Class StandardClaimNames

java.lang.Object

org.springframework.security.oauth2.core.oidc.StandardClaimNames

public final class StandardClaimNames
extends Object

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 final String	ADDRESS	address - the user's preferred postal address.
static final String	BIRTHDATE	birthdate - the user's birth date.
static final String	EMAIL	email - the user's preferred e-mail address.
static final String	EMAIL_VERIFIED	email_verified - true if the user's e-mail address has been verified, otherwise false.
static final String	FAMILY_NAME	family_name - the user's surname(s) or last name(s).
static final String	GENDER	gender - the user's gender.
static final String	GIVEN_NAME	given_name - the user's given name(s) or first name(s).
static final String	LOCALE	locale - the user's locale.
static final String	MIDDLE_NAME	middle_name - the user's middle name(s).
static final String	NAME	name - the user's full name.
static final String	NICKNAME	nickname - the user's nick name that may or may not be the same as the given_name.
static final String	PHONE_NUMBER	phone_number - the user's preferred phone number.
static final String	PHONE_NUMBER_VERIFIED	phone_number_verified - true if the user's phone number has been verified, otherwise false.
static final String	PICTURE	picture - the URL of the user's profile picture.
static final String	PREFERRED_USERNAME	preferred_username - the preferred username that the user wishes to be referred to.
static final String	PROFILE	profile - the URL of the user's profile page.
static final String	SUB	sub - the Subject identifier.
static final String	UPDATED_AT	updated_at - the time the user's information was last updated.
static final String	WEBSITE	website - the URL of the user's web page or blog.
static final String	ZONEINFO	zoneinfo - the user's time zone.

Method Summary

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SUB

public static final String SUB

sub - the Subject identifier.

See Also:

• Constant Field Values

NAME

public static final String NAME

name - the user's full name.

See Also:

• Constant Field Values

GIVEN_NAME

public static final String GIVEN_NAME

given_name - the user's given name(s) or first name(s).

See Also:

• Constant Field Values

FAMILY_NAME

public static final String FAMILY_NAME

family_name - the user's surname(s) or last name(s).

See Also:

• Constant Field Values

MIDDLE_NAME

public static final String MIDDLE_NAME

middle_name - the user's middle name(s).

See Also:

• Constant Field Values

NICKNAME

public static final String NICKNAME

nickname - the user's nick name that may or may not be the same as the given_name.

See Also:

• Constant Field Values

PREFERRED_USERNAME

public static final String PREFERRED_USERNAME

preferred_username - the preferred username that the user wishes to be referred to.

See Also:

• Constant Field Values

PROFILE

public static final String PROFILE

profile - the URL of the user's profile page.

See Also:

• Constant Field Values

PICTURE

public static final String PICTURE

picture - the URL of the user's profile picture.

See Also:

• Constant Field Values

WEBSITE

public static final String WEBSITE

website - the URL of the user's web page or blog.

See Also:

• Constant Field Values

EMAIL

public static final String EMAIL

email - the user's preferred e-mail address.

See Also:

• Constant Field Values

EMAIL_VERIFIED

public static final String EMAIL_VERIFIED

email_verified - true if the user's e-mail address has been verified, otherwise false.

See Also:

• Constant Field Values

GENDER

public static final String GENDER

gender - the user's gender.

See Also:

• Constant Field Values

BIRTHDATE

public static final String BIRTHDATE

birthdate - the user's birth date.

See Also:

• Constant Field Values

ZONEINFO

public static final String ZONEINFO

zoneinfo - the user's time zone.

See Also:

• Constant Field Values

LOCALE

public static final String LOCALE

locale - the user's locale.

See Also:

• Constant Field Values

PHONE_NUMBER

public static final String PHONE_NUMBER

phone_number - the user's preferred phone number.

See Also:

• Constant Field Values

PHONE_NUMBER_VERIFIED

public static final String PHONE_NUMBER_VERIFIED

phone_number_verified - true if the user's phone number has been verified, otherwise false.

See Also:

• Constant Field Values

ADDRESS

public static final String ADDRESS

address - the user's preferred postal address.

See Also:

• Constant Field Values

UPDATED_AT

public static final String UPDATED_AT

updated_at - the time the user's information was last updated.

See Also:

• Constant Field Values