AccessRequest

class oci.operator_access_control.models.AccessRequest(**kwargs)

Bases: object

An Oracle operator raises access request when they need access to any infrastructure resource governed by Operator Access Control. The access request identifies the target resource and the set of operator actions. Access request handling depends upon the Operator Control that governs the target resource, and the set of operator actions listed for approval in the access request. If all of the operator actions listed in the access request are in the pre-approved list in the Operator Control that governs the target resource, then the access request is automatically approved. If not, then the access request requires explicit approval from the approver group specified by the Operator Control governing the target resource.

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

Attributes

LIFECYCLE_STATE_APPROVALWAITING A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_APPROVED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_CLOSEFAILED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_COMPLETED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_COMPLETING A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_CREATED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_DEPLOYED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_DEPLOYFAILED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_EXPIRED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_EXPIRYFAILED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_EXTENDED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_EXTENDING A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_EXTENSIONREJECTED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_PREAPPROVED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_REJECTED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_REVOKED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_REVOKEFAILED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_REVOKING A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_UNDEPLOYED A constant which can be used with the lifecycle_state property of a AccessRequest.
LIFECYCLE_STATE_UNDEPLOYFAILED A constant which can be used with the lifecycle_state property of a AccessRequest.
SEVERITY_S1 A constant which can be used with the severity property of a AccessRequest.
SEVERITY_S2 A constant which can be used with the severity property of a AccessRequest.
SEVERITY_S3 A constant which can be used with the severity property of a AccessRequest.
SEVERITY_S4 A constant which can be used with the severity property of a AccessRequest.
access_reason_summary [Required] Gets the access_reason_summary of this AccessRequest.
action_requests_list Gets the action_requests_list of this AccessRequest.
approver_comment Gets the approver_comment of this AccessRequest.
audit_type Gets the audit_type of this AccessRequest.
closure_comment Gets the closure_comment of this AccessRequest.
compartment_id Gets the compartment_id of this AccessRequest.
defined_tags Gets the defined_tags of this AccessRequest.
duration Gets the duration of this AccessRequest.
extend_duration Gets the extend_duration of this AccessRequest.
freeform_tags Gets the freeform_tags of this AccessRequest.
id [Required] Gets the id of this AccessRequest.
is_auto_approved Gets the is_auto_approved of this AccessRequest.
lifecycle_state Gets the lifecycle_state of this AccessRequest.
opctl_additional_message Gets the opctl_additional_message of this AccessRequest.
opctl_id Gets the opctl_id of this AccessRequest.
opctl_name Gets the opctl_name of this AccessRequest.
operator_id Gets the operator_id of this AccessRequest.
reason Gets the reason of this AccessRequest.
request_id Gets the request_id of this AccessRequest.
resource_id [Required] Gets the resource_id of this AccessRequest.
resource_name Gets the resource_name of this AccessRequest.
severity Gets the severity of this AccessRequest.
system_message Gets the system_message of this AccessRequest.
time_of_creation Gets the time_of_creation of this AccessRequest.
time_of_modification Gets the time_of_modification of this AccessRequest.
user_id Gets the user_id of this AccessRequest.
workflow_id Gets the workflow_id of this AccessRequest.

Methods

__init__(**kwargs) Initializes a new AccessRequest object with values from keyword arguments.
LIFECYCLE_STATE_APPROVALWAITING = 'APPROVALWAITING'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “APPROVALWAITING”

LIFECYCLE_STATE_APPROVED = 'APPROVED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “APPROVED”

LIFECYCLE_STATE_CLOSEFAILED = 'CLOSEFAILED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “CLOSEFAILED”

LIFECYCLE_STATE_COMPLETED = 'COMPLETED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “COMPLETED”

LIFECYCLE_STATE_COMPLETING = 'COMPLETING'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “COMPLETING”

LIFECYCLE_STATE_CREATED = 'CREATED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “CREATED”

LIFECYCLE_STATE_DEPLOYED = 'DEPLOYED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “DEPLOYED”

LIFECYCLE_STATE_DEPLOYFAILED = 'DEPLOYFAILED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “DEPLOYFAILED”

LIFECYCLE_STATE_EXPIRED = 'EXPIRED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “EXPIRED”

LIFECYCLE_STATE_EXPIRYFAILED = 'EXPIRYFAILED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “EXPIRYFAILED”

LIFECYCLE_STATE_EXTENDED = 'EXTENDED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “EXTENDED”

LIFECYCLE_STATE_EXTENDING = 'EXTENDING'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “EXTENDING”

LIFECYCLE_STATE_EXTENSIONREJECTED = 'EXTENSIONREJECTED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “EXTENSIONREJECTED”

LIFECYCLE_STATE_PREAPPROVED = 'PREAPPROVED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “PREAPPROVED”

LIFECYCLE_STATE_REJECTED = 'REJECTED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “REJECTED”

