Updating Secret Description

Update vault secret using the OCI Console, CLI, and API interfaces

• Console
• CLI
• API

• 1. Open the navigation menu, click Identity & Security, and then click Vault.
  2. Under List Scope, in the Compartment list, click 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, click the vault name.

  4. Click Secrets, and then click the name of the secret you want to edit. (If needed, first change the list scope to the compartment that contains the secret.)
  5. Click Edit.
  6. In the Edit Secret dialog box, click Description, and then enter a new description. Avoid entering any confidential information in this field.
  7. When you are finished, click 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.

  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.

• Run the UpdateSecret operation to update a secret description.

  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.