org.springframework.security.oauth2.core.user

Interface OAuth2User

All Superinterfaces:

org.springframework.security.core.AuthenticatedPrincipal

All Known Subinterfaces:

OidcUser

All Known Implementing Classes:

DefaultOAuth2User, DefaultOidcUser

public interface OAuth2User
extends org.springframework.security.core.AuthenticatedPrincipal

A representation of a user Principal that is registered with an OAuth 2.0 Provider.

An OAuth 2.0 user is composed of one or more attributes, for example, first name, middle name, last name, email, phone number, address, etc. Each user attribute has a "name" and "value" and is keyed by the "name" in getAttributes().

NOTE: Attribute names are not standardized between providers and therefore will vary. Please consult the provider's API documentation for the set of supported user attribute names.

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:

DefaultOAuth2User, AuthenticatedPrincipal

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() Returns the attributes about the user.
java.util.Collection<? extends org.springframework.security.core.GrantedAuthority>	getAuthorities() Returns the authorities granted to the user.

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

getName

Method Detail

getAuthorities

java.util.Collection<? extends org.springframework.security.core.GrantedAuthority> getAuthorities()

Returns the authorities granted to the user.

Returns:

a Collection of GrantedAuthority(s)

getAttributes

java.util.Map<java.lang.String,java.lang.Object> getAttributes()

Returns the attributes about the user.

Returns:

a Map of attributes about the user