Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListUserAssessmentsRequest

example

Click here to see how to use ListUserAssessmentsRequest.

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 displayName

displayName: undefined | string

A filter to return only resources that match the specified display name.

Optional isBaseline

isBaseline: undefined | false | true

A filter to return only user assessments that are set as baseline.

Optional isScheduleAssessment

isScheduleAssessment: undefined | false | true

A filter to return only user assessments of type SAVE_SCHEDULE.

Optional lifecycleState

lifecycleState: model.UserAssessmentLifecycleState

The current state of the user assessment.

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 scheduleUserAssessmentId

scheduleUserAssessmentId: undefined | string

The OCID of the user assessment of type SAVE_SCHEDULE.

Optional sortBy

sortBy: SortBy

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

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 timeCreatedGreaterThanOrEqualTo

timeCreatedGreaterThanOrEqualTo: Date

A filter to return only user assessments that were created after the specified date and time, as defined by RFC3339. Using timeCreatedGreaterThanOrEqualTo parameter retrieves all assessments created after that date.

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

Optional timeCreatedLessThan

timeCreatedLessThan: Date

Search for resources that were created before a specific date. Specifying this parameter corresponding {@code timeCreatedLessThan} parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

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

Optional triggeredBy

triggeredBy: TriggeredBy

A filter to return user assessments that were created by either the system or by a user only.

Optional type

type: Type

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