Skip to main content
API Explorer|API Explorer
Infrastructure/Federation & SSO
POSTFederationSince 1.0SynchronousAuth Required

ProbeOIDCProvider

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • issuerStringRequired

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

    Example: https://idp.example.com

Responses

200 OK

On success, this API returns the following response structure.

  • issuerString

    Issuer URL as returned by the OIDC discovery document.

    Example: https://idp.example.com

  • authorizationEndpointString

    Authorization endpoint URL from the OIDC discovery document.

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

  • tokenEndpointString

    Token endpoint URL from the OIDC discovery document.

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

  • userinfoEndpointString

    UserInfo endpoint URL from the OIDC discovery document.

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

  • endSessionEndpointString

    End-session endpoint URL for initiating OIDC logout.

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

  • jwksUriString

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

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

  • scopesSupportedList

    Scopes supported

    Example: item1,item2

  • responseTypesSupportedList

    Response types supported

    Example: item1,item2

Endpoint

POST/api/v1/sso/probe

/api/v1/sso/probe

Operation ID

ProbeOIDCProvider

Permalink

Request Example

curl -X POST '{host}/api/v1/sso/probe' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"issuer":"https://idp.example.com"}'

Response Example

200
{
  "issuer": "https://idp.example.com",
  "authorizationEndpoint": "https://idp.example.com/oauth2/authorize",
  "tokenEndpoint": "https://idp.example.com/oauth2/token",
  "userinfoEndpoint": "https://idp.example.com/oauth2/userinfo",
  "endSessionEndpoint": "https://idp.example.com/oauth2/logout",
  "jwksUri": "https://idp.example.com/oauth2/jwks",
  "scopesSupported": [],
  "responseTypesSupported": []
}

Change History

This API has no change history records yet.

View all change history