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.

Headers

Idempotency-Key
string

Makes a POST safe to retry for 24 hours: the same key, credential, path and body returns the stored response (Idempotent-Replayed: true) instead of running again. 422 if the key was used for a different request; 409 while the first is in flight.

Required string length: 1 - 255

Path Parameters

sso_config_id
string
required

Response

Completeness check only: it does NOT contact the IdP and does not attempt a login. Single sign-on is not available (#257), so nothing signs in through a configuration however complete it is, and note says so.

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