Interface StandardClaimNames
-
public interface StandardClaimNames
The names of the "Standard Claims" defined by the OpenID Connect Core 1.0 specification that can be returned either in the UserInfo Response or the ID Token.- Since:
- 5.0
- See Also:
- Standard Claims, UserInfo Response, ID Token
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ADDRESS
address
- the user's preferred postal addressstatic java.lang.String
BIRTHDATE
birthdate
- the user's birth datestatic java.lang.String
EMAIL
email
- the user's preferred e-mail addressstatic java.lang.String
EMAIL_VERIFIED
email_verified
-true
if the user's e-mail address has been verified, otherwisefalse
static java.lang.String
FAMILY_NAME
family_name
- the user's surname(s) or last name(s)static java.lang.String
GENDER
gender
- the user's genderstatic java.lang.String
GIVEN_NAME
given_name
- the user's given name(s) or first name(s)static java.lang.String
LOCALE
locale
- the user's localestatic java.lang.String
MIDDLE_NAME
middle_name
- the user's middle name(s)static java.lang.String
NAME
name
- the user's full namestatic java.lang.String
NICKNAME
nickname
- the user's nick name that may or may not be the same as thegiven_name
static java.lang.String
PHONE_NUMBER
phone_number
- the user's preferred phone numberstatic java.lang.String
PHONE_NUMBER_VERIFIED
phone_number_verified
-true
if the user's phone number has been verified, otherwisefalse
static java.lang.String
PICTURE
picture
- the URL of the user's profile picturestatic java.lang.String
PREFERRED_USERNAME
preferred_username
- the preferred username that the user wishes to be referred tostatic java.lang.String
PROFILE
profile
- the URL of the user's profile pagestatic java.lang.String
SUB
sub
- the Subject identifierstatic java.lang.String
UPDATED_AT
updated_at
- the time the user's information was last updatedstatic java.lang.String
WEBSITE
website
- the URL of the user's web page or blogstatic java.lang.String
ZONEINFO
zoneinfo
- the user's time zone
-
-
-
Field Detail
-
SUB
static final java.lang.String SUB
sub
- the Subject identifier- See Also:
- Constant Field Values
-
NAME
static final java.lang.String NAME
name
- the user's full name- See Also:
- Constant Field Values
-
GIVEN_NAME
static final java.lang.String GIVEN_NAME
given_name
- the user's given name(s) or first name(s)- See Also:
- Constant Field Values
-
FAMILY_NAME
static final java.lang.String FAMILY_NAME
family_name
- the user's surname(s) or last name(s)- See Also:
- Constant Field Values
-
MIDDLE_NAME
static final java.lang.String MIDDLE_NAME
middle_name
- the user's middle name(s)- See Also:
- Constant Field Values
-
NICKNAME
static final java.lang.String NICKNAME
nickname
- the user's nick name that may or may not be the same as thegiven_name
- See Also:
- Constant Field Values
-
PREFERRED_USERNAME
static final java.lang.String PREFERRED_USERNAME
preferred_username
- the preferred username that the user wishes to be referred to- See Also:
- Constant Field Values
-
PROFILE
static final java.lang.String PROFILE
profile
- the URL of the user's profile page- See Also:
- Constant Field Values
-
PICTURE
static final java.lang.String PICTURE
picture
- the URL of the user's profile picture- See Also:
- Constant Field Values
-
WEBSITE
static final java.lang.String WEBSITE
website
- the URL of the user's web page or blog- See Also:
- Constant Field Values
-
EMAIL
static final java.lang.String EMAIL
email
- the user's preferred e-mail address- See Also:
- Constant Field Values
-
EMAIL_VERIFIED
static final java.lang.String EMAIL_VERIFIED
email_verified
-true
if the user's e-mail address has been verified, otherwisefalse
- See Also:
- Constant Field Values
-
GENDER
static final java.lang.String GENDER
gender
- the user's gender- See Also:
- Constant Field Values
-
BIRTHDATE
static final java.lang.String BIRTHDATE
birthdate
- the user's birth date- See Also:
- Constant Field Values
-
ZONEINFO
static final java.lang.String ZONEINFO
zoneinfo
- the user's time zone- See Also:
- Constant Field Values
-
LOCALE
static final java.lang.String LOCALE
locale
- the user's locale- See Also:
- Constant Field Values
-
PHONE_NUMBER
static final java.lang.String PHONE_NUMBER
phone_number
- the user's preferred phone number- See Also:
- Constant Field Values
-
PHONE_NUMBER_VERIFIED
static final java.lang.String PHONE_NUMBER_VERIFIED
phone_number_verified
-true
if the user's phone number has been verified, otherwisefalse
- See Also:
- Constant Field Values
-
ADDRESS
static final java.lang.String ADDRESS
address
- the user's preferred postal address- See Also:
- Constant Field Values
-
UPDATED_AT
static final java.lang.String UPDATED_AT
updated_at
- the time the user's information was last updated- See Also:
- Constant Field Values
-
-