Class IdToken.Payload (1.36.0)

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

Inherited Members

com.google.api.client.json.GenericJson.getFactory()

com.google.api.client.json.GenericJson.setFactory(com.google.api.client.json.JsonFactory)

com.google.api.client.json.GenericJson.toPrettyString()

com.google.api.client.json.GenericJson.toString()

com.google.api.client.json.webtoken.JsonWebToken.Payload.clone()

com.google.api.client.json.webtoken.JsonWebToken.Payload.getAudience()

com.google.api.client.json.webtoken.JsonWebToken.Payload.getAudienceAsList()

com.google.api.client.json.webtoken.JsonWebToken.Payload.getExpirationTimeSeconds()

com.google.api.client.json.webtoken.JsonWebToken.Payload.getIssuedAtTimeSeconds()

com.google.api.client.json.webtoken.JsonWebToken.Payload.getIssuer()

com.google.api.client.json.webtoken.JsonWebToken.Payload.getJwtId()

com.google.api.client.json.webtoken.JsonWebToken.Payload.getNotBeforeTimeSeconds()

com.google.api.client.json.webtoken.JsonWebToken.Payload.getSubject()

com.google.api.client.json.webtoken.JsonWebToken.Payload.getType()

com.google.api.client.json.webtoken.JsonWebToken.Payload.set(java.lang.String,java.lang.Object)

com.google.api.client.json.webtoken.JsonWebToken.Payload.setAudience(java.lang.Object)

com.google.api.client.json.webtoken.JsonWebToken.Payload.setExpirationTimeSeconds(java.lang.Long)

com.google.api.client.json.webtoken.JsonWebToken.Payload.setIssuedAtTimeSeconds(java.lang.Long)

com.google.api.client.json.webtoken.JsonWebToken.Payload.setIssuer(java.lang.String)

com.google.api.client.json.webtoken.JsonWebToken.Payload.setJwtId(java.lang.String)

com.google.api.client.json.webtoken.JsonWebToken.Payload.setNotBeforeTimeSeconds(java.lang.Long)

com.google.api.client.json.webtoken.JsonWebToken.Payload.setSubject(java.lang.String)

com.google.api.client.json.webtoken.JsonWebToken.Payload.setType(java.lang.String)

com.google.api.client.util.GenericData.entrySet()

com.google.api.client.util.GenericData.equals(java.lang.Object)

com.google.api.client.util.GenericData.get(java.lang.Object)

com.google.api.client.util.GenericData.getClassInfo()

com.google.api.client.util.GenericData.getUnknownKeys()

com.google.api.client.util.GenericData.hashCode()

com.google.api.client.util.GenericData.put(java.lang.String,java.lang.Object)

com.google.api.client.util.GenericData.putAll(java.util.Map<? extends java.lang.String,?>)

com.google.api.client.util.GenericData.remove(java.lang.Object)

com.google.api.client.util.GenericData.setUnknownKeys(java.util.Map<java.lang.String,java.lang.Object>)

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

AbstractMap.clear()

AbstractMap.containsKey(Object)

AbstractMap.containsValue(Object)

AbstractMap.isEmpty()

AbstractMap.keySet()

AbstractMap.put(K,V)

AbstractMap.putAll(Map<? extends K,? extends V>)

AbstractMap.size()

AbstractMap.values()

Constructors

Payload()

public Payload()

Methods

clone()

public IdToken.Payload clone()

Returns
Type	Description
`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
Type	Description
`String`

getAuthorizationTimeSeconds()

public final Long getAuthorizationTimeSeconds()

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

Returns
Type	Description
`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
Type	Description
`String`

getClassReference()

public final String getClassReference()

Returns the authentication context class reference or null for none.

Returns
Type	Description
`String`

getMethodsReferences()

public final List<String> getMethodsReferences()

Returns the authentication methods references or null for none.

Returns
Type	Description
`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
Type	Description
`String`

set(String fieldName, Object value)

public IdToken.Payload set(String fieldName, Object value)

Parameters
Name	Description
`fieldName`	`String`
`value`	`Object`

Returns
Type	Description
`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
Name	Description
`accessTokenHash`	`String`

Returns
Type	Description
`IdToken.Payload`

setAudience(Object audience)

public IdToken.Payload setAudience(Object audience)

Parameter
Name	Description
`audience`	`Object`

Returns
Type	Description
`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
Name	Description
`authorizationTimeSeconds`	`Long`

Returns
Type	Description
`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
Name	Description
`authorizedParty`	`String`

Returns
Type	Description
`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
Name	Description
`classReference`	`String`

Returns
Type	Description
`IdToken.Payload`

setExpirationTimeSeconds(Long expirationTimeSeconds)

public IdToken.Payload setExpirationTimeSeconds(Long expirationTimeSeconds)

Parameter
Name	Description
`expirationTimeSeconds`	`Long`

Returns
Type	Description
`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
Name	Description
`issuedAtTimeSeconds`	`Long`

Returns
Type	Description
`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
Name	Description
`issuer`	`String`

Returns
Type	Description
`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
Name	Description
`jwtId`	`String`

Returns
Type	Description
`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
Name	Description
`methodsReferences`	`List<String>`

Returns
Type	Description
`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
Name	Description
`nonce`	`String`

Returns
Type	Description
`IdToken.Payload`

setNotBeforeTimeSeconds(Long notBeforeTimeSeconds)

public IdToken.Payload setNotBeforeTimeSeconds(Long notBeforeTimeSeconds)

Parameter
Name	Description
`notBeforeTimeSeconds`	`Long`

Returns
Type	Description
`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
Name	Description
`subject`	`String`

Returns
Type	Description
`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
Name	Description
`type`	`String`

Returns
Type	Description
`IdToken.Payload`

Overrides

com.google.api.client.json.webtoken.JsonWebToken.Payload.setType(java.lang.String)