com.google.api.services.identitytoolkit.model

Class VerifyAssertionResponse

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.identitytoolkit.model.VerifyAssertionResponse

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class VerifyAssertionResponse
extends com.google.api.client.json.GenericJson

Response of verifying the IDP assertion.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Identity Toolkit API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
VerifyAssertionResponse()

Method Summary

Modifier and Type	Method and Description
VerifyAssertionResponse	clone()
java.lang.String	getAction() The action code.
java.lang.String	getAppInstallationUrl() URL for OTA app installation.
java.lang.String	getAppScheme() The custom scheme used by mobile app.
java.lang.String	getContext() The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
java.lang.String	getDateOfBirth() The birth date of the IdP account.
java.lang.String	getDisplayName() The display name of the user.
java.lang.String	getEmail() The email returned by the IdP.
java.lang.Boolean	getEmailRecycled() It's true if the email is recycled.
java.lang.Boolean	getEmailVerified() The value is true if the IDP is also the email provider.
java.lang.String	getErrorMessage() Client error code.
java.lang.Long	getExpiresIn() If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
java.lang.String	getFederatedId() The unique ID identifies the IdP account.
java.lang.String	getFirstName() The first name of the user.
java.lang.String	getFullName() The full name of the user.
java.lang.String	getIdToken() The ID token.
java.lang.String	getInputEmail() It's the identifier param in the createAuthUri request if the identifier is an email.
java.lang.Boolean	getIsNewUser() True if it's a new user sign-in, false if it's a returning user.
java.lang.String	getKind() The fixed string "identitytoolkit#VerifyAssertionResponse".
java.lang.String	getLanguage() The language preference of the user.
java.lang.String	getLastName() The last name of the user.
java.lang.String	getLocalId() The RP local ID if it's already been mapped to the IdP account identified by the federated ID.
java.lang.Boolean	getNeedConfirmation() Whether the assertion is from a non-trusted IDP and need account linking confirmation.
java.lang.Boolean	getNeedEmail() Whether need client to supply email to complete the federated login flow.
java.lang.String	getNickName() The nick name of the user.
java.lang.String	getOauthAccessToken() The OAuth2 access token.
java.lang.String	getOauthAuthorizationCode() The OAuth2 authorization code.
java.lang.Integer	getOauthExpireIn() The lifetime in seconds of the OAuth2 access token.
java.lang.String	getOauthIdToken() The OIDC id token.
java.lang.String	getOauthRequestToken() The user approved request token for the OpenID OAuth extension.
java.lang.String	getOauthScope() The scope for the OpenID OAuth extension.
java.lang.String	getOauthTokenSecret() The OAuth1 access token secret.
java.lang.String	getOriginalEmail() The original email stored in the mapping storage.
java.lang.String	getPhotoUrl() The URI of the public accessible profiel picture.
java.lang.String	getProviderId() The IdP ID.
java.lang.String	getRawUserInfo() Raw IDP-returned user info.
java.lang.String	getRefreshToken() If idToken is STS id token, then this field will be refresh token.
java.lang.String	getScreenName() The screen_name of a Twitter user or the login name at Github.
java.lang.String	getTimeZone() The timezone of the user.
java.util.List<java.lang.String>	getVerifiedProvider() When action is 'map', contains the idps which can be used for confirmation.
VerifyAssertionResponse	set(java.lang.String fieldName, java.lang.Object value)
VerifyAssertionResponse	setAction(java.lang.String action) The action code.
VerifyAssertionResponse	setAppInstallationUrl(java.lang.String appInstallationUrl) URL for OTA app installation.
VerifyAssertionResponse	setAppScheme(java.lang.String appScheme) The custom scheme used by mobile app.
VerifyAssertionResponse	setContext(java.lang.String context) The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
VerifyAssertionResponse	setDateOfBirth(java.lang.String dateOfBirth) The birth date of the IdP account.
VerifyAssertionResponse	setDisplayName(java.lang.String displayName) The display name of the user.
VerifyAssertionResponse	setEmail(java.lang.String email) The email returned by the IdP.
VerifyAssertionResponse	setEmailRecycled(java.lang.Boolean emailRecycled) It's true if the email is recycled.
VerifyAssertionResponse	setEmailVerified(java.lang.Boolean emailVerified) The value is true if the IDP is also the email provider.
VerifyAssertionResponse	setErrorMessage(java.lang.String errorMessage) Client error code.
VerifyAssertionResponse	setExpiresIn(java.lang.Long expiresIn) If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
VerifyAssertionResponse	setFederatedId(java.lang.String federatedId) The unique ID identifies the IdP account.
VerifyAssertionResponse	setFirstName(java.lang.String firstName) The first name of the user.
VerifyAssertionResponse	setFullName(java.lang.String fullName) The full name of the user.
VerifyAssertionResponse	setIdToken(java.lang.String idToken) The ID token.
VerifyAssertionResponse	setInputEmail(java.lang.String inputEmail) It's the identifier param in the createAuthUri request if the identifier is an email.
VerifyAssertionResponse	setIsNewUser(java.lang.Boolean isNewUser) True if it's a new user sign-in, false if it's a returning user.
VerifyAssertionResponse	setKind(java.lang.String kind) The fixed string "identitytoolkit#VerifyAssertionResponse".
VerifyAssertionResponse	setLanguage(java.lang.String language) The language preference of the user.
VerifyAssertionResponse	setLastName(java.lang.String lastName) The last name of the user.
VerifyAssertionResponse	setLocalId(java.lang.String localId) The RP local ID if it's already been mapped to the IdP account identified by the federated ID.
VerifyAssertionResponse	setNeedConfirmation(java.lang.Boolean needConfirmation) Whether the assertion is from a non-trusted IDP and need account linking confirmation.
VerifyAssertionResponse	setNeedEmail(java.lang.Boolean needEmail) Whether need client to supply email to complete the federated login flow.
VerifyAssertionResponse	setNickName(java.lang.String nickName) The nick name of the user.
VerifyAssertionResponse	setOauthAccessToken(java.lang.String oauthAccessToken) The OAuth2 access token.
VerifyAssertionResponse	setOauthAuthorizationCode(java.lang.String oauthAuthorizationCode) The OAuth2 authorization code.
VerifyAssertionResponse	setOauthExpireIn(java.lang.Integer oauthExpireIn) The lifetime in seconds of the OAuth2 access token.
VerifyAssertionResponse	setOauthIdToken(java.lang.String oauthIdToken) The OIDC id token.
VerifyAssertionResponse	setOauthRequestToken(java.lang.String oauthRequestToken) The user approved request token for the OpenID OAuth extension.
VerifyAssertionResponse	setOauthScope(java.lang.String oauthScope) The scope for the OpenID OAuth extension.
VerifyAssertionResponse	setOauthTokenSecret(java.lang.String oauthTokenSecret) The OAuth1 access token secret.
VerifyAssertionResponse	setOriginalEmail(java.lang.String originalEmail) The original email stored in the mapping storage.
VerifyAssertionResponse	setPhotoUrl(java.lang.String photoUrl) The URI of the public accessible profiel picture.
VerifyAssertionResponse	setProviderId(java.lang.String providerId) The IdP ID.
VerifyAssertionResponse	setRawUserInfo(java.lang.String rawUserInfo) Raw IDP-returned user info.
VerifyAssertionResponse	setRefreshToken(java.lang.String refreshToken) If idToken is STS id token, then this field will be refresh token.
VerifyAssertionResponse	setScreenName(java.lang.String screenName) The screen_name of a Twitter user or the login name at Github.
VerifyAssertionResponse	setTimeZone(java.lang.String timeZone) The timezone of the user.
VerifyAssertionResponse	setVerifiedProvider(java.util.List<java.lang.String> verifiedProvider) When action is 'map', contains the idps which can be used for confirmation.

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

