Oracle Cloud Infrastructure Documentation

Getting a Vault's Details

Learn how to get the an OCI vault's details.

    1. Open the navigation menu , select Identity & Security, and then select Vault.
    2. Under List scope, select the compartment that contains the vault.
    3. From the list of vaults in the compartment, select a vault name to open its details page.
    The Vault Information section displays the following information:
    • Compartment: The name of the compartment that contains the vault.
    • OCID: The unique, Oracle-assigned ID of the vault.
    • Created: The date and time when you initially created the vault.
    • HSM Key Version Usage: The total number of key versions across all HSM-protected keys that the vault contains.
    • Virtual Private: The vault is a virtual private type.
    • Crytographic Endpoint: The service endpoint to perform cryptographic operations such encrypt, decrypt and so forth.
    • Management Endpoint: The service endpoint to perform management operations such as "create, get,list, delete and so forth.

  • Open a command prompt and run oci kms management vault get operation.

    oci kms management vault get [OPTIONS]

    For example:

     oci kms management vault get --vault-id vault

    Cryptographic operations involving objects that were encrypted with the previous version of this key will continue to use the older key version. You can re-encrypt those objects with the current key version if you prefer.

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

  • Use the GetVault API to get information about a specific vault.

    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.