Sso Auth Api Get Auth Config

Sso Auth Api Get Auth Config
Minimal login configuration for the UI (public)

Returns what the login page needs before a session exists: ssoEnabled is true only when Enterprise SSO is configured and enabled, displayName is the configured SSO display name and is omitted when it is null (always when SSO is disabled), and apiDocsEnabled reports whether this API documentation page is served (vtp.api-docs.enabled, true by default). Public: no session required.

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

200 OK successful response envelope. The login page configuration, namely ssoEnabled, the SSO displayName when SSO is enabled, and apiDocsEnabled

Returns AuthConfigResponse of type(s) application/json
{
    "ssoEnabled": true,
    "displayName": "Example Corp SSO",
    "apiDocsEnabled": true
}
boolean
ssoEnabled
Required  

Whether Enterprise SSO is enabled and usable

string
displayName
Optional

Text for the 'Sign in with ...' button; present only when ssoEnabled is true

boolean
apiDocsEnabled
Required  

Whether the read-only API documentation page at /api/v1/docs/ is enabled on this appliance (vtp.api-docs.enabled); the console shows its API Documentation menu item only when true


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