Operator Access Control Access Requests Functions

Package: DBMS_CLOUD_OCI_OAC_ACCESS_REQUESTS

APPROVE_ACCESS_REQUEST Function

Approves an access request.

Syntax

FUNCTION approve_access_request (
  access_request_id varchar2,
  approve_access_request_details dbms_cloud_oci_operator_access_control_approve_access_request_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_access_requests_approve_access_request_response_t;

Parameters

Parameter	Description
`access_request_id`	(required) unique AccessRequest identifier
`approve_access_request_details`	(required) Details regarding the approval of an access request created by the operator.
`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.

GET_ACCESS_REQUEST Function

Gets details of an access request.

Syntax

FUNCTION get_access_request (
  access_request_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_access_requests_get_access_request_response_t;

Parameters

Parameter	Description
`access_request_id`	(required) unique AccessRequest 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.

INTERACTION_REQUEST Function

Posts query for additional information for the given access request.

Syntax

FUNCTION interaction_request (
  access_request_id varchar2,
  interaction_request_details dbms_cloud_oci_operator_access_control_interaction_request_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_access_requests_interaction_request_response_t;

Parameters

Parameter	Description
`access_request_id`	(required) unique AccessRequest identifier
`interaction_request_details`	(required) Details containing Query for additional information provided by Customer.
`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.

LIST_ACCESS_REQUEST_HISTORIES Function

Returns a history of all status associated with the accessRequestId.

Syntax

FUNCTION list_access_request_histories (
  access_request_id varchar2,
  limit number DEFAULT NULL,
  page 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_access_requests_list_access_request_histories_response_t;

Parameters

Parameter	Description
`access_request_id`	(required) unique AccessRequest identifier
`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.
`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_ACCESS_REQUESTS Function

Lists all access requests in the compartment.

Syntax

FUNCTION list_access_requests (
  compartment_id varchar2,
  resource_name varchar2 DEFAULT NULL,
  resource_type varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  time_start timestamp with time zone DEFAULT NULL,
  time_end timestamp with time zone 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_access_requests_list_access_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`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 AccessRequest lifecycleState. Allowed values are: 'CREATED', 'APPROVALWAITING', 'PREAPPROVED', 'APPROVED', 'MOREINFO', 'REJECTED', 'DEPLOYED', 'DEPLOYFAILED', 'UNDEPLOYED', 'UNDEPLOYFAILED', 'CLOSEFAILED', 'REVOKEFAILED', 'EXPIRYFAILED', 'REVOKING', 'REVOKED', 'EXTENDING', 'EXTENDED', 'EXTENSIONREJECTED', 'COMPLETING', 'COMPLETED', 'EXPIRED', 'APPROVEDFORFUTURE', 'INREVIEW'
`time_start`	(optional) Query start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd parameters are used together.
`time_end`	(optional) Query start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd parameters are used together.
`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.

LIST_INTERACTIONS Function

Lists the MoreInformation interaction between customer and operators.

Syntax

FUNCTION list_interactions (
  access_request_id varchar2,
  limit number DEFAULT NULL,
  page 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_access_requests_list_interactions_response_t;

Parameters

Parameter	Description
`access_request_id`	(required) unique AccessRequest identifier
`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.
`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.

REJECT_ACCESS_REQUEST Function

Rejects an access request.

Syntax

FUNCTION reject_access_request (
  access_request_id varchar2,
  reject_access_request_details dbms_cloud_oci_operator_access_control_reject_access_request_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_access_requests_reject_access_request_response_t;

Parameters

Parameter	Description
`access_request_id`	(required) unique AccessRequest identifier
`reject_access_request_details`	(required) Details regarding the rejection of an access request created by the operator.
`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.

REVIEW_ACCESS_REQUEST Function

Reviews the access request.

Syntax

FUNCTION review_access_request (
  access_request_id varchar2,
  review_access_request_details dbms_cloud_oci_operator_access_control_review_access_request_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_access_requests_review_access_request_response_t;

Parameters

Parameter	Description
`access_request_id`	(required) unique AccessRequest identifier
`review_access_request_details`	(required) Details regarding the approval of an access request created by the operator.
`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.

REVOKE_ACCESS_REQUEST Function

Revokes an already approved access request.

Syntax

FUNCTION revoke_access_request (
  access_request_id varchar2,
  revoke_access_request_details dbms_cloud_oci_operator_access_control_revoke_access_request_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_access_requests_revoke_access_request_response_t;

Parameters

Parameter	Description
`access_request_id`	(required) unique AccessRequest identifier
`revoke_access_request_details`	(required) Details regarding the revocation of an access request created by the operator.
`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.

Oracle Cloud Infrastructure Documentation Try Free Tier

APPROVE_ACCESS_REQUEST Function 🔗

GET_ACCESS_REQUEST Function 🔗

INTERACTION_REQUEST Function 🔗

LIST_ACCESS_REQUEST_HISTORIES Function 🔗

LIST_ACCESS_REQUESTS Function 🔗

LIST_INTERACTIONS Function 🔗

REJECT_ACCESS_REQUEST Function 🔗

REVIEW_ACCESS_REQUEST Function 🔗

REVOKE_ACCESS_REQUEST Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

APPROVE_ACCESS_REQUEST Function

GET_ACCESS_REQUEST Function

INTERACTION_REQUEST Function

LIST_ACCESS_REQUEST_HISTORIES Function

LIST_ACCESS_REQUESTS Function

LIST_INTERACTIONS Function

REJECT_ACCESS_REQUEST Function

REVIEW_ACCESS_REQUEST Function

REVOKE_ACCESS_REQUEST Function