Top Description Fields Constructors Methods
org.eclipse.microprofile.jwt

public final Enum Claims

extends Enum<Claims>
Class Inheritance
Imports
java.util.Set, jakarta.json.JsonObject

This enum represents the standardized claims that the MP-JWT specification allows for in terms of interoperability. For every claim in this enum, an MP-JWT implementation must return a value of the indicated type from JsonWebToken#getClaim(String) method. An implementation is free to include any additional claims, and users of JsonWebToken#getClaim(String) can expect that the JSON-P corresponding Java type is seen based on the JSON type of the claim. The set of included claims is defined by IANA, see https://www.iana.org/assignments/jwt/jwt.xhtml

Field Summary

Modifier and TypeField and Description
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
private String
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
public static final Claims
private Class<?>
public static final Claims
public static final Claims
public static final Claims
public static final Claims

Constructor Summary

AccessConstructor and Description
private
Claims(final String description, final Class<?> type)

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

A description for the claim
getDescription
()

public Class<?>

Returns:

type of the claim
getType
()

The required type of the claim

public static Claims
public static Claims[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

acrback to summary
public static final Claims acr
addressback to summary
public static final Claims address
amrback to summary
public static final Claims amr
at_hashback to summary
public static final Claims at_hash
audback to summary
public static final Claims aud
auth_timeback to summary
public static final Claims auth_time
azpback to summary
public static final Claims azp
birthdateback to summary
public static final Claims birthdate
c_hashback to summary
public static final Claims c_hash
cnfback to summary
public static final Claims cnf
descriptionback to summary
private String description
destback to summary
public static final Claims dest
emailback to summary
public static final Claims email
email_verifiedback to summary
public static final Claims email_verified
expback to summary
public static final Claims exp
family_nameback to summary
public static final Claims family_name
full_nameback to summary
public static final Claims full_name
genderback to summary
public static final Claims gender
given_nameback to summary
public static final Claims given_name
groupsback to summary
public static final Claims groups
iatback to summary
public static final Claims iat
issback to summary
public static final Claims iss
jkuback to summary
public static final Claims jku
jtiback to summary
public static final Claims jti
jweback to summary
public static final Claims jwe
jwkback to summary
public static final Claims jwk
kidback to summary
public static final Claims kid
localeback to summary
public static final Claims locale
middle_nameback to summary
public static final Claims middle_name
mkyback to summary
public static final Claims mky
nbfback to summary
public static final Claims nbf
nicknameback to summary
public static final Claims nickname
nonceback to summary
public static final Claims nonce
origback to summary
public static final Claims orig
phone_numberback to summary
public static final Claims phone_number
phone_number_verifiedback to summary
public static final Claims phone_number_verified
preferred_usernameback to summary
public static final Claims preferred_username
raw_tokenback to summary
public static final Claims raw_token
sip_callidback to summary
public static final Claims sip_callid
sip_cseq_numback to summary
public static final Claims sip_cseq_num
sip_dateback to summary
public static final Claims sip_date
sip_from_tagback to summary
public static final Claims sip_from_tag
sip_via_branchback to summary
public static final Claims sip_via_branch
subback to summary
public static final Claims sub
sub_jwkback to summary
public static final Claims sub_jwk
typeback to summary
private Class<?> type
UNKNOWNback to summary
public static final Claims UNKNOWN
updated_atback to summary
public static final Claims updated_at
upnback to summary
public static final Claims upn
zoneinfoback to summary
public static final Claims zoneinfo

Constructor Detail

Claimsback to summary
private Claims(final String description, final Class<?> type)

Method Detail

getDescriptionback to summary
public String getDescription()
Returns:String

A description for the claim

getTypeback to summary
public Class<?> getType()

The required type of the claim

Returns:Class<?>

type of the claim

valueOfback to summary
public static Claims valueOf(String name)
valuesback to summary
public static Claims[] values()