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



1140
1141
1142
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1140

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

Instance Attribute Details

#captcha_challenge ⇒ String

The captcha challenge. Corresponds to the JSON property captchaChallenge

Returns:

  • (String) 


1081
1082
1083
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1081

def captcha_challenge
  @captcha_challenge
end

#captcha_response ⇒ String

Response to the captcha. Corresponds to the JSON property captchaResponse

Returns:

  • (String) 


1086
1087
1088
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1086

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) 


1091
1092
1093
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1091

def disabled
  @disabled
end

#display_name ⇒ String

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

Returns:

  • (String) 


1097
1098
1099
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1097

def display_name
  @display_name
end

#email ⇒ String

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

Returns:

  • (String) 


1102
1103
1104
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1102

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) 


1107
1108
1109
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1107

def email_verified
  @email_verified
end

#id_token ⇒ String

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

Returns:

  • (String) 


1113
1114
1115
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1113

def id_token
  @id_token
end

#instance_id ⇒ String

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

Returns:

  • (String) 


1118
1119
1120
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1118

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) 


1123
1124
1125
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1123

def local_id
  @local_id
end

#password ⇒ String

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

Returns:

  • (String) 


1128
1129
1130
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1128

def password
  @password
end

#phone_number ⇒ String

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

Returns:

  • (String) 


1133
1134
1135
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1133

def phone_number
  @phone_number
end

#photo_url ⇒ String

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

Returns:

  • (String) 


1138
1139
1140
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1138

def photo_url
  @photo_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1145

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