org.springframework.security.core

Interface AuthenticatedPrincipal

All Known Subinterfaces:

OAuth2User, OidcUser

All Known Implementing Classes:

DefaultOAuth2User, DefaultOidcUser

public interface AuthenticatedPrincipal

Representation of an authenticated Principal once an Authentication request has been successfully authenticated by the AuthenticationManager.authenticate(Authentication) method. Implementors typically provide their own representation of a Principal, which usually contains information describing the Principal entity, such as, first/middle/last name, address, email, phone, id, etc. This interface allows implementors to expose specific attributes of their custom representation of Principal in a generic way.

Since:

5.0

See Also:

Authentication.getPrincipal(), UserDetails

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of the authenticated Principal.

Method Detail

getName

java.lang.String getName()

Returns the name of the authenticated Principal. Never null.

Returns:

the name of the authenticated Principal