Package org.springframework.security.oauth2.core.oidc

Interface StandardClaimAccessor

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:

  • Method Details

    • getSubject

      default String getSubject()
      Returns the Subject identifier (sub).
      Returns:
      the Subject identifier

    • getFullName

      default String getFullName()
      Returns the user's full name (name) in displayable form.
      Returns:
      the user's full name

    • getGivenName

      default String getGivenName()
      Returns the user's given name(s) or first name(s) (given_name).
      Returns:
      the user's given name(s)

    • getFamilyName

      default String getFamilyName()
      Returns the user's surname(s) or last name(s) (family_name).
      Returns:
      the user's family names(s)

    • getMiddleName

      default String getMiddleName()
      Returns the user's middle name(s) (middle_name).
      Returns:
      the user's middle name(s)

    • getNickName

      default 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 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 String getProfile()
      Returns the URL of the user's profile page (profile).
      Returns:
      the URL of the user's profile page

    • getPicture

      default String getPicture()
      Returns the URL of the user's profile picture (picture).
      Returns:
      the URL of the user's profile picture

    • getWebsite

      default 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 String getEmail()
      Returns the user's preferred e-mail address (email).
      Returns:
      the user's preferred e-mail address

    • getEmailVerified

      default 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 String getGender()
      Returns the user's gender (gender).
      Returns:
      the user's gender

    • getBirthdate

      default String getBirthdate()
      Returns the user's birth date (birthdate).
      Returns:
      the user's birth date

    • getZoneInfo

      default String getZoneInfo()
      Returns the user's time zone (zoneinfo).
      Returns:
      the user's time zone

    • getLocale

      default String getLocale()
      Returns the user's locale (locale).
      Returns:
      the user's locale

    • getPhoneNumber

      default String getPhoneNumber()
      Returns the user's preferred phone number (phone_number).
      Returns:
      the user's preferred phone number

    • getPhoneNumberVerified

      default 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 Instant getUpdatedAt()
      Returns the time the user's information was last updated (updated_at).
      Returns:
      the time the user's information was last updated