Secrets
A secret is a credential one of your integrations uses, such as an email gateway’s API key. You enter it here. Nobody can read it back, not even you.
What you see
Each secret your settings use has its own row.
| Field | What it tells you |
|---|---|
| Set, Not set or Retired | Whether a value is in use now. |
| Last activated | When the current value went live, and who entered it. |
| Approved by | Who approved the change, when your organisation requires a second person. |
| Used by | The settings that rely on this secret. |
A secret appears as soon as a setting refers to it, marked Not set until someone enters a value.
Set or rotate a secret
- Type the value into New value. The field hides what you type.
- Select Save.
- The field clears, and Last activated shows the new time.
The new value is used from the next message the system sends. Nothing needs to restart.
If your organisation requires approval for this change, the row says A rotation is awaiting approval. The old value stays in use until a second person approves. The approver sees which secret changes and who asked, never the value.
Only one rotation per secret can wait for approval at a time.
Retire a secret
Retire a secret when nothing uses it any more.
- Select Retire on its row.
- Confirm.
The secret stops being used at once, and the row shows Retired. To use it again, enter a new value. A value from before the retirement cannot be brought back.
Retire is unavailable while any setting still uses the secret. Remove that setting’s reference first.
The life of a secret
stateDiagram-v2
[*] --> NotSet: a setting refers to it
NotSet --> Set: enter a value
Set --> Set: rotate
Set --> Retired: retire (nothing uses it)
Retired --> Set: enter a new value
Why values are never shown
Keeping a credential out of screens, exports and logs is standard practice. It follows the OWASP Secrets Management Cheat Sheet and guards against CWE-522, insufficiently protected credentials. Both are listed in the platform’s standards register.
Every activation and retirement is recorded with who acted and when, so you can answer who changed a key, and on which day.
What your organisation configures
- Which settings use a secret, such as your email gateway.
- Whether rotating a secret needs a second person’s approval, through your approval rules.
- Who may view, set and retire secrets, through permissions.
From the LedgerTM product guide, as shipped with the software and written with it. Copied from the platform repository on 2026-11-11.