Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1ResetPasswordRequest

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

Overview

Request message for ResetPassword.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1ResetPasswordRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1ResetPasswordRequest.



1668
1669
1670
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1668

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

Instance Attribute Details

#email ⇒ String

Optional. The email of the account to be modified. Specify this and the old password in order to change an account's password without using an out-of-band code. Corresponds to the JSON property email

Returns:

  • (String) 


1640
1641
1642
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1640

def email
  @email
end

#new_password ⇒ String

The new password to be set for this account. Specifying this field will result in a change to the account and consume the out-of-band code if one was specified and it was of type PASSWORD_RESET. Corresponds to the JSON property newPassword

Returns:

  • (String) 


1647
1648
1649
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1647

def new_password
  @new_password
end

#old_password ⇒ String

The current password of the account to be modified. Specify this and email to change an account's password without using an out-of-band code. Corresponds to the JSON property oldPassword

Returns:

  • (String) 


1653
1654
1655
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1653

def old_password
  @old_password
end

#oob_code ⇒ String

An out-of-band (OOB) code generated by GetOobCode request. Specify only this parameter (or only this parameter and a tenant ID) to get the out-of-band code' s type in the response without mutating the account's state. Only a PASSWORD_RESET out-of-band code can be consumed via this method. Corresponds to the JSON property oobCode

Returns:

  • (String) 


1661
1662
1663
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1661

def oob_code
  @oob_code
end

#tenant_id ⇒ String

Optional. The tenant ID of the Identity Platform tenant the account belongs to. Corresponds to the JSON property tenantId

Returns:

  • (String) 


1666
1667
1668
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1666

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1673

def update!(**args)
  @email = args[:email] if args.key?(:email)
  @new_password = args[:new_password] if args.key?(:new_password)
  @old_password = args[:old_password] if args.key?(:old_password)
  @oob_code = args[:oob_code] if args.key?(:oob_code)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
end