Modifying a Private Endpoint

Modify an external key manager private endpoint.

You can modify an External KMS private endpoint to represent the external key management resource in the VCN and access the OCI KMS service.

    1. Open the Oracle Cloud Console navigation menu and click Identity & Security. Under Key Management and Secret Management, click Private Endpoints.
    2. In the Private Endpoints page, select a private endpoint in the summary table.
    3. In the Private Endpoint page, click the three dots next to a private endpoint in the summary table and click Edit.
    4. In the Edit Private Endpoint page, update the private endpoint name.
    5. Click Submit.

      Once you modify an External KMS private endpoint, you can access the Private Endpoint Details page to see the endpoint in "ACTIVE" state. You can use the actions at the page top to rename, move resource, add tags or delete the endpoint.

  • Open a command prompt and run oci kms ekm ekms-private-endpoint update to modify a private endpoint.

    oci kms ekm ekms-private-endpoint update -ekms-private-endpoint-id, -defined-tags

    Example

    --ekms-private-endpoint-id "ocid1.ekmsprivateendpoint.region1.sea.aeezmswpspiaa.abexamplekhf7t52cxoqe6vvb4pwajr", 
    --defined-tags { "Tag": {"key": "value"} }, 
    --display-name "Example EKMS PE UPDATE", 
    --freeform-tags {"key": "value"}
    

    Avoid entering confidential information.

    For a complete list of flags and variable options for Vault CLI commands, see Command Line Reference.

  • Run the UpdateEkmsPrivateEndpoint operation to modify private endpoint for connecting External KMS to Thales CipherTrust Manager.

    Note

    Each region has a unique endpoint for create, update, and list operations for secrets. This endpoint is referred to as the control plane URL or secret management endpoint. Each region also has a unique endpoint for operations related to retrieving secret contents. This endpoint is known as the data plane URL or the secret retrieval endpoint. For regional endpoints, see the API Documentation.

    For information about using the API and signing requests, see REST API documentation and Security Credentials. For information about SDKs, see SDKs and the CLI.