Package org.springframework.security.oauth2.client.annotation

Annotation Interface ClientRegistrationId

@Target({METHOD,TYPE}) @Retention(RUNTIME) @Documented public @interface ClientRegistrationId
This annotation can be added to the method of an interface based HTTP client created using HttpServiceProxyFactory to automatically associate an OAuth token with the request.
Since:
7.0
See Also:

  • Optional Element Summary

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

  • Element Details

    • registrationId

      @AliasFor("value") String registrationId
      Sets the client registration identifier.
      Returns:
      the client registration identifier
      Default:
      ""

    • value

      @AliasFor("registrationId") String value
      The default attribute for this annotation. This is an alias for registrationId(). For example, @RegisteredOAuth2AuthorizedClient("login-client") is equivalent to @RegisteredOAuth2AuthorizedClient(registrationId="login-client").
      Returns:
      the client registration identifier
      Default:
      ""