Class OidcUserInfo

java.lang.Object

org.springframework.security.oauth2.core.oidc.OidcUserInfo

All Implemented Interfaces:

Serializable, ClaimAccessor, StandardClaimAccessor

public class OidcUserInfo
extends Object
implements StandardClaimAccessor, Serializable

A representation of a UserInfo Response that is returned from the OAuth 2.0 Protected Resource UserInfo Endpoint.

The OidcUserInfo contains a set of "Standard Claims" about the authentication of an End-User.

Since:

5.0

See Also:

• StandardClaimAccessor
• UserInfo Response
• UserInfo Endpoint
• Standard Claims
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OidcUserInfo.Builder	A builder for OidcUserInfos.

Constructor Summary

Constructors

Constructor	Description
OidcUserInfo(Map<String,Object> claims)	Constructs a OidcUserInfo using the provided parameters.

Method Summary

Modifier and Type	Method	Description
static OidcUserInfo.Builder	builder()	Create a OidcUserInfo.Builder.
boolean	equals(@Nullable Object obj)
Map<String,Object>	getClaims()	Returns a set of claims that may be used for assertions.
int	hashCode()

Methods inherited from class Object

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

Methods inherited from interface ClaimAccessor

getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL, hasClaim

Methods inherited from interface StandardClaimAccessor

getAddress, getBirthdate, getEmail, getEmailVerified, getFamilyName, getFullName, getGender, getGivenName, getLocale, getMiddleName, getNickName, getPhoneNumber, getPhoneNumberVerified, getPicture, getPreferredUsername, getProfile, getSubject, getUpdatedAt, getWebsite, getZoneInfo

Constructor Details

OidcUserInfo

public OidcUserInfo(Map<String,Object> claims)

Constructs a OidcUserInfo using the provided parameters.

Parameters:

claims - the claims about the authentication of the End-User

Method Details

getClaims

public Map<String,Object> getClaims()

Description copied from interface: ClaimAccessor

Returns a set of claims that may be used for assertions.

Specified by:

getClaims in interface ClaimAccessor

Returns:

a Map of claims

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static OidcUserInfo.Builder builder()

Create a OidcUserInfo.Builder.

Returns:

the OidcUserInfo.Builder for further configuration

Since:

5.3