Function getAudits

  • 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