Package org.springframework.security.oauth2.client.web

Class OAuth2AuthorizationRequestCustomizers

java.lang.Object

org.springframework.security.oauth2.client.web.OAuth2AuthorizationRequestCustomizers

public final class OAuth2AuthorizationRequestCustomizers
extends java.lang.Object

A factory of customizers that customize the OAuth 2.0 Authorization Request via the OAuth2AuthorizationRequest.Builder.

Since:

5.7

See Also:

OAuth2AuthorizationRequest.Builder, DefaultOAuth2AuthorizationRequestResolver.setAuthorizationRequestCustomizer(Consumer), DefaultServerOAuth2AuthorizationRequestResolver.setAuthorizationRequestCustomizer(Consumer)

Method Summary

Modifier and Type	Method	Description
static java.util.function.Consumer<org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder>	withPkce()	Returns a Consumer to be provided the OAuth2AuthorizationRequest.Builder that adds the code_challenge and, usually, code_challenge_method parameters to the OAuth 2.0 Authorization Request.

Methods inherited from class java.lang.Object

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

Method Detail

withPkce

public static java.util.function.Consumer<org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder> withPkce()

Returns a Consumer to be provided the OAuth2AuthorizationRequest.Builder that adds the code_challenge and, usually, code_challenge_method parameters to the OAuth 2.0 Authorization Request. The code_verifier is stored in OAuth2AuthorizationRequest.getAttribute(String) under the key code_verifier for subsequent use in the OAuth 2.0 Access Token Request.

Returns:

a Consumer to be provided the OAuth2AuthorizationRequest.Builder that adds the PKCE parameters

See Also:

1.1. Protocol Flow, 4.1. Client Creates a Code Verifier, 4.2. Client Creates the Code Challenge