Constructors

  • Parameters

    • config: {
          acr_values_supported?: string[];
          authorization_endpoint: string;
          claim_types_supported?: string[];
          claims_locales_supported?: string[];
          claims_parameter_supported?: boolean;
          claims_supported?: string[];
          display_values_supported?: string[];
          grant_type_supported?: string[];
          id_token_encryption_alg_values_supported?: string[];
          id_token_encryption_enc_values_supported?: string[];
          id_token_signing_alg_values_supported: string[];
          issuer: string;
          jwks_uri: string;
          op_policy_uri?: string;
          op_tos_uri?: string;
          registration_endpoint?: string;
          request_object_encryption_alg_values_supported?: string[];
          request_object_encryption_enc_values_supported?: string[];
          request_object_signing_alg_values_supported?: string[];
          request_parameter_supported?: boolean;
          request_uri_parameter_supported?: boolean;
          require_request_uri_registration?: boolean;
          response_modes_supported?: string[];
          response_types_supported: string[];
          scopes_supported?: string[];
          service_documentation?: string;
          subject_types_supported: string[];
          token_endpoint?: string;
          token_endpoint_auth_methods_supported?: string[];
          token_endpoint_auth_signing_alg_values_supported?: string[];
          ui_locales_supported?: string[];
          user_info_encryption_alg_values_supported?: string[];
          user_info_encryption_enc_values_supported?: string[];
          user_info_signing_alg_values_supported?: string[];
          userinfo_endpoint?: string;
      }
      • Optional acr_values_supported?: string[]
      • authorization_endpoint: string
      • Optional claim_types_supported?: string[]
      • Optional claims_locales_supported?: string[]
      • Optional claims_parameter_supported?: boolean
      • Optional claims_supported?: string[]
      • Optional display_values_supported?: string[]
      • Optional grant_type_supported?: string[]
      • Optional id_token_encryption_alg_values_supported?: string[]
      • Optional id_token_encryption_enc_values_supported?: string[]
      • id_token_signing_alg_values_supported: string[]
      • issuer: string
      • jwks_uri: string
      • Optional op_policy_uri?: string
      • Optional op_tos_uri?: string
      • Optional registration_endpoint?: string
      • Optional request_object_encryption_alg_values_supported?: string[]
      • Optional request_object_encryption_enc_values_supported?: string[]
      • Optional request_object_signing_alg_values_supported?: string[]
      • Optional request_parameter_supported?: boolean
      • Optional request_uri_parameter_supported?: boolean
      • Optional require_request_uri_registration?: boolean
      • Optional response_modes_supported?: string[]
      • response_types_supported: string[]
      • Optional scopes_supported?: string[]
      • Optional service_documentation?: string
      • subject_types_supported: string[]
      • Optional token_endpoint?: string
      • Optional token_endpoint_auth_methods_supported?: string[]
      • Optional token_endpoint_auth_signing_alg_values_supported?: string[]
      • Optional ui_locales_supported?: string[]
      • Optional user_info_encryption_alg_values_supported?: string[]
      • Optional user_info_encryption_enc_values_supported?: string[]
      • Optional user_info_signing_alg_values_supported?: string[]
      • Optional userinfo_endpoint?: string
    • Optional options: OpenIdConfigurationOptions

    Returns OpenIdConfiguration

Properties

acrValuesSupported: undefined | string[]

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

additional: Record<string, unknown>

Additional 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

authorizationEndpoint: string

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

claimTypesSupported: undefined | string[]

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

claimsLocalesSupported: undefined | string[]

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

RFC5646: https://www.rfc-editor.org/rfc/rfc5646

claimsParameterSupported: undefined | boolean

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

claimsSupported: undefined | string[]

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

discoveryEndpoint: undefined | URL

The endpoint to use to refresh this OpenID Configuration data.

displayValuesSupported: undefined | string[]

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

expiresAt: undefined | number

Determines the exact time (in seconds) that the token expires and is used to answer that inquiry. See also: isExpired.

grantTypeSupported: undefined | string[]

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

idTokenEncryptionAlgValuesSupported: undefined | string[]

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

idTokenEncryptionEncValuesSupported: undefined | string[]

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

idTokenSigningAlgValuesSupported: string[]

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

issuer: string

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

jwksUri: string

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

opPolicyUri: undefined | string

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

opTosUri: undefined | string

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

registrationEndpoint: undefined | string

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

requestObjectEncryptionAlgValuesSupported: undefined | string[]

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

requestObjectEncryptionEncValuesSupported: undefined | string[]

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

requestObjectSigningAlgValuesSupported: undefined | string[]

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

requestParameterSupported: undefined | boolean

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

requestUriParameterSupported: undefined | boolean

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

requireRequestUriRegistration: undefined | boolean

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

responseModesSupported: undefined | string[]

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

responseTypesSupported: string[]

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

scopesSupported: undefined | string[]

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

serviceDocumentation: undefined | string

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

subjectTypesSupported: string[]

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

tokenEndpoint: undefined | string

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

tokenEndpointAuthMethodsSupported: undefined | string[]

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

RFC6749: https://www.rfc-editor.org/rfc/rfc6749

tokenEndpointAuthSigningAlgValuesSupported: undefined | string[]

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

uiLocalesSupported: undefined | string[]

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

RFC5646: https://www.rfc-editor.org/rfc/rfc5646

userInfoEncryptionAlgValuesSupported: undefined | string[]
userInfoEncryptionEncValuesSupported: undefined | string[]

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

userInfoEndpoint: undefined | string

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

