Class: Google::Apis::IdentitytoolkitV3::VerifyPasswordRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/identitytoolkit_v3/classes.rb,
generated/google/apis/identitytoolkit_v3/representations.rb,
generated/google/apis/identitytoolkit_v3/representations.rb

Overview

Request to verify the password.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ VerifyPasswordRequest

Returns a new instance of VerifyPasswordRequest



1497
1498
1499
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1497

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#captcha_challenge ⇒ String

The captcha challenge. Corresponds to the JSON property captchaChallenge

Returns:

  • (String) 


1441
1442
1443
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1441

def captcha_challenge
  @captcha_challenge
end

#captcha_response ⇒ String

Response to the captcha. Corresponds to the JSON property captchaResponse

Returns:

  • (String) 


1446
1447
1448
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1446

def captcha_response
  @captcha_response
end

#delegated_project_number ⇒ Fixnum

GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. Corresponds to the JSON property delegatedProjectNumber

Returns:

  • (Fixnum) 


1452
1453
1454
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1452

def delegated_project_number
  @delegated_project_number
end

#email ⇒ String

The email of the user. Corresponds to the JSON property email

Returns:

  • (String) 


1457
1458
1459
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1457

def email
  @email
end

#id_token ⇒ String

The GITKit token of the authenticated user. Corresponds to the JSON property idToken

Returns:

  • (String) 


1462
1463
1464
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1462

def id_token
  @id_token
end

#instance_id ⇒ String

Instance id token of the app. Corresponds to the JSON property instanceId

Returns:

  • (String) 


1467
1468
1469
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1467

def instance_id
  @instance_id
end

#password ⇒ String

The password inputed by the user. Corresponds to the JSON property password

Returns:

  • (String) 


1472
1473
1474
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1472

def password
  @password
end

#pending_id_token ⇒ String

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

Returns:

  • (String) 


1477
1478
1479
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1477

def pending_id_token
  @pending_id_token
end

#return_secure_token ⇒ Boolean Also known as: return_secure_token?

Whether return sts id token and refresh token instead of gitkit token. Corresponds to the JSON property returnSecureToken

Returns:

  • (Boolean) 


1482
1483
1484
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1482

def return_secure_token
  @return_secure_token
end

#tenant_id ⇒ String

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. Corresponds to the JSON property tenantId

Returns:

  • (String) 


1490
1491
1492
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1490

def tenant_id
  @tenant_id
end

#tenant_project_number ⇒ Fixnum

Tenant project number to be used for idp discovery. Corresponds to the JSON property tenantProjectNumber

Returns:

  • (Fixnum) 


1495
1496
1497
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1495

def tenant_project_number
  @tenant_project_number
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1502

def update!(**args)
  @captcha_challenge = args[:captcha_challenge] if args.key?(:captcha_challenge)
  @captcha_response = args[:captcha_response] if args.key?(:captcha_response)
  @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number)
  @email = args[:email] if args.key?(:email)
  @id_token = args[:id_token] if args.key?(:id_token)
  @instance_id = args[:instance_id] if args.key?(:instance_id)
  @password = args[:password] if args.key?(:password)
  @pending_id_token = args[:pending_id_token] if args.key?(:pending_id_token)
  @return_secure_token = args[:return_secure_token] if args.key?(:return_secure_token)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
  @tenant_project_number = args[:tenant_project_number] if args.key?(:tenant_project_number)
end