-
Notifications
You must be signed in to change notification settings - Fork 903
/
apiSpec.ts
8580 lines (8579 loc) · 364 KB
/
apiSpec.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
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
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* DO NOT EDIT! This file is automatically generated by scripts/gen-auth-api-spec.ts. */
/* See README.md (Section: Autogenerated files) for how to read / review this file. */
/* eslint-disable */
export default {
openapi: "3.0.3",
info: {
title: "Identity Toolkit API",
description:
"The Google Identity Toolkit API lets you use open standards to verify a user's identity.",
contact: { name: "Google", url: "https://google.com" },
version: "v1",
license: {
name: "Creative Commons Attribution 3.0",
url: "http://creativecommons.org/licenses/by/3.0/",
},
termsOfService: "https://developers.google.com/terms/",
},
servers: [{ url: "https://identitytoolkit.googleapis.com" }],
externalDocs: { url: "https://cloud.google.com/identity-platform" },
tags: [
{ name: "accounts" },
{ name: "projects" },
{ name: "v1" },
{ name: "defaultSupportedIdps" },
{ name: "v2" },
{ name: "secureToken" },
{ name: "emulator" },
],
paths: {
"/v1/accounts:createAuthUri": {
post: {
description:
"If an email identifier is specified, checks and returns if any user account is registered with the email. If there is a registered account, fetches all providers associated with the account's email. If the provider ID of an Identity Provider (IdP) is specified, creates an authorization URI for the IdP. The user can be directed to this URI to sign in with the IdP. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.createAuthUri",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1CreateAuthUriResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1CreateAuthUriRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:delete": {
post: {
description: "Deletes a user's account.",
operationId: "identitytoolkit.accounts.delete",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1DeleteAccountResponse",
},
},
},
},
},
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1DeleteAccountRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:issueSamlResponse": {
post: {
description: "Experimental",
operationId: "identitytoolkit.accounts.issueSamlResponse",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1IssueSamlResponseResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1IssueSamlResponseRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:lookup": {
post: {
description:
"Gets account information for all matched accounts. For an end user request, retrieves the account of the end user. For an admin request with Google OAuth 2.0 credential, retrieves one or multiple account(s) with matching criteria.",
operationId: "identitytoolkit.accounts.lookup",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetAccountInfoResponse",
},
},
},
},
},
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1GetAccountInfoRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:resetPassword": {
post: {
description:
"Resets the password of an account either using an out-of-band code generated by sendOobCode or by specifying the email and password of the account to be modified. Can also check the purpose of an out-of-band code without consuming it.",
operationId: "identitytoolkit.accounts.resetPassword",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1ResetPasswordResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1ResetPasswordRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:sendOobCode": {
post: {
description:
"Sends an out-of-band confirmation code for an account. Requests from a authenticated request can optionally return a link including the OOB code instead of sending it.",
operationId: "identitytoolkit.accounts.sendOobCode",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetOobCodeResponse",
},
},
},
},
},
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1GetOobCodeRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:sendVerificationCode": {
post: {
description:
"Sends a SMS verification code for phone number sign-in. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.sendVerificationCode",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SendVerificationCodeResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signInWithCustomToken": {
post: {
description:
"Signs in or signs up a user by exchanging a custom Auth token. Upon a successful sign-in or sign-up, a new Identity Platform ID token and refresh token are issued for the user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.signInWithCustomToken",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithCustomTokenResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithCustomTokenRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signInWithEmailLink": {
post: {
description:
"Signs in or signs up a user with a out-of-band code from an email link. If a user does not exist with the given email address, a user record will be created. If the sign-in succeeds, an Identity Platform ID and refresh token are issued for the authenticated user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.signInWithEmailLink",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithEmailLinkResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signInWithGameCenter": {
post: {
description:
"Signs in or signs up a user with iOS Game Center credentials. If the sign-in succeeds, a new Identity Platform ID token and refresh token are issued for the authenticated user. The bundle ID is required in the request header as `x-ios-bundle-identifier`. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project. Apple has [deprecated the `playerID` field](https://developer.apple.com/documentation/gamekit/gkplayer/1521127-playerid/). The Apple platform Firebase SDK will use `gamePlayerID` and `teamPlayerID` from version 10.5.0 and onwards. Upgrading to SDK version 10.5.0 or later updates existing integrations that use `playerID` to instead use `gamePlayerID` and `teamPlayerID`. When making calls to `signInWithGameCenter`, you must include `playerID` along with the new fields `gamePlayerID` and `teamPlayerID` to successfully identify all existing users. Upgrading existing Game Center sign in integrations to SDK version 10.5.0 or later is irreversible.",
operationId: "identitytoolkit.accounts.signInWithGameCenter",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithGameCenterResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithGameCenterRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signInWithIdp": {
post: {
description:
'Signs in or signs up a user using credentials from an Identity Provider (IdP). This is done by manually providing an IdP credential, or by providing the authorization response obtained via the authorization request from CreateAuthUri. If the sign-in succeeds, a new Identity Platform ID token and refresh token are issued for the authenticated user. A new Identity Platform user account will be created if the user has not previously signed in to the IdP with the same account. In addition, when the "One account per email address" setting is enabled, there should not be an existing Identity Platform user account with the same email address for a new user account to be created. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.',
operationId: "identitytoolkit.accounts.signInWithIdp",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithIdpResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithIdpRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signInWithPassword": {
post: {
description:
"Signs in a user with email and password. If the sign-in succeeds, a new Identity Platform ID token and refresh token are issued for the authenticated user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.signInWithPassword",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithPasswordResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithPasswordRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signInWithPhoneNumber": {
post: {
description:
"Completes a phone number authentication attempt. If a user already exists with the given phone number, an ID token is minted for that user. Otherwise, a new user is created and associated with the phone number. This method may also be used to link a phone number to an existing user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.signInWithPhoneNumber",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signUp": {
post: {
description:
"Signs up a new email and password user or anonymous user, or upgrades an anonymous user to email and password. For an admin request with a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control), creates a new anonymous, email and password, or phone number user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.signUp",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignUpResponse" },
},
},
},
},
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1SignUpRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:update": {
post: {
description:
"Updates account-related information for the specified user by setting specific fields or applying action codes. Requests from administrators and end users are supported.",
operationId: "identitytoolkit.accounts.update",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SetAccountInfoResponse",
},
},
},
},
},
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1SetAccountInfoRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:verifyIosClient": {
post: {
description:
"Verifies an iOS client is a real iOS device. If the request is valid, a receipt will be sent in the response and a secret will be sent via Apple Push Notification Service. The client should send both of them back to certain Identity Platform APIs in a later call (for example, /accounts:sendVerificationCode), in order to verify the client. The bundle ID is required in the request header as `x-ios-bundle-identifier`. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.verifyIosClient",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1VerifyIosClientResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1VerifyIosClientRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/projects/{targetProjectId}/accounts": {
post: {
description:
"Signs up a new email and password user or anonymous user, or upgrades an anonymous user to email and password. For an admin request with a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control), creates a new anonymous, email and password, or phone number user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.projects.accounts",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignUpResponse" },
},
},
},
},
parameters: [
{
name: "targetProjectId",
in: "path",
description:
"The project ID of the project which the user should belong to. Specifying this field requires a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control). If this is not set, the target project is inferred from the scope associated to the Bearer access token.",
required: true,
schema: { type: "string" },
},
],
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1SignUpRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["projects"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/projects/{targetProjectId}:createSessionCookie": {
post: {
description:
"Creates a session cookie for the given Identity Platform ID token. The session cookie is used by the client to preserve the user's login state.",
operationId: "identitytoolkit.projects.createSessionCookie",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse",
},
},
},
},
},
parameters: [
{
name: "targetProjectId",
in: "path",
description: "The ID of the project that the account belongs to.",
required: true,
schema: { type: "string" },
},
],
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["projects"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/projects/{targetProjectId}:queryAccounts": {
post: {
description:
"Looks up user accounts within a project or a tenant based on conditions in the request.",
operationId: "identitytoolkit.projects.queryAccounts",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1QueryUserInfoResponse",
},
},
},
},
},
parameters: [
{
name: "targetProjectId",
in: "path",
description: "The ID of the project to which the result is scoped.",
required: true,
schema: { type: "string" },
},
],
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1QueryUserInfoRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ Oauth2: ["https://www.googleapis.com/auth/firebase"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["projects"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/projects/{targetProjectId}/accounts:batchCreate": {
post: {
description:
"Uploads multiple accounts into the Google Cloud project. If there is a problem uploading one or more of the accounts, the rest will be uploaded, and a list of the errors will be returned. To use this method requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
operationId: "identitytoolkit.projects.accounts.batchCreate",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1UploadAccountResponse",
},
},
},
},
},
parameters: [
{
name: "targetProjectId",
in: "path",
description:
"The Project ID of the Identity Platform project which the account belongs to.",
required: true,
schema: { type: "string" },
},
],
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1UploadAccountRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ Oauth2: ["https://www.googleapis.com/auth/firebase"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["projects"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/projects/{targetProjectId}/accounts:batchDelete": {
post: {
description:
"Batch deletes multiple accounts. For accounts that fail to be deleted, error info is contained in the response. The method ignores accounts that do not exist or are duplicated in the request. This method requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).",
operationId: "identitytoolkit.projects.accounts.batchDelete",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse",
},
},
},
},
},
parameters: [
{
name: "targetProjectId",
in: "path",
description:
"If `tenant_id` is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that accounts belong to.",
required: true,
schema: { type: "string" },
},
],
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ Oauth2: ["https://www.googleapis.com/auth/firebase"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["projects"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/projects/{targetProjectId}/accounts:batchGet": {
get: {
description:
"Download account information for all accounts on the project in a paginated manner. To use this method requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).. Furthermore, additional permissions are needed to get password hash, password salt, and password version from accounts; otherwise these fields are redacted.",
operationId: "identitytoolkit.projects.accounts.batchGet",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1DownloadAccountResponse",
},
},
},
},
},
parameters: [
{
name: "targetProjectId",
in: "path",
description:
"If `tenant_id` is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that the accounts belong to.",
required: true,
schema: { type: "string" },
},
{ name: "delegatedProjectNumber", in: "query", schema: { type: "string" } },
{
name: "maxResults",
in: "query",
description:
"The maximum number of results to return. Must be at least 1 and no greater than 1000. By default, it is 20.",
schema: { type: "integer" },
},
{
name: "nextPageToken",
in: "query",
description: "The pagination token from the response of a previous request.",
schema: { type: "string" },
},