Skip to main content

Add a secret

Add a secret when a task needs to reach another service: file a Jira issue, post to Slack, push to GitHub, or launch a node in AWS, Azure or GCP. You type the secret once; Jaah never shows it again.

Who can do this: everyone. A secret you add is yours; only Org Owners and Admins can choose another Owner.

Add it​

The New secret form for Jira: Type, Name, Base URL, Account email, API token, Advanced, Cancel and Save

  1. In the sidebar, select Directory, then the Secrets tab.
  2. Select Add secret. A gallery of services opens beside the list. Select Connect on a service's card to connect it, or select Other secret for the plain form these steps follow.
  3. Pick the Type: the service it connects to. Type in the box to search the list. A secret opened from a service's card already has its type.
  4. Check the Name. It starts as the type's short lowercase key, for example jira; tasks find the secret by it, so make it say what it is for. Use slashes to file it in a folder, for example team/jira.
  5. Check NodeVault, if your organization uses it. Ticked, only your organization's nodes can open the secrets. It starts ticked wherever it can be used, and shows only there, so a type that can't use NodeVault has no box. See How NodeVault works.
  6. Fill in the fields for that type. They change with the type: Jira asks for a Base URL, an Account email and an API token; AWS for an Access key ID and a Secret access key; Azure for a Tenant ID, a Client ID, a Client secret and a Subscription ID; GCP for a Service account key: paste the whole JSON key file. Its Project ID comes from the key unless you fill it in. A type that signs in to the service shows a Connect button, and some types, such as Jira, show both the fields and the button; see Connect.
  7. Optional: open Advanced to add a Description and the type's optional fields. A description helps the people and tasks choosing between secrets.
  8. If you are an Org Owner or Admin, choose the Owner under Advanced; see Who owns a secret.
  9. Select Save.

The secret appears in the list. A filled round mark before its name means a value is stored.

Select Cancel to close the form without saving.

Keep secrets safe​

  • Paste a token or key only into the secret's own fields. Never put one in a task's description, a project's commands or its agent instructions: those are readable by anyone who can view them.
  • Use Personal for a token tied to your own account, and Organization for one the whole team shares.
  • An Org Owner or Admin can change a saved secret's Owner later, under Advanced, a member's personal one included: pick Personal and the member in Owned by, Organization or System, then Save. A secret that leaves Organization leaves its home project; a System one leaves every project.

Next steps​