userInfoSigningAlgValuesSupported: undefined | string[]

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

Type: TypeCheck<TObject<{
    acr_values_supported: TOptional<TArray<TString>>;
    authorization_endpoint: TString;
    claim_types_supported: TOptional<TArray<TString>>;
    claims_locales_supported: TOptional<TArray<TString>>;
    claims_parameter_supported: TOptional<TBoolean>;
    claims_supported: TOptional<TArray<TString>>;
    display_values_supported: TOptional<TArray<TString>>;
    grant_type_supported: TOptional<TArray<TString>>;
    id_token_encryption_alg_values_supported: TOptional<TArray<TString>>;
    id_token_encryption_enc_values_supported: TOptional<TArray<TString>>;
    id_token_signing_alg_values_supported: TArray<TString>;
    issuer: TString;
    jwks_uri: TString;
    op_policy_uri: TOptional<TString>;
    op_tos_uri: TOptional<TString>;
    registration_endpoint: TOptional<TString>;
    request_object_encryption_alg_values_supported: TOptional<TArray<TString>>;
    request_object_encryption_enc_values_supported: TOptional<TArray<TString>>;
    request_object_signing_alg_values_supported: TOptional<TArray<TString>>;
    request_parameter_supported: TOptional<TBoolean>;
    request_uri_parameter_supported: TOptional<TBoolean>;
    require_request_uri_registration: TOptional<TBoolean>;
    response_modes_supported: TOptional<TArray<TString>>;
    response_types_supported: TArray<TString>;
    scopes_supported: TOptional<TArray<TString>>;
    service_documentation: TOptional<TString>;
    subject_types_supported: TArray<TString>;
    token_endpoint: TOptional<TString>;
    token_endpoint_auth_methods_supported: TOptional<TArray<TString>>;
    token_endpoint_auth_signing_alg_values_supported: TOptional<TArray<TString>>;
    ui_locales_supported: TOptional<TArray<TString>>;
    user_info_encryption_alg_values_supported: TOptional<TArray<TString>>;
    user_info_encryption_enc_values_supported: TOptional<TArray<TString>>;
    user_info_signing_alg_values_supported: TOptional<TArray<TString>>;
    userinfo_endpoint: TOptional<TString>;
}>> = ...

Accessors

Methods

  • Parameters

    • config: {
          acr_values_supported?: string[];
          authorization_endpoint: string;
          claim_types_supported?: string[];
          claims_locales_supported?: string[];
          claims_parameter_supported?: boolean;
          claims_supported?: string[];
          display_values_supported?: string[];
          grant_type_supported?: string[];
          id_token_encryption_alg_values_supported?: string[];
          id_token_encryption_enc_values_supported?: string[];
          id_token_signing_alg_values_supported: string[];
          issuer: string;
          jwks_uri: string;
          op_policy_uri?: string;
          op_tos_uri?: string;
          registration_endpoint?: string;
          request_object_encryption_alg_values_supported?: string[];
          request_object_encryption_enc_values_supported?: string[];
          request_object_signing_alg_values_supported?: string[];
          request_parameter_supported?: boolean;
          request_uri_parameter_supported?: boolean;
          require_request_uri_registration?: boolean;
          response_modes_supported?: string[];
          response_types_supported: string[];
          scopes_supported?: string[];
          service_documentation?: string;
          subject_types_supported: string[];
          token_endpoint?: string;
          token_endpoint_auth_methods_supported?: string[];
          token_endpoint_auth_signing_alg_values_supported?: string[];
          ui_locales_supported?: string[];
          user_info_encryption_alg_values_supported?: string[];
          user_info_encryption_enc_values_supported?: string[];
          user_info_signing_alg_values_supported?: string[];
          userinfo_endpoint?: string;
      }
      • Optional acr_values_supported?: string[]
      • authorization_endpoint: string
      • Optional claim_types_supported?: string[]
      • Optional claims_locales_supported?: string[]
      • Optional claims_parameter_supported?: boolean
      • Optional claims_supported?: string[]
      • Optional display_values_supported?: string[]
      • Optional grant_type_supported?: string[]
      • Optional id_token_encryption_alg_values_supported?: string[]
      • Optional id_token_encryption_enc_values_supported?: string[]
      • id_token_signing_alg_values_supported: string[]
      • issuer: string
      • jwks_uri: string
      • Optional op_policy_uri?: string
      • Optional op_tos_uri?: string
      • Optional registration_endpoint?: string
      • Optional request_object_encryption_alg_values_supported?: string[]
      • Optional request_object_encryption_enc_values_supported?: string[]
      • Optional request_object_signing_alg_values_supported?: string[]
      • Optional request_parameter_supported?: boolean
      • Optional request_uri_parameter_supported?: boolean
      • Optional require_request_uri_registration?: boolean
      • Optional response_modes_supported?: string[]
      • response_types_supported: string[]
      • Optional scopes_supported?: string[]
      • Optional service_documentation?: string
      • subject_types_supported: string[]
      • Optional token_endpoint?: string
      • Optional token_endpoint_auth_methods_supported?: string[]
      • Optional token_endpoint_auth_signing_alg_values_supported?: string[]
      • Optional ui_locales_supported?: string[]
      • Optional user_info_encryption_alg_values_supported?: string[]
      • Optional user_info_encryption_enc_values_supported?: string[]
      • Optional user_info_signing_alg_values_supported?: string[]
      • Optional userinfo_endpoint?: string
    • Optional options: OpenIdConfigurationOptions

    Returns this