Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateDelegationControlDetails

While creating the Delegation Control, specify how Service Provider Actions are approved and the users who have the privilege of approving the Service Provider Actions associated with the Delegation Control.

You must specify which Service Provider Actions must be pre-approved. The rest of the Service Provider Actions associated with the Delegation Control will require an explicit approval from the users selected either through the approver groups or individually.

You must name your Delegation Control appropriately so it reflects the resources that will be governed by the Delegation Control. Neither the Delegation Controls nor their assignments to resources are visible to the support operators.

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains this Delegation Control.

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\"}}}

delegationSubscriptionIds

delegationSubscriptionIds: Array<string>

List of Delegation Subscription OCID that are allowed for this Delegation Control. The allowed subscriptions will determine the available Service Provider Actions. Only support operators for the allowed subscriptions are allowed to create Delegated Resource Access Request.

Optional description

description: undefined | string

Description of the Delegation Control.

displayName

displayName: string

Name of the Delegation Control. The name does not need to be unique.

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\"}}

Optional isAutoApproveDuringMaintenance

isAutoApproveDuringMaintenance: undefined | false | true

Set to true to allow all Delegated Resource Access Request to be approved automatically during maintenance.

notificationMessageFormat

notificationMessageFormat: string

The format of the OCI Notification messages for this Delegation Control.

notificationTopicId

notificationTopicId: string

The OCID of the OCI Notification topic to publish messages related to this Delegation Control.

Optional numApprovalsRequired

numApprovalsRequired: undefined | number

number of approvals required. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional preApprovedServiceProviderActionNames

preApprovedServiceProviderActionNames: Array<string>

List of pre-approved Service Provider Action names. The list of pre-defined Service Provider Actions can be obtained from the ListServiceProviderActions API. Delegated Resource Access Requests associated with a resource governed by this Delegation Control will be automatically approved if the Delegated Resource Access Request only contain Service Provider Actions in the pre-approved list.

resourceIds

resourceIds: Array<string>

The OCID of the selected resources that this Delegation Control is applicable to.

resourceType

Resource type for which the Delegation Control is applicable to.

Optional vaultId

vaultId: undefined | string

The OCID of the OCI Vault that will store the secrets containing the SSH keys to access the resource governed by this Delegation Control by Delegate Access Control Service. This property is required when resourceType is CLOUDVMCLUSTER. Delegate Access Control Service will generate the SSH keys and store them as secrets in the OCI Vault.

Optional vaultKeyId

vaultKeyId: undefined | string

The OCID of the Master Encryption Key in the OCI Vault specified by vaultId. This key will be used to encrypt the SSH keys to access the resource governed by this Delegation Control by Delegate Access Control Service. This property is required when resourceType is CLOUDVMCLUSTER.

Functions

getDeserializedJsonObj

getJsonObj