PrivilegedApiControl¶

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

Bases: object

A PrivilegedApiControl is a kind of Policy definition which provides details about which operations needs to be secure; who can approve a privilegedApiRequest requesting for a particular operation, whether the operations needs to be approved by customer or is it preApproved.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a PrivilegedApiControl.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a PrivilegedApiControl.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a PrivilegedApiControl.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a PrivilegedApiControl.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a PrivilegedApiControl.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a PrivilegedApiControl.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a PrivilegedApiControl.
`approver_group_id_list`	Gets the approver_group_id_list of this PrivilegedApiControl.
`compartment_id`	[Required] Gets the compartment_id of this PrivilegedApiControl.
`defined_tags`	[Required] Gets the defined_tags of this PrivilegedApiControl.
`description`	Gets the description of this PrivilegedApiControl.
`display_name`	[Required] Gets the display_name of this PrivilegedApiControl.
`freeform_tags`	[Required] Gets the freeform_tags of this PrivilegedApiControl.
`id`	[Required] Gets the id of this PrivilegedApiControl.
`lifecycle_details`	Gets the lifecycle_details of this PrivilegedApiControl.
`lifecycle_state`	[Required] Gets the lifecycle_state of this PrivilegedApiControl.
`notification_topic_id`	Gets the notification_topic_id of this PrivilegedApiControl.
`number_of_approvers`	Gets the number_of_approvers of this PrivilegedApiControl.
`privileged_operation_list`	Gets the privileged_operation_list of this PrivilegedApiControl.
`resource_type`	Gets the resource_type of this PrivilegedApiControl.
`resources`	Gets the resources of this PrivilegedApiControl.
`state`	[Required] Gets the state of this PrivilegedApiControl.
`state_details`	Gets the state_details of this PrivilegedApiControl.
`system_tags`	Gets the system_tags of this PrivilegedApiControl.
`time_created`	[Required] Gets the time_created of this PrivilegedApiControl.
`time_deleted`	Gets the time_deleted of this PrivilegedApiControl.
`time_updated`	Gets the time_updated of this PrivilegedApiControl.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a PrivilegedApiControl. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a PrivilegedApiControl. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a PrivilegedApiControl. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a PrivilegedApiControl. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a PrivilegedApiControl. This constant has a value of “FAILED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a PrivilegedApiControl. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a PrivilegedApiControl. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new PrivilegedApiControl 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 PrivilegedApiControl.
display_name (str) – The value to assign to the display_name property of this PrivilegedApiControl.
compartment_id (str) – The value to assign to the compartment_id property of this PrivilegedApiControl.
description (str) – The value to assign to the description property of this PrivilegedApiControl.
notification_topic_id (str) – The value to assign to the notification_topic_id property of this PrivilegedApiControl.
approver_group_id_list (list[str]) – The value to assign to the approver_group_id_list property of this PrivilegedApiControl.
resource_type (str) – The value to assign to the resource_type property of this PrivilegedApiControl.
resources (list[str]) – The value to assign to the resources property of this PrivilegedApiControl.
privileged_operation_list (list[oci.apiaccesscontrol.models.PrivilegedApiDetails]) – The value to assign to the privileged_operation_list property of this PrivilegedApiControl.
number_of_approvers (int) – The value to assign to the number_of_approvers property of this PrivilegedApiControl.
time_created (datetime) – The value to assign to the time_created property of this PrivilegedApiControl.
time_updated (datetime) – The value to assign to the time_updated property of this PrivilegedApiControl.
time_deleted (datetime) – The value to assign to the time_deleted property of this PrivilegedApiControl.
state (str) – The value to assign to the state property of this PrivilegedApiControl.
state_details (str) – The value to assign to the state_details property of this PrivilegedApiControl.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this PrivilegedApiControl. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this PrivilegedApiControl.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PrivilegedApiControl.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PrivilegedApiControl.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PrivilegedApiControl.

approver_group_id_list¶

Gets the approver_group_id_list of this PrivilegedApiControl. List of IAM user group ids who can approve an privilegedApi request associated with a target resource under the governance of this operator control.

Returns:	The approver_group_id_list of this PrivilegedApiControl.
Return type:	list[str]

compartment_id¶

[Required] Gets the compartment_id of this PrivilegedApiControl. The OCID of the compartment.

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

defined_tags¶

[Required] Gets the defined_tags of this PrivilegedApiControl. 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 PrivilegedApiControl.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this PrivilegedApiControl. Description of privilegedApi control.

Returns:	The description of this PrivilegedApiControl.
Return type:	str

display_name¶

[Required] Gets the display_name of this PrivilegedApiControl. Name of the privilegedApi control. The name must be unique.

Returns:	The display_name of this PrivilegedApiControl.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this PrivilegedApiControl. 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 PrivilegedApiControl.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this PrivilegedApiControl. The OCID of the PrivilegedApiControl.

Returns:	The id of this PrivilegedApiControl.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this PrivilegedApiControl. A message that describes the current state of the PrivilegedApiControl in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:	The lifecycle_details of this PrivilegedApiControl.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this PrivilegedApiControl. The current state of the PrivilegedApiControl.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this PrivilegedApiControl.
Return type:	str

notification_topic_id¶

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

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

number_of_approvers¶

Gets the number_of_approvers of this PrivilegedApiControl. Number of approvers required to approve an privilegedApi request.

Returns:	The number_of_approvers of this PrivilegedApiControl.
Return type:	int

privileged_operation_list¶

Gets the privileged_operation_list of this PrivilegedApiControl. List of privileged operations/apis. These operations/apis will be treaated as secured, once enabled by the Privileged API Managment for a resource. Any of these operations, if needs to be executed, needs to be raised as a PrivilegedApi Request which needs to be approved by customers or it can be pre-approved.

Returns:	The privileged_operation_list of this PrivilegedApiControl.
Return type:	list[oci.apiaccesscontrol.models.PrivilegedApiDetails]

resource_type¶

Gets the resource_type of this PrivilegedApiControl. resourceType for which the PrivilegedApiControl is applicable

Returns:	The resource_type of this PrivilegedApiControl.
Return type:	str

resources¶

Gets the resources of this PrivilegedApiControl. contains Resource details

Returns:	The resources of this PrivilegedApiControl.
Return type:	list[str]

state¶

[Required] Gets the state of this PrivilegedApiControl. The current state of the PrivilegedApiControl.

Returns:	The state of this PrivilegedApiControl.
Return type:	str

state_details¶

Gets the state_details of this PrivilegedApiControl. A message that describes the current state of the PrivilegedApiControl in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:	The state_details of this PrivilegedApiControl.
Return type:	str

system_tags¶

Gets the system_tags of this PrivilegedApiControl. 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 PrivilegedApiControl.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this PrivilegedApiControl. The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this PrivilegedApiControl.
Return type:	datetime

time_deleted¶

Gets the time_deleted of this PrivilegedApiControl. The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_deleted of this PrivilegedApiControl.
Return type:	datetime

time_updated¶

Gets the time_updated of this PrivilegedApiControl. The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_updated of this PrivilegedApiControl.
Return type:	datetime