Class OidcClientRegistration.Builder

java.lang.Object

org.springframework.security.oauth2.server.authorization.AbstractOAuth2ClientRegistration.AbstractBuilder<OidcClientRegistration, OidcClientRegistration.Builder>

org.springframework.security.oauth2.server.authorization.oidc.OidcClientRegistration.Builder

Enclosing class:

OidcClientRegistration

public static final class OidcClientRegistration.Builder
extends AbstractOAuth2ClientRegistration.AbstractBuilder<OidcClientRegistration, OidcClientRegistration.Builder>

Helps configure an OidcClientRegistration.

Since:

7.0

Method Summary

Modifier and Type	Method	Description
OidcClientRegistration	build()	Validate the claims and build the OidcClientRegistration.
OidcClientRegistration.Builder	idTokenSignedResponseAlgorithm(String idTokenSignedResponseAlgorithm)	Sets the JWS algorithm required for signing the ID Token issued to the Client, OPTIONAL.
OidcClientRegistration.Builder	postLogoutRedirectUri(String postLogoutRedirectUri)	Add the post logout redirection URI used by the Client, OPTIONAL.
OidcClientRegistration.Builder	postLogoutRedirectUris(Consumer<List<String>> postLogoutRedirectUrisConsumer)	A Consumer of the post logout redirection URI values used by the Client, allowing the ability to add, replace, or remove, OPTIONAL.
OidcClientRegistration.Builder	registrationAccessToken(String registrationAccessToken)	Sets the Registration Access Token that can be used at the Client Configuration Endpoint, OPTIONAL.
OidcClientRegistration.Builder	registrationClientUrl(String registrationClientUrl)	Sets the URL of the Client Configuration Endpoint where the Registration Access Token can be used, OPTIONAL.
OidcClientRegistration.Builder	tokenEndpointAuthenticationSigningAlgorithm(String authenticationSigningAlgorithm)	Sets the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods, OPTIONAL.
protected void	validate()

Methods inherited from class AbstractOAuth2ClientRegistration.AbstractBuilder

claim, claims, clientId, clientIdIssuedAt, clientName, clientSecret, clientSecretExpiresAt, getClaims, getThis, grantType, grantTypes, jwkSetUrl, redirectUri, redirectUris, responseType, responseTypes, scope, scopes, tokenEndpointAuthenticationMethod

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

postLogoutRedirectUri

public OidcClientRegistration.Builder postLogoutRedirectUri(String postLogoutRedirectUri)

Add the post logout redirection URI used by the Client, OPTIONAL. The post_logout_redirect_uri parameter is used by the client when requesting that the End-User's User Agent be redirected to after a logout has been performed.

Parameters:

postLogoutRedirectUri - the post logout redirection URI used by the Client

Returns:

the OidcClientRegistration.Builder for further configuration

postLogoutRedirectUris

public OidcClientRegistration.Builder postLogoutRedirectUris(Consumer<List<String>> postLogoutRedirectUrisConsumer)

A Consumer of the post logout redirection URI values used by the Client, allowing the ability to add, replace, or remove, OPTIONAL.

Parameters:

postLogoutRedirectUrisConsumer - a Consumer of the post logout redirection URI values used by the Client

Returns:

the OidcClientRegistration.Builder for further configuration

tokenEndpointAuthenticationSigningAlgorithm

public OidcClientRegistration.Builder tokenEndpointAuthenticationSigningAlgorithm(String authenticationSigningAlgorithm)

Sets the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods, OPTIONAL.

Parameters:

authenticationSigningAlgorithm - the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint

Returns:

the OidcClientRegistration.Builder for further configuration

idTokenSignedResponseAlgorithm

public OidcClientRegistration.Builder idTokenSignedResponseAlgorithm(String idTokenSignedResponseAlgorithm)

Sets the JWS algorithm required for signing the ID Token issued to the Client, OPTIONAL.

Parameters:

idTokenSignedResponseAlgorithm - the JWS algorithm required for signing the ID Token issued to the Client

Returns:

the OidcClientRegistration.Builder for further configuration

registrationAccessToken

public OidcClientRegistration.Builder registrationAccessToken(String registrationAccessToken)

Sets the Registration Access Token that can be used at the Client Configuration Endpoint, OPTIONAL.

Parameters:

registrationAccessToken - the Registration Access Token that can be used at the Client Configuration Endpoint

Returns:

the OidcClientRegistration.Builder for further configuration

registrationClientUrl

public OidcClientRegistration.Builder registrationClientUrl(String registrationClientUrl)

Sets the URL of the Client Configuration Endpoint where the Registration Access Token can be used, OPTIONAL.

Parameters:

registrationClientUrl - the URL of the Client Configuration Endpoint where the Registration Access Token can be used

Returns:

the OidcClientRegistration.Builder for further configuration

build

public OidcClientRegistration build()

Validate the claims and build the OidcClientRegistration.

The following claims are REQUIRED: client_id, redirect_uris.

Specified by:

build in class AbstractOAuth2ClientRegistration.AbstractBuilder<OidcClientRegistration, OidcClientRegistration.Builder>

Returns:

the OidcClientRegistration

validate

protected void validate()

Overrides:

validate in class AbstractOAuth2ClientRegistration.AbstractBuilder<OidcClientRegistration, OidcClientRegistration.Builder>