Logging out
Logging out is a deliberately quiet flow — usually nothing more than “you’ve been signed out”. The one case that does something extra is when a contributor has just completed a survey and the Diamond Code feature is enabled: the sign-out page also shows them their freshly-assigned Diamond Code so they can save it.
What happens
Section titled “What happens”A logged-in user clicks “Sign out” (from the nav menu, or arrives via a redirect from another flow that ends in logout). The app:
- Clears their session in the identity system
- Clears any in-memory user data in the app
- Notifies other open tabs that the user signed out
- Shows a “Signed out” message
- If the user came from a freshly-completed survey and your deployment uses Diamond Codes, the page also displays the contributor’s assigned Diamond Code with a copy-to-clipboard button
The whole thing is essentially instant; the user doesn’t need to do anything.
What the user sees
Section titled “What the user sees”| State | What’s on screen |
|---|---|
| The signed-out message | Your app’s logo, a “You have been signed out” line of text |
| Diamond Code (conditional) | A monospace code chip with a copy-to-clipboard button, plus a short explanation of what the code is and what to use it for |
The Diamond Code panel only appears when both: the Diamond Code feature is enabled for your deployment, and the user arrived at the logout page via a survey-submission redirect that appended the code to the URL.
What you can customise
Section titled “What you can customise”Translations
Section titled “Translations”| Text | Translation key |
|---|---|
| ”You have been signed out” message | auth.Logout.signed-out |
| Diamond Code panel text and labels | Profile.diamondCode.description, Profile.diamondCode.label, Profile.diamondCode.copyButtonAriaLabel |
| Diamond Code copy success/failure toasts | Profile.diamondCode.copySuccess, Profile.diamondCode.copyFailure |
These live in tep-configuration/translations/{locale}/main/auth.json (for the signed-out message) and tep-configuration/translations/{locale}/main/profile.json (for the Diamond Code panel — the panel is shared with the user’s profile page).
Branding
Section titled “Branding”The page renders your client’s logo. The logo source is your client’s branding configuration.
Variations for your deployment
Section titled “Variations for your deployment”| Your deployment | What’s different |
|---|---|
| Diamond Code enabled (e.g. NZ, CDN) | The Diamond Code panel appears for users arriving from survey completion |
| Diamond Code disabled | No Diamond Code panel; the page is just the signed-out message |
Need more detail?
Section titled “Need more detail?”For code paths and engineering notes, see Logging out (engineering).