Class OidcUserInfoAuthenticationToken

java.lang.Object
org.springframework.security.authentication.AbstractAuthenticationToken
org.springframework.security.oauth2.server.authorization.oidc.authentication.OidcUserInfoAuthenticationToken
All Implemented Interfaces:
Serializable, Principal, org.springframework.security.core.Authentication, org.springframework.security.core.CredentialsContainer
public class OidcUserInfoAuthenticationToken extends org.springframework.security.authentication.AbstractAuthenticationToken
An Authentication implementation used for OpenID Connect 1.0 UserInfo Endpoint.
Since:
7.0
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

    org.springframework.security.authentication.AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>

    Nested classes/interfaces inherited from interface org.springframework.security.core.Authentication

    org.springframework.security.core.Authentication.Builder<B>

  • Constructor Summary

    Constructors
    Constructor
    Description
    OidcUserInfoAuthenticationToken(org.springframework.security.core.Authentication principal)
    Constructs an OidcUserInfoAuthenticationToken using the provided parameters.
    OidcUserInfoAuthenticationToken(org.springframework.security.core.Authentication principal, org.springframework.security.oauth2.core.oidc.OidcUserInfo userInfo)
    Constructs an OidcUserInfoAuthenticationToken using the provided parameters.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    getCredentials()
     
    Object
    getPrincipal()
     
    @Nullable org.springframework.security.oauth2.core.oidc.OidcUserInfo
    getUserInfo()
    Returns the UserInfo claims.

    Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

    equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.springframework.security.core.Authentication

    toBuilder

    Methods inherited from interface Principal

    implies

  • Constructor Details

    • OidcUserInfoAuthenticationToken

      public OidcUserInfoAuthenticationToken(org.springframework.security.core.Authentication principal)
      Constructs an OidcUserInfoAuthenticationToken using the provided parameters.
      Parameters:
      principal - the principal

    • OidcUserInfoAuthenticationToken

      public OidcUserInfoAuthenticationToken(org.springframework.security.core.Authentication principal, org.springframework.security.oauth2.core.oidc.OidcUserInfo userInfo)
      Constructs an OidcUserInfoAuthenticationToken using the provided parameters.
      Parameters:
      principal - the authenticated principal
      userInfo - the UserInfo claims

  • Method Details

    • getPrincipal

      public Object getPrincipal()

    • getCredentials

      public Object getCredentials()

    • getUserInfo

      public @Nullable org.springframework.security.oauth2.core.oidc.OidcUserInfo getUserInfo()
      Returns the UserInfo claims.
      Returns:
      the UserInfo claims, or null if not provided