SsoSettingsResponse

SsoSettingsResponse
SsoSettingsResponse

Enterprise SSO settings. The client secret is never returned.

JSON Example
{
    "enabled": false,
    "displayName": "string",
    "externalBaseUrl": "string",
    "issuerUri": "string",
    "clientId": "string",
    "clientSecretStored": false,
    "clientSecretReenterRequired": false,
    "scopes": "string",
    "groupsClaim": "string",
    "clockSkewSeconds": 0,
    "defaultRole": "string",
    "updatedAt": "string",
    "effectiveExternalBaseUrl": "string",
    "externalBaseUrlSource": "string"
}
boolean
enabled
Required  

Whether Enterprise SSO is enabled

string
displayName
Required  

Text for the 'Sign in with ...' button

string
externalBaseUrl
Optional

Administrator-configured external base URL: https, no userinfo, path, query or fragment

string
issuerUri
Optional

OIDC issuer URI (https)

string
clientId
Optional

OIDC client identifier

boolean
clientSecretStored
Required  

True when a client secret is stored; the secret itself is never returned

boolean
clientSecretReenterRequired
Required  

True when a secret is stored but its key id differs from the current key id or the current key id cannot be obtained; the administrator must re-enter it

string
scopes
Required  

Space-separated OIDC scopes

string
groupsClaim
Required  

Name of the ID-token claim carrying groups

integer As int32 As int32
clockSkewSeconds
Required  

Tolerated clock difference in seconds between the console and the IdP; default 60, maximum 300

defaultRole
Optional

Role for users with no mapped group; unset means such users are denied

string As date-time As date-time
updatedAt
Optional

Timestamp of the last update as an ISO 8601 date-time with offset

string
effectiveExternalBaseUrl
Required   Read-Only  

Read-only. The external base URL the console uses to build the OIDC redirect URI - the saved externalBaseUrl when non-blank, otherwise the appliance default, otherwise null. Never derived from request headers.

externalBaseUrlSource
Required   Read-Only  

Read-only. SETTINGS when a saved externalBaseUrl is in effect, APPLIANCE_DEFAULT when the operator-set default is in effect, NONE when neither exists.