GoogleIdToken.Payload (google-api-java-client 1.30.10)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.client.json.webtoken.JsonWebToken.Payload
      - com.google.api.client.auth.openidconnect.IdToken.Payload
        
        com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

GoogleIdToken
```
@Beta
public static class GoogleIdToken.Payload
extends IdToken.Payload
```
Beta
Google ID token payload.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Payload()

Constructors
Constructor and Description
`Payload()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`GoogleIdToken.Payload`	`clone()`
`String`	`getEmail()` Returns the e-mail address of the user or `null` if it was not requested.
`Boolean`	`getEmailVerified()` Returns `true` if the users e-mail address has been verified by Google.
`String`	`getHostedDomain()` Returns the hosted domain name if asserted user is a domain managed user or `null` for none.
`String`	`getIssuee()` Deprecated. (scheduled to be removed in 1.18) Use `IdToken.Payload.getAuthorizedParty()` instead.
`String`	`getUserId()` Deprecated. (scheduled to be removed in 1.18) Use `JsonWebToken.Payload.getSubject()` instead.
`GoogleIdToken.Payload`	`set(String fieldName, Object value)`
`GoogleIdToken.Payload`	`setAccessTokenHash(String accessTokenHash)`
`GoogleIdToken.Payload`	`setAudience(Object audience)`
`GoogleIdToken.Payload`	`setAuthorizationTimeSeconds(Long authorizationTimeSeconds)`
`GoogleIdToken.Payload`	`setAuthorizedParty(String authorizedParty)`
`GoogleIdToken.Payload`	`setClassReference(String classReference)`
`GoogleIdToken.Payload`	`setEmail(String email)` Sets the e-mail address of the user or `null` if it was not requested.
`GoogleIdToken.Payload`	`setEmailVerified(Boolean emailVerified)` Sets whether the users e-mail address has been verified by Google or not.
`GoogleIdToken.Payload`	`setExpirationTimeSeconds(Long expirationTimeSeconds)`
`GoogleIdToken.Payload`	`setHostedDomain(String hostedDomain)` Sets the hosted domain name if asserted user is a domain managed user or `null` for none.
`GoogleIdToken.Payload`	`setIssuedAtTimeSeconds(Long issuedAtTimeSeconds)`
`GoogleIdToken.Payload`	`setIssuee(String issuee)` Deprecated. (scheduled to be removed in 1.18) Use `setAuthorizedParty(String)` instead.
`GoogleIdToken.Payload`	`setIssuer(String issuer)`
`GoogleIdToken.Payload`	`setJwtId(String jwtId)`
`GoogleIdToken.Payload`	`setMethodsReferences(List<String> methodsReferences)`
`GoogleIdToken.Payload`	`setNonce(String nonce)`
`GoogleIdToken.Payload`	`setNotBeforeTimeSeconds(Long notBeforeTimeSeconds)`
`GoogleIdToken.Payload`	`setSubject(String subject)`
`GoogleIdToken.Payload`	`setType(String type)`
`GoogleIdToken.Payload`	`setUserId(String userId)` Deprecated. (scheduled to be removed in 1.18) Use `setSubject(String)` instead.

Methods inherited from class com.google.api.client.auth.openidconnect.IdToken.Payload
getAccessTokenHash, getAuthorizationTimeSeconds, getAuthorizedParty, getClassReference, getMethodsReferences, getNonce

Methods inherited from class com.google.api.client.json.webtoken.JsonWebToken.Payload
getAudience, getAudienceAsList, getExpirationTimeSeconds, getIssuedAtTimeSeconds, getIssuer, getJwtId, getNotBeforeTimeSeconds, getSubject, getType

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Payload
```
public Payload()
```
- Method Detail
  - getUserId
```
@Deprecated
public String getUserId()
```
    Deprecated. (scheduled to be removed in 1.18) Use JsonWebToken.Payload.getSubject() instead.
    
    Returns the obfuscated Google user id or null for none.
  - setUserId
```
@Deprecated
public GoogleIdToken.Payload setUserId(String userId)
```
    Deprecated. (scheduled to be removed in 1.18) Use setSubject(String) instead.
    
    Sets the obfuscated Google user id or null for none.
  - getIssuee
```
@Deprecated
public String getIssuee()
```
    Deprecated. (scheduled to be removed in 1.18) Use IdToken.Payload.getAuthorizedParty() instead.
    
    Returns the client ID of issuee or null for none.
  - setIssuee
```
@Deprecated
public GoogleIdToken.Payload setIssuee(String issuee)
```
    Deprecated. (scheduled to be removed in 1.18) Use setAuthorizedParty(String) instead.
    
    Sets the client ID of issuee or null for none.
  - getHostedDomain
```
public String getHostedDomain()
```
    Returns the hosted domain name if asserted user is a domain managed user or null for none.
  - setHostedDomain
```
public GoogleIdToken.Payload setHostedDomain(String hostedDomain)
```
    Sets the hosted domain name if asserted user is a domain managed user or null for none.
  - getEmail
```
public String getEmail()
```
    Returns the e-mail address of the user or null if it was not requested.
    Requires the "https://www.googleapis.com/auth/userinfo.email" scope.
    
    Since:
    
    1.10
  - setEmail
```
public GoogleIdToken.Payload setEmail(String email)
```
    Sets the e-mail address of the user or null if it was not requested.
    Used in conjunction with the "https://www.googleapis.com/auth/userinfo.email" scope.
    
    Since:
    
    1.10
  - getEmailVerified
```
public Boolean getEmailVerified()
```
    Returns true if the users e-mail address has been verified by Google.
    Requires the "https://www.googleapis.com/auth/userinfo.email" scope.
    
    Since:
    
    1.10
    Upgrade warning: in prior version 1.16 this method accessed "verified_email" and returns a boolean, but starting with verison 1.17, it now accesses "email_verified" and returns a Boolean. Previously, if this value was not specified, this method would return false, but now it returns null.
  - setEmailVerified
```
public GoogleIdToken.Payload setEmailVerified(Boolean emailVerified)
```
    Sets whether the users e-mail address has been verified by Google or not.
    Used in conjunction with the "https://www.googleapis.com/auth/userinfo.email" scope.
    
    Since:
    
    1.10
    Upgrade warning: in prior version 1.16 this method accessed "verified_email" and required a boolean parameter, but starting with verison 1.17, it now accesses "email_verified" and requires a Boolean parameter.
  - setAuthorizationTimeSeconds
```
public GoogleIdToken.Payload setAuthorizationTimeSeconds(Long authorizationTimeSeconds)
```
    Overrides:
    
    setAuthorizationTimeSeconds in class IdToken.Payload
  - setAuthorizedParty
```
public GoogleIdToken.Payload setAuthorizedParty(String authorizedParty)
```
    Overrides:
    
    setAuthorizedParty in class IdToken.Payload
  - setNonce
```
public GoogleIdToken.Payload setNonce(String nonce)
```
    Overrides:
    
    setNonce in class IdToken.Payload
  - setAccessTokenHash
```
public GoogleIdToken.Payload setAccessTokenHash(String accessTokenHash)
```
    Overrides:
    
    setAccessTokenHash in class IdToken.Payload
  - setClassReference
```
public GoogleIdToken.Payload setClassReference(String classReference)
```
    Overrides:
    
    setClassReference in class IdToken.Payload
  - setMethodsReferences
```
public GoogleIdToken.Payload setMethodsReferences(List<String> methodsReferences)
```
    Overrides:
    
    setMethodsReferences in class IdToken.Payload
  - setExpirationTimeSeconds
```
public GoogleIdToken.Payload setExpirationTimeSeconds(Long expirationTimeSeconds)
```
    Overrides:
    
    setExpirationTimeSeconds in class IdToken.Payload
  - setNotBeforeTimeSeconds
```
public GoogleIdToken.Payload setNotBeforeTimeSeconds(Long notBeforeTimeSeconds)
```
    Overrides:
    
    setNotBeforeTimeSeconds in class IdToken.Payload
  - setIssuedAtTimeSeconds
```
public GoogleIdToken.Payload setIssuedAtTimeSeconds(Long issuedAtTimeSeconds)
```
    Overrides:
    
    setIssuedAtTimeSeconds in class IdToken.Payload
  - setIssuer
```
public GoogleIdToken.Payload setIssuer(String issuer)
```
    Overrides:
    
    setIssuer in class IdToken.Payload
  - setAudience
```
public GoogleIdToken.Payload setAudience(Object audience)
```
    Overrides:
    
    setAudience in class IdToken.Payload
  - setJwtId
```
public GoogleIdToken.Payload setJwtId(String jwtId)
```
    Overrides:
    
    setJwtId in class IdToken.Payload
  - setType
```
public GoogleIdToken.Payload setType(String type)
```
    Overrides:
    
    setType in class IdToken.Payload
  - setSubject
```
public GoogleIdToken.Payload setSubject(String subject)
```
    Overrides:
    
    setSubject in class IdToken.Payload
  - set
```
public GoogleIdToken.Payload set(String fieldName,
                                 Object value)
```
    Overrides:
    
    set in class IdToken.Payload
  - clone
```
public GoogleIdToken.Payload clone()
```
    Overrides:
    
    clone in class IdToken.Payload

Class GoogleIdToken.Payload

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.auth.openidconnect.IdToken.Payload

Methods inherited from class com.google.api.client.json.webtoken.JsonWebToken.Payload

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Payload

Method Detail

getUserId

setUserId

getIssuee

setIssuee

getHostedDomain

setHostedDomain

getEmail

setEmail

getEmailVerified

setEmailVerified

setAuthorizationTimeSeconds

setAuthorizedParty

setNonce

setAccessTokenHash

setClassReference

setMethodsReferences

setExpirationTimeSeconds

setNotBeforeTimeSeconds

setIssuedAtTimeSeconds

setIssuer

setAudience

setJwtId

setType

setSubject

set

clone