SsoSettingsUpdateRequest

SsoSettingsUpdateRequest
SsoSettingsUpdateRequest

Request body to update Enterprise SSO settings. When issuerUri differs from the saved issuer and confirmIssuerChange is not true, nothing is saved and the answer is 409 ISSUER_CHANGE_CONFIRMATION_REQUIRED; the client repeats the request with confirmIssuerChange set to true after the administrator confirms.

JSON Example
{
    "enabled": false,
    "displayName": "string",
    "externalBaseUrl": "string",
    "issuerUri": "string",
    "clientId": "string",
    "clientSecret": "string",
    "scopes": "string",
    "groupsClaim": "string",
    "clockSkewSeconds": 0,
    "defaultRole": "string",
    "confirmIssuerChange": false
}
boolean
enabled
Required  

Whether Enterprise SSO is enabled; enabling needs an effective external base URL (externalBaseUrl or the appliance default), issuerUri and clientId

string
displayName
Required  
Constraints: minLength: 1 maxLength: 64

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

string
externalBaseUrl
Optional
Constraints: maxLength: 2048

External base URL: https, no userinfo, path, query or fragment; otherwise 400 INVALID_EXTERNAL_BASE_URL

string
issuerUri
Optional
Constraints: maxLength: 2048

OIDC issuer URI (https, no user info, query or fragment); a saved issuer cannot be cleared

string
clientId
Optional
Constraints: maxLength: 512

OIDC client identifier

string
clientSecret
Optional
Constraints: maxLength: 4096

Client secret, input only. Omit or send blank to keep the stored secret; it can never be cleared. Never present in any response, log or audit record.

string
scopes
Required  
Constraints: maxLength: 1024

Space-separated OIDC scopes

string
groupsClaim
Required  
Constraints: maxLength: 256

Name of the ID-token claim carrying groups

integer As int32 As int32
clockSkewSeconds
Optional
Constraints: minimum: 0 maximum: 300

Absent keeps the current value (60 when never set); a value outside 0..300 is 400 INVALID_CLOCK_SKEW

defaultRole
Optional

Role for users with no mapped group; null or absent means deny. ADMIN is rejected with 400 DEFAULT_ROLE_NOT_ALLOWED.

boolean
confirmIssuerChange
Optional

Set to true to confirm an issuer change after the 409 ISSUER_CHANGE_CONFIRMATION_REQUIRED warning