Skip to content

Commit b421d59

Browse files
hperlclaude
andauthored
docs: add break-glass SSO account recovery (#2491)
* docs: add break-glass SSO account recovery documentation Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: update break-glass API to final design - Field renamed from break_glass to break_glass_for_organization (UUID) - Add workspace members API tab (PATCH /workspaces/{ws}/members/{member}) - Add identity admin API tab with org UUID value - Console UI uses "Allow account recovery" toggle - Document org-scoping behavior: flag doesn't carry over if user changes org Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: split break-glass docs between console and kratos - Console SSO guide (docs/console/single-sign-on.mdx): Console UI toggle and workspace members API - Kratos organizations (docs/kratos/organizations/organizations.mdx): identity admin API with break_glass_for_organization UUID field Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent ff64b3f commit b421d59

File tree

2 files changed

+85
-0
lines changed

2 files changed

+85
-0
lines changed

docs/console/single-sign-on.mdx

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,40 @@ this setting, as it may lock out users who have not completed the SSO setup.
5757

5858
:::
5959

60+
## Break-glass account recovery
61+
62+
When your SSO provider is unavailable due to an outage or misconfiguration, organization members can't sign in. Break-glass
63+
account recovery lets designated users bypass SSO enforcement and recover access to their accounts through email.
64+
65+
### Enable account recovery for a member
66+
67+
Go to **Workspace Settings** > **Members**. For workspaces with SSO enabled, an **Allow account recovery** toggle appears for each
68+
organization member. Enable this toggle for the designated user.
69+
70+
You can also use the workspace members API:
71+
72+
```shell
73+
curl -X PATCH "https://api.console.ory.sh/workspaces/$WORKSPACE_ID/members/$MEMBER_ID" \
74+
-H "Authorization: Bearer $ORY_SESSION_TOKEN" \
75+
-H "Content-Type: application/json" \
76+
-d '{"break_glass": true}'
77+
```
78+
79+
To disable account recovery, set `break_glass` to `false` or use the toggle in the Console.
80+
81+
### How recovery works
82+
83+
1. The designated user navigates to the account recovery page and enters their email address.
84+
2. Ory sends a recovery code to the email address.
85+
3. The user enters the recovery code and gets a session.
86+
87+
:::warning
88+
89+
Grant account recovery access only to a small number of trusted users, such as organization administrators. Any user with this
90+
access can bypass SSO and recover their account through email.
91+
92+
:::
93+
6094
## Known limitiations
6195

6296
- Only one domain is supported. If you need to support multiple domains, choose one primary domain for SSO and ensure that all

docs/kratos/organizations/organizations.mdx

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,57 @@ Jun 10 09:16:40 2038 GMT
408408
You can use this information to externally monitor certificate expirations or integrate it into your internal workflows and
409409
alerting systems as needed.
410410

411+
## Break-glass account recovery for SSO
412+
413+
When an organization's SSO provider is unavailable, organization members can't sign in. Break-glass account recovery lets
414+
designated users bypass SSO enforcement and recover access through email-based recovery.
415+
416+
Each recovery address has a `break_glass_for_organization` field that stores the organization UUID it applies to. Recovery is only
417+
allowed when this field matches the identity's current organization. If the user moves to a different organization, the flag
418+
doesn't carry over.
419+
420+
For Ory Network users, the easiest way to manage this is through the
421+
[Ory Console SSO settings](/docs/console/single-sign-on#break-glass-account-recovery).
422+
423+
### Set break-glass via the identity admin API
424+
425+
Set the `break_glass_for_organization` field on a recovery address to the organization's UUID:
426+
427+
```shell
428+
curl -X PATCH "https://$PROJECT_SLUG.projects.oryapis.com/admin/identities/$IDENTITY_ID" \
429+
-H "Authorization: Bearer $ORY_API_KEY" \
430+
-H "Content-Type: application/json" \
431+
-d '[
432+
{
433+
"op": "replace",
434+
"path": "/recovery_addresses/0/break_glass_for_organization",
435+
"value": "$ORGANIZATION_ID"
436+
}
437+
]'
438+
```
439+
440+
To disable break-glass recovery, set the value to the nil UUID:
441+
442+
```shell
443+
curl -X PATCH "https://$PROJECT_SLUG.projects.oryapis.com/admin/identities/$IDENTITY_ID" \
444+
-H "Authorization: Bearer $ORY_API_KEY" \
445+
-H "Content-Type: application/json" \
446+
-d '[
447+
{
448+
"op": "replace",
449+
"path": "/recovery_addresses/0/break_glass_for_organization",
450+
"value": "00000000-0000-0000-0000-000000000000"
451+
}
452+
]'
453+
```
454+
455+
:::warning
456+
457+
Grant break-glass recovery only to a small number of trusted users. Any user with this flag can bypass SSO and recover their
458+
account through email.
459+
460+
:::
461+
411462
## Self-service organization onboarding
412463

413464
```mdx-code-block

0 commit comments

Comments
 (0)