org.springframework.security.oauth2.oidc.user

Interface UserInfo

All Superinterfaces:

AuthenticatedPrincipal, OAuth2User, java.io.Serializable

All Known Implementing Classes:

DefaultUserInfo

public interface UserInfo
extends OAuth2User

A representation of a user Principal that is registered with an OpenID Connect 1.0 Provider.

The structure of the user Principal is defined by the UserInfo Endpoint, which is an OAuth 2.0 Protected Resource that returns a set of Claims about the authenticated End-User.

Implementation instances of this interface represent an AuthenticatedPrincipal which is associated to an Authentication object and may be accessed via Authentication.getPrincipal().

Since:

5.0

See Also:

DefaultUserInfo, AuthenticatedPrincipal, OpenID Connect Core 1.0, UserInfo Endpoint, Standard Claims

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UserInfo.Address

Method Summary

Modifier and Type	Method and Description
UserInfo.Address	getAddress()
java.lang.String	getBirthdate()
java.lang.String	getEmail()
java.lang.Boolean	getEmailVerified()
java.lang.String	getFamilyName()
java.lang.String	getGender()
java.lang.String	getGivenName()
java.lang.String	getLocale()
java.lang.String	getMiddleName()
java.lang.String	getNickName()
java.lang.String	getPhoneNumber()
java.lang.Boolean	getPhoneNumberVerified()
java.lang.String	getPicture()
java.lang.String	getPreferredUsername()
java.lang.String	getProfile()
java.lang.String	getSubject()
java.time.Instant	getUpdatedAt()
java.lang.String	getWebsite()
java.lang.String	getZoneInfo()

Methods inherited from interface org.springframework.security.oauth2.core.user.OAuth2User

getAttributes, getAuthorities

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

getName

Method Detail

getSubject

java.lang.String getSubject()

getGivenName

java.lang.String getGivenName()

getFamilyName

java.lang.String getFamilyName()

getMiddleName

java.lang.String getMiddleName()

getNickName

java.lang.String getNickName()

getPreferredUsername

java.lang.String getPreferredUsername()

getProfile

java.lang.String getProfile()

getPicture

java.lang.String getPicture()

getWebsite

java.lang.String getWebsite()

getEmail

java.lang.String getEmail()

getEmailVerified

java.lang.Boolean getEmailVerified()

getGender

java.lang.String getGender()

getBirthdate

java.lang.String getBirthdate()

getZoneInfo

java.lang.String getZoneInfo()

getLocale

java.lang.String getLocale()

getPhoneNumber

java.lang.String getPhoneNumber()

getPhoneNumberVerified

java.lang.Boolean getPhoneNumberVerified()

getAddress

UserInfo.Address getAddress()

getUpdatedAt

java.time.Instant getUpdatedAt()