VerifyAssertionResponse

public VerifyAssertionResponse()

Method Detail

getAction

public java.lang.String getAction()

The action code.

Returns:

value or null for none

setAction

public VerifyAssertionResponse setAction(java.lang.String action)

The action code.

Parameters:

action - action or null for none

getAppInstallationUrl

public java.lang.String getAppInstallationUrl()

URL for OTA app installation.

Returns:

value or null for none

setAppInstallationUrl

public VerifyAssertionResponse setAppInstallationUrl(java.lang.String appInstallationUrl)

URL for OTA app installation.

Parameters:

appInstallationUrl - appInstallationUrl or null for none

getAppScheme

public java.lang.String getAppScheme()

The custom scheme used by mobile app.

Returns:

value or null for none

setAppScheme

public VerifyAssertionResponse setAppScheme(java.lang.String appScheme)

The custom scheme used by mobile app.

Parameters:

appScheme - appScheme or null for none

getContext

public java.lang.String getContext()

The opaque value used by the client to maintain context info between the authentication request and the IDP callback.

Returns:

value or null for none

setContext

public VerifyAssertionResponse setContext(java.lang.String context)

The opaque value used by the client to maintain context info between the authentication request and the IDP callback.

Parameters:

context - context or null for none

getDateOfBirth

public java.lang.String getDateOfBirth()