LIFECYCLE_STATE_REVOKED = 'REVOKED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “REVOKED”

LIFECYCLE_STATE_REVOKEFAILED = 'REVOKEFAILED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “REVOKEFAILED”

LIFECYCLE_STATE_REVOKING = 'REVOKING'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “REVOKING”

LIFECYCLE_STATE_UNDEPLOYED = 'UNDEPLOYED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “UNDEPLOYED”

LIFECYCLE_STATE_UNDEPLOYFAILED = 'UNDEPLOYFAILED'

A constant which can be used with the lifecycle_state property of a AccessRequest. This constant has a value of “UNDEPLOYFAILED”

SEVERITY_S1 = 'S1'

A constant which can be used with the severity property of a AccessRequest. This constant has a value of “S1”

SEVERITY_S2 = 'S2'

A constant which can be used with the severity property of a AccessRequest. This constant has a value of “S2”

SEVERITY_S3 = 'S3'

A constant which can be used with the severity property of a AccessRequest. This constant has a value of “S3”

SEVERITY_S4 = 'S4'

A constant which can be used with the severity property of a AccessRequest. This constant has a value of “S4”

__init__(**kwargs)

Initializes a new AccessRequest object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • id (str) – The value to assign to the id property of this AccessRequest.
  • request_id (str) – The value to assign to the request_id property of this AccessRequest.
  • access_reason_summary (str) – The value to assign to the access_reason_summary property of this AccessRequest.
  • operator_id (str) – The value to assign to the operator_id property of this AccessRequest.
  • resource_id (str) – The value to assign to the resource_id property of this AccessRequest.
  • resource_name (str) – The value to assign to the resource_name property of this AccessRequest.
  • compartment_id (str) – The value to assign to the compartment_id property of this AccessRequest.
  • action_requests_list (list[str]) – The value to assign to the action_requests_list property of this AccessRequest.
  • reason (str) – The value to assign to the reason property of this AccessRequest.
  • severity (str) – The value to assign to the severity property of this AccessRequest. Allowed values for this property are: “S1”, “S2”, “S3”, “S4”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • duration (int) – The value to assign to the duration property of this AccessRequest.
  • extend_duration (int) – The value to assign to the extend_duration property of this AccessRequest.
  • workflow_id (list[str]) – The value to assign to the workflow_id property of this AccessRequest.
  • is_auto_approved (bool) – The value to assign to the is_auto_approved property of this AccessRequest.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this AccessRequest. Allowed values for this property are: “CREATED”, “APPROVALWAITING”, “PREAPPROVED”, “APPROVED”, “REJECTED”, “DEPLOYED”, “DEPLOYFAILED”, “UNDEPLOYED”, “UNDEPLOYFAILED”, “CLOSEFAILED”, “REVOKEFAILED”, “EXPIRYFAILED”, “REVOKING”, “REVOKED”, “EXTENDING”, “EXTENDED”, “EXTENSIONREJECTED”, “COMPLETING”, “COMPLETED”, “EXPIRED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • time_of_creation (datetime) – The value to assign to the time_of_creation property of this AccessRequest.
  • time_of_modification (datetime) – The value to assign to the time_of_modification property of this AccessRequest.
  • user_id (str) – The value to assign to the user_id property of this AccessRequest.
  • approver_comment (str) – The value to assign to the approver_comment property of this AccessRequest.
  • closure_comment (str) – The value to assign to the closure_comment property of this AccessRequest.
  • opctl_id (str) – The value to assign to the opctl_id property of this AccessRequest.
  • opctl_name (str) – The value to assign to the opctl_name property of this AccessRequest.
  • system_message (str) – The value to assign to the system_message property of this AccessRequest.
  • opctl_additional_message (str) – The value to assign to the opctl_additional_message property of this AccessRequest.
  • audit_type (list[str]) – The value to assign to the audit_type property of this AccessRequest.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AccessRequest.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AccessRequest.
access_reason_summary

[Required] Gets the access_reason_summary of this AccessRequest. Summary comment by the operator creating the access request.

Returns:The access_reason_summary of this AccessRequest.
Return type:str
action_requests_list

Gets the action_requests_list of this AccessRequest. List of operator actions for which approval is sought by the operator user.

Returns:The action_requests_list of this AccessRequest.
Return type:list[str]
approver_comment

Gets the approver_comment of this AccessRequest. The last recent Comment entered by the approver of the request.

Returns:The approver_comment of this AccessRequest.
Return type:str
audit_type

Gets the audit_type of this AccessRequest. Specifies the type of auditing to be enabled. There are two levels of auditing: command-level and keystroke-level. By default, auditing is enabled at the command level i.e., each command issued by the operator is audited. When keystroke-level is chosen, in addition to command level logging, key strokes are also logged.

Returns:The audit_type of this AccessRequest.
Return type:list[str]
closure_comment

