Skip to main content
ZStack
Infrastructure/Federation & SSO

TestSSOConnection

SSO Actions Test connectivity and validate the specified SSO configuration against its IDP.

POST/api/v1/sso/configurations/{id}/test

Operation ID

TestSSOConnection

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • id
    StringRequired

    Unique identifier of the SSO configuration to test.

Body Fields

  • tenantUuid
    StringRequired

    Deprecated and ignored. SSO configurations are global.

    Example: deprecated-tenant-uuid

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • success
    Boolean

    Whether the SSO connectivity test succeeded.

    Example: true

  • issuer
    String

    Issuer URL returned by the identity provider during the test.

    Example: https://idp.example.com

  • authorizationEndpoint
    String

    Authorization endpoint discovered from the identity provider.

    Example: https://idp.example.com/oauth2/authorize

  • tokenEndpoint
    String

    Token endpoint discovered from the identity provider.

    Example: https://idp.example.com/oauth2/token

  • errorMessage
    String

    Error message if the connectivity test failed.

    Example: authentication failed