The birth date of the IdP account.

Returns:

value or null for none

setDateOfBirth

public VerifyAssertionResponse setDateOfBirth(java.lang.String dateOfBirth)

The birth date of the IdP account.

Parameters:

dateOfBirth - dateOfBirth or null for none

getDisplayName

public java.lang.String getDisplayName()

The display name of the user.

Returns:

value or null for none

setDisplayName

public VerifyAssertionResponse setDisplayName(java.lang.String displayName)

The display name of the user.

Parameters:

displayName - displayName or null for none

getEmail

public java.lang.String getEmail()

The email returned by the IdP. NOTE: The federated login user may not own the email.

Returns:

value or null for none

setEmail

public VerifyAssertionResponse setEmail(java.lang.String email)

The email returned by the IdP. NOTE: The federated login user may not own the email.

Parameters:

email - email or null for none

getEmailRecycled

public java.lang.Boolean getEmailRecycled()

It's true if the email is recycled.

Returns:

value or null for none

setEmailRecycled

public VerifyAssertionResponse setEmailRecycled(java.lang.Boolean emailRecycled)

It's true if the email is recycled.

Parameters:

emailRecycled - emailRecycled or null for none

getEmailVerified

public java.lang.Boolean getEmailVerified()

The value is true if the IDP is also the email provider. It means the user owns the email.

Returns:

value or null for none

setEmailVerified

public VerifyAssertionResponse setEmailVerified(java.lang.Boolean emailVerified)

The value is true if the IDP is also the email provider. It means the user owns the email.

Parameters:

emailVerified - emailVerified or null for none

getErrorMessage

public java.lang.String getErrorMessage()

Client error code.

Returns:

value or null for none

setErrorMessage

public VerifyAssertionResponse setErrorMessage(java.lang.String errorMessage)

Client error code.

Parameters:

errorMessage - errorMessage or null for none

getExpiresIn

public java.lang.Long getExpiresIn()

If idToken is STS id token, then this field will be expiration time of STS id token in seconds.

Returns:

value or null for none

setExpiresIn

public VerifyAssertionResponse setExpiresIn(java.lang.Long expiresIn)

If idToken is STS id token, then this field will be expiration time of STS id token in seconds.

Parameters:

expiresIn - expiresIn or null for none

getFederatedId

public java.lang.String getFederatedId()

The unique ID identifies the IdP account.

Returns:

value or null for none

setFederatedId

public VerifyAssertionResponse setFederatedId(java.lang.String federatedId)

The unique ID identifies the IdP account.

Parameters:

federatedId - federatedId or null for none

getFirstName

public java.lang.String getFirstName()

The first name of the user.

Returns:

value or null for none

setFirstName

public VerifyAssertionResponse setFirstName(java.lang.String firstName)

The first name of the user.

Parameters:

firstName - firstName or null for none

getFullName

public java.lang.String getFullName()

The full name of the user.

Returns:

value or null for none

setFullName

public VerifyAssertionResponse setFullName(java.lang.String fullName)

The full name of the user.

Parameters:

fullName - fullName or null for none

getIdToken

public java.lang.String getIdToken()

The ID token.

Returns:

value or null for none

setIdToken

public VerifyAssertionResponse setIdToken(java.lang.String idToken)

The ID token.

Parameters:

idToken - idToken or null for none

getInputEmail

public java.lang.String getInputEmail()

It's the identifier param in the createAuthUri request if the identifier is an email. It can be used to check whether the user input email is different from the asserted email.

Returns:

value or null for none

setInputEmail

