Package org.wildfly.security.http.oidc
Class IDToken
- java.lang.Object
-
- org.wildfly.security.http.oidc.JsonWebToken
-
- org.wildfly.security.http.oidc.IDToken
-
public class IDToken extends JsonWebToken
Representation of an OIDC ID token, as per OpenID Connect Core 1.0.- Author:
- Farah Juma
-
-
Field Summary
Fields Modifier and Type Field Description static String
ACR
static String
ADDRESS
static String
AT_HASH
static String
BIRTHDATE
static String
C_HASH
static String
CLAIMS_LOCALES
static String
EMAIL
static String
EMAIL_VERIFIED
static String
FAMILY_NAME
static String
GENDER
static String
GIVEN_NAME
static String
LOCALE
static String
MIDDLE_NAME
static String
NAME
static String
NICKNAME
static String
PHONE_NUMBER
static String
PHONE_NUMBER_VERIFIED
static String
PICTURE
static String
PREFERRED_USERNAME
static String
PROFILE
static String
S_HASH
static String
SUB
static String
UPDATED_AT
static String
WEBSITE
static String
ZONEINFO
-
Fields inherited from class org.wildfly.security.http.oidc.JsonWebToken
EXP, IAT, NBF
-
-
Constructor Summary
Constructors Constructor Description IDToken(org.jose4j.jwt.JwtClaims jwtClaims)
Construct a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getAccessTokenHash()
Get the access token hash claim.String
getAcr()
Get the acr claim.AddressClaimSet
getAddress()
Get the address claim.String
getBirthdate()
Get the birth date claim.String
getClaimsLocales()
Get the claims locales.String
getCodeHash()
Get the code hash claim.String
getEmail()
Get the email claim.Boolean
getEmailVerified()
Get the email verified claim.String
getFamilyName()
Get the family name claim.String
getGender()
Get the gender claim.String
getGivenName()
Get the given name claim.String
getLocale()
Get the locale claim.String
getMiddleName()
Get the middle name claim.String
getName()
Get the name claim.String
getNickName()
Get the nick name claim.String
getPhoneNumber()
Get the phone number claim.Boolean
getPhoneNumberVerified()
Get the phone number verified claim.String
getPicture()
Get the picture claim.String
getPreferredUsername()
Get the preferred username claim.String
getPrincipalName(OidcClientConfiguration deployment)
String
getProfile()
Get the profile claim.String
getStateHash()
Get the state hash claim.Long
getUpdatedAt()
Get the updated at claim.String
getWebsite()
Get the website claim.String
getZoneinfo()
Get the zone info claim.-
Methods inherited from class org.wildfly.security.http.oidc.JsonWebToken
getAudience, getClaimNames, getClaimValue, getClaimValue, getClaimValueAsLong, getClaimValueAsString, getExpiration, getID, getIssuedAt, getIssuer, getNotBefore, getStringListClaimValue, getSubject, hasClaim, isActive, isExpired, isNotBefore, replaceMap, wrapValue
-
-
-
-
Field Detail
-
AT_HASH
public static final String AT_HASH
- See Also:
- Constant Field Values
-
C_HASH
public static final String C_HASH
- See Also:
- Constant Field Values
-
NAME
public static final String NAME
- See Also:
- Constant Field Values
-
GIVEN_NAME
public static final String GIVEN_NAME
- See Also:
- Constant Field Values
-
FAMILY_NAME
public static final String FAMILY_NAME
- See Also:
- Constant Field Values
-
MIDDLE_NAME
public static final String MIDDLE_NAME
- See Also:
- Constant Field Values
-
NICKNAME
public static final String NICKNAME
- See Also:
- Constant Field Values
-
PREFERRED_USERNAME
public static final String PREFERRED_USERNAME
- See Also:
- Constant Field Values
-
PROFILE
public static final String PROFILE
- See Also:
- Constant Field Values
-
PICTURE
public static final String PICTURE
- See Also:
- Constant Field Values
-
WEBSITE
public static final String WEBSITE
- See Also:
- Constant Field Values
-
EMAIL
public static final String EMAIL
- See Also:
- Constant Field Values
-
EMAIL_VERIFIED
public static final String EMAIL_VERIFIED
- See Also:
- Constant Field Values
-
GENDER
public static final String GENDER
- See Also:
- Constant Field Values
-
BIRTHDATE
public static final String BIRTHDATE
- See Also:
- Constant Field Values
-
ZONEINFO
public static final String ZONEINFO
- See Also:
- Constant Field Values
-
LOCALE
public static final String LOCALE
- See Also:
- Constant Field Values
-
PHONE_NUMBER
public static final String PHONE_NUMBER
- See Also:
- Constant Field Values
-
PHONE_NUMBER_VERIFIED
public static final String PHONE_NUMBER_VERIFIED
- See Also:
- Constant Field Values
-
ADDRESS
public static final String ADDRESS
- See Also:
- Constant Field Values
-
UPDATED_AT
public static final String UPDATED_AT
- See Also:
- Constant Field Values
-
CLAIMS_LOCALES
public static final String CLAIMS_LOCALES
- See Also:
- Constant Field Values
-
ACR
public static final String ACR
- See Also:
- Constant Field Values
-
S_HASH
public static final String S_HASH
- See Also:
- Constant Field Values
-
SUB
public static final String SUB
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
public String getName()
Get the name claim.- Returns:
- the name claim
-
getGivenName
public String getGivenName()
Get the given name claim.- Returns:
- the given name claim
-
getFamilyName
public String getFamilyName()
Get the family name claim.- Returns:
- the family name claim
-
getMiddleName
public String getMiddleName()
Get the middle name claim.- Returns:
- the middle name claim
-
getNickName
public String getNickName()
Get the nick name claim.- Returns:
- the nick name claim
-
getPreferredUsername
public String getPreferredUsername()
Get the preferred username claim.- Returns:
- the preferred username claim
-
getProfile
public String getProfile()
Get the profile claim.- Returns:
- the profile claim
-
getPicture
public String getPicture()
Get the picture claim.- Returns:
- the picture claim
-
getWebsite
public String getWebsite()
Get the website claim.- Returns:
- the website claim
-
getEmail
public String getEmail()
Get the email claim.- Returns:
- the email claim
-
getEmailVerified
public Boolean getEmailVerified()
Get the email verified claim.- Returns:
- the email verified claim
-
getGender
public String getGender()
Get the gender claim.- Returns:
- the gender claim
-
getBirthdate
public String getBirthdate()
Get the birth date claim.- Returns:
- the birthdate claim
-
getZoneinfo
public String getZoneinfo()
Get the zone info claim.- Returns:
- the zone info claim
-
getLocale
public String getLocale()
Get the locale claim.- Returns:
- the locale claim
-
getPhoneNumber
public String getPhoneNumber()
Get the phone number claim.- Returns:
- the phone number claim
-
getPhoneNumberVerified
public Boolean getPhoneNumberVerified()
Get the phone number verified claim.- Returns:
- the phone number verified claim
-
getAddress
public AddressClaimSet getAddress()
Get the address claim.- Returns:
- the address claim
- Throws:
IllegalArgumentException
- if the address claim is malformed
-
getUpdatedAt
public Long getUpdatedAt()
Get the updated at claim.- Returns:
- the updated at claim
-
getClaimsLocales
public String getClaimsLocales()
Get the claims locales.- Returns:
- the cliams locales
-
getAccessTokenHash
public String getAccessTokenHash()
Get the access token hash claim.- Returns:
- the access token hash claim
-
getCodeHash
public String getCodeHash()
Get the code hash claim.- Returns:
- the code hash claim
-
getStateHash
public String getStateHash()
Get the state hash claim.- Returns:
- the state hash claim
-
getAcr
public String getAcr()
Get the acr claim.- Returns:
- the acr claim
-
getPrincipalName
public String getPrincipalName(OidcClientConfiguration deployment)
-
-