com.google.api.services.identitytoolkit.model

Class IdentitytoolkitRelyingpartyCreateAuthUriRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class IdentitytoolkitRelyingpartyCreateAuthUriRequest
extends GenericJson

Request to get the IDP authentication URL.

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

Method Summary

Modifier and Type	Method and Description
IdentitytoolkitRelyingpartyCreateAuthUriRequest	clone()
String	getAppId() The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.
String	getAuthFlowType() Explicitly specify the auth flow type.
String	getClientId() The relying party OAuth client ID.
String	getContext() The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
String	getContinueUri() The URI to which the IDP redirects the user after the federated login flow.
Map<String,String>	getCustomParameter() The query parameter that client can customize by themselves in auth url.
String	getHostedDomain() The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts.
String	getIdentifier() The email or federated ID of the user.
String	getOauthConsumerKey() The developer's consumer key for OpenId OAuth Extension
String	getOauthScope() Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant
String	getOpenidRealm() Optional realm for OpenID protocol.
String	getOtaApp() The native app package for OTA installation.
String	getProviderId() The IdP ID.
String	getSessionId() The session_id passed by client.
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.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	set(String fieldName, Object value)
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setAppId(String appId) The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setAuthFlowType(String authFlowType) Explicitly specify the auth flow type.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setClientId(String clientId) The relying party OAuth client ID.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setContext(String context) The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setContinueUri(String continueUri) The URI to which the IDP redirects the user after the federated login flow.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setCustomParameter(Map<String,String> customParameter) The query parameter that client can customize by themselves in auth url.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setHostedDomain(String hostedDomain) The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setIdentifier(String identifier) The email or federated ID of the user.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setOauthConsumerKey(String oauthConsumerKey) The developer's consumer key for OpenId OAuth Extension
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setOauthScope(String oauthScope) Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setOpenidRealm(String openidRealm) Optional realm for OpenID protocol.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setOtaApp(String otaApp) The native app package for OTA installation.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setProviderId(String providerId) The IdP ID.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	setSessionId(String sessionId) The session_id passed by client.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	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.
IdentitytoolkitRelyingpartyCreateAuthUriRequest	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

IdentitytoolkitRelyingpartyCreateAuthUriRequest

public IdentitytoolkitRelyingpartyCreateAuthUriRequest()

Method Detail

getAppId

public String getAppId()

The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.

Returns:

value or null for none

setAppId

public IdentitytoolkitRelyingpartyCreateAuthUriRequest setAppId(String appId)

The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.

Parameters:

appId - appId or null for none

getAuthFlowType

public String getAuthFlowType()

Explicitly specify the auth flow type. Currently only support "CODE_FLOW" type. The field is only used for Google provider.

Returns:

value or null for none

setAuthFlowType

public IdentitytoolkitRelyingpartyCreateAuthUriRequest setAuthFlowType(String authFlowType)

Explicitly specify the auth flow type. Currently only support "CODE_FLOW" type. The field is only used for Google provider.

Parameters:

authFlowType - authFlowType or null for none

getClientId

public String getClientId()

The relying party OAuth client ID.

Returns:

value or null for none

setClientId

public IdentitytoolkitRelyingpartyCreateAuthUriRequest setClientId(String clientId)

The relying party OAuth client ID.

Parameters:

clientId - clientId or null for none

getContext

public 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 IdentitytoolkitRelyingpartyCreateAuthUriRequest setContext(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

getContinueUri

public String getContinueUri()

The URI to which the IDP redirects the user after the federated login flow.

Returns:

value or null for none

setContinueUri

public IdentitytoolkitRelyingpartyCreateAuthUriRequest setContinueUri(String continueUri)

The URI to which the IDP redirects the user after the federated login flow.

Parameters:

continueUri - continueUri or null for none

getCustomParameter

public Map<String,String> getCustomParameter()

The query parameter that client can customize by themselves in auth url. The following parameters are reserved for server so that they cannot be customized by clients: client_id, response_type, scope, redirect_uri, state, oauth_token.

Returns:

value or null for none

setCustomParameter

public IdentitytoolkitRelyingpartyCreateAuthUriRequest setCustomParameter(Map<String,String> customParameter)

The query parameter that client can customize by themselves in auth url. The following parameters are reserved for server so that they cannot be customized by clients: client_id, response_type, scope, redirect_uri, state, oauth_token.

Parameters:

customParameter - customParameter or null for none

getHostedDomain

public String getHostedDomain()

The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts.

Returns:

value or null for none

setHostedDomain

public IdentitytoolkitRelyingpartyCreateAuthUriRequest setHostedDomain(String hostedDomain)

The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts.

Parameters:

hostedDomain - hostedDomain or null for none

getIdentifier

public String getIdentifier()

The email or federated ID of the user.

Returns:

value or null for none

setIdentifier

public IdentitytoolkitRelyingpartyCreateAuthUriRequest setIdentifier(String identifier)

The email or federated ID of the user.

Parameters:

identifier - identifier or null for none

getOauthConsumerKey

public String getOauthConsumerKey()

The developer's consumer key for OpenId OAuth Extension

Returns:

value or null for none

setOauthConsumerKey

public IdentitytoolkitRelyingpartyCreateAuthUriRequest setOauthConsumerKey(String oauthConsumerKey)

The developer's consumer key for OpenId OAuth Extension

Parameters:

oauthConsumerKey - oauthConsumerKey or null for none

getOauthScope

public String getOauthScope()

Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant

Returns:

value or null for none

setOauthScope

public IdentitytoolkitRelyingpartyCreateAuthUriRequest setOauthScope(String oauthScope)

Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant

Parameters:

oauthScope - oauthScope or null for none

getOpenidRealm

public String getOpenidRealm()

Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set.

Returns:

value or null for none

setOpenidRealm

public IdentitytoolkitRelyingpartyCreateAuthUriRequest setOpenidRealm(String openidRealm)

Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set.

Parameters:

openidRealm - openidRealm or null for none

getOtaApp

public String getOtaApp()

The native app package for OTA installation.

Returns:

value or null for none

setOtaApp

public IdentitytoolkitRelyingpartyCreateAuthUriRequest setOtaApp(String otaApp)

The native app package for OTA installation.

Parameters:

otaApp - otaApp or null for none

getProviderId

public 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. For other OpenID IdPs it's the OP identifier.

Returns:

value or null for none

setProviderId

public IdentitytoolkitRelyingpartyCreateAuthUriRequest setProviderId(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. For other OpenID IdPs it's the OP identifier.

Parameters:

providerId - providerId or null for none

getSessionId

public String getSessionId()

The session_id passed by client.

Returns:

value or null for none

setSessionId

public IdentitytoolkitRelyingpartyCreateAuthUriRequest setSessionId(String sessionId)

The session_id passed by client.

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 IdentitytoolkitRelyingpartyCreateAuthUriRequest 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 IdentitytoolkitRelyingpartyCreateAuthUriRequest setTenantProjectNumber(BigInteger tenantProjectNumber)

Tenant project number to be used for idp discovery.

Parameters:

tenantProjectNumber - tenantProjectNumber or null for none

set

public IdentitytoolkitRelyingpartyCreateAuthUriRequest set(String fieldName,
                                                           Object value)

Overrides:

set in class GenericJson

clone

public IdentitytoolkitRelyingpartyCreateAuthUriRequest clone()

Overrides:

clone in class GenericJson