Sso Settings Api Get Sso Settings
Returns the saved configuration, or the defaults when no row exists. The client secret, its ciphertext and its key id are never returned.
200 OK successful response envelope. The saved Enterprise SSO configuration, or the defaults when none is saved; the client secret is never returned
{
"enabled": true,
"displayName": "Example Corp SSO",
"externalBaseUrl": "https://console.example.com",
"issuerUri": "https://idp.example.com/realms/example",
"clientId": "vtp-console",
"clientSecretStored": true,
"clientSecretReenterRequired": false,
"scopes": "openid profile email",
"groupsClaim": "groups",
"clockSkewSeconds": 60,
"defaultRole": "AUDITOR",
"updatedAt": "2026-01-12T10:00:00Z",
"effectiveExternalBaseUrl": "https://console.example.com",
"externalBaseUrlSource": "SETTINGS"
}
Whether Enterprise SSO is enabled
Text for the 'Sign in with ...' button
Administrator-configured external base URL: https, no userinfo, path, query or fragment
OIDC issuer URI (https)
OIDC client identifier
True when a client secret is stored; the secret itself is never returned
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
Space-separated OIDC scopes
Name of the ID-token claim carrying groups
Tolerated clock difference in seconds between the console and the IdP; default 60, maximum 300
Role for users with no mapped group; unset means such users are denied
Timestamp of the last update as an ISO 8601 date-time with offset
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.
Read-only. SETTINGS when a saved externalBaseUrl is in effect, APPLIANCE_DEFAULT when the operator-set default is in effect, NONE when neither exists.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
403 Forbidden: FORBIDDEN when the signed-in role is not allowed to call this operation; PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/settings/sso