Oracle Cloud Infrastructure Documentation

Viewing a Key's Summary Details

Learn how to view the summary details for a list of keys in a specified OCI vault. The summary for each key includes the key name, algorithm, compartment, auto-rotation status, and other metadata.

    1. Open the navigation menu , select Identity & Security, and then select Vault.
    2. Under List Scope, in the Compartment list, select the name of the compartment that contains the vault with the keys you're interested in.
    3. From the list of vaults in the compartment, select the vault name.
    4. To see a list of keys in this vault, select Master Encryption Keys. You can see keys in other compartments by changing the list scope. The list table includes summary details for lifecycle state, protection mode, encryption algorithm, and creation date. For more information about a key, select the key name and view the details in Key Information and Versions.

  • Open a command prompt and run oci kms management key list to list keys in a vault:

    oci kms management key list --compartment-id <target_compartment_id> --endpoint <control_plane_url>

    For example:

    
oci kms management key list --compartment-id ocid1.compartment.oc1..example1example25qrlpo4agcmothkbgqgmuz2zzum45ibplooqtabwk3zz --endpoint https://exampleaaacu2-management.kms.us-ashburn-1.oraclecloud.com

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

  • Use the ListKeys API with the Management Endpoint to get the summary details for each key in the list of master encryption keys. The summary details for each key are described in the KeySummary 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.