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. On the External Key Management Vaults page, find the vault that you want to work with. If you need help finding the list page or the vault, see Listing External Key Management Vaults.
    2. Select the name of the vault to see its details.
    3. In the Keys tab, select the name of a key reference to see its details.
    4. In the Key Reference Details page, select Edit Name.
      Note

      You can update the key reference name, but not the external Key GUID.
      .
    5. Enter a new name.
    6. Select Save Changes.

  • Use the oci kms management key update command and required parameters to rename a key reference:

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

    Avoid entering confidential information.

    For a complete list of parameters and values for CLI commands, see the CLI Command 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 KMSMANAGEMENT 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.