Lockbox Functions

Package: DBMS_CLOUD_OCI_LBX_LOCKBOX

CANCEL_WORK_REQUEST Function

Cancels the work request with the given ID.

Syntax

FUNCTION cancel_work_request (
  work_request_id varchar2,
  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_lbx_lockbox_cancel_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`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://managed-access.{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.

CHANGE_APPROVAL_TEMPLATE_COMPARTMENT Function

Moves an ApprovalTemplate resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_approval_template_compartment (
  approval_template_id varchar2,
  change_approval_template_compartment_details dbms_cloud_oci_lockbox_change_approval_template_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lbx_lockbox_change_approval_template_compartment_response_t;

Parameters

Parameter	Description
`approval_template_id`	(required) The unique identifier (OCID) of the approval template.
`change_approval_template_compartment_details`	(required) The information to be updated.
`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.
`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.
`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://managed-access.{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.

CHANGE_LOCKBOX_COMPARTMENT Function

Moves a Lockbox resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_lockbox_compartment (
  lockbox_id varchar2,
  change_lockbox_compartment_details dbms_cloud_oci_lockbox_change_lockbox_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lbx_lockbox_change_lockbox_compartment_response_t;

Parameters

Parameter	Description
`lockbox_id`	(required) unique Lockbox identifier
`change_lockbox_compartment_details`	(required) The information to be updated.
`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.
`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.
`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://managed-access.{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_ACCESS_REQUEST Function

Creates a new access request.

Syntax

FUNCTION create_access_request (
  create_access_request_details dbms_cloud_oci_lockbox_create_access_request_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_lbx_lockbox_create_access_request_response_t;

Parameters

Parameter	Description
`create_access_request_details`	(required) Details for the new access request.
`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://managed-access.{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_APPROVAL_TEMPLATE Function

Creates a new approval template.

Syntax

FUNCTION create_approval_template (
  create_approval_template_details dbms_cloud_oci_lockbox_create_approval_template_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_lbx_lockbox_create_approval_template_response_t;

Parameters

Parameter	Description
`create_approval_template_details`	(required) Details for the new approval template.
`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://managed-access.{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_LOCKBOX Function

Creates a new Lockbox.

Syntax

FUNCTION create_lockbox (
  create_lockbox_details dbms_cloud_oci_lockbox_create_lockbox_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_lbx_lockbox_create_lockbox_response_t;

Parameters

Parameter	Description
`create_lockbox_details`	(required) Details for the new Lockbox.
`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://managed-access.{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_APPROVAL_TEMPLATE Function

Deletes an ApprovalTemplate resource by identifier

Syntax

FUNCTION delete_approval_template (
  approval_template_id varchar2,
  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_lbx_lockbox_delete_approval_template_response_t;

Parameters

Parameter	Description
`approval_template_id`	(required) The unique identifier (OCID) of the approval template.
`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://managed-access.{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_LOCKBOX Function

Deletes a Lockbox resource by identifier

Syntax

FUNCTION delete_lockbox (
  lockbox_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lbx_lockbox_delete_lockbox_response_t;

Parameters

Parameter	Description
`lockbox_id`	(required) unique Lockbox identifier
`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.
`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.
`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://managed-access.{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.

EXPORT_ACCESS_REQUESTS Function

Exports a list of AccessRequestSummary objects within a compartment and during a specified time range in text format. You can filter the results by problem severity.

Syntax

FUNCTION export_access_requests (
  export_access_requests_details dbms_cloud_oci_lockbox_export_access_requests_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  lockbox_partner varchar2 DEFAULT NULL,
  partner_id varchar2 DEFAULT NULL,
  requestor_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lbx_lockbox_export_access_requests_response_t;

Parameters

Parameter	Description
`export_access_requests_details`	(required)
`opc_request_id`	(optional) The client request ID for tracing.
`id`	(optional) A generic Id query param used to filter lockbox, access request and approval template by Id.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`lifecycle_state`	(optional) A filter to return only resources their lifecycleState matches the given lifecycleState.
`lockbox_partner`	(optional) The name of the lockbox partner. Allowed values are: 'FAAAS', 'CANARY'
`partner_id`	(optional) The ID of the partner.
`requestor_id`	(optional) The unique identifier (OCID) of the requestor in which to list resources.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`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. Allowed values are: 'timeCreated', 'displayName', 'id'
`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://managed-access.{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_MATERIALS Function

Retrieves the access credential/material associated with the access request.

Syntax

FUNCTION get_access_materials (
  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_lbx_lockbox_get_access_materials_response_t;

Parameters

Parameter	Description
`access_request_id`	(required) The unique identifier (OCID) of the access request.
`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://managed-access.{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

Retrieves an access request identified by the access request ID.

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_lbx_lockbox_get_access_request_response_t;

Parameters

Parameter	Description
`access_request_id`	(required) The unique identifier (OCID) of the access request.
`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://managed-access.{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_APPROVAL_TEMPLATE Function

Retrieves an approval template identified by the approval template ID.

Syntax

FUNCTION get_approval_template (
  approval_template_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_lbx_lockbox_get_approval_template_response_t;

Parameters

Parameter	Description
`approval_template_id`	(required) The unique identifier (OCID) of the approval template.
`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://managed-access.{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_LOCKBOX Function

Gets a Lockbox by identifier

Syntax

FUNCTION get_lockbox (
  lockbox_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_lbx_lockbox_get_lockbox_response_t;

Parameters

Parameter	Description
`lockbox_id`	(required) unique Lockbox 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://managed-access.{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_WORK_REQUEST Function

Gets details of the work request with the given ID.

Syntax

FUNCTION get_work_request (
  work_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_lbx_lockbox_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`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://managed-access.{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.

HANDLE_ACCESS_REQUEST Function

Handle the AccessRequest

Syntax

FUNCTION handle_access_request (
  access_request_id varchar2,
  handle_access_request_details dbms_cloud_oci_lockbox_handle_access_request_details_t,
  if_match varchar2 DEFAULT NULL,
  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_lbx_lockbox_handle_access_request_response_t;

Parameters

Parameter	Description
`access_request_id`	(required) The unique identifier (OCID) of the access request.
`handle_access_request_details`	(required) The details of handling access request
`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_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://managed-access.{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

Retrieves a list of AccessRequestSummary objects in a compartment.

Syntax

FUNCTION list_access_requests (
  opc_request_id varchar2 DEFAULT NULL,
  lockbox_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  lockbox_partner varchar2 DEFAULT NULL,
  partner_id varchar2 DEFAULT NULL,
  requestor_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  time_created_after timestamp with time zone DEFAULT NULL,
  time_created_before timestamp with time zone DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lbx_lockbox_list_access_requests_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) The client request ID for tracing.
`lockbox_id`	(optional) The unique identifier (OCID) of the associated lockbox.
`id`	(optional) A generic Id query param used to filter lockbox, access request and approval template by Id.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`lifecycle_state`	(optional) A filter to return only resources their lifecycleState matches the given lifecycleState.
`lockbox_partner`	(optional) The name of the lockbox partner. Allowed values are: 'FAAAS', 'CANARY'
`partner_id`	(optional) The ID of the partner.
`requestor_id`	(optional) The unique identifier (OCID) of the requestor in which to list resources.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`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. Allowed values are: 'timeCreated', 'displayName', 'id'
`time_created_after`	(optional) Date and time on or after which Access Requests were created, as described in RFC 3339
`time_created_before`	(optional) Date and time on or before which Access requests were created, as described in RFC 3339
`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://managed-access.{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_APPROVAL_TEMPLATES Function

Retrieves a list of ApprovalTemplateSummary objects in a compartment.

Syntax

FUNCTION list_approval_templates (
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  display_name 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,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lbx_lockbox_list_approval_templates_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) The client request ID for tracing.
`compartment_id`	(optional) The ID of the compartment in which to list resources.
`id`	(optional) A generic Id query param used to filter lockbox, access request and approval template by Id.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`lifecycle_state`	(optional) A filter to return only resources for which their lifecycleState matches the given lifecycleState.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`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. Allowed values are: 'timeCreated', 'displayName', 'id'
`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://managed-access.{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_LOCKBOXES Function

Returns a list of Lockboxes.

Syntax

FUNCTION list_lockboxes (
  compartment_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  lockbox_partner varchar2 DEFAULT NULL,
  partner_id 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_lbx_lockbox_list_lockboxes_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The ID of the compartment in which to list resources.
`lifecycle_state`	(optional) A filter to return only resources their lifecycleState matches the given lifecycleState.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`id`	(optional) unique Lockbox identifier
`resource_id`	(optional) The ID of the resource associated with the lockbox.
`lockbox_partner`	(optional) The name of the lockbox partner. Allowed values are: 'FAAAS', 'CANARY'
`partner_id`	(optional) The ID of the partner.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`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. Allowed values are: 'timeCreated', 'displayName', 'id'
`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://managed-access.{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_WORK_REQUEST_ERRORS Function

Returns a (paginated) list of errors for the work request with the given ID.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lbx_lockbox_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: 'timeAccepted'
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`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://managed-access.{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_WORK_REQUEST_LOGS Function

Returns a (paginated) list of logs for the work request with the given ID.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lbx_lockbox_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: 'timeAccepted'
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`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://managed-access.{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_WORK_REQUESTS Function

Lists the work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2 DEFAULT NULL,
  work_request_id varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lbx_lockbox_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The ID of the compartment in which to list resources.
`work_request_id`	(optional) The ID of the asynchronous work request.
`status`	(optional) A filter to return only resources their lifecycleState matches the given OperationStatus. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED', 'NEEDS_ATTENTION'
`resource_id`	(optional) The ID of the resource affected by the work request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`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 timeAccepted is descending. Allowed values are: 'timeAccepted'
`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://managed-access.{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_APPROVAL_TEMPLATE Function

Updates the ApprovalTemplate

Syntax

FUNCTION update_approval_template (
  approval_template_id varchar2,
  update_approval_template_details dbms_cloud_oci_lockbox_update_approval_template_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_lbx_lockbox_update_approval_template_response_t;

Parameters

Parameter	Description
`approval_template_id`	(required) The unique identifier (OCID) of the approval template.
`update_approval_template_details`	(required) The information to be updated.
`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://managed-access.{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_LOCKBOX Function

Updates the Lockbox

Syntax

FUNCTION update_lockbox (
  lockbox_id varchar2,
  update_lockbox_details dbms_cloud_oci_lockbox_update_lockbox_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_lbx_lockbox_update_lockbox_response_t;

Parameters

Parameter	Description
`lockbox_id`	(required) unique Lockbox identifier
`update_lockbox_details`	(required) The information to be updated.
`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://managed-access.{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