org.springframework.security.oauth2.core

Interface OAuth2AuthenticatedPrincipal

All Superinterfaces:

org.springframework.security.core.AuthenticatedPrincipal

All Known Subinterfaces:

OAuth2User, OidcUser

All Known Implementing Classes:

DefaultOAuth2AuthenticatedPrincipal, DefaultOAuth2User, DefaultOidcUser

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

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

Since:

5.2

Method Summary

Modifier and Type	Method and Description
default <A> A	getAttribute(java.lang.String name) Get the OAuth 2.0 token attribute by name
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() Get the OAuth 2.0 token attributes
java.util.Collection<? extends org.springframework.security.core.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 Detail

getAttribute

@Nullable
default <A> A getAttribute(java.lang.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

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

Get the OAuth 2.0 token attributes

Returns:

the OAuth 2.0 token attributes

getAuthorities

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

Get the Collection of GrantedAuthoritys associated with this OAuth 2.0 token

Returns:

the OAuth 2.0 token authorities