com.google.api.client.googleapis.auth.oauth2

Class GoogleIdToken.Payload

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 com.google.api.client.auth.openidconnect.IdToken.Payload

Beta
Google ID token payload.

Nested Class Summary

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

com.google.api.client.util.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
GoogleIdToken.Payload()

Method Summary

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GoogleIdToken.Payload

public GoogleIdToken.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 com.google.api.client.auth.openidconnect.IdToken.Payload

setAuthorizedParty

public GoogleIdToken.Payload setAuthorizedParty(String authorizedParty)

Overrides:

setAuthorizedParty in class com.google.api.client.auth.openidconnect.IdToken.Payload

setNonce

public GoogleIdToken.Payload setNonce(String nonce)

Overrides:

setNonce in class com.google.api.client.auth.openidconnect.IdToken.Payload

setAccessTokenHash

public GoogleIdToken.Payload setAccessTokenHash(String accessTokenHash)

Overrides:

setAccessTokenHash in class com.google.api.client.auth.openidconnect.IdToken.Payload

setClassReference

public GoogleIdToken.Payload setClassReference(String classReference)

Overrides:

setClassReference in class com.google.api.client.auth.openidconnect.IdToken.Payload

setMethodsReferences

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

Overrides:

setMethodsReferences in class com.google.api.client.auth.openidconnect.IdToken.Payload

setExpirationTimeSeconds

public GoogleIdToken.Payload setExpirationTimeSeconds(Long expirationTimeSeconds)

Overrides:

setExpirationTimeSeconds in class com.google.api.client.auth.openidconnect.IdToken.Payload

setNotBeforeTimeSeconds

public GoogleIdToken.Payload setNotBeforeTimeSeconds(Long notBeforeTimeSeconds)

Overrides:

setNotBeforeTimeSeconds in class com.google.api.client.auth.openidconnect.IdToken.Payload

setIssuedAtTimeSeconds

public GoogleIdToken.Payload setIssuedAtTimeSeconds(Long issuedAtTimeSeconds)

Overrides:

setIssuedAtTimeSeconds in class com.google.api.client.auth.openidconnect.IdToken.Payload

setIssuer

public GoogleIdToken.Payload setIssuer(String issuer)

Overrides:

setIssuer in class com.google.api.client.auth.openidconnect.IdToken.Payload

setAudience

public GoogleIdToken.Payload setAudience(Object audience)

Overrides:

setAudience in class com.google.api.client.auth.openidconnect.IdToken.Payload

setJwtId

public GoogleIdToken.Payload setJwtId(String jwtId)

Overrides:

setJwtId in class com.google.api.client.auth.openidconnect.IdToken.Payload

setType

public GoogleIdToken.Payload setType(String type)

Overrides:

setType in class com.google.api.client.auth.openidconnect.IdToken.Payload

setSubject

public GoogleIdToken.Payload setSubject(String subject)

Overrides:

setSubject in class com.google.api.client.auth.openidconnect.IdToken.Payload

set

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

Overrides:

set in class com.google.api.client.auth.openidconnect.IdToken.Payload

clone

public GoogleIdToken.Payload clone()

Overrides:

clone in class com.google.api.client.auth.openidconnect.IdToken.Payload