Skip to main content
POST
Create a workspace SSO configuration

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.

Body

application/json

Every field is optional — an empty config is storable and simply reports as not ready from the test action.

provider
enum<string>
default:saml

Only the exact string 'oidc' selects oidc; anything else (including omission) becomes 'saml'. One config per provider per workspace.

Available options:
saml,
oidc
enabled
boolean
default:false

Only the literal true enables.

idp_entity_id
string | null

Trimmed; blank becomes null.

idp_sso_url
string | null

Must be https:// when present.

idp_certificate
string | null

IdP signing certificate (PEM). Public material, not a secret — but never returned by the list endpoint.

acs_url
string | null

Must be https:// when present.

allowed_domains
string[]

Email domains allowed to SSO. Trimmed, lowercased; non-strings and blanks dropped.

Response

Created.

id
string
required
ok
enum<boolean>
required
Available options:
true