Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace OperatorControlAssignment

An Operator Control Assignment identifies the target resource that is placed under the governance of an Operator Control. Creating an Operator Control Assignment Assignment with a time duration ensures that human accesses to the target resource will be governed by Operator Control for the duration specified.

Properties

Optional assignerId

assignerId: undefined | string

The OCID of the user who created this operator control assignment.

Optional comment

comment: undefined | string

Comment about the assignment of the operator control to this target resource.

Optional compartmentId

compartmentId: undefined | string

The OCID of the comparment that contains the operator control assignment.

Optional definedTags

definedTags: undefined | object

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

Optional detachmentDescription

detachmentDescription: undefined | string

description containing reason for releasing of OperatorControl.

Optional errorCode

errorCode: undefined | number

The code identifying the error occurred during Assignment operation. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional errorMessage

errorMessage: undefined | string

The message describing the error occurred during Assignment operation.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

id

id: string

The OCID of the operator control assignment.

Optional isAutoApproveDuringMaintenance

isAutoApproveDuringMaintenance: undefined | false | true

The boolean if true would autoApprove during maintenance.

Optional isDefaultAssignment

isDefaultAssignment: undefined | false | true

Whether the assignment is a default assignment.

Optional isEnforcedAlways

isEnforcedAlways: undefined | false | true

If set, then the target resource is always governed by the operator control.

Optional isHypervisorLogForwarded

isHypervisorLogForwarded: undefined | false | true

If set, then the hypervisor audit logs will be forwarded to the relevant remote syslog server

Optional isLogForwarded

isLogForwarded: undefined | false | true

If set indicates that the audit logs are being forwarded to the relevant remote logging server

Optional lifecycleDetails

lifecycleDetails: undefined | string

More in detail about the lifeCycleState.

Optional lifecycleState

lifecycleState: model.OperatorControlAssignmentLifecycleStates

The current lifcycle state of the OperatorControl.

Optional opControlName

opControlName: undefined | string

Name of the operator control name associated.

operatorControlId

operatorControlId: string

The OCID of the operator control.

Optional remoteSyslogServerAddress

remoteSyslogServerAddress: undefined | string

The address of the remote syslog server where the audit logs are being forwarded to. Address in host or IP format.

Optional remoteSyslogServerCACert

remoteSyslogServerCACert: undefined | string

The CA certificate of the remote syslog server.

Optional remoteSyslogServerPort

remoteSyslogServerPort: undefined | number

The listening port of the remote syslog server. The port range is 0 - 65535. Only TCP supported. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional resourceCompartmentId

resourceCompartmentId: undefined | string

The OCID of the compartment that contains the target resource.

resourceId

resourceId: string

The OCID of the target resource.

resourceName

resourceName: string

Name of the target resource.

Optional resourceType

resourceType: model.ResourceTypes

resourceType for which the OperatorControlAssignment is applicable

Optional timeAssignmentFrom

timeAssignmentFrom: Date

The time at which the target resource will be brought under the governance of the operator control expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'

Optional timeAssignmentTo

timeAssignmentTo: Date

The time at which the target resource will leave the governance of the operator control expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'

Optional timeOfAssignment

timeOfAssignment: Date

Time when the operator control assignment is created in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'

Optional timeOfDeletion

timeOfDeletion: Date

Time on which the operator control assignment was deleted in RFC 3339timestamp format.Example: '2020-05-22T21:10:29.600Z'

Optional unassignerId

unassignerId: undefined | string

User id who released the operatorControl.

Functions

getDeserializedJsonObj

getJsonObj