CreatePrivilegedApiControlDetails¶

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

Bases: object

The data to create a PrivilegedApiControl.

Methods

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

Attributes

`approver_group_id_list`	[Required] Gets the approver_group_id_list of this CreatePrivilegedApiControlDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreatePrivilegedApiControlDetails.
`defined_tags`	Gets the defined_tags of this CreatePrivilegedApiControlDetails.
`description`	Gets the description of this CreatePrivilegedApiControlDetails.
`display_name`	Gets the display_name of this CreatePrivilegedApiControlDetails.
`freeform_tags`	Gets the freeform_tags of this CreatePrivilegedApiControlDetails.
`notification_topic_id`	[Required] Gets the notification_topic_id of this CreatePrivilegedApiControlDetails.
`number_of_approvers`	Gets the number_of_approvers of this CreatePrivilegedApiControlDetails.
`privileged_operation_list`	[Required] Gets the privileged_operation_list of this CreatePrivilegedApiControlDetails.
`resource_type`	[Required] Gets the resource_type of this CreatePrivilegedApiControlDetails.
`resources`	[Required] Gets the resources of this CreatePrivilegedApiControlDetails.

__init__(**kwargs)¶

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

Parameters:

display_name (str) – The value to assign to the display_name property of this CreatePrivilegedApiControlDetails.
description (str) – The value to assign to the description property of this CreatePrivilegedApiControlDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreatePrivilegedApiControlDetails.
notification_topic_id (str) – The value to assign to the notification_topic_id property of this CreatePrivilegedApiControlDetails.
approver_group_id_list (list[str]) – The value to assign to the approver_group_id_list property of this CreatePrivilegedApiControlDetails.
privileged_operation_list (list[oci.apiaccesscontrol.models.PrivilegedApiDetails]) – The value to assign to the privileged_operation_list property of this CreatePrivilegedApiControlDetails.
resource_type (str) – The value to assign to the resource_type property of this CreatePrivilegedApiControlDetails.
resources (list[str]) – The value to assign to the resources property of this CreatePrivilegedApiControlDetails.
number_of_approvers (int) – The value to assign to the number_of_approvers property of this CreatePrivilegedApiControlDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreatePrivilegedApiControlDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreatePrivilegedApiControlDetails.

approver_group_id_list¶

[Required] Gets the approver_group_id_list of this CreatePrivilegedApiControlDetails. List of user IAM group ids who can approve an privilegedApi request associated with a resource governed by this operator control.

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

compartment_id¶

[Required] Gets the compartment_id of this CreatePrivilegedApiControlDetails. The OCID of the compartment to create the PrivilegedApiControl in.

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

defined_tags¶

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

description¶

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

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

display_name¶

Gets the display_name of this CreatePrivilegedApiControlDetails. Name of the privilegedApi control It has to be unique.

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

freeform_tags¶

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

notification_topic_id¶

[Required] Gets the notification_topic_id of this CreatePrivilegedApiControlDetails. The OCID of the OCI Notification topic to publish messages related to this Delegation Control.

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

number_of_approvers¶

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

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

privileged_operation_list¶

[Required] Gets the privileged_operation_list of this CreatePrivilegedApiControlDetails. List of privileged operator operations. If Privileged API Managment is enabled for a resource it will be validated whether the operation done by the operator is a part of privileged operation.

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

resource_type¶

[Required] Gets the resource_type of this CreatePrivilegedApiControlDetails. resourceType for which the PrivilegedApiControl is applicable

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

resources¶

[Required] Gets the resources of this CreatePrivilegedApiControlDetails. contains Resource details

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