StandardClaimAccessor (spring-security-oauth2-core 5.2.4.RELEASE API)

All Superinterfaces:

ClaimAccessor

All Known Subinterfaces:

IdTokenClaimAccessor, OidcUser

All Known Implementing Classes:

DefaultOidcUser, OidcIdToken, OidcUserInfo
```
public interface StandardClaimAccessor
extends ClaimAccessor
```
A ClaimAccessor for the "Standard Claims" that can be returned either in the UserInfo Response or the ID Token.

Since:

5.0

See Also:

ClaimAccessor, StandardClaimNames, OidcUserInfo, UserInfo Response, Standard Claims

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default AddressStandardClaim`	`getAddress()` Returns the user's preferred postal address `(address)`.
`default java.lang.String`	`getBirthdate()` Returns the user's birth date `(birthdate)`.
`default java.lang.String`	`getEmail()` Returns the user's preferred e-mail address `(email)`.
`default java.lang.Boolean`	`getEmailVerified()` Returns `true` if the user's e-mail address has been verified `(email_verified)`, otherwise `false`.
`default java.lang.String`	`getFamilyName()` Returns the user's surname(s) or last name(s) `(family_name)`.
`default java.lang.String`	`getFullName()` Returns the user's full name `(name)` in displayable form.
`default java.lang.String`	`getGender()` Returns the user's gender `(gender)`.
`default java.lang.String`	`getGivenName()` Returns the user's given name(s) or first name(s) `(given_name)`.
`default java.lang.String`	`getLocale()` Returns the user's locale `(locale)`.
`default java.lang.String`	`getMiddleName()` Returns the user's middle name(s) `(middle_name)`.
`default java.lang.String`	`getNickName()` Returns the user's nick name `(nickname)` that may or may not be the same as the `(given_name)`.
`default java.lang.String`	`getPhoneNumber()` Returns the user's preferred phone number `(phone_number)`.
`default java.lang.Boolean`	`getPhoneNumberVerified()` Returns `true` if the user's phone number has been verified `(phone_number_verified)`, otherwise `false`.
`default java.lang.String`	`getPicture()` Returns the URL of the user's profile picture `(picture)`.
`default java.lang.String`	`getPreferredUsername()` Returns the preferred username `(preferred_username)` that the user wishes to be referred to.
`default java.lang.String`	`getProfile()` Returns the URL of the user's profile page `(profile)`.
`default java.lang.String`	`getSubject()` Returns the Subject identifier `(sub)`.
`default java.time.Instant`	`getUpdatedAt()` Returns the time the user's information was last updated `(updated_at)`.
`default java.lang.String`	`getWebsite()` Returns the URL of the user's web page or blog `(website)`.
`default java.lang.String`	`getZoneInfo()` Returns the user's time zone `(zoneinfo)`.

Methods inherited from interface org.springframework.security.oauth2.core.ClaimAccessor
containsClaim, getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL, getClaims

- Method Detail
  - getSubject
```
default java.lang.String getSubject()
```
    Returns the Subject identifier (sub).
    
    Returns:
    
    the Subject identifier
  - getFullName
```
default java.lang.String getFullName()
```
    Returns the user's full name (name) in displayable form.
    
    Returns:
    
    the user's full name
  - getGivenName
```
default java.lang.String getGivenName()
```
    Returns the user's given name(s) or first name(s) (given_name).
    
    Returns:
    
    the user's given name(s)
  - getFamilyName
```
default java.lang.String getFamilyName()
```
    Returns the user's surname(s) or last name(s) (family_name).
    
    Returns:
    
    the user's family names(s)
  - getMiddleName
```
default java.lang.String getMiddleName()
```
    Returns the user's middle name(s) (middle_name).
    
    Returns:
    
    the user's middle name(s)
  - getNickName
```
default java.lang.String getNickName()
```
    Returns the user's nick name (nickname) that may or may not be the same as the (given_name).
    
    Returns:
    
    the user's nick name
  - getPreferredUsername
```
default java.lang.String getPreferredUsername()
```
    Returns the preferred username (preferred_username) that the user wishes to be referred to.
    
    Returns:
    
    the user's preferred user name
  - getProfile
```
default java.lang.String getProfile()
```
    Returns the URL of the user's profile page (profile).
    
    Returns:
    
    the URL of the user's profile page
  - getPicture
```
default java.lang.String getPicture()
```
    Returns the URL of the user's profile picture (picture).
    
    Returns:
    
    the URL of the user's profile picture
  - getWebsite
```
default java.lang.String getWebsite()
```
    Returns the URL of the user's web page or blog (website).
    
    Returns:
    
    the URL of the user's web page or blog
  - getEmail
```
default java.lang.String getEmail()
```
    Returns the user's preferred e-mail address (email).
    
    Returns:
    
    the user's preferred e-mail address
  - getEmailVerified
```
default java.lang.Boolean getEmailVerified()
```
    Returns true if the user's e-mail address has been verified (email_verified), otherwise false.
    
    Returns:
    
    true if the user's e-mail address has been verified, otherwise false
  - getGender
```
default java.lang.String getGender()
```
    Returns the user's gender (gender).
    
    Returns:
    
    the user's gender
  - getBirthdate
```
default java.lang.String getBirthdate()
```
    Returns the user's birth date (birthdate).
    
    Returns:
    
    the user's birth date
  - getZoneInfo
```
default java.lang.String getZoneInfo()
```
    Returns the user's time zone (zoneinfo).
    
    Returns:
    
    the user's time zone
  - getLocale
```
default java.lang.String getLocale()
```
    Returns the user's locale (locale).
    
    Returns:
    
    the user's locale
  - getPhoneNumber
```
default java.lang.String getPhoneNumber()
```
    Returns the user's preferred phone number (phone_number).
    
    Returns:
    
    the user's preferred phone number
  - getPhoneNumberVerified
```
default java.lang.Boolean getPhoneNumberVerified()
```
    Returns true if the user's phone number has been verified (phone_number_verified), otherwise false.
    
    Returns:
    
    true if the user's phone number has been verified, otherwise false
  - getAddress
```
default AddressStandardClaim getAddress()
```
    Returns the user's preferred postal address (address).
    
    Returns:
    
    the user's preferred postal address
  - getUpdatedAt
```
default java.time.Instant getUpdatedAt()
```
    Returns the time the user's information was last updated (updated_at).
    
    Returns:
    
    the time the user's information was last updated

Interface StandardClaimAccessor

Method Summary

Methods inherited from interface org.springframework.security.oauth2.core.ClaimAccessor

Method Detail

getSubject

getFullName

getGivenName

getFamilyName

getMiddleName

getNickName

getPreferredUsername

getProfile

getPicture

getWebsite

getEmail

getEmailVerified

getGender

getBirthdate

getZoneInfo

getLocale

getPhoneNumber

getPhoneNumberVerified

getAddress

getUpdatedAt