public VerifyAssertionResponse setInputEmail(java.lang.String inputEmail)

It's the identifier param in the createAuthUri request if the identifier is an email. It can be used to check whether the user input email is different from the asserted email.

Parameters:

inputEmail - inputEmail or null for none

getIsNewUser

public java.lang.Boolean getIsNewUser()

True if it's a new user sign-in, false if it's a returning user.

Returns:

value or null for none

setIsNewUser

public VerifyAssertionResponse setIsNewUser(java.lang.Boolean isNewUser)

True if it's a new user sign-in, false if it's a returning user.

Parameters:

isNewUser - isNewUser or null for none

getKind

public java.lang.String getKind()

The fixed string "identitytoolkit#VerifyAssertionResponse".

Returns:

value or null for none

setKind

public VerifyAssertionResponse setKind(java.lang.String kind)

The fixed string "identitytoolkit#VerifyAssertionResponse".

Parameters:

kind - kind or null for none

getLanguage

public java.lang.String getLanguage()

The language preference of the user.

Returns:

value or null for none

setLanguage

public VerifyAssertionResponse setLanguage(java.lang.String language)

The language preference of the user.

Parameters:

language - language or null for none

getLastName

public java.lang.String getLastName()

The last name of the user.

Returns:

value or null for none

setLastName

public VerifyAssertionResponse setLastName(java.lang.String lastName)

The last name of the user.

Parameters:

lastName - lastName or null for none

getLocalId

public java.lang.String getLocalId()

The RP local ID if it's already been mapped to the IdP account identified by the federated ID.

Returns:

value or null for none

setLocalId

public VerifyAssertionResponse setLocalId(java.lang.String localId)

The RP local ID if it's already been mapped to the IdP account identified by the federated ID.

Parameters:

localId - localId or null for none

getNeedConfirmation

public java.lang.Boolean getNeedConfirmation()

Whether the assertion is from a non-trusted IDP and need account linking confirmation.

Returns:

value or null for none

setNeedConfirmation

public VerifyAssertionResponse setNeedConfirmation(java.lang.Boolean needConfirmation)

Whether the assertion is from a non-trusted IDP and need account linking confirmation.

Parameters:

needConfirmation - needConfirmation or null for none

getNeedEmail

public java.lang.Boolean getNeedEmail()

Whether need client to supply email to complete the federated login flow.

Returns:

value or null for none

setNeedEmail

public VerifyAssertionResponse setNeedEmail(java.lang.Boolean needEmail)

Whether need client to supply email to complete the federated login flow.

Parameters:

needEmail - needEmail or null for none

getNickName

public java.lang.String getNickName()

The nick name of the user.

Returns:

value or null for none

setNickName

public VerifyAssertionResponse setNickName(java.lang.String nickName)

The nick name of the user.

Parameters:

nickName - nickName or null for none

getOauthAccessToken

public java.lang.String getOauthAccessToken()

The OAuth2 access token.

Returns:

value or null for none

setOauthAccessToken

public VerifyAssertionResponse setOauthAccessToken(java.lang.String oauthAccessToken)

The OAuth2 access token.

Parameters:

oauthAccessToken - oauthAccessToken or null for none

getOauthAuthorizationCode

public java.lang.String getOauthAuthorizationCode()

The OAuth2 authorization code.

Returns:

value or null for none

setOauthAuthorizationCode

public VerifyAssertionResponse setOauthAuthorizationCode(java.lang.String oauthAuthorizationCode)

The OAuth2 authorization code.

Parameters:

oauthAuthorizationCode - oauthAuthorizationCode or null for none

getOauthExpireIn

public java.lang.Integer getOauthExpireIn()

The lifetime in seconds of the OAuth2 access token.

Returns:

value or null for none

setOauthExpireIn

public VerifyAssertionResponse setOauthExpireIn(java.lang.Integer oauthExpireIn)

The lifetime in seconds of the OAuth2 access token.

Parameters:

oauthExpireIn - oauthExpireIn or null for none

getOauthIdToken

public java.lang.String getOauthIdToken()

The OIDC id token.

Returns:

value or null for none

setOauthIdToken

public VerifyAssertionResponse setOauthIdToken(java.lang.String oauthIdToken)

The OIDC id token.

Parameters:

oauthIdToken - oauthIdToken or null for none

