Set single sign-on settings
Applies at once, with no restart. When a save turns SSO on or changes the issuer URL, the client ID or the client secret, the console must read the discovery document of the issuer, and the client secret must be readable. Other saves do not contact the identity provider. An empty client_secret keeps the stored secret, also one that is unreadable. Local login can be off only while SSO is on, and to turn SSO off turns local login on. Only an SSO session or the admin token can turn local login off; that ends the sessions of the local users.
/api/v1/settings/oidctse_sessionAPI key · cookierequiredapplication/jsonadmin_groupsstring[]allow_local_loginbooleanrequiredTo turn SSO off turns local login on
client_idstringclient_secretstringEmpty keeps the stored secret
default_rolestringnone, viewer, operator or admin
enabledbooleanrequiredissuer_urlstringoperator_groupsstring[]role_claimstringEmpty: groups
viewer_groupsstring[]OK
admin_groupsstring[]requiredallow_local_loginbooleanrequiredLocal users can log in with a password. Off only while SSO is on
client_idstringrequiredclient_secret_statestringrequiredThe stored client secret: set, unset, or unreadable (it does not decrypt with the current TSE_DB_ENCRYPTION_KEY: enter it again). The API never returns the secret.
setunsetunreadabledefault_rolestringrequiredThe role of a user with no matching group. none: the user can log in only with a service grant
nonevieweroperatoradminenabledbooleanrequiredSSO is on: the login page shows Log in with SSO
issuer_urlstringrequiredlocal_login_lock_reasonstringrequiredWhy this session cannot turn local login off, or empty
operator_groupsstring[]requiredredirect_uristringrequiredThe redirect URI to register at the identity provider
role_claimstringrequiredThe ID token claim that holds the groups
viewer_groupsstring[]requiredError
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message