PrivilegedApiRequestSummary¶
- class oci.apiaccesscontrol.models.PrivilegedApiRequestSummary(**kwargs)¶
Bases:
objectSummary of access request.
Attributes:
A constant which can be used with the severity property of a PrivilegedApiRequestSummary.
A constant which can be used with the severity property of a PrivilegedApiRequestSummary.
A constant which can be used with the severity property of a PrivilegedApiRequestSummary.
A constant which can be used with the severity property of a PrivilegedApiRequestSummary.
Gets the compartment_id of this PrivilegedApiRequestSummary.
Gets the defined_tags of this PrivilegedApiRequestSummary.
Gets the display_name of this PrivilegedApiRequestSummary.
Gets the duration_in_hrs of this PrivilegedApiRequestSummary.
Gets the freeform_tags of this PrivilegedApiRequestSummary.
[Required] Gets the id of this PrivilegedApiRequestSummary.
Gets the lifecycle_details of this PrivilegedApiRequestSummary.
Gets the lifecycle_state of this PrivilegedApiRequestSummary.
Gets the privileged_operation_list of this PrivilegedApiRequestSummary.
[Required] Gets the reason_summary of this PrivilegedApiRequestSummary.
Gets the request_id of this PrivilegedApiRequestSummary.
[Required] Gets the resource_id of this PrivilegedApiRequestSummary.
Gets the resource_name of this PrivilegedApiRequestSummary.
Gets the resource_type of this PrivilegedApiRequestSummary.
Gets the severity of this PrivilegedApiRequestSummary.
Gets the state of this PrivilegedApiRequestSummary.
Gets the sub_resource_name_list of this PrivilegedApiRequestSummary.
Gets the system_tags of this PrivilegedApiRequestSummary.
Gets the time_created of this PrivilegedApiRequestSummary.
Gets the time_requested_for_future_access of this PrivilegedApiRequestSummary. Time in future when the user for the access request needs to be created in `RFC 3339`__timestamp format. Example: '2020-05-22T21:10:29.600Z'.
Gets the time_updated of this PrivilegedApiRequestSummary.
Methods:
__init__(**kwargs)Initializes a new PrivilegedApiRequestSummary object with values from keyword arguments.
- SEVERITY_SEV_1 = 'SEV_1'¶
A constant which can be used with the severity property of a PrivilegedApiRequestSummary. 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 PrivilegedApiRequestSummary. 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 PrivilegedApiRequestSummary. 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 PrivilegedApiRequestSummary. This constant has a value of “SEV_4”
- __init__(**kwargs)¶
Initializes a new PrivilegedApiRequestSummary 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 PrivilegedApiRequestSummary.
display_name (str) – The value to assign to the display_name property of this PrivilegedApiRequestSummary.
request_id (str) – The value to assign to the request_id property of this PrivilegedApiRequestSummary.
reason_summary (str) – The value to assign to the reason_summary property of this PrivilegedApiRequestSummary.
compartment_id (str) – The value to assign to the compartment_id property of this PrivilegedApiRequestSummary.
resource_name (str) – The value to assign to the resource_name property of this PrivilegedApiRequestSummary.
resource_id (str) – The value to assign to the resource_id property of this PrivilegedApiRequestSummary.
sub_resource_name_list (list[str]) – The value to assign to the sub_resource_name_list property of this PrivilegedApiRequestSummary.
resource_type (str) – The value to assign to the resource_type property of this PrivilegedApiRequestSummary.
privileged_operation_list (list[oci.apiaccesscontrol.models.PrivilegedApiRequestOperationDetails]) – The value to assign to the privileged_operation_list property of this PrivilegedApiRequestSummary.
state (str) – The value to assign to the state property of this PrivilegedApiRequestSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this PrivilegedApiRequestSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this PrivilegedApiRequestSummary.
time_created (datetime) – The value to assign to the time_created property of this PrivilegedApiRequestSummary.
time_updated (datetime) – The value to assign to the time_updated property of this PrivilegedApiRequestSummary.
duration_in_hrs (int) – The value to assign to the duration_in_hrs property of this PrivilegedApiRequestSummary.
severity (str) – The value to assign to the severity property of this PrivilegedApiRequestSummary. Allowed values for this property are: “SEV_1”, “SEV_2”, “SEV_3”, “SEV_4”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_requested_for_future_access (datetime) – The value to assign to the time_requested_for_future_access property of this PrivilegedApiRequestSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PrivilegedApiRequestSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PrivilegedApiRequestSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PrivilegedApiRequestSummary.
- property compartment_id¶
Gets the compartment_id of this PrivilegedApiRequestSummary. The OCID of the compartment that contains the privilegedApi request.
- Returns
The compartment_id of this PrivilegedApiRequestSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this PrivilegedApiRequestSummary. 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 PrivilegedApiRequestSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this PrivilegedApiRequestSummary. Name of the privilegedApi control. The name must be unique.
- Returns
The display_name of this PrivilegedApiRequestSummary.
- Return type
str
- property duration_in_hrs¶
Gets the duration_in_hrs of this PrivilegedApiRequestSummary. Duration in hours for which access is sought on the target resource.
- Returns
The duration_in_hrs of this PrivilegedApiRequestSummary.
- Return type
int
- property freeform_tags¶
Gets the freeform_tags of this PrivilegedApiRequestSummary. 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 PrivilegedApiRequestSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this PrivilegedApiRequestSummary. The OCID of the access request.
- Returns
The id of this PrivilegedApiRequestSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this PrivilegedApiRequestSummary. More in detail about the lifeCycleState.
- Returns
The lifecycle_details of this PrivilegedApiRequestSummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this PrivilegedApiRequestSummary. The current state of the PrivilegedApiRequest.
- Returns
The lifecycle_state of this PrivilegedApiRequestSummary.
- Return type
str
- property privileged_operation_list¶
Gets the privileged_operation_list of this PrivilegedApiRequestSummary. List of api names, attributes for which approval is sought by the user.
- Returns
The privileged_operation_list of this PrivilegedApiRequestSummary.
- Return type
list[oci.apiaccesscontrol.models.PrivilegedApiRequestOperationDetails]
- property reason_summary¶
[Required] Gets the reason_summary of this PrivilegedApiRequestSummary. Comment associated with the privilegedApi request.
- Returns
The reason_summary of this PrivilegedApiRequestSummary.
- Return type
str
- property request_id¶
Gets the request_id of this PrivilegedApiRequestSummary. This is a system-generated identifier to identity a Request in human readable form in the form of REQYYYYMMDD<number>.
- Returns
The request_id of this PrivilegedApiRequestSummary.
- Return type
str
- property resource_id¶
[Required] Gets the resource_id of this PrivilegedApiRequestSummary. The OCID of the target resource associated with the privilegedApi request. The operator raises an privilegedApi request to get approval to access the target resource.
- Returns
The resource_id of this PrivilegedApiRequestSummary.
- Return type
str
- property resource_name¶
Gets the resource_name of this PrivilegedApiRequestSummary. resourceName for which the PrivilegedApiRequest is applicable
- Returns
The resource_name of this PrivilegedApiRequestSummary.
- Return type
str
- property resource_type¶
Gets the resource_type of this PrivilegedApiRequestSummary. resourceType for which the PrivilegedApiRequest is applicable
- Returns
The resource_type of this PrivilegedApiRequestSummary.
- Return type
str
- property severity¶
Gets the severity of this PrivilegedApiRequestSummary. Priority assigned to the privilegedApi request by the operator
Allowed values for this property are: “SEV_1”, “SEV_2”, “SEV_3”, “SEV_4”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The severity of this PrivilegedApiRequestSummary.
- Return type
str
- property state¶
Gets the state of this PrivilegedApiRequestSummary. The current state of the Access Request.
- Returns
The state of this PrivilegedApiRequestSummary.
- Return type
str
- property sub_resource_name_list¶
Gets the sub_resource_name_list of this PrivilegedApiRequestSummary. The subresource names requested for approval.
- Returns
The sub_resource_name_list of this PrivilegedApiRequestSummary.
- Return type
list[str]
- property system_tags¶
Gets the system_tags of this PrivilegedApiRequestSummary. System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this PrivilegedApiRequestSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this PrivilegedApiRequestSummary. Time when the privilegedApi request was created by the operator user in `RFC 3339`__ timestamp format.Example: ‘2020-05-22T21:10:29.600Z’
- Returns
The time_created of this PrivilegedApiRequestSummary.
- Return type
datetime
- property time_requested_for_future_access¶
Gets the time_requested_for_future_access of this PrivilegedApiRequestSummary. Time in future when the user for the access 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 PrivilegedApiRequestSummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this PrivilegedApiRequestSummary. Time when the privilegedApi request was last modified in `RFC 3339`__ timestamp format.Example: ‘2020-05-22T21:10:29.600Z’
- Returns
The time_updated of this PrivilegedApiRequestSummary.
- Return type
datetime