Updating Secret Description

Learn how to update the description of a secret stored in an OCI vault.

• Console
• CLI
• API

• 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 that has the secret with the description you want to update.

  3. From the list of vaults in the compartment, select the vault name.

  4. Select Secrets, and then select the name of the secret you want to edit. (If needed, first change the list scope to the compartment that contains the secret.)
  5. Select Edit.
  6. In the Edit Secret dialog box, select Description, and then enter a new description. Avoid entering any confidential information in this field.
  7. When you're finished, select Save Changes.

• Use the update command to update the details of a secret in a vault.

  Open a command prompt and run oci vault secret update to edit a secret's description.

  Caution
  
  Avoid entering confidential information in the secret description. Also, you must update the current secret version number, secret contents, and secret rules independently of one another. Lastly, you can only update secrets in an Active lifecycle state.

  Command

  CopyTry It

  oci vault secret update --secret-id <secret_OCID> --description <secret_description_text>

  For example:

  
  oci vault secret update --secret-id ocid1.vaultsecret.oc1.iad.exampleaz5qacpqahuecvbjqzql4qmpbrtd7pprafhivcfik6wuitexample --description "this is a new secret description"

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

• Use the UpdateSecret API with the Management Endpoint to update a secret description.

  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.