Class IdToken.Payload (1.32.1)

public static class IdToken.Payload extends JsonWebToken.Payload

Beta
ID token payload.

Inheritance

Object > java.util.AbstractMap > com.google.api.client.util.GenericData > com.google.api.client.json.GenericJson > com.google.api.client.json.webtoken.JsonWebToken.Payload > IdToken.Payload

Constructors

Payload()

public Payload()

Methods

clone()

public IdToken.Payload clone()
Returns
TypeDescription
IdToken.Payload
Overrides
com.google.api.client.json.webtoken.JsonWebToken.Payload.clone()

getAccessTokenHash()

public final String getAccessTokenHash()

Returns the access token hash value or null for none.

Returns
TypeDescription
String

getAuthorizationTimeSeconds()

public final Long getAuthorizationTimeSeconds()

Returns the time (in seconds) of end-user authorization or null for none.

Returns
TypeDescription
Long

getAuthorizedParty()

public final String getAuthorizedParty()

Returns the authorized party or null for none.

Upgrade warning: in prior version 1.15 this method returned an Object, but starting with version 1.16 it returns a String.

Returns
TypeDescription
String

getClassReference()

public final String getClassReference()

Returns the authentication context class reference or null for none.

Returns
TypeDescription
String

getMethodsReferences()

public final List<String> getMethodsReferences()

Returns the authentication methods references or null for none.

Returns
TypeDescription
List<String>

getNonce()

public final String getNonce()

Returns the value used to associate a client session with an ID token or null for none.

Returns
TypeDescription
String

set(String fieldName, Object value)

public IdToken.Payload set(String fieldName, Object value)
Parameters
NameDescription
fieldNameString
valueObject
Returns
TypeDescription
IdToken.Payload
Overrides
com.google.api.client.json.webtoken.JsonWebToken.Payload.set(java.lang.String,java.lang.Object)

setAccessTokenHash(String accessTokenHash)

public IdToken.Payload setAccessTokenHash(String accessTokenHash)

Sets the access token hash value or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
accessTokenHashString
Returns
TypeDescription
IdToken.Payload

setAudience(Object audience)

public IdToken.Payload setAudience(Object audience)
Parameter
NameDescription
audienceObject
Returns
TypeDescription
IdToken.Payload
Overrides
com.google.api.client.json.webtoken.JsonWebToken.Payload.setAudience(java.lang.Object)

setAuthorizationTimeSeconds(Long authorizationTimeSeconds)

public IdToken.Payload setAuthorizationTimeSeconds(Long authorizationTimeSeconds)

Sets the time (in seconds) of end-user authorization or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
authorizationTimeSecondsLong
Returns
TypeDescription
IdToken.Payload

setAuthorizedParty(String authorizedParty)

public IdToken.Payload setAuthorizedParty(String authorizedParty)

Sets the authorized party or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Upgrade warning: in prior version 1.15 the parameter was an Object, but starting with version 1.16 the parameter is a String.

Parameter
NameDescription
authorizedPartyString
Returns
TypeDescription
IdToken.Payload

setClassReference(String classReference)

public IdToken.Payload setClassReference(String classReference)

Sets the authentication context class reference or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
classReferenceString
Returns
TypeDescription
IdToken.Payload

setExpirationTimeSeconds(Long expirationTimeSeconds)

public IdToken.Payload setExpirationTimeSeconds(Long expirationTimeSeconds)
Parameter
NameDescription
expirationTimeSecondsLong
Returns
TypeDescription
IdToken.Payload
Overrides
com.google.api.client.json.webtoken.JsonWebToken.Payload.setExpirationTimeSeconds(java.lang.Long)

setIssuedAtTimeSeconds(Long issuedAtTimeSeconds)

public IdToken.Payload setIssuedAtTimeSeconds(Long issuedAtTimeSeconds)
Parameter
NameDescription
issuedAtTimeSecondsLong
Returns
TypeDescription
IdToken.Payload
Overrides
com.google.api.client.json.webtoken.JsonWebToken.Payload.setIssuedAtTimeSeconds(java.lang.Long)

setIssuer(String issuer)

public IdToken.Payload setIssuer(String issuer)
Parameter
NameDescription
issuerString
Returns
TypeDescription
IdToken.Payload
Overrides
com.google.api.client.json.webtoken.JsonWebToken.Payload.setIssuer(java.lang.String)

setJwtId(String jwtId)

public IdToken.Payload setJwtId(String jwtId)
Parameter
NameDescription
jwtIdString
Returns
TypeDescription
IdToken.Payload
Overrides
com.google.api.client.json.webtoken.JsonWebToken.Payload.setJwtId(java.lang.String)

setMethodsReferences(List<String> methodsReferences)

public IdToken.Payload setMethodsReferences(List<String> methodsReferences)

Sets the authentication methods references or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
methodsReferencesList<String>
Returns
TypeDescription
IdToken.Payload

setNonce(String nonce)

public IdToken.Payload setNonce(String nonce)

Sets the value used to associate a client session with an ID token or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
nonceString
Returns
TypeDescription
IdToken.Payload

setNotBeforeTimeSeconds(Long notBeforeTimeSeconds)

public IdToken.Payload setNotBeforeTimeSeconds(Long notBeforeTimeSeconds)
Parameter
NameDescription
notBeforeTimeSecondsLong
Returns
TypeDescription
IdToken.Payload
Overrides
com.google.api.client.json.webtoken.JsonWebToken.Payload.setNotBeforeTimeSeconds(java.lang.Long)

setSubject(String subject)

public IdToken.Payload setSubject(String subject)
Parameter
NameDescription
subjectString
Returns
TypeDescription
IdToken.Payload
Overrides
com.google.api.client.json.webtoken.JsonWebToken.Payload.setSubject(java.lang.String)

setType(String type)

public IdToken.Payload setType(String type)
Parameter
NameDescription
typeString
Returns
TypeDescription
IdToken.Payload
Overrides
com.google.api.client.json.webtoken.JsonWebToken.Payload.setType(java.lang.String)