Skip to main content
POST
Create 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.

Headers

Idempotency-Key
string

Optional on every POST: 1-255 printable ASCII characters without spaces (a UUID is recommended). The same key with the same request replays the stored response for 24 hours. See Idempotency.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$

Body

application/json

Create an SSO connection.

protocol
enum<string>
required

Protocol. Treat as an open set: new values may be added.

Available options:
saml,
oidc
displayName
string
required

1-120 characters.

Maximum string length: 120
emailDomains
string[]
required

1-10 domains.

Required array length: 1 - 10 elements

Domain.

saml
object

Required for saml.

oidc
object

Required for oidc.

jitProvisioning
boolean

Create members on first login.

jitDefaultGroupId
integer<uint64> | null

Group for new members.

Required range: 0 <= x <= 18446744073709552000

Response

Success.

Single-object envelope around SsoConnection.

data
object
required

A single sign-on connection.