google-apis-identitytoolkit_v3 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,724 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module IdentitytoolkitV3
23
+ # Google Identity Toolkit API
24
+ #
25
+ # Help the third party sites to implement federated login.
26
+ #
27
+ # @example
28
+ # require 'google/apis/identitytoolkit_v3'
29
+ #
30
+ # Identitytoolkit = Google::Apis::IdentitytoolkitV3 # Alias the module
31
+ # service = Identitytoolkit::IdentityToolkitService.new
32
+ #
33
+ # @see https://developers.google.com/identity-toolkit/v3/
34
+ class IdentityToolkitService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
42
+ # characters.
43
+ attr_accessor :quota_user
44
+
45
+ # @return [String]
46
+ # Deprecated. Please use quotaUser instead.
47
+ attr_accessor :user_ip
48
+
49
+ def initialize
50
+ super('https://www.googleapis.com/', 'identitytoolkit/v3/relyingparty/',
51
+ client_name: 'google-apis-identitytoolkit_v3',
52
+ client_version: Google::Apis::IdentitytoolkitV3::GEM_VERSION)
53
+ @batch_path = 'batch/identitytoolkit/v3'
54
+ end
55
+
56
+ # Creates the URI used by the IdP to authenticate the user.
57
+ # @param [Google::Apis::IdentitytoolkitV3::CreateAuthUriRequest] create_auth_uri_request_object
58
+ # @param [String] fields
59
+ # Selector specifying which fields to include in a partial response.
60
+ # @param [String] quota_user
61
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
62
+ # characters.
63
+ # @param [String] user_ip
64
+ # Deprecated. Please use quotaUser instead.
65
+ # @param [Google::Apis::RequestOptions] options
66
+ # Request-specific options
67
+ #
68
+ # @yield [result, err] Result & error if block supplied
69
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::CreateAuthUriResponse] parsed result object
70
+ # @yieldparam err [StandardError] error object if request failed
71
+ #
72
+ # @return [Google::Apis::IdentitytoolkitV3::CreateAuthUriResponse]
73
+ #
74
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
75
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
76
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
77
+ def create_auth_uri(create_auth_uri_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
78
+ command = make_simple_command(:post, 'createAuthUri', options)
79
+ command.request_representation = Google::Apis::IdentitytoolkitV3::CreateAuthUriRequest::Representation
80
+ command.request_object = create_auth_uri_request_object
81
+ command.response_representation = Google::Apis::IdentitytoolkitV3::CreateAuthUriResponse::Representation
82
+ command.response_class = Google::Apis::IdentitytoolkitV3::CreateAuthUriResponse
83
+ command.query['fields'] = fields unless fields.nil?
84
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
85
+ command.query['userIp'] = user_ip unless user_ip.nil?
86
+ execute_or_queue_command(command, &block)
87
+ end
88
+
89
+ # Delete user account.
90
+ # @param [Google::Apis::IdentitytoolkitV3::DeleteAccountRequest] delete_account_request_object
91
+ # @param [String] fields
92
+ # Selector specifying which fields to include in a partial response.
93
+ # @param [String] quota_user
94
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
95
+ # characters.
96
+ # @param [String] user_ip
97
+ # Deprecated. Please use quotaUser instead.
98
+ # @param [Google::Apis::RequestOptions] options
99
+ # Request-specific options
100
+ #
101
+ # @yield [result, err] Result & error if block supplied
102
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::DeleteAccountResponse] parsed result object
103
+ # @yieldparam err [StandardError] error object if request failed
104
+ #
105
+ # @return [Google::Apis::IdentitytoolkitV3::DeleteAccountResponse]
106
+ #
107
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
108
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
109
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
110
+ def delete_account(delete_account_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
111
+ command = make_simple_command(:post, 'deleteAccount', options)
112
+ command.request_representation = Google::Apis::IdentitytoolkitV3::DeleteAccountRequest::Representation
113
+ command.request_object = delete_account_request_object
114
+ command.response_representation = Google::Apis::IdentitytoolkitV3::DeleteAccountResponse::Representation
115
+ command.response_class = Google::Apis::IdentitytoolkitV3::DeleteAccountResponse
116
+ command.query['fields'] = fields unless fields.nil?
117
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
118
+ command.query['userIp'] = user_ip unless user_ip.nil?
119
+ execute_or_queue_command(command, &block)
120
+ end
121
+
122
+ # Batch download user accounts.
123
+ # @param [Google::Apis::IdentitytoolkitV3::DownloadAccountRequest] download_account_request_object
124
+ # @param [String] fields
125
+ # Selector specifying which fields to include in a partial response.
126
+ # @param [String] quota_user
127
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
128
+ # characters.
129
+ # @param [String] user_ip
130
+ # Deprecated. Please use quotaUser instead.
131
+ # @param [Google::Apis::RequestOptions] options
132
+ # Request-specific options
133
+ #
134
+ # @yield [result, err] Result & error if block supplied
135
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::DownloadAccountResponse] parsed result object
136
+ # @yieldparam err [StandardError] error object if request failed
137
+ #
138
+ # @return [Google::Apis::IdentitytoolkitV3::DownloadAccountResponse]
139
+ #
140
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
141
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
142
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
143
+ def download_account(download_account_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
144
+ command = make_simple_command(:post, 'downloadAccount', options)
145
+ command.request_representation = Google::Apis::IdentitytoolkitV3::DownloadAccountRequest::Representation
146
+ command.request_object = download_account_request_object
147
+ command.response_representation = Google::Apis::IdentitytoolkitV3::DownloadAccountResponse::Representation
148
+ command.response_class = Google::Apis::IdentitytoolkitV3::DownloadAccountResponse
149
+ command.query['fields'] = fields unless fields.nil?
150
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
151
+ command.query['userIp'] = user_ip unless user_ip.nil?
152
+ execute_or_queue_command(command, &block)
153
+ end
154
+
155
+ # Reset password for a user.
156
+ # @param [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyEmailLinkSigninRequest] identitytoolkit_relyingparty_email_link_signin_request_object
157
+ # @param [String] fields
158
+ # Selector specifying which fields to include in a partial response.
159
+ # @param [String] quota_user
160
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
161
+ # characters.
162
+ # @param [String] user_ip
163
+ # Deprecated. Please use quotaUser instead.
164
+ # @param [Google::Apis::RequestOptions] options
165
+ # Request-specific options
166
+ #
167
+ # @yield [result, err] Result & error if block supplied
168
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::EmailLinkSigninResponse] parsed result object
169
+ # @yieldparam err [StandardError] error object if request failed
170
+ #
171
+ # @return [Google::Apis::IdentitytoolkitV3::EmailLinkSigninResponse]
172
+ #
173
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
174
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
175
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
176
+ def email_relyingparty_link_signin(identitytoolkit_relyingparty_email_link_signin_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
177
+ command = make_simple_command(:post, 'emailLinkSignin', options)
178
+ command.request_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyEmailLinkSigninRequest::Representation
179
+ command.request_object = identitytoolkit_relyingparty_email_link_signin_request_object
180
+ command.response_representation = Google::Apis::IdentitytoolkitV3::EmailLinkSigninResponse::Representation
181
+ command.response_class = Google::Apis::IdentitytoolkitV3::EmailLinkSigninResponse
182
+ command.query['fields'] = fields unless fields.nil?
183
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
184
+ command.query['userIp'] = user_ip unless user_ip.nil?
185
+ execute_or_queue_command(command, &block)
186
+ end
187
+
188
+ # Returns the account info.
189
+ # @param [Google::Apis::IdentitytoolkitV3::GetAccountInfoRequest] get_account_info_request_object
190
+ # @param [String] fields
191
+ # Selector specifying which fields to include in a partial response.
192
+ # @param [String] quota_user
193
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
194
+ # characters.
195
+ # @param [String] user_ip
196
+ # Deprecated. Please use quotaUser instead.
197
+ # @param [Google::Apis::RequestOptions] options
198
+ # Request-specific options
199
+ #
200
+ # @yield [result, err] Result & error if block supplied
201
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::GetAccountInfoResponse] parsed result object
202
+ # @yieldparam err [StandardError] error object if request failed
203
+ #
204
+ # @return [Google::Apis::IdentitytoolkitV3::GetAccountInfoResponse]
205
+ #
206
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
207
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
208
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
209
+ def get_account_info(get_account_info_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
210
+ command = make_simple_command(:post, 'getAccountInfo', options)
211
+ command.request_representation = Google::Apis::IdentitytoolkitV3::GetAccountInfoRequest::Representation
212
+ command.request_object = get_account_info_request_object
213
+ command.response_representation = Google::Apis::IdentitytoolkitV3::GetAccountInfoResponse::Representation
214
+ command.response_class = Google::Apis::IdentitytoolkitV3::GetAccountInfoResponse
215
+ command.query['fields'] = fields unless fields.nil?
216
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
217
+ command.query['userIp'] = user_ip unless user_ip.nil?
218
+ execute_or_queue_command(command, &block)
219
+ end
220
+
221
+ # Get a code for user action confirmation.
222
+ # @param [Google::Apis::IdentitytoolkitV3::Relyingparty] relyingparty_object
223
+ # @param [String] fields
224
+ # Selector specifying which fields to include in a partial response.
225
+ # @param [String] quota_user
226
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
227
+ # characters.
228
+ # @param [String] user_ip
229
+ # Deprecated. Please use quotaUser instead.
230
+ # @param [Google::Apis::RequestOptions] options
231
+ # Request-specific options
232
+ #
233
+ # @yield [result, err] Result & error if block supplied
234
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::GetOobConfirmationCodeResponse] parsed result object
235
+ # @yieldparam err [StandardError] error object if request failed
236
+ #
237
+ # @return [Google::Apis::IdentitytoolkitV3::GetOobConfirmationCodeResponse]
238
+ #
239
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
240
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
241
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
242
+ def get_oob_confirmation_code(relyingparty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
243
+ command = make_simple_command(:post, 'getOobConfirmationCode', options)
244
+ command.request_representation = Google::Apis::IdentitytoolkitV3::Relyingparty::Representation
245
+ command.request_object = relyingparty_object
246
+ command.response_representation = Google::Apis::IdentitytoolkitV3::GetOobConfirmationCodeResponse::Representation
247
+ command.response_class = Google::Apis::IdentitytoolkitV3::GetOobConfirmationCodeResponse
248
+ command.query['fields'] = fields unless fields.nil?
249
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
250
+ command.query['userIp'] = user_ip unless user_ip.nil?
251
+ execute_or_queue_command(command, &block)
252
+ end
253
+
254
+ # Get project configuration.
255
+ # @param [String] delegated_project_number
256
+ # Delegated GCP project number of the request.
257
+ # @param [String] project_number
258
+ # GCP project number of the request.
259
+ # @param [String] fields
260
+ # Selector specifying which fields to include in a partial response.
261
+ # @param [String] quota_user
262
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
263
+ # characters.
264
+ # @param [String] user_ip
265
+ # Deprecated. Please use quotaUser instead.
266
+ # @param [Google::Apis::RequestOptions] options
267
+ # Request-specific options
268
+ #
269
+ # @yield [result, err] Result & error if block supplied
270
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::GetProjectConfigResponse] parsed result object
271
+ # @yieldparam err [StandardError] error object if request failed
272
+ #
273
+ # @return [Google::Apis::IdentitytoolkitV3::GetProjectConfigResponse]
274
+ #
275
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
276
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
277
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
278
+ def get_project_config(delegated_project_number: nil, project_number: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
279
+ command = make_simple_command(:get, 'getProjectConfig', options)
280
+ command.response_representation = Google::Apis::IdentitytoolkitV3::GetProjectConfigResponse::Representation
281
+ command.response_class = Google::Apis::IdentitytoolkitV3::GetProjectConfigResponse
282
+ command.query['delegatedProjectNumber'] = delegated_project_number unless delegated_project_number.nil?
283
+ command.query['projectNumber'] = project_number unless project_number.nil?
284
+ command.query['fields'] = fields unless fields.nil?
285
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
286
+ command.query['userIp'] = user_ip unless user_ip.nil?
287
+ execute_or_queue_command(command, &block)
288
+ end
289
+
290
+ # Get token signing public key.
291
+ # @param [String] fields
292
+ # Selector specifying which fields to include in a partial response.
293
+ # @param [String] quota_user
294
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
295
+ # characters.
296
+ # @param [String] user_ip
297
+ # Deprecated. Please use quotaUser instead.
298
+ # @param [Google::Apis::RequestOptions] options
299
+ # Request-specific options
300
+ #
301
+ # @yield [result, err] Result & error if block supplied
302
+ # @yieldparam result [Hash<String,String>] parsed result object
303
+ # @yieldparam err [StandardError] error object if request failed
304
+ #
305
+ # @return [Hash<String,String>]
306
+ #
307
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
308
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
309
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
310
+ def get_public_keys(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
311
+ command = make_simple_command(:get, 'publicKeys', options)
312
+ command.response_representation = Hash<String,String>::Representation
313
+ command.response_class = Hash<String,String>
314
+ command.query['fields'] = fields unless fields.nil?
315
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
316
+ command.query['userIp'] = user_ip unless user_ip.nil?
317
+ execute_or_queue_command(command, &block)
318
+ end
319
+
320
+ # Get recaptcha secure param.
321
+ # @param [String] fields
322
+ # Selector specifying which fields to include in a partial response.
323
+ # @param [String] quota_user
324
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
325
+ # characters.
326
+ # @param [String] user_ip
327
+ # Deprecated. Please use quotaUser instead.
328
+ # @param [Google::Apis::RequestOptions] options
329
+ # Request-specific options
330
+ #
331
+ # @yield [result, err] Result & error if block supplied
332
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::GetRecaptchaParamResponse] parsed result object
333
+ # @yieldparam err [StandardError] error object if request failed
334
+ #
335
+ # @return [Google::Apis::IdentitytoolkitV3::GetRecaptchaParamResponse]
336
+ #
337
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
338
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
339
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
340
+ def get_recaptcha_param(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
341
+ command = make_simple_command(:get, 'getRecaptchaParam', options)
342
+ command.response_representation = Google::Apis::IdentitytoolkitV3::GetRecaptchaParamResponse::Representation
343
+ command.response_class = Google::Apis::IdentitytoolkitV3::GetRecaptchaParamResponse
344
+ command.query['fields'] = fields unless fields.nil?
345
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
346
+ command.query['userIp'] = user_ip unless user_ip.nil?
347
+ execute_or_queue_command(command, &block)
348
+ end
349
+
350
+ # Reset password for a user.
351
+ # @param [Google::Apis::IdentitytoolkitV3::ResetPasswordRequest] reset_password_request_object
352
+ # @param [String] fields
353
+ # Selector specifying which fields to include in a partial response.
354
+ # @param [String] quota_user
355
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
356
+ # characters.
357
+ # @param [String] user_ip
358
+ # Deprecated. Please use quotaUser instead.
359
+ # @param [Google::Apis::RequestOptions] options
360
+ # Request-specific options
361
+ #
362
+ # @yield [result, err] Result & error if block supplied
363
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::ResetPasswordResponse] parsed result object
364
+ # @yieldparam err [StandardError] error object if request failed
365
+ #
366
+ # @return [Google::Apis::IdentitytoolkitV3::ResetPasswordResponse]
367
+ #
368
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
369
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
370
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
371
+ def reset_password(reset_password_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
372
+ command = make_simple_command(:post, 'resetPassword', options)
373
+ command.request_representation = Google::Apis::IdentitytoolkitV3::ResetPasswordRequest::Representation
374
+ command.request_object = reset_password_request_object
375
+ command.response_representation = Google::Apis::IdentitytoolkitV3::ResetPasswordResponse::Representation
376
+ command.response_class = Google::Apis::IdentitytoolkitV3::ResetPasswordResponse
377
+ command.query['fields'] = fields unless fields.nil?
378
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
379
+ command.query['userIp'] = user_ip unless user_ip.nil?
380
+ execute_or_queue_command(command, &block)
381
+ end
382
+
383
+ # Send SMS verification code.
384
+ # @param [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySendVerificationCodeRequest] identitytoolkit_relyingparty_send_verification_code_request_object
385
+ # @param [String] fields
386
+ # Selector specifying which fields to include in a partial response.
387
+ # @param [String] quota_user
388
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
389
+ # characters.
390
+ # @param [String] user_ip
391
+ # Deprecated. Please use quotaUser instead.
392
+ # @param [Google::Apis::RequestOptions] options
393
+ # Request-specific options
394
+ #
395
+ # @yield [result, err] Result & error if block supplied
396
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySendVerificationCodeResponse] parsed result object
397
+ # @yieldparam err [StandardError] error object if request failed
398
+ #
399
+ # @return [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySendVerificationCodeResponse]
400
+ #
401
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
402
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
403
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
404
+ def send_relyingparty_verification_code(identitytoolkit_relyingparty_send_verification_code_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
405
+ command = make_simple_command(:post, 'sendVerificationCode', options)
406
+ command.request_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySendVerificationCodeRequest::Representation
407
+ command.request_object = identitytoolkit_relyingparty_send_verification_code_request_object
408
+ command.response_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySendVerificationCodeResponse::Representation
409
+ command.response_class = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySendVerificationCodeResponse
410
+ command.query['fields'] = fields unless fields.nil?
411
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
412
+ command.query['userIp'] = user_ip unless user_ip.nil?
413
+ execute_or_queue_command(command, &block)
414
+ end
415
+
416
+ # Set account info for a user.
417
+ # @param [Google::Apis::IdentitytoolkitV3::SetAccountInfoRequest] set_account_info_request_object
418
+ # @param [String] fields
419
+ # Selector specifying which fields to include in a partial response.
420
+ # @param [String] quota_user
421
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
422
+ # characters.
423
+ # @param [String] user_ip
424
+ # Deprecated. Please use quotaUser instead.
425
+ # @param [Google::Apis::RequestOptions] options
426
+ # Request-specific options
427
+ #
428
+ # @yield [result, err] Result & error if block supplied
429
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::SetAccountInfoResponse] parsed result object
430
+ # @yieldparam err [StandardError] error object if request failed
431
+ #
432
+ # @return [Google::Apis::IdentitytoolkitV3::SetAccountInfoResponse]
433
+ #
434
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
435
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
436
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
437
+ def set_account_info(set_account_info_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
438
+ command = make_simple_command(:post, 'setAccountInfo', options)
439
+ command.request_representation = Google::Apis::IdentitytoolkitV3::SetAccountInfoRequest::Representation
440
+ command.request_object = set_account_info_request_object
441
+ command.response_representation = Google::Apis::IdentitytoolkitV3::SetAccountInfoResponse::Representation
442
+ command.response_class = Google::Apis::IdentitytoolkitV3::SetAccountInfoResponse
443
+ command.query['fields'] = fields unless fields.nil?
444
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
445
+ command.query['userIp'] = user_ip unless user_ip.nil?
446
+ execute_or_queue_command(command, &block)
447
+ end
448
+
449
+ # Set project configuration.
450
+ # @param [Google::Apis::IdentitytoolkitV3::SetProjectConfigRequest] set_project_config_request_object
451
+ # @param [String] fields
452
+ # Selector specifying which fields to include in a partial response.
453
+ # @param [String] quota_user
454
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
455
+ # characters.
456
+ # @param [String] user_ip
457
+ # Deprecated. Please use quotaUser instead.
458
+ # @param [Google::Apis::RequestOptions] options
459
+ # Request-specific options
460
+ #
461
+ # @yield [result, err] Result & error if block supplied
462
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySetProjectConfigResponse] parsed result object
463
+ # @yieldparam err [StandardError] error object if request failed
464
+ #
465
+ # @return [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySetProjectConfigResponse]
466
+ #
467
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
468
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
469
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
470
+ def set_relyingparty_project_config(set_project_config_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
471
+ command = make_simple_command(:post, 'setProjectConfig', options)
472
+ command.request_representation = Google::Apis::IdentitytoolkitV3::SetProjectConfigRequest::Representation
473
+ command.request_object = set_project_config_request_object
474
+ command.response_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySetProjectConfigResponse::Representation
475
+ command.response_class = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySetProjectConfigResponse
476
+ command.query['fields'] = fields unless fields.nil?
477
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
478
+ command.query['userIp'] = user_ip unless user_ip.nil?
479
+ execute_or_queue_command(command, &block)
480
+ end
481
+
482
+ # Sign out user.
483
+ # @param [Google::Apis::IdentitytoolkitV3::SignOutUserRequest] sign_out_user_request_object
484
+ # @param [String] fields
485
+ # Selector specifying which fields to include in a partial response.
486
+ # @param [String] quota_user
487
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
488
+ # characters.
489
+ # @param [String] user_ip
490
+ # Deprecated. Please use quotaUser instead.
491
+ # @param [Google::Apis::RequestOptions] options
492
+ # Request-specific options
493
+ #
494
+ # @yield [result, err] Result & error if block supplied
495
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::SignOutUserResponse] parsed result object
496
+ # @yieldparam err [StandardError] error object if request failed
497
+ #
498
+ # @return [Google::Apis::IdentitytoolkitV3::SignOutUserResponse]
499
+ #
500
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
501
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
502
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
503
+ def sign_out_user(sign_out_user_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
504
+ command = make_simple_command(:post, 'signOutUser', options)
505
+ command.request_representation = Google::Apis::IdentitytoolkitV3::SignOutUserRequest::Representation
506
+ command.request_object = sign_out_user_request_object
507
+ command.response_representation = Google::Apis::IdentitytoolkitV3::SignOutUserResponse::Representation
508
+ command.response_class = Google::Apis::IdentitytoolkitV3::SignOutUserResponse
509
+ command.query['fields'] = fields unless fields.nil?
510
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
511
+ command.query['userIp'] = user_ip unless user_ip.nil?
512
+ execute_or_queue_command(command, &block)
513
+ end
514
+
515
+ # Signup new user.
516
+ # @param [Google::Apis::IdentitytoolkitV3::SignupNewUserRequest] signup_new_user_request_object
517
+ # @param [String] fields
518
+ # Selector specifying which fields to include in a partial response.
519
+ # @param [String] quota_user
520
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
521
+ # characters.
522
+ # @param [String] user_ip
523
+ # Deprecated. Please use quotaUser instead.
524
+ # @param [Google::Apis::RequestOptions] options
525
+ # Request-specific options
526
+ #
527
+ # @yield [result, err] Result & error if block supplied
528
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::SignupNewUserResponse] parsed result object
529
+ # @yieldparam err [StandardError] error object if request failed
530
+ #
531
+ # @return [Google::Apis::IdentitytoolkitV3::SignupNewUserResponse]
532
+ #
533
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
534
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
535
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
536
+ def signup_new_user(signup_new_user_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
537
+ command = make_simple_command(:post, 'signupNewUser', options)
538
+ command.request_representation = Google::Apis::IdentitytoolkitV3::SignupNewUserRequest::Representation
539
+ command.request_object = signup_new_user_request_object
540
+ command.response_representation = Google::Apis::IdentitytoolkitV3::SignupNewUserResponse::Representation
541
+ command.response_class = Google::Apis::IdentitytoolkitV3::SignupNewUserResponse
542
+ command.query['fields'] = fields unless fields.nil?
543
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
544
+ command.query['userIp'] = user_ip unless user_ip.nil?
545
+ execute_or_queue_command(command, &block)
546
+ end
547
+
548
+ # Batch upload existing user accounts.
549
+ # @param [Google::Apis::IdentitytoolkitV3::UploadAccountRequest] upload_account_request_object
550
+ # @param [String] fields
551
+ # Selector specifying which fields to include in a partial response.
552
+ # @param [String] quota_user
553
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
554
+ # characters.
555
+ # @param [String] user_ip
556
+ # Deprecated. Please use quotaUser instead.
557
+ # @param [Google::Apis::RequestOptions] options
558
+ # Request-specific options
559
+ #
560
+ # @yield [result, err] Result & error if block supplied
561
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::UploadAccountResponse] parsed result object
562
+ # @yieldparam err [StandardError] error object if request failed
563
+ #
564
+ # @return [Google::Apis::IdentitytoolkitV3::UploadAccountResponse]
565
+ #
566
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
567
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
568
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
569
+ def upload_account(upload_account_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
570
+ command = make_simple_command(:post, 'uploadAccount', options)
571
+ command.request_representation = Google::Apis::IdentitytoolkitV3::UploadAccountRequest::Representation
572
+ command.request_object = upload_account_request_object
573
+ command.response_representation = Google::Apis::IdentitytoolkitV3::UploadAccountResponse::Representation
574
+ command.response_class = Google::Apis::IdentitytoolkitV3::UploadAccountResponse
575
+ command.query['fields'] = fields unless fields.nil?
576
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
577
+ command.query['userIp'] = user_ip unless user_ip.nil?
578
+ execute_or_queue_command(command, &block)
579
+ end
580
+
581
+ # Verifies the assertion returned by the IdP.
582
+ # @param [Google::Apis::IdentitytoolkitV3::VerifyAssertionRequest] verify_assertion_request_object
583
+ # @param [String] fields
584
+ # Selector specifying which fields to include in a partial response.
585
+ # @param [String] quota_user
586
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
587
+ # characters.
588
+ # @param [String] user_ip
589
+ # Deprecated. Please use quotaUser instead.
590
+ # @param [Google::Apis::RequestOptions] options
591
+ # Request-specific options
592
+ #
593
+ # @yield [result, err] Result & error if block supplied
594
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse] parsed result object
595
+ # @yieldparam err [StandardError] error object if request failed
596
+ #
597
+ # @return [Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse]
598
+ #
599
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
600
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
601
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
602
+ def verify_assertion(verify_assertion_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
603
+ command = make_simple_command(:post, 'verifyAssertion', options)
604
+ command.request_representation = Google::Apis::IdentitytoolkitV3::VerifyAssertionRequest::Representation
605
+ command.request_object = verify_assertion_request_object
606
+ command.response_representation = Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse::Representation
607
+ command.response_class = Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse
608
+ command.query['fields'] = fields unless fields.nil?
609
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
610
+ command.query['userIp'] = user_ip unless user_ip.nil?
611
+ execute_or_queue_command(command, &block)
612
+ end
613
+
614
+ # Verifies the developer asserted ID token.
615
+ # @param [Google::Apis::IdentitytoolkitV3::VerifyCustomTokenRequest] verify_custom_token_request_object
616
+ # @param [String] fields
617
+ # Selector specifying which fields to include in a partial response.
618
+ # @param [String] quota_user
619
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
620
+ # characters.
621
+ # @param [String] user_ip
622
+ # Deprecated. Please use quotaUser instead.
623
+ # @param [Google::Apis::RequestOptions] options
624
+ # Request-specific options
625
+ #
626
+ # @yield [result, err] Result & error if block supplied
627
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::VerifyCustomTokenResponse] parsed result object
628
+ # @yieldparam err [StandardError] error object if request failed
629
+ #
630
+ # @return [Google::Apis::IdentitytoolkitV3::VerifyCustomTokenResponse]
631
+ #
632
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
633
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
634
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
635
+ def verify_custom_token(verify_custom_token_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
636
+ command = make_simple_command(:post, 'verifyCustomToken', options)
637
+ command.request_representation = Google::Apis::IdentitytoolkitV3::VerifyCustomTokenRequest::Representation
638
+ command.request_object = verify_custom_token_request_object
639
+ command.response_representation = Google::Apis::IdentitytoolkitV3::VerifyCustomTokenResponse::Representation
640
+ command.response_class = Google::Apis::IdentitytoolkitV3::VerifyCustomTokenResponse
641
+ command.query['fields'] = fields unless fields.nil?
642
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
643
+ command.query['userIp'] = user_ip unless user_ip.nil?
644
+ execute_or_queue_command(command, &block)
645
+ end
646
+
647
+ # Verifies the user entered password.
648
+ # @param [Google::Apis::IdentitytoolkitV3::VerifyPasswordRequest] verify_password_request_object
649
+ # @param [String] fields
650
+ # Selector specifying which fields to include in a partial response.
651
+ # @param [String] quota_user
652
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
653
+ # characters.
654
+ # @param [String] user_ip
655
+ # Deprecated. Please use quotaUser instead.
656
+ # @param [Google::Apis::RequestOptions] options
657
+ # Request-specific options
658
+ #
659
+ # @yield [result, err] Result & error if block supplied
660
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::VerifyPasswordResponse] parsed result object
661
+ # @yieldparam err [StandardError] error object if request failed
662
+ #
663
+ # @return [Google::Apis::IdentitytoolkitV3::VerifyPasswordResponse]
664
+ #
665
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
666
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
667
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
668
+ def verify_password(verify_password_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
669
+ command = make_simple_command(:post, 'verifyPassword', options)
670
+ command.request_representation = Google::Apis::IdentitytoolkitV3::VerifyPasswordRequest::Representation
671
+ command.request_object = verify_password_request_object
672
+ command.response_representation = Google::Apis::IdentitytoolkitV3::VerifyPasswordResponse::Representation
673
+ command.response_class = Google::Apis::IdentitytoolkitV3::VerifyPasswordResponse
674
+ command.query['fields'] = fields unless fields.nil?
675
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
676
+ command.query['userIp'] = user_ip unless user_ip.nil?
677
+ execute_or_queue_command(command, &block)
678
+ end
679
+
680
+ # Verifies ownership of a phone number and creates/updates the user account
681
+ # accordingly.
682
+ # @param [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest] identitytoolkit_relyingparty_verify_phone_number_request_object
683
+ # @param [String] fields
684
+ # Selector specifying which fields to include in a partial response.
685
+ # @param [String] quota_user
686
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
687
+ # characters.
688
+ # @param [String] user_ip
689
+ # Deprecated. Please use quotaUser instead.
690
+ # @param [Google::Apis::RequestOptions] options
691
+ # Request-specific options
692
+ #
693
+ # @yield [result, err] Result & error if block supplied
694
+ # @yieldparam result [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse] parsed result object
695
+ # @yieldparam err [StandardError] error object if request failed
696
+ #
697
+ # @return [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse]
698
+ #
699
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
700
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
701
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
702
+ def verify_relyingparty_phone_number(identitytoolkit_relyingparty_verify_phone_number_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
703
+ command = make_simple_command(:post, 'verifyPhoneNumber', options)
704
+ command.request_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest::Representation
705
+ command.request_object = identitytoolkit_relyingparty_verify_phone_number_request_object
706
+ command.response_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse::Representation
707
+ command.response_class = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse
708
+ command.query['fields'] = fields unless fields.nil?
709
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
710
+ command.query['userIp'] = user_ip unless user_ip.nil?
711
+ execute_or_queue_command(command, &block)
712
+ end
713
+
714
+ protected
715
+
716
+ def apply_command_defaults(command)
717
+ command.query['key'] = key unless key.nil?
718
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
719
+ command.query['userIp'] = user_ip unless user_ip.nil?
720
+ end
721
+ end
722
+ end
723
+ end
724
+ end