Class ProfileClaims

java.lang.Object
io.micronaut.security.token.ProfileClaims
public final class ProfileClaims extends Object
Constants for the OpenID Connect Standard Claims. These are the member names of the standard set of claims about the authenticated end-user that may be returned in the ID Token and/or by the UserInfo Endpoint.
Since:
5.3.0
Author:
Sergio del Amo

  • Field Details

    • CLAIM_SUB

      public static final String CLAIM_SUB
      Subject - Identifier for the end-user at the issuer.
      See Also:

    • CLAIM_NAME

      public static final String CLAIM_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.
      See Also:

    • CLAIM_GIVEN_NAME

      public static final String CLAIM_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.
      See Also:

    • CLAIM_FAMILY_NAME

      public static final String CLAIM_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.
      See Also:

    • CLAIM_MIDDLE_NAME

      public static final String CLAIM_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.
      See Also:

    • CLAIM_NICKNAME

      public static final String CLAIM_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.
      See Also:

    • CLAIM_PREFERRED_USERNAME

      public static final String CLAIM_PREFERRED_USERNAME
      Shorthand name by which the end-user wishes to be referred to at the relying party, such as janedoe or j.doe. This value may be any valid JSON string including special characters such as @, /, or whitespace.
      See Also:

    • CLAIM_PROFILE

      public static final String CLAIM_PROFILE
      URL of the end-user's profile page. The contents of this web page should be about the end-user.
      See Also:

    • CLAIM_PICTURE

      public static final String CLAIM_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.
      See Also:

    • CLAIM_WEBSITE

      public static final String CLAIM_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.
      See Also:

    • CLAIM_EMAIL

      public static final String CLAIM_EMAIL
      End-user's preferred e-mail address. Its value must conform to the RFC 5322 addr-spec syntax.
      See Also:

    • CLAIM_EMAIL_VERIFIED

      public static final String CLAIM_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 OpenID Provider took affirmative steps to ensure that this e-mail address was controlled by the end-user at the time the verification was performed.
      See Also:

    • CLAIM_GENDER

      public static final String CLAIM_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.
      See Also:

    • CLAIM_BIRTHDATE

      public static final String CLAIM_BIRTHDATE
      End-user's birthday, represented as an ISO 8601-1 YYYY-MM-DD format. The year may be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed.
      See Also:

    • CLAIM_ZONEINFO

      public static final String CLAIM_ZONEINFO
      String from IANA Time Zone Database representing the end-user's time zone. For example, Europe/Paris or America/Los_Angeles.
      See Also:

    • CLAIM_LOCALE

      public static final String CLAIM_LOCALE
      End-user's locale, represented as a BCP47 language tag. This is typically an ISO 639 Alpha-2 language code in lowercase and an ISO 3166-1 Alpha-2 country code in uppercase, separated by a dash. For example, en-US or fr-CA.
      See Also:

    • CLAIM_PHONE_NUMBER

      public static final String CLAIM_PHONE_NUMBER
      End-user's preferred telephone number. E.164 is recommended as the format of this claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400.
      See Also:

    • CLAIM_PHONE_NUMBER_VERIFIED

      public static final String CLAIM_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 OpenID Provider took affirmative steps to ensure that this phone number was controlled by the end-user at the time the verification was performed.
      See Also:

    • CLAIM_ADDRESS

      public static final String CLAIM_ADDRESS
      End-user's preferred postal address. The value of the address member is a JSON structure containing some or all of the members defined in the OpenID Connect Address Claim.
      See Also:

    • CLAIM_UPDATED_AT

      public static final String CLAIM_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-01T00:00:00Z as measured in UTC until the date/time.
      See Also:

  • Method Details