com.google.api.services.identitytoolkit.model

Class IdentitytoolkitRelyingpartyVerifyAssertionRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.identitytoolkit.model.IdentitytoolkitRelyingpartyVerifyAssertionRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class IdentitytoolkitRelyingpartyVerifyAssertionRequest
extends GenericJson

Request to verify 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

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
IdentitytoolkitRelyingpartyVerifyAssertionRequest()

Method Summary

Modifier and Type	Method and Description
IdentitytoolkitRelyingpartyVerifyAssertionRequest	clone()
Boolean	getAutoCreate() When it's true, automatically creates a new account if the user doesn't exist.
Long	getDelegatedProjectNumber() GCP project number of the requesting delegated app.
String	getIdToken() The GITKit token of the authenticated user.
String	getInstanceId() Instance id token of the app.
String	getPendingIdToken() The GITKit token for the non-trusted IDP pending to be confirmed by the user.
String	getPostBody() The post body if the request is a HTTP POST.
String	getRequestUri() The URI to which the IDP redirects the user back.
Boolean	getReturnIdpCredential() Whether return 200 and IDP credential rather than throw exception when federated id is already linked.
Boolean	getReturnRefreshToken() Whether to return refresh tokens.
Boolean	getReturnSecureToken() Whether return sts id token and refresh token instead of gitkit token.
String	getSessionId() Session ID, which should match the one in previous createAuthUri request.
String	getTenantId() For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from.
BigInteger	getTenantProjectNumber() Tenant project number to be used for idp discovery.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	set(String fieldName, Object value)
IdentitytoolkitRelyingpartyVerifyAssertionRequest	setAutoCreate(Boolean autoCreate) When it's true, automatically creates a new account if the user doesn't exist.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	setDelegatedProjectNumber(Long delegatedProjectNumber) GCP project number of the requesting delegated app.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	setIdToken(String idToken) The GITKit token of the authenticated user.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	setInstanceId(String instanceId) Instance id token of the app.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	setPendingIdToken(String pendingIdToken) The GITKit token for the non-trusted IDP pending to be confirmed by the user.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	setPostBody(String postBody) The post body if the request is a HTTP POST.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	setRequestUri(String requestUri) The URI to which the IDP redirects the user back.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	setReturnIdpCredential(Boolean returnIdpCredential) Whether return 200 and IDP credential rather than throw exception when federated id is already linked.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	setReturnRefreshToken(Boolean returnRefreshToken) Whether to return refresh tokens.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	setReturnSecureToken(Boolean returnSecureToken) Whether return sts id token and refresh token instead of gitkit token.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	setSessionId(String sessionId) Session ID, which should match the one in previous createAuthUri request.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	setTenantId(String tenantId) For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	setTenantProjectNumber(BigInteger tenantProjectNumber) Tenant project number to be used for idp discovery.

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

IdentitytoolkitRelyingpartyVerifyAssertionRequest

public IdentitytoolkitRelyingpartyVerifyAssertionRequest()

Method Detail

getAutoCreate

public Boolean getAutoCreate()

When it's true, automatically creates a new account if the user doesn't exist. When it's false, allows existing user to sign in normally and throws exception if the user doesn't exist.

Returns:

value or null for none

setAutoCreate

public IdentitytoolkitRelyingpartyVerifyAssertionRequest setAutoCreate(Boolean autoCreate)

When it's true, automatically creates a new account if the user doesn't exist. When it's false, allows existing user to sign in normally and throws exception if the user doesn't exist.

Parameters:

autoCreate - autoCreate or null for none

getDelegatedProjectNumber

public Long getDelegatedProjectNumber()

GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.

Returns:

value or null for none

setDelegatedProjectNumber

public IdentitytoolkitRelyingpartyVerifyAssertionRequest setDelegatedProjectNumber(Long delegatedProjectNumber)

GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.

Parameters:

delegatedProjectNumber - delegatedProjectNumber or null for none

getIdToken

public String getIdToken()

The GITKit token of the authenticated user.

Returns:

value or null for none

setIdToken

