ReferenceAdmin
Start a break-glass session on a team (platform admins with a session; audited as breakglass.start)
POST
/v1/admin/break-glassGrants the caller read access to the team's conversations, documents or both for the duration (default 1 hour, at most the maximum setting), through the normal API and UI. Nothing else changes: no role, no write access. Every read is audited as breakglass.read with the session ID. Without the approval setting the session is active at once and the team's owners are notified (mandatory); with it, the session is pending until another platform admin approves it, or lapses after the approval timeout. One open session per admin and team (409 break_glass_open).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/admin/break-glass" \ -H "Content-Type: application/json" \ -d '{ "team": "string", "reason": "stringstringstringst", "scopes": [ "conversations" ] }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "team": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "slug": "string", "name": "string" }, "requestedBy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "displayName": "string", "email": "string" }, "reason": "string", "scopes": [ "conversations" ], "durationMinutes": 0, "status": "pending", "requestedAt": "2019-08-24T14:15:22Z", "approvalDeadline": "2019-08-24T14:15:22Z", "decidedBy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "displayName": "string", "email": "string" }, "decidedAt": "2019-08-24T14:15:22Z", "decisionNote": "string", "startedAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "endedAt": "2019-08-24T14:15:22Z", "endedBy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "displayName": "string", "email": "string" }, "reads": [ { "kind": "conversation_list", "reads": 0, "targets": 0 } ] }}