Oracle Cloud Infrastructure Documentation

Viewing a Key Version

Learn how to view or retrieve information about a key version of a Master Encryption Key.

For information on retrieving key material for software-protected master encryption keys and key versions, see Exporting Vault Keys and Key Versions.

    1. On the Master Encryption Keys list page, find the key that you want to work with. If you need help finding the list page, see Listing Keys.
    2. Select the name of the key you want to work with, then select Versions to see the list of key versions for the key.
    3. Each key version in the list can be identified by its OCID. Select Actions menu (three dots) in the row for a key version, and then select Copy to clipboard to retrieve the OCID of the key version. You can also view the following for each key version:
      • State
      • Auto rotation configuration
      • Source of key material: internal (created within OCI Key Management) or external (created using a third-party tool and then imported into an OCI vault)
      • Creation date

  • Use the oci kms management key-version get command and required parameters to retrieve a key version of an OCI Master Encryption Key:

    oci kms management key-version get --key-id <key_ocid> --key-version-id <key_version_ocid> [OPTIONS]

    For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

  • Run the GetKeyVersion operation with the Management Endpoint to retrieve a key version of an OCI Master Encryption Key.

    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.