Skip to main content
PATCH
Suspend, reinstate, or SSO-exempt a member
Applies exactly one change: a status transition or the break-glass ssoExempt flag. Suspending revokes all of the member’s sessions. Use ssoExempt to keep an admin able to sign in if SSO breaks. Related guide: User provisioning: onboard and offboard people. Exactly one change per request — either a status transition or the break-glass ssoExempt flag. Suspending revokes the member’s sessions.
Availability: Cloud · Enterprise (self-hosted). Not available on the Community edition: a self-hosted deployment needs ENTERPRISE_ENABLED=true, otherwise the endpoint answers 403 with error.type: "enterprise_license_required".

Authorizations

Authorization
string
header
required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

userId
string
required

Body

application/json
status
enum<string>
required
Available options:
active,
suspended

Response

The member's new state

userId
string
status
string
ssoExempt
boolean
revocation
string

Status changes only — what happened to the member's identity-provider sessions (revoked, skipped, failed).