A custom secret is a key:value pair that contains any sensitive authentication/authorization data that you can use in a workflow. Some common examples of secrets include but are not limited to:
- Key
- Password
- User name
- API token/key
- SSH keys
Secret name vs. key name
The secret name is the friendly name of the secret as it appears in the UI.
The context name is the name by which the secret is referenced and accessed in workflows, steps, and context.
After a secret is created, you can't change the key name or the context name, but you can change the value.
The key name can contain letters, numbers, spaces, and special characters. The context name is created by lower-casing and snake-casing the display name.
- Special characters followed by a letter or number and spaces are converted to an underscore:
_. - Special characters not followed by a letter or number are dropped.
| Secret name | Key name |
|---|---|
| API key | {{ $.secrets.api_key }} |
| API&key | {{ $.secrets.api_key }} |
| apiKey | {{ $.secrets.apikey }} |
| API key#$% | {{ $.secrets.api_key }} |
| API key 123 | {{ $.secrets.api_key_123 }} |