org.springframework.security.oauth2.client.annotation

Annotation Type OAuth2Client

@Target(value={PARAMETER,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Documented
public @interface OAuth2Client

This annotation may be used to resolve a method parameter into an argument value for the following types: ClientRegistration, OAuth2AuthorizedClient and OAuth2AccessToken.

For example:

 @Controller
 public class MyController {
     @GetMapping("/client-registration")
     public String clientRegistration(@OAuth2Client("login-client") ClientRegistration clientRegistration) {
         // do something with clientRegistration
     }

     @GetMapping("/authorized-client")
     public String authorizedClient(@OAuth2Client("login-client") OAuth2AuthorizedClient authorizedClient) {
         // do something with authorizedClient
     }

     @GetMapping("/access-token")
     public String accessToken(@OAuth2Client("login-client") OAuth2AccessToken accessToken) {
         // do something with accessToken
     }
 }
 

Since:

5.1

See Also:

OAuth2ClientArgumentResolver

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	registrationId Sets the client registration identifier.
java.lang.String	value The default attribute for this annotation.

Element Detail

registrationId

@AliasFor(value="value")
public abstract java.lang.String registrationId

Sets the client registration identifier.

Returns:

the client registration identifier

Default:

""

value

@AliasFor(value="registrationId")
public abstract java.lang.String value

The default attribute for this annotation. This is an alias for registrationId(). For example, @OAuth2Client("login-client") is equivalent to @OAuth2Client(registrationId="login-client").

Returns:

the client registration identifier

Default:

""