identitytoolkit  v3
Public Member Functions | Static Public Member Functions | List of all members
google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest Class Reference

#include <identitytoolkit_relyingparty_verify_password_request.h>

Inheritance diagram for google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest:

Public Member Functions

 IdentitytoolkitRelyingpartyVerifyPasswordRequest (const Json::Value &storage)
 
 IdentitytoolkitRelyingpartyVerifyPasswordRequest (Json::Value *storage)
 
virtual ~IdentitytoolkitRelyingpartyVerifyPasswordRequest ()
 
const StringPiece GetTypeName () const
 
bool has_captcha_challenge () const
 
void clear_captcha_challenge ()
 
const StringPiece get_captcha_challenge () const
 
void set_captcha_challenge (const StringPiece &value)
 
bool has_captcha_response () const
 
void clear_captcha_response ()
 
const StringPiece get_captcha_response () const
 
void set_captcha_response (const StringPiece &value)
 
bool has_delegated_project_number () const
 
void clear_delegated_project_number ()
 
int64 get_delegated_project_number () const
 
void set_delegated_project_number (int64 value)
 
bool has_email () const
 
void clear_email ()
 
const StringPiece get_email () const
 
void set_email (const StringPiece &value)
 
bool has_id_token () const
 
void clear_id_token ()
 
const StringPiece get_id_token () const
 
void set_id_token (const StringPiece &value)
 
bool has_instance_id () const
 
void clear_instance_id ()
 
const StringPiece get_instance_id () const
 
void set_instance_id (const StringPiece &value)
 
bool has_password () const
 
void clear_password ()
 
const StringPiece get_password () const
 
void set_password (const StringPiece &value)
 
bool has_pending_id_token () const
 
void clear_pending_id_token ()
 
const StringPiece get_pending_id_token () const
 
void set_pending_id_token (const StringPiece &value)
 
bool has_return_secure_token () const
 
void clear_return_secure_token ()
 
bool get_return_secure_token () const
 
void set_return_secure_token (bool value)
 
bool has_tenant_id () const
 
void clear_tenant_id ()
 
const StringPiece get_tenant_id () const
 
void set_tenant_id (const StringPiece &value)
 
bool has_tenant_project_number () const
 
void clear_tenant_project_number ()
 
uint64 get_tenant_project_number () const
 
void set_tenant_project_number (uint64 value)
 

Static Public Member Functions

static IdentitytoolkitRelyingpartyVerifyPasswordRequestNew ()
 

Detailed Description

Request to verify the password.

Constructor & Destructor Documentation

◆ IdentitytoolkitRelyingpartyVerifyPasswordRequest() [1/2]

google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::IdentitytoolkitRelyingpartyVerifyPasswordRequest ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ IdentitytoolkitRelyingpartyVerifyPasswordRequest() [2/2]

google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::IdentitytoolkitRelyingpartyVerifyPasswordRequest ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~IdentitytoolkitRelyingpartyVerifyPasswordRequest()

google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::~IdentitytoolkitRelyingpartyVerifyPasswordRequest ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_captcha_challenge()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::clear_captcha_challenge ( )
inline

Clears the 'captchaChallenge' attribute.

◆ clear_captcha_response()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::clear_captcha_response ( )
inline

Clears the 'captchaResponse' attribute.

◆ clear_delegated_project_number()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::clear_delegated_project_number ( )
inline

Clears the 'delegatedProjectNumber' attribute.

◆ clear_email()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::clear_email ( )
inline

Clears the 'email' attribute.

◆ clear_id_token()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::clear_id_token ( )
inline

Clears the 'idToken' attribute.

◆ clear_instance_id()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::clear_instance_id ( )
inline

Clears the 'instanceId' attribute.

◆ clear_password()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::clear_password ( )
inline

Clears the 'password' attribute.

◆ clear_pending_id_token()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::clear_pending_id_token ( )
inline

Clears the 'pendingIdToken' attribute.

◆ clear_return_secure_token()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::clear_return_secure_token ( )
inline

Clears the 'returnSecureToken' attribute.

◆ clear_tenant_id()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::clear_tenant_id ( )
inline

Clears the 'tenantId' attribute.

◆ clear_tenant_project_number()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::clear_tenant_project_number ( )
inline

Clears the 'tenantProjectNumber' attribute.

◆ get_captcha_challenge()

const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::get_captcha_challenge ( ) const
inline

Get the value of the 'captchaChallenge' attribute.

◆ get_captcha_response()

const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::get_captcha_response ( ) const
inline

Get the value of the 'captchaResponse' attribute.

◆ get_delegated_project_number()

int64 google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::get_delegated_project_number ( ) const
inline

Get the value of the 'delegatedProjectNumber' attribute.

◆ get_email()

const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::get_email ( ) const
inline

Get the value of the 'email' attribute.

◆ get_id_token()

const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::get_id_token ( ) const
inline

