#include <identitytoolkit_relyingparty_create_auth_uri_request.h>
Request to get the IDP authentication URL.
◆ IdentitytoolkitRelyingpartyCreateAuthUriRequest() [1/2]
| google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::IdentitytoolkitRelyingpartyCreateAuthUriRequest |
( |
const Json::Value & |
storage | ) |
|
|
explicit |
Standard constructor for an immutable data object instance.
- Parameters
-
| [in] | storage | The underlying data storage for this instance. |
◆ IdentitytoolkitRelyingpartyCreateAuthUriRequest() [2/2]
| google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::IdentitytoolkitRelyingpartyCreateAuthUriRequest |
( |
Json::Value * |
storage | ) |
|
|
explicit |
Standard constructor for a mutable data object instance.
- Parameters
-
| [in] | storage | The underlying data storage for this instance. |
◆ ~IdentitytoolkitRelyingpartyCreateAuthUriRequest()
| google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::~IdentitytoolkitRelyingpartyCreateAuthUriRequest |
( |
| ) |
|
|
virtual |
◆ clear_app_id()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_app_id |
( |
| ) |
|
|
inline |
Clears the 'appId' attribute.
◆ clear_auth_flow_type()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_auth_flow_type |
( |
| ) |
|
|
inline |
Clears the 'authFlowType' attribute.
◆ clear_client_id()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_client_id |
( |
| ) |
|
|
inline |
Clears the 'clientId' attribute.
◆ clear_context()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_context |
( |
| ) |
|
|
inline |
Clears the 'context' attribute.
◆ clear_continue_uri()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_continue_uri |
( |
| ) |
|
|
inline |
Clears the 'continueUri' attribute.
◆ clear_custom_parameter()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_custom_parameter |
( |
| ) |
|
|
inline |
Clears the 'customParameter' attribute.
◆ clear_hosted_domain()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_hosted_domain |
( |
| ) |
|
|
inline |
Clears the 'hostedDomain' attribute.
◆ clear_identifier()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_identifier |
( |
| ) |
|
|
inline |
Clears the 'identifier' attribute.
◆ clear_oauth_consumer_key()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_oauth_consumer_key |
( |
| ) |
|
|
inline |
Clears the 'oauthConsumerKey' attribute.
◆ clear_oauth_scope()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_oauth_scope |
( |
| ) |
|
|
inline |
Clears the 'oauthScope' attribute.
◆ clear_openid_realm()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_openid_realm |
( |
| ) |
|
|
inline |
Clears the 'openidRealm' attribute.
◆ clear_ota_app()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_ota_app |
( |
| ) |
|
|
inline |
Clears the 'otaApp' attribute.
◆ clear_provider_id()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_provider_id |
( |
| ) |
|
|
inline |
Clears the 'providerId' attribute.
◆ clear_session_id()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_session_id |
( |
| ) |
|
|
inline |
Clears the 'sessionId' attribute.
◆ clear_tenant_id()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_tenant_id |
( |
| ) |
|
|
inline |
Clears the 'tenantId' attribute.
◆ clear_tenant_project_number()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::clear_tenant_project_number |
( |
| ) |
|
|
inline |
Clears the 'tenantProjectNumber' attribute.
◆ get_app_id()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_app_id |
( |
| ) |
const |
|
inline |
Get the value of the 'appId' attribute.
◆ get_auth_flow_type()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_auth_flow_type |
( |
| ) |
const |
|
inline |
Get the value of the 'authFlowType' attribute.
◆ get_client_id()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_client_id |
( |
| ) |
const |
|
inline |
Get the value of the 'clientId' attribute.
◆ get_context()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_context |
( |
| ) |
const |
|
inline |
Get the value of the 'context' attribute.
◆ get_continue_uri()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_continue_uri |
( |
| ) |
const |
|
inline |
Get the value of the 'continueUri' attribute.
◆ get_custom_parameter()
| const client::JsonCppAssociativeArray<string > google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_custom_parameter |
( |
| ) |
const |
|
inline |
Get a reference to the value of the 'customParameter' attribute.
◆ get_hosted_domain()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_hosted_domain |
( |
| ) |
const |
|
inline |
Get the value of the 'hostedDomain' attribute.
◆ get_identifier()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_identifier |
( |
| ) |
const |
|
inline |
Get the value of the 'identifier' attribute.
◆ get_oauth_consumer_key()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_oauth_consumer_key |
( |
| ) |
const |
|
inline |
Get the value of the 'oauthConsumerKey' attribute.
◆ get_oauth_scope()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_oauth_scope |
( |
| ) |
const |
|
inline |
Get the value of the 'oauthScope' attribute.
◆ get_openid_realm()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_openid_realm |
( |
| ) |
const |
|
inline |
Get the value of the 'openidRealm' attribute.
◆ get_ota_app()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_ota_app |
( |
| ) |
const |
|
inline |
Get the value of the 'otaApp' attribute.
◆ get_provider_id()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_provider_id |
( |
| ) |
const |
|
inline |
Get the value of the 'providerId' attribute.
◆ get_session_id()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_session_id |
( |
| ) |
const |
|
inline |
Get the value of the 'sessionId' attribute.
◆ get_tenant_id()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_tenant_id |
( |
| ) |
const |
|
inline |
Get the value of the 'tenantId' attribute.
◆ get_tenant_project_number()
| uint64 google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::get_tenant_project_number |
( |
| ) |
const |
|
inline |
Get the value of the 'tenantProjectNumber' attribute.
◆ GetTypeName()
| const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::GetTypeName |
( |
| ) |
const |
|
inline |
Returns a string denoting the type of this data object.
- Returns
google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreate AuthUriRequest
◆ has_app_id()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_app_id |
( |
| ) |
const |
|
inline |
Determine if the 'appId' attribute was set.
- Returns
- true if the '
appId' attribute was set.
◆ has_auth_flow_type()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_auth_flow_type |
( |
| ) |
const |
|
inline |
Determine if the 'authFlowType' attribute was set.
- Returns
- true if the '
authFlowType' attribute was set.
◆ has_client_id()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_client_id |
( |
| ) |
const |
|
inline |
Determine if the 'clientId' attribute was set.
- Returns
- true if the '
clientId' attribute was set.
◆ has_context()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_context |
( |
| ) |
const |
|
inline |
Determine if the 'context' attribute was set.
- Returns
- true if the '
context' attribute was set.
◆ has_continue_uri()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_continue_uri |
( |
| ) |
const |
|
inline |
Determine if the 'continueUri' attribute was set.
- Returns
- true if the '
continueUri' attribute was set.
◆ has_custom_parameter()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_custom_parameter |
( |
| ) |
const |
|
inline |
Determine if the 'customParameter' attribute was set.
- Returns
- true if the '
customParameter' attribute was set.
◆ has_hosted_domain()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_hosted_domain |
( |
| ) |
const |
|
inline |
Determine if the 'hostedDomain' attribute was set.
- Returns
- true if the '
hostedDomain' attribute was set.
◆ has_identifier()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_identifier |
( |
| ) |
const |
|
inline |
Determine if the 'identifier' attribute was set.
- Returns
- true if the '
identifier' attribute was set.
◆ has_oauth_consumer_key()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_oauth_consumer_key |
( |
| ) |
const |
|
inline |
Determine if the 'oauthConsumerKey' attribute was set.
- Returns
- true if the '
oauthConsumerKey' attribute was set.
◆ has_oauth_scope()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_oauth_scope |
( |
| ) |
const |
|
inline |
Determine if the 'oauthScope' attribute was set.
- Returns
- true if the '
oauthScope' attribute was set.
◆ has_openid_realm()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_openid_realm |
( |
| ) |
const |
|
inline |
Determine if the 'openidRealm' attribute was set.
- Returns
- true if the '
openidRealm' attribute was set.
◆ has_ota_app()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_ota_app |
( |
| ) |
const |
|
inline |
Determine if the 'otaApp' attribute was set.
- Returns
- true if the '
otaApp' attribute was set.
◆ has_provider_id()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_provider_id |
( |
| ) |
const |
|
inline |
Determine if the 'providerId' attribute was set.
- Returns
- true if the '
providerId' attribute was set.
◆ has_session_id()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_session_id |
( |
| ) |
const |
|
inline |
Determine if the 'sessionId' attribute was set.
- Returns
- true if the '
sessionId' attribute was set.
◆ has_tenant_id()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_tenant_id |
( |
| ) |
const |
|
inline |
Determine if the 'tenantId' attribute was set.
- Returns
- true if the '
tenantId' attribute was set.
◆ has_tenant_project_number()
| bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::has_tenant_project_number |
( |
| ) |
const |
|
inline |
Determine if the 'tenantProjectNumber' attribute was set.
- Returns
- true if the '
tenantProjectNumber' attribute was set.
◆ mutable_customParameter()
| client::JsonCppAssociativeArray<string > google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::mutable_customParameter |
( |
| ) |
|
|
inline |
Gets a reference to a mutable value of the 'customParameter' property.
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
- The result can be modified to change the attribute value.
◆ New()
Creates a new default instance.
- Returns
- Ownership is passed back to the caller.
◆ set_app_id()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_app_id |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'appId' attribute.
The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.
- Parameters
-
◆ set_auth_flow_type()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_auth_flow_type |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'authFlowType' attribute.
Explicitly specify the auth flow type. Currently only support "CODE_FLOW" type. The field is only used for Google provider.
- Parameters
-
◆ set_client_id()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_client_id |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'clientId' attribute.
The relying party OAuth client ID.
- Parameters
-
◆ set_context()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_context |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'context' attribute.
The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
- Parameters
-
◆ set_continue_uri()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_continue_uri |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'continueUri' attribute.
The URI to which the IDP redirects the user after the federated login flow.
- Parameters
-
◆ set_hosted_domain()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_hosted_domain |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'hostedDomain' attribute.
The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts.
- Parameters
-
◆ set_identifier()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_identifier |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'identifier' attribute.
The email or federated ID of the user.
- Parameters
-
◆ set_oauth_consumer_key()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_oauth_consumer_key |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'oauthConsumerKey' attribute.
The developer's consumer key for OpenId OAuth Extension.
- Parameters
-
◆ set_oauth_scope()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_oauth_scope |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'oauthScope' attribute.
Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant.
- Parameters
-
◆ set_openid_realm()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_openid_realm |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'openidRealm' attribute.
Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set.
- Parameters
-
◆ set_ota_app()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_ota_app |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'otaApp' attribute.
The native app package for OTA installation.
- Parameters
-
◆ set_provider_id()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_provider_id |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'providerId' attribute.
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
-
◆ set_session_id()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_session_id |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'sessionId' attribute.
The session_id passed by client.
- Parameters
-
◆ set_tenant_id()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_tenant_id |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'tenantId' attribute.
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
-
◆ set_tenant_project_number()
| void google_identitytoolkit_api::IdentitytoolkitRelyingpartyCreateAuthUriRequest::set_tenant_project_number |
( |
uint64 |
value | ) |
|
|
inline |
Change the 'tenantProjectNumber' attribute.
Tenant project number to be used for idp discovery.
- Parameters
-
The documentation for this class was generated from the following files: