Oracle Cloud Infrastructure Documentation

Renaming Key References

Learn how to rename a key reference created for an encryption key stored in an external key managmeent system.

After you create a key reference, you can rename it by accessing the Key Reference Details page.

    1. Open the navigation menu , select Identity & Security, and then select External Key Management.
    2. In the External key Management home page, select a vault from the list.
    3. In the Vault Details page, select a key reference.
    4. In the Key Reference Details page, select Rename.
      Note

      You can update the key reference name, but not the external Key GUID.
      .

  • Open a command prompt and run oci kms management key update to rename a key reference:

    oci kms management key update --external-key-reference --display-name

    Avoid entering confidential information.

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

  • Use the UpdateKey API with the Management Endpoint to rename a key reference.

    Note

    The Management Endpoint is used for management operations including Create, Update, List, Get, and Delete. The Management Endpoint is also called the control plane URL or the KMSMANAGMENT endpoint.

    The Cryptographic Endpoint is used for cryptographic operations including Encrypt, Decrypt, Generate Data Encryption Key, Sign, and Verify. The Cryptographic Endpoint is also called the data plane URL or the KMSCRYPTO endpoint.

    You can find the management and cryptographic endpoints in a vault's details metadata. See Getting a Vault's Details for instructions.

    For regional endpoints for the Key Management, Secret Management, and Secret Retrieval APIs, see API Reference and Endpoints.

    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.