Sso Settings Api Get Sso Settings

Sso Settings Api Get Sso Settings
Get Enterprise SSO settings (Administrator only)

Returns the saved configuration, or the defaults when no row exists. The client secret, its ciphertext and its key id are never returned.

Request
URI
GET
https://{api_host}/api/v1/settings/sso
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The saved Enterprise SSO configuration, or the defaults when none is saved; the client secret is never returned

Returns SsoSettingsResponse of type(s) application/json
{
    "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"
}
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.


401

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

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)

Returns ForbiddenRead of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/settings/sso