Package org.springframework.security.oauth2.server.authorization.oidc.authentication

Class OidcClientRegistrationAuthenticationToken

java.lang.Object
org.springframework.security.authentication.AbstractAuthenticationToken
org.springframework.security.oauth2.server.authorization.oidc.authentication.OidcClientRegistrationAuthenticationToken
All Implemented Interfaces:
Serializable, Principal, Authentication, CredentialsContainer
public class OidcClientRegistrationAuthenticationToken extends AbstractAuthenticationToken
An Authentication implementation used for OpenID Connect 1.0 Dynamic Client Registration (and Configuration) Endpoint.
Since:
7.0
See Also:

  • Constructor Details

    • OidcClientRegistrationAuthenticationToken

      public OidcClientRegistrationAuthenticationToken(Authentication principal, OidcClientRegistration clientRegistration)
      Constructs an OidcClientRegistrationAuthenticationToken using the provided parameters.
      Parameters:
      principal - the authenticated principal
      clientRegistration - the client registration

    • OidcClientRegistrationAuthenticationToken

      public OidcClientRegistrationAuthenticationToken(Authentication principal, String clientId)
      Constructs an OidcClientRegistrationAuthenticationToken using the provided parameters.
      Parameters:
      principal - the authenticated principal
      clientId - the client identifier

  • Method Details

    • getPrincipal

      public Object getPrincipal()
      Description copied from interface: Authentication
      The identity of the principal being authenticated. In the case of an authentication request with username and password, this would be the username. Callers are expected to populate the principal for an authentication request.

      The AuthenticationManager implementation will often return an Authentication containing richer information as the principal for use by the application. Many of the authentication providers will create a UserDetails object as the principal.

      Returns:
      the Principal being authenticated or the authenticated principal after authentication.

    • getCredentials

      public Object getCredentials()
      Description copied from interface: Authentication
      The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to the AuthenticationManager. Callers are expected to populate the credentials.
      Returns:
      the credentials that prove the identity of the Principal

    • getClientRegistration

      public OidcClientRegistration getClientRegistration()
      Returns the client registration.
      Returns:
      the client registration

    • getClientId

      @Nullable public String getClientId()
      Returns the client identifier.
      Returns:
      the client identifier