Gets the closure_comment of this AccessRequest. The comment entered by the operator while closing the request.

Returns:The closure_comment of this AccessRequest.
Return type:str
compartment_id

Gets the compartment_id of this AccessRequest. The OCID of the compartment that contains the access request.

Returns:The compartment_id of this AccessRequest.
Return type:str
defined_tags

Gets the defined_tags of this AccessRequest. Defined tags for this resource. Each key is predefined and scoped to a namespace.

Returns:The defined_tags of this AccessRequest.
Return type:dict(str, dict(str, object))
duration

Gets the duration of this AccessRequest. Duration in hours for which access is sought on the target resource.

Returns:The duration of this AccessRequest.
Return type:int
extend_duration

Gets the extend_duration of this AccessRequest. Duration in hours for which extension access is sought on the target resource.

Returns:The extend_duration of this AccessRequest.
Return type:int
freeform_tags

Gets the freeform_tags of this AccessRequest. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

Returns:The freeform_tags of this AccessRequest.
Return type:dict(str, str)
id

[Required] Gets the id of this AccessRequest. The OCID of the access request.

Returns:The id of this AccessRequest.
Return type:str
is_auto_approved

Gets the is_auto_approved of this AccessRequest. Whether the access request was automatically approved.

Returns:The is_auto_approved of this AccessRequest.
Return type:bool
lifecycle_state

Gets the lifecycle_state of this AccessRequest. The current state of the AccessRequest.

Allowed values for this property are: “CREATED”, “APPROVALWAITING”, “PREAPPROVED”, “APPROVED”, “REJECTED”, “DEPLOYED”, “DEPLOYFAILED”, “UNDEPLOYED”, “UNDEPLOYFAILED”, “CLOSEFAILED”, “REVOKEFAILED”, “EXPIRYFAILED”, “REVOKING”, “REVOKED”, “EXTENDING”, “EXTENDED”, “EXTENSIONREJECTED”, “COMPLETING”, “COMPLETED”, “EXPIRED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this AccessRequest.
Return type:str
opctl_additional_message

Gets the opctl_additional_message of this AccessRequest. Additional message specific to the access request that can be specified by the approver at the time of approval.

Returns:The opctl_additional_message of this AccessRequest.
Return type:str
opctl_id

Gets the opctl_id of this AccessRequest. The OCID of the operator control governing the target resource.

Returns:The opctl_id of this AccessRequest.
Return type:str
opctl_name

Gets the opctl_name of this AccessRequest. Name of the Operator control governing the target resource.

Returns:The opctl_name of this AccessRequest.
Return type:str
operator_id

Gets the operator_id of this AccessRequest. A unique identifier associated with the operator who raised the request. This identifier can not be used directly to identify the operator. You need to provide this identifier if you would like Oracle to provide additional information about the operator action within Oracle tenancy.

Returns:The operator_id of this AccessRequest.
Return type:str
reason

Gets the reason of this AccessRequest. Summary reason for which the operator is requesting access on the target resource.

Returns:The reason of this AccessRequest.
Return type:str
request_id

Gets the request_id of this AccessRequest. This is an automatic identifier generated by the system which is easier for human comprehension.

Returns:The request_id of this AccessRequest.
Return type:str
resource_id

[Required] Gets the resource_id of this AccessRequest. The OCID of the target resource associated with the access request. The operator raises an access request to get approval to access the target resource.

Returns:The resource_id of this AccessRequest.
Return type:str
resource_name

Gets the resource_name of this AccessRequest. The name of the target resource.

Returns:The resource_name of this AccessRequest.
Return type:str
severity

Gets the severity of this AccessRequest. Priority assigned to the access request by the operator

Allowed values for this property are: “S1”, “S2”, “S3”, “S4”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The severity of this AccessRequest.
Return type:str
system_message

Gets the system_message of this AccessRequest. System message that will be displayed to the operator at login to the target resource.

Returns:The system_message of this AccessRequest.
Return type:str
time_of_creation

Gets the time_of_creation of this AccessRequest. Time when the access request was created in `RFC 3339`__timestamp format. Example: ‘2020-05-22T21:10:29.600Z’

Returns:The time_of_creation of this AccessRequest.
Return type:datetime
time_of_modification

Gets the time_of_modification of this AccessRequest. Time when the access request was last modified in `RFC 3339`__timestamp format. Example: ‘2020-05-22T21:10:29.600Z’

Returns:The time_of_modification of this AccessRequest.
Return type:datetime
user_id

Gets the user_id of this AccessRequest. The OCID of the user that last modified the access request.

Returns:The user_id of this AccessRequest.
Return type:str
workflow_id

Gets the workflow_id of this AccessRequest. The OCID of the workflow associated with the access request. This is needed if you want to contact Oracle Support for a stuck access request or for an access request that encounters an internal error.

Returns:The workflow_id of this AccessRequest.
Return type:list[str]