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 Summary

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

    Methods inherited from interface ClaimAccessor

    getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL, getClaims, hasClaim

  • Method Details

    • getSubject

      default @Nullable String getSubject()
      Returns the Subject identifier (sub), or null if it does not exist.
      Returns:
      the Subject identifier, or null if it does not exist

    • getFullName

      default @Nullable String getFullName()
      Returns the user's full name (name) in displayable form, or null if it does not exist.
      Returns:
      the user's full name, or null if it does not exist

    • getGivenName

      default @Nullable String getGivenName()
      Returns the user's given name(s) or first name(s) (given_name), or null if it does not exist.
      Returns:
      the user's given name(s), or null if it does not exist

    • getFamilyName

      default @Nullable String getFamilyName()
      Returns the user's surname(s) or last name(s) (family_name), or null if it does not exist.
      Returns:
      the user's family names(s), or null if it does not exist

    • getMiddleName

      default @Nullable String getMiddleName()
      Returns the user's middle name(s) (middle_name), or null if it does not exist.
      Returns:
      the user's middle name(s), or null if it does not exist

    • getNickName

      default @Nullable String getNickName()
      Returns the user's nick name (nickname) that may or may not be the same as the (given_name), or null if it does not exist.
      Returns:
      the user's nick name, or null if it does not exist

    • getPreferredUsername

      default @Nullable String getPreferredUsername()
      Returns the preferred username (preferred_username) that the user wishes to be referred to, or null if it does not exist.
      Returns:
      the user's preferred user name, or null if it does not exist

    • getProfile

      default @Nullable String getProfile()
      Returns the URL of the user's profile page (profile), or null if it does not exist.
      Returns:
      the URL of the user's profile page, or null if it does not exist

    • getPicture

      default @Nullable String getPicture()
      Returns the URL of the user's profile picture (picture), or null if it does not exist.
      Returns:
      the URL of the user's profile picture, or null if it does not exist

    • getWebsite

      default @Nullable String getWebsite()
      Returns the URL of the user's web page or blog (website), or null if it does not exist.
      Returns:
      the URL of the user's web page or blog, or null if it does not exist

    • getEmail

      default @Nullable String getEmail()
      Returns the user's preferred e-mail address (email), or null if it does not exist.
      Returns:
      the user's preferred e-mail address, or null if it does not exist

    • getEmailVerified

      default @Nullable Boolean getEmailVerified()
      Returns true if the user's e-mail address has been verified (email_verified), otherwise false, or null if it does not exist.
      Returns:
      true if the user's e-mail address has been verified, otherwise false, or null if it does not exist

    • getGender

      default @Nullable String getGender()
      Returns the user's gender (gender), or null if it does not exist.
      Returns:
      the user's gender, or null if it does not exist

    • getBirthdate

      default @Nullable String getBirthdate()
      Returns the user's birth date (birthdate), or null if it does not exist.
      Returns:
      the user's birth date, or null if it does not exist

    • getZoneInfo

      default @Nullable String getZoneInfo()
      Returns the user's time zone (zoneinfo), or null if it does not exist.
      Returns:
      the user's time zone, or null if it does not exist

    • getLocale

      default @Nullable String getLocale()
      Returns the user's locale (locale), or null if it does not exist.
      Returns:
      the user's locale, or null if it does not exist

    • getPhoneNumber

      default @Nullable String getPhoneNumber()
      Returns the user's preferred phone number (phone_number), or null if it does not exist.
      Returns:
      the user's preferred phone number, or null if it does not exist

    • getPhoneNumberVerified

      default @Nullable Boolean getPhoneNumberVerified()
      Returns true if the user's phone number has been verified (phone_number_verified), otherwise false, or null if it does not exist.
      Returns:
      true if the user's phone number has been verified, otherwise false, or null if it does not exist

    • getAddress

      default AddressStandardClaim getAddress()
      Returns the user's preferred postal address (address).
      Returns:
      the user's preferred postal address

    • getUpdatedAt

      default @Nullable Instant getUpdatedAt()
      Returns the time the user's information was last updated (updated_at), or null if it does not exist.
      Returns:
      the time the user's information was last updated, or null if it does not exist