Package io.jans.as.model.jwt

Class JwtClaimName

  • public final class JwtClaimName
extends java.lang.Object
    Version:
    September 30, 2021
    Author:
    Javier Rojas Blum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ACCESS_TOKEN_HASH  
      static java.lang.String ADDRESS
      The End-User's preferred address.
      static java.lang.String ADDRESS_COUNTRY
      The country name component.
      static java.lang.String ADDRESS_FORMATTED
      The full mailing address, formatted for display or use with a mailing label.
      static java.lang.String ADDRESS_LOCALITY
      The city or locality component.
      static java.lang.String ADDRESS_POSTAL_CODE
      The zip code or postal code component.
      static java.lang.String ADDRESS_REGION
      The state, province, prefecture or region component.
      static java.lang.String ADDRESS_STREET_ADDRESS
      The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information.
      static java.lang.String AUDIENCE
      Audience(s) that this ID Token is intended for.
      static java.lang.String AUTH_REQ_ID  
      static java.lang.String AUTHENTICATION_CONTEXT_CLASS_REFERENCE
      Authentication Context Class Reference.
      static java.lang.String AUTHENTICATION_METHOD_REFERENCES
      Authentication Methods References.
      static java.lang.String AUTHENTICATION_TIME
      Time when the End-User authentication occurred.
      static java.lang.String AUTHORIZED_PARTY
      Authorized party - the party to which the ID Token was issued.
      static java.lang.String BIRTHDATE
      The End-User's birthday.
      static java.lang.String CNF  
      static java.lang.String CODE_HASH  
      static java.lang.String EMAIL
      The End-User's preferred e-mail address.
      static java.lang.String EMAIL_VERIFIED
      True if the End-User's e-mail address has been verified; otherwise false.
      static java.lang.String EXPIRATION_TIME
      Expiration time on or after which the ID Token must not be accepted for processing.
      static java.lang.String FAMILY_NAME
      Surname or last name of the End-User.
      static java.lang.String GENDER
      The End-User's gender: Values defined by this specification are female and male.
      static java.lang.String GIVEN_NAME
      Given name or first name of the End-User.
      static java.lang.String ISSUED_AT
      Time at which the JWT was issued.
      static java.lang.String ISSUER
      Issuer Identifier for the Issuer of the response.
      static java.lang.String JANS_OPENID_CONNECT_VERSION  
      static java.lang.String JKT  
      static java.lang.String JWT_ID  
      static java.lang.String LOCALE
      The End-User's locale, represented as a BCP47 (RFC5646) language tag.
      static java.lang.String MIDDLE_NAME
      Middle name of the End-User.
      static java.lang.String NAME
      End-User's full name in displayable form including all name parts.
      static java.lang.String NICKNAME
      Casual name of the End-User.
      static java.lang.String NONCE
      String value used to associate a Client session with an ID Token, and to mitigate replay attacks.
      static java.lang.String NOT_BEFORE  
      static java.lang.String PHONE_NUMBER
      The End-User's preferred telephone number.
      static java.lang.String PHONE_NUMBER_VERIFIED
      True if the End-User's phone number has been verified; otherwise false.
      static java.lang.String PICTURE
      URL of the End-User's profile picture.
      static java.lang.String PREFERRED_USERNAME
      Shorthand name that the End-User wishes to be referred to at the RP, such as janedoe or j.doe.
      static java.lang.String PRINCIPAL  
      static java.lang.String PROFILE
      URL of the End-User's profile page.
      static java.lang.String REFRESH_TOKEN_HASH  
      static java.lang.String STATE_HASH  
      static java.lang.String SUBJECT_IDENTIFIER
      A locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed by the Client.
      static java.lang.String TOKEN_BINDING_HASH  
      static java.lang.String TYPE  
      static java.lang.String UPDATED_AT
      Time the End-User's information was last updated.
      static java.lang.String USER_NAME
      The End-User's preferred userName.
      static java.lang.String WEBSITE
      URL of the End-User's web page or blog.
      static java.lang.String ZONEINFO
      String from zoneinfo time zone database.

    • Method Summary

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • EXPIRATION_TIME

        public static final java.lang.String EXPIRATION_TIME
        Expiration time on or after which the ID Token must not be accepted for processing. The processing of this parameter requires that the current date/time must be before the expiration date/time listed in the value.
        See Also:
        Constant Field Values

      • ISSUED_AT

        public static final java.lang.String ISSUED_AT
        Time at which the JWT was issued. 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.
        See Also:
        Constant Field Values

      • ISSUER

        public static final java.lang.String ISSUER
        Issuer Identifier for the Issuer of the response. The iss value is a case sensitive URL using the https scheme that contains scheme, host, and optionally, port number and path components and no query or fragment components.
        See Also:
        Constant Field Values

      • AUDIENCE

        public static final java.lang.String AUDIENCE
        Audience(s) that this ID Token is intended for. It must contain the OAuth 2.0 client_id of the Relying Party as an audience value. It may also contain identifiers for other audiences. In the general case, the aud value is an array of case sensitive strings. In the common special case when there is one audience, the aud value may be a single case sensitive string.
        See Also:
        Constant Field Values

      • AUTHENTICATION_METHOD_REFERENCES

        public static final java.lang.String AUTHENTICATION_METHOD_REFERENCES
        Authentication Methods References.

        JSON array of strings that are identifiers for authentication methods used in the authentication. For instance, values might indicate that both password and OTP authentication methods were used. The definition of particular values to be used in the amr Claim is beyond the scope of this specification. Parties using this claim will need to agree upon the meanings of the values used, which may be context-specific. The amr value is an array of case sensitive strings.

        See Also:
        Constant Field Values

      • SUBJECT_IDENTIFIER

        public static final java.lang.String SUBJECT_IDENTIFIER
        A locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed by the Client.
        See Also:
        Constant Field Values

      • TOKEN_BINDING_HASH

        public static final java.lang.String TOKEN_BINDING_HASH
        See Also:
        Constant Field Values

      • AUTHORIZED_PARTY

        public static final java.lang.String AUTHORIZED_PARTY
        Authorized party - the party to which the ID Token was issued. If present, it must contain the OAuth 2.0 Client ID of this party. This Claim is only needed when the ID Token has a single audience value and that audience is different than the authorized party. It may be included even when the authorized party is the same as the sole audience.
        See Also:
        Constant Field Values

      • AUTHENTICATION_CONTEXT_CLASS_REFERENCE

        public static final java.lang.String AUTHENTICATION_CONTEXT_CLASS_REFERENCE
        Authentication Context Class Reference. String specifying an Authentication Context Class Reference value that identifies the Authentication Context Class that the authentication performed satisfied.
        See Also:
        Constant Field Values

      • NONCE

        public static final java.lang.String NONCE
        String value used to associate a Client session with an ID Token, and to mitigate replay attacks. The value is passed through unmodified from the Authentication Request to the ID Token. If present in the ID Token, Clients must verify that the nonce Claim Value is equal to the value of the nonce parameter sent in the Authentication Request. If present in the Authentication Request, Authorization Servers must include a nonce Claim in the ID Token with the Claim Value being the nonce value sent in the Authentication Request. Authorization Servers should perform no other processing on nonce values used. The nonce value is a case sensitive string.
        See Also:
        Constant Field Values

      • AUTHENTICATION_TIME

        public static final java.lang.String AUTHENTICATION_TIME
        Time when the End-User authentication occurred. 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. When a max_age request is made or when auth_time is requested as an Essential Claim, then this Claim is required; otherwise, its inclusion is optional.
        See Also:
        Constant Field Values

      • ACCESS_TOKEN_HASH

        public static final java.lang.String ACCESS_TOKEN_HASH
        See Also:
        Constant Field Values

      • NAME

        public static final java.lang.String NAME
        End-User's full name in displayable form including all name parts.
        See Also:
        Constant Field Values

      • GIVEN_NAME

        public static final java.lang.String GIVEN_NAME
        Given name or first name of the End-User.
        See Also:
        Constant Field Values

      • FAMILY_NAME

        public static final java.lang.String FAMILY_NAME
        Surname or last name of the End-User.
        See Also:
        Constant Field Values

      • MIDDLE_NAME

        public static final java.lang.String MIDDLE_NAME
        Middle name of the End-User.
        See Also:
        Constant Field Values

      • NICKNAME

        public static final java.lang.String NICKNAME
        Casual name of the End-User. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.
        See Also:
        Constant Field Values

      • PREFERRED_USERNAME

        public static final java.lang.String PREFERRED_USERNAME
        Shorthand name that the End-User wishes to be referred to at the RP, such as janedoe or j.doe.
        See Also:
        Constant Field Values

      • PROFILE

        public static final java.lang.String PROFILE
        URL of the End-User's profile page.
        See Also:
        Constant Field Values

      • PICTURE

        public static final java.lang.String PICTURE
        URL of the End-User's profile picture.
        See Also:
        Constant Field Values

      • WEBSITE

        public static final java.lang.String WEBSITE
        URL of the End-User's web page or blog.
        See Also:
        Constant Field Values

      • EMAIL

        public static final java.lang.String EMAIL
        The End-User's preferred e-mail address.
        See Also:
        Constant Field Values

      • USER_NAME

        public static final java.lang.String USER_NAME
        The End-User's preferred userName.
        See Also:
        Constant Field Values

      • EMAIL_VERIFIED

        public static final java.lang.String EMAIL_VERIFIED
        True if the End-User's e-mail address has been verified; otherwise false.
        See Also:
        Constant Field Values

      • GENDER

        public static final java.lang.String GENDER
        The 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:
        Constant Field Values

      • BIRTHDATE

        public static final java.lang.String BIRTHDATE
        The End-User's birthday.
        See Also:
        Constant Field Values

      • ZONEINFO

        public static final java.lang.String ZONEINFO
        String from zoneinfo time zone database. For example, Europe/Paris or America/Los_Angeles.
        See Also:
        Constant Field Values

      • LOCALE

        public static final java.lang.String LOCALE
        The 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.
        See Also:
        Constant Field Values

      • PHONE_NUMBER

        public static final java.lang.String PHONE_NUMBER
        The 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:
        Constant Field Values

      • PHONE_NUMBER_VERIFIED

        public static final java.lang.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.
        See Also:
        Constant Field Values

      • ADDRESS

        public static final java.lang.String ADDRESS
        The End-User's preferred address.
        See Also:
        Constant Field Values

      • UPDATED_AT

        public static final java.lang.String UPDATED_AT
        Time the End-User's information was last updated.
        See Also:
        Constant Field Values

      • ADDRESS_FORMATTED

        public static final java.lang.String ADDRESS_FORMATTED
        The full mailing address, formatted for display or use with a mailing label.
        See Also:
        Constant Field Values

      • ADDRESS_STREET_ADDRESS

        public static final java.lang.String ADDRESS_STREET_ADDRESS
        The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information.
        See Also:
        Constant Field Values

      • ADDRESS_LOCALITY

        public static final java.lang.String ADDRESS_LOCALITY
        The city or locality component.
        See Also:
        Constant Field Values

      • ADDRESS_REGION

        public static final java.lang.String ADDRESS_REGION
        The state, province, prefecture or region component.
        See Also:
        Constant Field Values

      • ADDRESS_POSTAL_CODE

        public static final java.lang.String ADDRESS_POSTAL_CODE
        The zip code or postal code component.
        See Also:
        Constant Field Values

      • ADDRESS_COUNTRY

        public static final java.lang.String ADDRESS_COUNTRY
        The country name component.
        See Also:
        Constant Field Values

      • JANS_OPENID_CONNECT_VERSION

        public static final java.lang.String JANS_OPENID_CONNECT_VERSION
        See Also:
        Constant Field Values

      • REFRESH_TOKEN_HASH

        public static final java.lang.String REFRESH_TOKEN_HASH
        See Also:
        Constant Field Values