Get a break glass session
Settings module
GET/break-glass-sessions/{id}breakGlassSessions.get
One hour of emergency full access for an Owner. Requires MFA and a reason; every Admin is notified. Returns one break glass session with its `ETag`. A break glass session the caller may not see returns 404.
- Requires the capability audit.log.read.
- OAuth scopes: audit.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the break glass session. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: BreakGlassSession
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the break glass session. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| person_id | string (uuid) | Yes | Identifier of the Owner. |
| reason | string | Yes | Written reason, 20 to 2000 characters.Constraints: length 20 to 2000 |
| started_at | string (date-time) | Yes | Start. |
| expires_at | string (date-time) | Yes | End, one hour after start. |
| ended_at | string (date-time) | null | Yes | When the holder ended it early; null when it ran its hour. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"reason": "Payroll export failed during show day and must run now.",
"started_at": "2026-10-08T14:30:00Z",
"expires_at": "2026-10-08T14:30:00Z",
"ended_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X GET "$XOS_BASE_URL/break-glass-sessions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.breakGlassSessions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.break_glass_sessions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos break-glass-sessions get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f