Optional
acr_Optional
claim_Optional
claims_Optional
claims_Optional
claims_Optional
display_Optional
grant_Optional
id_Optional
id_Optional
op_Optional
op_Optional
registration_Optional
request_Optional
request_Optional
request_Optional
request_Optional
request_Optional
require_Optional
response_Optional
scopes_Optional
service_Optional
token_Optional
token_Optional
token_Optional
ui_Optional
user_Optional
user_Optional
user_Optional
userinfo_Optional
options: OpenIdConfigurationOptionsAdditional OpenID Provider Metadata parameters MAY also be used. Some are defined by other specifications, such as OpenID Connect Session Management 1.0 [OpenID.Session].
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
OpenID.Session: https://openid.net/specs/openid-connect-session-1_0.html
URL of the OP's OAuth 2.0 Authorization Endpoint [OpenID.Core].
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
OpenID.Core: https://openid.net/specs/openid-connect-core-1_0.html
JSON array containing a list of the Claim Types that the OpenID Provider supports. These Claim Types are described in Section 5.6 of OpenID Connect Core 1.0 [OpenID.Core]. Values defined by this specification are normal, aggregated, and distributed. If omitted, the implementation supports only normal Claims.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
OpenID.Core: https://openid.net/specs/openid-connect-core-1_0.html
Languages and scripts supported for values in Claims being returned, represented as a JSON array of BCP47 [RFC5646] language tag values. Not all languages and scripts are necessarily supported for all Claim values.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. If omitted, the default value is false.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
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.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
Private
discoveryThe endpoint to use to refresh this OpenID Configuration data.
JSON array containing a list of the display parameter values that the OpenID Provider supports. These values are described in Section 3.1.2.1 of OpenID Connect Core 1.0 [OpenID.Core].
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
OpenID.Core: https://openid.net/specs/openid-connect-core-1_0.html
Private
expiresDetermines the exact time (in seconds) that the token expires and is used to answer that inquiry. See also: isExpired.
JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports. Dynamic OpenID Providers MUST support the authorization_code and implicit Grant Type values and MAY support other Grant Types. If omitted, the default value is ["authorization_code", "implicit"].
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
JSON array containing a list of the JWE encryption algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT].
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
JWT: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-json-web-token
JSON array containing a list of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT].
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
JWT: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-json-web-token
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 [JWT]. The algorithm RS256 MUST be included. The value none MAY be supported, but MUST NOT be used unless the Response Type used returns no ID Token from the Authorization Endpoint (such as when using the Authorization Code Flow).
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
JWT: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-json-web-token
URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier. If Issuer discovery is supported (see Section 2), 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 Issuer.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
Section 2: https://openid.net/specs/openid-connect-discovery-1_0.html#IssuerDiscovery
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.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
JWK: https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-key
URL that the OpenID Provider provides to the person registering the Client to read about the OP's requirements on how the Relying Party can use the data provided by the OP. The registration process SHOULD display this URL to the person registering the Client if it is given.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
URL that the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service. The registration process SHOULD display this URL to the person registering the Client if it is given.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
URL of the OP's Dynamic Client Registration Endpoint [OpenID.Registration].
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
OpenID.Registration: https://openid.net/specs/openid-connect-registration-1_0.html
JSON array containing a list of the JWE encryption algorithms (alg values) supported by the OP for Request Objects. These algorithms are used both when the Request Object is passed by value and when it is passed by reference.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
JSON array containing a list of the JWE encryption algorithms (enc values) supported by the OP for Request Objects. These algorithms are used both when the Request Object is passed by value and when it is passed by reference.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
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). Servers SHOULD support none and RS256.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
OpenID.Core: https://openid.net/specs/openid-connect-core-1_0.html
Boolean value specifying whether the OP supports use of the request parameter, with true indicating support. If omitted, the default value is false.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support. If omitted, the default value is true.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter. Pre-registration is REQUIRED when the value is true. If omitted, the default value is false.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports, as specified in OAuth 2.0 Multiple Response Type Encoding Practices [OAuth.Responses]. If omitted, the default for Dynamic OpenID Providers is ["query", "fragment"].
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
OAuth.Responses: https://openid.net/specs/oauth-v2-multiple-response-types-1_0.html
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.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
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, although those defined in [OpenID.Core] SHOULD be listed, if supported.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
RFC6749: https://www.rfc-editor.org/rfc/rfc6749
OpenID.Core: https://openid.net/specs/openid-connect-core-1_0.html
URL of a page containing human-readable information that developers might want or need to know when using the OpenID Provider. In particular, if the OpenID Provider does not support Dynamic Client Registration, then information on how to register Clients needs to be provided in this documentation.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
URL of the OP's OAuth 2.0 Token Endpoint [OpenID.Core]. This is REQUIRED unless only the Implicit Flow is used.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
OpenID.Core: https://openid.net/specs/openid-connect-core-1_0.html
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 [OpenID.Core]. Other authentication methods MAY be defined by extensions. If omitted, the default is client_secret_basic -- the HTTP Basic Authentication Scheme specified in Section 2.3.1 of OAuth 2.0 [RFC6749].
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
OpenID.Core: https://openid.net/specs/openid-connect-core-1_0.html
JSON array containing a list of the JWS signing algorithms (alg values) supported by the Token Endpoint for the signature on the JWT [JWT] used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods. Servers SHOULD support RS256. The value none MUST NOT be used.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
JWT: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-json-web-token
Languages and scripts supported for the user interface, represented as a JSON array of BCP47 [RFC5646] language tag values.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
JSON array containing a list of the JWE [JWE] encryption algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
JWE: https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-encryption
JWA: https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-algorithms
JWT: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-json-web-token
JSON array containing a list of the JWE encryption algorithms (enc values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
JWA: https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-algorithms
JWT: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-json-web-token
URL of the OP's UserInfo Endpoint [OpenID.Core]. This URL MUST use the https scheme and MAY contain port, path, and query parameter components.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
OpenID.Core: https://openid.net/specs/openid-connect-core-1_0.html
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]. The value none MAY be included.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
JWS: https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-signature
JWA: https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-algorithms
JWT: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-json-web-token
Static
TypeThe config does not have an associated expiration or the expiration date-time passed. Set to a negative number to never expire the configuration.
Indicates that the configuration is or is not expired.
Resolves the end session endpoint afer fetching the Open ID Configuration from the discovery endpoint.
Optional
options: GetEndSessionEndpointOptionsThe end session endpoint as a URL object, if present.
Private
initOptional
acr_Optional
claim_Optional
claims_Optional
claims_Optional
claims_Optional
display_Optional
grant_Optional
id_Optional
id_Optional
op_Optional
op_Optional
registration_Optional
request_Optional
request_Optional
request_Optional
request_Optional
request_Optional
require_Optional
response_Optional
scopes_Optional
service_Optional
token_Optional
token_Optional
token_Optional
ui_Optional
user_Optional
user_Optional
user_Optional
userinfo_Optional
options: OpenIdConfigurationOptionsStatic
fromValidates the input and converts it to an OpenIdConfiguration.
Any unknown value that is needing validation to use as OpenIdConfiguration input.
Optional
options: OpenIdConfigurationOptionsOpenIDConfiguration options used to refresh the data.
Access validated input on an access token instance.
Static
load
JSON array containing a list of the Authentication Context Class References that this OP supports.
Source: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata