Oracle Cloud Infrastructure Documentation
Try Free Tier

Operator Access Control Operator Control Assignment Funtions

Package: DBMS_CLOUD_OCI_OAC_OPERATOR_CONTROL_ASSIGNMENT

CHANGE_OPERATOR_CONTROL_ASSIGNMENT_COMPARTMENT Function

Changes the compartment of the specified Operator Control assignment ID.

Syntax

FUNCTION change_operator_control_assignment_compartment (
  operator_control_assignment_id varchar2,
  change_operator_control_assignment_compartment_details dbms_cloud_oci_operator_access_control_change_operator_control_assignment_compartment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oac_operator_control_assignment_change_operator_control_assignment_compartment_response_t;

Parameters

Parameter Description

operator_control_assignment_id

(required) unique OperatorControl identifier

change_operator_control_assignment_compartment_details

(required) Changes the compartment for the given operator control assignment.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operator-access-control.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_OPERATOR_CONTROL_ASSIGNMENT Function

Creates an Operator Control Assignment resource. In effect, this brings the target resource under the governance of the Operator Control for specified time duration.

Syntax

FUNCTION create_operator_control_assignment (
  create_operator_control_assignment_details dbms_cloud_oci_operator_access_control_create_operator_control_assignment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oac_operator_control_assignment_create_operator_control_assignment_response_t;

Parameters

Parameter Description

create_operator_control_assignment_details

(required) Details of the Operator Control Assignment.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operator-access-control.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_OPERATOR_CONTROL_ASSIGNMENT Function

Deletes the specified Operator Control Assignment. This has the effect of unassigning the specific Operator Control from the target resource.

Syntax

FUNCTION delete_operator_control_assignment (
  operator_control_assignment_id varchar2,
  description varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oac_operator_control_assignment_delete_operator_control_assignment_response_t;

Parameters

Parameter Description

operator_control_assignment_id

(required) unique OperatorControl identifier

description

(optional) reason for detachment of OperatorAssignment.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operator-access-control.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_OPERATOR_CONTROL_ASSIGNMENT Function

Gets the details of an Operator Control Assignment of the specified ID.

Syntax

FUNCTION get_operator_control_assignment (
  operator_control_assignment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oac_operator_control_assignment_get_operator_control_assignment_response_t;

Parameters

Parameter Description

operator_control_assignment_id

(required) unique OperatorControl identifier

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operator-access-control.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_OPERATOR_CONTROL_ASSIGNMENTS Function

Lists all Operator Control Assignments.

Syntax

FUNCTION list_operator_control_assignments (
  compartment_id varchar2,
  operator_control_name varchar2 DEFAULT NULL,
  resource_name varchar2 DEFAULT NULL,
  resource_type varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oac_operator_control_assignment_list_operator_control_assignments_response_t;

Parameters

Parameter Description

compartment_id

(required) The ID of the compartment in which to list resources.

operator_control_name

(optional) A filter to return OperatorControl that match the given operatorControlName.

resource_name

(optional) A filter to return only resources that match the given ResourceName.

resource_type

(optional) A filter to return only lists of resources that match the entire given service type.

lifecycle_state

(optional) A filter to return only resources whose lifecycleState matches the given OperatorControlAssignment lifecycleState.

Allowed values are: 'CREATED', 'APPLIED', 'APPLYFAILED', 'UPDATING', 'UPDATEFAILED', 'DELETING', 'DELETED', 'DELETIONFAILED'

limit

(optional) The maximum number of items to return.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

sort_order

(optional) The sort order to use, either 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

Allowed values are: 'timeCreated', 'displayName'

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operator-access-control.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_OPERATOR_CONTROL_ASSIGNMENT Function

Modifies the existing Operator Control assignment of the specified Operator Control assignment ID. Modifying the assignment does not change the Operator Control assignment ID.

Syntax

FUNCTION update_operator_control_assignment (
  operator_control_assignment_id varchar2,
  update_operator_control_assignment_details dbms_cloud_oci_operator_access_control_update_operator_control_assignment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oac_operator_control_assignment_update_operator_control_assignment_response_t;

Parameters

Parameter Description

operator_control_assignment_id

(required) unique OperatorControl identifier

update_operator_control_assignment_details

(required) Details for the new operator control assignment.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operator-access-control.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

Was this article helpful?