getOauthRequestToken

public java.lang.String getOauthRequestToken()

The user approved request token for the OpenID OAuth extension.

Returns:

value or null for none

setOauthRequestToken

public VerifyAssertionResponse setOauthRequestToken(java.lang.String oauthRequestToken)

The user approved request token for the OpenID OAuth extension.

Parameters:

oauthRequestToken - oauthRequestToken or null for none

getOauthScope

public java.lang.String getOauthScope()

The scope for the OpenID OAuth extension.

Returns:

value or null for none

setOauthScope

public VerifyAssertionResponse setOauthScope(java.lang.String oauthScope)

The scope for the OpenID OAuth extension.

Parameters:

oauthScope - oauthScope or null for none

getOauthTokenSecret

public java.lang.String getOauthTokenSecret()

The OAuth1 access token secret.

Returns:

value or null for none

setOauthTokenSecret

public VerifyAssertionResponse setOauthTokenSecret(java.lang.String oauthTokenSecret)

The OAuth1 access token secret.

Parameters:

oauthTokenSecret - oauthTokenSecret or null for none

getOriginalEmail

public java.lang.String getOriginalEmail()

The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email.

Returns:

value or null for none

setOriginalEmail

public VerifyAssertionResponse setOriginalEmail(java.lang.String originalEmail)

The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email.

Parameters:

originalEmail - originalEmail or null for none

getPhotoUrl

public java.lang.String getPhotoUrl()

The URI of the public accessible profiel picture.

Returns:

value or null for none

setPhotoUrl

public VerifyAssertionResponse setPhotoUrl(java.lang.String photoUrl)

The URI of the public accessible profiel picture.

Parameters:

photoUrl - photoUrl or null for none

getProviderId

public java.lang.String getProviderId()

The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. If the "providerId" param is set to OpenID OP identifer other than the whilte listed IdPs the OP identifier is returned. If the "identifier" param is federated ID in the createAuthUri request. The domain part of the federated ID is returned.

Returns:

value or null for none

setProviderId

public VerifyAssertionResponse setProviderId(java.lang.String providerId)

The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. If the "providerId" param is set to OpenID OP identifer other than the whilte listed IdPs the OP identifier is returned. If the "identifier" param is federated ID in the createAuthUri request. The domain part of the federated ID is returned.

Parameters:

providerId - providerId or null for none

getRawUserInfo

public java.lang.String getRawUserInfo()

Raw IDP-returned user info.

Returns:

value or null for none

setRawUserInfo

public VerifyAssertionResponse setRawUserInfo(java.lang.String rawUserInfo)

Raw IDP-returned user info.

Parameters:

rawUserInfo - rawUserInfo or null for none

getRefreshToken

public java.lang.String getRefreshToken()

If idToken is STS id token, then this field will be refresh token.

Returns:

value or null for none

setRefreshToken

public VerifyAssertionResponse setRefreshToken(java.lang.String refreshToken)

If idToken is STS id token, then this field will be refresh token.

Parameters:

refreshToken - refreshToken or null for none

getScreenName

public java.lang.String getScreenName()

The screen_name of a Twitter user or the login name at Github.

Returns:

value or null for none

setScreenName

public VerifyAssertionResponse setScreenName(java.lang.String screenName)

The screen_name of a Twitter user or the login name at Github.

Parameters:

screenName - screenName or null for none

getTimeZone

public java.lang.String getTimeZone()

The timezone of the user.

Returns:

value or null for none

setTimeZone

public VerifyAssertionResponse setTimeZone(java.lang.String timeZone)

The timezone of the user.

Parameters:

timeZone - timeZone or null for none

getVerifiedProvider

public java.util.List<java.lang.String> getVerifiedProvider()

When action is 'map', contains the idps which can be used for confirmation.

Returns:

value or null for none

setVerifiedProvider

public VerifyAssertionResponse setVerifiedProvider(java.util.List<java.lang.String> verifiedProvider)

When action is 'map', contains the idps which can be used for confirmation.

Parameters:

verifiedProvider - verifiedProvider or null for none

set

public VerifyAssertionResponse set(java.lang.String fieldName,
                                   java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public VerifyAssertionResponse clone()

Overrides:

clone in class com.google.api.client.json.GenericJson