Skip to main content
ZStack
Infrastructure/Federation & SSO

ProbeOIDCProvider

Probe an OIDC provider and return its well-known discovery document metadata.

POST/api/v1/sso/probe

Operation ID

ProbeOIDCProvider

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

Body Fields

  • issuer
    StringRequired

    Issuer URL of the OIDC provider to probe for discovery metadata.

    Example: https://idp.example.com

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • issuer
    String

    Issuer URL as returned by the OIDC discovery document.

    Example: https://idp.example.com

  • authorizationEndpoint
    String

    Authorization endpoint URL from the OIDC discovery document.

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

  • tokenEndpoint
    String

    Token endpoint URL from the OIDC discovery document.

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

  • userinfoEndpoint
    String

    UserInfo endpoint URL from the OIDC discovery document.

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

  • endSessionEndpoint
    String

    End-session endpoint URL for initiating OIDC logout.

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

  • jwksUri
    String

    JWKS URI for retrieving the provider's JSON Web Key Set.

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

  • scopesSupported
    List

    Scopes supported

    Example: item1,item2

  • responseTypesSupported
    List

    Response types supported

    Example: item1,item2