Skip to main content
GET
Get SSO enforcement
Returns enforcement state and its preconditions. Related guide: User provisioning: SSO and SCIM. Whether members must sign in through SSO, and whether the preconditions (an active connection, a verified domain) hold.
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.

Response

The state

ssoRequired
boolean
hasActiveConnection
boolean
hasVerifiedDomain
boolean
canRequire
boolean

Both preconditions hold, so enforcement may be switched on.

exemptMemberCount
integer

Break-glass members. Keep it above zero.