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

Class OidcUserInfoAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

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

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

public class OidcUserInfoAuthenticationToken
extends AbstractAuthenticationToken

An Authentication implementation used for OpenID Connect 1.0 UserInfo Endpoint.

Since:

7.0

See Also:

• AbstractAuthenticationToken
• OidcUserInfo
• OidcUserInfoAuthenticationProvider
• Serialized Form

Nested Class Summary

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

AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

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

Authentication.Builder<B extends Authentication.Builder<B>>

Constructor Summary

Constructors

Constructor	Description
OidcUserInfoAuthenticationToken(Authentication principal)	Constructs an OidcUserInfoAuthenticationToken using the provided parameters.
OidcUserInfoAuthenticationToken(Authentication principal, OidcUserInfo userInfo)	Constructs an OidcUserInfoAuthenticationToken using the provided parameters.

Method Summary

Modifier and Type	Method	Description
Object	getCredentials()	The credentials that prove the principal is correct.
Object	getPrincipal()	The identity of the principal being authenticated.
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 java.lang.Object

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

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

toBuilder

Methods inherited from interface java.security.Principal

implies

Constructor Details

OidcUserInfoAuthenticationToken

public OidcUserInfoAuthenticationToken(Authentication principal)

Constructs an OidcUserInfoAuthenticationToken using the provided parameters.

Parameters:

principal - the principal

OidcUserInfoAuthenticationToken

public OidcUserInfoAuthenticationToken(Authentication principal,
 OidcUserInfo userInfo)

Constructs an OidcUserInfoAuthenticationToken using the provided parameters.

Parameters:

principal - the authenticated principal

userInfo - the UserInfo claims

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

getUserInfo

public OidcUserInfo getUserInfo()

Returns the UserInfo claims.

Returns:

the UserInfo claims