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.
{
"enabled": false,
"displayName": "string",
"externalBaseUrl": "string",
"issuerUri": "string",
"clientId": "string",
"clientSecret": "string",
"scopes": "string",
"groupsClaim": "string",
"clockSkewSeconds": 0,
"defaultRole": "string",
"confirmIssuerChange": false
}
Whether Enterprise SSO is enabled; enabling needs an effective external base URL (externalBaseUrl or the appliance default), issuerUri and clientId
Text for the 'Sign in with ...' button
External base URL: https, no userinfo, path, query or fragment; otherwise 400 INVALID_EXTERNAL_BASE_URL
OIDC issuer URI (https, no user info, query or fragment); a saved issuer cannot be cleared
OIDC client identifier
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.
Space-separated OIDC scopes
Name of the ID-token claim carrying groups
Absent keeps the current value (60 when never set); a value outside 0..300 is 400 INVALID_CLOCK_SKEW
Role for users with no mapped group; null or absent means deny. ADMIN is rejected with 400 DEFAULT_ROLE_NOT_ALLOWED.
Set to true to confirm an issuer change after the 409 ISSUER_CHANGE_CONFIRMATION_REQUIRED warning