public interface StandardClaimAccessor extends ClaimAccessor
ClaimAccessor
for the "Standard Claims" that can be returned either
in the UserInfo Response or the ID Token.ClaimAccessor
,
StandardClaimNames
,
OidcUserInfo
,
UserInfo
Response,
Standard
ClaimsModifier 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) . |
containsClaim, getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL, getClaims
default java.lang.String getSubject()
(sub)
.default java.lang.String getFullName()
(name)
in displayable form.default java.lang.String getGivenName()
(given_name)
.default java.lang.String getFamilyName()
(family_name)
.default java.lang.String getMiddleName()
(middle_name)
.default java.lang.String getNickName()
(nickname)
that may or may not be the same as
the (given_name)
.default java.lang.String getPreferredUsername()
(preferred_username)
that the user wishes to
be referred to.default java.lang.String getProfile()
(profile)
.default java.lang.String getPicture()
(picture)
.default java.lang.String getWebsite()
(website)
.default java.lang.String getEmail()
(email)
.default java.lang.Boolean getEmailVerified()
true
if the user's e-mail address has been verified
(email_verified)
, otherwise false
.true
if the user's e-mail address has been verified, otherwise
false
default java.lang.String getGender()
(gender)
.default java.lang.String getBirthdate()
(birthdate)
.default java.lang.String getZoneInfo()
(zoneinfo)
.default java.lang.String getLocale()
(locale)
.default java.lang.String getPhoneNumber()
(phone_number)
.default java.lang.Boolean getPhoneNumberVerified()
true
if the user's phone number has been verified
(phone_number_verified)
, otherwise false
.true
if the user's phone number has been verified, otherwise
false
default AddressStandardClaim getAddress()
(address)
.default java.time.Instant getUpdatedAt()
(updated_at)
.