Class: Google::Apis::IdentitytoolkitV3::SetAccountInfoRequest

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 more...

Overview

Request to set the account information.

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) ⇒ SetAccountInfoRequest

Returns a new instance of SetAccountInfoRequest

[View source]

910
911
912
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 910

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

Instance Attribute Details

#captcha_challenge ⇒ String

The captcha challenge. Corresponds to the JSON property captchaChallenge

Returns:

  • (String) 

793
794
795
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 793

def captcha_challenge
  @captcha_challenge
end

#captcha_response ⇒ String

Response to the captcha. Corresponds to the JSON property captchaResponse

Returns:

  • (String) 

798
799
800
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 798

def captcha_response
  @captcha_response
end

#created_at ⇒ Fixnum

The timestamp when the account is created. Corresponds to the JSON property createdAt

Returns:

  • (Fixnum) 

803
804
805
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 803

def created_at
  @created_at
end

#custom_attributes ⇒ String

The custom attributes to be set in the user's id token. Corresponds to the JSON property customAttributes

Returns:

  • (String) 

808
809
810
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 808

def custom_attributes
  @custom_attributes
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) 

814
815
816
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 814

def delegated_project_number
  @delegated_project_number
end

#delete_attribute ⇒ Array<String>

The attributes users request to delete. Corresponds to the JSON property deleteAttribute

Returns:

  • (Array<String>) 

819
820
821
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 819

def delete_attribute
  @delete_attribute
end

#delete_provider ⇒ Array<String>

The IDPs the user request to delete. Corresponds to the JSON property deleteProvider

Returns:

  • (Array<String>) 

824
825
826
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 824

def delete_provider
  @delete_provider
end

#disable_user ⇒ Boolean Also known as: disable_user?

Whether to disable the user. Corresponds to the JSON property disableUser

Returns:

  • (Boolean) 

829
830
831
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 829

def disable_user
  @disable_user
end

#display_name ⇒ String

The name of the user. Corresponds to the JSON property displayName

Returns:

  • (String) 

835
836
837
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 835

def display_name
  @display_name
end

#email ⇒ String

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

Returns:

  • (String) 

840
841
842
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 840

def email
  @email
end

#email_verified ⇒ Boolean Also known as: email_verified?

Mark the email as verified or not. Corresponds to the JSON property emailVerified

Returns:

  • (Boolean) 

845
846
847
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 845

def email_verified
  @email_verified
end

#id_token ⇒ String

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

Returns:

  • (String) 

851
852
853
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 851

def id_token
  @id_token
end

#instance_id ⇒ String

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

Returns:

  • (String) 

856
857
858
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 856

def instance_id
  @instance_id
end

#last_login_at ⇒ Fixnum

Last login timestamp. Corresponds to the JSON property lastLoginAt

Returns:

  • (Fixnum) 

861
862
863
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 861

def 
  @last_login_at
end

#local_id ⇒ String

The local ID of the user. Corresponds to the JSON property localId

Returns:

  • (String) 

866
867
868
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 866

def local_id
  @local_id
end

#oob_code ⇒ String

The out-of-band code of the change email request. Corresponds to the JSON property oobCode

Returns:

  • (String) 

871
872
873
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 871

def oob_code
  @oob_code
end

#password ⇒ String

The new password of the user. Corresponds to the JSON property password

Returns:

  • (String) 

876
877
878
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 876

def password
  @password
end

#phone_number ⇒ String

Privileged caller can update user with specified phone number. Corresponds to the JSON property phoneNumber

Returns:

  • (String) 

881
882
883
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 881

def phone_number
  @phone_number
end

#photo_url ⇒ String

The photo url of the user. Corresponds to the JSON property photoUrl

Returns:

  • (String) 

886
887
888
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 886

def photo_url
  @photo_url
end

#provider ⇒ Array<String>

The associated IDPs of the user. Corresponds to the JSON property provider

Returns:

  • (Array<String>) 

891
892
893
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 891

def provider
  @provider
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) 

896
897
898
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 896

def return_secure_token
  @return_secure_token
end

#upgrade_to_federated_login ⇒ Boolean Also known as: upgrade_to_federated_login?

Mark the user to upgrade to federated login. Corresponds to the JSON property upgradeToFederatedLogin

Returns:

  • (Boolean) 

902
903
904
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 902

def 
  @upgrade_to_federated_login
end

#valid_since ⇒ Fixnum

Timestamp in seconds for valid login token. Corresponds to the JSON property validSince

Returns:

  • (Fixnum) 

908
909
910
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 908

def valid_since
  @valid_since
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 915

def update!(**args)
  @captcha_challenge = args[:captcha_challenge] if args.key?(:captcha_challenge)
  @captcha_response = args[:captcha_response] if args.key?(:captcha_response)
  @created_at = args[:created_at] if args.key?(:created_at)
  @custom_attributes = args[:custom_attributes] if args.key?(:custom_attributes)
  @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number)
  @delete_attribute = args[:delete_attribute] if args.key?(:delete_attribute)
  @delete_provider = args[:delete_provider] if args.key?(:delete_provider)
  @disable_user = args[:disable_user] if args.key?(:disable_user)
  @display_name = args[:display_name] if args.key?(:display_name)
  @email = args[:email] if args.key?(:email)
  @email_verified = args[:email_verified] if args.key?(:email_verified)
  @id_token = args[:id_token] if args.key?(:id_token)
  @instance_id = args[:instance_id] if args.key?(:instance_id)
  @last_login_at = args[:last_login_at] if args.key?(:last_login_at)
  @local_id = args[:local_id] if args.key?(:local_id)
  @oob_code = args[:oob_code] if args.key?(:oob_code)
  @password = args[:password] if args.key?(:password)
  @phone_number = args[:phone_number] if args.key?(:phone_number)
  @photo_url = args[:photo_url] if args.key?(:photo_url)
  @provider = args[:provider] if args.key?(:provider)
  @return_secure_token = args[:return_secure_token] if args.key?(:return_secure_token)
  @upgrade_to_federated_login = args[:upgrade_to_federated_login] if args.key?(:upgrade_to_federated_login)
  @valid_since = args[:valid_since] if args.key?(:valid_since)
end
x

Warning: This is not the latest release.

Privacy · Terms