2.9.1 (latest) 2.9.0 2.8.1 2.7.2 2.6.0 2.5.1 2.4.1 2.1.2 2.0.1 1.35.2 1.34.1 1.33.4

    public static class GoogleIdToken.Payload extends IdToken.Payload

Beta   

Google ID token payload.

## Inheritance

[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> java.util.AbstractMap \> com.google.api.client.util.GenericData \> com.google.api.client.json.GenericJson \> [JsonWebToken.Payload](https://docs.cloud.google.com/java/docs/reference/google-http-client/latest/com.google.api.client.json.webtoken.JsonWebToken.Payload.html) \> com.google.api.client.auth.openidconnect.IdToken.Payload \> GoogleIdToken.Payload

## Inherited Members

com.google.api.client.auth.openidconnect.IdToken.Payload.clone() com.google.api.client.auth.openidconnect.IdToken.Payload.getAccessTokenHash() com.google.api.client.auth.openidconnect.IdToken.Payload.getAuthorizationTimeSeconds() com.google.api.client.auth.openidconnect.IdToken.Payload.getAuthorizedParty() com.google.api.client.auth.openidconnect.IdToken.Payload.getClassReference() com.google.api.client.auth.openidconnect.IdToken.Payload.getMethodsReferences() com.google.api.client.auth.openidconnect.IdToken.Payload.getNonce() com.google.api.client.auth.openidconnect.IdToken.Payload.set(java.lang.String,java.lang.Object) com.google.api.client.auth.openidconnect.IdToken.Payload.setAccessTokenHash(java.lang.String) com.google.api.client.auth.openidconnect.IdToken.Payload.setAudience(java.lang.Object) com.google.api.client.auth.openidconnect.IdToken.Payload.setAuthorizationTimeSeconds(java.lang.Long) com.google.api.client.auth.openidconnect.IdToken.Payload.setAuthorizedParty(java.lang.String) com.google.api.client.auth.openidconnect.IdToken.Payload.setClassReference(java.lang.String) com.google.api.client.auth.openidconnect.IdToken.Payload.setExpirationTimeSeconds(java.lang.Long) com.google.api.client.auth.openidconnect.IdToken.Payload.setIssuedAtTimeSeconds(java.lang.Long) com.google.api.client.auth.openidconnect.IdToken.Payload.setIssuer(java.lang.String) com.google.api.client.auth.openidconnect.IdToken.Payload.setJwtId(java.lang.String) com.google.api.client.auth.openidconnect.IdToken.Payload.setMethodsReferences(java.util.List\<java.lang.String\>) com.google.api.client.auth.openidconnect.IdToken.Payload.setNonce(java.lang.String) com.google.api.client.auth.openidconnect.IdToken.Payload.setNotBeforeTimeSeconds(java.lang.Long) com.google.api.client.auth.openidconnect.IdToken.Payload.setSubject(java.lang.String) com.google.api.client.auth.openidconnect.IdToken.Payload.setType(java.lang.String) 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.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.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()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) [Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) [Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) [Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) [Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) [Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) [Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-) [AbstractMap.clear()](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#clear--) [AbstractMap.containsKey(Object)](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#containsKey-java.lang.Object-) [AbstractMap.containsValue(Object)](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#containsValue-java.lang.Object-) [AbstractMap.isEmpty()](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#isEmpty--) [AbstractMap.keySet()](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#keySet--) [AbstractMap.put(K,V)](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#put-K-V-) [AbstractMap.putAll(Map\<? extends K,? extends V\>)](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#putAll-java.util.Map<? extends K-? extends V>-) [AbstractMap.size()](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#size--) [AbstractMap.values()](https://docs.oracle.com/javase/8/docs/api/java/util/AbstractMap.html#values--)

## Constructors

### Payload()

    public Payload()

## Methods

### clone()

    public GoogleIdToken.Payload clone()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.clone()

### 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html` |   |

### getHostedDomain()

    public String getHostedDomain()

Returns the hosted domain name if asserted user is a domain managed user or `null` for
none.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### getIssuee() (deprecated)

    public String getIssuee()

**Deprecated.** *(scheduled to be removed in 1.18) Use #getAuthorizedParty() instead.*

Returns the client ID of issuee or `null` for none.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### getUserId() (deprecated)

    public String getUserId()

**Deprecated.** *(scheduled to be removed in 1.18) Use #getSubject() instead.*

Returns the obfuscated Google user id or `null` for none.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### set(String fieldName, Object value)

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `fieldName` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |
| `value` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.set(java.lang.String,java.lang.Object)

### setAccessTokenHash(String accessTokenHash)

    public GoogleIdToken.Payload setAccessTokenHash(String accessTokenHash)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `accessTokenHash` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setAccessTokenHash(java.lang.String)

### setAudience(Object audience)

    public GoogleIdToken.Payload setAudience(Object audience)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `audience` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setAudience(java.lang.Object)

### setAuthorizationTimeSeconds(Long authorizationTimeSeconds)

    public GoogleIdToken.Payload setAuthorizationTimeSeconds(Long authorizationTimeSeconds)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `authorizationTimeSeconds` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setAuthorizationTimeSeconds(java.lang.Long)

### setAuthorizedParty(String authorizedParty)

    public GoogleIdToken.Payload setAuthorizedParty(String authorizedParty)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `authorizedParty` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setAuthorizedParty(java.lang.String)

### setClassReference(String classReference)

    public GoogleIdToken.Payload setClassReference(String classReference)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `classReference` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setClassReference(java.lang.String)

### setEmail(String email)

    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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `email` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

### setEmailVerified(Boolean emailVerified)

    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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `emailVerified` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

### setExpirationTimeSeconds(Long expirationTimeSeconds)

    public GoogleIdToken.Payload setExpirationTimeSeconds(Long expirationTimeSeconds)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `expirationTimeSeconds` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setExpirationTimeSeconds(java.lang.Long)

### setHostedDomain(String hostedDomain)

    public GoogleIdToken.Payload setHostedDomain(String hostedDomain)

Sets the hosted domain name if asserted user is a domain managed user or `null` for
none.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `hostedDomain` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

### setIssuedAtTimeSeconds(Long issuedAtTimeSeconds)

    public GoogleIdToken.Payload setIssuedAtTimeSeconds(Long issuedAtTimeSeconds)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `issuedAtTimeSeconds` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setIssuedAtTimeSeconds(java.lang.Long)

### setIssuee(String issuee) (deprecated)

    public GoogleIdToken.Payload setIssuee(String issuee)

**Deprecated.** *(scheduled to be removed in 1.18) Use [#setAuthorizedParty(String)](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload#com_google_api_client_googleapis_auth_oauth2_GoogleIdToken_Payload_setAuthorizedParty_java_lang_String_)
instead.*

Sets the client ID of issuee or `null` for none.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `issuee` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

### setIssuer(String issuer)

    public GoogleIdToken.Payload setIssuer(String issuer)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `issuer` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setIssuer(java.lang.String)

### setJwtId(String jwtId)

    public GoogleIdToken.Payload setJwtId(String jwtId)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `jwtId` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setJwtId(java.lang.String)

### setMethodsReferences(List\<String\> methodsReferences)

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `methodsReferences` | `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setMethodsReferences(java.util.List\<java.lang.String\>)

### setNonce(String nonce)

    public GoogleIdToken.Payload setNonce(String nonce)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `nonce` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setNonce(java.lang.String)

### setNotBeforeTimeSeconds(Long notBeforeTimeSeconds)

    public GoogleIdToken.Payload setNotBeforeTimeSeconds(Long notBeforeTimeSeconds)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `notBeforeTimeSeconds` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setNotBeforeTimeSeconds(java.lang.Long)

### setSubject(String subject)

    public GoogleIdToken.Payload setSubject(String subject)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `subject` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setSubject(java.lang.String)

### setType(String type)

    public GoogleIdToken.Payload setType(String type)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `type` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |

**Overrides** com.google.api.client.auth.openidconnect.IdToken.Payload.setType(java.lang.String)

### setUserId(String userId) (deprecated)

    public GoogleIdToken.Payload setUserId(String userId)

**Deprecated.** *(scheduled to be removed in 1.18) Use [#setSubject(String)](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload#com_google_api_client_googleapis_auth_oauth2_GoogleIdToken_Payload_setSubject_java_lang_String_) instead.*

Sets the obfuscated Google user id or `null` for none.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `userId` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload` |   |