Class: Google::Apis::IdentitytoolkitV3::SignupNewUserRequest

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 signup new user, create anonymous user or anonymous user reauth.

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

Returns a new instance of SignupNewUserRequest



1047
1048
1049
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1047

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

Instance Attribute Details

#captcha_challenge ⇒ String

The captcha challenge. Corresponds to the JSON property captchaChallenge

Returns:

  • (String) 


988
989
990
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 988

def captcha_challenge
  @captcha_challenge
end

#captcha_response ⇒ String

Response to the captcha. Corresponds to the JSON property captchaResponse

Returns:

  • (String) 


993
994
995
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 993

def captcha_response
  @captcha_response
end

#disabled ⇒ Boolean Also known as: disabled?

Whether to disable the user. Only can be used by service account. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


998
999
1000
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 998

def disabled
  @disabled
end

#display_name ⇒ String

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

Returns:

  • (String) 


1004
1005
1006
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1004

def display_name
  @display_name
end

#email ⇒ String

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

Returns:

  • (String) 


1009
1010
1011
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1009

def email
  @email
end

#email_verified ⇒ Boolean Also known as: email_verified?

Mark the email as verified or not. Only can be used by service account. Corresponds to the JSON property emailVerified

Returns:

  • (Boolean) 


1014
1015
1016
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1014

def email_verified
  @email_verified
end

#id_token ⇒ String

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

Returns:

  • (String) 


1020
1021
1022
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1020

def id_token
  @id_token
end

#instance_id ⇒ String

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

Returns:

  • (String) 


1025
1026
1027
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1025

def instance_id
  @instance_id
end

#local_id ⇒ String

Privileged caller can create user with specified user id. Corresponds to the JSON property localId

Returns:

  • (String) 


1030
1031
1032
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1030

def local_id
  @local_id
end

#password ⇒ String

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

Returns:

  • (String) 


1035
1036
1037
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1035

def password
  @password
end

#phone_number ⇒ String

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

Returns:

  • (String) 


1040
1041
1042
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1040

def phone_number
  @phone_number
end

#photo_url ⇒ String

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

Returns:

  • (String) 


1045
1046
1047
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1045

def photo_url
  @photo_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1052

def update!(**args)
  @captcha_challenge = args[:captcha_challenge] if args.key?(:captcha_challenge)
  @captcha_response = args[:captcha_response] if args.key?(:captcha_response)
  @disabled = args[:disabled] if args.key?(:disabled)
  @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)
  @local_id = args[:local_id] if args.key?(:local_id)
  @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)
end