Oracle Cloud Infrastructure Documentation
Try Free Tier

Key Management Ekm Functions

Package: DBMS_CLOUD_OCI_KM_EKM

CREATE_EKMS_PRIVATE_ENDPOINT Function

Create a new EKMS private endpoint used to connect to external key manager system

Syntax

FUNCTION create_ekms_private_endpoint (
  create_ekms_private_endpoint_details dbms_cloud_oci_key_management_create_ekms_private_endpoint_details_t,
  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_km_ekm_create_ekms_private_endpoint_response_t;

Parameters

Parameter Description

create_ekms_private_endpoint_details

(required) The information used to create EKMS private endpoint.

opc_request_id

(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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://kms.{region}.{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_EKMS_PRIVATE_ENDPOINT Function

Deletes EKMS private endpoint by identifier.

Syntax

FUNCTION delete_ekms_private_endpoint (
  ekms_private_endpoint_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_km_ekm_delete_ekms_private_endpoint_response_t;

Parameters

Parameter Description

ekms_private_endpoint_id

(required) Unique EKMS private endpoint 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) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

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://kms.{region}.{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_EKMS_PRIVATE_ENDPOINT Function

Gets a specific EKMS private by identifier.

Syntax

FUNCTION get_ekms_private_endpoint (
  ekms_private_endpoint_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_km_ekm_get_ekms_private_endpoint_response_t;

Parameters

Parameter Description

ekms_private_endpoint_id

(required) Unique EKMS private endpoint identifier.

opc_request_id

(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

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://kms.{region}.{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_EKMS_PRIVATE_ENDPOINTS Function

Returns a list of all the EKMS private endpoints in the specified compartment.

Syntax

FUNCTION list_ekms_private_endpoints (
  compartment_id varchar2,
  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_km_ekm_list_ekms_private_endpoints_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

limit

(optional) The maximum number of items to return in a paginated \"List\" call.

page

(optional) The value of the `opc-next-page` response header from the previous \"List\" call.

sort_order

(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. You can specify only one sort order. The default order for `TIMECREATED` is descending. The default order for `DISPLAYNAME` is ascending.

Allowed values are: 'TIMECREATED', 'DISPLAYNAME'

opc_request_id

(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

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://kms.{region}.{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_EKMS_PRIVATE_ENDPOINT Function

Updates EKMS private endpoint.

Syntax

FUNCTION update_ekms_private_endpoint (
  ekms_private_endpoint_id varchar2,
  update_ekms_private_endpoint_details dbms_cloud_oci_key_management_update_ekms_private_endpoint_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_km_ekm_update_ekms_private_endpoint_response_t;

Parameters

Parameter Description

ekms_private_endpoint_id

(required) Unique EKMS private endpoint identifier.

update_ekms_private_endpoint_details

(required) The information to be updated in EKMS private endpoint

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) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

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://kms.{region}.{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?