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

#include <identitytoolkit_relyingparty_verify_assertion_request.h>

Inheritance diagram for google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest:

Public Member Functions

 IdentitytoolkitRelyingpartyVerifyAssertionRequest (const Json::Value &storage)
 
 IdentitytoolkitRelyingpartyVerifyAssertionRequest (Json::Value *storage)
 
virtual ~IdentitytoolkitRelyingpartyVerifyAssertionRequest ()
 
const StringPiece GetTypeName () const
 
bool has_auto_create () const
 
void clear_auto_create ()
 
bool get_auto_create () const
 
void set_auto_create (bool 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_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_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_post_body () const
 
void clear_post_body ()
 
const StringPiece get_post_body () const
 
void set_post_body (const StringPiece &value)
 
bool has_request_uri () const
 
void clear_request_uri ()
 
const StringPiece get_request_uri () const
 
void set_request_uri (const StringPiece &value)
 
bool has_return_idp_credential () const
 
void clear_return_idp_credential ()
 
bool get_return_idp_credential () const
 
void set_return_idp_credential (bool value)
 
bool has_return_refresh_token () const
 
void clear_return_refresh_token ()
 
bool get_return_refresh_token () const
 
void set_return_refresh_token (bool 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_session_id () const
 
void clear_session_id ()
 
const StringPiece get_session_id () const
 
void set_session_id (const StringPiece &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 IdentitytoolkitRelyingpartyVerifyAssertionRequestNew ()
 

Detailed Description

Request to verify the IDP assertion.

Constructor & Destructor Documentation

◆ IdentitytoolkitRelyingpartyVerifyAssertionRequest() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ IdentitytoolkitRelyingpartyVerifyAssertionRequest() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~IdentitytoolkitRelyingpartyVerifyAssertionRequest()

google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::~IdentitytoolkitRelyingpartyVerifyAssertionRequest ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_auto_create()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::clear_auto_create ( )
inline

Clears the 'autoCreate' attribute.

◆ clear_delegated_project_number()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::clear_delegated_project_number ( )
inline

Clears the 'delegatedProjectNumber' attribute.

◆ clear_id_token()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::clear_id_token ( )
inline

Clears the 'idToken' attribute.

◆ clear_instance_id()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::clear_instance_id ( )
inline

Clears the 'instanceId' attribute.

◆ clear_pending_id_token()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::clear_pending_id_token ( )
inline

Clears the 'pendingIdToken' attribute.

◆ clear_post_body()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::clear_post_body ( )
inline

Clears the 'postBody' attribute.

◆ clear_request_uri()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::clear_request_uri ( )
inline

Clears the 'requestUri' attribute.

◆ clear_return_idp_credential()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::clear_return_idp_credential ( )
inline

Clears the 'returnIdpCredential' attribute.

◆ clear_return_refresh_token()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::clear_return_refresh_token ( )
inline

Clears the 'returnRefreshToken' attribute.

◆ clear_return_secure_token()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::clear_return_secure_token ( )
inline

Clears the 'returnSecureToken' attribute.

◆ clear_session_id()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::clear_session_id ( )
inline

Clears the 'sessionId' attribute.

◆ clear_tenant_id()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::clear_tenant_id ( )
inline

Clears the 'tenantId' attribute.

◆ clear_tenant_project_number()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::clear_tenant_project_number ( )
inline

Clears the 'tenantProjectNumber' attribute.

◆ get_auto_create()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::get_auto_create ( ) const
inline

Get the value of the 'autoCreate' attribute.

◆ get_delegated_project_number()

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

Get the value of the 'delegatedProjectNumber' attribute.

◆ get_id_token()

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

Get the value of the 'idToken' attribute.

◆ get_instance_id()

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

Get the value of the 'instanceId' attribute.

◆ get_pending_id_token()

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

Get the value of the 'pendingIdToken' attribute.

◆ get_post_body()

const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::get_post_body ( ) const
inline

Get the value of the 'postBody' attribute.

◆ get_request_uri()

const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::get_request_uri ( ) const
inline

Get the value of the 'requestUri' attribute.

◆ get_return_idp_credential()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::get_return_idp_credential ( ) const
inline

Get the value of the 'returnIdpCredential' attribute.

◆ get_return_refresh_token()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::get_return_refresh_token ( ) const
inline

Get the value of the 'returnRefreshToken' attribute.

◆ get_return_secure_token()

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

Get the value of the 'returnSecureToken' attribute.

◆ get_session_id()

const StringPiece google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::get_session_id ( ) const
inline

Get the value of the 'sessionId' attribute.

◆ get_tenant_id()

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

Get the value of the 'tenantId' attribute.

◆ get_tenant_project_number()

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

Get the value of the 'tenantProjectNumber' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerify AssertionRequest

◆ has_auto_create()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::has_auto_create ( ) const
inline

Determine if the 'autoCreate' attribute was set.

Returns
true if the 'autoCreate' attribute was set.

◆ has_delegated_project_number()

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

Determine if the 'delegatedProjectNumber' attribute was set.

Returns
true if the 'delegatedProjectNumber' attribute was set.

◆ has_id_token()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::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::IdentitytoolkitRelyingpartyVerifyAssertionRequest::has_instance_id ( ) const
inline

Determine if the 'instanceId' attribute was set.

Returns
true if the 'instanceId' attribute was set.

◆ has_pending_id_token()

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

Determine if the 'pendingIdToken' attribute was set.

Returns
true if the 'pendingIdToken' attribute was set.

◆ has_post_body()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::has_post_body ( ) const
inline

Determine if the 'postBody' attribute was set.

Returns
true if the 'postBody' attribute was set.

◆ has_request_uri()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::has_request_uri ( ) const
inline

Determine if the 'requestUri' attribute was set.

Returns
true if the 'requestUri' attribute was set.

◆ has_return_idp_credential()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::has_return_idp_credential ( ) const
inline

Determine if the 'returnIdpCredential' attribute was set.

Returns
true if the 'returnIdpCredential' attribute was set.

◆ has_return_refresh_token()

bool google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::has_return_refresh_token ( ) const
inline

Determine if the 'returnRefreshToken' attribute was set.

Returns
true if the 'returnRefreshToken' attribute was set.

◆ has_return_secure_token()

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

Determine if the 'returnSecureToken' attribute was set.

Returns
true if the 'returnSecureToken' attribute was set.

◆ has_session_id()

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

Determine if the 'tenantProjectNumber' attribute was set.

Returns
true if the 'tenantProjectNumber' attribute was set.

◆ New()

IdentitytoolkitRelyingpartyVerifyAssertionRequest * google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_auto_create()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::set_auto_create ( bool  value)
inline

Change the 'autoCreate' attribute.

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
[in]valueThe new value.

◆ set_delegated_project_number()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::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_id_token()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::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::IdentitytoolkitRelyingpartyVerifyAssertionRequest::set_instance_id ( const StringPiece &  value)
inline

Change the 'instanceId' attribute.

Instance id token of the app.

Parameters
[in]valueThe new value.

◆ set_pending_id_token()

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

Change the 'pendingIdToken' attribute.

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

Parameters
[in]valueThe new value.

◆ set_post_body()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::set_post_body ( const StringPiece &  value)
inline

Change the 'postBody' attribute.

The post body if the request is a HTTP POST.

Parameters
[in]valueThe new value.

◆ set_request_uri()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::set_request_uri ( const StringPiece &  value)
inline

Change the 'requestUri' attribute.

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

Parameters
[in]valueThe new value.

◆ set_return_idp_credential()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::set_return_idp_credential ( bool  value)
inline

Change the 'returnIdpCredential' attribute.

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

Parameters
[in]valueThe new value.

◆ set_return_refresh_token()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::set_return_refresh_token ( bool  value)
inline

Change the 'returnRefreshToken' attribute.

Whether to return refresh tokens.

Parameters
[in]valueThe new value.

◆ set_return_secure_token()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::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_session_id()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::set_session_id ( const StringPiece &  value)
inline

Change the 'sessionId' attribute.

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

Parameters
[in]valueThe new value.

◆ set_tenant_id()

void google_identitytoolkit_api::IdentitytoolkitRelyingpartyVerifyAssertionRequest::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::IdentitytoolkitRelyingpartyVerifyAssertionRequest::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: