@faable/auth-sdk 1.3.8 → 1.3.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4371 +0,0 @@
1
- /**
2
- * This file was auto-generated by openapi-typescript.
3
- * Do not make direct changes to the file.
4
- */
5
- export interface paths {
6
- "/metrics": {
7
- parameters: {
8
- query?: never;
9
- header?: never;
10
- path?: never;
11
- cookie?: never;
12
- };
13
- get: {
14
- parameters: {
15
- query?: never;
16
- header?: never;
17
- path?: never;
18
- cookie?: never;
19
- };
20
- requestBody?: never;
21
- responses: {
22
- /** @description Default Response */
23
- 200: {
24
- headers: {
25
- [name: string]: unknown;
26
- };
27
- content?: never;
28
- };
29
- };
30
- };
31
- put?: never;
32
- post?: never;
33
- delete?: never;
34
- options?: never;
35
- head?: never;
36
- patch?: never;
37
- trace?: never;
38
- };
39
- "/account/current": {
40
- parameters: {
41
- query?: never;
42
- header?: never;
43
- path?: never;
44
- cookie?: never;
45
- };
46
- /**
47
- * Get current Account
48
- * @description Get current Account
49
- */
50
- get: {
51
- parameters: {
52
- query?: never;
53
- header?: never;
54
- path?: never;
55
- cookie?: never;
56
- };
57
- requestBody?: never;
58
- responses: {
59
- /** @description AuthAccount */
60
- 200: {
61
- headers: {
62
- [name: string]: unknown;
63
- };
64
- content: {
65
- "application/json": components["schemas"]["AuthAccount"];
66
- };
67
- };
68
- };
69
- };
70
- put?: never;
71
- post?: never;
72
- delete?: never;
73
- options?: never;
74
- head?: never;
75
- patch?: never;
76
- trace?: never;
77
- };
78
- "/account": {
79
- parameters: {
80
- query?: never;
81
- header?: never;
82
- path?: never;
83
- cookie?: never;
84
- };
85
- /**
86
- * List Auth Accounts
87
- * @description List Auth Accounts
88
- */
89
- get: {
90
- parameters: {
91
- query?: {
92
- /** @description Start from this cursor */
93
- cursor?: string;
94
- /** @description Start from this cursor */
95
- next?: string;
96
- /** @description Size of the results array */
97
- pageSize?: number;
98
- };
99
- header?: never;
100
- path?: never;
101
- cookie?: never;
102
- };
103
- requestBody?: never;
104
- responses: {
105
- /** @description PaginatedResponse */
106
- 200: {
107
- headers: {
108
- [name: string]: unknown;
109
- };
110
- content: {
111
- "application/json": {
112
- /** @description next cursor */
113
- next: string | null;
114
- /** @description List of results */
115
- results: components["schemas"]["AuthAccount"][];
116
- };
117
- };
118
- };
119
- };
120
- };
121
- put?: never;
122
- /**
123
- * Create an Account
124
- * @description Create an Account
125
- */
126
- post: {
127
- parameters: {
128
- query?: never;
129
- header?: never;
130
- path?: never;
131
- cookie?: never;
132
- };
133
- requestBody?: {
134
- content: {
135
- "application/json": components["schemas"]["AuthAccountCreate"];
136
- };
137
- };
138
- responses: {
139
- /** @description AuthAccount */
140
- 201: {
141
- headers: {
142
- [name: string]: unknown;
143
- };
144
- content: {
145
- "application/json": components["schemas"]["AuthAccount"];
146
- };
147
- };
148
- };
149
- };
150
- delete?: never;
151
- options?: never;
152
- head?: never;
153
- patch?: never;
154
- trace?: never;
155
- };
156
- "/account/{account_id}": {
157
- parameters: {
158
- query?: never;
159
- header?: never;
160
- path?: never;
161
- cookie?: never;
162
- };
163
- /**
164
- * Get Account
165
- * @description Get Account
166
- */
167
- get: {
168
- parameters: {
169
- query?: never;
170
- header?: never;
171
- path: {
172
- account_id: string;
173
- };
174
- cookie?: never;
175
- };
176
- requestBody?: never;
177
- responses: {
178
- /** @description AuthAccount */
179
- 200: {
180
- headers: {
181
- [name: string]: unknown;
182
- };
183
- content: {
184
- "application/json": {
185
- /** @description AuthAccount ID */
186
- id: string;
187
- name: string;
188
- domain: string;
189
- slug: string;
190
- logo_src?: string | null;
191
- icon_src?: string | null;
192
- callback_hostnames: string[];
193
- token_signature: string;
194
- default_connection?: components["schemas"]["Connection"] | string | unknown;
195
- enabled_locales: string[];
196
- team?: string | null;
197
- /** @description AuthAccount creation date */
198
- createdAt: string;
199
- /** @description AuthAccount updated date */
200
- updatedAt?: string;
201
- };
202
- };
203
- };
204
- };
205
- };
206
- put?: never;
207
- post?: never;
208
- /**
209
- * Delete an Account
210
- * @description Delete an Account
211
- */
212
- delete: {
213
- parameters: {
214
- query?: never;
215
- header?: never;
216
- path: {
217
- account_id: string;
218
- };
219
- cookie?: never;
220
- };
221
- requestBody?: never;
222
- responses: never;
223
- };
224
- options?: never;
225
- head?: never;
226
- patch?: never;
227
- trace?: never;
228
- };
229
- "/account/host/{host}": {
230
- parameters: {
231
- query?: never;
232
- header?: never;
233
- path?: never;
234
- cookie?: never;
235
- };
236
- /**
237
- * Find account by host
238
- * @description Find account by host
239
- */
240
- get: {
241
- parameters: {
242
- query?: never;
243
- header?: never;
244
- path: {
245
- host: string;
246
- };
247
- cookie?: never;
248
- };
249
- requestBody?: never;
250
- responses: {
251
- /** @description AuthAccount */
252
- 200: {
253
- headers: {
254
- [name: string]: unknown;
255
- };
256
- content: {
257
- "application/json": {
258
- /** @description AuthAccount ID */
259
- id: string;
260
- name: string;
261
- domain: string;
262
- slug: string;
263
- logo_src?: string | null;
264
- icon_src?: string | null;
265
- callback_hostnames: string[];
266
- token_signature: string;
267
- default_connection?: components["schemas"]["Connection"] | string | unknown;
268
- enabled_locales: string[];
269
- team?: string | null;
270
- /** @description AuthAccount creation date */
271
- createdAt: string;
272
- /** @description AuthAccount updated date */
273
- updatedAt?: string;
274
- };
275
- };
276
- };
277
- };
278
- };
279
- put?: never;
280
- post?: never;
281
- delete?: never;
282
- options?: never;
283
- head?: never;
284
- patch?: never;
285
- trace?: never;
286
- };
287
- "/connection": {
288
- parameters: {
289
- query?: never;
290
- header?: never;
291
- path?: never;
292
- cookie?: never;
293
- };
294
- /**
295
- * List Connections in Account
296
- * @description List Connections in Account
297
- */
298
- get: operations["connection/list"];
299
- put?: never;
300
- /**
301
- * Create Connection in Account
302
- * @description Create Connection in Account
303
- */
304
- post: operations["connection/create"];
305
- delete?: never;
306
- options?: never;
307
- head?: never;
308
- patch?: never;
309
- trace?: never;
310
- };
311
- "/connection/{connection_id}": {
312
- parameters: {
313
- query?: never;
314
- header?: never;
315
- path?: never;
316
- cookie?: never;
317
- };
318
- /**
319
- * Get Connection in Account
320
- * @description Get Connection in Account
321
- */
322
- get: operations["connection/get"];
323
- put?: never;
324
- post?: never;
325
- /**
326
- * Delete Connection in Account
327
- * @description Delete Connection in Account
328
- */
329
- delete: operations["connection/remove"];
330
- options?: never;
331
- head?: never;
332
- patch?: never;
333
- trace?: never;
334
- };
335
- "/client": {
336
- parameters: {
337
- query?: never;
338
- header?: never;
339
- path?: never;
340
- cookie?: never;
341
- };
342
- /**
343
- * List Clients in Account
344
- * @description List Clients in Account
345
- */
346
- get: operations["client/list"];
347
- put?: never;
348
- /**
349
- * Create Client in Account
350
- * @description Create Client in Account
351
- */
352
- post: operations["client/create"];
353
- delete?: never;
354
- options?: never;
355
- head?: never;
356
- patch?: never;
357
- trace?: never;
358
- };
359
- "/client/{client_id}": {
360
- parameters: {
361
- query?: never;
362
- header?: never;
363
- path?: never;
364
- cookie?: never;
365
- };
366
- /**
367
- * Get Client in Account
368
- * @description Get Client in Account
369
- */
370
- get: operations["client/get"];
371
- put?: never;
372
- post?: never;
373
- /**
374
- * Delete Client in Account
375
- * @description Delete Client in Account
376
- */
377
- delete: operations["client/remove"];
378
- options?: never;
379
- head?: never;
380
- patch?: never;
381
- trace?: never;
382
- };
383
- "/user": {
384
- parameters: {
385
- query?: never;
386
- header?: never;
387
- path?: never;
388
- cookie?: never;
389
- };
390
- /**
391
- * List Users in Account
392
- * @description List Users in Account
393
- */
394
- get: operations["user/list"];
395
- put?: never;
396
- /**
397
- * Create User in Account
398
- * @description Create User in Account
399
- */
400
- post: operations["user/create"];
401
- delete?: never;
402
- options?: never;
403
- head?: never;
404
- patch?: never;
405
- trace?: never;
406
- };
407
- "/user/{user_id}": {
408
- parameters: {
409
- query?: never;
410
- header?: never;
411
- path?: never;
412
- cookie?: never;
413
- };
414
- /**
415
- * Get User in Account
416
- * @description Get User in Account
417
- */
418
- get: operations["user/get"];
419
- put?: never;
420
- /**
421
- * Update Users in Account
422
- * @description Update Users in Account
423
- */
424
- post: operations["user/update"];
425
- /**
426
- * Delete User in Account
427
- * @description Delete User in Account
428
- */
429
- delete: operations["user/remove"];
430
- options?: never;
431
- head?: never;
432
- patch?: never;
433
- trace?: never;
434
- };
435
- "/identity": {
436
- parameters: {
437
- query?: never;
438
- header?: never;
439
- path?: never;
440
- cookie?: never;
441
- };
442
- /**
443
- * List Identitys in Account
444
- * @description List Identitys in Account
445
- */
446
- get: operations["identity/list"];
447
- put?: never;
448
- /**
449
- * Create Identity in Account
450
- * @description Create Identity in Account
451
- */
452
- post: operations["identity/create"];
453
- delete?: never;
454
- options?: never;
455
- head?: never;
456
- patch?: never;
457
- trace?: never;
458
- };
459
- "/identity/{identity_id}": {
460
- parameters: {
461
- query?: never;
462
- header?: never;
463
- path?: never;
464
- cookie?: never;
465
- };
466
- /**
467
- * Get Identity in Account
468
- * @description Get Identity in Account
469
- */
470
- get: operations["identity/get"];
471
- put?: never;
472
- post?: never;
473
- /**
474
- * Delete Identity in Account
475
- * @description Delete Identity in Account
476
- */
477
- delete: operations["identity/remove"];
478
- options?: never;
479
- head?: never;
480
- patch?: never;
481
- trace?: never;
482
- };
483
- "/role": {
484
- parameters: {
485
- query?: never;
486
- header?: never;
487
- path?: never;
488
- cookie?: never;
489
- };
490
- /**
491
- * List Roles in Account
492
- * @description List Roles in Account
493
- */
494
- get: operations["role/list"];
495
- put?: never;
496
- /**
497
- * Create Role in Account
498
- * @description Create Role in Account
499
- */
500
- post: operations["role/create"];
501
- delete?: never;
502
- options?: never;
503
- head?: never;
504
- patch?: never;
505
- trace?: never;
506
- };
507
- "/role/{role_id}": {
508
- parameters: {
509
- query?: never;
510
- header?: never;
511
- path?: never;
512
- cookie?: never;
513
- };
514
- /**
515
- * Get Role in Account
516
- * @description Get Role in Account
517
- */
518
- get: operations["role/get"];
519
- put?: never;
520
- post?: never;
521
- /**
522
- * Delete Role in Account
523
- * @description Delete Role in Account
524
- */
525
- delete: operations["role/remove"];
526
- options?: never;
527
- head?: never;
528
- patch?: never;
529
- trace?: never;
530
- };
531
- "/role/{role_id}/users": {
532
- parameters: {
533
- query?: never;
534
- header?: never;
535
- path?: never;
536
- cookie?: never;
537
- };
538
- /**
539
- * List Users with Role
540
- * @description List Users with Role
541
- */
542
- get: operations["role/users"];
543
- put?: never;
544
- /**
545
- * Assign Users to Role
546
- * @description Assign Users to Role
547
- */
548
- post: operations["role/assign_users"];
549
- delete?: never;
550
- options?: never;
551
- head?: never;
552
- patch?: never;
553
- trace?: never;
554
- };
555
- "/rolemember": {
556
- parameters: {
557
- query?: never;
558
- header?: never;
559
- path?: never;
560
- cookie?: never;
561
- };
562
- /**
563
- * List Rolemembers in Account
564
- * @description List Rolemembers in Account
565
- */
566
- get: operations["rolemember/list"];
567
- put?: never;
568
- /**
569
- * Create Rolemember in Account
570
- * @description Create Rolemember in Account
571
- */
572
- post: operations["rolemember/create"];
573
- delete?: never;
574
- options?: never;
575
- head?: never;
576
- patch?: never;
577
- trace?: never;
578
- };
579
- "/rolemember/{rolemember_id}": {
580
- parameters: {
581
- query?: never;
582
- header?: never;
583
- path?: never;
584
- cookie?: never;
585
- };
586
- /**
587
- * Get Rolemember in Account
588
- * @description Get Rolemember in Account
589
- */
590
- get: operations["rolemember/get"];
591
- put?: never;
592
- post?: never;
593
- /**
594
- * Delete Rolemember in Account
595
- * @description Delete Rolemember in Account
596
- */
597
- delete: operations["rolemember/remove"];
598
- options?: never;
599
- head?: never;
600
- patch?: never;
601
- trace?: never;
602
- };
603
- "/team": {
604
- parameters: {
605
- query?: never;
606
- header?: never;
607
- path?: never;
608
- cookie?: never;
609
- };
610
- /**
611
- * List Teams in Account
612
- * @description List Teams in Account
613
- */
614
- get: operations["team/list"];
615
- put?: never;
616
- /**
617
- * Create Team in Account
618
- * @description Create Team in Account
619
- */
620
- post: operations["team/create"];
621
- delete?: never;
622
- options?: never;
623
- head?: never;
624
- patch?: never;
625
- trace?: never;
626
- };
627
- "/team/{team_id}": {
628
- parameters: {
629
- query?: never;
630
- header?: never;
631
- path?: never;
632
- cookie?: never;
633
- };
634
- /**
635
- * Get Team in Account
636
- * @description Get Team in Account
637
- */
638
- get: operations["team/get"];
639
- put?: never;
640
- post?: never;
641
- /**
642
- * Delete Team in Account
643
- * @description Delete Team in Account
644
- */
645
- delete: operations["team/remove"];
646
- options?: never;
647
- head?: never;
648
- patch?: never;
649
- trace?: never;
650
- };
651
- "/teammember": {
652
- parameters: {
653
- query?: never;
654
- header?: never;
655
- path?: never;
656
- cookie?: never;
657
- };
658
- /**
659
- * List Teammembers in Account
660
- * @description List Teammembers in Account
661
- */
662
- get: operations["teammember/list"];
663
- put?: never;
664
- /**
665
- * Create Teammember in Account
666
- * @description Create Teammember in Account
667
- */
668
- post: operations["teammember/create"];
669
- delete?: never;
670
- options?: never;
671
- head?: never;
672
- patch?: never;
673
- trace?: never;
674
- };
675
- "/teammember/{teammember_id}": {
676
- parameters: {
677
- query?: never;
678
- header?: never;
679
- path?: never;
680
- cookie?: never;
681
- };
682
- /**
683
- * Get Teammember in Account
684
- * @description Get Teammember in Account
685
- */
686
- get: operations["teammember/get"];
687
- put?: never;
688
- post?: never;
689
- /**
690
- * Delete Teammember in Account
691
- * @description Delete Teammember in Account
692
- */
693
- delete: operations["teammember/remove"];
694
- options?: never;
695
- head?: never;
696
- patch?: never;
697
- trace?: never;
698
- };
699
- "/team/{team_id}/member": {
700
- parameters: {
701
- query?: never;
702
- header?: never;
703
- path?: never;
704
- cookie?: never;
705
- };
706
- /**
707
- * List Team Members
708
- * @description List Team Members
709
- */
710
- get: {
711
- parameters: {
712
- query?: {
713
- /** @description Start from this cursor */
714
- cursor?: string;
715
- /** @description Start from this cursor */
716
- next?: string;
717
- /** @description Size of the results array */
718
- pageSize?: number;
719
- };
720
- header?: never;
721
- path: {
722
- team_id: string;
723
- };
724
- cookie?: never;
725
- };
726
- requestBody?: never;
727
- responses: {
728
- /** @description PaginatedResponse */
729
- 200: {
730
- headers: {
731
- [name: string]: unknown;
732
- };
733
- content: {
734
- "application/json": {
735
- /** @description next cursor */
736
- next: string | null;
737
- /** @description List of results */
738
- results: components["schemas"]["TeamMember"][];
739
- };
740
- };
741
- };
742
- };
743
- };
744
- put?: never;
745
- /**
746
- * Add Users as Team Members
747
- * @description Add Users as Team Members
748
- */
749
- post: {
750
- parameters: {
751
- query?: never;
752
- header?: never;
753
- path: {
754
- team_id: string;
755
- };
756
- cookie?: never;
757
- };
758
- requestBody?: {
759
- content: {
760
- "application/json": components["schemas"]["TeamMemberCreate"];
761
- };
762
- };
763
- responses: {
764
- /** @description TeamMember */
765
- 201: {
766
- headers: {
767
- [name: string]: unknown;
768
- };
769
- content: {
770
- "application/json": components["schemas"]["TeamMember"];
771
- };
772
- };
773
- };
774
- };
775
- delete?: never;
776
- options?: never;
777
- head?: never;
778
- patch?: never;
779
- trace?: never;
780
- };
781
- "/team/{team_id}/member/check/{user_id}": {
782
- parameters: {
783
- query?: never;
784
- header?: never;
785
- path?: never;
786
- cookie?: never;
787
- };
788
- /**
789
- * Check user is member of Team
790
- * @description Check user is member of Team
791
- */
792
- get: {
793
- parameters: {
794
- query?: {
795
- /** @description Start from this cursor */
796
- cursor?: string;
797
- /** @description Start from this cursor */
798
- next?: string;
799
- /** @description Size of the results array */
800
- pageSize?: number;
801
- };
802
- header?: never;
803
- path: {
804
- team_id: string;
805
- user_id: string;
806
- };
807
- cookie?: never;
808
- };
809
- requestBody?: never;
810
- responses: {
811
- /** @description TeamMember */
812
- 200: {
813
- headers: {
814
- [name: string]: unknown;
815
- };
816
- content: {
817
- "application/json": components["schemas"]["TeamMember"];
818
- };
819
- };
820
- };
821
- };
822
- put?: never;
823
- post?: never;
824
- delete?: never;
825
- options?: never;
826
- head?: never;
827
- patch?: never;
828
- trace?: never;
829
- };
830
- "/api": {
831
- parameters: {
832
- query?: never;
833
- header?: never;
834
- path?: never;
835
- cookie?: never;
836
- };
837
- /**
838
- * List Apis in Account
839
- * @description List Apis in Account
840
- */
841
- get: operations["api/list"];
842
- put?: never;
843
- /**
844
- * Create Api in Account
845
- * @description Create Api in Account
846
- */
847
- post: operations["api/create"];
848
- delete?: never;
849
- options?: never;
850
- head?: never;
851
- patch?: never;
852
- trace?: never;
853
- };
854
- "/api/{api_id}": {
855
- parameters: {
856
- query?: never;
857
- header?: never;
858
- path?: never;
859
- cookie?: never;
860
- };
861
- /**
862
- * Get Api in Account
863
- * @description Get Api in Account
864
- */
865
- get: operations["api/get"];
866
- put?: never;
867
- post?: never;
868
- /**
869
- * Delete Api in Account
870
- * @description Delete Api in Account
871
- */
872
- delete: operations["api/remove"];
873
- options?: never;
874
- head?: never;
875
- patch?: never;
876
- trace?: never;
877
- };
878
- "/account/keys/rotate": {
879
- parameters: {
880
- query?: never;
881
- header?: never;
882
- path?: never;
883
- cookie?: never;
884
- };
885
- get?: never;
886
- put?: never;
887
- /**
888
- * Rotate Account Keys
889
- * @description Rotate Account Keys
890
- */
891
- post: {
892
- parameters: {
893
- query?: never;
894
- header?: never;
895
- path?: never;
896
- cookie?: never;
897
- };
898
- requestBody?: {
899
- content: {
900
- "application/json": Record<string, never>;
901
- };
902
- };
903
- responses: {
904
- /** @description Default Response */
905
- 200: {
906
- headers: {
907
- [name: string]: unknown;
908
- };
909
- content?: never;
910
- };
911
- };
912
- };
913
- delete?: never;
914
- options?: never;
915
- head?: never;
916
- patch?: never;
917
- trace?: never;
918
- };
919
- "/action": {
920
- parameters: {
921
- query?: never;
922
- header?: never;
923
- path?: never;
924
- cookie?: never;
925
- };
926
- /**
927
- * List Actions in Account
928
- * @description List Actions in Account
929
- */
930
- get: operations["action/list"];
931
- put?: never;
932
- /**
933
- * Create Action in Account
934
- * @description Create Action in Account
935
- */
936
- post: operations["action/create"];
937
- delete?: never;
938
- options?: never;
939
- head?: never;
940
- patch?: never;
941
- trace?: never;
942
- };
943
- "/action/{action_id}": {
944
- parameters: {
945
- query?: never;
946
- header?: never;
947
- path?: never;
948
- cookie?: never;
949
- };
950
- /**
951
- * Get Action in Account
952
- * @description Get Action in Account
953
- */
954
- get: operations["action/get"];
955
- put?: never;
956
- post?: never;
957
- /**
958
- * Delete Action in Account
959
- * @description Delete Action in Account
960
- */
961
- delete: operations["action/remove"];
962
- options?: never;
963
- head?: never;
964
- patch?: never;
965
- trace?: never;
966
- };
967
- "/notificationsubscription": {
968
- parameters: {
969
- query?: never;
970
- header?: never;
971
- path?: never;
972
- cookie?: never;
973
- };
974
- /**
975
- * List Notificationsubscriptions in Account
976
- * @description List Notificationsubscriptions in Account
977
- */
978
- get: operations["notificationsubscription/list"];
979
- put?: never;
980
- /**
981
- * Create Notificationsubscription in Account
982
- * @description Create Notificationsubscription in Account
983
- */
984
- post: operations["notificationsubscription/create"];
985
- delete?: never;
986
- options?: never;
987
- head?: never;
988
- patch?: never;
989
- trace?: never;
990
- };
991
- "/notificationsubscription/{notificationsubscription_id}": {
992
- parameters: {
993
- query?: never;
994
- header?: never;
995
- path?: never;
996
- cookie?: never;
997
- };
998
- /**
999
- * Get Notificationsubscription in Account
1000
- * @description Get Notificationsubscription in Account
1001
- */
1002
- get: operations["notificationsubscription/get"];
1003
- put?: never;
1004
- /**
1005
- * Update Notificationsubscriptions in Account
1006
- * @description Update Notificationsubscriptions in Account
1007
- */
1008
- post: operations["notificationsubscription/update"];
1009
- /**
1010
- * Delete Notificationsubscription in Account
1011
- * @description Delete Notificationsubscription in Account
1012
- */
1013
- delete: operations["notificationsubscription/remove"];
1014
- options?: never;
1015
- head?: never;
1016
- patch?: never;
1017
- trace?: never;
1018
- };
1019
- "/customdomain/{Customdomain_id}/retry": {
1020
- parameters: {
1021
- query?: never;
1022
- header?: never;
1023
- path?: never;
1024
- cookie?: never;
1025
- };
1026
- get?: never;
1027
- put?: never;
1028
- /** Retry manual domain verification */
1029
- post: operations["customdomain/retry"];
1030
- delete?: never;
1031
- options?: never;
1032
- head?: never;
1033
- patch?: never;
1034
- trace?: never;
1035
- };
1036
- "/customdomain": {
1037
- parameters: {
1038
- query?: never;
1039
- header?: never;
1040
- path?: never;
1041
- cookie?: never;
1042
- };
1043
- /**
1044
- * List Customdomains in Account
1045
- * @description List Customdomains in Account
1046
- */
1047
- get: operations["customdomain/list"];
1048
- put?: never;
1049
- /**
1050
- * Create Customdomain in Account
1051
- * @description Create Customdomain in Account
1052
- */
1053
- post: operations["customdomain/create"];
1054
- delete?: never;
1055
- options?: never;
1056
- head?: never;
1057
- patch?: never;
1058
- trace?: never;
1059
- };
1060
- "/customdomain/{customdomain_id}": {
1061
- parameters: {
1062
- query?: never;
1063
- header?: never;
1064
- path?: never;
1065
- cookie?: never;
1066
- };
1067
- /**
1068
- * Get Customdomain in Account
1069
- * @description Get Customdomain in Account
1070
- */
1071
- get: operations["customdomain/get"];
1072
- put?: never;
1073
- post?: never;
1074
- /**
1075
- * Delete Customdomain in Account
1076
- * @description Delete Customdomain in Account
1077
- */
1078
- delete: operations["customdomain/remove"];
1079
- options?: never;
1080
- head?: never;
1081
- patch?: never;
1082
- trace?: never;
1083
- };
1084
- "/passwordless/verify_redirect": {
1085
- parameters: {
1086
- query?: never;
1087
- header?: never;
1088
- path?: never;
1089
- cookie?: never;
1090
- };
1091
- /**
1092
- * Receive a passwordless token via email link and convert it to a valid session
1093
- * @description Receive a passwordless token and convert it to a valid session
1094
- */
1095
- get: operations["passwordless/verify_redirect"];
1096
- put?: never;
1097
- post?: never;
1098
- delete?: never;
1099
- options?: never;
1100
- head?: never;
1101
- patch?: never;
1102
- trace?: never;
1103
- };
1104
- "/passwordless/start": {
1105
- parameters: {
1106
- query?: never;
1107
- header?: never;
1108
- path?: never;
1109
- cookie?: never;
1110
- };
1111
- get?: never;
1112
- put?: never;
1113
- /**
1114
- * Start Passwordless authentication flow
1115
- * @description Start Passwordless authentication flow
1116
- */
1117
- post: operations["passwordless/start"];
1118
- delete?: never;
1119
- options?: never;
1120
- head?: never;
1121
- patch?: never;
1122
- trace?: never;
1123
- };
1124
- "/me": {
1125
- parameters: {
1126
- query?: never;
1127
- header?: never;
1128
- path?: never;
1129
- cookie?: never;
1130
- };
1131
- /**
1132
- * Introspection endpoint for current User in session
1133
- * @description Introspection endpoint for current User in session
1134
- */
1135
- get: {
1136
- parameters: {
1137
- query?: never;
1138
- header?: never;
1139
- path?: never;
1140
- cookie?: never;
1141
- };
1142
- requestBody?: never;
1143
- responses: {
1144
- /** @description User */
1145
- 200: {
1146
- headers: {
1147
- [name: string]: unknown;
1148
- };
1149
- content: {
1150
- "application/json": components["schemas"]["User"];
1151
- };
1152
- };
1153
- };
1154
- };
1155
- put?: never;
1156
- post?: never;
1157
- delete?: never;
1158
- options?: never;
1159
- head?: never;
1160
- patch?: never;
1161
- trace?: never;
1162
- };
1163
- "/logout": {
1164
- parameters: {
1165
- query?: never;
1166
- header?: never;
1167
- path?: never;
1168
- cookie?: never;
1169
- };
1170
- /**
1171
- * Logout current user
1172
- * @description Logout current user
1173
- */
1174
- get: {
1175
- parameters: {
1176
- query?: {
1177
- client_id?: string;
1178
- returnTo?: string;
1179
- };
1180
- header?: never;
1181
- path?: never;
1182
- cookie?: never;
1183
- };
1184
- requestBody?: never;
1185
- responses: {
1186
- /** @description Default Response */
1187
- 200: {
1188
- headers: {
1189
- [name: string]: unknown;
1190
- };
1191
- content?: never;
1192
- };
1193
- };
1194
- };
1195
- put?: never;
1196
- post?: never;
1197
- delete?: never;
1198
- options?: never;
1199
- head?: never;
1200
- patch?: never;
1201
- trace?: never;
1202
- };
1203
- "/authorize": {
1204
- parameters: {
1205
- query?: never;
1206
- header?: never;
1207
- path?: never;
1208
- cookie?: never;
1209
- };
1210
- /**
1211
- * Authorization request
1212
- * @description Authorization request
1213
- */
1214
- get: operations["authorize"];
1215
- put?: never;
1216
- post?: never;
1217
- delete?: never;
1218
- options?: never;
1219
- head?: never;
1220
- patch?: never;
1221
- trace?: never;
1222
- };
1223
- "/oauth/token": {
1224
- parameters: {
1225
- query?: never;
1226
- header?: never;
1227
- path?: never;
1228
- cookie?: never;
1229
- };
1230
- /**
1231
- * Token exchange
1232
- * @description Token exchange
1233
- */
1234
- get: {
1235
- parameters: {
1236
- query?: {
1237
- /** @description Grant Type. https://oauth.net/2/grant-types/ */
1238
- grant_type?: "authorization_code" | "client_credentials" | "refresh_token" | "password" | "http://auth0.com/oauth/grant-type/passwordless/otp" | "urn:ietf:params:oauth:grant-type:token-exchange" | "urn:ietf:params:oauth:grant-type:device_code";
1239
- client_id?: string;
1240
- client_secret?: string;
1241
- scope?: string;
1242
- code?: string;
1243
- code_verifier?: string;
1244
- username?: string;
1245
- otp?: string;
1246
- refresh_token?: string;
1247
- subject_token?: string;
1248
- subject_token_type?: string;
1249
- /** @description The device code returned by the authorization server. */
1250
- device_code?: string;
1251
- };
1252
- header?: never;
1253
- path?: never;
1254
- cookie?: never;
1255
- };
1256
- requestBody?: never;
1257
- responses: {
1258
- /** @description Default Response */
1259
- 200: {
1260
- headers: {
1261
- [name: string]: unknown;
1262
- };
1263
- content: {
1264
- "application/json": {
1265
- token_type: string;
1266
- expires_in: number;
1267
- access_token: string;
1268
- refresh_token?: string;
1269
- id_token?: string;
1270
- scope?: string;
1271
- };
1272
- };
1273
- };
1274
- };
1275
- };
1276
- put?: never;
1277
- /**
1278
- * Token exchange
1279
- * @description Token exchange
1280
- */
1281
- post: {
1282
- parameters: {
1283
- query?: {
1284
- /** @description Grant Type. https://oauth.net/2/grant-types/ */
1285
- grant_type?: "authorization_code" | "client_credentials" | "refresh_token" | "password" | "http://auth0.com/oauth/grant-type/passwordless/otp" | "urn:ietf:params:oauth:grant-type:token-exchange" | "urn:ietf:params:oauth:grant-type:device_code";
1286
- client_id?: string;
1287
- client_secret?: string;
1288
- scope?: string;
1289
- code?: string;
1290
- code_verifier?: string;
1291
- username?: string;
1292
- otp?: string;
1293
- refresh_token?: string;
1294
- subject_token?: string;
1295
- subject_token_type?: string;
1296
- /** @description The device code returned by the authorization server. */
1297
- device_code?: string;
1298
- };
1299
- header?: never;
1300
- path?: never;
1301
- cookie?: never;
1302
- };
1303
- requestBody?: {
1304
- content: {
1305
- "application/json": {
1306
- /** @description Grant Type. https://oauth.net/2/grant-types/ */
1307
- grant_type?: "authorization_code" | "client_credentials" | "refresh_token" | "password" | "http://auth0.com/oauth/grant-type/passwordless/otp" | "urn:ietf:params:oauth:grant-type:token-exchange" | "urn:ietf:params:oauth:grant-type:device_code";
1308
- client_id?: string;
1309
- client_secret?: string;
1310
- scope?: string;
1311
- code?: string;
1312
- code_verifier?: string;
1313
- username?: string;
1314
- otp?: string;
1315
- refresh_token?: string;
1316
- subject_token?: string;
1317
- subject_token_type?: string;
1318
- /** @description The device code returned by the authorization server. */
1319
- device_code?: string;
1320
- } & {
1321
- [key: string]: unknown;
1322
- };
1323
- };
1324
- };
1325
- responses: {
1326
- /** @description Default Response */
1327
- 200: {
1328
- headers: {
1329
- [name: string]: unknown;
1330
- };
1331
- content: {
1332
- "application/json": {
1333
- token_type: string;
1334
- expires_in: number;
1335
- access_token: string;
1336
- refresh_token?: string;
1337
- id_token?: string;
1338
- scope?: string;
1339
- };
1340
- };
1341
- };
1342
- };
1343
- };
1344
- delete?: never;
1345
- options?: never;
1346
- head?: never;
1347
- patch?: never;
1348
- trace?: never;
1349
- };
1350
- "/oauth/device/code": {
1351
- parameters: {
1352
- query?: never;
1353
- header?: never;
1354
- path?: never;
1355
- cookie?: never;
1356
- };
1357
- get?: never;
1358
- put?: never;
1359
- /**
1360
- * Device authorization request
1361
- * @description The device authorization endpoint is used by the device to request a device code and a user code from the authorization server.
1362
- */
1363
- post: operations["device-authorize"];
1364
- delete?: never;
1365
- options?: never;
1366
- head?: never;
1367
- patch?: never;
1368
- trace?: never;
1369
- };
1370
- "/activate": {
1371
- parameters: {
1372
- query?: never;
1373
- header?: never;
1374
- path?: never;
1375
- cookie?: never;
1376
- };
1377
- /**
1378
- * Activate device
1379
- * @description Redirects to the external device activation page.
1380
- */
1381
- get: {
1382
- parameters: {
1383
- query?: {
1384
- user_code?: string;
1385
- };
1386
- header?: never;
1387
- path?: never;
1388
- cookie?: never;
1389
- };
1390
- requestBody?: never;
1391
- responses: {
1392
- /** @description Default Response */
1393
- 200: {
1394
- headers: {
1395
- [name: string]: unknown;
1396
- };
1397
- content?: never;
1398
- };
1399
- };
1400
- };
1401
- put?: never;
1402
- post?: never;
1403
- delete?: never;
1404
- options?: never;
1405
- head?: never;
1406
- patch?: never;
1407
- trace?: never;
1408
- };
1409
- "/confirm": {
1410
- parameters: {
1411
- query?: never;
1412
- header?: never;
1413
- path?: never;
1414
- cookie?: never;
1415
- };
1416
- /**
1417
- * Confirm device authorization
1418
- * @description Redirects to the external device confirmation page.
1419
- */
1420
- get: {
1421
- parameters: {
1422
- query?: {
1423
- user_code?: string;
1424
- };
1425
- header?: never;
1426
- path?: never;
1427
- cookie?: never;
1428
- };
1429
- requestBody?: never;
1430
- responses: {
1431
- /** @description Default Response */
1432
- 200: {
1433
- headers: {
1434
- [name: string]: unknown;
1435
- };
1436
- content?: never;
1437
- };
1438
- };
1439
- };
1440
- put?: never;
1441
- post?: never;
1442
- delete?: never;
1443
- options?: never;
1444
- head?: never;
1445
- patch?: never;
1446
- trace?: never;
1447
- };
1448
- "/oauth/device/verify": {
1449
- parameters: {
1450
- query?: never;
1451
- header?: never;
1452
- path?: never;
1453
- cookie?: never;
1454
- };
1455
- get?: never;
1456
- put?: never;
1457
- /**
1458
- * Verify user code
1459
- * @description API endpoint for the external UI to validate a user code and retrieve client information.
1460
- */
1461
- post: {
1462
- parameters: {
1463
- query?: never;
1464
- header?: never;
1465
- path?: never;
1466
- cookie?: never;
1467
- };
1468
- requestBody: {
1469
- content: {
1470
- "application/json": {
1471
- user_code: string;
1472
- };
1473
- };
1474
- };
1475
- responses: {
1476
- /** @description Default Response */
1477
- 200: {
1478
- headers: {
1479
- [name: string]: unknown;
1480
- };
1481
- content: {
1482
- "application/json": {
1483
- device_code: string;
1484
- client: {
1485
- name?: string;
1486
- client_id?: string;
1487
- };
1488
- };
1489
- };
1490
- };
1491
- };
1492
- };
1493
- delete?: never;
1494
- options?: never;
1495
- head?: never;
1496
- patch?: never;
1497
- trace?: never;
1498
- };
1499
- "/oauth/device/authorize": {
1500
- parameters: {
1501
- query?: never;
1502
- header?: never;
1503
- path?: never;
1504
- cookie?: never;
1505
- };
1506
- get?: never;
1507
- put?: never;
1508
- /**
1509
- * Authorize device
1510
- * @description API endpoint for the external UI to authorize the device request for the current authenticated user.
1511
- */
1512
- post: {
1513
- parameters: {
1514
- query?: never;
1515
- header?: never;
1516
- path?: never;
1517
- cookie?: never;
1518
- };
1519
- requestBody: {
1520
- content: {
1521
- "application/json": {
1522
- device_code: string;
1523
- };
1524
- };
1525
- };
1526
- responses: {
1527
- /** @description Default Response */
1528
- 200: {
1529
- headers: {
1530
- [name: string]: unknown;
1531
- };
1532
- content: {
1533
- "application/json": {
1534
- success: boolean;
1535
- };
1536
- };
1537
- };
1538
- };
1539
- };
1540
- delete?: never;
1541
- options?: never;
1542
- head?: never;
1543
- patch?: never;
1544
- trace?: never;
1545
- };
1546
- "/callback": {
1547
- parameters: {
1548
- query?: never;
1549
- header?: never;
1550
- path?: never;
1551
- cookie?: never;
1552
- };
1553
- /**
1554
- * OAuth2 Callback URL
1555
- * @description OAuth2 Callback URL
1556
- */
1557
- get: operations["callback"];
1558
- put?: never;
1559
- post?: never;
1560
- delete?: never;
1561
- options?: never;
1562
- head?: never;
1563
- patch?: never;
1564
- trace?: never;
1565
- };
1566
- "/continue": {
1567
- parameters: {
1568
- query?: never;
1569
- header?: never;
1570
- path?: never;
1571
- cookie?: never;
1572
- };
1573
- /**
1574
- * OAuth2 Resume URL
1575
- * @description Resume OAuth flow after a progressive profiling action
1576
- */
1577
- get: operations["oauth_continue"];
1578
- put?: never;
1579
- post?: never;
1580
- delete?: never;
1581
- options?: never;
1582
- head?: never;
1583
- patch?: never;
1584
- trace?: never;
1585
- };
1586
- "/.well-known/openid-configuration": {
1587
- parameters: {
1588
- query?: never;
1589
- header?: never;
1590
- path?: never;
1591
- cookie?: never;
1592
- };
1593
- /**
1594
- * OpenID Discovery
1595
- * @description OpenID Discovery
1596
- */
1597
- get: {
1598
- parameters: {
1599
- query?: never;
1600
- header?: never;
1601
- path?: never;
1602
- cookie?: never;
1603
- };
1604
- requestBody?: never;
1605
- responses: {
1606
- /** @description Default Response */
1607
- 200: {
1608
- headers: {
1609
- [name: string]: unknown;
1610
- };
1611
- content?: never;
1612
- };
1613
- };
1614
- };
1615
- put?: never;
1616
- post?: never;
1617
- delete?: never;
1618
- options?: never;
1619
- head?: never;
1620
- patch?: never;
1621
- trace?: never;
1622
- };
1623
- "/.well-known/jwks.json": {
1624
- parameters: {
1625
- query?: never;
1626
- header?: never;
1627
- path?: never;
1628
- cookie?: never;
1629
- };
1630
- /**
1631
- * JWKS endpoint
1632
- * @description JWKS endpoint
1633
- */
1634
- get: {
1635
- parameters: {
1636
- query?: never;
1637
- header?: never;
1638
- path?: never;
1639
- cookie?: never;
1640
- };
1641
- requestBody?: never;
1642
- responses: {
1643
- /** @description Default Response */
1644
- 200: {
1645
- headers: {
1646
- [name: string]: unknown;
1647
- };
1648
- content?: never;
1649
- };
1650
- };
1651
- };
1652
- put?: never;
1653
- post?: never;
1654
- delete?: never;
1655
- options?: never;
1656
- head?: never;
1657
- patch?: never;
1658
- trace?: never;
1659
- };
1660
- "/usernamepassword/login": {
1661
- parameters: {
1662
- query?: never;
1663
- header?: never;
1664
- path?: never;
1665
- cookie?: never;
1666
- };
1667
- get?: never;
1668
- put?: never;
1669
- post: {
1670
- parameters: {
1671
- query?: never;
1672
- header?: never;
1673
- path?: never;
1674
- cookie?: never;
1675
- };
1676
- requestBody?: {
1677
- content: {
1678
- "application/json": components["schemas"]["UsernamepasswordLoginBody"];
1679
- };
1680
- };
1681
- responses: {
1682
- /** @description Default Response */
1683
- 200: {
1684
- headers: {
1685
- [name: string]: unknown;
1686
- };
1687
- content?: never;
1688
- };
1689
- };
1690
- };
1691
- delete?: never;
1692
- options?: never;
1693
- head?: never;
1694
- patch?: never;
1695
- trace?: never;
1696
- };
1697
- "/login/callback": {
1698
- parameters: {
1699
- query?: never;
1700
- header?: never;
1701
- path?: never;
1702
- cookie?: never;
1703
- };
1704
- get?: never;
1705
- put?: never;
1706
- post: {
1707
- parameters: {
1708
- query?: never;
1709
- header?: never;
1710
- path?: never;
1711
- cookie?: never;
1712
- };
1713
- requestBody?: {
1714
- content: {
1715
- "application/json": components["schemas"]["LoginCallbackBody"];
1716
- };
1717
- };
1718
- responses: {
1719
- /** @description Default Response */
1720
- 200: {
1721
- headers: {
1722
- [name: string]: unknown;
1723
- };
1724
- content?: never;
1725
- };
1726
- };
1727
- };
1728
- delete?: never;
1729
- options?: never;
1730
- head?: never;
1731
- patch?: never;
1732
- trace?: never;
1733
- };
1734
- "/dbconnections/change_password": {
1735
- parameters: {
1736
- query?: never;
1737
- header?: never;
1738
- path?: never;
1739
- cookie?: never;
1740
- };
1741
- get?: never;
1742
- put?: never;
1743
- /**
1744
- * Change password
1745
- * @description Change password
1746
- */
1747
- post: operations["change_password"];
1748
- delete?: never;
1749
- options?: never;
1750
- head?: never;
1751
- patch?: never;
1752
- trace?: never;
1753
- };
1754
- "/reset-verify": {
1755
- parameters: {
1756
- query?: never;
1757
- header?: never;
1758
- path?: never;
1759
- cookie?: never;
1760
- };
1761
- /**
1762
- * Change password verify
1763
- * @description Change password verify
1764
- */
1765
- get: operations["change_password_verify"];
1766
- put?: never;
1767
- post?: never;
1768
- delete?: never;
1769
- options?: never;
1770
- head?: never;
1771
- patch?: never;
1772
- trace?: never;
1773
- };
1774
- "/reset-change": {
1775
- parameters: {
1776
- query?: never;
1777
- header?: never;
1778
- path?: never;
1779
- cookie?: never;
1780
- };
1781
- get?: never;
1782
- put?: never;
1783
- /**
1784
- * Reset password change
1785
- * @description Reset password change
1786
- */
1787
- post: operations["change_password_change"];
1788
- delete?: never;
1789
- options?: never;
1790
- head?: never;
1791
- patch?: never;
1792
- trace?: never;
1793
- };
1794
- }
1795
- export type webhooks = Record<string, never>;
1796
- export interface components {
1797
- schemas: {
1798
- /** @description AuthAccount */
1799
- AuthAccount: {
1800
- /** @description AuthAccount ID */
1801
- id: string;
1802
- name: string;
1803
- domain: string;
1804
- slug: string;
1805
- logo_src?: string | null;
1806
- icon_src?: string | null;
1807
- callback_hostnames: string[];
1808
- token_signature: string;
1809
- default_connection?: components["schemas"]["Connection"] | string | unknown;
1810
- enabled_locales: string[];
1811
- team?: string | null;
1812
- /** @description AuthAccount creation date */
1813
- createdAt: string;
1814
- /** @description AuthAccount updated date */
1815
- updatedAt?: string;
1816
- };
1817
- /** @description Connection */
1818
- Connection: {
1819
- /** @description Connection ID */
1820
- id: string;
1821
- connection_name: string;
1822
- connection_type: string;
1823
- /** @default null */
1824
- authorize_url: string;
1825
- /** @default null */
1826
- token_url: string;
1827
- /** @default null */
1828
- userinfo_url: string;
1829
- /** @default null */
1830
- client_id: string;
1831
- /** @default null */
1832
- client_secret: string;
1833
- /** @default null */
1834
- issuer: string;
1835
- /** @default null */
1836
- jwks_url: string;
1837
- /** @default null */
1838
- response_type: string;
1839
- enabled: boolean;
1840
- /** @default null */
1841
- enabled_clients: string[] | null;
1842
- /** @default [] */
1843
- scope: string[];
1844
- /**
1845
- * @description Authorize params
1846
- * @default {}
1847
- */
1848
- authorize_params: {
1849
- [key: string]: string;
1850
- };
1851
- /** @description Object is related with this account */
1852
- account: string;
1853
- /**
1854
- * @description ConnectionMetadata
1855
- * @default {}
1856
- */
1857
- metadata: {
1858
- [key: string]: unknown;
1859
- };
1860
- /** @description Connection creation date */
1861
- createdAt: string;
1862
- /** @description Connection updated date */
1863
- updatedAt?: string;
1864
- };
1865
- /**
1866
- * @description ConnectionMetadata
1867
- * @default {}
1868
- */
1869
- ConnectionMetadata: {
1870
- [key: string]: unknown;
1871
- };
1872
- /** @description ConnectionCreate */
1873
- ConnectionCreate: {
1874
- connection_name: string;
1875
- connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "oidc";
1876
- authorize_url?: string;
1877
- client_id?: string;
1878
- client_secret?: string;
1879
- issuer?: string;
1880
- jwks_url?: string;
1881
- scope?: string[];
1882
- enabled?: boolean;
1883
- claims_mapping?: {
1884
- [key: string]: string;
1885
- };
1886
- /**
1887
- * @description Authorize params
1888
- * @default {}
1889
- */
1890
- authorize_params: {
1891
- [key: string]: string;
1892
- };
1893
- /** @description Add Metadata */
1894
- metadata?: {
1895
- [key: string]: unknown;
1896
- };
1897
- };
1898
- /** @description Add Metadata */
1899
- ConnectionMetadataCreate: {
1900
- [key: string]: unknown;
1901
- };
1902
- /** @description Client */
1903
- Client: {
1904
- /** @description Client ID */
1905
- id: string;
1906
- name: string;
1907
- description: string;
1908
- client_id: string;
1909
- client_secret: string;
1910
- callbacks: string[];
1911
- logout_urls: string[];
1912
- refresh_token: {
1913
- expiration_mode: "expire" | "not-expire";
1914
- infinite_token_lifetime: boolean;
1915
- token_lifetime: number;
1916
- };
1917
- /** @description Object is related with this account */
1918
- account: string;
1919
- /**
1920
- * @description ClientMetadata
1921
- * @default {}
1922
- */
1923
- metadata: {
1924
- [key: string]: unknown;
1925
- };
1926
- /** @description Client creation date */
1927
- createdAt: string;
1928
- /** @description Client updated date */
1929
- updatedAt?: string;
1930
- };
1931
- /**
1932
- * @description ClientMetadata
1933
- * @default {}
1934
- */
1935
- ClientMetadata: {
1936
- [key: string]: unknown;
1937
- };
1938
- /** @description ClientCreate */
1939
- ClientCreate: {
1940
- name: string;
1941
- description?: string;
1942
- callbacks?: string[];
1943
- logout_urls?: string[];
1944
- /** @description Add Metadata */
1945
- metadata?: {
1946
- [key: string]: unknown;
1947
- };
1948
- };
1949
- /** @description Add Metadata */
1950
- ClientMetadataCreate: {
1951
- [key: string]: unknown;
1952
- };
1953
- /** @description User */
1954
- User: {
1955
- /** @description User ID */
1956
- id: string;
1957
- /** @description User name */
1958
- name?: string | null;
1959
- /** @description unique username for this user */
1960
- username?: string | null;
1961
- /** @description Given name */
1962
- given_name?: string | null;
1963
- /** @description Family name */
1964
- family_name?: string | null;
1965
- /** @description User email */
1966
- email?: string | null;
1967
- /**
1968
- * @description true if email is verified
1969
- * @default false
1970
- */
1971
- email_verified: boolean;
1972
- /** @description contact phone number */
1973
- phone?: string | null;
1974
- /** @description phone is verified */
1975
- phone_verified: boolean;
1976
- /** @description country iso code */
1977
- country_iso?: string | null;
1978
- /** @description user birth_date */
1979
- birth_date?: string | null;
1980
- /** @description user main language */
1981
- locale?: string;
1982
- /** @description customer region */
1983
- region?: string | null;
1984
- /** @description User picture url */
1985
- picture?: string | null;
1986
- /** @description Total number of logins this user has performed. */
1987
- logins_count: number;
1988
- /** @description Last IP address from which this user logged in */
1989
- last_ip?: string | null;
1990
- /** @description Last date and time this user logged in (ISO_8601 format) */
1991
- last_login?: string | null;
1992
- /**
1993
- * @description User Metadata
1994
- * @default {}
1995
- */
1996
- user_metadata: {
1997
- [key: string]: unknown;
1998
- };
1999
- /**
2000
- * @description App Metadata
2001
- * @default {}
2002
- */
2003
- app_metadata: {
2004
- [key: string]: unknown;
2005
- };
2006
- /** @description Object is related with this account */
2007
- account: string;
2008
- /**
2009
- * @description UserMetadata
2010
- * @default {}
2011
- */
2012
- metadata: {
2013
- [key: string]: unknown;
2014
- };
2015
- /** @description User creation date */
2016
- createdAt: string;
2017
- /** @description User updated date */
2018
- updatedAt?: string;
2019
- };
2020
- /**
2021
- * @description User Metadata
2022
- * @default {}
2023
- */
2024
- UserUserMetadata: {
2025
- [key: string]: unknown;
2026
- };
2027
- /**
2028
- * @description App Metadata
2029
- * @default {}
2030
- */
2031
- UserAppMetadata: {
2032
- [key: string]: unknown;
2033
- };
2034
- /**
2035
- * @description UserMetadata
2036
- * @default {}
2037
- */
2038
- UserMetadata: {
2039
- [key: string]: unknown;
2040
- };
2041
- /** @description UserCreate */
2042
- UserCreate: {
2043
- /** @description The user's full name. */
2044
- name?: string;
2045
- /** @description The user's given name. */
2046
- given_name?: string;
2047
- /** @description The user's family name. */
2048
- family_name?: string;
2049
- /** @description The user's email. */
2050
- email?: string;
2051
- /** @description contact phone number */
2052
- phone?: string;
2053
- /** @description The user's birth date */
2054
- birth_date?: string;
2055
- /** @description The user's default locale lang. */
2056
- locale?: string;
2057
- /** @description A URI pointing to the user's picture. */
2058
- picture?: string;
2059
- /** @description Initial password for this user (mandatory only for auth0 connection strategy) */
2060
- password?: string;
2061
- /** @description User Metadata */
2062
- user_metadata?: {
2063
- [key: string]: unknown;
2064
- };
2065
- /** @description App Metadata */
2066
- app_metadata?: {
2067
- [key: string]: unknown;
2068
- };
2069
- };
2070
- /** @description User Metadata */
2071
- UserUserCreate: {
2072
- [key: string]: unknown;
2073
- };
2074
- /** @description App Metadata */
2075
- UserAppCreate: {
2076
- [key: string]: unknown;
2077
- };
2078
- /** @description UserUpdate */
2079
- UserUpdate: {
2080
- /** @description name */
2081
- name?: string;
2082
- /** @description given name */
2083
- given_name?: string;
2084
- /** @description family name */
2085
- family_name?: string;
2086
- /** @description contact email */
2087
- email?: string;
2088
- /** @description New password for this user */
2089
- password?: string;
2090
- /** @description contact phone number */
2091
- phone?: string;
2092
- /** @description user country as iso string */
2093
- country_iso?: string;
2094
- /** @description user birth_date */
2095
- birth_date?: string;
2096
- /** @description user birth_date */
2097
- locale?: string;
2098
- /** @description User picture url */
2099
- picture?: string;
2100
- /** @description User defined metadata */
2101
- user_metadata?: {
2102
- [key: string]: unknown;
2103
- };
2104
- /** @description App defined metadata */
2105
- app_metadata?: {
2106
- [key: string]: unknown;
2107
- };
2108
- };
2109
- /** @description User defined metadata */
2110
- UserUserMetadataUpdate: {
2111
- [key: string]: unknown;
2112
- };
2113
- /** @description App defined metadata */
2114
- UserAppMetadataUpdate: {
2115
- [key: string]: unknown;
2116
- };
2117
- /** @description Identity */
2118
- Identity: {
2119
- /** @description Identity ID */
2120
- id: string;
2121
- connection: components["schemas"]["Connection"] | string | unknown;
2122
- user: components["schemas"]["User"] | string | unknown;
2123
- identity_id: string;
2124
- access_token?: string;
2125
- access_token_secret?: string;
2126
- refresh_token?: string;
2127
- profile_data: unknown;
2128
- /** @description Object is related with this account */
2129
- account: string;
2130
- /**
2131
- * @description IdentityMetadata
2132
- * @default {}
2133
- */
2134
- metadata: {
2135
- [key: string]: unknown;
2136
- };
2137
- /** @description Identity creation date */
2138
- createdAt: string;
2139
- /** @description Identity updated date */
2140
- updatedAt?: string;
2141
- };
2142
- /**
2143
- * @description IdentityMetadata
2144
- * @default {}
2145
- */
2146
- IdentityMetadata: {
2147
- [key: string]: unknown;
2148
- };
2149
- IdentityCreate: {
2150
- account: string;
2151
- user: string;
2152
- identity_id: string;
2153
- connection: string;
2154
- access_token?: string;
2155
- access_token_secret?: string;
2156
- refresh_token?: string;
2157
- profile_data: unknown;
2158
- };
2159
- /** @description Role */
2160
- Role: {
2161
- /** @description Role ID */
2162
- id: string;
2163
- /** @description Name for this role */
2164
- name: string;
2165
- /** @description Description of this role */
2166
- description: string;
2167
- /** @description Object is related with this account */
2168
- account: string;
2169
- /**
2170
- * @description RoleMetadata
2171
- * @default {}
2172
- */
2173
- metadata: {
2174
- [key: string]: unknown;
2175
- };
2176
- /** @description Role creation date */
2177
- createdAt: string;
2178
- /** @description Role updated date */
2179
- updatedAt?: string;
2180
- };
2181
- /**
2182
- * @description RoleMetadata
2183
- * @default {}
2184
- */
2185
- RoleMetadata: {
2186
- [key: string]: unknown;
2187
- };
2188
- /** @description RoleCreate */
2189
- RoleCreate: {
2190
- name: string;
2191
- description?: string;
2192
- /** @description Add Metadata */
2193
- metadata?: {
2194
- [key: string]: unknown;
2195
- };
2196
- };
2197
- /** @description Add Metadata */
2198
- RoleMetadataCreate: {
2199
- [key: string]: unknown;
2200
- };
2201
- /** @description RoleMember */
2202
- RoleMember: {
2203
- /** @description RoleMember ID */
2204
- id: string;
2205
- role: components["schemas"]["Role"] | string | unknown;
2206
- user: components["schemas"]["User"] | string | unknown;
2207
- /** @description Object is related with this account */
2208
- account: string;
2209
- /**
2210
- * @description RoleMemberMetadata
2211
- * @default {}
2212
- */
2213
- metadata: {
2214
- [key: string]: unknown;
2215
- };
2216
- /** @description RoleMember creation date */
2217
- createdAt: string;
2218
- /** @description RoleMember updated date */
2219
- updatedAt?: string;
2220
- };
2221
- /**
2222
- * @description RoleMemberMetadata
2223
- * @default {}
2224
- */
2225
- RoleMemberMetadata: {
2226
- [key: string]: unknown;
2227
- };
2228
- RoleMemberCreate: {
2229
- users: string[];
2230
- };
2231
- /** @description Team */
2232
- Team: {
2233
- /** @description Team ID */
2234
- id: string;
2235
- name: string;
2236
- slug: string;
2237
- description: string | null;
2238
- logo_url: string | null;
2239
- /** @description Object is related with this account */
2240
- account: string;
2241
- /**
2242
- * @description TeamMetadata
2243
- * @default {}
2244
- */
2245
- metadata: {
2246
- [key: string]: unknown;
2247
- };
2248
- /** @description Team creation date */
2249
- createdAt: string;
2250
- /** @description Team updated date */
2251
- updatedAt?: string;
2252
- };
2253
- /**
2254
- * @description TeamMetadata
2255
- * @default {}
2256
- */
2257
- TeamMetadata: {
2258
- [key: string]: unknown;
2259
- };
2260
- /** @description TeamCreate */
2261
- TeamCreate: {
2262
- name: string;
2263
- description?: string;
2264
- /** @description Add Metadata */
2265
- metadata?: {
2266
- [key: string]: unknown;
2267
- };
2268
- };
2269
- /** @description Add Metadata */
2270
- TeamMetadataCreate: {
2271
- [key: string]: unknown;
2272
- };
2273
- /** @description TeamMember */
2274
- TeamMember: {
2275
- /** @description TeamMember ID */
2276
- id: string;
2277
- user: components["schemas"]["User"] | string | unknown;
2278
- team: components["schemas"]["Team"] | string | unknown;
2279
- roles: (components["schemas"]["Role"] | string | unknown)[];
2280
- /** @description Object is related with this account */
2281
- account: string;
2282
- /**
2283
- * @description TeamMemberMetadata
2284
- * @default {}
2285
- */
2286
- metadata: {
2287
- [key: string]: unknown;
2288
- };
2289
- /** @description TeamMember creation date */
2290
- createdAt: string;
2291
- /** @description TeamMember updated date */
2292
- updatedAt?: string;
2293
- };
2294
- /**
2295
- * @description TeamMemberMetadata
2296
- * @default {}
2297
- */
2298
- TeamMemberMetadata: {
2299
- [key: string]: unknown;
2300
- };
2301
- TeamMemberCreate: {
2302
- users: string[];
2303
- };
2304
- Permission: {
2305
- value: string;
2306
- description?: string;
2307
- };
2308
- PermissionCreate: {
2309
- value: string;
2310
- description?: string;
2311
- };
2312
- /** @description Api */
2313
- Api: {
2314
- /** @description Api ID */
2315
- id: string;
2316
- name: string;
2317
- description?: string;
2318
- permissions: components["schemas"]["Permission"][];
2319
- /** @description Object is related with this account */
2320
- account: string;
2321
- /**
2322
- * @description ApiMetadata
2323
- * @default {}
2324
- */
2325
- metadata: {
2326
- [key: string]: unknown;
2327
- };
2328
- /** @description Api creation date */
2329
- createdAt: string;
2330
- /** @description Api updated date */
2331
- updatedAt?: string;
2332
- };
2333
- /**
2334
- * @description ApiMetadata
2335
- * @default {}
2336
- */
2337
- ApiMetadata: {
2338
- [key: string]: unknown;
2339
- };
2340
- ApiCreate: {
2341
- name: string;
2342
- description?: string;
2343
- permissions: components["schemas"]["PermissionCreate"][];
2344
- };
2345
- /** @description Action */
2346
- Action: {
2347
- /** @description Action ID */
2348
- id: string;
2349
- /** @description Action Name */
2350
- name: string;
2351
- /** @description Trigger event name (e.g., post-login) */
2352
- trigger: string;
2353
- /** @description JavaScript Code to execute */
2354
- code: string;
2355
- /**
2356
- * @description Is this action active?
2357
- * @default true
2358
- */
2359
- enabled: boolean;
2360
- /**
2361
- * @description Execution order
2362
- * @default 0
2363
- */
2364
- order: number;
2365
- /** @description Object is related with this account */
2366
- account: string;
2367
- /**
2368
- * @description ActionMetadata
2369
- * @default {}
2370
- */
2371
- metadata: {
2372
- [key: string]: unknown;
2373
- };
2374
- /** @description Action creation date */
2375
- createdAt: string;
2376
- /** @description Action updated date */
2377
- updatedAt?: string;
2378
- };
2379
- /**
2380
- * @description ActionMetadata
2381
- * @default {}
2382
- */
2383
- ActionMetadata: {
2384
- [key: string]: unknown;
2385
- };
2386
- ActionCreate: {
2387
- /** @description Action Name */
2388
- name: string;
2389
- /** @description Trigger event name (e.g., post-login) */
2390
- trigger: string;
2391
- /** @description JavaScript Code to execute */
2392
- code?: string;
2393
- /**
2394
- * @description Is this action active?
2395
- * @default true
2396
- */
2397
- enabled: boolean;
2398
- /**
2399
- * @description Execution order
2400
- * @default 0
2401
- */
2402
- order: number;
2403
- };
2404
- /** @description NotificationSubscription */
2405
- NotificationSubscription: {
2406
- /** @description NotificationSubscriptionEmail ID */
2407
- id: string;
2408
- events: string[];
2409
- /** @enum {string} */
2410
- channel: "email";
2411
- /** @description Whether the subscription is active */
2412
- active: boolean;
2413
- config: {
2414
- recipients: string[];
2415
- };
2416
- /** @description Object is related with this account */
2417
- account: string;
2418
- /**
2419
- * @description NotificationSubscriptionEmailMetadata
2420
- * @default {}
2421
- */
2422
- metadata: {
2423
- [key: string]: unknown;
2424
- };
2425
- /** @description NotificationSubscriptionEmail creation date */
2426
- createdAt: string;
2427
- /** @description NotificationSubscriptionEmail updated date */
2428
- updatedAt?: string;
2429
- } | {
2430
- /** @description NotificationSubscriptionWebhook ID */
2431
- id: string;
2432
- events: string[];
2433
- /** @enum {string} */
2434
- channel: "webhook";
2435
- /** @description Whether the subscription is active */
2436
- active: boolean;
2437
- config: {
2438
- /**
2439
- * Format: uri
2440
- * @description Webhook URL
2441
- */
2442
- url: string;
2443
- /** @description Secret used to sign the webhook payload */
2444
- secret: string;
2445
- };
2446
- /** @description Object is related with this account */
2447
- account: string;
2448
- /**
2449
- * @description NotificationSubscriptionWebhookMetadata
2450
- * @default {}
2451
- */
2452
- metadata: {
2453
- [key: string]: unknown;
2454
- };
2455
- /** @description NotificationSubscriptionWebhook creation date */
2456
- createdAt: string;
2457
- /** @description NotificationSubscriptionWebhook updated date */
2458
- updatedAt?: string;
2459
- };
2460
- /** @description NotificationSubscriptionEmail */
2461
- NotificationSubscriptionEmail: {
2462
- /** @description NotificationSubscriptionEmail ID */
2463
- id: string;
2464
- events: string[];
2465
- /** @enum {string} */
2466
- channel: "email";
2467
- /** @description Whether the subscription is active */
2468
- active: boolean;
2469
- config: {
2470
- recipients: string[];
2471
- };
2472
- /** @description Object is related with this account */
2473
- account: string;
2474
- /**
2475
- * @description NotificationSubscriptionEmailMetadata
2476
- * @default {}
2477
- */
2478
- metadata: {
2479
- [key: string]: unknown;
2480
- };
2481
- /** @description NotificationSubscriptionEmail creation date */
2482
- createdAt: string;
2483
- /** @description NotificationSubscriptionEmail updated date */
2484
- updatedAt?: string;
2485
- };
2486
- NotificationSubscriptionEmailConfig: {
2487
- recipients: string[];
2488
- };
2489
- /**
2490
- * @description NotificationSubscriptionEmailMetadata
2491
- * @default {}
2492
- */
2493
- NotificationSubscriptionEmailMetadata: {
2494
- [key: string]: unknown;
2495
- };
2496
- /** @description NotificationSubscriptionWebhook */
2497
- NotificationSubscriptionWebhook: {
2498
- /** @description NotificationSubscriptionWebhook ID */
2499
- id: string;
2500
- events: string[];
2501
- /** @enum {string} */
2502
- channel: "webhook";
2503
- /** @description Whether the subscription is active */
2504
- active: boolean;
2505
- config: {
2506
- /**
2507
- * Format: uri
2508
- * @description Webhook URL
2509
- */
2510
- url: string;
2511
- /** @description Secret used to sign the webhook payload */
2512
- secret: string;
2513
- };
2514
- /** @description Object is related with this account */
2515
- account: string;
2516
- /**
2517
- * @description NotificationSubscriptionWebhookMetadata
2518
- * @default {}
2519
- */
2520
- metadata: {
2521
- [key: string]: unknown;
2522
- };
2523
- /** @description NotificationSubscriptionWebhook creation date */
2524
- createdAt: string;
2525
- /** @description NotificationSubscriptionWebhook updated date */
2526
- updatedAt?: string;
2527
- };
2528
- NotificationSubscriptionWebhookConfig: {
2529
- /**
2530
- * Format: uri
2531
- * @description Webhook URL
2532
- */
2533
- url: string;
2534
- /** @description Secret used to sign the webhook payload */
2535
- secret: string;
2536
- };
2537
- /**
2538
- * @description NotificationSubscriptionWebhookMetadata
2539
- * @default {}
2540
- */
2541
- NotificationSubscriptionWebhookMetadata: {
2542
- [key: string]: unknown;
2543
- };
2544
- /** @description NotificationSubscriptionCreate */
2545
- NotificationSubscriptionCreate: {
2546
- events: string[];
2547
- /** @enum {string} */
2548
- channel: "email";
2549
- /** @description Whether the subscription is active */
2550
- active?: boolean;
2551
- config: {
2552
- recipients: string[];
2553
- };
2554
- /** @description Add Metadata */
2555
- metadata?: {
2556
- [key: string]: unknown;
2557
- };
2558
- } | {
2559
- events: string[];
2560
- /** @enum {string} */
2561
- channel: "webhook";
2562
- /** @description Whether the subscription is active */
2563
- active?: boolean;
2564
- config: {
2565
- /**
2566
- * Format: uri
2567
- * @description Webhook URL
2568
- */
2569
- url: string;
2570
- /** @description Secret used to sign the webhook payload */
2571
- secret: string;
2572
- };
2573
- /** @description Add Metadata */
2574
- metadata?: {
2575
- [key: string]: unknown;
2576
- };
2577
- };
2578
- /** @description NotificationSubscriptionEmailCreate */
2579
- NotificationSubscriptionEmailCreate: {
2580
- events: string[];
2581
- /** @enum {string} */
2582
- channel: "email";
2583
- /** @description Whether the subscription is active */
2584
- active?: boolean;
2585
- config: {
2586
- recipients: string[];
2587
- };
2588
- /** @description Add Metadata */
2589
- metadata?: {
2590
- [key: string]: unknown;
2591
- };
2592
- };
2593
- NotificationSubscriptionEmailConfigCreate: {
2594
- recipients: string[];
2595
- };
2596
- /** @description Add Metadata */
2597
- NotificationSubscriptionEmailMetadataCreate: {
2598
- [key: string]: unknown;
2599
- };
2600
- /** @description NotificationSubscriptionWebhookCreate */
2601
- NotificationSubscriptionWebhookCreate: {
2602
- events: string[];
2603
- /** @enum {string} */
2604
- channel: "webhook";
2605
- /** @description Whether the subscription is active */
2606
- active?: boolean;
2607
- config: {
2608
- /**
2609
- * Format: uri
2610
- * @description Webhook URL
2611
- */
2612
- url: string;
2613
- /** @description Secret used to sign the webhook payload */
2614
- secret: string;
2615
- };
2616
- /** @description Add Metadata */
2617
- metadata?: {
2618
- [key: string]: unknown;
2619
- };
2620
- };
2621
- NotificationSubscriptionWebhookConfigCreate: {
2622
- /**
2623
- * Format: uri
2624
- * @description Webhook URL
2625
- */
2626
- url: string;
2627
- /** @description Secret used to sign the webhook payload */
2628
- secret: string;
2629
- };
2630
- /** @description Add Metadata */
2631
- NotificationSubscriptionWebhookMetadataCreate: {
2632
- [key: string]: unknown;
2633
- };
2634
- /** @description NotificationSubscriptionUpdate */
2635
- NotificationSubscriptionUpdate: {
2636
- events?: string[];
2637
- /** @enum {string} */
2638
- channel?: "email";
2639
- /** @description Whether the subscription is active */
2640
- active?: boolean;
2641
- config?: {
2642
- recipients?: string[];
2643
- };
2644
- /** @description Metadata update */
2645
- metadata?: {
2646
- [key: string]: unknown;
2647
- };
2648
- } | {
2649
- events?: string[];
2650
- /** @enum {string} */
2651
- channel?: "webhook";
2652
- /** @description Whether the subscription is active */
2653
- active?: boolean;
2654
- config?: {
2655
- /**
2656
- * Format: uri
2657
- * @description Webhook URL
2658
- */
2659
- url?: string;
2660
- /** @description Secret used to sign the webhook payload */
2661
- secret?: string;
2662
- };
2663
- /** @description Metadata update */
2664
- metadata?: {
2665
- [key: string]: unknown;
2666
- };
2667
- };
2668
- /** @description Metadata update */
2669
- NotificationSubscriptionEmailMetadataUpdate: {
2670
- [key: string]: unknown;
2671
- };
2672
- /** @description Metadata update */
2673
- NotificationSubscriptionWebhookMetadataUpdate: {
2674
- [key: string]: unknown;
2675
- };
2676
- /** @description Customdomain */
2677
- Customdomain: {
2678
- /** @description Customdomain ID */
2679
- id: string;
2680
- domain: string;
2681
- token: string;
2682
- status: string;
2683
- attempts: number;
2684
- /** Format: date-time */
2685
- nextCheck?: string;
2686
- /** Format: date-time */
2687
- lastCheck?: string;
2688
- errorLog?: string;
2689
- /** Format: date-time */
2690
- verifiedAt?: string;
2691
- /** @description Object is related with this account */
2692
- account: string;
2693
- /**
2694
- * @description CustomdomainMetadata
2695
- * @default {}
2696
- */
2697
- metadata: {
2698
- [key: string]: unknown;
2699
- };
2700
- /** @description Customdomain creation date */
2701
- createdAt: string;
2702
- /** @description Customdomain updated date */
2703
- updatedAt?: string;
2704
- };
2705
- /**
2706
- * @description CustomdomainMetadata
2707
- * @default {}
2708
- */
2709
- CustomdomainMetadata: {
2710
- [key: string]: unknown;
2711
- };
2712
- /** @description CustomdomainCreate */
2713
- CustomdomainCreate: {
2714
- domain: string;
2715
- /** @description Add Metadata */
2716
- metadata?: {
2717
- [key: string]: unknown;
2718
- };
2719
- };
2720
- /** @description Add Metadata */
2721
- CustomdomainMetadataCreate: {
2722
- [key: string]: unknown;
2723
- };
2724
- /** @description AuthAccountCreate */
2725
- AuthAccountCreate: {
2726
- name: string;
2727
- team: string;
2728
- logo_src?: string;
2729
- icon_src?: string;
2730
- callback_hostnames?: string[];
2731
- default_connection?: string;
2732
- /** @description Add Metadata */
2733
- metadata?: {
2734
- [key: string]: unknown;
2735
- };
2736
- };
2737
- /** @description Add Metadata */
2738
- AuthAccountMetadataCreate: {
2739
- [key: string]: unknown;
2740
- };
2741
- OAuthTokenParams: {
2742
- /** @description Grant Type. https://oauth.net/2/grant-types/ */
2743
- grant_type?: "authorization_code" | "client_credentials" | "refresh_token" | "password" | "http://auth0.com/oauth/grant-type/passwordless/otp" | "urn:ietf:params:oauth:grant-type:token-exchange" | "urn:ietf:params:oauth:grant-type:device_code";
2744
- client_id?: string;
2745
- client_secret?: string;
2746
- scope?: string;
2747
- code?: string;
2748
- code_verifier?: string;
2749
- username?: string;
2750
- otp?: string;
2751
- refresh_token?: string;
2752
- subject_token?: string;
2753
- subject_token_type?: string;
2754
- /** @description The device code returned by the authorization server. */
2755
- device_code?: string;
2756
- } & {
2757
- [key: string]: unknown;
2758
- };
2759
- /** @description Grant Type. https://oauth.net/2/grant-types/ */
2760
- OAuthGrantType: "authorization_code" | "client_credentials" | "refresh_token" | "password" | "http://auth0.com/oauth/grant-type/passwordless/otp" | "urn:ietf:params:oauth:grant-type:token-exchange" | "urn:ietf:params:oauth:grant-type:device_code";
2761
- /** @description UsernamepasswordLoginBody */
2762
- UsernamepasswordLoginBody: {
2763
- username: string;
2764
- password: string;
2765
- /** @description An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the application. This value must be used by the application to prevent CSRF attacks. */
2766
- state?: string;
2767
- response_type?: string;
2768
- client_id: string;
2769
- /** @description Deprecated. Use connection_id */
2770
- connection?: string;
2771
- /** @description Which oauth connection to use. Leave empty to use default connection */
2772
- connection_id?: string;
2773
- scope?: string;
2774
- /** @description The URL to which Faable will redirect the browser after authorization has been granted by the user. */
2775
- redirect_uri?: string;
2776
- prompt?: string;
2777
- };
2778
- LoginCallbackBody: {
2779
- /** @description is always wsignin1.0 */
2780
- wa: string;
2781
- /** @description JWT */
2782
- wresult: string;
2783
- /** @description Serialized JSON with context */
2784
- wctx: string;
2785
- };
2786
- };
2787
- responses: never;
2788
- parameters: never;
2789
- requestBodies: never;
2790
- headers: never;
2791
- pathItems: never;
2792
- }
2793
- export type $defs = Record<string, never>;
2794
- export interface operations {
2795
- "connection/list": {
2796
- parameters: {
2797
- query?: {
2798
- /** @description Start from this cursor */
2799
- cursor?: string;
2800
- /** @description Start from this cursor */
2801
- next?: string;
2802
- /** @description Size of the results array */
2803
- pageSize?: number;
2804
- /** @description Filter using a FaableQL query */
2805
- query?: string;
2806
- expand?: string[];
2807
- };
2808
- header?: never;
2809
- path?: never;
2810
- cookie?: never;
2811
- };
2812
- requestBody?: never;
2813
- responses: {
2814
- /** @description PaginatedResponse */
2815
- 200: {
2816
- headers: {
2817
- [name: string]: unknown;
2818
- };
2819
- content: {
2820
- "application/json": {
2821
- /** @description next cursor */
2822
- next: string | null;
2823
- /** @description List of results */
2824
- results: components["schemas"]["Connection"][];
2825
- };
2826
- };
2827
- };
2828
- };
2829
- };
2830
- "connection/create": {
2831
- parameters: {
2832
- query?: never;
2833
- header?: never;
2834
- path?: never;
2835
- cookie?: never;
2836
- };
2837
- requestBody?: {
2838
- content: {
2839
- "application/json": components["schemas"]["ConnectionCreate"];
2840
- };
2841
- };
2842
- responses: {
2843
- /** @description Connection */
2844
- 200: {
2845
- headers: {
2846
- [name: string]: unknown;
2847
- };
2848
- content: {
2849
- "application/json": components["schemas"]["Connection"];
2850
- };
2851
- };
2852
- };
2853
- };
2854
- "connection/get": {
2855
- parameters: {
2856
- query?: never;
2857
- header?: never;
2858
- path: {
2859
- connection_id: string;
2860
- };
2861
- cookie?: never;
2862
- };
2863
- requestBody?: never;
2864
- responses: {
2865
- /** @description Connection */
2866
- 200: {
2867
- headers: {
2868
- [name: string]: unknown;
2869
- };
2870
- content: {
2871
- "application/json": components["schemas"]["Connection"];
2872
- };
2873
- };
2874
- };
2875
- };
2876
- "connection/remove": {
2877
- parameters: {
2878
- query?: never;
2879
- header?: never;
2880
- path: {
2881
- connection_id: string;
2882
- };
2883
- cookie?: never;
2884
- };
2885
- requestBody?: never;
2886
- responses: {
2887
- /** @description Default Response */
2888
- 200: {
2889
- headers: {
2890
- [name: string]: unknown;
2891
- };
2892
- content?: never;
2893
- };
2894
- };
2895
- };
2896
- "client/list": {
2897
- parameters: {
2898
- query?: {
2899
- /** @description Start from this cursor */
2900
- cursor?: string;
2901
- /** @description Start from this cursor */
2902
- next?: string;
2903
- /** @description Size of the results array */
2904
- pageSize?: number;
2905
- /** @description Filter using a FaableQL query */
2906
- query?: string;
2907
- expand?: string[];
2908
- };
2909
- header?: never;
2910
- path?: never;
2911
- cookie?: never;
2912
- };
2913
- requestBody?: never;
2914
- responses: {
2915
- /** @description PaginatedResponse */
2916
- 200: {
2917
- headers: {
2918
- [name: string]: unknown;
2919
- };
2920
- content: {
2921
- "application/json": {
2922
- /** @description next cursor */
2923
- next: string | null;
2924
- /** @description List of results */
2925
- results: components["schemas"]["Client"][];
2926
- };
2927
- };
2928
- };
2929
- };
2930
- };
2931
- "client/create": {
2932
- parameters: {
2933
- query?: never;
2934
- header?: never;
2935
- path?: never;
2936
- cookie?: never;
2937
- };
2938
- requestBody?: {
2939
- content: {
2940
- "application/json": components["schemas"]["ClientCreate"];
2941
- };
2942
- };
2943
- responses: {
2944
- /** @description Client */
2945
- 200: {
2946
- headers: {
2947
- [name: string]: unknown;
2948
- };
2949
- content: {
2950
- "application/json": components["schemas"]["Client"];
2951
- };
2952
- };
2953
- };
2954
- };
2955
- "client/get": {
2956
- parameters: {
2957
- query?: never;
2958
- header?: never;
2959
- path: {
2960
- client_id: string;
2961
- };
2962
- cookie?: never;
2963
- };
2964
- requestBody?: never;
2965
- responses: {
2966
- /** @description Client */
2967
- 200: {
2968
- headers: {
2969
- [name: string]: unknown;
2970
- };
2971
- content: {
2972
- "application/json": components["schemas"]["Client"];
2973
- };
2974
- };
2975
- };
2976
- };
2977
- "client/remove": {
2978
- parameters: {
2979
- query?: never;
2980
- header?: never;
2981
- path: {
2982
- client_id: string;
2983
- };
2984
- cookie?: never;
2985
- };
2986
- requestBody?: never;
2987
- responses: {
2988
- /** @description Default Response */
2989
- 200: {
2990
- headers: {
2991
- [name: string]: unknown;
2992
- };
2993
- content?: never;
2994
- };
2995
- };
2996
- };
2997
- "user/list": {
2998
- parameters: {
2999
- query?: {
3000
- /** @description Start from this cursor */
3001
- cursor?: string;
3002
- /** @description Start from this cursor */
3003
- next?: string;
3004
- /** @description Size of the results array */
3005
- pageSize?: number;
3006
- /** @description Filter using a FaableQL query */
3007
- query?: string;
3008
- expand?: string[];
3009
- };
3010
- header?: never;
3011
- path?: never;
3012
- cookie?: never;
3013
- };
3014
- requestBody?: never;
3015
- responses: {
3016
- /** @description PaginatedResponse */
3017
- 200: {
3018
- headers: {
3019
- [name: string]: unknown;
3020
- };
3021
- content: {
3022
- "application/json": {
3023
- /** @description next cursor */
3024
- next: string | null;
3025
- /** @description List of results */
3026
- results: components["schemas"]["User"][];
3027
- };
3028
- };
3029
- };
3030
- };
3031
- };
3032
- "user/create": {
3033
- parameters: {
3034
- query?: never;
3035
- header?: never;
3036
- path?: never;
3037
- cookie?: never;
3038
- };
3039
- requestBody?: {
3040
- content: {
3041
- "application/json": components["schemas"]["UserCreate"];
3042
- };
3043
- };
3044
- responses: {
3045
- /** @description User */
3046
- 200: {
3047
- headers: {
3048
- [name: string]: unknown;
3049
- };
3050
- content: {
3051
- "application/json": components["schemas"]["User"];
3052
- };
3053
- };
3054
- };
3055
- };
3056
- "user/get": {
3057
- parameters: {
3058
- query?: never;
3059
- header?: never;
3060
- path: {
3061
- user_id: string;
3062
- };
3063
- cookie?: never;
3064
- };
3065
- requestBody?: never;
3066
- responses: {
3067
- /** @description User */
3068
- 200: {
3069
- headers: {
3070
- [name: string]: unknown;
3071
- };
3072
- content: {
3073
- "application/json": components["schemas"]["User"];
3074
- };
3075
- };
3076
- };
3077
- };
3078
- "user/update": {
3079
- parameters: {
3080
- query?: never;
3081
- header?: never;
3082
- path: {
3083
- user_id: string;
3084
- };
3085
- cookie?: never;
3086
- };
3087
- requestBody?: {
3088
- content: {
3089
- "application/json": components["schemas"]["UserUpdate"];
3090
- };
3091
- };
3092
- responses: {
3093
- /** @description User */
3094
- 200: {
3095
- headers: {
3096
- [name: string]: unknown;
3097
- };
3098
- content: {
3099
- "application/json": components["schemas"]["User"];
3100
- };
3101
- };
3102
- };
3103
- };
3104
- "user/remove": {
3105
- parameters: {
3106
- query?: never;
3107
- header?: never;
3108
- path: {
3109
- user_id: string;
3110
- };
3111
- cookie?: never;
3112
- };
3113
- requestBody?: never;
3114
- responses: {
3115
- /** @description Default Response */
3116
- 200: {
3117
- headers: {
3118
- [name: string]: unknown;
3119
- };
3120
- content?: never;
3121
- };
3122
- };
3123
- };
3124
- "identity/list": {
3125
- parameters: {
3126
- query?: {
3127
- /** @description Start from this cursor */
3128
- cursor?: string;
3129
- /** @description Start from this cursor */
3130
- next?: string;
3131
- /** @description Size of the results array */
3132
- pageSize?: number;
3133
- /** @description Filter using a FaableQL query */
3134
- query?: string;
3135
- expand?: string[];
3136
- };
3137
- header?: never;
3138
- path?: never;
3139
- cookie?: never;
3140
- };
3141
- requestBody?: never;
3142
- responses: {
3143
- /** @description PaginatedResponse */
3144
- 200: {
3145
- headers: {
3146
- [name: string]: unknown;
3147
- };
3148
- content: {
3149
- "application/json": {
3150
- /** @description next cursor */
3151
- next: string | null;
3152
- /** @description List of results */
3153
- results: components["schemas"]["Identity"][];
3154
- };
3155
- };
3156
- };
3157
- };
3158
- };
3159
- "identity/create": {
3160
- parameters: {
3161
- query?: never;
3162
- header?: never;
3163
- path?: never;
3164
- cookie?: never;
3165
- };
3166
- requestBody?: {
3167
- content: {
3168
- "application/json": components["schemas"]["IdentityCreate"];
3169
- };
3170
- };
3171
- responses: {
3172
- /** @description Identity */
3173
- 200: {
3174
- headers: {
3175
- [name: string]: unknown;
3176
- };
3177
- content: {
3178
- "application/json": components["schemas"]["Identity"];
3179
- };
3180
- };
3181
- };
3182
- };
3183
- "identity/get": {
3184
- parameters: {
3185
- query?: never;
3186
- header?: never;
3187
- path: {
3188
- identity_id: string;
3189
- };
3190
- cookie?: never;
3191
- };
3192
- requestBody?: never;
3193
- responses: {
3194
- /** @description Identity */
3195
- 200: {
3196
- headers: {
3197
- [name: string]: unknown;
3198
- };
3199
- content: {
3200
- "application/json": components["schemas"]["Identity"];
3201
- };
3202
- };
3203
- };
3204
- };
3205
- "identity/remove": {
3206
- parameters: {
3207
- query?: never;
3208
- header?: never;
3209
- path: {
3210
- identity_id: string;
3211
- };
3212
- cookie?: never;
3213
- };
3214
- requestBody?: never;
3215
- responses: {
3216
- /** @description Default Response */
3217
- 200: {
3218
- headers: {
3219
- [name: string]: unknown;
3220
- };
3221
- content?: never;
3222
- };
3223
- };
3224
- };
3225
- "role/list": {
3226
- parameters: {
3227
- query?: {
3228
- /** @description Start from this cursor */
3229
- cursor?: string;
3230
- /** @description Start from this cursor */
3231
- next?: string;
3232
- /** @description Size of the results array */
3233
- pageSize?: number;
3234
- /** @description Filter using a FaableQL query */
3235
- query?: string;
3236
- expand?: string[];
3237
- };
3238
- header?: never;
3239
- path?: never;
3240
- cookie?: never;
3241
- };
3242
- requestBody?: never;
3243
- responses: {
3244
- /** @description PaginatedResponse */
3245
- 200: {
3246
- headers: {
3247
- [name: string]: unknown;
3248
- };
3249
- content: {
3250
- "application/json": {
3251
- /** @description next cursor */
3252
- next: string | null;
3253
- /** @description List of results */
3254
- results: components["schemas"]["Role"][];
3255
- };
3256
- };
3257
- };
3258
- };
3259
- };
3260
- "role/create": {
3261
- parameters: {
3262
- query?: never;
3263
- header?: never;
3264
- path?: never;
3265
- cookie?: never;
3266
- };
3267
- requestBody?: {
3268
- content: {
3269
- "application/json": components["schemas"]["RoleCreate"];
3270
- };
3271
- };
3272
- responses: {
3273
- /** @description Role */
3274
- 200: {
3275
- headers: {
3276
- [name: string]: unknown;
3277
- };
3278
- content: {
3279
- "application/json": components["schemas"]["Role"];
3280
- };
3281
- };
3282
- };
3283
- };
3284
- "role/get": {
3285
- parameters: {
3286
- query?: never;
3287
- header?: never;
3288
- path: {
3289
- role_id: string;
3290
- };
3291
- cookie?: never;
3292
- };
3293
- requestBody?: never;
3294
- responses: {
3295
- /** @description Role */
3296
- 200: {
3297
- headers: {
3298
- [name: string]: unknown;
3299
- };
3300
- content: {
3301
- "application/json": components["schemas"]["Role"];
3302
- };
3303
- };
3304
- };
3305
- };
3306
- "role/remove": {
3307
- parameters: {
3308
- query?: never;
3309
- header?: never;
3310
- path: {
3311
- role_id: string;
3312
- };
3313
- cookie?: never;
3314
- };
3315
- requestBody?: never;
3316
- responses: {
3317
- /** @description Default Response */
3318
- 200: {
3319
- headers: {
3320
- [name: string]: unknown;
3321
- };
3322
- content?: never;
3323
- };
3324
- };
3325
- };
3326
- "role/users": {
3327
- parameters: {
3328
- query?: {
3329
- /** @description Start from this cursor */
3330
- cursor?: string;
3331
- /** @description Start from this cursor */
3332
- next?: string;
3333
- /** @description Size of the results array */
3334
- pageSize?: number;
3335
- };
3336
- header?: never;
3337
- path: {
3338
- role_id: string;
3339
- };
3340
- cookie?: never;
3341
- };
3342
- requestBody?: never;
3343
- responses: {
3344
- /** @description PaginatedResponse */
3345
- 200: {
3346
- headers: {
3347
- [name: string]: unknown;
3348
- };
3349
- content: {
3350
- "application/json": {
3351
- /** @description next cursor */
3352
- next: string | null;
3353
- /** @description List of results */
3354
- results: components["schemas"]["RoleMember"][];
3355
- };
3356
- };
3357
- };
3358
- };
3359
- };
3360
- "role/assign_users": {
3361
- parameters: {
3362
- query?: never;
3363
- header?: never;
3364
- path: {
3365
- role_id: string;
3366
- };
3367
- cookie?: never;
3368
- };
3369
- requestBody?: {
3370
- content: {
3371
- "application/json": components["schemas"]["RoleMemberCreate"];
3372
- };
3373
- };
3374
- responses: {
3375
- /** @description Default Response */
3376
- 200: {
3377
- headers: {
3378
- [name: string]: unknown;
3379
- };
3380
- content?: never;
3381
- };
3382
- };
3383
- };
3384
- "rolemember/list": {
3385
- parameters: {
3386
- query?: {
3387
- /** @description Start from this cursor */
3388
- cursor?: string;
3389
- /** @description Start from this cursor */
3390
- next?: string;
3391
- /** @description Size of the results array */
3392
- pageSize?: number;
3393
- /** @description Filter using a FaableQL query */
3394
- query?: string;
3395
- expand?: string[];
3396
- };
3397
- header?: never;
3398
- path?: never;
3399
- cookie?: never;
3400
- };
3401
- requestBody?: never;
3402
- responses: {
3403
- /** @description PaginatedResponse */
3404
- 200: {
3405
- headers: {
3406
- [name: string]: unknown;
3407
- };
3408
- content: {
3409
- "application/json": {
3410
- /** @description next cursor */
3411
- next: string | null;
3412
- /** @description List of results */
3413
- results: components["schemas"]["RoleMember"][];
3414
- };
3415
- };
3416
- };
3417
- };
3418
- };
3419
- "rolemember/create": {
3420
- parameters: {
3421
- query?: never;
3422
- header?: never;
3423
- path?: never;
3424
- cookie?: never;
3425
- };
3426
- requestBody?: {
3427
- content: {
3428
- "application/json": components["schemas"]["RoleMemberCreate"];
3429
- };
3430
- };
3431
- responses: {
3432
- /** @description RoleMember */
3433
- 200: {
3434
- headers: {
3435
- [name: string]: unknown;
3436
- };
3437
- content: {
3438
- "application/json": components["schemas"]["RoleMember"];
3439
- };
3440
- };
3441
- };
3442
- };
3443
- "rolemember/get": {
3444
- parameters: {
3445
- query?: never;
3446
- header?: never;
3447
- path: {
3448
- rolemember_id: string;
3449
- };
3450
- cookie?: never;
3451
- };
3452
- requestBody?: never;
3453
- responses: {
3454
- /** @description RoleMember */
3455
- 200: {
3456
- headers: {
3457
- [name: string]: unknown;
3458
- };
3459
- content: {
3460
- "application/json": components["schemas"]["RoleMember"];
3461
- };
3462
- };
3463
- };
3464
- };
3465
- "rolemember/remove": {
3466
- parameters: {
3467
- query?: never;
3468
- header?: never;
3469
- path: {
3470
- rolemember_id: string;
3471
- };
3472
- cookie?: never;
3473
- };
3474
- requestBody?: never;
3475
- responses: {
3476
- /** @description Default Response */
3477
- 200: {
3478
- headers: {
3479
- [name: string]: unknown;
3480
- };
3481
- content?: never;
3482
- };
3483
- };
3484
- };
3485
- "team/list": {
3486
- parameters: {
3487
- query?: {
3488
- /** @description Start from this cursor */
3489
- cursor?: string;
3490
- /** @description Start from this cursor */
3491
- next?: string;
3492
- /** @description Size of the results array */
3493
- pageSize?: number;
3494
- /** @description Filter using a FaableQL query */
3495
- query?: string;
3496
- expand?: string[];
3497
- };
3498
- header?: never;
3499
- path?: never;
3500
- cookie?: never;
3501
- };
3502
- requestBody?: never;
3503
- responses: {
3504
- /** @description PaginatedResponse */
3505
- 200: {
3506
- headers: {
3507
- [name: string]: unknown;
3508
- };
3509
- content: {
3510
- "application/json": {
3511
- /** @description next cursor */
3512
- next: string | null;
3513
- /** @description List of results */
3514
- results: components["schemas"]["Team"][];
3515
- };
3516
- };
3517
- };
3518
- };
3519
- };
3520
- "team/create": {
3521
- parameters: {
3522
- query?: never;
3523
- header?: never;
3524
- path?: never;
3525
- cookie?: never;
3526
- };
3527
- requestBody?: {
3528
- content: {
3529
- "application/json": components["schemas"]["TeamCreate"];
3530
- };
3531
- };
3532
- responses: {
3533
- /** @description Team */
3534
- 200: {
3535
- headers: {
3536
- [name: string]: unknown;
3537
- };
3538
- content: {
3539
- "application/json": components["schemas"]["Team"];
3540
- };
3541
- };
3542
- };
3543
- };
3544
- "team/get": {
3545
- parameters: {
3546
- query?: never;
3547
- header?: never;
3548
- path: {
3549
- team_id: string;
3550
- };
3551
- cookie?: never;
3552
- };
3553
- requestBody?: never;
3554
- responses: {
3555
- /** @description Team */
3556
- 200: {
3557
- headers: {
3558
- [name: string]: unknown;
3559
- };
3560
- content: {
3561
- "application/json": components["schemas"]["Team"];
3562
- };
3563
- };
3564
- };
3565
- };
3566
- "team/remove": {
3567
- parameters: {
3568
- query?: never;
3569
- header?: never;
3570
- path: {
3571
- team_id: string;
3572
- };
3573
- cookie?: never;
3574
- };
3575
- requestBody?: never;
3576
- responses: {
3577
- /** @description Default Response */
3578
- 200: {
3579
- headers: {
3580
- [name: string]: unknown;
3581
- };
3582
- content?: never;
3583
- };
3584
- };
3585
- };
3586
- "teammember/list": {
3587
- parameters: {
3588
- query?: {
3589
- /** @description Start from this cursor */
3590
- cursor?: string;
3591
- /** @description Start from this cursor */
3592
- next?: string;
3593
- /** @description Size of the results array */
3594
- pageSize?: number;
3595
- /** @description Filter using a FaableQL query */
3596
- query?: string;
3597
- expand?: string[];
3598
- };
3599
- header?: never;
3600
- path?: never;
3601
- cookie?: never;
3602
- };
3603
- requestBody?: never;
3604
- responses: {
3605
- /** @description PaginatedResponse */
3606
- 200: {
3607
- headers: {
3608
- [name: string]: unknown;
3609
- };
3610
- content: {
3611
- "application/json": {
3612
- /** @description next cursor */
3613
- next: string | null;
3614
- /** @description List of results */
3615
- results: components["schemas"]["TeamMember"][];
3616
- };
3617
- };
3618
- };
3619
- };
3620
- };
3621
- "teammember/create": {
3622
- parameters: {
3623
- query?: never;
3624
- header?: never;
3625
- path?: never;
3626
- cookie?: never;
3627
- };
3628
- requestBody?: {
3629
- content: {
3630
- "application/json": components["schemas"]["TeamMemberCreate"];
3631
- };
3632
- };
3633
- responses: {
3634
- /** @description TeamMember */
3635
- 200: {
3636
- headers: {
3637
- [name: string]: unknown;
3638
- };
3639
- content: {
3640
- "application/json": components["schemas"]["TeamMember"];
3641
- };
3642
- };
3643
- };
3644
- };
3645
- "teammember/get": {
3646
- parameters: {
3647
- query?: never;
3648
- header?: never;
3649
- path: {
3650
- teammember_id: string;
3651
- };
3652
- cookie?: never;
3653
- };
3654
- requestBody?: never;
3655
- responses: {
3656
- /** @description TeamMember */
3657
- 200: {
3658
- headers: {
3659
- [name: string]: unknown;
3660
- };
3661
- content: {
3662
- "application/json": components["schemas"]["TeamMember"];
3663
- };
3664
- };
3665
- };
3666
- };
3667
- "teammember/remove": {
3668
- parameters: {
3669
- query?: never;
3670
- header?: never;
3671
- path: {
3672
- teammember_id: string;
3673
- };
3674
- cookie?: never;
3675
- };
3676
- requestBody?: never;
3677
- responses: {
3678
- /** @description Default Response */
3679
- 200: {
3680
- headers: {
3681
- [name: string]: unknown;
3682
- };
3683
- content?: never;
3684
- };
3685
- };
3686
- };
3687
- "api/list": {
3688
- parameters: {
3689
- query?: {
3690
- /** @description Start from this cursor */
3691
- cursor?: string;
3692
- /** @description Start from this cursor */
3693
- next?: string;
3694
- /** @description Size of the results array */
3695
- pageSize?: number;
3696
- /** @description Filter using a FaableQL query */
3697
- query?: string;
3698
- expand?: string[];
3699
- };
3700
- header?: never;
3701
- path?: never;
3702
- cookie?: never;
3703
- };
3704
- requestBody?: never;
3705
- responses: {
3706
- /** @description PaginatedResponse */
3707
- 200: {
3708
- headers: {
3709
- [name: string]: unknown;
3710
- };
3711
- content: {
3712
- "application/json": {
3713
- /** @description next cursor */
3714
- next: string | null;
3715
- /** @description List of results */
3716
- results: components["schemas"]["Api"][];
3717
- };
3718
- };
3719
- };
3720
- };
3721
- };
3722
- "api/create": {
3723
- parameters: {
3724
- query?: never;
3725
- header?: never;
3726
- path?: never;
3727
- cookie?: never;
3728
- };
3729
- requestBody?: {
3730
- content: {
3731
- "application/json": components["schemas"]["ApiCreate"];
3732
- };
3733
- };
3734
- responses: {
3735
- /** @description Api */
3736
- 200: {
3737
- headers: {
3738
- [name: string]: unknown;
3739
- };
3740
- content: {
3741
- "application/json": components["schemas"]["Api"];
3742
- };
3743
- };
3744
- };
3745
- };
3746
- "api/get": {
3747
- parameters: {
3748
- query?: never;
3749
- header?: never;
3750
- path: {
3751
- api_id: string;
3752
- };
3753
- cookie?: never;
3754
- };
3755
- requestBody?: never;
3756
- responses: {
3757
- /** @description Api */
3758
- 200: {
3759
- headers: {
3760
- [name: string]: unknown;
3761
- };
3762
- content: {
3763
- "application/json": components["schemas"]["Api"];
3764
- };
3765
- };
3766
- };
3767
- };
3768
- "api/remove": {
3769
- parameters: {
3770
- query?: never;
3771
- header?: never;
3772
- path: {
3773
- api_id: string;
3774
- };
3775
- cookie?: never;
3776
- };
3777
- requestBody?: never;
3778
- responses: {
3779
- /** @description Default Response */
3780
- 200: {
3781
- headers: {
3782
- [name: string]: unknown;
3783
- };
3784
- content?: never;
3785
- };
3786
- };
3787
- };
3788
- "action/list": {
3789
- parameters: {
3790
- query?: {
3791
- /** @description Start from this cursor */
3792
- cursor?: string;
3793
- /** @description Start from this cursor */
3794
- next?: string;
3795
- /** @description Size of the results array */
3796
- pageSize?: number;
3797
- /** @description Filter using a FaableQL query */
3798
- query?: string;
3799
- expand?: string[];
3800
- };
3801
- header?: never;
3802
- path?: never;
3803
- cookie?: never;
3804
- };
3805
- requestBody?: never;
3806
- responses: {
3807
- /** @description PaginatedResponse */
3808
- 200: {
3809
- headers: {
3810
- [name: string]: unknown;
3811
- };
3812
- content: {
3813
- "application/json": {
3814
- /** @description next cursor */
3815
- next: string | null;
3816
- /** @description List of results */
3817
- results: components["schemas"]["Action"][];
3818
- };
3819
- };
3820
- };
3821
- };
3822
- };
3823
- "action/create": {
3824
- parameters: {
3825
- query?: never;
3826
- header?: never;
3827
- path?: never;
3828
- cookie?: never;
3829
- };
3830
- requestBody?: {
3831
- content: {
3832
- "application/json": components["schemas"]["ActionCreate"];
3833
- };
3834
- };
3835
- responses: {
3836
- /** @description Action */
3837
- 200: {
3838
- headers: {
3839
- [name: string]: unknown;
3840
- };
3841
- content: {
3842
- "application/json": components["schemas"]["Action"];
3843
- };
3844
- };
3845
- };
3846
- };
3847
- "action/get": {
3848
- parameters: {
3849
- query?: never;
3850
- header?: never;
3851
- path: {
3852
- action_id: string;
3853
- };
3854
- cookie?: never;
3855
- };
3856
- requestBody?: never;
3857
- responses: {
3858
- /** @description Action */
3859
- 200: {
3860
- headers: {
3861
- [name: string]: unknown;
3862
- };
3863
- content: {
3864
- "application/json": components["schemas"]["Action"];
3865
- };
3866
- };
3867
- };
3868
- };
3869
- "action/remove": {
3870
- parameters: {
3871
- query?: never;
3872
- header?: never;
3873
- path: {
3874
- action_id: string;
3875
- };
3876
- cookie?: never;
3877
- };
3878
- requestBody?: never;
3879
- responses: {
3880
- /** @description Default Response */
3881
- 200: {
3882
- headers: {
3883
- [name: string]: unknown;
3884
- };
3885
- content?: never;
3886
- };
3887
- };
3888
- };
3889
- "notificationsubscription/list": {
3890
- parameters: {
3891
- query?: {
3892
- /** @description Start from this cursor */
3893
- cursor?: string;
3894
- /** @description Start from this cursor */
3895
- next?: string;
3896
- /** @description Size of the results array */
3897
- pageSize?: number;
3898
- /** @description Filter using a FaableQL query */
3899
- query?: string;
3900
- expand?: string[];
3901
- };
3902
- header?: never;
3903
- path?: never;
3904
- cookie?: never;
3905
- };
3906
- requestBody?: never;
3907
- responses: {
3908
- /** @description PaginatedResponse */
3909
- 200: {
3910
- headers: {
3911
- [name: string]: unknown;
3912
- };
3913
- content: {
3914
- "application/json": {
3915
- /** @description next cursor */
3916
- next: string | null;
3917
- /** @description List of results */
3918
- results: components["schemas"]["NotificationSubscription"][];
3919
- };
3920
- };
3921
- };
3922
- };
3923
- };
3924
- "notificationsubscription/create": {
3925
- parameters: {
3926
- query?: never;
3927
- header?: never;
3928
- path?: never;
3929
- cookie?: never;
3930
- };
3931
- requestBody?: {
3932
- content: {
3933
- "application/json": components["schemas"]["NotificationSubscriptionCreate"];
3934
- };
3935
- };
3936
- responses: {
3937
- /** @description NotificationSubscription */
3938
- 200: {
3939
- headers: {
3940
- [name: string]: unknown;
3941
- };
3942
- content: {
3943
- "application/json": components["schemas"]["NotificationSubscription"];
3944
- };
3945
- };
3946
- };
3947
- };
3948
- "notificationsubscription/get": {
3949
- parameters: {
3950
- query?: never;
3951
- header?: never;
3952
- path: {
3953
- notificationsubscription_id: string;
3954
- };
3955
- cookie?: never;
3956
- };
3957
- requestBody?: never;
3958
- responses: {
3959
- /** @description NotificationSubscription */
3960
- 200: {
3961
- headers: {
3962
- [name: string]: unknown;
3963
- };
3964
- content: {
3965
- "application/json": components["schemas"]["NotificationSubscription"];
3966
- };
3967
- };
3968
- };
3969
- };
3970
- "notificationsubscription/update": {
3971
- parameters: {
3972
- query?: never;
3973
- header?: never;
3974
- path: {
3975
- notificationsubscription_id: string;
3976
- };
3977
- cookie?: never;
3978
- };
3979
- requestBody?: {
3980
- content: {
3981
- "application/json": components["schemas"]["NotificationSubscriptionUpdate"];
3982
- };
3983
- };
3984
- responses: {
3985
- /** @description NotificationSubscription */
3986
- 200: {
3987
- headers: {
3988
- [name: string]: unknown;
3989
- };
3990
- content: {
3991
- "application/json": components["schemas"]["NotificationSubscription"];
3992
- };
3993
- };
3994
- };
3995
- };
3996
- "notificationsubscription/remove": {
3997
- parameters: {
3998
- query?: never;
3999
- header?: never;
4000
- path: {
4001
- notificationsubscription_id: string;
4002
- };
4003
- cookie?: never;
4004
- };
4005
- requestBody?: never;
4006
- responses: {
4007
- /** @description Default Response */
4008
- 200: {
4009
- headers: {
4010
- [name: string]: unknown;
4011
- };
4012
- content?: never;
4013
- };
4014
- };
4015
- };
4016
- "customdomain/retry": {
4017
- parameters: {
4018
- query?: never;
4019
- header?: never;
4020
- path: {
4021
- Customdomain_id: string;
4022
- };
4023
- cookie?: never;
4024
- };
4025
- requestBody?: never;
4026
- responses: {
4027
- /** @description Default Response */
4028
- 200: {
4029
- headers: {
4030
- [name: string]: unknown;
4031
- };
4032
- content?: never;
4033
- };
4034
- };
4035
- };
4036
- "customdomain/list": {
4037
- parameters: {
4038
- query?: {
4039
- /** @description Start from this cursor */
4040
- cursor?: string;
4041
- /** @description Start from this cursor */
4042
- next?: string;
4043
- /** @description Size of the results array */
4044
- pageSize?: number;
4045
- /** @description Filter using a FaableQL query */
4046
- query?: string;
4047
- expand?: string[];
4048
- };
4049
- header?: never;
4050
- path?: never;
4051
- cookie?: never;
4052
- };
4053
- requestBody?: never;
4054
- responses: {
4055
- /** @description PaginatedResponse */
4056
- 200: {
4057
- headers: {
4058
- [name: string]: unknown;
4059
- };
4060
- content: {
4061
- "application/json": {
4062
- /** @description next cursor */
4063
- next: string | null;
4064
- /** @description List of results */
4065
- results: components["schemas"]["Customdomain"][];
4066
- };
4067
- };
4068
- };
4069
- };
4070
- };
4071
- "customdomain/create": {
4072
- parameters: {
4073
- query?: never;
4074
- header?: never;
4075
- path?: never;
4076
- cookie?: never;
4077
- };
4078
- requestBody?: {
4079
- content: {
4080
- "application/json": components["schemas"]["CustomdomainCreate"];
4081
- };
4082
- };
4083
- responses: {
4084
- /** @description Customdomain */
4085
- 200: {
4086
- headers: {
4087
- [name: string]: unknown;
4088
- };
4089
- content: {
4090
- "application/json": components["schemas"]["Customdomain"];
4091
- };
4092
- };
4093
- };
4094
- };
4095
- "customdomain/get": {
4096
- parameters: {
4097
- query?: never;
4098
- header?: never;
4099
- path: {
4100
- customdomain_id: string;
4101
- };
4102
- cookie?: never;
4103
- };
4104
- requestBody?: never;
4105
- responses: {
4106
- /** @description Customdomain */
4107
- 200: {
4108
- headers: {
4109
- [name: string]: unknown;
4110
- };
4111
- content: {
4112
- "application/json": components["schemas"]["Customdomain"];
4113
- };
4114
- };
4115
- };
4116
- };
4117
- "customdomain/remove": {
4118
- parameters: {
4119
- query?: never;
4120
- header?: never;
4121
- path: {
4122
- customdomain_id: string;
4123
- };
4124
- cookie?: never;
4125
- };
4126
- requestBody?: never;
4127
- responses: {
4128
- /** @description Default Response */
4129
- 200: {
4130
- headers: {
4131
- [name: string]: unknown;
4132
- };
4133
- content?: never;
4134
- };
4135
- };
4136
- };
4137
- "passwordless/verify_redirect": {
4138
- parameters: {
4139
- query: {
4140
- token: string;
4141
- };
4142
- header?: never;
4143
- path?: never;
4144
- cookie?: never;
4145
- };
4146
- requestBody?: never;
4147
- responses: {
4148
- /** @description Default Response */
4149
- 200: {
4150
- headers: {
4151
- [name: string]: unknown;
4152
- };
4153
- content?: never;
4154
- };
4155
- };
4156
- };
4157
- "passwordless/start": {
4158
- parameters: {
4159
- query?: never;
4160
- header?: never;
4161
- path?: never;
4162
- cookie?: never;
4163
- };
4164
- requestBody: {
4165
- content: {
4166
- "application/json": {
4167
- client_id: string;
4168
- email: string;
4169
- /** @default link */
4170
- send: string;
4171
- auth_params?: {
4172
- [key: string]: string;
4173
- };
4174
- };
4175
- };
4176
- };
4177
- responses: {
4178
- /** @description Default Response */
4179
- 200: {
4180
- headers: {
4181
- [name: string]: unknown;
4182
- };
4183
- content?: never;
4184
- };
4185
- };
4186
- };
4187
- authorize: {
4188
- parameters: {
4189
- query: {
4190
- response_type?: string;
4191
- /** @description Challenge method for PKCE. Only S256 is supported. */
4192
- code_challenge_method?: string;
4193
- /** @description Challenge for PKCE authorization code flow */
4194
- code_challenge?: string;
4195
- client_id: string;
4196
- /** @description Deprecated. Use connection_id */
4197
- connection?: string;
4198
- /** @description Which oauth connection to use. Leave empty to use default connection */
4199
- connection_id?: string;
4200
- scope?: string;
4201
- /** @description The URL to which Faable will redirect the browser after authorization has been granted by the user. */
4202
- redirect_uri?: string;
4203
- /** @description An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the application. This value must be used by the application to prevent CSRF attacks. */
4204
- state?: string;
4205
- prompt?: string;
4206
- };
4207
- header?: never;
4208
- path?: never;
4209
- cookie?: never;
4210
- };
4211
- requestBody?: never;
4212
- responses: {
4213
- /** @description Default Response */
4214
- 200: {
4215
- headers: {
4216
- [name: string]: unknown;
4217
- };
4218
- content?: never;
4219
- };
4220
- };
4221
- };
4222
- "device-authorize": {
4223
- parameters: {
4224
- query?: never;
4225
- header?: never;
4226
- path?: never;
4227
- cookie?: never;
4228
- };
4229
- requestBody: {
4230
- content: {
4231
- "application/json": {
4232
- /** @description The client ID of the application. */
4233
- client_id: string;
4234
- /** @description The scope of the access request. */
4235
- scope?: string;
4236
- };
4237
- };
4238
- };
4239
- responses: {
4240
- /** @description Default Response */
4241
- 200: {
4242
- headers: {
4243
- [name: string]: unknown;
4244
- };
4245
- content: {
4246
- "application/json": {
4247
- device_code: string;
4248
- user_code: string;
4249
- verification_uri: string;
4250
- verification_uri_complete: string;
4251
- expires_in: number;
4252
- interval: number;
4253
- };
4254
- };
4255
- };
4256
- };
4257
- };
4258
- callback: {
4259
- parameters: {
4260
- query?: {
4261
- code?: string;
4262
- state?: string;
4263
- error?: string;
4264
- error_uri?: string;
4265
- error_description?: string;
4266
- };
4267
- header?: never;
4268
- path?: never;
4269
- cookie?: never;
4270
- };
4271
- requestBody?: never;
4272
- responses: {
4273
- /** @description Default Response */
4274
- 200: {
4275
- headers: {
4276
- [name: string]: unknown;
4277
- };
4278
- content?: never;
4279
- };
4280
- };
4281
- };
4282
- oauth_continue: {
4283
- parameters: {
4284
- query: {
4285
- state: string;
4286
- };
4287
- header?: never;
4288
- path?: never;
4289
- cookie?: never;
4290
- };
4291
- requestBody?: never;
4292
- responses: {
4293
- /** @description Default Response */
4294
- 200: {
4295
- headers: {
4296
- [name: string]: unknown;
4297
- };
4298
- content?: never;
4299
- };
4300
- };
4301
- };
4302
- change_password: {
4303
- parameters: {
4304
- query?: never;
4305
- header?: never;
4306
- path?: never;
4307
- cookie?: never;
4308
- };
4309
- requestBody: {
4310
- content: {
4311
- "application/json": {
4312
- email: string;
4313
- };
4314
- };
4315
- };
4316
- responses: {
4317
- /** @description Default Response */
4318
- 200: {
4319
- headers: {
4320
- [name: string]: unknown;
4321
- };
4322
- content?: never;
4323
- };
4324
- };
4325
- };
4326
- change_password_verify: {
4327
- parameters: {
4328
- query: {
4329
- ticket: string;
4330
- };
4331
- header?: never;
4332
- path?: never;
4333
- cookie?: never;
4334
- };
4335
- requestBody?: never;
4336
- responses: {
4337
- /** @description Default Response */
4338
- 200: {
4339
- headers: {
4340
- [name: string]: unknown;
4341
- };
4342
- content?: never;
4343
- };
4344
- };
4345
- };
4346
- change_password_change: {
4347
- parameters: {
4348
- query?: never;
4349
- header?: never;
4350
- path?: never;
4351
- cookie?: never;
4352
- };
4353
- requestBody: {
4354
- content: {
4355
- "application/json": {
4356
- state: string;
4357
- new_password: string;
4358
- };
4359
- };
4360
- };
4361
- responses: {
4362
- /** @description Default Response */
4363
- 200: {
4364
- headers: {
4365
- [name: string]: unknown;
4366
- };
4367
- content?: never;
4368
- };
4369
- };
4370
- };
4371
- }