Groundeddocs
ReferenceAdmin

Change the break-glass settings (platform admins with a session; audited as platform.break_glass_settings_update)

PUT/v1/admin/settings/break-glass

By default one platform admin starts a session alone with a written reason; with approvalRequired a second platform admin must approve it first. Changes apply to sessions started afterwards.

Header Parameters

If-Match*string

The resource's revision, as returned in ETag (for example "3"). Missing returns 428; stale returns 412.

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 PUT "https://example.com/v1/admin/settings/break-glass" \  -H "If-Match: string" \  -H "Content-Type: application/json" \  -d '{    "approvalRequired": true,    "maxDurationMinutes": 15,    "approvalTimeoutMinutes": 5  }'
{  "data": {    "approvalRequired": true,    "maxDurationMinutes": 0,    "approvalTimeoutMinutes": 0,    "defaultDurationMinutes": 0,    "minReasonLength": 0,    "updatedAt": "2019-08-24T14:15:22Z",    "updatedBy": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "displayName": "string",      "email": "string"    },    "revision": 0  }}