Skip to main content
POST
Check whether an SSO configuration is complete

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

sso_config_id
string
required

Response

Completeness check only — it does NOT contact the IdP and does not attempt a login. The live SAML assertion-consumer flow is a documented follow-on.

ready
boolean
required

True when all four of idp_entity_id, idp_sso_url, idp_certificate and acs_url are set.

missing
enum<string>[]
required
Available options:
idp_entity_id,
idp_sso_url,
idp_certificate,
acs_url
note
string
required