Package org.springframework.security.oauth2.core

Interface OAuth2AuthenticatedPrincipal

All Superinterfaces:

AuthenticatedPrincipal

All Known Subinterfaces:

OAuth2User, OidcUser

All Known Implementing Classes:

DefaultOAuth2AuthenticatedPrincipal, DefaultOAuth2User, DefaultOidcUser, OAuth2IntrospectionAuthenticatedPrincipal

public interface OAuth2AuthenticatedPrincipal
extends AuthenticatedPrincipal

An AuthenticatedPrincipal that represents the principal associated with an OAuth 2.0 token.

Since:

5.2

Method Summary

Modifier and Type	Method	Description
default <A> A	getAttribute(String name)	Get the OAuth 2.0 token attribute by name
Map<String,Object>	getAttributes()	Get the OAuth 2.0 token attributes
Collection<? extends GrantedAuthority>	getAuthorities()	Get the Collection of GrantedAuthoritys associated with this OAuth 2.0 token

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

getName

Method Details

getAttribute

@Nullable
default <A> A getAttribute(String name)

Get the OAuth 2.0 token attribute by name

Type Parameters:

A - the type of the attribute

Parameters:

name - the name of the attribute

Returns:

the attribute or null otherwise

getAttributes

Map<String,Object> getAttributes()

Get the OAuth 2.0 token attributes

Returns:

the OAuth 2.0 token attributes

getAuthorities

Collection<? extends GrantedAuthority> getAuthorities()

Get the Collection of GrantedAuthoritys associated with this OAuth 2.0 token

Returns:

the OAuth 2.0 token authorities