This documentation is for the Cloud version. If you're looking for the Server app documentation, visit Secret
Description
Encrypts text for secure sharing of sensitive information on Confluence Cloud pages.
Need a step-by-step guide? See Using and sharing secrets.
Parameters
| Name | Required | Available In | Migratable to Cloud? | Default Value | Description |
|---|---|---|---|---|---|
Title | Yes | Cloud | No | Enter a title for the secret. Used as secret identifier, although it doesn't have to be unique across the space. Also used as search keywords and shown in multiple locations in Confluence. Can store up to 255 characters. | |
Description | Optional | Cloud | No | Enter a description for the secret. Used to provide context about the secret, as search keywords and shown in multiple locations in Confluence. | |
Secret | Yes | Cloud | No | The secret to be encrypted, in text format. The only parameter value of the macro that is encrypted. | |
Access Control | Optional | Cloud | No |
Select how you want the following users and/or groups to access the secret.
If you leave the Users and the User Groups fields blank, then only you (the owner of the secret) will be able to view it.  The "Deny access" control is now deprecated, and is no longer available in the latest version of this app. For more details, refer to this KB article. | |
Users | Optional | Cloud | No | Specify user(s) who are allowed to decrypt the secret. Start typing in the field to search for a Confluence user or click to select from a menu. | |
User Group | Optional | Cloud | No | Select group(s) that are allowed to decrypt the secret. Start typing in the field to search for a Confluence group or click to select from a menu. | |
User Owners | Yes | Cloud | No | (Creator of the Secret) | Select user(s) who are allowed full access to the secret including updating secrets, and add/remove access to secrets. By default, the Secret creator is also the owner. Start typing in the field to search for a Confluence user or click to select from a menu. |
Group Owners | Optional | Cloud | No | Select group(s) who are allowed full access to the Secret including updating Secrets, and add/remove access to Secrets. Start typing in the field to search for a Confluence group or click to select from a menu. |
Editor View
Macro Edit View
Notes
The Secret macro is an entity of the space, not the page. Anyone who has access to the space can see a list of all secrets, however, only those who are part of the access control can access the information.