Package io.jans.as.model.jwt
Class JwtClaimName
java.lang.Object
io.jans.as.model.jwt.JwtClaimName
- Version:
- September 30, 2021
- Author:
- Javier Rojas Blum
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final StringThe End-User's preferred address.static final StringThe country name component.static final StringThe full mailing address, formatted for display or use with a mailing label.static final StringThe city or locality component.static final StringThe zip code or postal code component.static final StringThe state, province, prefecture or region component.static final StringThe full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information.static final StringAudience(s) that this ID Token is intended for.static final Stringstatic final StringAuthentication Context Class Reference.static final StringAuthentication Methods References.static final StringTime when the End-User authentication occurred.static final StringAuthorized party - the party to which the ID Token was issued.static final StringThe End-User's birthday.static final Stringstatic final Stringstatic final StringThe End-User's preferred e-mail address.static final StringTrue if the End-User's e-mail address has been verified; otherwise false.static final StringExpiration time on or after which the ID Token must not be accepted for processing.static final StringSurname or last name of the End-User.static final StringThe End-User's gender: Values defined by this specification are female and male.static final StringGiven name or first name of the End-User.static final StringTime at which the JWT was issued.static final StringIssuer Identifier for the Issuer of the response.static final Stringstatic final Stringstatic final Stringstatic final StringThe End-User's locale, represented as a BCP47 (RFC5646) language tag.static final StringMiddle name of the End-User.static final StringEnd-User's full name in displayable form including all name parts.static final StringCasual name of the End-User.static final StringString value used to associate a Client session with an ID Token, and to mitigate replay attacks.static final Stringstatic final StringThe End-User's preferred telephone number.static final StringTrue if the End-User's phone number has been verified; otherwise false.static final StringURL of the End-User's profile picture.static final StringShorthand name that the End-User wishes to be referred to at the RP, such as janedoe or j.doe.static final Stringstatic final StringURL of the End-User's profile page.static final Stringstatic final Stringstatic final StringA locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed by the Client.static final Stringstatic final Stringstatic final StringTime the End-User's information was last updated.static final StringThe End-User's preferred userName.static final StringURL of the End-User's web page or blog.static final StringString from zoneinfo time zone database. -
Method Summary
-
Field Details
-
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:
-
NOT_BEFORE
- See Also:
-
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:
-
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:
-
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:
-
PRINCIPAL
- See Also:
-
JWT_ID
- See Also:
-
TYPE
- See Also:
-
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:
-
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:
-
TOKEN_BINDING_HASH
- See Also:
-
CNF
- See Also:
-
JKT
- See Also:
-
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:
-
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:
-
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:
-
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:
-
ACCESS_TOKEN_HASH
- See Also:
-
CODE_HASH
- See Also:
-
STATE_HASH
- See Also:
-
NAME
End-User's full name in displayable form including all name parts.- See Also:
-
GIVEN_NAME
Given name or first name of the End-User.- See Also:
-
FAMILY_NAME
Surname or last name of the End-User.- See Also:
-
MIDDLE_NAME
Middle name of the End-User.- See Also:
-
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:
-
PREFERRED_USERNAME
Shorthand name that the End-User wishes to be referred to at the RP, such as janedoe or j.doe.- See Also:
-
PROFILE
URL of the End-User's profile page.- See Also:
-
PICTURE
URL of the End-User's profile picture.- See Also:
-
WEBSITE
URL of the End-User's web page or blog.- See Also:
-
EMAIL
The End-User's preferred e-mail address.- See Also:
-
USER_NAME
The End-User's preferred userName.- See Also:
-
EMAIL_VERIFIED
True if the End-User's e-mail address has been verified; otherwise false.- See Also:
-
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:
-
BIRTHDATE
The End-User's birthday.- See Also:
-
ZONEINFO
String from zoneinfo time zone database. For example, Europe/Paris or America/Los_Angeles.- See Also:
-
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:
-
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:
-
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:
-
ADDRESS
The End-User's preferred address.- See Also:
-
UPDATED_AT
Time the End-User's information was last updated.- See Also:
-
ADDRESS_FORMATTED
The full mailing address, formatted for display or use with a mailing label.- See Also:
-
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:
-
ADDRESS_LOCALITY
The city or locality component.- See Also:
-
ADDRESS_REGION
The state, province, prefecture or region component.- See Also:
-
ADDRESS_POSTAL_CODE
The zip code or postal code component.- See Also:
-
ADDRESS_COUNTRY
The country name component.- See Also:
-
JANS_OPENID_CONNECT_VERSION
- See Also:
-
REFRESH_TOKEN_HASH
- See Also:
-
AUTH_REQ_ID
- See Also:
-