Interface AuditsAPI

interface AuditsAPI {
    clearCache: () => void;
    getArchivedAudits: (
        query: { date: string },
        options?: ApiCallOptions,
    ) => Promise<GetArchivedAuditsHttpResponse>;
    getAudit: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetAuditHttpResponse>;
    getAudits: (
        query: {
            eventTime?: string;
            eventType?: string;
            id?: string;
            limit?: number;
            next?: string;
            prev?: string;
            sort?: string;
            source?: string;
            userId?: string;
        },
        options?: ApiCallOptions,
    ) => Promise<GetAuditsHttpResponse>;
    getAuditSources: (
        options?: ApiCallOptions,
    ) => Promise<GetAuditSourcesHttpResponse>;
    getAuditsSettings: (
        options?: ApiCallOptions,
    ) => Promise<GetAuditsSettingsHttpResponse>;
    getAuditTypes: (
        options?: ApiCallOptions,
    ) => Promise<GetAuditTypesHttpResponse>;
}
Index

Properties

clearCache getArchivedAudits getAudit getAudits getAuditSources getAuditsSettings getAuditTypes

Properties

clearCache: () => void

Clears the cache for audits api requests.

Type declaration

    • (): void

    • Clears the cache for audits api requests.

      Returns void

getArchivedAudits: (
    query: { date: string },
    options?: ApiCallOptions,
) => Promise<GetArchivedAuditsHttpResponse>

Retrieves audit events from long term storage. Finds and returns audit events from the archive, formatted as a JSON array, for the given date and tenant (in JWT). Archived events are not removed.

Type declaration

    • (
          query: { date: string },
          options?: ApiCallOptions,
      ): Promise<GetArchivedAuditsHttpResponse>

    • Retrieves audit events from long term storage. Finds and returns audit events from the archive, formatted as a JSON array, for the given date and tenant (in JWT). Archived events are not removed.

      Parameters

      • query: { date: string }

        an object with query parameters

        • date: string

          Date to be used as filter and criteria during extraction.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetArchivedAuditsHttpResponse>

      GetArchivedAuditsHttpError

an object with query parameters

GetArchivedAuditsHttpError

getAudit: (
    id: string,
    options?: ApiCallOptions,
) => Promise<GetAuditHttpResponse>

Finds and returns a specific audit events for the given event ID.

Type declaration

The audit item's unique identifier.

GetAuditHttpError

getAudits: (
    query: {
        eventTime?: string;
        eventType?: string;
        id?: string;
        limit?: number;
        next?: string;
        prev?: string;
        sort?: string;
        source?: string;
        userId?: string;
    },
    options?: ApiCallOptions,
) => Promise<GetAuditsHttpResponse>

Retrieves list of events for subscribed services for your tenant. Stores events for 90 days, after which they can be accessed via /v1/audits/archive.

Type declaration

    • (
          query: {
              eventTime?: string;
              eventType?: string;
              id?: string;
              limit?: number;
              next?: string;
              prev?: string;
              sort?: string;
              source?: string;
              userId?: string;
          },
          options?: ApiCallOptions,
      ): Promise<GetAuditsHttpResponse>

    • Retrieves list of events for subscribed services for your tenant. Stores events for 90 days, after which they can be accessed via /v1/audits/archive.

      Parameters

      • query: {
            eventTime?: string;
            eventType?: string;
            id?: string;
            limit?: number;
            next?: string;
            prev?: string;
            sort?: string;
            source?: string;
            userId?: string;
        }

        an object with query parameters

        • OptionaleventTime?: string

          The start/end time interval formatted in ISO 8601 to search by eventTime. For example, "?eventTime=2021-07-14T18:41:15.00Z/2021-07-14T18:41:15.99Z".

        • OptionaleventType?: string

          The case-sensitive string used to search by eventType. Retrieve a list of possible eventTypes with /v1/audits/types.

        • Optionalid?: string

          The comma separated list of audit unique identifiers.

        • Optionallimit?: number

          The maximum number of resources to return for a request.

        • Optionalnext?: string

          The cursor to the next page of resources. Provide either the next or prev cursor, but not both.

        • Optionalprev?: string

          The cursor to the previous page of resources. Provide either the next or prev cursor, but not both.

        • Optionalsort?: string

          The property of a resource to sort on (default sort is -eventTime). The supported properties are source, eventType, and eventTime. A property must be prefixed by + or - to indicate ascending or descending sort order respectively.

        • Optionalsource?: string

          The case-sensitive string used to search by source. Retrieve a list of possible sources with /v1/audits/sources.

        • OptionaluserId?: string

          The case-sensitive string used to search by userId.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAuditsHttpResponse>

      GetAuditsHttpError

an object with query parameters

GetAuditsHttpError

getAuditSources: (
    options?: ApiCallOptions,
) => Promise<GetAuditSourcesHttpResponse>

Finds and returns the list of possible event sources for this tenant.

Type declaration

GetAuditSourcesHttpError

getAuditsSettings: (
    options?: ApiCallOptions,
) => Promise<GetAuditsSettingsHttpResponse>

Returns the server configuration options. It includes options that represent the server configuration state and parameters that were used to run the server with certain functionality.

Type declaration

GetAuditsSettingsHttpError

getAuditTypes: (options?: ApiCallOptions) => Promise<GetAuditTypesHttpResponse>

Finds and returns the list of possible event types for this tenant.

Type declaration

GetAuditTypesHttpError

Settings

Member Visibility

On This Page

Properties