CreatePrivilegedApiRequestDetails¶

class oci.apiaccesscontrol.models.CreatePrivilegedApiRequestDetails(**kwargs)¶

Bases: object

An Oracle operator raises privilegedApi request when they need access to any infrastructure resource governed by PrivilegedApi Access Control. The privilegedApi 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 privilegedApi request are in the pre-approved list in the PrivilegedApi Control that governs the target resource, then the privilegedApi request is automatically approved. If not, then the privilegedApi request requires explicit approval from the approver group specified by the PrivilegedApi Control governing the target resource.

You can approve or reject an privilegedApi request. You can also revoke the approval of an already approved privilegedApi 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 privilegedApi request was processed.

Attributes

`SEVERITY_SEV_1`	A constant which can be used with the severity property of a CreatePrivilegedApiRequestDetails.
`SEVERITY_SEV_2`	A constant which can be used with the severity property of a CreatePrivilegedApiRequestDetails.
`SEVERITY_SEV_3`	A constant which can be used with the severity property of a CreatePrivilegedApiRequestDetails.
`SEVERITY_SEV_4`	A constant which can be used with the severity property of a CreatePrivilegedApiRequestDetails.
`compartment_id`	Gets the compartment_id of this CreatePrivilegedApiRequestDetails.
`defined_tags`	Gets the defined_tags of this CreatePrivilegedApiRequestDetails.
`duration_in_hrs`	Gets the duration_in_hrs of this CreatePrivilegedApiRequestDetails.
`freeform_tags`	Gets the freeform_tags of this CreatePrivilegedApiRequestDetails.
`notification_topic_id`	Gets the notification_topic_id of this CreatePrivilegedApiRequestDetails.
`privileged_operation_list`	[Required] Gets the privileged_operation_list of this CreatePrivilegedApiRequestDetails.
`reason_detail`	Gets the reason_detail of this CreatePrivilegedApiRequestDetails.
`reason_summary`	[Required] Gets the reason_summary of this CreatePrivilegedApiRequestDetails.
`resource_id`	[Required] Gets the resource_id of this CreatePrivilegedApiRequestDetails.
`severity`	Gets the severity of this CreatePrivilegedApiRequestDetails.
`sub_resource_name_list`	Gets the sub_resource_name_list of this CreatePrivilegedApiRequestDetails.
`ticket_numbers`	Gets the ticket_numbers of this CreatePrivilegedApiRequestDetails.
`time_requested_for_future_access`	Gets the time_requested_for_future_access of this CreatePrivilegedApiRequestDetails.

Methods

__init__(**kwargs) Initializes a new CreatePrivilegedApiRequestDetails object with values from keyword arguments.

SEVERITY_SEV_1 = 'SEV_1'¶: A constant which can be used with the severity property of a CreatePrivilegedApiRequestDetails. This constant has a value of “SEV_1”

SEVERITY_SEV_2 = 'SEV_2'¶: A constant which can be used with the severity property of a CreatePrivilegedApiRequestDetails. This constant has a value of “SEV_2”

SEVERITY_SEV_3 = 'SEV_3'¶: A constant which can be used with the severity property of a CreatePrivilegedApiRequestDetails. This constant has a value of “SEV_3”

SEVERITY_SEV_4 = 'SEV_4'¶: A constant which can be used with the severity property of a CreatePrivilegedApiRequestDetails. This constant has a value of “SEV_4”

__init__(**kwargs)¶

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

Parameters:

