# OpenID Connect Discovery

The well known endpoint an be used to retrieve information for OpenID Connect clients. We encourage you to not roll
your own OpenID Connect client but to use an OpenID Connect client library instead. You can learn more on this
flow at https://openid.net/specs/openid-connect-discovery-1_0.html .

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/

Endpoint: GET /.well-known/openid-configuration

## Response 200 fields (application/json):

  - `authorization_endpoint` (string, required)
    URL of the OP's OAuth 2.0 Authorization Endpoint.
    Example: "https://playground.ory.sh/ory-hydra/public/oauth2/auth"

  - `backchannel_logout_session_supported` (boolean)
    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_supported` (boolean)
    Boolean value specifying whether the OP supports back-channel logout, with true indicating support.

  - `claims_parameter_supported` (boolean)
    Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support.

  - `claims_supported` (array)
    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_supported` (array)
    JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported
by this authorization server.

  - `end_session_endpoint` (string)
    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_supported` (boolean)
    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_supported` (boolean)
    Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support.

  - `grant_types_supported` (array)
    JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports.

  - `id_token_signing_alg_values_supported` (array, required)
    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.

  - `issuer` (string, required)
    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.
    Example: "https://playground.ory.sh/ory-hydra/public/"

  - `jwks_uri` (string, required)
    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.
    Example: "https://playground.ory.sh/ory-hydra/public/.well-known/jwks.json"

  - `registration_endpoint` (string)
    URL of the OP's Dynamic Client Registration Endpoint.
    Example: "https://playground.ory.sh/ory-hydra/admin/client"

  - `request_object_signing_alg_values_supported` (array)
    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_supported` (boolean)
    Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.

  - `request_uri_parameter_supported` (boolean)
    Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.

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

  - `response_modes_supported` (array)
    JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.

  - `response_types_supported` (array, required)
    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_endpoint` (string)
    URL of the authorization server's OAuth 2.0 revocation endpoint.

  - `scopes_supported` (array)
    SON 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_supported` (array, required)
    JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include
pairwise and public.

  - `token_endpoint` (string, required)
    URL of the OP's OAuth 2.0 Token Endpoint
    Example: "https://playground.ory.sh/ory-hydra/public/oauth2/token"

  - `token_endpoint_auth_methods_supported` (array)
    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_endpoint` (string)
    URL of the OP's UserInfo Endpoint.

  - `userinfo_signing_alg_values_supported` (array)
    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].

## Response 401 fields (application/json):

  - `error` (string)
    Name is the error name.
    Example: "The requested resource could not be found"

  - `error_debug` (string)
    Debug contains debug information. This is usually not available and has to be enabled.
    Example: "The database adapter was unable to find the element"

  - `error_description` (string)
    Description contains further information on the nature of the error.
    Example: "Object with ID 12345 does not exist"

  - `status_code` (integer)
    Code represents the error status code (404, 403, 401, ...).
    Example: 404

## Response 500 fields (application/json):

  - `error` (string)
    Name is the error name.
    Example: "The requested resource could not be found"

  - `error_debug` (string)
    Debug contains debug information. This is usually not available and has to be enabled.
    Example: "The database adapter was unable to find the element"

  - `error_description` (string)
    Description contains further information on the nature of the error.
    Example: "Object with ID 12345 does not exist"

  - `status_code` (integer)
    Code represents the error status code (404, 403, 401, ...).
    Example: 404