Skip to main content
PUT
Update SSO configuration

Authorizations

Authorization
string
header
required

JWT token for admin console authentication

Body

application/json
provider
enum<string>
required

SSO provider type

Available options:
SAML,
OIDC,
AZURE_AD,
OKTA,
GOOGLE_WORKSPACE
displayName
string

Display name for the SSO button

Example:

"Sign in with Acme Corp"

samlEntityId
string

SAML Entity ID (for SAML provider)

Example:

"https://idp.customer.com/saml"

samlSsoUrl
string

SAML SSO URL (for SAML provider)

Example:

"https://idp.customer.com/saml/sso"

samlCertificate
string

SAML X.509 Certificate (PEM format)

oidcIssuer
string

OIDC Issuer URL (for OIDC provider)

Example:

"https://idp.customer.com"

oidcClientId
string

OIDC Client ID

oidcClientSecret
string

OIDC Client Secret

oidcScopes
string[]

OIDC Scopes

autoProvision
boolean
default:true

Automatically create users on first login

defaultRole
enum<string>
default:VIEWER

Default role for auto-provisioned users

Available options:
OWNER,
ADMIN,
DESIGNER,
DEVELOPER,
VIEWER
allowedDomains
string[]

Allowed email domains (empty means all domains)

Example:
enforceSso
boolean
default:false

Force SSO for all users (no password login)

Response

SSO configuration updated