Get the value of the 'idToken' attribute.

◆ get_instance_id()

const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::get_instance_id ( ) const
inline

Get the value of the 'instanceId' attribute.

◆ get_password()

const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::get_password ( ) const
inline

Get the value of the 'password' attribute.

◆ get_pending_id_token()

const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::get_pending_id_token ( ) const
inline

Get the value of the 'pendingIdToken' attribute.

◆ get_return_secure_token()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::get_return_secure_token ( ) const
inline

Get the value of the 'returnSecureToken' attribute.

◆ get_tenant_id()

const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::get_tenant_id ( ) const
inline

Get the value of the 'tenantId' attribute.

◆ get_tenant_project_number()

uint64 google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::get_tenant_project_number ( ) const
inline

Get the value of the 'tenantProjectNumber' attribute.

◆ GetTypeName()

const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerify PasswordRequest

◆ has_captcha_challenge()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::has_captcha_challenge ( ) const
inline

Determine if the 'captchaChallenge' attribute was set.

Returns
true if the 'captchaChallenge' attribute was set.

◆ has_captcha_response()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::has_captcha_response ( ) const
inline

Determine if the 'captchaResponse' attribute was set.

Returns
true if the 'captchaResponse' attribute was set.

◆ has_delegated_project_number()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::has_delegated_project_number ( ) const
inline

Determine if the 'delegatedProjectNumber' attribute was set.

Returns
true if the 'delegatedProjectNumber' attribute was set.

◆ has_email()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::has_email ( ) const
inline

Determine if the 'email' attribute was set.

Returns
true if the 'email' attribute was set.

◆ has_id_token()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::has_id_token ( ) const
inline

Determine if the 'idToken' attribute was set.

Returns
true if the 'idToken' attribute was set.

◆ has_instance_id()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::has_instance_id ( ) const
inline

Determine if the 'instanceId' attribute was set.

Returns
true if the 'instanceId' attribute was set.

◆ has_password()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::has_password ( ) const
inline

Determine if the 'password' attribute was set.

Returns
true if the 'password' attribute was set.

◆ has_pending_id_token()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::has_pending_id_token ( ) const
inline

Determine if the 'pendingIdToken' attribute was set.

Returns
true if the 'pendingIdToken' attribute was set.

◆ has_return_secure_token()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::has_return_secure_token ( ) const
inline

Determine if the 'returnSecureToken' attribute was set.

Returns
true if the 'returnSecureToken' attribute was set.

◆ has_tenant_id()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::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::IdentitytoolkitRelyingpartyVerifyPasswordRequest::has_tenant_project_number ( ) const
inline

Determine if the 'tenantProjectNumber' attribute was set.

Returns
true if the 'tenantProjectNumber' attribute was set.

◆ New()

IdentitytoolkitRelyingpartyVerifyPasswordRequest * google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_captcha_challenge()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::set_captcha_challenge ( const StringPiece &  value)
inline

Change the 'captchaChallenge' attribute.

The captcha challenge.

Parameters
[in]valueThe new value.

◆ set_captcha_response()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::set_captcha_response ( const StringPiece &  value)
inline

Change the 'captchaResponse' attribute.

Response to the captcha.

Parameters
[in]valueThe new value.

◆ set_delegated_project_number()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::set_delegated_project_number ( int64  value)
inline

Change the 'delegatedProjectNumber' attribute.

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

Parameters
[in]valueThe new value.

◆ set_email()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::set_email ( const StringPiece &  value)
inline

Change the 'email' attribute.

The email of the user.

Parameters
[in]valueThe new value.

◆ set_id_token()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::set_id_token ( const StringPiece &  value)
inline

Change the 'idToken' attribute.

The GITKit token of the authenticated user.

Parameters
[in]valueThe new value.

◆ set_instance_id()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::set_instance_id ( const StringPiece &  value)
inline

Change the 'instanceId' attribute.

Instance id token of the app.

Parameters
[in]valueThe new value.

◆ set_password()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::set_password ( const StringPiece &  value)
inline

Change the 'password' attribute.

The password inputed by the user.

Parameters
[in]valueThe new value.

◆ set_pending_id_token()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::set_pending_id_token ( const StringPiece &  value)
inline

Change the 'pendingIdToken' attribute.

The GITKit token for the non-trusted IDP, which is to be confirmed by the user.

Parameters
[in]valueThe new value.

◆ set_return_secure_token()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::set_return_secure_token ( bool  value)
inline

Change the 'returnSecureToken' attribute.

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

Parameters
[in]valueThe new value.

◆ set_tenant_id()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::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
[in]valueThe new value.

◆ set_tenant_project_number()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyPasswordRequest::set_tenant_project_number ( uint64  value)
inline

Change the 'tenantProjectNumber' attribute.

Tenant project number to be used for idp discovery.

Parameters
[in]valueThe new value.

The documentation for this class was generated from the following files: