Get OpenID config

Get OpenID discovery configuration

GET/{apiBasePath}/.well-known/openid-configuration

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

Responses

200Retrieve OpenID configuration

One of:

object

issuerstring

URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier (https://openid.net/specs/openid-connect-discovery-1_0.html section 3)

jwks_uristring

URL for fetching a list JsonWebKey, used for JWT signature verification. Refer to /jwt/jwks.json API in the JWT recipe for JWK details

authorization_endpointstring

URL of the authorization endpoint

token_endpointstring

URL of the token endpoint

userinfo_endpointstring

URL of the userinfo endpoint

revocation_endpointstring

URL of the token revocation endpoint

token_introspection_endpointstring

URL of the token introspection endpoint

end_session_endpointstring

URL of the end session endpoint

subject_types_supportedstring[]

id_token_signing_alg_values_supportedstring[]

response_types_supportedstring[]

generalErrorResponse

statusstring

Error status code

Allowed:GENERAL_ERROR

messagestring

Error message

400Bad request error

string

404Resource not found error

string

500Internal server error

string

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

apiBasePathpath*Its value depends on the apiBasePath set by the user

Request

curl -X GET "/auth/.well-known/openid-configuration"

const response = await fetch("/auth/.well-known/openid-configuration", {
  method: "GET"
});

import requests

response = requests.get(
    "/auth/.well-known/openid-configuration",
)

Response

{
  "issuer": "https://api.example.com/auth",
  "jwks_uri": "https://api.example.com/auth/jwt/jwks.json",
  "authorization_endpoint": "https://api.example.com/auth/oauth/authorize",
  "token_endpoint": "https://api.example.com/auth/oauth/token",
  "userinfo_endpoint": "https://api.example.com/auth/oauth/userinfo",
  "revocation_endpoint": "https://api.example.com/auth/oauth/revoke",
  "token_introspection_endpoint": "https://api.example.com/auth/oauth/introspect",
  "end_session_endpoint": "https://api.example.com/auth/oauth/end_session",
  "subject_types_supported": [
    "public"
  ],
  "id_token_signing_alg_values_supported": [
    "RS256"
  ],
  "response_types_supported": [
    "code"
  ]
}

"Bad request"

"Not Found"

"Internal Error"