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

Authorizations

Authorization
string
header
required

ID token of a signed-in dashboard user. Operations that API keys cannot call use it.

Path Parameters

ssoConnectionId
integer<uint64>
required

Numeric id (ssoConnectionId). A non-numeric id is a 400 data-failed-validation; an unknown id or one of another partner is a 404. Unsigned 64-bit integer. May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Body

application/json

Update an SSO connection.

displayName
string

Name.

emailDomains
string[]

Replaced; new domains are unverified.

Domain.

saml
object

SAML settings.

oidc
object

OIDC settings.

enforced
boolean

Enforce SSO.

jitProvisioning
boolean

JIT provisioning.

jitDefaultGroupId
integer<uint64> | null

Default group.

Required range: 0 <= x <= 18446744073709552000

Response

Success.

Single-object envelope around SsoConnection.

data
object
required

A single sign-on connection.