Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListAuditEventAnalyticsRequest

example

Click here to see how to use ListAuditEventAnalyticsRequest.

Properties

Optional accessLevel

accessLevel: AccessLevel

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartmentId

compartmentId: string

A filter to return only resources that match the specified compartment OCID.

Optional compartmentIdInSubtree

compartmentIdInSubtree: undefined | false | true

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

Optional groupBy

groupBy: Array<GroupBy>

A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

Optional ifMatch

ifMatch: undefined | string

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Optional limit

limit: undefined | number

For details about how pagination works, see List Pagination.

Optional opcRequestId

opcRequestId: undefined | string

Unique identifier for the request.

Optional opcRetryToken

opcRetryToken: undefined | string

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Optional page

page: undefined | string

It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Optional queryTimeZone

queryTimeZone: undefined | string

Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional scimQuery

scimQuery: undefined | string

The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

*Example:** query=(operationTime ge '2021-06-04T01-00-26') and (eventName eq 'LOGON')

Optional sortBy

sortBy: SortBy

If this query parameter is specified, the result is ordered based on this query parameter value.

Optional sortOrder

sortOrder: SortOrder

The sort order to use, either ascending (ASC) or descending (DESC).

Optional summaryField

summaryField: Array<SummaryField>

Specifies a subset of summarized fields to be returned in the response.

Optional timeEnded

timeEnded: Date

An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

Optional timeStarted

timeStarted: Date

An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.