Skip to main content
PATCH
Update an SSO connection
Dashboard session only. API keys cannot call this operation.

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Path Parameters

ssoConnectionId
integer<uint64>
required

SSO connection id. Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Body

application/json

Changes to an SSO connection.

displayName
string

Name.

Required string length: 1 - 120
emailDomains
string[]

Email domains (replaced; new domains are unverified).

Required array length: 1 - 10 elements
saml
object

SAML settings (required when protocol is saml).

oidc
object

OIDC settings (required when protocol is oidc).

enforced
boolean

Enforce SSO for the domains.

jitProvisioning
boolean

Just-in-time provisioning.

jitDefaultGroupId
integer<uint64> | null

Default group.

Required range: 0 <= x <= 18446744073709552000

Response

OK

Single-object envelope around a SsoConnection.

data
object
required

A SAML or OIDC single sign-on connection.