StandardClaims (com.authlete:authlete-java-common 3.65 API)

java.lang.Object
- com.authlete.common.types.StandardClaims

```
public final class StandardClaims
extends Object
```
Standard claims.
Author:

Takahiko Kawasaki

See Also:

OpenID Connect Core 1.0, 5.1. Standard Claims

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADDRESS` End-User's preferred postal address.
`static String`	`BIRTHDATE` End-User's birthday, represented as an ISO 8601:2004 [ISO8601-2004] YYYY-MM-DD format.
`static String`	`EMAIL` End-User's preferred e-mail address.
`static String`	`EMAIL_VERIFIED` True if the End-User's e-mail address has been verified; otherwise false.
`static String`	`FAMILY_NAME` Surname(s) or last name(s) of the End-User.
`static String`	`GENDER` End-User's gender.
`static String`	`GIVEN_NAME` Given name(s) or first name(s) of the End-User.
`static String`	`LOCALE` End-User's locale, represented as a BCP47 [RFC5646] language tag.
`static String`	`MIDDLE_NAME` Middle name(s) of the End-User.
`static String`	`NAME` End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
`static String`	`NICKNAME` Casual name of the End-User that may or may not be the same as the given_name.
`static String`	`PHONE_NUMBER` End-User's preferred telephone number.
`static String`	`PHONE_NUMBER_VERIFIED` True if the End-User's phone number has been verified; otherwise false.
`static String`	`PICTURE` URL of the End-User's profile picture.
`static String`	`PREFERRED_USERNAME` Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe.
`static String`	`PROFILE` URL of the End-User's profile page.
`static String`	`SUB` Subject - Identifier for the End-User at the Issuer.
`static String`	`UPDATED_AT` Time the End-User's information was last updated.
`static String`	`WEBSITE` URL of the End-User's Web page or blog.
`static String`	`ZONEINFO` String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static SortedSet<String>`	`getStandardClaims()` Get the claim list described in "OpenID Connect Core 1.0, 5.1. Standard Claims".
`static boolean`	`isStandardClaim(String claimName)` Check if the given claim name is in the list described in "OpenID Connect Core 1.0, 5.1. Standard Claims".
`static int`	`toBits(Set<String> set)`
`static Set<String>`	`toSet(int bits)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SUB
```
public static final String SUB
```
    Subject - Identifier for the End-User at the Issuer.
    "sub", string.
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
    "name", string.
    
    See Also:
    
    Constant Field Values
  - GIVEN_NAME
```
public static final String GIVEN_NAME
```
    Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.
    "given_name", string.
    
    See Also:
    
    Constant Field Values
  - FAMILY_NAME
```
public static final String FAMILY_NAME
```
    Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.
    "family_name", string.
    
    See Also:
    
    Constant Field Values
  - MIDDLE_NAME
```
public static final String MIDDLE_NAME
```
    Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.
    "middle_name", string.
    
    See Also:
    
    Constant Field Values
  - NICKNAME
```
public static final String NICKNAME
```
    Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.
    "nickname", string.
    
    See Also:
    
    Constant Field Values
  - PREFERRED_USERNAME
```
public static final String PREFERRED_USERNAME
```
    Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
    "preferred_username", string.
    
    See Also:
    
    Constant Field Values
  - PROFILE
```
public static final String PROFILE
```
    URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.
    "profile", string.
    
    See Also:
    
    Constant Field Values
  - PICTURE
```
public static final String PICTURE
```
    URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User.
    "picture", string.
    
    See Also:
    
    Constant Field Values
  - WEBSITE
```
public static final String WEBSITE
```
    URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with.
    "website", string.
    
    See Also:
    
    Constant Field Values
  - EMAIL
```
public static final String EMAIL
```
    End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7 Claim Stability and Uniqueness.
    "email", string.
    
    See Also:
    
    Constant Field Values
  - EMAIL_VERIFIED
```
public static final String EMAIL_VERIFIED
```
    True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.
    "email_verified", boolean.
    
    See Also:
    
    Constant Field Values
  - GENDER
```
public static final String GENDER
```
    End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable.
    "gender", string.
    
    See Also:
    
    Constant Field Values
  - BIRTHDATE
```
public static final String BIRTHDATE
```
    End-User's birthday, represented as an ISO 8601:2004 [ISO8601-2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates.
    "birthdate", string.
    
    See Also:
    
    Constant Field Values
  - ZONEINFO
```
public static final String ZONEINFO
```
    String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.
    "zoneinfo", string.
    
    See Also:
    
    Constant Field Values
  - LOCALE
```
public static final String LOCALE
```
    End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639-1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166-1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well.
    "locale", string.
    
    See Also:
    
    Constant Field Values
  - PHONE_NUMBER
```
public static final String PHONE_NUMBER
```
    End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.
    "phone_number", string.
    
    See Also:
    
    Constant Field Values
  - PHONE_NUMBER_VERIFIED
```
public static final String PHONE_NUMBER_VERIFIED
```
    True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format.
    "phone_number_verified", boolean.
    
    See Also:
    
    Constant Field Values
  - ADDRESS
```
public static final String ADDRESS
```
    End-User's preferred postal address. The value of the address member is a JSON [RFC4627] structure containing some or all of the members defined in Section 5.1.1.
    "address", JSON object.
    
    See Also:
    
    Constant Field Values
  - UPDATED_AT
```
public static final String UPDATED_AT
```
    Time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
    "updated_at", number.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isStandardClaim
```
public static boolean isStandardClaim(String claimName)
```
    Check if the given claim name is in the list described in "OpenID Connect Core 1.0, 5.1. Standard Claims".
  - getStandardClaims
```
public static SortedSet<String> getStandardClaims()
```
    Get the claim list described in "OpenID Connect Core 1.0, 5.1. Standard Claims".
  - toBits
```
public static int toBits(Set<String> set)
```
  - toSet
```
public static Set<String> toSet(int bits)
```

Class StandardClaims

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SUB

NAME

GIVEN_NAME

FAMILY_NAME

MIDDLE_NAME

NICKNAME

PREFERRED_USERNAME

PROFILE

PICTURE

WEBSITE

EMAIL

EMAIL_VERIFIED

GENDER

BIRTHDATE

ZONEINFO

LOCALE

PHONE_NUMBER

PHONE_NUMBER_VERIFIED

ADDRESS

UPDATED_AT

Method Detail

isStandardClaim

getStandardClaims

toBits

toSet