Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-175068227.4 KB
oidc

OpenID Connect Discovery

A mechanism for an OpenID Connect Relying Party to discover the End-User's OpenID Provider and obtain information needed to interact with it, including its OAuth 2.0 endpoint locations.

Popular libraries for OpenID Connect clients include oidc-client-js (JavaScript), go-oidc (Golang), and others. For a full list of clients go here: https://openid.net/developers/certified/

get/.well-known/openid-configuration

Response

oidcConfiguration

authorization_endpointstring required

OAuth 2.0 Authorization Endpoint URL

backchannel_logout_session_supportedboolean

OpenID Connect Back-Channel Logout Session Required

Boolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to identify the RP session with the OP. If supported, the sid Claim is also included in ID Tokens issued by the OP

backchannel_logout_supportedboolean

OpenID Connect Back-Channel Logout Supported

Boolean value specifying whether the OP supports back-channel logout, with true indicating support.

claims_parameter_supportedboolean

OpenID Connect Claims Parameter Parameter Supported

Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support.

claims_supportedstring[]

OpenID Connect Supported Claims

JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list.

code_challenge_methods_supportedstring[]

OAuth 2.0 PKCE Supported Code Challenge Methods

JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported by this authorization server.

credentials_endpoint_draft_00string

OpenID Connect Verifiable Credentials Endpoint

Contains the URL of the Verifiable Credentials Endpoint.

device_authorization_endpointstring required

OAuth 2.0 Device Authorization Endpoint URL

end_session_endpointstring

OpenID Connect End-Session Endpoint

URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP.

frontchannel_logout_session_supportedboolean

OpenID Connect Front-Channel Logout Session Required

Boolean value specifying whether the OP can pass iss (issuer) and sid (session ID) query parameters to identify the RP session with the OP when the frontchannel_logout_uri is used. If supported, the sid Claim is also included in ID Tokens issued by the OP.

frontchannel_logout_supportedboolean

OpenID Connect Front-Channel Logout Supported

Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support.

grant_types_supportedstring[]

OAuth 2.0 Supported Grant Types

JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports.

id_token_signed_response_algstring[] required

OpenID Connect Default ID Token Signing Algorithms

Algorithm used to sign OpenID Connect ID Tokens.

id_token_signing_alg_values_supportedstring[] required

OpenID Connect Supported ID Token Signing Algorithms

JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT.

issuerstring required

OpenID Connect Issuer URL

An URL using the https scheme with no query or fragment component that the OP asserts as its IssuerURL Identifier. If IssuerURL discovery is supported , this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this IssuerURL.

jwks_uristring required

OpenID Connect Well-Known JSON Web Keys URL

URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.

registration_endpointstring

OpenID Connect Dynamic Client Registration Endpoint URL

request_object_signing_alg_values_supportedstring[]

OpenID Connect Supported Request Object Signing Algorithms

JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used both when the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter).

request_parameter_supportedboolean

OpenID Connect Request Parameter Supported

Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.

request_uri_parameter_supportedboolean

OpenID Connect Request URI Parameter Supported

Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.

require_request_uri_registrationboolean

OpenID Connect Requires Request URI Registration

Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter.

response_modes_supportedstring[]

OAuth 2.0 Supported Response Modes

JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.

response_types_supportedstring[] required

OAuth 2.0 Supported Response Types

JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values.

revocation_endpointstring

OAuth 2.0 Token Revocation URL

URL of the authorization server's OAuth 2.0 revocation endpoint.

scopes_supportedstring[]

OAuth 2.0 Supported Scope Values

JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used

subject_types_supportedstring[] required

OpenID Connect Supported Subject Types

JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public.

token_endpointstring required

OAuth 2.0 Token Endpoint URL

token_endpoint_auth_methods_supportedstring[]

OAuth 2.0 Supported Client Authentication Methods

JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core 1.0

userinfo_endpointstring

OpenID Connect Userinfo URL

URL of the OP's UserInfo Endpoint.

userinfo_signed_response_algstring[] required

OpenID Connect User Userinfo Signing Algorithm

Algorithm used to sign OpenID Connect Userinfo Responses.

userinfo_signing_alg_values_supportedstring[]

OpenID Connect Supported Userinfo Signing Algorithm

JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].

Example response

{
  "request_parameter_supported": true,
  "claims_parameter_supported": true,
  "backchannel_logout_supported": true,
  "scopes_supported": [
    "scopes_supported",
    "scopes_supported"
  ],
  "issuer": "https://playground.ory.sh/ory-hydra/public/",
  "userinfo_signed_response_alg": [
    "userinfo_signed_response_alg",
    "userinfo_signed_response_alg"
  ],
  "authorization_endpoint": "https://playground.ory.sh/ory-hydra/public/oauth2/auth",
  "device_authorization_endpoint": "https://playground.ory.sh/ory-hydra/public/oauth2/device/oauth",
  "claims_supported": [
    "claims_supported",
    "claims_supported"
  ],
  "userinfo_signing_alg_values_supported": [
    "userinfo_signing_alg_values_supported",
    "userinfo_signing_alg_values_supported"
  ],
  "token_endpoint_auth_methods_supported": [
    "token_endpoint_auth_methods_supported",
    "token_endpoint_auth_methods_supported"
  ],
  "backchannel_logout_session_supported": true,
  "response_modes_supported": [
    "response_modes_supported",
    "response_modes_supported"
  ],
  "id_token_signed_response_alg": [
    "id_token_signed_response_alg",
    "id_token_signed_response_alg"
  ],
  "token_endpoint": "https://playground.ory.sh/ory-hydra/public/oauth2/token",
  "response_types_supported": [
    "response_types_supported",
    "response_types_supported"
  ],
  "request_uri_parameter_supported": true,
  "grant_types_supported": [
    "grant_types_supported",
    "grant_types_supported"
  ],
  "end_session_endpoint": "end_session_endpoint",
  "revocation_endpoint": "revocation_endpoint",
  "userinfo_endpoint": "userinfo_endpoint",
  "frontchannel_logout_supported": true,
  "require_request_uri_registration": true,
  "code_challenge_methods_supported": [
    "code_challenge_methods_supported",
    "code_challenge_methods_supported"
  ],
  "credentials_endpoint_draft_00": "credentials_endpoint_draft_00",
  "frontchannel_logout_session_supported": true,
  "jwks_uri": "https://{slug}.projects.oryapis.com/.well-known/jwks.json",
  "credentials_supported_draft_00": [
    {
      "types": [
        "types",
        "types"
      ],
      "cryptographic_suites_supported": [
        "cryptographic_suites_supported",
        "cryptographic_suites_supported"
      ],
      "cryptographic_binding_methods_supported": [
        "cryptographic_binding_methods_supported",
        "cryptographic_binding_methods_supported"
      ],
      "format": "format"
    },
    {
      "types": [
        "types",
        "types"
      ],
      "cryptographic_suites_supported": [
        "cryptographic_suites_supported",
        "cryptographic_suites_supported"
      ],
      "cryptographic_binding_methods_supported": [
        "cryptographic_binding_methods_supported",
        "cryptographic_binding_methods_supported"
      ],
      "format": "format"
    }
  ],
  "subject_types_supported": [
    "subject_types_supported",
    "subject_types_supported"
  ],
  "id_token_signing_alg_values_supported": [
    "id_token_signing_alg_values_supported",
    "id_token_signing_alg_values_supported"
  ],
  "registration_endpoint": "https://playground.ory.sh/ory-hydra/admin/client",
  "request_object_signing_alg_values_supported": [
    "request_object_signing_alg_values_supported",
    "request_object_signing_alg_values_supported"
  ]
}