Class: Google::Apis::IdentitytoolkitV3::SignupNewUserRequest
- Inherits:
-
Object
- Object
- Google::Apis::IdentitytoolkitV3::SignupNewUserRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/identitytoolkit_v3/classes.rb,
lib/google/apis/identitytoolkit_v3/representations.rb,
lib/google/apis/identitytoolkit_v3/representations.rb
Overview
Request to signup new user, create anonymous user or anonymous user reauth.
Instance Attribute Summary collapse
-
#captcha_challenge ⇒ String
The captcha challenge.
-
#captcha_response ⇒ String
Response to the captcha.
-
#disabled ⇒ Boolean
(also: #disabled?)
Whether to disable the user.
-
#display_name ⇒ String
The name of the user.
-
#email ⇒ String
The email of the user.
-
#email_verified ⇒ Boolean
(also: #email_verified?)
Mark the email as verified or not.
-
#id_token ⇒ String
The GITKit token of the authenticated user.
-
#instance_id ⇒ String
Instance id token of the app.
-
#local_id ⇒ String
Privileged caller can create user with specified user id.
-
#password ⇒ String
The new password of the user.
-
#phone_number ⇒ String
Privileged caller can create user with specified phone number.
-
#photo_url ⇒ String
The photo url of the user.
-
#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.
-
#tenant_project_number ⇒ Fixnum
Tenant project number to be used for idp discovery.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SignupNewUserRequest
constructor
A new instance of SignupNewUserRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ SignupNewUserRequest
Returns a new instance of SignupNewUserRequest.
1166 1167 1168 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1166 def initialize(**args) update!(**args) end |
Instance Attribute Details
#captcha_challenge ⇒ String
The captcha challenge.
Corresponds to the JSON property captchaChallenge
1095 1096 1097 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1095 def captcha_challenge @captcha_challenge end |
#captcha_response ⇒ String
Response to the captcha.
Corresponds to the JSON property captchaResponse
1100 1101 1102 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1100 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
1105 1106 1107 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1105 def disabled @disabled end |
#display_name ⇒ String
The name of the user.
Corresponds to the JSON property displayName
1111 1112 1113 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1111 def display_name @display_name end |
#email ⇒ String
The email of the user.
Corresponds to the JSON property email
1116 1117 1118 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1116 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
1121 1122 1123 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1121 def email_verified @email_verified end |
#id_token ⇒ String
The GITKit token of the authenticated user.
Corresponds to the JSON property idToken
1127 1128 1129 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1127 def id_token @id_token end |
#instance_id ⇒ String
Instance id token of the app.
Corresponds to the JSON property instanceId
1132 1133 1134 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1132 def instance_id @instance_id end |
#local_id ⇒ String
Privileged caller can create user with specified user id.
Corresponds to the JSON property localId
1137 1138 1139 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1137 def local_id @local_id end |
#password ⇒ String
The new password of the user.
Corresponds to the JSON property password
1142 1143 1144 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1142 def password @password end |
#phone_number ⇒ String
Privileged caller can create user with specified phone number.
Corresponds to the JSON property phoneNumber
1147 1148 1149 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1147 def phone_number @phone_number end |
#photo_url ⇒ String
The photo url of the user.
Corresponds to the JSON property photoUrl
1152 1153 1154 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1152 def photo_url @photo_url 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
1159 1160 1161 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1159 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
1164 1165 1166 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1164 def tenant_project_number @tenant_project_number end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1171 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) @tenant_id = args[:tenant_id] if args.key?(:tenant_id) @tenant_project_number = args[:tenant_project_number] if args.key?(:tenant_project_number) end |