public IdentitytoolkitRelyingpartyVerifyAssertionRequest setIdToken(String idToken)

The GITKit token of the authenticated user.

Parameters:

idToken - idToken or null for none

getInstanceId

public String getInstanceId()

Instance id token of the app.

Returns:

value or null for none

setInstanceId

public IdentitytoolkitRelyingpartyVerifyAssertionRequest setInstanceId(String instanceId)

Instance id token of the app.

Parameters:

instanceId - instanceId or null for none

getPendingIdToken

public String getPendingIdToken()

The GITKit token for the non-trusted IDP pending to be confirmed by the user.

Returns:

value or null for none

setPendingIdToken

public IdentitytoolkitRelyingpartyVerifyAssertionRequest setPendingIdToken(String pendingIdToken)

The GITKit token for the non-trusted IDP pending to be confirmed by the user.

Parameters:

pendingIdToken - pendingIdToken or null for none

getPostBody

public String getPostBody()

The post body if the request is a HTTP POST.

Returns:

value or null for none

setPostBody

public IdentitytoolkitRelyingpartyVerifyAssertionRequest setPostBody(String postBody)

The post body if the request is a HTTP POST.

Parameters:

postBody - postBody or null for none

getRequestUri

public String getRequestUri()

The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP.

Returns:

value or null for none

setRequestUri

public IdentitytoolkitRelyingpartyVerifyAssertionRequest setRequestUri(String requestUri)

The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP.

Parameters:

requestUri - requestUri or null for none

getReturnIdpCredential

public Boolean getReturnIdpCredential()

Whether return 200 and IDP credential rather than throw exception when federated id is already linked.

Returns:

value or null for none

setReturnIdpCredential

public IdentitytoolkitRelyingpartyVerifyAssertionRequest setReturnIdpCredential(Boolean returnIdpCredential)

Whether return 200 and IDP credential rather than throw exception when federated id is already linked.

Parameters:

returnIdpCredential - returnIdpCredential or null for none

getReturnRefreshToken

public Boolean getReturnRefreshToken()

Whether to return refresh tokens.

Returns:

value or null for none

setReturnRefreshToken

public IdentitytoolkitRelyingpartyVerifyAssertionRequest setReturnRefreshToken(Boolean returnRefreshToken)

Whether to return refresh tokens.

Parameters:

returnRefreshToken - returnRefreshToken or null for none

getReturnSecureToken

public Boolean getReturnSecureToken()

Whether return sts id token and refresh token instead of gitkit token.

Returns:

value or null for none

setReturnSecureToken

public IdentitytoolkitRelyingpartyVerifyAssertionRequest setReturnSecureToken(Boolean returnSecureToken)

Whether return sts id token and refresh token instead of gitkit token.

Parameters:

returnSecureToken - returnSecureToken or null for none

getSessionId

public String getSessionId()

Session ID, which should match the one in previous createAuthUri request.

Returns:

value or null for none

setSessionId

public IdentitytoolkitRelyingpartyVerifyAssertionRequest setSessionId(String sessionId)

Session ID, which should match the one in previous createAuthUri request.

Parameters:

sessionId - sessionId or null for none

getTenantId

public String getTenantId()

For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from.

Returns:

value or null for none

setTenantId

public IdentitytoolkitRelyingpartyVerifyAssertionRequest setTenantId(String tenantId)

For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from.

Parameters:

tenantId - tenantId or null for none

getTenantProjectNumber

public BigInteger getTenantProjectNumber()

Tenant project number to be used for idp discovery.

Returns:

value or null for none

setTenantProjectNumber

public IdentitytoolkitRelyingpartyVerifyAssertionRequest setTenantProjectNumber(BigInteger tenantProjectNumber)

Tenant project number to be used for idp discovery.

Parameters:

tenantProjectNumber - tenantProjectNumber or null for none

set

public IdentitytoolkitRelyingpartyVerifyAssertionRequest set(String fieldName,
                                                             Object value)

Overrides:

set in class GenericJson

clone

public IdentitytoolkitRelyingpartyVerifyAssertionRequest clone()

Overrides:

clone in class GenericJson