Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListUserAnalyticsRequest

example

Click here to see how to use ListUserAnalyticsRequest.

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.

Optional accountStatus

accountStatus: undefined | string

A filter to return only items that match the specified account status.

Optional authenticationType

authenticationType: undefined | string

A filter to return only items that match the specified authentication type.

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 limit

limit: undefined | number

For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

Optional opcRequestId

opcRequestId: undefined | string

Unique identifier for the request.

Optional page

page: undefined | string

For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

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 sortBy

sortBy: SortBy

The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending.

Optional sortOrder

sortOrder: SortOrder

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

Optional targetId

targetId: undefined | string

A filter to return only items related to a specific target OCID.

Optional timeLastLoginGreaterThanOrEqualTo

timeLastLoginGreaterThanOrEqualTo: Date

A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

*Example:** 2016-12-19T16:39:57.600Z

Optional timeLastLoginLessThan

timeLastLoginLessThan: Date

A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

Optional timePasswordLastChangedGreaterThanOrEqualTo

timePasswordLastChangedGreaterThanOrEqualTo: Date

A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

*Example:** 2016-12-19T16:39:57.600Z

Optional timePasswordLastChangedLessThan

timePasswordLastChangedLessThan: Date

A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.

*Example:** 2016-12-19T16:39:57.600Z

Optional timeUserCreatedGreaterThanOrEqualTo

timeUserCreatedGreaterThanOrEqualTo: Date

A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

Optional timeUserCreatedLessThan

timeUserCreatedLessThan: Date

A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z

userAssessmentId

userAssessmentId: string

The OCID of the user assessment.

Optional userCategory

userCategory: undefined | string

A filter to return only items that match the specified user category.

Optional userKey

userKey: undefined | string

A filter to return only items that match the specified user key.

Optional userName

userName: undefined | string

A filter to return only items that match the specified user name.