Skip to main content

Rename a secret or describe it

A secret named only after its type, such as jira or jira-2, says little about which site or account it reaches. Rename it, and add a description, so people and tasks pick the right one. The stored value stays as it is.

Who can do this: a personal secret's owner, or an org admin for an organization or system secret. Anyone else sees Read-only and who can edit it, and every field is locked.

  1. In the sidebar, select Directory, then the Secrets tab.
  2. Find the secret, then select its name, or ⋯ at the end of its row and then Edit. It opens beside the list on the Details tab.
  3. Type the new Name. Names are saved in lowercase, and a / makes a folder: jira/prod puts the secret in a jira folder. The line at the top of the form shows where the secret lives and its name as you type. Name can't be empty: on Save, the field says Name is required.
  4. Leave the secret's own fields empty. A stored value shows as dots, and an empty field keeps it.
  5. Open Advanced and type a Description, or change the one there, for example which site or team it is for. Never paste a value here: every task that may use the secret can read its description, and the field warns This looks like a secret. when the text looks like one.
  6. Select Save. The pane closes and the list shows the new name, with the description beside it in a wide window.
  7. If a task, playbook or automation names this secret by its runner path, update it: the path ends with the name, so the old one no longer finds the secret. Select ⋯ on the row, then Copy runner path, and paste the new path where the old one was.

Two secrets in the same place can't share a name: on Save, the Name field says the name already exists. Choose another one.