reason_summary (str) – The value to assign to the reason_summary property of this CreatePrivilegedApiRequestDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreatePrivilegedApiRequestDetails.
resource_id (str) – The value to assign to the resource_id property of this CreatePrivilegedApiRequestDetails.
sub_resource_name_list (list[str]) – The value to assign to the sub_resource_name_list property of this CreatePrivilegedApiRequestDetails.
privileged_operation_list (list[oci.apiaccesscontrol.models.PrivilegedApiRequestOperationDetails]) – The value to assign to the privileged_operation_list property of this CreatePrivilegedApiRequestDetails.
notification_topic_id (str) – The value to assign to the notification_topic_id property of this CreatePrivilegedApiRequestDetails.
reason_detail (str) – The value to assign to the reason_detail property of this CreatePrivilegedApiRequestDetails.
severity (str) – The value to assign to the severity property of this CreatePrivilegedApiRequestDetails. Allowed values for this property are: “SEV_1”, “SEV_2”, “SEV_3”, “SEV_4”
duration_in_hrs (int) – The value to assign to the duration_in_hrs property of this CreatePrivilegedApiRequestDetails.
ticket_numbers (list[str]) – The value to assign to the ticket_numbers property of this CreatePrivilegedApiRequestDetails.
time_requested_for_future_access (datetime) – The value to assign to the time_requested_for_future_access property of this CreatePrivilegedApiRequestDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreatePrivilegedApiRequestDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreatePrivilegedApiRequestDetails.

compartment_id¶

Gets the compartment_id of this CreatePrivilegedApiRequestDetails. The `OCID`__ of the compartment.

Returns:	The compartment_id of this CreatePrivilegedApiRequestDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreatePrivilegedApiRequestDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__.

Example: {“Operations”: {“CostCenter”: “42”}}

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

duration_in_hrs¶

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

Returns:	The duration_in_hrs of this CreatePrivilegedApiRequestDetails.
Return type:	int

freeform_tags¶

Gets the freeform_tags of this CreatePrivilegedApiRequestDetails. 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: {“Department”: “Finance”}

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

notification_topic_id¶

Gets the notification_topic_id of this CreatePrivilegedApiRequestDetails. The OCID of the OCI Notification topic to publish messages related to this Privileged Api Request.

Returns:	The notification_topic_id of this CreatePrivilegedApiRequestDetails.
Return type:	str

privileged_operation_list¶

[Required] Gets the privileged_operation_list of this CreatePrivilegedApiRequestDetails. List of api names, attributes for which approval is sought by the user.

Returns:	The privileged_operation_list of this CreatePrivilegedApiRequestDetails.
Return type:	list[oci.apiaccesscontrol.models.PrivilegedApiRequestOperationDetails]

reason_detail¶

Gets the reason_detail of this CreatePrivilegedApiRequestDetails. Reason in detail for which the operator is requesting access on the target resource.

Returns:	The reason_detail of this CreatePrivilegedApiRequestDetails.
Return type:	str

reason_summary¶

[Required] Gets the reason_summary of this CreatePrivilegedApiRequestDetails. Summary comment by the operator creating the access request.

Returns:	The reason_summary of this CreatePrivilegedApiRequestDetails.
Return type:	str

resource_id¶

[Required] Gets the resource_id of this CreatePrivilegedApiRequestDetails. 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 CreatePrivilegedApiRequestDetails.
Return type:	str

severity¶

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

Allowed values for this property are: “SEV_1”, “SEV_2”, “SEV_3”, “SEV_4”

Returns:	The severity of this CreatePrivilegedApiRequestDetails.
Return type:	str

sub_resource_name_list¶

Gets the sub_resource_name_list of this CreatePrivilegedApiRequestDetails. The subresource names requested for approval.

Returns:	The sub_resource_name_list of this CreatePrivilegedApiRequestDetails.
Return type:	list[str]

ticket_numbers¶

Gets the ticket_numbers of this CreatePrivilegedApiRequestDetails. A list of ticket numbers related to this Privileged Api Access Request, e.g. Service Request (SR) number and JIRA ticket number.

Returns:	The ticket_numbers of this CreatePrivilegedApiRequestDetails.
Return type:	list[str]

time_requested_for_future_access¶

Gets the time_requested_for_future_access of this CreatePrivilegedApiRequestDetails. Time in future when the user for the privilegedApi request needs to be created in `RFC 3339`__timestamp format. Example: ‘2020-05-22T21:10:29.600Z’

Returns:	The time_requested_for_future_access of this CreatePrivilegedApiRequestDetails.
Return type:	datetime