Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DelegatedResourceAccessRequest

A support operator raises Delegated Resource Access Request when they need access to any infrastructure resource governed by Delegation Control. The Delegated Resource Access Request identifies the target resource and the set of Service Provider Actions. Delegated Resource Access Request handling depends upon the Delegation Control that governs the target resource, and the set of Service Provider Actions listed for approval in the Delegated Resource Access Request. If all of the Service Provider Actions listed in the Delegated Resource Access Request are in the pre-approved list in the Delegation Control that governs the target resource, then the Delegated Resource Access Request is automatically approved. If not, then the Delegated Resource Access Request requires explicit approval from the approver group specified by the Delegation Control governing the target resource.

You can approve or reject a Delegated Resource Access Request. You can also revoke the approval of an already approved Delegated Resource Access Request. While creating a Delegated Resource Access Request, the support operator specifies the duration of access. You have the option to approve the entire duration or reduce or even increase the time duration. A support operator can also request for an extension. The approval for such an extension is processed the same way the original Delegated Resource Access Request was processed.

Properties

Optional approvalInfo

In case of single approval, this will have only one item. Else, a list of approvals.

Optional auditTypes

auditTypes: Array<AuditTypes>

Specifies the type of auditing to be enabled. There are two levels of auditing: command-level and keystroke-level. By default, both command-level and keystroke-level auditing are enabled, i.e. commands and key strokes issued by the support operator are logged.

Optional closureComment

closureComment: undefined | string

The comment entered by the support operator while closing the request.

compartmentId

compartmentId: string

The OCID of the compartment that contains the Delegated Resource Access Request.

Optional databaseNameList

databaseNameList: Array<string>

List of Database unique names for which access is requested. This parameter is required for DLGT_MGMT_SYS_MAINT_ACCESS cage when database access in needed.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional delegationControlId

delegationControlId: undefined | string

The OCID of the Delegation Control governing the target resource.

Optional delegationSubscriptionIds

delegationSubscriptionIds: Array<string>

List of Delegation Subscription OCID that are associated with this Delegated Resource Access Request based on the service types being requested.

description

description: string

Detailed description of this Delegated Resource Access Request.

Optional displayName

displayName: undefined | string

Display name. This is generated by the system automatically.

Optional durationInHours

durationInHours: undefined | number

Duration in hours for which access is sought on the target resource. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional extendDurationInHours

extendDurationInHours: undefined | number

Duration in hours for which extension access is sought on the target resource. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the Delegated Resource Access Request.

Optional isAutoApproved

isAutoApproved: undefined | false | true

Set to true if the request is approved automatically based on preApprovedServiceProviderActionNames or isAutoApproveDuringMaintenance in the associated Delegation Control.

Optional isPendingMoreInfo

isPendingMoreInfo: undefined | false | true

Indicates if the delegated resource access request is waiting on more information from the operator

Optional lifecycleState

lifecycleState: LifecycleState

The current lifecycle state of the Delegated Resource Access Request.

Optional lifecycleStateDetails

lifecycleStateDetails: undefined | string

Description of the current lifecycle state in more detail.

Optional numExtensionApprovals

numExtensionApprovals: undefined | number

Number of extension approvals that have been obtained so far. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional numInitialApprovals

numInitialApprovals: undefined | number

Number of initial approvals that have been obtained so far. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional providedServiceTypes

providedServiceTypes: Array<ProvidedServiceTypes>

List of Service Provider Service Types being provided by the support operator user.

reasonForRequest

reasonForRequest: string

A short description explaining why this Delegated Resource Access Request is needed by the support operator.

Optional requestStatus

requestStatus: model.DelegatedResourceAccessRequestStatus

The current status of the Delegated Resource Access Request.

Optional requestedActionNames

requestedActionNames: Array<string>

List of Service Provider Action names for which approval is sought by the support operator user. The list of pre-defined Service Provider Actions can be obtained from the ListServiceProviderActions API.

Optional requesterType

requesterType: model.DelegatedResourceAccessRequesterType

Requester type

resourceId

resourceId: string

The OCID of the target resource associated with the Delegated Resource Access Request. The support operator raises a Delegated Resource Access Request to get approval to access the target resource.

Optional resourceName

resourceName: undefined | string

The name of the target resource associated with the Delegated Resource Access Request. The support operator raises a Delegated Resource Access Request to get approval to access the target resource.

Optional resourceType

resourceType: model.DelegationControlResourceType

Resource type for which the associated Delegation Control is applicable to.

Optional severity

severity: model.DelegatedResourceAccessRequestSeverity

Priority assigned to the Delegated Resource Access Request by the support operator

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}}

Optional ticketNumbers

ticketNumbers: Array<string>

A list of ticket numbers related to this Delegated Resource Access Request, e.g. Service Request (SR) number and JIRA ticket number.

Optional timeAccessRequested

timeAccessRequested: Date

Requested access start time in UTC.

Optional timeCreated

timeCreated: Date

Time when the Delegated Resource Access Request was created in RFC 3339timestamp format, e.g. '2020-05-22T21:10:29.600Z'.

Optional timeUpdated

timeUpdated: Date

Time when the Delegated Resource Access Request was last modified in RFC 3339timestamp format, e.g. '2020-05-22T21:10:29.600Z'.

Functions

getDeserializedJsonObj

getJsonObj