-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class AuthenticationTokenClaims implements Parcelable
This class represents an immutable claims for using AuthenticationToken. It includes all metadata or key values of the claims
WARNING: This feature is currently in development and not intended for external usage.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
AuthenticationTokenClaims.Companion
-
Field Summary
Fields Modifier and Type Field Description private final String
jti
private final String
iss
private final String
aud
private final String
nonce
private final Long
exp
private final Long
iat
private final String
sub
private final String
name
private final String
givenName
private final String
middleName
private final String
familyName
private final String
email
private final String
picture
private final Set<String>
userFriends
private final String
userBirthday
private final Map<String, Integer>
userAgeRange
private final Map<String, String>
userHometown
private final Map<String, String>
userLocation
private final String
userGender
private final String
userLink
-
Constructor Summary
Constructors Constructor Description AuthenticationTokenClaims(String encodedClaims, String expectedNonce)
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends, String userBirthday, Map<String, Integer> userAgeRange, Map<String, String> userHometown, Map<String, String> userLocation, String userGender, String userLink)
Creates a the claims component of AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends, String userBirthday, Map<String, Integer> userAgeRange, Map<String, String> userHometown, Map<String, String> userLocation, String userGender)
Creates a the claims component of AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends, String userBirthday, Map<String, Integer> userAgeRange, Map<String, String> userHometown, Map<String, String> userLocation)
Creates a the claims component of AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends, String userBirthday, Map<String, Integer> userAgeRange, Map<String, String> userHometown)
Creates a the claims component of AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends, String userBirthday, Map<String, Integer> userAgeRange)
Creates a the claims component of AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends, String userBirthday)
Creates a the claims component of AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends)
Creates a the claims component of AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture)
Creates a the claims component of AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email)
Creates a the claims component of AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName)
Creates a the claims component of AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName)
Creates a the claims component of AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName)
Creates a the claims component of AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name)
Creates a the claims component of AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub)
Creates a the claims component of
-
Method Summary
Modifier and Type Method Description final String
getJti()
Get a unique identifier for the token. final String
getIss()
Get issuer Identifier for the Issuer of the response. final String
getAud()
Get audience(s) that this ID Token is intended for. final String
getNonce()
String value used to associate a Client session with an ID Token, and to mitigate replay attacks. final Long
getExp()
Expiration time (in seconds) on or after which the ID Token MUST NOT be accepted for processing. final Long
getIat()
Time (in seconds) at which the JWT was issued. final String
getSub()
Subject - Identifier for the End-User at the Issuer. final String
getName()
End-User's full name in displayable form including all name parts. final String
getGivenName()
End-User's given name in displayable form final String
getMiddleName()
End-User's middle name in displayable form final String
getFamilyName()
End-User's family name in displayable form final String
getEmail()
End-User's preferred e-mail address. final String
getPicture()
URL of the End-User's profile picture. final Set<String>
getUserFriends()
End-User's friends. final String
getUserBirthday()
End-User's birthday final Map<String, Integer>
getUserAgeRange()
End-User's age range final Map<String, String>
getUserHometown()
End-User's hometown final Map<String, String>
getUserLocation()
End-User's location final String
getUserGender()
End-User's gender final String
getUserLink()
End-User's link Unit
writeToParcel(Parcel dest, Integer flags)
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
Integer
describeContents()
final String
toEnCodedString()
-
-
Constructor Detail
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends, String userBirthday, Map<String, Integer> userAgeRange, Map<String, String> userHometown, Map<String, String> userLocation, String userGender, String userLink)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuername
- End-User's full name in displayable form including all name partsgivenName
- End-User's given name in displayable formmiddleName
- End-User's middle name in displayable formfamilyName
- End-User's family name in displayable formemail
- End-User's preferred e-mail addresspicture
- URL of the End-User's profile pictureuserFriends
- End-User's friendsuserBirthday
- End-User's birthdayuserAgeRange
- End-User's age rangeuserHometown
- End-User's hometownuserLocation
- End-User's locationuserGender
- End-User's genderuserLink
- End-User's link
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends, String userBirthday, Map<String, Integer> userAgeRange, Map<String, String> userHometown, Map<String, String> userLocation, String userGender)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuername
- End-User's full name in displayable form including all name partsgivenName
- End-User's given name in displayable formmiddleName
- End-User's middle name in displayable formfamilyName
- End-User's family name in displayable formemail
- End-User's preferred e-mail addresspicture
- URL of the End-User's profile pictureuserFriends
- End-User's friendsuserBirthday
- End-User's birthdayuserAgeRange
- End-User's age rangeuserHometown
- End-User's hometownuserLocation
- End-User's locationuserGender
- End-User's gender
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends, String userBirthday, Map<String, Integer> userAgeRange, Map<String, String> userHometown, Map<String, String> userLocation)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuername
- End-User's full name in displayable form including all name partsgivenName
- End-User's given name in displayable formmiddleName
- End-User's middle name in displayable formfamilyName
- End-User's family name in displayable formemail
- End-User's preferred e-mail addresspicture
- URL of the End-User's profile pictureuserFriends
- End-User's friendsuserBirthday
- End-User's birthdayuserAgeRange
- End-User's age rangeuserHometown
- End-User's hometownuserLocation
- End-User's location
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends, String userBirthday, Map<String, Integer> userAgeRange, Map<String, String> userHometown)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuername
- End-User's full name in displayable form including all name partsgivenName
- End-User's given name in displayable formmiddleName
- End-User's middle name in displayable formfamilyName
- End-User's family name in displayable formemail
- End-User's preferred e-mail addresspicture
- URL of the End-User's profile pictureuserFriends
- End-User's friendsuserBirthday
- End-User's birthdayuserAgeRange
- End-User's age rangeuserHometown
- End-User's hometown
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends, String userBirthday, Map<String, Integer> userAgeRange)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuername
- End-User's full name in displayable form including all name partsgivenName
- End-User's given name in displayable formmiddleName
- End-User's middle name in displayable formfamilyName
- End-User's family name in displayable formemail
- End-User's preferred e-mail addresspicture
- URL of the End-User's profile pictureuserFriends
- End-User's friendsuserBirthday
- End-User's birthdayuserAgeRange
- End-User's age range
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends, String userBirthday)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuername
- End-User's full name in displayable form including all name partsgivenName
- End-User's given name in displayable formmiddleName
- End-User's middle name in displayable formfamilyName
- End-User's family name in displayable formemail
- End-User's preferred e-mail addresspicture
- URL of the End-User's profile pictureuserFriends
- End-User's friendsuserBirthday
- End-User's birthday
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture, Collection<String> userFriends)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuername
- End-User's full name in displayable form including all name partsgivenName
- End-User's given name in displayable formmiddleName
- End-User's middle name in displayable formfamilyName
- End-User's family name in displayable formemail
- End-User's preferred e-mail addresspicture
- URL of the End-User's profile pictureuserFriends
- End-User's friends
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email, String picture)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuername
- End-User's full name in displayable form including all name partsgivenName
- End-User's given name in displayable formmiddleName
- End-User's middle name in displayable formfamilyName
- End-User's family name in displayable formemail
- End-User's preferred e-mail addresspicture
- URL of the End-User's profile picture
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName, String email)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuername
- End-User's full name in displayable form including all name partsgivenName
- End-User's given name in displayable formmiddleName
- End-User's middle name in displayable formfamilyName
- End-User's family name in displayable formemail
- End-User's preferred e-mail address
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName, String familyName)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuername
- End-User's full name in displayable form including all name partsgivenName
- End-User's given name in displayable formmiddleName
- End-User's middle name in displayable formfamilyName
- End-User's family name in displayable form
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName, String middleName)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuername
- End-User's full name in displayable form including all name partsgivenName
- End-User's given name in displayable formmiddleName
- End-User's middle name in displayable form
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name, String givenName)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuername
- End-User's full name in displayable form including all name partsgivenName
- End-User's given name in displayable form
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub, String name)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuername
- End-User's full name in displayable form including all name parts
-
AuthenticationTokenClaims
AuthenticationTokenClaims(String jti, String iss, String aud, String nonce, Long exp, Long iat, String sub)
Creates a the claims component of- Parameters:
jti
- A unique identifier for the tokeniss
- Issuer Identifier for the Issuer of the responseaud
- Audience(s) that this ID Token is intended fornonce
- String value used to associate a Client session with an ID Tokenexp
- Expiration time on or after which the ID Token MUST NOT be accepted for processingiat
- Time at which the JWT was issuedsub
- Subject - Identifier for the End-User at the Issuer
-
-
Method Detail
-
getNonce
final String getNonce()
String value used to associate a Client session with an ID Token, and to mitigate replay attacks.
-
getExp
final Long getExp()
Expiration time (in seconds) on or after which the ID Token MUST NOT be accepted for processing.
-
getGivenName
final String getGivenName()
End-User's given name in displayable form
-
getMiddleName
final String getMiddleName()
End-User's middle name in displayable form
-
getFamilyName
final String getFamilyName()
End-User's family name in displayable form
-
getEmail
final String getEmail()
End-User's preferred e-mail address.
IMPORTANT: This field will only be populated if your user has granted your application the 'email' permission.
-
getPicture
final String getPicture()
URL of the End-User's profile picture.
-
getUserFriends
final Set<String> getUserFriends()
End-User's friends.
IMPORTANT: This field will only be populated if your user has granted your application the 'user_friends' permission.
-
getUserBirthday
final String getUserBirthday()
End-User's birthday
-
getUserAgeRange
final Map<String, Integer> getUserAgeRange()
End-User's age range
-
getUserHometown
final Map<String, String> getUserHometown()
End-User's hometown
-
getUserLocation
final Map<String, String> getUserLocation()
End-User's location
-
getUserGender
final String getUserGender()
End-User's gender
-
getUserLink
final String getUserLink()
End-User's link
-
writeToParcel
Unit writeToParcel(Parcel dest, Integer flags)
-
describeContents
Integer describeContents()
-
toEnCodedString
final String toEnCodedString()
-
-
-
-