OidcConfiguration class abstract

Includes links to several endpoints (for example /oauth2/token) and exposes information on supported signature algorithms among others.

Properties:

  • authorizationEndpoint - OAuth 2.0 Authorization Endpoint URL
  • backchannelLogoutSessionSupported - 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
  • backchannelLogoutSupported - OpenID Connect Back-Channel Logout Supported Boolean value specifying whether the OP supports back-channel logout, with true indicating support.
  • claimsParameterSupported - OpenID Connect Claims Parameter Parameter Supported Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support.
  • claimsSupported - 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.
  • codeChallengeMethodsSupported - 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.
  • credentialsEndpointDraft00 - OpenID Connect Verifiable Credentials Endpoint Contains the URL of the Verifiable Credentials Endpoint.
  • credentialsSupportedDraft00 - OpenID Connect Verifiable Credentials Supported JSON array containing a list of the Verifiable Credentials supported by this authorization server.
  • endSessionEndpoint - 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.
  • frontchannelLogoutSessionSupported - 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.
  • frontchannelLogoutSupported - OpenID Connect Front-Channel Logout Supported Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support.
  • grantTypesSupported - OAuth 2.0 Supported Grant Types JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports.
  • idTokenSignedResponseAlg - OpenID Connect Default ID Token Signing Algorithms Algorithm used to sign OpenID Connect ID Tokens.
  • idTokenSigningAlgValuesSupported - 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.
  • issuer - 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.
  • jwksUri - 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.
  • registrationEndpoint - OpenID Connect Dynamic Client Registration Endpoint URL
  • requestObjectSigningAlgValuesSupported - 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).
  • requestParameterSupported - OpenID Connect Request Parameter Supported Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.
  • requestUriParameterSupported - OpenID Connect Request URI Parameter Supported Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.
  • requireRequestUriRegistration - 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.
  • responseModesSupported - OAuth 2.0 Supported Response Modes JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.
  • responseTypesSupported - 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.
  • revocationEndpoint - OAuth 2.0 Token Revocation URL URL of the authorization server's OAuth 2.0 revocation endpoint.
  • scopesSupported - 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
  • subjectTypesSupported - 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.
  • tokenEndpoint - OAuth 2.0 Token Endpoint URL
  • tokenEndpointAuthMethodsSupported - 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
  • userinfoEndpoint - OpenID Connect Userinfo URL URL of the OP's UserInfo Endpoint.
  • userinfoSignedResponseAlg - OpenID Connect User Userinfo Signing Algorithm Algorithm used to sign OpenID Connect Userinfo Responses.
  • userinfoSigningAlgValuesSupported - 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.
Annotations
  • @BuiltValue()

Constructors

OidcConfiguration([void updates(OidcConfigurationBuilder b)])
factory

Properties

authorizationEndpoint → String
OAuth 2.0 Authorization Endpoint URL
no setter
backchannelLogoutSessionSupported → bool?
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
no setter
backchannelLogoutSupported → bool?
OpenID Connect Back-Channel Logout Supported Boolean value specifying whether the OP supports back-channel logout, with true indicating support.
no setter
claimsParameterSupported → bool?
OpenID Connect Claims Parameter Parameter Supported Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support.
no setter
claimsSupported → BuiltList<String>?
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.
no setter
codeChallengeMethodsSupported → BuiltList<String>?
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.
no setter
credentialsEndpointDraft00 → String?
OpenID Connect Verifiable Credentials Endpoint Contains the URL of the Verifiable Credentials Endpoint.
no setter
credentialsSupportedDraft00 → BuiltList<CredentialSupportedDraft00>?
OpenID Connect Verifiable Credentials Supported JSON array containing a list of the Verifiable Credentials supported by this authorization server.
no setter
endSessionEndpoint → String?
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.
no setter
frontchannelLogoutSessionSupported → bool?
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.
no setter
frontchannelLogoutSupported → bool?
OpenID Connect Front-Channel Logout Supported Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support.
no setter
grantTypesSupported → BuiltList<String>?
OAuth 2.0 Supported Grant Types JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports.
no setter
hashCode → int
The hash code for this object.
no setterinherited
idTokenSignedResponseAlg → BuiltList<String>
OpenID Connect Default ID Token Signing Algorithms Algorithm used to sign OpenID Connect ID Tokens.
no setter
idTokenSigningAlgValuesSupported → BuiltList<String>
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.
no setter
issuer → String
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.
no setter
jwksUri → String
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.
no setter
registrationEndpoint → String?
OpenID Connect Dynamic Client Registration Endpoint URL
no setter
requestObjectSigningAlgValuesSupported → BuiltList<String>?
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).
no setter
requestParameterSupported → bool?
OpenID Connect Request Parameter Supported Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.
no setter
requestUriParameterSupported → bool?
OpenID Connect Request URI Parameter Supported Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.
no setter
requireRequestUriRegistration → bool?
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.
no setter
responseModesSupported → BuiltList<String>?
OAuth 2.0 Supported Response Modes JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.
no setter
responseTypesSupported → BuiltList<String>
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.
no setter
revocationEndpoint → String?
OAuth 2.0 Token Revocation URL URL of the authorization server's OAuth 2.0 revocation endpoint.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scopesSupported → BuiltList<String>?
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
no setter
subjectTypesSupported → BuiltList<String>
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.
no setter
tokenEndpoint → String
OAuth 2.0 Token Endpoint URL
no setter
tokenEndpointAuthMethodsSupported → BuiltList<String>?
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
no setter
userinfoEndpoint → String?
OpenID Connect Userinfo URL URL of the OP's UserInfo Endpoint.
no setter
userinfoSignedResponseAlg → BuiltList<String>
OpenID Connect User Userinfo Signing Algorithm Algorithm used to sign OpenID Connect Userinfo Responses.
no setter
userinfoSigningAlgValuesSupported → BuiltList<String>?
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.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(OidcConfigurationBuilder)) → OidcConfiguration
Rebuilds the instance.
inherited
toBuilder() → OidcConfigurationBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<OidcConfiguration>
no setter