Class: Google::Apis::IdentitytoolkitV3::IdentityToolkitService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/identitytoolkit_v3/service.rb

Overview

Google Identity Toolkit API

Help the third party sites to implement federated login.

Examples:

require 'google/apis/identitytoolkit_v3'

Identitytoolkit = Google::Apis::IdentitytoolkitV3 # Alias the module
service = Identitytoolkit::IdentityToolkitService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initialize ⇒ IdentityToolkitService

Returns a new instance of IdentityToolkitService.



51
52
53
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'identitytoolkit/v3/relyingparty/')
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.



44
45
46
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 44

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



49
50
51
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

#create_auth_uri(create_auth_uri_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::CreateAuthUriResponse

Creates the URI used by the IdP to authenticate the user.

Parameters:

  • create_auth_uri_request_object (Google::Apis::IdentitytoolkitV3::CreateAuthUriRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



78
79
80
81
82
83
84
85
86
87
88
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 78

def create_auth_uri(create_auth_uri_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'createAuthUri', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::CreateAuthUriRequest::Representation
  command.request_object = create_auth_uri_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV3::CreateAuthUriResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::CreateAuthUriResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_account(delete_account_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::DeleteAccountResponse

Delete user account.

Parameters:

  • delete_account_request_object (Google::Apis::IdentitytoolkitV3::DeleteAccountRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



113
114
115
116
117
118
119
120
121
122
123
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 113

def ( = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'deleteAccount', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::DeleteAccountRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV3::DeleteAccountResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::DeleteAccountResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#download_account(download_account_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::DownloadAccountResponse

Batch download user accounts.

Parameters:

  • download_account_request_object (Google::Apis::IdentitytoolkitV3::DownloadAccountRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



148
149
150
151
152
153
154
155
156
157
158
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 148

def ( = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'downloadAccount', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::DownloadAccountRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV3::DownloadAccountResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::DownloadAccountResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_account_info(get_account_info_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::GetAccountInfoResponse

Returns the account info.

Parameters:

  • get_account_info_request_object (Google::Apis::IdentitytoolkitV3::GetAccountInfoRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



183
184
185
186
187
188
189
190
191
192
193
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 183

def ( = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'getAccountInfo', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::GetAccountInfoRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV3::GetAccountInfoResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::GetAccountInfoResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_oob_confirmation_code(relyingparty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::GetOobConfirmationCodeResponse

Get a code for user action confirmation.

Parameters:

  • relyingparty_object (Google::Apis::IdentitytoolkitV3::Relyingparty) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



218
219
220
221
222
223
224
225
226
227
228
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 218

def get_oob_confirmation_code(relyingparty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'getOobConfirmationCode', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::Relyingparty::Representation
  command.request_object = relyingparty_object
  command.response_representation = Google::Apis::IdentitytoolkitV3::GetOobConfirmationCodeResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::GetOobConfirmationCodeResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_project_config(delegated_project_number: nil, project_number: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::GetProjectConfigResponse

Get project configuration.

Parameters:

  • delegated_project_number (String) (defaults to: nil) —

    Delegated GCP project number of the request.

  • project_number (String) (defaults to: nil) —

    GCP project number of the request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



256
257
258
259
260
261
262
263
264
265
266
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 256

def get_project_config(delegated_project_number: nil, project_number: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'getProjectConfig', options)
  command.response_representation = Google::Apis::IdentitytoolkitV3::GetProjectConfigResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::GetProjectConfigResponse
  command.query['delegatedProjectNumber'] = delegated_project_number unless delegated_project_number.nil?
  command.query['projectNumber'] = project_number unless project_number.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_public_keys(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Hash<String,String>

Get token signing public key.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (Hash<String,String>) —

    parsed result object

  • err (StandardError) —

    error object if request failed

Returns:

  • (Hash<String,String>)

Raises:



290
291
292
293
294
295
296
297
298
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 290

def get_public_keys(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'publicKeys', options)
  command.response_representation = Hash<String,String>::Representation
  command.response_class = Hash<String,String>
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_recaptcha_param(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::GetRecaptchaParamResponse

Get recaptcha secure param.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



322
323
324
325
326
327
328
329
330
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 322

def get_recaptcha_param(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'getRecaptchaParam', options)
  command.response_representation = Google::Apis::IdentitytoolkitV3::GetRecaptchaParamResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::GetRecaptchaParamResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#reset_password(reset_password_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::ResetPasswordResponse

Reset password for a user.

Parameters:

  • reset_password_request_object (Google::Apis::IdentitytoolkitV3::ResetPasswordRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



355
356
357
358
359
360
361
362
363
364
365
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 355

def reset_password(reset_password_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'resetPassword', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::ResetPasswordRequest::Representation
  command.request_object = reset_password_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV3::ResetPasswordResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::ResetPasswordResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#set_account_info(set_account_info_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::SetAccountInfoResponse

Set account info for a user.

Parameters:

  • set_account_info_request_object (Google::Apis::IdentitytoolkitV3::SetAccountInfoRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



390
391
392
393
394
395
396
397
398
399
400
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 390

def ( = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'setAccountInfo', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::SetAccountInfoRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV3::SetAccountInfoResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::SetAccountInfoResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#set_relyingparty_project_config(set_project_config_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySetProjectConfigResponse

Set project configuration.

Parameters:

  • set_project_config_request_object (Google::Apis::IdentitytoolkitV3::SetProjectConfigRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



425
426
427
428
429
430
431
432
433
434
435
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 425

def set_relyingparty_project_config(set_project_config_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'setProjectConfig', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::SetProjectConfigRequest::Representation
  command.request_object = set_project_config_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySetProjectConfigResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySetProjectConfigResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#sign_out_user(sign_out_user_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::SignOutUserResponse

Sign out user.

Parameters:

  • sign_out_user_request_object (Google::Apis::IdentitytoolkitV3::SignOutUserRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



460
461
462
463
464
465
466
467
468
469
470
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 460

def sign_out_user(sign_out_user_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'signOutUser', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::SignOutUserRequest::Representation
  command.request_object = sign_out_user_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV3::SignOutUserResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::SignOutUserResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#signup_new_user(signup_new_user_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::SignupNewUserResponse

Signup new user.

Parameters:

  • signup_new_user_request_object (Google::Apis::IdentitytoolkitV3::SignupNewUserRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



495
496
497
498
499
500
501
502
503
504
505
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 495

def ( = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'signupNewUser', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::SignupNewUserRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV3::SignupNewUserResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::SignupNewUserResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#upload_account(upload_account_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::UploadAccountResponse

Batch upload existing user accounts.

Parameters:

  • upload_account_request_object (Google::Apis::IdentitytoolkitV3::UploadAccountRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



530
531
532
533
534
535
536
537
538
539
540
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 530

def ( = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'uploadAccount', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::UploadAccountRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::IdentitytoolkitV3::UploadAccountResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::UploadAccountResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#verify_assertion(verify_assertion_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse

Verifies the assertion returned by the IdP.

Parameters:

  • verify_assertion_request_object (Google::Apis::IdentitytoolkitV3::VerifyAssertionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



565
566
567
568
569
570
571
572
573
574
575
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 565

def verify_assertion(verify_assertion_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'verifyAssertion', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::VerifyAssertionRequest::Representation
  command.request_object = verify_assertion_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#verify_custom_token(verify_custom_token_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::VerifyCustomTokenResponse

Verifies the developer asserted ID token.

Parameters:

  • verify_custom_token_request_object (Google::Apis::IdentitytoolkitV3::VerifyCustomTokenRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



600
601
602
603
604
605
606
607
608
609
610
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 600

def verify_custom_token(verify_custom_token_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'verifyCustomToken', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::VerifyCustomTokenRequest::Representation
  command.request_object = verify_custom_token_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV3::VerifyCustomTokenResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::VerifyCustomTokenResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#verify_password(verify_password_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdentitytoolkitV3::VerifyPasswordResponse

Verifies the user entered password.

Parameters:

  • verify_password_request_object (Google::Apis::IdentitytoolkitV3::VerifyPasswordRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



635
636
637
638
639
640
641
642
643
644
645
 
# File 'generated/google/apis/identitytoolkit_v3/service.rb', line 635

def verify_password(verify_password_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'verifyPassword', options)
  command.request_representation = Google::Apis::IdentitytoolkitV3::VerifyPasswordRequest::Representation
  command.request_object = verify_password_request_object
  command.response_representation = Google::Apis::IdentitytoolkitV3::VerifyPasswordResponse::Representation
  command.response_class = Google::Apis::IdentitytoolkitV3::VerifyPasswordResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end