Introduction
An OpenID Provider publishes its configuration as a JSON document so that applications can find its endpoints and learn what it supports. OpenID Connect Discovery 1.0 says that providers “MUST make a JSON document available at the path
formed by concatenating the string /.well-known/openid-configuration to the Issuer”. The document is a flat JSON object of provider metadata. The version read for this site is the one that incorporates errata set 2 (December 2023); where its text differs from older copies
(for example it makes authorization_endpoint REQUIRED), the text read wins. OAuth 2.0 authorization servers use the same document under a different well-known name: see oauth-authorization-server.
Structure
{
"issuer": "https://server.example.com",
"authorization_endpoint": "https://server.example.com/authorize",
"token_endpoint": "https://server.example.com/token",
"userinfo_endpoint": "https://server.example.com/userinfo",
"jwks_uri": "https://server.example.com/jwks.json",
"scopes_supported": ["openid", "profile", "email"],
"response_types_supported": ["code", "id_token", "token id_token"],
"subject_types_supported": ["public", "pairwise"],
"id_token_signing_alg_values_supported": ["RS256", "ES256"]
}
| Status | Members (OpenID Connect Discovery 1.0, section 3) |
|---|---|
| REQUIRED | issuer (an https URL with no query or fragment, identical to the iss claim of ID Tokens), authorization_endpoint (https), jwks_uri (https; the signing keys, and no private or symmetric key values),
response_types_supported, subject_types_supported (“pairwise” and “public” are valid), id_token_signing_alg_values_supported (the algorithm RS256 MUST be included). |
| REQUIRED, with an exception | token_endpoint: required unless only the Implicit Flow is used. |
| RECOMMENDED | userinfo_endpoint, registration_endpoint, scopes_supported (the server MUST support openid), claims_supported. |
| OPTIONAL | response_modes_supported (default ["query","fragment"]), grant_types_supported (default ["authorization_code","implicit"]), acr_values_supported, the signing and encryption algorithm lists for the ID Token, the UserInfo
endpoint and Request Objects, token_endpoint_auth_methods_supported (default client_secret_basic), token_endpoint_auth_signing_alg_values_supported (none MUST NOT be used), display_values_supported, claim_types_supported
(default: only normal), service_documentation, claims_locales_supported, ui_locales_supported, claims_parameter_supported (default false), request_parameter_supported (default false),
request_uri_parameter_supported (default true), require_request_uri_registration (default false), op_policy_uri, op_tos_uri. |
| others | “Additional OpenID Provider Metadata parameters MAY also be used.” Some are defined by other specifications, such as OpenID Connect Session Management. |
Arrays of values are JSON arrays of strings; boolean members are JSON booleans; URLs that the text says MUST use https are checked for that scheme.
In the explorer
A file named openid-configuration or openid-configuration.json opens here when it is a JSON object with a string issuer and at least four members that the two specifications define. Any other file with these names opens as before. The tree labels each member with its status in the
specification; the Members tab lists every member present and the REQUIRED and RECOMMENDED ones that are absent; the Overview names the missing REQUIRED members. A problem is a required member that is absent (with the token endpoint excused when only implicit response types are listed), an issuer or an endpoint that is not https,
an issuer with a query or fragment, a member of the wrong type, scopes_supported without openid, no RS256, or none in the token endpoint signing algorithms. Members the specification does not define are labelled as allowed, not errors. The issuer is not compared with an address, because a file has none.
All 20 public providers tried were claimed.
Not described
Known, not yet covered
- Reference: issuer discovery with WebFinger (section 2), the request and validation rules (sections 4 and 4.3), the semantics of each algorithm and claim value, and metadata defined by other specifications (Session Management, Front-Channel and Back-Channel Logout, and others) are not described.
- Viewer: the dynamic-provider requirement that
response_types_supportedinclude code, id_token and “id_token token” is not checked, as it applies to dynamic providers only; algorithm names are not checked against the JOSE registry; language tags are not checked against BCP 47. - Viewer: nothing is fetched: the JWK Set and the endpoints are not read.
Unknown
- Reference: none known beyond the above.
Links
Reference
- OpenID Connect Discovery 1.0 incorporating errata set 2 – the specification
- RFC 8414 – OAuth 2.0 Authorization Server Metadata, the general form
- oauth-authorization-server – the OAuth 2.0 counterpart