@faable/auth-sdk 1.3.9 → 1.3.11
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.
- package/dist/FaableAuthApi.d.ts +125 -5
- package/dist/api/types.d.ts +2831 -838
- package/package.json +1 -1
package/dist/api/types.d.ts
CHANGED
|
@@ -3,39 +3,6 @@
|
|
|
3
3
|
* Do not make direct changes to the file.
|
|
4
4
|
*/
|
|
5
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
6
|
"/account/current": {
|
|
40
7
|
parameters: {
|
|
41
8
|
query?: never;
|
|
@@ -45,28 +12,9 @@ export interface paths {
|
|
|
45
12
|
};
|
|
46
13
|
/**
|
|
47
14
|
* Get current Account
|
|
48
|
-
* @description
|
|
15
|
+
* @description Returns the Account resolved from request context (header, hostname, or team id). Use `expand` to populate nested references.
|
|
49
16
|
*/
|
|
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
|
-
};
|
|
17
|
+
get: operations["account/current"];
|
|
70
18
|
put?: never;
|
|
71
19
|
post?: never;
|
|
72
20
|
delete?: never;
|
|
@@ -83,70 +31,16 @@ export interface paths {
|
|
|
83
31
|
cookie?: never;
|
|
84
32
|
};
|
|
85
33
|
/**
|
|
86
|
-
* List
|
|
87
|
-
* @description List
|
|
34
|
+
* List Accounts
|
|
35
|
+
* @description List Accounts owned by the requesting project/team. Supports cursor pagination and `expand`.
|
|
88
36
|
*/
|
|
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
|
-
};
|
|
37
|
+
get: operations["account/list"];
|
|
121
38
|
put?: never;
|
|
122
39
|
/**
|
|
123
40
|
* Create an Account
|
|
124
|
-
* @description
|
|
41
|
+
* @description Creates a new Auth Account. The slug is derived from the name and used to build the default `*.auth.faable.link` domain.
|
|
125
42
|
*/
|
|
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
|
-
};
|
|
43
|
+
post: operations["account/create"];
|
|
150
44
|
delete?: never;
|
|
151
45
|
options?: never;
|
|
152
46
|
head?: never;
|
|
@@ -161,66 +55,17 @@ export interface paths {
|
|
|
161
55
|
cookie?: never;
|
|
162
56
|
};
|
|
163
57
|
/**
|
|
164
|
-
* Get Account
|
|
165
|
-
* @description
|
|
58
|
+
* Get an Account
|
|
59
|
+
* @description Fetch a single Account by its id. Use `expand` to populate id-only fields (e.g. `default_connection`) inline.
|
|
166
60
|
*/
|
|
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
|
-
};
|
|
61
|
+
get: operations["account/get"];
|
|
206
62
|
put?: never;
|
|
207
63
|
post?: never;
|
|
208
64
|
/**
|
|
209
65
|
* Delete an Account
|
|
210
|
-
* @description
|
|
66
|
+
* @description Permanently removes an Account and its associated data. This action cannot be undone.
|
|
211
67
|
*/
|
|
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
|
-
};
|
|
68
|
+
delete: operations["account/delete"];
|
|
224
69
|
options?: never;
|
|
225
70
|
head?: never;
|
|
226
71
|
patch?: never;
|
|
@@ -234,48 +79,10 @@ export interface paths {
|
|
|
234
79
|
cookie?: never;
|
|
235
80
|
};
|
|
236
81
|
/**
|
|
237
|
-
* Find
|
|
238
|
-
* @description
|
|
82
|
+
* Find Account by host
|
|
83
|
+
* @description Looks up the Account that owns the given hostname, checking both the built-in `*.auth.faable.link` slug and any verified custom domains.
|
|
239
84
|
*/
|
|
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
|
-
};
|
|
85
|
+
get: operations["account/getByHost"];
|
|
279
86
|
put?: never;
|
|
280
87
|
post?: never;
|
|
281
88
|
delete?: never;
|
|
@@ -705,73 +512,15 @@ export interface paths {
|
|
|
705
512
|
};
|
|
706
513
|
/**
|
|
707
514
|
* List Team Members
|
|
708
|
-
* @description List Team
|
|
515
|
+
* @description List all Users that belong to the given Team in the current Account.
|
|
709
516
|
*/
|
|
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
|
-
};
|
|
517
|
+
get: operations["team/listMembers"];
|
|
744
518
|
put?: never;
|
|
745
519
|
/**
|
|
746
|
-
* Add Users
|
|
747
|
-
* @description
|
|
520
|
+
* Add Users to a Team
|
|
521
|
+
* @description Adds one or more Users as members of the given Team. Returns the resulting TeamMember record.
|
|
748
522
|
*/
|
|
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
|
-
};
|
|
523
|
+
post: operations["team/addMembers"];
|
|
775
524
|
delete?: never;
|
|
776
525
|
options?: never;
|
|
777
526
|
head?: never;
|
|
@@ -786,39 +535,10 @@ export interface paths {
|
|
|
786
535
|
cookie?: never;
|
|
787
536
|
};
|
|
788
537
|
/**
|
|
789
|
-
* Check
|
|
790
|
-
* @description
|
|
538
|
+
* Check User is member of a Team
|
|
539
|
+
* @description Returns the TeamMember record if the User belongs to the given Team, or 404 otherwise.
|
|
791
540
|
*/
|
|
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
|
-
};
|
|
541
|
+
get: operations["team/checkMember"];
|
|
822
542
|
put?: never;
|
|
823
543
|
post?: never;
|
|
824
544
|
delete?: never;
|
|
@@ -885,31 +605,10 @@ export interface paths {
|
|
|
885
605
|
get?: never;
|
|
886
606
|
put?: never;
|
|
887
607
|
/**
|
|
888
|
-
* Rotate Account
|
|
889
|
-
* @description
|
|
608
|
+
* Rotate Account signing keys
|
|
609
|
+
* @description Promotes the queued key to production and generates a fresh queued key. The previously-active key is retained inside the JWK Set so tokens already issued remain verifiable via `/.well-known/jwks.json`.
|
|
890
610
|
*/
|
|
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
|
-
};
|
|
611
|
+
post: operations["account/rotateKeys"];
|
|
913
612
|
delete?: never;
|
|
914
613
|
options?: never;
|
|
915
614
|
head?: never;
|
|
@@ -1016,7 +715,47 @@ export interface paths {
|
|
|
1016
715
|
patch?: never;
|
|
1017
716
|
trace?: never;
|
|
1018
717
|
};
|
|
1019
|
-
"/
|
|
718
|
+
"/log": {
|
|
719
|
+
parameters: {
|
|
720
|
+
query?: never;
|
|
721
|
+
header?: never;
|
|
722
|
+
path?: never;
|
|
723
|
+
cookie?: never;
|
|
724
|
+
};
|
|
725
|
+
/**
|
|
726
|
+
* List Logs in Account
|
|
727
|
+
* @description List Logs in Account
|
|
728
|
+
*/
|
|
729
|
+
get: operations["log/list"];
|
|
730
|
+
put?: never;
|
|
731
|
+
post?: never;
|
|
732
|
+
delete?: never;
|
|
733
|
+
options?: never;
|
|
734
|
+
head?: never;
|
|
735
|
+
patch?: never;
|
|
736
|
+
trace?: never;
|
|
737
|
+
};
|
|
738
|
+
"/log/{log_id}": {
|
|
739
|
+
parameters: {
|
|
740
|
+
query?: never;
|
|
741
|
+
header?: never;
|
|
742
|
+
path?: never;
|
|
743
|
+
cookie?: never;
|
|
744
|
+
};
|
|
745
|
+
/**
|
|
746
|
+
* Get Log in Account
|
|
747
|
+
* @description Get Log in Account
|
|
748
|
+
*/
|
|
749
|
+
get: operations["log/get"];
|
|
750
|
+
put?: never;
|
|
751
|
+
post?: never;
|
|
752
|
+
delete?: never;
|
|
753
|
+
options?: never;
|
|
754
|
+
head?: never;
|
|
755
|
+
patch?: never;
|
|
756
|
+
trace?: never;
|
|
757
|
+
};
|
|
758
|
+
"/customdomain/{customdomain_id}/retry": {
|
|
1020
759
|
parameters: {
|
|
1021
760
|
query?: never;
|
|
1022
761
|
header?: never;
|
|
@@ -1025,7 +764,10 @@ export interface paths {
|
|
|
1025
764
|
};
|
|
1026
765
|
get?: never;
|
|
1027
766
|
put?: never;
|
|
1028
|
-
/**
|
|
767
|
+
/**
|
|
768
|
+
* Retry manual domain verification
|
|
769
|
+
* @description Forces a re-verification of a Custom Domain that is in FAILED, DEGRADED or VERIFYING state. Rate-limited to one retry per minute.
|
|
770
|
+
*/
|
|
1029
771
|
post: operations["customdomain/retry"];
|
|
1030
772
|
delete?: never;
|
|
1031
773
|
options?: never;
|
|
@@ -1129,29 +871,10 @@ export interface paths {
|
|
|
1129
871
|
cookie?: never;
|
|
1130
872
|
};
|
|
1131
873
|
/**
|
|
1132
|
-
*
|
|
1133
|
-
* @description
|
|
874
|
+
* Get current User
|
|
875
|
+
* @description Returns the User behind the current session or bearer token. Requires a valid session cookie or `Authorization: Bearer <access_token>` header.
|
|
1134
876
|
*/
|
|
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
|
-
};
|
|
877
|
+
get: operations["session/me"];
|
|
1155
878
|
put?: never;
|
|
1156
879
|
post?: never;
|
|
1157
880
|
delete?: never;
|
|
@@ -1168,30 +891,10 @@ export interface paths {
|
|
|
1168
891
|
cookie?: never;
|
|
1169
892
|
};
|
|
1170
893
|
/**
|
|
1171
|
-
*
|
|
1172
|
-
* @description
|
|
894
|
+
* OpenID Connect RP-Initiated Logout
|
|
895
|
+
* @description Destroys the current session. Implements OIDC RP-Initiated Logout 1.0 and Front-Channel Logout 1.0: when RPs with a registered `frontchannel_logout_uri` participated in the session, returns an HTML page with one iframe per RP and (when applicable) auto-redirects to `post_logout_redirect_uri`.
|
|
1173
896
|
*/
|
|
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
|
-
};
|
|
897
|
+
get: operations["session/logout"];
|
|
1195
898
|
put?: never;
|
|
1196
899
|
post?: never;
|
|
1197
900
|
delete?: never;
|
|
@@ -1228,119 +931,16 @@ export interface paths {
|
|
|
1228
931
|
cookie?: never;
|
|
1229
932
|
};
|
|
1230
933
|
/**
|
|
1231
|
-
* Token
|
|
1232
|
-
* @description Token
|
|
934
|
+
* OAuth2 Token endpoint (GET)
|
|
935
|
+
* @description OAuth2 Token endpoint (RFC 6749 §3.2). Exchanges credentials for tokens depending on `grant_type` (authorization_code, client_credentials, refresh_token, password, otp, token_exchange, device_code). The GET variant accepts the same parameters as querystring.
|
|
1233
936
|
*/
|
|
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
|
-
};
|
|
937
|
+
get: operations["oauth/tokenGet"];
|
|
1276
938
|
put?: never;
|
|
1277
939
|
/**
|
|
1278
|
-
* Token
|
|
1279
|
-
* @description Token
|
|
940
|
+
* OAuth2 Token endpoint
|
|
941
|
+
* @description OAuth2 Token endpoint (RFC 6749 §3.2). Exchanges credentials for tokens depending on `grant_type` (authorization_code, client_credentials, refresh_token, password, otp, token_exchange, device_code).
|
|
1280
942
|
*/
|
|
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
|
-
};
|
|
943
|
+
post: operations["oauth/token"];
|
|
1344
944
|
delete?: never;
|
|
1345
945
|
options?: never;
|
|
1346
946
|
head?: never;
|
|
@@ -1358,9 +958,9 @@ export interface paths {
|
|
|
1358
958
|
put?: never;
|
|
1359
959
|
/**
|
|
1360
960
|
* Device authorization request
|
|
1361
|
-
* @description
|
|
961
|
+
* @description OAuth2 Device Authorization Grant (RFC 8628) — start step. A device that cannot run a browser calls this endpoint to obtain a `device_code`, a `user_code` to show to the user, and the verification URLs to display.
|
|
1362
962
|
*/
|
|
1363
|
-
post: operations["
|
|
963
|
+
post: operations["oauth/deviceCode"];
|
|
1364
964
|
delete?: never;
|
|
1365
965
|
options?: never;
|
|
1366
966
|
head?: never;
|
|
@@ -1375,29 +975,10 @@ export interface paths {
|
|
|
1375
975
|
cookie?: never;
|
|
1376
976
|
};
|
|
1377
977
|
/**
|
|
1378
|
-
*
|
|
1379
|
-
* @description Redirects to the external device
|
|
978
|
+
* Device activation redirect
|
|
979
|
+
* @description Entry URL displayed on the device. Redirects the browser to the external `/flow/device-code/activate` UI where the user enters their `user_code`.
|
|
1380
980
|
*/
|
|
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
|
-
};
|
|
981
|
+
get: operations["oauth/deviceActivate"];
|
|
1401
982
|
put?: never;
|
|
1402
983
|
post?: never;
|
|
1403
984
|
delete?: never;
|
|
@@ -1414,29 +995,10 @@ export interface paths {
|
|
|
1414
995
|
cookie?: never;
|
|
1415
996
|
};
|
|
1416
997
|
/**
|
|
1417
|
-
*
|
|
1418
|
-
* @description Redirects to the external device
|
|
998
|
+
* Device confirmation redirect
|
|
999
|
+
* @description Redirects to the external `/flow/device-code/confirm` UI after the user enters their `user_code`. The UI then calls `/oauth/device/authorize` to grant the device.
|
|
1419
1000
|
*/
|
|
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
|
-
};
|
|
1001
|
+
get: operations["oauth/deviceConfirm"];
|
|
1440
1002
|
put?: never;
|
|
1441
1003
|
post?: never;
|
|
1442
1004
|
delete?: never;
|
|
@@ -1455,41 +1017,10 @@ export interface paths {
|
|
|
1455
1017
|
get?: never;
|
|
1456
1018
|
put?: never;
|
|
1457
1019
|
/**
|
|
1458
|
-
* Verify
|
|
1459
|
-
* @description
|
|
1020
|
+
* Verify a device user_code
|
|
1021
|
+
* @description Called by the external UI after the user enters their `user_code`. Returns the matching `device_code` and minimal client info so the UI can render "Authorize <App>?".
|
|
1460
1022
|
*/
|
|
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
|
-
};
|
|
1023
|
+
post: operations["oauth/deviceVerify"];
|
|
1493
1024
|
delete?: never;
|
|
1494
1025
|
options?: never;
|
|
1495
1026
|
head?: never;
|
|
@@ -1506,37 +1037,10 @@ export interface paths {
|
|
|
1506
1037
|
get?: never;
|
|
1507
1038
|
put?: never;
|
|
1508
1039
|
/**
|
|
1509
|
-
* Authorize device
|
|
1510
|
-
* @description
|
|
1040
|
+
* Authorize a pending device request
|
|
1041
|
+
* @description Authorizes a `device_code` on behalf of the currently authenticated user, allowing the device to subsequently exchange that code for tokens at `/oauth/token`.
|
|
1511
1042
|
*/
|
|
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
|
-
};
|
|
1043
|
+
post: operations["oauth/deviceAuthorize"];
|
|
1540
1044
|
delete?: never;
|
|
1541
1045
|
options?: never;
|
|
1542
1046
|
head?: never;
|
|
@@ -1591,27 +1095,10 @@ export interface paths {
|
|
|
1591
1095
|
cookie?: never;
|
|
1592
1096
|
};
|
|
1593
1097
|
/**
|
|
1594
|
-
* OpenID Discovery
|
|
1595
|
-
* @description OpenID Discovery
|
|
1098
|
+
* OpenID Connect Discovery document
|
|
1099
|
+
* @description Returns the OpenID Provider Configuration document for this Account (issuer, supported endpoints, response types, signing algorithms, claims, etc.) as defined by OIDC Discovery 1.0.
|
|
1596
1100
|
*/
|
|
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
|
-
};
|
|
1101
|
+
get: operations["oauth/openidConfiguration"];
|
|
1615
1102
|
put?: never;
|
|
1616
1103
|
post?: never;
|
|
1617
1104
|
delete?: never;
|
|
@@ -1628,27 +1115,10 @@ export interface paths {
|
|
|
1628
1115
|
cookie?: never;
|
|
1629
1116
|
};
|
|
1630
1117
|
/**
|
|
1631
|
-
*
|
|
1632
|
-
* @description
|
|
1118
|
+
* JSON Web Key Set
|
|
1119
|
+
* @description Returns the public JWKs (RFC 7517) used to verify tokens issued by this Account. Consumers MUST use the `kid` from a token header to select the right key.
|
|
1633
1120
|
*/
|
|
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
|
-
};
|
|
1121
|
+
get: operations["oauth/jwks"];
|
|
1652
1122
|
put?: never;
|
|
1653
1123
|
post?: never;
|
|
1654
1124
|
delete?: never;
|
|
@@ -1657,44 +1127,31 @@ export interface paths {
|
|
|
1657
1127
|
patch?: never;
|
|
1658
1128
|
trace?: never;
|
|
1659
1129
|
};
|
|
1660
|
-
"/
|
|
1130
|
+
"/userinfo": {
|
|
1661
1131
|
parameters: {
|
|
1662
1132
|
query?: never;
|
|
1663
1133
|
header?: never;
|
|
1664
1134
|
path?: never;
|
|
1665
1135
|
cookie?: never;
|
|
1666
1136
|
};
|
|
1667
|
-
|
|
1137
|
+
/**
|
|
1138
|
+
* OpenID Connect UserInfo endpoint
|
|
1139
|
+
* @description Returns claims about the authenticated User. Authentication is via a Bearer access token (RFC 6750). Returned claims are filtered by the `scope` claim of the access token (OIDC §5.3.2). The response always contains `sub`. See https://openid.net/specs/openid-connect-core-1_0.html#UserInfo.
|
|
1140
|
+
*/
|
|
1141
|
+
get: operations["oauth/userinfo"];
|
|
1668
1142
|
put?: never;
|
|
1669
|
-
|
|
1670
|
-
|
|
1671
|
-
|
|
1672
|
-
|
|
1673
|
-
|
|
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
|
-
};
|
|
1143
|
+
/**
|
|
1144
|
+
* OpenID Connect UserInfo endpoint (POST)
|
|
1145
|
+
* @description Same as `GET /userinfo`. Provided for clients that prefer to send the Bearer token in a POST body or are required to by spec compliance audits.
|
|
1146
|
+
*/
|
|
1147
|
+
post: operations["oauth/userinfoPost"];
|
|
1691
1148
|
delete?: never;
|
|
1692
1149
|
options?: never;
|
|
1693
1150
|
head?: never;
|
|
1694
1151
|
patch?: never;
|
|
1695
1152
|
trace?: never;
|
|
1696
1153
|
};
|
|
1697
|
-
"/
|
|
1154
|
+
"/oidc/register": {
|
|
1698
1155
|
parameters: {
|
|
1699
1156
|
query?: never;
|
|
1700
1157
|
header?: never;
|
|
@@ -1703,35 +1160,18 @@ export interface paths {
|
|
|
1703
1160
|
};
|
|
1704
1161
|
get?: never;
|
|
1705
1162
|
put?: never;
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
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
|
-
};
|
|
1163
|
+
/**
|
|
1164
|
+
* OpenID Connect Dynamic Client Registration
|
|
1165
|
+
* @description Register a new OAuth/OIDC client dynamically (OIDC Dynamic Client Registration 1.0 / RFC 7591). The new client is bound to the Account resolved from the request context.
|
|
1166
|
+
*/
|
|
1167
|
+
post: operations["oauth/register"];
|
|
1728
1168
|
delete?: never;
|
|
1729
1169
|
options?: never;
|
|
1730
1170
|
head?: never;
|
|
1731
1171
|
patch?: never;
|
|
1732
1172
|
trace?: never;
|
|
1733
1173
|
};
|
|
1734
|
-
"/
|
|
1174
|
+
"/usernamepassword/login": {
|
|
1735
1175
|
parameters: {
|
|
1736
1176
|
query?: never;
|
|
1737
1177
|
header?: never;
|
|
@@ -1741,37 +1181,77 @@ export interface paths {
|
|
|
1741
1181
|
get?: never;
|
|
1742
1182
|
put?: never;
|
|
1743
1183
|
/**
|
|
1744
|
-
*
|
|
1745
|
-
* @description
|
|
1184
|
+
* Username + password login
|
|
1185
|
+
* @description Authenticates a user with username/password credentials against the database connection and renders an auto-submitting form that posts the resulting token to `/login/callback`.
|
|
1746
1186
|
*/
|
|
1747
|
-
post: operations["
|
|
1187
|
+
post: operations["usernamepassword/login"];
|
|
1748
1188
|
delete?: never;
|
|
1749
1189
|
options?: never;
|
|
1750
1190
|
head?: never;
|
|
1751
1191
|
patch?: never;
|
|
1752
1192
|
trace?: never;
|
|
1753
1193
|
};
|
|
1754
|
-
"/
|
|
1194
|
+
"/login/callback": {
|
|
1755
1195
|
parameters: {
|
|
1756
1196
|
query?: never;
|
|
1757
1197
|
header?: never;
|
|
1758
1198
|
path?: never;
|
|
1759
1199
|
cookie?: never;
|
|
1760
1200
|
};
|
|
1201
|
+
get?: never;
|
|
1202
|
+
put?: never;
|
|
1761
1203
|
/**
|
|
1762
|
-
*
|
|
1763
|
-
* @description
|
|
1204
|
+
* Username + password login callback
|
|
1205
|
+
* @description Completes the username/password login flow. The token issued by `/usernamepassword/login` is posted back here together with the serialized state (`wctx`) so the server can redirect the user agent to the original client `redirect_uri`.
|
|
1764
1206
|
*/
|
|
1765
|
-
|
|
1766
|
-
put?: never;
|
|
1767
|
-
post?: never;
|
|
1207
|
+
post: operations["usernamepassword/loginCallback"];
|
|
1768
1208
|
delete?: never;
|
|
1769
1209
|
options?: never;
|
|
1770
1210
|
head?: never;
|
|
1771
1211
|
patch?: never;
|
|
1772
1212
|
trace?: never;
|
|
1773
1213
|
};
|
|
1774
|
-
"/
|
|
1214
|
+
"/dbconnections/change_password": {
|
|
1215
|
+
parameters: {
|
|
1216
|
+
query?: never;
|
|
1217
|
+
header?: never;
|
|
1218
|
+
path?: never;
|
|
1219
|
+
cookie?: never;
|
|
1220
|
+
};
|
|
1221
|
+
get?: never;
|
|
1222
|
+
put?: never;
|
|
1223
|
+
/**
|
|
1224
|
+
* Change password
|
|
1225
|
+
* @description Change password
|
|
1226
|
+
*/
|
|
1227
|
+
post: operations["change_password"];
|
|
1228
|
+
delete?: never;
|
|
1229
|
+
options?: never;
|
|
1230
|
+
head?: never;
|
|
1231
|
+
patch?: never;
|
|
1232
|
+
trace?: never;
|
|
1233
|
+
};
|
|
1234
|
+
"/reset-verify": {
|
|
1235
|
+
parameters: {
|
|
1236
|
+
query?: never;
|
|
1237
|
+
header?: never;
|
|
1238
|
+
path?: never;
|
|
1239
|
+
cookie?: never;
|
|
1240
|
+
};
|
|
1241
|
+
/**
|
|
1242
|
+
* Change password verify
|
|
1243
|
+
* @description Change password verify
|
|
1244
|
+
*/
|
|
1245
|
+
get: operations["change_password_verify"];
|
|
1246
|
+
put?: never;
|
|
1247
|
+
post?: never;
|
|
1248
|
+
delete?: never;
|
|
1249
|
+
options?: never;
|
|
1250
|
+
head?: never;
|
|
1251
|
+
patch?: never;
|
|
1252
|
+
trace?: never;
|
|
1253
|
+
};
|
|
1254
|
+
"/reset-change": {
|
|
1775
1255
|
parameters: {
|
|
1776
1256
|
query?: never;
|
|
1777
1257
|
header?: never;
|
|
@@ -1809,17 +1289,32 @@ export interface components {
|
|
|
1809
1289
|
default_connection?: components["schemas"]["Connection"] | string | unknown;
|
|
1810
1290
|
enabled_locales: string[];
|
|
1811
1291
|
team?: string | null;
|
|
1292
|
+
notification_settings: {
|
|
1293
|
+
/**
|
|
1294
|
+
* @description Send the built-in welcome email on user.created
|
|
1295
|
+
* @default false
|
|
1296
|
+
*/
|
|
1297
|
+
welcome_email_enabled: boolean;
|
|
1298
|
+
};
|
|
1812
1299
|
/** @description AuthAccount creation date */
|
|
1813
1300
|
createdAt: string;
|
|
1814
1301
|
/** @description AuthAccount updated date */
|
|
1815
1302
|
updatedAt?: string;
|
|
1816
1303
|
};
|
|
1304
|
+
AccountNotificationSettings: {
|
|
1305
|
+
/**
|
|
1306
|
+
* @description Send the built-in welcome email on user.created
|
|
1307
|
+
* @default false
|
|
1308
|
+
*/
|
|
1309
|
+
welcome_email_enabled: boolean;
|
|
1310
|
+
};
|
|
1817
1311
|
/** @description Connection */
|
|
1818
1312
|
Connection: {
|
|
1819
1313
|
/** @description Connection ID */
|
|
1820
1314
|
id: string;
|
|
1821
1315
|
connection_name: string;
|
|
1822
|
-
|
|
1316
|
+
/** @enum {unknown} */
|
|
1317
|
+
connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "oidc";
|
|
1823
1318
|
/** @default null */
|
|
1824
1319
|
authorize_url: string;
|
|
1825
1320
|
/** @default null */
|
|
@@ -1872,6 +1367,7 @@ export interface components {
|
|
|
1872
1367
|
/** @description ConnectionCreate */
|
|
1873
1368
|
ConnectionCreate: {
|
|
1874
1369
|
connection_name: string;
|
|
1370
|
+
/** @enum {unknown} */
|
|
1875
1371
|
connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "oidc";
|
|
1876
1372
|
authorize_url?: string;
|
|
1877
1373
|
client_id?: string;
|
|
@@ -1910,10 +1406,24 @@ export interface components {
|
|
|
1910
1406
|
callbacks: string[];
|
|
1911
1407
|
logout_urls: string[];
|
|
1912
1408
|
refresh_token: {
|
|
1409
|
+
/** @enum {unknown} */
|
|
1913
1410
|
expiration_mode: "expire" | "not-expire";
|
|
1914
1411
|
infinite_token_lifetime: boolean;
|
|
1915
1412
|
token_lifetime: number;
|
|
1916
1413
|
};
|
|
1414
|
+
client_uri?: string | null;
|
|
1415
|
+
logo_uri?: string | null;
|
|
1416
|
+
tos_uri?: string | null;
|
|
1417
|
+
policy_uri?: string | null;
|
|
1418
|
+
contacts?: string[];
|
|
1419
|
+
grant_types?: string[];
|
|
1420
|
+
response_types?: string[];
|
|
1421
|
+
token_endpoint_auth_method?: string;
|
|
1422
|
+
application_type?: string;
|
|
1423
|
+
software_id?: string | null;
|
|
1424
|
+
software_version?: string | null;
|
|
1425
|
+
frontchannel_logout_uri?: string | null;
|
|
1426
|
+
frontchannel_logout_session_required?: boolean;
|
|
1917
1427
|
/** @description Object is related with this account */
|
|
1918
1428
|
account: string;
|
|
1919
1429
|
/**
|
|
@@ -1962,6 +1472,10 @@ export interface components {
|
|
|
1962
1472
|
given_name?: string | null;
|
|
1963
1473
|
/** @description Family name */
|
|
1964
1474
|
family_name?: string | null;
|
|
1475
|
+
/** @description Middle name (OIDC §5.1) */
|
|
1476
|
+
middle_name?: string | null;
|
|
1477
|
+
/** @description Casual name. Distinct from given_name (e.g. "Mike" vs "Michael"). OIDC §5.1 */
|
|
1478
|
+
nickname?: string | null;
|
|
1965
1479
|
/** @description User email */
|
|
1966
1480
|
email?: string | null;
|
|
1967
1481
|
/**
|
|
@@ -1977,10 +1491,28 @@ export interface components {
|
|
|
1977
1491
|
country_iso?: string | null;
|
|
1978
1492
|
/** @description user birth_date */
|
|
1979
1493
|
birth_date?: string | null;
|
|
1494
|
+
/** @description User gender (free-form, OIDC §5.1) */
|
|
1495
|
+
gender?: string | null;
|
|
1496
|
+
/** @description IANA time-zone name (e.g. "Europe/Madrid"). OIDC §5.1 — used for the `zoneinfo` claim. */
|
|
1497
|
+
zoneinfo?: string | null;
|
|
1980
1498
|
/** @description user main language */
|
|
1981
1499
|
locale?: string;
|
|
1982
1500
|
/** @description customer region */
|
|
1983
1501
|
region?: string | null;
|
|
1502
|
+
/** @description URL of the User's personal Web page or blog (OIDC §5.1) */
|
|
1503
|
+
website?: string | null;
|
|
1504
|
+
address?: {
|
|
1505
|
+
/** @description Full mailing address, formatted for display (may contain newlines) */
|
|
1506
|
+
formatted?: string | null;
|
|
1507
|
+
street_address?: string | null;
|
|
1508
|
+
/** @description City or locality */
|
|
1509
|
+
locality?: string | null;
|
|
1510
|
+
/** @description State, province, or region */
|
|
1511
|
+
region?: string | null;
|
|
1512
|
+
postal_code?: string | null;
|
|
1513
|
+
/** @description Country name */
|
|
1514
|
+
country?: string | null;
|
|
1515
|
+
} | null;
|
|
1984
1516
|
/** @description User picture url */
|
|
1985
1517
|
picture?: string | null;
|
|
1986
1518
|
/** @description Total number of logins this user has performed. */
|
|
@@ -2017,6 +1549,18 @@ export interface components {
|
|
|
2017
1549
|
/** @description User updated date */
|
|
2018
1550
|
updatedAt?: string;
|
|
2019
1551
|
};
|
|
1552
|
+
UserAddress: {
|
|
1553
|
+
/** @description Full mailing address, formatted for display (may contain newlines) */
|
|
1554
|
+
formatted?: string | null;
|
|
1555
|
+
street_address?: string | null;
|
|
1556
|
+
/** @description City or locality */
|
|
1557
|
+
locality?: string | null;
|
|
1558
|
+
/** @description State, province, or region */
|
|
1559
|
+
region?: string | null;
|
|
1560
|
+
postal_code?: string | null;
|
|
1561
|
+
/** @description Country name */
|
|
1562
|
+
country?: string | null;
|
|
1563
|
+
} | null;
|
|
2020
1564
|
/**
|
|
2021
1565
|
* @description User Metadata
|
|
2022
1566
|
* @default {}
|
|
@@ -2348,8 +1892,12 @@ export interface components {
|
|
|
2348
1892
|
id: string;
|
|
2349
1893
|
/** @description Action Name */
|
|
2350
1894
|
name: string;
|
|
2351
|
-
/**
|
|
2352
|
-
|
|
1895
|
+
/**
|
|
1896
|
+
* @description Trigger event name
|
|
1897
|
+
* @default post-login
|
|
1898
|
+
* @enum {unknown}
|
|
1899
|
+
*/
|
|
1900
|
+
trigger: "continue" | "post-login";
|
|
2353
1901
|
/** @description JavaScript Code to execute */
|
|
2354
1902
|
code: string;
|
|
2355
1903
|
/**
|
|
@@ -2673,18 +2221,53 @@ export interface components {
|
|
|
2673
2221
|
NotificationSubscriptionWebhookMetadataUpdate: {
|
|
2674
2222
|
[key: string]: unknown;
|
|
2675
2223
|
};
|
|
2224
|
+
/** @description Log */
|
|
2225
|
+
Log: {
|
|
2226
|
+
/** @description Log ID */
|
|
2227
|
+
id: string;
|
|
2228
|
+
/** @description Log type, e.g. email.user.created */
|
|
2229
|
+
type: string;
|
|
2230
|
+
/** @description Log status */
|
|
2231
|
+
status: "success" | "failed" | "skipped" | "info";
|
|
2232
|
+
/** @description Optional log message */
|
|
2233
|
+
message?: string;
|
|
2234
|
+
/** @description Type-specific structured payload */
|
|
2235
|
+
data?: unknown;
|
|
2236
|
+
/** @description Object is related with this account */
|
|
2237
|
+
account: string;
|
|
2238
|
+
/**
|
|
2239
|
+
* @description LogMetadata
|
|
2240
|
+
* @default {}
|
|
2241
|
+
*/
|
|
2242
|
+
metadata: {
|
|
2243
|
+
[key: string]: unknown;
|
|
2244
|
+
};
|
|
2245
|
+
/** @description Log creation date */
|
|
2246
|
+
createdAt: string;
|
|
2247
|
+
/** @description Log updated date */
|
|
2248
|
+
updatedAt?: string;
|
|
2249
|
+
};
|
|
2250
|
+
/**
|
|
2251
|
+
* @description LogMetadata
|
|
2252
|
+
* @default {}
|
|
2253
|
+
*/
|
|
2254
|
+
LogMetadata: {
|
|
2255
|
+
[key: string]: unknown;
|
|
2256
|
+
};
|
|
2676
2257
|
/** @description Customdomain */
|
|
2677
2258
|
Customdomain: {
|
|
2678
2259
|
/** @description Customdomain ID */
|
|
2679
2260
|
id: string;
|
|
2680
2261
|
domain: string;
|
|
2681
2262
|
token: string;
|
|
2682
|
-
|
|
2263
|
+
/** @enum {unknown} */
|
|
2264
|
+
status: "PENDING" | "VERIFYING" | "ACTIVE" | "FAILED" | "DEGRADED";
|
|
2683
2265
|
attempts: number;
|
|
2684
2266
|
/** Format: date-time */
|
|
2685
2267
|
nextCheck?: string;
|
|
2686
2268
|
/** Format: date-time */
|
|
2687
2269
|
lastCheck?: string;
|
|
2270
|
+
/** @description User feedback error from last check */
|
|
2688
2271
|
errorLog?: string;
|
|
2689
2272
|
/** Format: date-time */
|
|
2690
2273
|
verifiedAt?: string;
|
|
@@ -2721,6 +2304,66 @@ export interface components {
|
|
|
2721
2304
|
CustomdomainMetadataCreate: {
|
|
2722
2305
|
[key: string]: unknown;
|
|
2723
2306
|
};
|
|
2307
|
+
ClientRegistrationRequest: {
|
|
2308
|
+
/** @description Array of redirection URI values used by the client (RFC 7591 §2). REQUIRED for any client that uses an authorization grant. */
|
|
2309
|
+
redirect_uris: string[];
|
|
2310
|
+
/** @description Human-readable name of the client (RFC 7591 §2) */
|
|
2311
|
+
client_name?: string;
|
|
2312
|
+
/** @description URL of the home page of the client */
|
|
2313
|
+
client_uri?: string;
|
|
2314
|
+
logo_uri?: string;
|
|
2315
|
+
tos_uri?: string;
|
|
2316
|
+
policy_uri?: string;
|
|
2317
|
+
/** @description Array of email addresses responsible for the client */
|
|
2318
|
+
contacts?: string[];
|
|
2319
|
+
/** @description Grant types the client will use. Defaults to ["authorization_code"]. Must be a subset of what the server supports. */
|
|
2320
|
+
grant_types?: string[];
|
|
2321
|
+
/** @description Response types the client will use. Defaults to ["code"]. */
|
|
2322
|
+
response_types?: string[];
|
|
2323
|
+
/** @description How the client authenticates at the token endpoint. Defaults to "client_secret_basic". */
|
|
2324
|
+
token_endpoint_auth_method?: string;
|
|
2325
|
+
/** @description OIDC §2 — application type. Defaults to "web". */
|
|
2326
|
+
application_type?: "web" | "native";
|
|
2327
|
+
/** @description OIDC RP-Initiated Logout — URIs the OP MAY redirect to after end-session. */
|
|
2328
|
+
post_logout_redirect_uris?: string[];
|
|
2329
|
+
/** @description Space-separated list of scope values the client may use. */
|
|
2330
|
+
scope?: string;
|
|
2331
|
+
software_id?: string;
|
|
2332
|
+
software_version?: string;
|
|
2333
|
+
/** @description OIDC Front-Channel Logout 1.0 — URL the OP loads inside an iframe at end-session to let the RP clear its session. */
|
|
2334
|
+
frontchannel_logout_uri?: string;
|
|
2335
|
+
/** @description OIDC Front-Channel Logout 1.0 — when true, the OP MUST include `iss` and `sid` parameters when calling the frontchannel_logout_uri. */
|
|
2336
|
+
frontchannel_logout_session_required?: boolean;
|
|
2337
|
+
} & {
|
|
2338
|
+
[key: string]: unknown;
|
|
2339
|
+
};
|
|
2340
|
+
ClientRegistrationResponse: {
|
|
2341
|
+
client_id: string;
|
|
2342
|
+
client_secret: string;
|
|
2343
|
+
/** @description Unix timestamp (seconds) at which the client_id was issued */
|
|
2344
|
+
client_id_issued_at: number;
|
|
2345
|
+
/** @description 0 if the client_secret does not expire */
|
|
2346
|
+
client_secret_expires_at: number;
|
|
2347
|
+
redirect_uris: string[];
|
|
2348
|
+
client_name?: string;
|
|
2349
|
+
client_uri?: string;
|
|
2350
|
+
logo_uri?: string;
|
|
2351
|
+
tos_uri?: string;
|
|
2352
|
+
policy_uri?: string;
|
|
2353
|
+
contacts?: string[];
|
|
2354
|
+
grant_types: string[];
|
|
2355
|
+
response_types: string[];
|
|
2356
|
+
token_endpoint_auth_method: string;
|
|
2357
|
+
application_type: string;
|
|
2358
|
+
post_logout_redirect_uris?: string[];
|
|
2359
|
+
scope?: string;
|
|
2360
|
+
software_id?: string;
|
|
2361
|
+
software_version?: string;
|
|
2362
|
+
frontchannel_logout_uri?: string;
|
|
2363
|
+
frontchannel_logout_session_required?: boolean;
|
|
2364
|
+
} & {
|
|
2365
|
+
[key: string]: unknown;
|
|
2366
|
+
};
|
|
2724
2367
|
/** @description AuthAccountCreate */
|
|
2725
2368
|
AuthAccountCreate: {
|
|
2726
2369
|
name: string;
|
|
@@ -2773,6 +2416,10 @@ export interface components {
|
|
|
2773
2416
|
scope?: string;
|
|
2774
2417
|
/** @description The URL to which Faable will redirect the browser after authorization has been granted by the user. */
|
|
2775
2418
|
redirect_uri?: string;
|
|
2419
|
+
/** @description OIDC §3.1.2.1 — string value used to associate a Client session with an ID Token, to mitigate replay attacks. If passed at /authorize, the same value MUST appear in the issued id_token. */
|
|
2420
|
+
nonce?: string;
|
|
2421
|
+
/** @description OIDC §3.1.2.1 — maximum allowable elapsed time in seconds since the last End-User authentication. If exceeded, the OP re-authenticates and `auth_time` is REQUIRED in the resulting id_token. */
|
|
2422
|
+
max_age?: number;
|
|
2776
2423
|
prompt?: string;
|
|
2777
2424
|
};
|
|
2778
2425
|
LoginCallbackBody: {
|
|
@@ -2792,7 +2439,54 @@ export interface components {
|
|
|
2792
2439
|
}
|
|
2793
2440
|
export type $defs = Record<string, never>;
|
|
2794
2441
|
export interface operations {
|
|
2795
|
-
"
|
|
2442
|
+
"account/current": {
|
|
2443
|
+
parameters: {
|
|
2444
|
+
query?: {
|
|
2445
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
2446
|
+
expand?: string[];
|
|
2447
|
+
};
|
|
2448
|
+
header?: never;
|
|
2449
|
+
path?: never;
|
|
2450
|
+
cookie?: never;
|
|
2451
|
+
};
|
|
2452
|
+
requestBody?: never;
|
|
2453
|
+
responses: {
|
|
2454
|
+
/** @description AuthAccount */
|
|
2455
|
+
200: {
|
|
2456
|
+
headers: {
|
|
2457
|
+
[name: string]: unknown;
|
|
2458
|
+
};
|
|
2459
|
+
content: {
|
|
2460
|
+
"application/json": {
|
|
2461
|
+
/** @description AuthAccount ID */
|
|
2462
|
+
id: string;
|
|
2463
|
+
name: string;
|
|
2464
|
+
domain: string;
|
|
2465
|
+
slug: string;
|
|
2466
|
+
logo_src?: string | null;
|
|
2467
|
+
icon_src?: string | null;
|
|
2468
|
+
callback_hostnames: string[];
|
|
2469
|
+
token_signature: string;
|
|
2470
|
+
default_connection?: components["schemas"]["Connection"] | string | unknown;
|
|
2471
|
+
enabled_locales: string[];
|
|
2472
|
+
team?: string | null;
|
|
2473
|
+
notification_settings: {
|
|
2474
|
+
/**
|
|
2475
|
+
* @description Send the built-in welcome email on user.created
|
|
2476
|
+
* @default false
|
|
2477
|
+
*/
|
|
2478
|
+
welcome_email_enabled: boolean;
|
|
2479
|
+
};
|
|
2480
|
+
/** @description AuthAccount creation date */
|
|
2481
|
+
createdAt: string;
|
|
2482
|
+
/** @description AuthAccount updated date */
|
|
2483
|
+
updatedAt?: string;
|
|
2484
|
+
};
|
|
2485
|
+
};
|
|
2486
|
+
};
|
|
2487
|
+
};
|
|
2488
|
+
};
|
|
2489
|
+
"account/list": {
|
|
2796
2490
|
parameters: {
|
|
2797
2491
|
query?: {
|
|
2798
2492
|
/** @description Start from this cursor */
|
|
@@ -2801,8 +2495,7 @@ export interface operations {
|
|
|
2801
2495
|
next?: string;
|
|
2802
2496
|
/** @description Size of the results array */
|
|
2803
2497
|
pageSize?: number;
|
|
2804
|
-
/** @description
|
|
2805
|
-
query?: string;
|
|
2498
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
2806
2499
|
expand?: string[];
|
|
2807
2500
|
};
|
|
2808
2501
|
header?: never;
|
|
@@ -2821,79 +2514,180 @@ export interface operations {
|
|
|
2821
2514
|
/** @description next cursor */
|
|
2822
2515
|
next: string | null;
|
|
2823
2516
|
/** @description List of results */
|
|
2824
|
-
results: components["schemas"]["
|
|
2517
|
+
results: components["schemas"]["AuthAccount"][];
|
|
2825
2518
|
};
|
|
2826
2519
|
};
|
|
2827
2520
|
};
|
|
2828
2521
|
};
|
|
2829
2522
|
};
|
|
2830
|
-
"
|
|
2523
|
+
"account/create": {
|
|
2831
2524
|
parameters: {
|
|
2832
2525
|
query?: never;
|
|
2833
2526
|
header?: never;
|
|
2834
2527
|
path?: never;
|
|
2835
2528
|
cookie?: never;
|
|
2836
2529
|
};
|
|
2837
|
-
|
|
2530
|
+
/** @description AuthAccountCreate */
|
|
2531
|
+
requestBody: {
|
|
2838
2532
|
content: {
|
|
2839
|
-
"application/json":
|
|
2533
|
+
"application/json": {
|
|
2534
|
+
name: string;
|
|
2535
|
+
team: string;
|
|
2536
|
+
logo_src?: string;
|
|
2537
|
+
icon_src?: string;
|
|
2538
|
+
callback_hostnames?: string[];
|
|
2539
|
+
default_connection?: string;
|
|
2540
|
+
/** @description Add Metadata */
|
|
2541
|
+
metadata?: {
|
|
2542
|
+
[key: string]: unknown;
|
|
2543
|
+
};
|
|
2544
|
+
};
|
|
2840
2545
|
};
|
|
2841
2546
|
};
|
|
2842
2547
|
responses: {
|
|
2843
|
-
/** @description
|
|
2844
|
-
|
|
2548
|
+
/** @description AuthAccount */
|
|
2549
|
+
201: {
|
|
2845
2550
|
headers: {
|
|
2846
2551
|
[name: string]: unknown;
|
|
2847
2552
|
};
|
|
2848
2553
|
content: {
|
|
2849
|
-
"application/json":
|
|
2554
|
+
"application/json": {
|
|
2555
|
+
/** @description AuthAccount ID */
|
|
2556
|
+
id: string;
|
|
2557
|
+
name: string;
|
|
2558
|
+
domain: string;
|
|
2559
|
+
slug: string;
|
|
2560
|
+
logo_src?: string | null;
|
|
2561
|
+
icon_src?: string | null;
|
|
2562
|
+
callback_hostnames: string[];
|
|
2563
|
+
token_signature: string;
|
|
2564
|
+
default_connection?: components["schemas"]["Connection"] | string | unknown;
|
|
2565
|
+
enabled_locales: string[];
|
|
2566
|
+
team?: string | null;
|
|
2567
|
+
notification_settings: {
|
|
2568
|
+
/**
|
|
2569
|
+
* @description Send the built-in welcome email on user.created
|
|
2570
|
+
* @default false
|
|
2571
|
+
*/
|
|
2572
|
+
welcome_email_enabled: boolean;
|
|
2573
|
+
};
|
|
2574
|
+
/** @description AuthAccount creation date */
|
|
2575
|
+
createdAt: string;
|
|
2576
|
+
/** @description AuthAccount updated date */
|
|
2577
|
+
updatedAt?: string;
|
|
2578
|
+
};
|
|
2850
2579
|
};
|
|
2851
2580
|
};
|
|
2852
2581
|
};
|
|
2853
2582
|
};
|
|
2854
|
-
"
|
|
2583
|
+
"account/get": {
|
|
2855
2584
|
parameters: {
|
|
2856
|
-
query?:
|
|
2585
|
+
query?: {
|
|
2586
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
2587
|
+
expand?: string[];
|
|
2588
|
+
};
|
|
2857
2589
|
header?: never;
|
|
2858
2590
|
path: {
|
|
2859
|
-
|
|
2591
|
+
account_id: string;
|
|
2860
2592
|
};
|
|
2861
2593
|
cookie?: never;
|
|
2862
2594
|
};
|
|
2863
2595
|
requestBody?: never;
|
|
2864
2596
|
responses: {
|
|
2865
|
-
/** @description
|
|
2597
|
+
/** @description AuthAccount */
|
|
2866
2598
|
200: {
|
|
2867
2599
|
headers: {
|
|
2868
2600
|
[name: string]: unknown;
|
|
2869
2601
|
};
|
|
2870
2602
|
content: {
|
|
2871
|
-
"application/json":
|
|
2603
|
+
"application/json": {
|
|
2604
|
+
/** @description AuthAccount ID */
|
|
2605
|
+
id: string;
|
|
2606
|
+
name: string;
|
|
2607
|
+
domain: string;
|
|
2608
|
+
slug: string;
|
|
2609
|
+
logo_src?: string | null;
|
|
2610
|
+
icon_src?: string | null;
|
|
2611
|
+
callback_hostnames: string[];
|
|
2612
|
+
token_signature: string;
|
|
2613
|
+
default_connection?: components["schemas"]["Connection"] | string | unknown;
|
|
2614
|
+
enabled_locales: string[];
|
|
2615
|
+
team?: string | null;
|
|
2616
|
+
notification_settings: {
|
|
2617
|
+
/**
|
|
2618
|
+
* @description Send the built-in welcome email on user.created
|
|
2619
|
+
* @default false
|
|
2620
|
+
*/
|
|
2621
|
+
welcome_email_enabled: boolean;
|
|
2622
|
+
};
|
|
2623
|
+
/** @description AuthAccount creation date */
|
|
2624
|
+
createdAt: string;
|
|
2625
|
+
/** @description AuthAccount updated date */
|
|
2626
|
+
updatedAt?: string;
|
|
2627
|
+
};
|
|
2872
2628
|
};
|
|
2873
2629
|
};
|
|
2874
2630
|
};
|
|
2875
2631
|
};
|
|
2876
|
-
"
|
|
2632
|
+
"account/delete": {
|
|
2877
2633
|
parameters: {
|
|
2878
2634
|
query?: never;
|
|
2879
2635
|
header?: never;
|
|
2880
2636
|
path: {
|
|
2881
|
-
|
|
2637
|
+
account_id: string;
|
|
2638
|
+
};
|
|
2639
|
+
cookie?: never;
|
|
2640
|
+
};
|
|
2641
|
+
requestBody?: never;
|
|
2642
|
+
responses: never;
|
|
2643
|
+
};
|
|
2644
|
+
"account/getByHost": {
|
|
2645
|
+
parameters: {
|
|
2646
|
+
query?: never;
|
|
2647
|
+
header?: never;
|
|
2648
|
+
path: {
|
|
2649
|
+
host: string;
|
|
2882
2650
|
};
|
|
2883
2651
|
cookie?: never;
|
|
2884
2652
|
};
|
|
2885
2653
|
requestBody?: never;
|
|
2886
2654
|
responses: {
|
|
2887
|
-
/** @description
|
|
2655
|
+
/** @description AuthAccount */
|
|
2888
2656
|
200: {
|
|
2889
2657
|
headers: {
|
|
2890
2658
|
[name: string]: unknown;
|
|
2891
2659
|
};
|
|
2892
|
-
content
|
|
2660
|
+
content: {
|
|
2661
|
+
"application/json": {
|
|
2662
|
+
/** @description AuthAccount ID */
|
|
2663
|
+
id: string;
|
|
2664
|
+
name: string;
|
|
2665
|
+
domain: string;
|
|
2666
|
+
slug: string;
|
|
2667
|
+
logo_src?: string | null;
|
|
2668
|
+
icon_src?: string | null;
|
|
2669
|
+
callback_hostnames: string[];
|
|
2670
|
+
token_signature: string;
|
|
2671
|
+
default_connection?: components["schemas"]["Connection"] | string | unknown;
|
|
2672
|
+
enabled_locales: string[];
|
|
2673
|
+
team?: string | null;
|
|
2674
|
+
notification_settings: {
|
|
2675
|
+
/**
|
|
2676
|
+
* @description Send the built-in welcome email on user.created
|
|
2677
|
+
* @default false
|
|
2678
|
+
*/
|
|
2679
|
+
welcome_email_enabled: boolean;
|
|
2680
|
+
};
|
|
2681
|
+
/** @description AuthAccount creation date */
|
|
2682
|
+
createdAt: string;
|
|
2683
|
+
/** @description AuthAccount updated date */
|
|
2684
|
+
updatedAt?: string;
|
|
2685
|
+
};
|
|
2686
|
+
};
|
|
2893
2687
|
};
|
|
2894
2688
|
};
|
|
2895
2689
|
};
|
|
2896
|
-
"
|
|
2690
|
+
"connection/list": {
|
|
2897
2691
|
parameters: {
|
|
2898
2692
|
query?: {
|
|
2899
2693
|
/** @description Start from this cursor */
|
|
@@ -2904,6 +2698,7 @@ export interface operations {
|
|
|
2904
2698
|
pageSize?: number;
|
|
2905
2699
|
/** @description Filter using a FaableQL query */
|
|
2906
2700
|
query?: string;
|
|
2701
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
2907
2702
|
expand?: string[];
|
|
2908
2703
|
};
|
|
2909
2704
|
header?: never;
|
|
@@ -2922,64 +2717,187 @@ export interface operations {
|
|
|
2922
2717
|
/** @description next cursor */
|
|
2923
2718
|
next: string | null;
|
|
2924
2719
|
/** @description List of results */
|
|
2925
|
-
results: components["schemas"]["
|
|
2720
|
+
results: components["schemas"]["Connection"][];
|
|
2926
2721
|
};
|
|
2927
2722
|
};
|
|
2928
2723
|
};
|
|
2929
2724
|
};
|
|
2930
2725
|
};
|
|
2931
|
-
"
|
|
2726
|
+
"connection/create": {
|
|
2932
2727
|
parameters: {
|
|
2933
2728
|
query?: never;
|
|
2934
2729
|
header?: never;
|
|
2935
2730
|
path?: never;
|
|
2936
2731
|
cookie?: never;
|
|
2937
2732
|
};
|
|
2938
|
-
|
|
2733
|
+
/** @description ConnectionCreate */
|
|
2734
|
+
requestBody: {
|
|
2939
2735
|
content: {
|
|
2940
|
-
"application/json":
|
|
2736
|
+
"application/json": {
|
|
2737
|
+
connection_name: string;
|
|
2738
|
+
/** @enum {unknown} */
|
|
2739
|
+
connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "oidc";
|
|
2740
|
+
authorize_url?: string;
|
|
2741
|
+
client_id?: string;
|
|
2742
|
+
client_secret?: string;
|
|
2743
|
+
issuer?: string;
|
|
2744
|
+
jwks_url?: string;
|
|
2745
|
+
scope?: string[];
|
|
2746
|
+
enabled?: boolean;
|
|
2747
|
+
claims_mapping?: {
|
|
2748
|
+
[key: string]: string;
|
|
2749
|
+
};
|
|
2750
|
+
/**
|
|
2751
|
+
* @description Authorize params
|
|
2752
|
+
* @default {}
|
|
2753
|
+
*/
|
|
2754
|
+
authorize_params?: {
|
|
2755
|
+
[key: string]: string;
|
|
2756
|
+
};
|
|
2757
|
+
/** @description Add Metadata */
|
|
2758
|
+
metadata?: {
|
|
2759
|
+
[key: string]: unknown;
|
|
2760
|
+
};
|
|
2761
|
+
};
|
|
2941
2762
|
};
|
|
2942
2763
|
};
|
|
2943
2764
|
responses: {
|
|
2944
|
-
/** @description
|
|
2765
|
+
/** @description Connection */
|
|
2945
2766
|
200: {
|
|
2946
2767
|
headers: {
|
|
2947
2768
|
[name: string]: unknown;
|
|
2948
2769
|
};
|
|
2949
2770
|
content: {
|
|
2950
|
-
"application/json":
|
|
2771
|
+
"application/json": {
|
|
2772
|
+
/** @description Connection ID */
|
|
2773
|
+
id: string;
|
|
2774
|
+
connection_name: string;
|
|
2775
|
+
/** @enum {unknown} */
|
|
2776
|
+
connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "oidc";
|
|
2777
|
+
/** @default null */
|
|
2778
|
+
authorize_url: string;
|
|
2779
|
+
/** @default null */
|
|
2780
|
+
token_url: string;
|
|
2781
|
+
/** @default null */
|
|
2782
|
+
userinfo_url: string;
|
|
2783
|
+
/** @default null */
|
|
2784
|
+
client_id: string;
|
|
2785
|
+
/** @default null */
|
|
2786
|
+
client_secret: string;
|
|
2787
|
+
/** @default null */
|
|
2788
|
+
issuer: string;
|
|
2789
|
+
/** @default null */
|
|
2790
|
+
jwks_url: string;
|
|
2791
|
+
/** @default null */
|
|
2792
|
+
response_type: string;
|
|
2793
|
+
enabled: boolean;
|
|
2794
|
+
/** @default null */
|
|
2795
|
+
enabled_clients: string[] | null;
|
|
2796
|
+
/** @default [] */
|
|
2797
|
+
scope: string[];
|
|
2798
|
+
/**
|
|
2799
|
+
* @description Authorize params
|
|
2800
|
+
* @default {}
|
|
2801
|
+
*/
|
|
2802
|
+
authorize_params: {
|
|
2803
|
+
[key: string]: string;
|
|
2804
|
+
};
|
|
2805
|
+
/** @description Object is related with this account */
|
|
2806
|
+
account: string;
|
|
2807
|
+
/**
|
|
2808
|
+
* @description ConnectionMetadata
|
|
2809
|
+
* @default {}
|
|
2810
|
+
*/
|
|
2811
|
+
metadata: {
|
|
2812
|
+
[key: string]: unknown;
|
|
2813
|
+
};
|
|
2814
|
+
/** @description Connection creation date */
|
|
2815
|
+
createdAt: string;
|
|
2816
|
+
/** @description Connection updated date */
|
|
2817
|
+
updatedAt?: string;
|
|
2818
|
+
};
|
|
2951
2819
|
};
|
|
2952
2820
|
};
|
|
2953
2821
|
};
|
|
2954
2822
|
};
|
|
2955
|
-
"
|
|
2823
|
+
"connection/get": {
|
|
2956
2824
|
parameters: {
|
|
2957
|
-
query?:
|
|
2825
|
+
query?: {
|
|
2826
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
2827
|
+
expand?: string[];
|
|
2828
|
+
};
|
|
2958
2829
|
header?: never;
|
|
2959
2830
|
path: {
|
|
2960
|
-
|
|
2831
|
+
connection_id: string;
|
|
2961
2832
|
};
|
|
2962
2833
|
cookie?: never;
|
|
2963
2834
|
};
|
|
2964
2835
|
requestBody?: never;
|
|
2965
2836
|
responses: {
|
|
2966
|
-
/** @description
|
|
2837
|
+
/** @description Connection */
|
|
2967
2838
|
200: {
|
|
2968
2839
|
headers: {
|
|
2969
2840
|
[name: string]: unknown;
|
|
2970
2841
|
};
|
|
2971
2842
|
content: {
|
|
2972
|
-
"application/json":
|
|
2843
|
+
"application/json": {
|
|
2844
|
+
/** @description Connection ID */
|
|
2845
|
+
id: string;
|
|
2846
|
+
connection_name: string;
|
|
2847
|
+
/** @enum {unknown} */
|
|
2848
|
+
connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "oidc";
|
|
2849
|
+
/** @default null */
|
|
2850
|
+
authorize_url: string;
|
|
2851
|
+
/** @default null */
|
|
2852
|
+
token_url: string;
|
|
2853
|
+
/** @default null */
|
|
2854
|
+
userinfo_url: string;
|
|
2855
|
+
/** @default null */
|
|
2856
|
+
client_id: string;
|
|
2857
|
+
/** @default null */
|
|
2858
|
+
client_secret: string;
|
|
2859
|
+
/** @default null */
|
|
2860
|
+
issuer: string;
|
|
2861
|
+
/** @default null */
|
|
2862
|
+
jwks_url: string;
|
|
2863
|
+
/** @default null */
|
|
2864
|
+
response_type: string;
|
|
2865
|
+
enabled: boolean;
|
|
2866
|
+
/** @default null */
|
|
2867
|
+
enabled_clients: string[] | null;
|
|
2868
|
+
/** @default [] */
|
|
2869
|
+
scope: string[];
|
|
2870
|
+
/**
|
|
2871
|
+
* @description Authorize params
|
|
2872
|
+
* @default {}
|
|
2873
|
+
*/
|
|
2874
|
+
authorize_params: {
|
|
2875
|
+
[key: string]: string;
|
|
2876
|
+
};
|
|
2877
|
+
/** @description Object is related with this account */
|
|
2878
|
+
account: string;
|
|
2879
|
+
/**
|
|
2880
|
+
* @description ConnectionMetadata
|
|
2881
|
+
* @default {}
|
|
2882
|
+
*/
|
|
2883
|
+
metadata: {
|
|
2884
|
+
[key: string]: unknown;
|
|
2885
|
+
};
|
|
2886
|
+
/** @description Connection creation date */
|
|
2887
|
+
createdAt: string;
|
|
2888
|
+
/** @description Connection updated date */
|
|
2889
|
+
updatedAt?: string;
|
|
2890
|
+
};
|
|
2973
2891
|
};
|
|
2974
2892
|
};
|
|
2975
2893
|
};
|
|
2976
2894
|
};
|
|
2977
|
-
"
|
|
2895
|
+
"connection/remove": {
|
|
2978
2896
|
parameters: {
|
|
2979
2897
|
query?: never;
|
|
2980
2898
|
header?: never;
|
|
2981
2899
|
path: {
|
|
2982
|
-
|
|
2900
|
+
connection_id: string;
|
|
2983
2901
|
};
|
|
2984
2902
|
cookie?: never;
|
|
2985
2903
|
};
|
|
@@ -2994,7 +2912,7 @@ export interface operations {
|
|
|
2994
2912
|
};
|
|
2995
2913
|
};
|
|
2996
2914
|
};
|
|
2997
|
-
"
|
|
2915
|
+
"client/list": {
|
|
2998
2916
|
parameters: {
|
|
2999
2917
|
query?: {
|
|
3000
2918
|
/** @description Start from this cursor */
|
|
@@ -3005,6 +2923,7 @@ export interface operations {
|
|
|
3005
2923
|
pageSize?: number;
|
|
3006
2924
|
/** @description Filter using a FaableQL query */
|
|
3007
2925
|
query?: string;
|
|
2926
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
3008
2927
|
expand?: string[];
|
|
3009
2928
|
};
|
|
3010
2929
|
header?: never;
|
|
@@ -3023,90 +2942,159 @@ export interface operations {
|
|
|
3023
2942
|
/** @description next cursor */
|
|
3024
2943
|
next: string | null;
|
|
3025
2944
|
/** @description List of results */
|
|
3026
|
-
results: components["schemas"]["
|
|
2945
|
+
results: components["schemas"]["Client"][];
|
|
3027
2946
|
};
|
|
3028
2947
|
};
|
|
3029
2948
|
};
|
|
3030
2949
|
};
|
|
3031
2950
|
};
|
|
3032
|
-
"
|
|
2951
|
+
"client/create": {
|
|
3033
2952
|
parameters: {
|
|
3034
2953
|
query?: never;
|
|
3035
2954
|
header?: never;
|
|
3036
2955
|
path?: never;
|
|
3037
2956
|
cookie?: never;
|
|
3038
2957
|
};
|
|
3039
|
-
|
|
2958
|
+
/** @description ClientCreate */
|
|
2959
|
+
requestBody: {
|
|
3040
2960
|
content: {
|
|
3041
|
-
"application/json":
|
|
3042
|
-
|
|
3043
|
-
|
|
3044
|
-
|
|
3045
|
-
|
|
3046
|
-
|
|
3047
|
-
|
|
3048
|
-
|
|
3049
|
-
|
|
3050
|
-
content: {
|
|
3051
|
-
"application/json": components["schemas"]["User"];
|
|
2961
|
+
"application/json": {
|
|
2962
|
+
name: string;
|
|
2963
|
+
description?: string;
|
|
2964
|
+
callbacks?: string[];
|
|
2965
|
+
logout_urls?: string[];
|
|
2966
|
+
/** @description Add Metadata */
|
|
2967
|
+
metadata?: {
|
|
2968
|
+
[key: string]: unknown;
|
|
2969
|
+
};
|
|
3052
2970
|
};
|
|
3053
2971
|
};
|
|
3054
2972
|
};
|
|
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
2973
|
responses: {
|
|
3067
|
-
/** @description
|
|
2974
|
+
/** @description Client */
|
|
3068
2975
|
200: {
|
|
3069
2976
|
headers: {
|
|
3070
2977
|
[name: string]: unknown;
|
|
3071
2978
|
};
|
|
3072
2979
|
content: {
|
|
3073
|
-
"application/json":
|
|
2980
|
+
"application/json": {
|
|
2981
|
+
/** @description Client ID */
|
|
2982
|
+
id: string;
|
|
2983
|
+
name: string;
|
|
2984
|
+
description: string;
|
|
2985
|
+
client_id: string;
|
|
2986
|
+
client_secret: string;
|
|
2987
|
+
callbacks: string[];
|
|
2988
|
+
logout_urls: string[];
|
|
2989
|
+
refresh_token: {
|
|
2990
|
+
/** @enum {unknown} */
|
|
2991
|
+
expiration_mode: "expire" | "not-expire";
|
|
2992
|
+
infinite_token_lifetime: boolean;
|
|
2993
|
+
token_lifetime: number;
|
|
2994
|
+
};
|
|
2995
|
+
client_uri?: string | null;
|
|
2996
|
+
logo_uri?: string | null;
|
|
2997
|
+
tos_uri?: string | null;
|
|
2998
|
+
policy_uri?: string | null;
|
|
2999
|
+
contacts?: string[];
|
|
3000
|
+
grant_types?: string[];
|
|
3001
|
+
response_types?: string[];
|
|
3002
|
+
token_endpoint_auth_method?: string;
|
|
3003
|
+
application_type?: string;
|
|
3004
|
+
software_id?: string | null;
|
|
3005
|
+
software_version?: string | null;
|
|
3006
|
+
frontchannel_logout_uri?: string | null;
|
|
3007
|
+
frontchannel_logout_session_required?: boolean;
|
|
3008
|
+
/** @description Object is related with this account */
|
|
3009
|
+
account: string;
|
|
3010
|
+
/**
|
|
3011
|
+
* @description ClientMetadata
|
|
3012
|
+
* @default {}
|
|
3013
|
+
*/
|
|
3014
|
+
metadata: {
|
|
3015
|
+
[key: string]: unknown;
|
|
3016
|
+
};
|
|
3017
|
+
/** @description Client creation date */
|
|
3018
|
+
createdAt: string;
|
|
3019
|
+
/** @description Client updated date */
|
|
3020
|
+
updatedAt?: string;
|
|
3021
|
+
};
|
|
3074
3022
|
};
|
|
3075
3023
|
};
|
|
3076
3024
|
};
|
|
3077
3025
|
};
|
|
3078
|
-
"
|
|
3026
|
+
"client/get": {
|
|
3079
3027
|
parameters: {
|
|
3080
|
-
query?:
|
|
3028
|
+
query?: {
|
|
3029
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
3030
|
+
expand?: string[];
|
|
3031
|
+
};
|
|
3081
3032
|
header?: never;
|
|
3082
3033
|
path: {
|
|
3083
|
-
|
|
3034
|
+
client_id: string;
|
|
3084
3035
|
};
|
|
3085
3036
|
cookie?: never;
|
|
3086
3037
|
};
|
|
3087
|
-
requestBody?:
|
|
3088
|
-
content: {
|
|
3089
|
-
"application/json": components["schemas"]["UserUpdate"];
|
|
3090
|
-
};
|
|
3091
|
-
};
|
|
3038
|
+
requestBody?: never;
|
|
3092
3039
|
responses: {
|
|
3093
|
-
/** @description
|
|
3040
|
+
/** @description Client */
|
|
3094
3041
|
200: {
|
|
3095
3042
|
headers: {
|
|
3096
3043
|
[name: string]: unknown;
|
|
3097
3044
|
};
|
|
3098
3045
|
content: {
|
|
3099
|
-
"application/json":
|
|
3046
|
+
"application/json": {
|
|
3047
|
+
/** @description Client ID */
|
|
3048
|
+
id: string;
|
|
3049
|
+
name: string;
|
|
3050
|
+
description: string;
|
|
3051
|
+
client_id: string;
|
|
3052
|
+
client_secret: string;
|
|
3053
|
+
callbacks: string[];
|
|
3054
|
+
logout_urls: string[];
|
|
3055
|
+
refresh_token: {
|
|
3056
|
+
/** @enum {unknown} */
|
|
3057
|
+
expiration_mode: "expire" | "not-expire";
|
|
3058
|
+
infinite_token_lifetime: boolean;
|
|
3059
|
+
token_lifetime: number;
|
|
3060
|
+
};
|
|
3061
|
+
client_uri?: string | null;
|
|
3062
|
+
logo_uri?: string | null;
|
|
3063
|
+
tos_uri?: string | null;
|
|
3064
|
+
policy_uri?: string | null;
|
|
3065
|
+
contacts?: string[];
|
|
3066
|
+
grant_types?: string[];
|
|
3067
|
+
response_types?: string[];
|
|
3068
|
+
token_endpoint_auth_method?: string;
|
|
3069
|
+
application_type?: string;
|
|
3070
|
+
software_id?: string | null;
|
|
3071
|
+
software_version?: string | null;
|
|
3072
|
+
frontchannel_logout_uri?: string | null;
|
|
3073
|
+
frontchannel_logout_session_required?: boolean;
|
|
3074
|
+
/** @description Object is related with this account */
|
|
3075
|
+
account: string;
|
|
3076
|
+
/**
|
|
3077
|
+
* @description ClientMetadata
|
|
3078
|
+
* @default {}
|
|
3079
|
+
*/
|
|
3080
|
+
metadata: {
|
|
3081
|
+
[key: string]: unknown;
|
|
3082
|
+
};
|
|
3083
|
+
/** @description Client creation date */
|
|
3084
|
+
createdAt: string;
|
|
3085
|
+
/** @description Client updated date */
|
|
3086
|
+
updatedAt?: string;
|
|
3087
|
+
};
|
|
3100
3088
|
};
|
|
3101
3089
|
};
|
|
3102
3090
|
};
|
|
3103
3091
|
};
|
|
3104
|
-
"
|
|
3092
|
+
"client/remove": {
|
|
3105
3093
|
parameters: {
|
|
3106
3094
|
query?: never;
|
|
3107
3095
|
header?: never;
|
|
3108
3096
|
path: {
|
|
3109
|
-
|
|
3097
|
+
client_id: string;
|
|
3110
3098
|
};
|
|
3111
3099
|
cookie?: never;
|
|
3112
3100
|
};
|
|
@@ -3121,7 +3109,7 @@ export interface operations {
|
|
|
3121
3109
|
};
|
|
3122
3110
|
};
|
|
3123
3111
|
};
|
|
3124
|
-
"
|
|
3112
|
+
"user/list": {
|
|
3125
3113
|
parameters: {
|
|
3126
3114
|
query?: {
|
|
3127
3115
|
/** @description Start from this cursor */
|
|
@@ -3132,6 +3120,7 @@ export interface operations {
|
|
|
3132
3120
|
pageSize?: number;
|
|
3133
3121
|
/** @description Filter using a FaableQL query */
|
|
3134
3122
|
query?: string;
|
|
3123
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
3135
3124
|
expand?: string[];
|
|
3136
3125
|
};
|
|
3137
3126
|
header?: never;
|
|
@@ -3150,22 +3139,481 @@ export interface operations {
|
|
|
3150
3139
|
/** @description next cursor */
|
|
3151
3140
|
next: string | null;
|
|
3152
3141
|
/** @description List of results */
|
|
3153
|
-
results: components["schemas"]["
|
|
3142
|
+
results: components["schemas"]["User"][];
|
|
3154
3143
|
};
|
|
3155
3144
|
};
|
|
3156
3145
|
};
|
|
3157
3146
|
};
|
|
3158
3147
|
};
|
|
3159
|
-
"
|
|
3148
|
+
"user/create": {
|
|
3160
3149
|
parameters: {
|
|
3161
3150
|
query?: never;
|
|
3162
3151
|
header?: never;
|
|
3163
3152
|
path?: never;
|
|
3164
3153
|
cookie?: never;
|
|
3165
3154
|
};
|
|
3166
|
-
|
|
3155
|
+
/** @description UserCreate */
|
|
3156
|
+
requestBody: {
|
|
3167
3157
|
content: {
|
|
3168
|
-
"application/json":
|
|
3158
|
+
"application/json": {
|
|
3159
|
+
/** @description The user's full name. */
|
|
3160
|
+
name?: string;
|
|
3161
|
+
/** @description The user's given name. */
|
|
3162
|
+
given_name?: string;
|
|
3163
|
+
/** @description The user's family name. */
|
|
3164
|
+
family_name?: string;
|
|
3165
|
+
/** @description The user's email. */
|
|
3166
|
+
email?: string;
|
|
3167
|
+
/** @description contact phone number */
|
|
3168
|
+
phone?: string;
|
|
3169
|
+
/** @description The user's birth date */
|
|
3170
|
+
birth_date?: string;
|
|
3171
|
+
/** @description The user's default locale lang. */
|
|
3172
|
+
locale?: string;
|
|
3173
|
+
/** @description A URI pointing to the user's picture. */
|
|
3174
|
+
picture?: string;
|
|
3175
|
+
/** @description Initial password for this user (mandatory only for auth0 connection strategy) */
|
|
3176
|
+
password?: string;
|
|
3177
|
+
/** @description User Metadata */
|
|
3178
|
+
user_metadata?: {
|
|
3179
|
+
[key: string]: unknown;
|
|
3180
|
+
};
|
|
3181
|
+
/** @description App Metadata */
|
|
3182
|
+
app_metadata?: {
|
|
3183
|
+
[key: string]: unknown;
|
|
3184
|
+
};
|
|
3185
|
+
};
|
|
3186
|
+
};
|
|
3187
|
+
};
|
|
3188
|
+
responses: {
|
|
3189
|
+
/** @description User */
|
|
3190
|
+
200: {
|
|
3191
|
+
headers: {
|
|
3192
|
+
[name: string]: unknown;
|
|
3193
|
+
};
|
|
3194
|
+
content: {
|
|
3195
|
+
"application/json": {
|
|
3196
|
+
/** @description User ID */
|
|
3197
|
+
id: string;
|
|
3198
|
+
/** @description User name */
|
|
3199
|
+
name?: string | null;
|
|
3200
|
+
/** @description unique username for this user */
|
|
3201
|
+
username?: string | null;
|
|
3202
|
+
/** @description Given name */
|
|
3203
|
+
given_name?: string | null;
|
|
3204
|
+
/** @description Family name */
|
|
3205
|
+
family_name?: string | null;
|
|
3206
|
+
/** @description Middle name (OIDC §5.1) */
|
|
3207
|
+
middle_name?: string | null;
|
|
3208
|
+
/** @description Casual name. Distinct from given_name (e.g. "Mike" vs "Michael"). OIDC §5.1 */
|
|
3209
|
+
nickname?: string | null;
|
|
3210
|
+
/** @description User email */
|
|
3211
|
+
email?: string | null;
|
|
3212
|
+
/**
|
|
3213
|
+
* @description true if email is verified
|
|
3214
|
+
* @default false
|
|
3215
|
+
*/
|
|
3216
|
+
email_verified: boolean;
|
|
3217
|
+
/** @description contact phone number */
|
|
3218
|
+
phone?: string | null;
|
|
3219
|
+
/** @description phone is verified */
|
|
3220
|
+
phone_verified: boolean;
|
|
3221
|
+
/** @description country iso code */
|
|
3222
|
+
country_iso?: string | null;
|
|
3223
|
+
/** @description user birth_date */
|
|
3224
|
+
birth_date?: string | null;
|
|
3225
|
+
/** @description User gender (free-form, OIDC §5.1) */
|
|
3226
|
+
gender?: string | null;
|
|
3227
|
+
/** @description IANA time-zone name (e.g. "Europe/Madrid"). OIDC §5.1 — used for the `zoneinfo` claim. */
|
|
3228
|
+
zoneinfo?: string | null;
|
|
3229
|
+
/** @description user main language */
|
|
3230
|
+
locale?: string;
|
|
3231
|
+
/** @description customer region */
|
|
3232
|
+
region?: string | null;
|
|
3233
|
+
/** @description URL of the User's personal Web page or blog (OIDC §5.1) */
|
|
3234
|
+
website?: string | null;
|
|
3235
|
+
address?: {
|
|
3236
|
+
/** @description Full mailing address, formatted for display (may contain newlines) */
|
|
3237
|
+
formatted?: string | null;
|
|
3238
|
+
street_address?: string | null;
|
|
3239
|
+
/** @description City or locality */
|
|
3240
|
+
locality?: string | null;
|
|
3241
|
+
/** @description State, province, or region */
|
|
3242
|
+
region?: string | null;
|
|
3243
|
+
postal_code?: string | null;
|
|
3244
|
+
/** @description Country name */
|
|
3245
|
+
country?: string | null;
|
|
3246
|
+
} | null;
|
|
3247
|
+
/** @description User picture url */
|
|
3248
|
+
picture?: string | null;
|
|
3249
|
+
/** @description Total number of logins this user has performed. */
|
|
3250
|
+
logins_count: number;
|
|
3251
|
+
/** @description Last IP address from which this user logged in */
|
|
3252
|
+
last_ip?: string | null;
|
|
3253
|
+
/** @description Last date and time this user logged in (ISO_8601 format) */
|
|
3254
|
+
last_login?: string | null;
|
|
3255
|
+
/**
|
|
3256
|
+
* @description User Metadata
|
|
3257
|
+
* @default {}
|
|
3258
|
+
*/
|
|
3259
|
+
user_metadata: {
|
|
3260
|
+
[key: string]: unknown;
|
|
3261
|
+
};
|
|
3262
|
+
/**
|
|
3263
|
+
* @description App Metadata
|
|
3264
|
+
* @default {}
|
|
3265
|
+
*/
|
|
3266
|
+
app_metadata: {
|
|
3267
|
+
[key: string]: unknown;
|
|
3268
|
+
};
|
|
3269
|
+
/** @description Object is related with this account */
|
|
3270
|
+
account: string;
|
|
3271
|
+
/**
|
|
3272
|
+
* @description UserMetadata
|
|
3273
|
+
* @default {}
|
|
3274
|
+
*/
|
|
3275
|
+
metadata: {
|
|
3276
|
+
[key: string]: unknown;
|
|
3277
|
+
};
|
|
3278
|
+
/** @description User creation date */
|
|
3279
|
+
createdAt: string;
|
|
3280
|
+
/** @description User updated date */
|
|
3281
|
+
updatedAt?: string;
|
|
3282
|
+
};
|
|
3283
|
+
};
|
|
3284
|
+
};
|
|
3285
|
+
};
|
|
3286
|
+
};
|
|
3287
|
+
"user/get": {
|
|
3288
|
+
parameters: {
|
|
3289
|
+
query?: {
|
|
3290
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
3291
|
+
expand?: string[];
|
|
3292
|
+
};
|
|
3293
|
+
header?: never;
|
|
3294
|
+
path: {
|
|
3295
|
+
user_id: string;
|
|
3296
|
+
};
|
|
3297
|
+
cookie?: never;
|
|
3298
|
+
};
|
|
3299
|
+
requestBody?: never;
|
|
3300
|
+
responses: {
|
|
3301
|
+
/** @description User */
|
|
3302
|
+
200: {
|
|
3303
|
+
headers: {
|
|
3304
|
+
[name: string]: unknown;
|
|
3305
|
+
};
|
|
3306
|
+
content: {
|
|
3307
|
+
"application/json": {
|
|
3308
|
+
/** @description User ID */
|
|
3309
|
+
id: string;
|
|
3310
|
+
/** @description User name */
|
|
3311
|
+
name?: string | null;
|
|
3312
|
+
/** @description unique username for this user */
|
|
3313
|
+
username?: string | null;
|
|
3314
|
+
/** @description Given name */
|
|
3315
|
+
given_name?: string | null;
|
|
3316
|
+
/** @description Family name */
|
|
3317
|
+
family_name?: string | null;
|
|
3318
|
+
/** @description Middle name (OIDC §5.1) */
|
|
3319
|
+
middle_name?: string | null;
|
|
3320
|
+
/** @description Casual name. Distinct from given_name (e.g. "Mike" vs "Michael"). OIDC §5.1 */
|
|
3321
|
+
nickname?: string | null;
|
|
3322
|
+
/** @description User email */
|
|
3323
|
+
email?: string | null;
|
|
3324
|
+
/**
|
|
3325
|
+
* @description true if email is verified
|
|
3326
|
+
* @default false
|
|
3327
|
+
*/
|
|
3328
|
+
email_verified: boolean;
|
|
3329
|
+
/** @description contact phone number */
|
|
3330
|
+
phone?: string | null;
|
|
3331
|
+
/** @description phone is verified */
|
|
3332
|
+
phone_verified: boolean;
|
|
3333
|
+
/** @description country iso code */
|
|
3334
|
+
country_iso?: string | null;
|
|
3335
|
+
/** @description user birth_date */
|
|
3336
|
+
birth_date?: string | null;
|
|
3337
|
+
/** @description User gender (free-form, OIDC §5.1) */
|
|
3338
|
+
gender?: string | null;
|
|
3339
|
+
/** @description IANA time-zone name (e.g. "Europe/Madrid"). OIDC §5.1 — used for the `zoneinfo` claim. */
|
|
3340
|
+
zoneinfo?: string | null;
|
|
3341
|
+
/** @description user main language */
|
|
3342
|
+
locale?: string;
|
|
3343
|
+
/** @description customer region */
|
|
3344
|
+
region?: string | null;
|
|
3345
|
+
/** @description URL of the User's personal Web page or blog (OIDC §5.1) */
|
|
3346
|
+
website?: string | null;
|
|
3347
|
+
address?: {
|
|
3348
|
+
/** @description Full mailing address, formatted for display (may contain newlines) */
|
|
3349
|
+
formatted?: string | null;
|
|
3350
|
+
street_address?: string | null;
|
|
3351
|
+
/** @description City or locality */
|
|
3352
|
+
locality?: string | null;
|
|
3353
|
+
/** @description State, province, or region */
|
|
3354
|
+
region?: string | null;
|
|
3355
|
+
postal_code?: string | null;
|
|
3356
|
+
/** @description Country name */
|
|
3357
|
+
country?: string | null;
|
|
3358
|
+
} | null;
|
|
3359
|
+
/** @description User picture url */
|
|
3360
|
+
picture?: string | null;
|
|
3361
|
+
/** @description Total number of logins this user has performed. */
|
|
3362
|
+
logins_count: number;
|
|
3363
|
+
/** @description Last IP address from which this user logged in */
|
|
3364
|
+
last_ip?: string | null;
|
|
3365
|
+
/** @description Last date and time this user logged in (ISO_8601 format) */
|
|
3366
|
+
last_login?: string | null;
|
|
3367
|
+
/**
|
|
3368
|
+
* @description User Metadata
|
|
3369
|
+
* @default {}
|
|
3370
|
+
*/
|
|
3371
|
+
user_metadata: {
|
|
3372
|
+
[key: string]: unknown;
|
|
3373
|
+
};
|
|
3374
|
+
/**
|
|
3375
|
+
* @description App Metadata
|
|
3376
|
+
* @default {}
|
|
3377
|
+
*/
|
|
3378
|
+
app_metadata: {
|
|
3379
|
+
[key: string]: unknown;
|
|
3380
|
+
};
|
|
3381
|
+
/** @description Object is related with this account */
|
|
3382
|
+
account: string;
|
|
3383
|
+
/**
|
|
3384
|
+
* @description UserMetadata
|
|
3385
|
+
* @default {}
|
|
3386
|
+
*/
|
|
3387
|
+
metadata: {
|
|
3388
|
+
[key: string]: unknown;
|
|
3389
|
+
};
|
|
3390
|
+
/** @description User creation date */
|
|
3391
|
+
createdAt: string;
|
|
3392
|
+
/** @description User updated date */
|
|
3393
|
+
updatedAt?: string;
|
|
3394
|
+
};
|
|
3395
|
+
};
|
|
3396
|
+
};
|
|
3397
|
+
};
|
|
3398
|
+
};
|
|
3399
|
+
"user/update": {
|
|
3400
|
+
parameters: {
|
|
3401
|
+
query?: never;
|
|
3402
|
+
header?: never;
|
|
3403
|
+
path: {
|
|
3404
|
+
user_id: string;
|
|
3405
|
+
};
|
|
3406
|
+
cookie?: never;
|
|
3407
|
+
};
|
|
3408
|
+
/** @description UserUpdate */
|
|
3409
|
+
requestBody: {
|
|
3410
|
+
content: {
|
|
3411
|
+
"application/json": {
|
|
3412
|
+
/** @description name */
|
|
3413
|
+
name?: string;
|
|
3414
|
+
/** @description given name */
|
|
3415
|
+
given_name?: string;
|
|
3416
|
+
/** @description family name */
|
|
3417
|
+
family_name?: string;
|
|
3418
|
+
/** @description contact email */
|
|
3419
|
+
email?: string;
|
|
3420
|
+
/** @description New password for this user */
|
|
3421
|
+
password?: string;
|
|
3422
|
+
/** @description contact phone number */
|
|
3423
|
+
phone?: string;
|
|
3424
|
+
/** @description user country as iso string */
|
|
3425
|
+
country_iso?: string;
|
|
3426
|
+
/** @description user birth_date */
|
|
3427
|
+
birth_date?: string;
|
|
3428
|
+
/** @description user birth_date */
|
|
3429
|
+
locale?: string;
|
|
3430
|
+
/** @description User picture url */
|
|
3431
|
+
picture?: string;
|
|
3432
|
+
/** @description User defined metadata */
|
|
3433
|
+
user_metadata?: {
|
|
3434
|
+
[key: string]: unknown;
|
|
3435
|
+
};
|
|
3436
|
+
/** @description App defined metadata */
|
|
3437
|
+
app_metadata?: {
|
|
3438
|
+
[key: string]: unknown;
|
|
3439
|
+
};
|
|
3440
|
+
};
|
|
3441
|
+
};
|
|
3442
|
+
};
|
|
3443
|
+
responses: {
|
|
3444
|
+
/** @description User */
|
|
3445
|
+
200: {
|
|
3446
|
+
headers: {
|
|
3447
|
+
[name: string]: unknown;
|
|
3448
|
+
};
|
|
3449
|
+
content: {
|
|
3450
|
+
"application/json": {
|
|
3451
|
+
/** @description User ID */
|
|
3452
|
+
id: string;
|
|
3453
|
+
/** @description User name */
|
|
3454
|
+
name?: string | null;
|
|
3455
|
+
/** @description unique username for this user */
|
|
3456
|
+
username?: string | null;
|
|
3457
|
+
/** @description Given name */
|
|
3458
|
+
given_name?: string | null;
|
|
3459
|
+
/** @description Family name */
|
|
3460
|
+
family_name?: string | null;
|
|
3461
|
+
/** @description Middle name (OIDC §5.1) */
|
|
3462
|
+
middle_name?: string | null;
|
|
3463
|
+
/** @description Casual name. Distinct from given_name (e.g. "Mike" vs "Michael"). OIDC §5.1 */
|
|
3464
|
+
nickname?: string | null;
|
|
3465
|
+
/** @description User email */
|
|
3466
|
+
email?: string | null;
|
|
3467
|
+
/**
|
|
3468
|
+
* @description true if email is verified
|
|
3469
|
+
* @default false
|
|
3470
|
+
*/
|
|
3471
|
+
email_verified: boolean;
|
|
3472
|
+
/** @description contact phone number */
|
|
3473
|
+
phone?: string | null;
|
|
3474
|
+
/** @description phone is verified */
|
|
3475
|
+
phone_verified: boolean;
|
|
3476
|
+
/** @description country iso code */
|
|
3477
|
+
country_iso?: string | null;
|
|
3478
|
+
/** @description user birth_date */
|
|
3479
|
+
birth_date?: string | null;
|
|
3480
|
+
/** @description User gender (free-form, OIDC §5.1) */
|
|
3481
|
+
gender?: string | null;
|
|
3482
|
+
/** @description IANA time-zone name (e.g. "Europe/Madrid"). OIDC §5.1 — used for the `zoneinfo` claim. */
|
|
3483
|
+
zoneinfo?: string | null;
|
|
3484
|
+
/** @description user main language */
|
|
3485
|
+
locale?: string;
|
|
3486
|
+
/** @description customer region */
|
|
3487
|
+
region?: string | null;
|
|
3488
|
+
/** @description URL of the User's personal Web page or blog (OIDC §5.1) */
|
|
3489
|
+
website?: string | null;
|
|
3490
|
+
address?: {
|
|
3491
|
+
/** @description Full mailing address, formatted for display (may contain newlines) */
|
|
3492
|
+
formatted?: string | null;
|
|
3493
|
+
street_address?: string | null;
|
|
3494
|
+
/** @description City or locality */
|
|
3495
|
+
locality?: string | null;
|
|
3496
|
+
/** @description State, province, or region */
|
|
3497
|
+
region?: string | null;
|
|
3498
|
+
postal_code?: string | null;
|
|
3499
|
+
/** @description Country name */
|
|
3500
|
+
country?: string | null;
|
|
3501
|
+
} | null;
|
|
3502
|
+
/** @description User picture url */
|
|
3503
|
+
picture?: string | null;
|
|
3504
|
+
/** @description Total number of logins this user has performed. */
|
|
3505
|
+
logins_count: number;
|
|
3506
|
+
/** @description Last IP address from which this user logged in */
|
|
3507
|
+
last_ip?: string | null;
|
|
3508
|
+
/** @description Last date and time this user logged in (ISO_8601 format) */
|
|
3509
|
+
last_login?: string | null;
|
|
3510
|
+
/**
|
|
3511
|
+
* @description User Metadata
|
|
3512
|
+
* @default {}
|
|
3513
|
+
*/
|
|
3514
|
+
user_metadata: {
|
|
3515
|
+
[key: string]: unknown;
|
|
3516
|
+
};
|
|
3517
|
+
/**
|
|
3518
|
+
* @description App Metadata
|
|
3519
|
+
* @default {}
|
|
3520
|
+
*/
|
|
3521
|
+
app_metadata: {
|
|
3522
|
+
[key: string]: unknown;
|
|
3523
|
+
};
|
|
3524
|
+
/** @description Object is related with this account */
|
|
3525
|
+
account: string;
|
|
3526
|
+
/**
|
|
3527
|
+
* @description UserMetadata
|
|
3528
|
+
* @default {}
|
|
3529
|
+
*/
|
|
3530
|
+
metadata: {
|
|
3531
|
+
[key: string]: unknown;
|
|
3532
|
+
};
|
|
3533
|
+
/** @description User creation date */
|
|
3534
|
+
createdAt: string;
|
|
3535
|
+
/** @description User updated date */
|
|
3536
|
+
updatedAt?: string;
|
|
3537
|
+
};
|
|
3538
|
+
};
|
|
3539
|
+
};
|
|
3540
|
+
};
|
|
3541
|
+
};
|
|
3542
|
+
"user/remove": {
|
|
3543
|
+
parameters: {
|
|
3544
|
+
query?: never;
|
|
3545
|
+
header?: never;
|
|
3546
|
+
path: {
|
|
3547
|
+
user_id: string;
|
|
3548
|
+
};
|
|
3549
|
+
cookie?: never;
|
|
3550
|
+
};
|
|
3551
|
+
requestBody?: never;
|
|
3552
|
+
responses: {
|
|
3553
|
+
/** @description Default Response */
|
|
3554
|
+
200: {
|
|
3555
|
+
headers: {
|
|
3556
|
+
[name: string]: unknown;
|
|
3557
|
+
};
|
|
3558
|
+
content?: never;
|
|
3559
|
+
};
|
|
3560
|
+
};
|
|
3561
|
+
};
|
|
3562
|
+
"identity/list": {
|
|
3563
|
+
parameters: {
|
|
3564
|
+
query?: {
|
|
3565
|
+
/** @description Start from this cursor */
|
|
3566
|
+
cursor?: string;
|
|
3567
|
+
/** @description Start from this cursor */
|
|
3568
|
+
next?: string;
|
|
3569
|
+
/** @description Size of the results array */
|
|
3570
|
+
pageSize?: number;
|
|
3571
|
+
/** @description Filter using a FaableQL query */
|
|
3572
|
+
query?: string;
|
|
3573
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
3574
|
+
expand?: string[];
|
|
3575
|
+
};
|
|
3576
|
+
header?: never;
|
|
3577
|
+
path?: never;
|
|
3578
|
+
cookie?: never;
|
|
3579
|
+
};
|
|
3580
|
+
requestBody?: never;
|
|
3581
|
+
responses: {
|
|
3582
|
+
/** @description PaginatedResponse */
|
|
3583
|
+
200: {
|
|
3584
|
+
headers: {
|
|
3585
|
+
[name: string]: unknown;
|
|
3586
|
+
};
|
|
3587
|
+
content: {
|
|
3588
|
+
"application/json": {
|
|
3589
|
+
/** @description next cursor */
|
|
3590
|
+
next: string | null;
|
|
3591
|
+
/** @description List of results */
|
|
3592
|
+
results: components["schemas"]["Identity"][];
|
|
3593
|
+
};
|
|
3594
|
+
};
|
|
3595
|
+
};
|
|
3596
|
+
};
|
|
3597
|
+
};
|
|
3598
|
+
"identity/create": {
|
|
3599
|
+
parameters: {
|
|
3600
|
+
query?: never;
|
|
3601
|
+
header?: never;
|
|
3602
|
+
path?: never;
|
|
3603
|
+
cookie?: never;
|
|
3604
|
+
};
|
|
3605
|
+
requestBody: {
|
|
3606
|
+
content: {
|
|
3607
|
+
"application/json": {
|
|
3608
|
+
account: string;
|
|
3609
|
+
user: string;
|
|
3610
|
+
identity_id: string;
|
|
3611
|
+
connection: string;
|
|
3612
|
+
access_token?: string;
|
|
3613
|
+
access_token_secret?: string;
|
|
3614
|
+
refresh_token?: string;
|
|
3615
|
+
profile_data: unknown;
|
|
3616
|
+
};
|
|
3169
3617
|
};
|
|
3170
3618
|
};
|
|
3171
3619
|
responses: {
|
|
@@ -3175,14 +3623,40 @@ export interface operations {
|
|
|
3175
3623
|
[name: string]: unknown;
|
|
3176
3624
|
};
|
|
3177
3625
|
content: {
|
|
3178
|
-
"application/json":
|
|
3626
|
+
"application/json": {
|
|
3627
|
+
/** @description Identity ID */
|
|
3628
|
+
id: string;
|
|
3629
|
+
connection: components["schemas"]["Connection"] | string | unknown;
|
|
3630
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
3631
|
+
identity_id: string;
|
|
3632
|
+
access_token?: string;
|
|
3633
|
+
access_token_secret?: string;
|
|
3634
|
+
refresh_token?: string;
|
|
3635
|
+
profile_data: unknown;
|
|
3636
|
+
/** @description Object is related with this account */
|
|
3637
|
+
account: string;
|
|
3638
|
+
/**
|
|
3639
|
+
* @description IdentityMetadata
|
|
3640
|
+
* @default {}
|
|
3641
|
+
*/
|
|
3642
|
+
metadata: {
|
|
3643
|
+
[key: string]: unknown;
|
|
3644
|
+
};
|
|
3645
|
+
/** @description Identity creation date */
|
|
3646
|
+
createdAt: string;
|
|
3647
|
+
/** @description Identity updated date */
|
|
3648
|
+
updatedAt?: string;
|
|
3649
|
+
};
|
|
3179
3650
|
};
|
|
3180
3651
|
};
|
|
3181
3652
|
};
|
|
3182
3653
|
};
|
|
3183
3654
|
"identity/get": {
|
|
3184
3655
|
parameters: {
|
|
3185
|
-
query?:
|
|
3656
|
+
query?: {
|
|
3657
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
3658
|
+
expand?: string[];
|
|
3659
|
+
};
|
|
3186
3660
|
header?: never;
|
|
3187
3661
|
path: {
|
|
3188
3662
|
identity_id: string;
|
|
@@ -3197,7 +3671,30 @@ export interface operations {
|
|
|
3197
3671
|
[name: string]: unknown;
|
|
3198
3672
|
};
|
|
3199
3673
|
content: {
|
|
3200
|
-
"application/json":
|
|
3674
|
+
"application/json": {
|
|
3675
|
+
/** @description Identity ID */
|
|
3676
|
+
id: string;
|
|
3677
|
+
connection: components["schemas"]["Connection"] | string | unknown;
|
|
3678
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
3679
|
+
identity_id: string;
|
|
3680
|
+
access_token?: string;
|
|
3681
|
+
access_token_secret?: string;
|
|
3682
|
+
refresh_token?: string;
|
|
3683
|
+
profile_data: unknown;
|
|
3684
|
+
/** @description Object is related with this account */
|
|
3685
|
+
account: string;
|
|
3686
|
+
/**
|
|
3687
|
+
* @description IdentityMetadata
|
|
3688
|
+
* @default {}
|
|
3689
|
+
*/
|
|
3690
|
+
metadata: {
|
|
3691
|
+
[key: string]: unknown;
|
|
3692
|
+
};
|
|
3693
|
+
/** @description Identity creation date */
|
|
3694
|
+
createdAt: string;
|
|
3695
|
+
/** @description Identity updated date */
|
|
3696
|
+
updatedAt?: string;
|
|
3697
|
+
};
|
|
3201
3698
|
};
|
|
3202
3699
|
};
|
|
3203
3700
|
};
|
|
@@ -3233,6 +3730,7 @@ export interface operations {
|
|
|
3233
3730
|
pageSize?: number;
|
|
3234
3731
|
/** @description Filter using a FaableQL query */
|
|
3235
3732
|
query?: string;
|
|
3733
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
3236
3734
|
expand?: string[];
|
|
3237
3735
|
};
|
|
3238
3736
|
header?: never;
|
|
@@ -3264,9 +3762,17 @@ export interface operations {
|
|
|
3264
3762
|
path?: never;
|
|
3265
3763
|
cookie?: never;
|
|
3266
3764
|
};
|
|
3267
|
-
|
|
3765
|
+
/** @description RoleCreate */
|
|
3766
|
+
requestBody: {
|
|
3268
3767
|
content: {
|
|
3269
|
-
"application/json":
|
|
3768
|
+
"application/json": {
|
|
3769
|
+
name: string;
|
|
3770
|
+
description?: string;
|
|
3771
|
+
/** @description Add Metadata */
|
|
3772
|
+
metadata?: {
|
|
3773
|
+
[key: string]: unknown;
|
|
3774
|
+
};
|
|
3775
|
+
};
|
|
3270
3776
|
};
|
|
3271
3777
|
};
|
|
3272
3778
|
responses: {
|
|
@@ -3276,14 +3782,37 @@ export interface operations {
|
|
|
3276
3782
|
[name: string]: unknown;
|
|
3277
3783
|
};
|
|
3278
3784
|
content: {
|
|
3279
|
-
"application/json":
|
|
3785
|
+
"application/json": {
|
|
3786
|
+
/** @description Role ID */
|
|
3787
|
+
id: string;
|
|
3788
|
+
/** @description Name for this role */
|
|
3789
|
+
name: string;
|
|
3790
|
+
/** @description Description of this role */
|
|
3791
|
+
description: string;
|
|
3792
|
+
/** @description Object is related with this account */
|
|
3793
|
+
account: string;
|
|
3794
|
+
/**
|
|
3795
|
+
* @description RoleMetadata
|
|
3796
|
+
* @default {}
|
|
3797
|
+
*/
|
|
3798
|
+
metadata: {
|
|
3799
|
+
[key: string]: unknown;
|
|
3800
|
+
};
|
|
3801
|
+
/** @description Role creation date */
|
|
3802
|
+
createdAt: string;
|
|
3803
|
+
/** @description Role updated date */
|
|
3804
|
+
updatedAt?: string;
|
|
3805
|
+
};
|
|
3280
3806
|
};
|
|
3281
3807
|
};
|
|
3282
3808
|
};
|
|
3283
3809
|
};
|
|
3284
3810
|
"role/get": {
|
|
3285
3811
|
parameters: {
|
|
3286
|
-
query?:
|
|
3812
|
+
query?: {
|
|
3813
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
3814
|
+
expand?: string[];
|
|
3815
|
+
};
|
|
3287
3816
|
header?: never;
|
|
3288
3817
|
path: {
|
|
3289
3818
|
role_id: string;
|
|
@@ -3298,7 +3827,27 @@ export interface operations {
|
|
|
3298
3827
|
[name: string]: unknown;
|
|
3299
3828
|
};
|
|
3300
3829
|
content: {
|
|
3301
|
-
"application/json":
|
|
3830
|
+
"application/json": {
|
|
3831
|
+
/** @description Role ID */
|
|
3832
|
+
id: string;
|
|
3833
|
+
/** @description Name for this role */
|
|
3834
|
+
name: string;
|
|
3835
|
+
/** @description Description of this role */
|
|
3836
|
+
description: string;
|
|
3837
|
+
/** @description Object is related with this account */
|
|
3838
|
+
account: string;
|
|
3839
|
+
/**
|
|
3840
|
+
* @description RoleMetadata
|
|
3841
|
+
* @default {}
|
|
3842
|
+
*/
|
|
3843
|
+
metadata: {
|
|
3844
|
+
[key: string]: unknown;
|
|
3845
|
+
};
|
|
3846
|
+
/** @description Role creation date */
|
|
3847
|
+
createdAt: string;
|
|
3848
|
+
/** @description Role updated date */
|
|
3849
|
+
updatedAt?: string;
|
|
3850
|
+
};
|
|
3302
3851
|
};
|
|
3303
3852
|
};
|
|
3304
3853
|
};
|
|
@@ -3366,9 +3915,11 @@ export interface operations {
|
|
|
3366
3915
|
};
|
|
3367
3916
|
cookie?: never;
|
|
3368
3917
|
};
|
|
3369
|
-
requestBody
|
|
3918
|
+
requestBody: {
|
|
3370
3919
|
content: {
|
|
3371
|
-
"application/json":
|
|
3920
|
+
"application/json": {
|
|
3921
|
+
users: string[];
|
|
3922
|
+
};
|
|
3372
3923
|
};
|
|
3373
3924
|
};
|
|
3374
3925
|
responses: {
|
|
@@ -3392,6 +3943,7 @@ export interface operations {
|
|
|
3392
3943
|
pageSize?: number;
|
|
3393
3944
|
/** @description Filter using a FaableQL query */
|
|
3394
3945
|
query?: string;
|
|
3946
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
3395
3947
|
expand?: string[];
|
|
3396
3948
|
};
|
|
3397
3949
|
header?: never;
|
|
@@ -3423,9 +3975,11 @@ export interface operations {
|
|
|
3423
3975
|
path?: never;
|
|
3424
3976
|
cookie?: never;
|
|
3425
3977
|
};
|
|
3426
|
-
requestBody
|
|
3978
|
+
requestBody: {
|
|
3427
3979
|
content: {
|
|
3428
|
-
"application/json":
|
|
3980
|
+
"application/json": {
|
|
3981
|
+
users: string[];
|
|
3982
|
+
};
|
|
3429
3983
|
};
|
|
3430
3984
|
};
|
|
3431
3985
|
responses: {
|
|
@@ -3435,14 +3989,35 @@ export interface operations {
|
|
|
3435
3989
|
[name: string]: unknown;
|
|
3436
3990
|
};
|
|
3437
3991
|
content: {
|
|
3438
|
-
"application/json":
|
|
3992
|
+
"application/json": {
|
|
3993
|
+
/** @description RoleMember ID */
|
|
3994
|
+
id: string;
|
|
3995
|
+
role: components["schemas"]["Role"] | string | unknown;
|
|
3996
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
3997
|
+
/** @description Object is related with this account */
|
|
3998
|
+
account: string;
|
|
3999
|
+
/**
|
|
4000
|
+
* @description RoleMemberMetadata
|
|
4001
|
+
* @default {}
|
|
4002
|
+
*/
|
|
4003
|
+
metadata: {
|
|
4004
|
+
[key: string]: unknown;
|
|
4005
|
+
};
|
|
4006
|
+
/** @description RoleMember creation date */
|
|
4007
|
+
createdAt: string;
|
|
4008
|
+
/** @description RoleMember updated date */
|
|
4009
|
+
updatedAt?: string;
|
|
4010
|
+
};
|
|
3439
4011
|
};
|
|
3440
4012
|
};
|
|
3441
4013
|
};
|
|
3442
4014
|
};
|
|
3443
4015
|
"rolemember/get": {
|
|
3444
4016
|
parameters: {
|
|
3445
|
-
query?:
|
|
4017
|
+
query?: {
|
|
4018
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
4019
|
+
expand?: string[];
|
|
4020
|
+
};
|
|
3446
4021
|
header?: never;
|
|
3447
4022
|
path: {
|
|
3448
4023
|
rolemember_id: string;
|
|
@@ -3457,7 +4032,25 @@ export interface operations {
|
|
|
3457
4032
|
[name: string]: unknown;
|
|
3458
4033
|
};
|
|
3459
4034
|
content: {
|
|
3460
|
-
"application/json":
|
|
4035
|
+
"application/json": {
|
|
4036
|
+
/** @description RoleMember ID */
|
|
4037
|
+
id: string;
|
|
4038
|
+
role: components["schemas"]["Role"] | string | unknown;
|
|
4039
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
4040
|
+
/** @description Object is related with this account */
|
|
4041
|
+
account: string;
|
|
4042
|
+
/**
|
|
4043
|
+
* @description RoleMemberMetadata
|
|
4044
|
+
* @default {}
|
|
4045
|
+
*/
|
|
4046
|
+
metadata: {
|
|
4047
|
+
[key: string]: unknown;
|
|
4048
|
+
};
|
|
4049
|
+
/** @description RoleMember creation date */
|
|
4050
|
+
createdAt: string;
|
|
4051
|
+
/** @description RoleMember updated date */
|
|
4052
|
+
updatedAt?: string;
|
|
4053
|
+
};
|
|
3461
4054
|
};
|
|
3462
4055
|
};
|
|
3463
4056
|
};
|
|
@@ -3493,6 +4086,7 @@ export interface operations {
|
|
|
3493
4086
|
pageSize?: number;
|
|
3494
4087
|
/** @description Filter using a FaableQL query */
|
|
3495
4088
|
query?: string;
|
|
4089
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
3496
4090
|
expand?: string[];
|
|
3497
4091
|
};
|
|
3498
4092
|
header?: never;
|
|
@@ -3524,9 +4118,17 @@ export interface operations {
|
|
|
3524
4118
|
path?: never;
|
|
3525
4119
|
cookie?: never;
|
|
3526
4120
|
};
|
|
3527
|
-
|
|
4121
|
+
/** @description TeamCreate */
|
|
4122
|
+
requestBody: {
|
|
3528
4123
|
content: {
|
|
3529
|
-
"application/json":
|
|
4124
|
+
"application/json": {
|
|
4125
|
+
name: string;
|
|
4126
|
+
description?: string;
|
|
4127
|
+
/** @description Add Metadata */
|
|
4128
|
+
metadata?: {
|
|
4129
|
+
[key: string]: unknown;
|
|
4130
|
+
};
|
|
4131
|
+
};
|
|
3530
4132
|
};
|
|
3531
4133
|
};
|
|
3532
4134
|
responses: {
|
|
@@ -3536,14 +4138,37 @@ export interface operations {
|
|
|
3536
4138
|
[name: string]: unknown;
|
|
3537
4139
|
};
|
|
3538
4140
|
content: {
|
|
3539
|
-
"application/json":
|
|
4141
|
+
"application/json": {
|
|
4142
|
+
/** @description Team ID */
|
|
4143
|
+
id: string;
|
|
4144
|
+
name: string;
|
|
4145
|
+
slug: string;
|
|
4146
|
+
description: string | null;
|
|
4147
|
+
logo_url: string | null;
|
|
4148
|
+
/** @description Object is related with this account */
|
|
4149
|
+
account: string;
|
|
4150
|
+
/**
|
|
4151
|
+
* @description TeamMetadata
|
|
4152
|
+
* @default {}
|
|
4153
|
+
*/
|
|
4154
|
+
metadata: {
|
|
4155
|
+
[key: string]: unknown;
|
|
4156
|
+
};
|
|
4157
|
+
/** @description Team creation date */
|
|
4158
|
+
createdAt: string;
|
|
4159
|
+
/** @description Team updated date */
|
|
4160
|
+
updatedAt?: string;
|
|
4161
|
+
};
|
|
3540
4162
|
};
|
|
3541
4163
|
};
|
|
3542
4164
|
};
|
|
3543
4165
|
};
|
|
3544
4166
|
"team/get": {
|
|
3545
4167
|
parameters: {
|
|
3546
|
-
query?:
|
|
4168
|
+
query?: {
|
|
4169
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
4170
|
+
expand?: string[];
|
|
4171
|
+
};
|
|
3547
4172
|
header?: never;
|
|
3548
4173
|
path: {
|
|
3549
4174
|
team_id: string;
|
|
@@ -3558,7 +4183,27 @@ export interface operations {
|
|
|
3558
4183
|
[name: string]: unknown;
|
|
3559
4184
|
};
|
|
3560
4185
|
content: {
|
|
3561
|
-
"application/json":
|
|
4186
|
+
"application/json": {
|
|
4187
|
+
/** @description Team ID */
|
|
4188
|
+
id: string;
|
|
4189
|
+
name: string;
|
|
4190
|
+
slug: string;
|
|
4191
|
+
description: string | null;
|
|
4192
|
+
logo_url: string | null;
|
|
4193
|
+
/** @description Object is related with this account */
|
|
4194
|
+
account: string;
|
|
4195
|
+
/**
|
|
4196
|
+
* @description TeamMetadata
|
|
4197
|
+
* @default {}
|
|
4198
|
+
*/
|
|
4199
|
+
metadata: {
|
|
4200
|
+
[key: string]: unknown;
|
|
4201
|
+
};
|
|
4202
|
+
/** @description Team creation date */
|
|
4203
|
+
createdAt: string;
|
|
4204
|
+
/** @description Team updated date */
|
|
4205
|
+
updatedAt?: string;
|
|
4206
|
+
};
|
|
3562
4207
|
};
|
|
3563
4208
|
};
|
|
3564
4209
|
};
|
|
@@ -3594,6 +4239,7 @@ export interface operations {
|
|
|
3594
4239
|
pageSize?: number;
|
|
3595
4240
|
/** @description Filter using a FaableQL query */
|
|
3596
4241
|
query?: string;
|
|
4242
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
3597
4243
|
expand?: string[];
|
|
3598
4244
|
};
|
|
3599
4245
|
header?: never;
|
|
@@ -3625,9 +4271,11 @@ export interface operations {
|
|
|
3625
4271
|
path?: never;
|
|
3626
4272
|
cookie?: never;
|
|
3627
4273
|
};
|
|
3628
|
-
requestBody
|
|
4274
|
+
requestBody: {
|
|
3629
4275
|
content: {
|
|
3630
|
-
"application/json":
|
|
4276
|
+
"application/json": {
|
|
4277
|
+
users: string[];
|
|
4278
|
+
};
|
|
3631
4279
|
};
|
|
3632
4280
|
};
|
|
3633
4281
|
responses: {
|
|
@@ -3637,14 +4285,36 @@ export interface operations {
|
|
|
3637
4285
|
[name: string]: unknown;
|
|
3638
4286
|
};
|
|
3639
4287
|
content: {
|
|
3640
|
-
"application/json":
|
|
4288
|
+
"application/json": {
|
|
4289
|
+
/** @description TeamMember ID */
|
|
4290
|
+
id: string;
|
|
4291
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
4292
|
+
team: components["schemas"]["Team"] | string | unknown;
|
|
4293
|
+
roles: (components["schemas"]["Role"] | string | unknown)[];
|
|
4294
|
+
/** @description Object is related with this account */
|
|
4295
|
+
account: string;
|
|
4296
|
+
/**
|
|
4297
|
+
* @description TeamMemberMetadata
|
|
4298
|
+
* @default {}
|
|
4299
|
+
*/
|
|
4300
|
+
metadata: {
|
|
4301
|
+
[key: string]: unknown;
|
|
4302
|
+
};
|
|
4303
|
+
/** @description TeamMember creation date */
|
|
4304
|
+
createdAt: string;
|
|
4305
|
+
/** @description TeamMember updated date */
|
|
4306
|
+
updatedAt?: string;
|
|
4307
|
+
};
|
|
3641
4308
|
};
|
|
3642
4309
|
};
|
|
3643
4310
|
};
|
|
3644
4311
|
};
|
|
3645
4312
|
"teammember/get": {
|
|
3646
4313
|
parameters: {
|
|
3647
|
-
query?:
|
|
4314
|
+
query?: {
|
|
4315
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
4316
|
+
expand?: string[];
|
|
4317
|
+
};
|
|
3648
4318
|
header?: never;
|
|
3649
4319
|
path: {
|
|
3650
4320
|
teammember_id: string;
|
|
@@ -3659,7 +4329,26 @@ export interface operations {
|
|
|
3659
4329
|
[name: string]: unknown;
|
|
3660
4330
|
};
|
|
3661
4331
|
content: {
|
|
3662
|
-
"application/json":
|
|
4332
|
+
"application/json": {
|
|
4333
|
+
/** @description TeamMember ID */
|
|
4334
|
+
id: string;
|
|
4335
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
4336
|
+
team: components["schemas"]["Team"] | string | unknown;
|
|
4337
|
+
roles: (components["schemas"]["Role"] | string | unknown)[];
|
|
4338
|
+
/** @description Object is related with this account */
|
|
4339
|
+
account: string;
|
|
4340
|
+
/**
|
|
4341
|
+
* @description TeamMemberMetadata
|
|
4342
|
+
* @default {}
|
|
4343
|
+
*/
|
|
4344
|
+
metadata: {
|
|
4345
|
+
[key: string]: unknown;
|
|
4346
|
+
};
|
|
4347
|
+
/** @description TeamMember creation date */
|
|
4348
|
+
createdAt: string;
|
|
4349
|
+
/** @description TeamMember updated date */
|
|
4350
|
+
updatedAt?: string;
|
|
4351
|
+
};
|
|
3663
4352
|
};
|
|
3664
4353
|
};
|
|
3665
4354
|
};
|
|
@@ -3684,7 +4373,7 @@ export interface operations {
|
|
|
3684
4373
|
};
|
|
3685
4374
|
};
|
|
3686
4375
|
};
|
|
3687
|
-
"
|
|
4376
|
+
"team/listMembers": {
|
|
3688
4377
|
parameters: {
|
|
3689
4378
|
query?: {
|
|
3690
4379
|
/** @description Start from this cursor */
|
|
@@ -3693,12 +4382,11 @@ export interface operations {
|
|
|
3693
4382
|
next?: string;
|
|
3694
4383
|
/** @description Size of the results array */
|
|
3695
4384
|
pageSize?: number;
|
|
3696
|
-
/** @description Filter using a FaableQL query */
|
|
3697
|
-
query?: string;
|
|
3698
|
-
expand?: string[];
|
|
3699
4385
|
};
|
|
3700
4386
|
header?: never;
|
|
3701
|
-
path
|
|
4387
|
+
path: {
|
|
4388
|
+
team_id: string;
|
|
4389
|
+
};
|
|
3702
4390
|
cookie?: never;
|
|
3703
4391
|
};
|
|
3704
4392
|
requestBody?: never;
|
|
@@ -3713,41 +4401,199 @@ export interface operations {
|
|
|
3713
4401
|
/** @description next cursor */
|
|
3714
4402
|
next: string | null;
|
|
3715
4403
|
/** @description List of results */
|
|
3716
|
-
results: components["schemas"]["
|
|
4404
|
+
results: components["schemas"]["TeamMember"][];
|
|
3717
4405
|
};
|
|
3718
4406
|
};
|
|
3719
4407
|
};
|
|
3720
4408
|
};
|
|
3721
4409
|
};
|
|
3722
|
-
"
|
|
4410
|
+
"team/addMembers": {
|
|
3723
4411
|
parameters: {
|
|
3724
4412
|
query?: never;
|
|
3725
4413
|
header?: never;
|
|
3726
|
-
path
|
|
4414
|
+
path: {
|
|
4415
|
+
team_id: string;
|
|
4416
|
+
};
|
|
3727
4417
|
cookie?: never;
|
|
3728
4418
|
};
|
|
3729
|
-
requestBody
|
|
4419
|
+
requestBody: {
|
|
3730
4420
|
content: {
|
|
3731
|
-
"application/json":
|
|
4421
|
+
"application/json": {
|
|
4422
|
+
users: string[];
|
|
4423
|
+
};
|
|
3732
4424
|
};
|
|
3733
4425
|
};
|
|
3734
4426
|
responses: {
|
|
3735
|
-
/** @description
|
|
3736
|
-
|
|
4427
|
+
/** @description TeamMember */
|
|
4428
|
+
201: {
|
|
3737
4429
|
headers: {
|
|
3738
4430
|
[name: string]: unknown;
|
|
3739
4431
|
};
|
|
3740
4432
|
content: {
|
|
3741
|
-
"application/json":
|
|
4433
|
+
"application/json": {
|
|
4434
|
+
/** @description TeamMember ID */
|
|
4435
|
+
id: string;
|
|
4436
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
4437
|
+
team: components["schemas"]["Team"] | string | unknown;
|
|
4438
|
+
roles: (components["schemas"]["Role"] | string | unknown)[];
|
|
4439
|
+
/** @description Object is related with this account */
|
|
4440
|
+
account: string;
|
|
4441
|
+
/**
|
|
4442
|
+
* @description TeamMemberMetadata
|
|
4443
|
+
* @default {}
|
|
4444
|
+
*/
|
|
4445
|
+
metadata: {
|
|
4446
|
+
[key: string]: unknown;
|
|
4447
|
+
};
|
|
4448
|
+
/** @description TeamMember creation date */
|
|
4449
|
+
createdAt: string;
|
|
4450
|
+
/** @description TeamMember updated date */
|
|
4451
|
+
updatedAt?: string;
|
|
4452
|
+
};
|
|
3742
4453
|
};
|
|
3743
4454
|
};
|
|
3744
4455
|
};
|
|
3745
4456
|
};
|
|
3746
|
-
"
|
|
4457
|
+
"team/checkMember": {
|
|
3747
4458
|
parameters: {
|
|
3748
|
-
query?:
|
|
3749
|
-
|
|
3750
|
-
|
|
4459
|
+
query?: {
|
|
4460
|
+
/** @description Start from this cursor */
|
|
4461
|
+
cursor?: string;
|
|
4462
|
+
/** @description Start from this cursor */
|
|
4463
|
+
next?: string;
|
|
4464
|
+
/** @description Size of the results array */
|
|
4465
|
+
pageSize?: number;
|
|
4466
|
+
};
|
|
4467
|
+
header?: never;
|
|
4468
|
+
path: {
|
|
4469
|
+
team_id: string;
|
|
4470
|
+
user_id: string;
|
|
4471
|
+
};
|
|
4472
|
+
cookie?: never;
|
|
4473
|
+
};
|
|
4474
|
+
requestBody?: never;
|
|
4475
|
+
responses: {
|
|
4476
|
+
/** @description TeamMember */
|
|
4477
|
+
200: {
|
|
4478
|
+
headers: {
|
|
4479
|
+
[name: string]: unknown;
|
|
4480
|
+
};
|
|
4481
|
+
content: {
|
|
4482
|
+
"application/json": {
|
|
4483
|
+
/** @description TeamMember ID */
|
|
4484
|
+
id: string;
|
|
4485
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
4486
|
+
team: components["schemas"]["Team"] | string | unknown;
|
|
4487
|
+
roles: (components["schemas"]["Role"] | string | unknown)[];
|
|
4488
|
+
/** @description Object is related with this account */
|
|
4489
|
+
account: string;
|
|
4490
|
+
/**
|
|
4491
|
+
* @description TeamMemberMetadata
|
|
4492
|
+
* @default {}
|
|
4493
|
+
*/
|
|
4494
|
+
metadata: {
|
|
4495
|
+
[key: string]: unknown;
|
|
4496
|
+
};
|
|
4497
|
+
/** @description TeamMember creation date */
|
|
4498
|
+
createdAt: string;
|
|
4499
|
+
/** @description TeamMember updated date */
|
|
4500
|
+
updatedAt?: string;
|
|
4501
|
+
};
|
|
4502
|
+
};
|
|
4503
|
+
};
|
|
4504
|
+
};
|
|
4505
|
+
};
|
|
4506
|
+
"api/list": {
|
|
4507
|
+
parameters: {
|
|
4508
|
+
query?: {
|
|
4509
|
+
/** @description Start from this cursor */
|
|
4510
|
+
cursor?: string;
|
|
4511
|
+
/** @description Start from this cursor */
|
|
4512
|
+
next?: string;
|
|
4513
|
+
/** @description Size of the results array */
|
|
4514
|
+
pageSize?: number;
|
|
4515
|
+
/** @description Filter using a FaableQL query */
|
|
4516
|
+
query?: string;
|
|
4517
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
4518
|
+
expand?: string[];
|
|
4519
|
+
};
|
|
4520
|
+
header?: never;
|
|
4521
|
+
path?: never;
|
|
4522
|
+
cookie?: never;
|
|
4523
|
+
};
|
|
4524
|
+
requestBody?: never;
|
|
4525
|
+
responses: {
|
|
4526
|
+
/** @description PaginatedResponse */
|
|
4527
|
+
200: {
|
|
4528
|
+
headers: {
|
|
4529
|
+
[name: string]: unknown;
|
|
4530
|
+
};
|
|
4531
|
+
content: {
|
|
4532
|
+
"application/json": {
|
|
4533
|
+
/** @description next cursor */
|
|
4534
|
+
next: string | null;
|
|
4535
|
+
/** @description List of results */
|
|
4536
|
+
results: components["schemas"]["Api"][];
|
|
4537
|
+
};
|
|
4538
|
+
};
|
|
4539
|
+
};
|
|
4540
|
+
};
|
|
4541
|
+
};
|
|
4542
|
+
"api/create": {
|
|
4543
|
+
parameters: {
|
|
4544
|
+
query?: never;
|
|
4545
|
+
header?: never;
|
|
4546
|
+
path?: never;
|
|
4547
|
+
cookie?: never;
|
|
4548
|
+
};
|
|
4549
|
+
requestBody: {
|
|
4550
|
+
content: {
|
|
4551
|
+
"application/json": {
|
|
4552
|
+
name: string;
|
|
4553
|
+
description?: string;
|
|
4554
|
+
permissions: components["schemas"]["PermissionCreate"][];
|
|
4555
|
+
};
|
|
4556
|
+
};
|
|
4557
|
+
};
|
|
4558
|
+
responses: {
|
|
4559
|
+
/** @description Api */
|
|
4560
|
+
200: {
|
|
4561
|
+
headers: {
|
|
4562
|
+
[name: string]: unknown;
|
|
4563
|
+
};
|
|
4564
|
+
content: {
|
|
4565
|
+
"application/json": {
|
|
4566
|
+
/** @description Api ID */
|
|
4567
|
+
id: string;
|
|
4568
|
+
name: string;
|
|
4569
|
+
description?: string;
|
|
4570
|
+
permissions: components["schemas"]["Permission"][];
|
|
4571
|
+
/** @description Object is related with this account */
|
|
4572
|
+
account: string;
|
|
4573
|
+
/**
|
|
4574
|
+
* @description ApiMetadata
|
|
4575
|
+
* @default {}
|
|
4576
|
+
*/
|
|
4577
|
+
metadata: {
|
|
4578
|
+
[key: string]: unknown;
|
|
4579
|
+
};
|
|
4580
|
+
/** @description Api creation date */
|
|
4581
|
+
createdAt: string;
|
|
4582
|
+
/** @description Api updated date */
|
|
4583
|
+
updatedAt?: string;
|
|
4584
|
+
};
|
|
4585
|
+
};
|
|
4586
|
+
};
|
|
4587
|
+
};
|
|
4588
|
+
};
|
|
4589
|
+
"api/get": {
|
|
4590
|
+
parameters: {
|
|
4591
|
+
query?: {
|
|
4592
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
4593
|
+
expand?: string[];
|
|
4594
|
+
};
|
|
4595
|
+
header?: never;
|
|
4596
|
+
path: {
|
|
3751
4597
|
api_id: string;
|
|
3752
4598
|
};
|
|
3753
4599
|
cookie?: never;
|
|
@@ -3760,7 +4606,26 @@ export interface operations {
|
|
|
3760
4606
|
[name: string]: unknown;
|
|
3761
4607
|
};
|
|
3762
4608
|
content: {
|
|
3763
|
-
"application/json":
|
|
4609
|
+
"application/json": {
|
|
4610
|
+
/** @description Api ID */
|
|
4611
|
+
id: string;
|
|
4612
|
+
name: string;
|
|
4613
|
+
description?: string;
|
|
4614
|
+
permissions: components["schemas"]["Permission"][];
|
|
4615
|
+
/** @description Object is related with this account */
|
|
4616
|
+
account: string;
|
|
4617
|
+
/**
|
|
4618
|
+
* @description ApiMetadata
|
|
4619
|
+
* @default {}
|
|
4620
|
+
*/
|
|
4621
|
+
metadata: {
|
|
4622
|
+
[key: string]: unknown;
|
|
4623
|
+
};
|
|
4624
|
+
/** @description Api creation date */
|
|
4625
|
+
createdAt: string;
|
|
4626
|
+
/** @description Api updated date */
|
|
4627
|
+
updatedAt?: string;
|
|
4628
|
+
};
|
|
3764
4629
|
};
|
|
3765
4630
|
};
|
|
3766
4631
|
};
|
|
@@ -3785,6 +4650,41 @@ export interface operations {
|
|
|
3785
4650
|
};
|
|
3786
4651
|
};
|
|
3787
4652
|
};
|
|
4653
|
+
"account/rotateKeys": {
|
|
4654
|
+
parameters: {
|
|
4655
|
+
query?: never;
|
|
4656
|
+
header?: never;
|
|
4657
|
+
path?: never;
|
|
4658
|
+
cookie?: never;
|
|
4659
|
+
};
|
|
4660
|
+
requestBody: {
|
|
4661
|
+
content: {
|
|
4662
|
+
"application/json": Record<string, never>;
|
|
4663
|
+
};
|
|
4664
|
+
};
|
|
4665
|
+
responses: {
|
|
4666
|
+
/** @description Default Response */
|
|
4667
|
+
200: {
|
|
4668
|
+
headers: {
|
|
4669
|
+
[name: string]: unknown;
|
|
4670
|
+
};
|
|
4671
|
+
content: {
|
|
4672
|
+
"application/json": {
|
|
4673
|
+
/** @description ISO 8601 timestamp of the rotation */
|
|
4674
|
+
rotated_at: string;
|
|
4675
|
+
/** @description kid that was active before rotation. Tokens signed with it are still verifiable via /.well-known/jwks.json */
|
|
4676
|
+
previous_production_kid: string;
|
|
4677
|
+
/** @description kid now used to sign new tokens */
|
|
4678
|
+
production_kid: string;
|
|
4679
|
+
/** @description kid that will be promoted on the next rotation */
|
|
4680
|
+
next_in_queue_kid: string;
|
|
4681
|
+
/** @description All kids currently published in the JWK Set */
|
|
4682
|
+
kids_active: string[];
|
|
4683
|
+
};
|
|
4684
|
+
};
|
|
4685
|
+
};
|
|
4686
|
+
};
|
|
4687
|
+
};
|
|
3788
4688
|
"action/list": {
|
|
3789
4689
|
parameters: {
|
|
3790
4690
|
query?: {
|
|
@@ -3796,6 +4696,7 @@ export interface operations {
|
|
|
3796
4696
|
pageSize?: number;
|
|
3797
4697
|
/** @description Filter using a FaableQL query */
|
|
3798
4698
|
query?: string;
|
|
4699
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
3799
4700
|
expand?: string[];
|
|
3800
4701
|
};
|
|
3801
4702
|
header?: never;
|
|
@@ -3827,9 +4728,26 @@ export interface operations {
|
|
|
3827
4728
|
path?: never;
|
|
3828
4729
|
cookie?: never;
|
|
3829
4730
|
};
|
|
3830
|
-
requestBody
|
|
4731
|
+
requestBody: {
|
|
3831
4732
|
content: {
|
|
3832
|
-
"application/json":
|
|
4733
|
+
"application/json": {
|
|
4734
|
+
/** @description Action Name */
|
|
4735
|
+
name: string;
|
|
4736
|
+
/** @description Trigger event name (e.g., post-login) */
|
|
4737
|
+
trigger: string;
|
|
4738
|
+
/** @description JavaScript Code to execute */
|
|
4739
|
+
code?: string;
|
|
4740
|
+
/**
|
|
4741
|
+
* @description Is this action active?
|
|
4742
|
+
* @default true
|
|
4743
|
+
*/
|
|
4744
|
+
enabled?: boolean;
|
|
4745
|
+
/**
|
|
4746
|
+
* @description Execution order
|
|
4747
|
+
* @default 0
|
|
4748
|
+
*/
|
|
4749
|
+
order?: number;
|
|
4750
|
+
};
|
|
3833
4751
|
};
|
|
3834
4752
|
};
|
|
3835
4753
|
responses: {
|
|
@@ -3839,14 +4757,53 @@ export interface operations {
|
|
|
3839
4757
|
[name: string]: unknown;
|
|
3840
4758
|
};
|
|
3841
4759
|
content: {
|
|
3842
|
-
"application/json":
|
|
4760
|
+
"application/json": {
|
|
4761
|
+
/** @description Action ID */
|
|
4762
|
+
id: string;
|
|
4763
|
+
/** @description Action Name */
|
|
4764
|
+
name: string;
|
|
4765
|
+
/**
|
|
4766
|
+
* @description Trigger event name
|
|
4767
|
+
* @default post-login
|
|
4768
|
+
* @enum {unknown}
|
|
4769
|
+
*/
|
|
4770
|
+
trigger: "continue" | "post-login";
|
|
4771
|
+
/** @description JavaScript Code to execute */
|
|
4772
|
+
code: string;
|
|
4773
|
+
/**
|
|
4774
|
+
* @description Is this action active?
|
|
4775
|
+
* @default true
|
|
4776
|
+
*/
|
|
4777
|
+
enabled: boolean;
|
|
4778
|
+
/**
|
|
4779
|
+
* @description Execution order
|
|
4780
|
+
* @default 0
|
|
4781
|
+
*/
|
|
4782
|
+
order: number;
|
|
4783
|
+
/** @description Object is related with this account */
|
|
4784
|
+
account: string;
|
|
4785
|
+
/**
|
|
4786
|
+
* @description ActionMetadata
|
|
4787
|
+
* @default {}
|
|
4788
|
+
*/
|
|
4789
|
+
metadata: {
|
|
4790
|
+
[key: string]: unknown;
|
|
4791
|
+
};
|
|
4792
|
+
/** @description Action creation date */
|
|
4793
|
+
createdAt: string;
|
|
4794
|
+
/** @description Action updated date */
|
|
4795
|
+
updatedAt?: string;
|
|
4796
|
+
};
|
|
3843
4797
|
};
|
|
3844
4798
|
};
|
|
3845
4799
|
};
|
|
3846
4800
|
};
|
|
3847
4801
|
"action/get": {
|
|
3848
4802
|
parameters: {
|
|
3849
|
-
query?:
|
|
4803
|
+
query?: {
|
|
4804
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
4805
|
+
expand?: string[];
|
|
4806
|
+
};
|
|
3850
4807
|
header?: never;
|
|
3851
4808
|
path: {
|
|
3852
4809
|
action_id: string;
|
|
@@ -3861,7 +4818,43 @@ export interface operations {
|
|
|
3861
4818
|
[name: string]: unknown;
|
|
3862
4819
|
};
|
|
3863
4820
|
content: {
|
|
3864
|
-
"application/json":
|
|
4821
|
+
"application/json": {
|
|
4822
|
+
/** @description Action ID */
|
|
4823
|
+
id: string;
|
|
4824
|
+
/** @description Action Name */
|
|
4825
|
+
name: string;
|
|
4826
|
+
/**
|
|
4827
|
+
* @description Trigger event name
|
|
4828
|
+
* @default post-login
|
|
4829
|
+
* @enum {unknown}
|
|
4830
|
+
*/
|
|
4831
|
+
trigger: "continue" | "post-login";
|
|
4832
|
+
/** @description JavaScript Code to execute */
|
|
4833
|
+
code: string;
|
|
4834
|
+
/**
|
|
4835
|
+
* @description Is this action active?
|
|
4836
|
+
* @default true
|
|
4837
|
+
*/
|
|
4838
|
+
enabled: boolean;
|
|
4839
|
+
/**
|
|
4840
|
+
* @description Execution order
|
|
4841
|
+
* @default 0
|
|
4842
|
+
*/
|
|
4843
|
+
order: number;
|
|
4844
|
+
/** @description Object is related with this account */
|
|
4845
|
+
account: string;
|
|
4846
|
+
/**
|
|
4847
|
+
* @description ActionMetadata
|
|
4848
|
+
* @default {}
|
|
4849
|
+
*/
|
|
4850
|
+
metadata: {
|
|
4851
|
+
[key: string]: unknown;
|
|
4852
|
+
};
|
|
4853
|
+
/** @description Action creation date */
|
|
4854
|
+
createdAt: string;
|
|
4855
|
+
/** @description Action updated date */
|
|
4856
|
+
updatedAt?: string;
|
|
4857
|
+
};
|
|
3865
4858
|
};
|
|
3866
4859
|
};
|
|
3867
4860
|
};
|
|
@@ -3897,6 +4890,7 @@ export interface operations {
|
|
|
3897
4890
|
pageSize?: number;
|
|
3898
4891
|
/** @description Filter using a FaableQL query */
|
|
3899
4892
|
query?: string;
|
|
4893
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
3900
4894
|
expand?: string[];
|
|
3901
4895
|
};
|
|
3902
4896
|
header?: never;
|
|
@@ -3928,9 +4922,42 @@ export interface operations {
|
|
|
3928
4922
|
path?: never;
|
|
3929
4923
|
cookie?: never;
|
|
3930
4924
|
};
|
|
3931
|
-
|
|
4925
|
+
/** @description NotificationSubscriptionCreate */
|
|
4926
|
+
requestBody: {
|
|
3932
4927
|
content: {
|
|
3933
|
-
"application/json":
|
|
4928
|
+
"application/json": {
|
|
4929
|
+
events: string[];
|
|
4930
|
+
/** @enum {string} */
|
|
4931
|
+
channel: "email";
|
|
4932
|
+
/** @description Whether the subscription is active */
|
|
4933
|
+
active?: boolean;
|
|
4934
|
+
config: {
|
|
4935
|
+
recipients: string[];
|
|
4936
|
+
};
|
|
4937
|
+
/** @description Add Metadata */
|
|
4938
|
+
metadata?: {
|
|
4939
|
+
[key: string]: unknown;
|
|
4940
|
+
};
|
|
4941
|
+
} | {
|
|
4942
|
+
events: string[];
|
|
4943
|
+
/** @enum {string} */
|
|
4944
|
+
channel: "webhook";
|
|
4945
|
+
/** @description Whether the subscription is active */
|
|
4946
|
+
active?: boolean;
|
|
4947
|
+
config: {
|
|
4948
|
+
/**
|
|
4949
|
+
* Format: uri
|
|
4950
|
+
* @description Webhook URL
|
|
4951
|
+
*/
|
|
4952
|
+
url: string;
|
|
4953
|
+
/** @description Secret used to sign the webhook payload */
|
|
4954
|
+
secret: string;
|
|
4955
|
+
};
|
|
4956
|
+
/** @description Add Metadata */
|
|
4957
|
+
metadata?: {
|
|
4958
|
+
[key: string]: unknown;
|
|
4959
|
+
};
|
|
4960
|
+
};
|
|
3934
4961
|
};
|
|
3935
4962
|
};
|
|
3936
4963
|
responses: {
|
|
@@ -3940,14 +4967,71 @@ export interface operations {
|
|
|
3940
4967
|
[name: string]: unknown;
|
|
3941
4968
|
};
|
|
3942
4969
|
content: {
|
|
3943
|
-
"application/json":
|
|
4970
|
+
"application/json": {
|
|
4971
|
+
/** @description NotificationSubscriptionEmail ID */
|
|
4972
|
+
id: string;
|
|
4973
|
+
events: string[];
|
|
4974
|
+
/** @enum {string} */
|
|
4975
|
+
channel: "email";
|
|
4976
|
+
/** @description Whether the subscription is active */
|
|
4977
|
+
active: boolean;
|
|
4978
|
+
config: {
|
|
4979
|
+
recipients: string[];
|
|
4980
|
+
};
|
|
4981
|
+
/** @description Object is related with this account */
|
|
4982
|
+
account: string;
|
|
4983
|
+
/**
|
|
4984
|
+
* @description NotificationSubscriptionEmailMetadata
|
|
4985
|
+
* @default {}
|
|
4986
|
+
*/
|
|
4987
|
+
metadata: {
|
|
4988
|
+
[key: string]: unknown;
|
|
4989
|
+
};
|
|
4990
|
+
/** @description NotificationSubscriptionEmail creation date */
|
|
4991
|
+
createdAt: string;
|
|
4992
|
+
/** @description NotificationSubscriptionEmail updated date */
|
|
4993
|
+
updatedAt?: string;
|
|
4994
|
+
} | {
|
|
4995
|
+
/** @description NotificationSubscriptionWebhook ID */
|
|
4996
|
+
id: string;
|
|
4997
|
+
events: string[];
|
|
4998
|
+
/** @enum {string} */
|
|
4999
|
+
channel: "webhook";
|
|
5000
|
+
/** @description Whether the subscription is active */
|
|
5001
|
+
active: boolean;
|
|
5002
|
+
config: {
|
|
5003
|
+
/**
|
|
5004
|
+
* Format: uri
|
|
5005
|
+
* @description Webhook URL
|
|
5006
|
+
*/
|
|
5007
|
+
url: string;
|
|
5008
|
+
/** @description Secret used to sign the webhook payload */
|
|
5009
|
+
secret: string;
|
|
5010
|
+
};
|
|
5011
|
+
/** @description Object is related with this account */
|
|
5012
|
+
account: string;
|
|
5013
|
+
/**
|
|
5014
|
+
* @description NotificationSubscriptionWebhookMetadata
|
|
5015
|
+
* @default {}
|
|
5016
|
+
*/
|
|
5017
|
+
metadata: {
|
|
5018
|
+
[key: string]: unknown;
|
|
5019
|
+
};
|
|
5020
|
+
/** @description NotificationSubscriptionWebhook creation date */
|
|
5021
|
+
createdAt: string;
|
|
5022
|
+
/** @description NotificationSubscriptionWebhook updated date */
|
|
5023
|
+
updatedAt?: string;
|
|
5024
|
+
};
|
|
3944
5025
|
};
|
|
3945
5026
|
};
|
|
3946
5027
|
};
|
|
3947
5028
|
};
|
|
3948
5029
|
"notificationsubscription/get": {
|
|
3949
5030
|
parameters: {
|
|
3950
|
-
query?:
|
|
5031
|
+
query?: {
|
|
5032
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
5033
|
+
expand?: string[];
|
|
5034
|
+
};
|
|
3951
5035
|
header?: never;
|
|
3952
5036
|
path: {
|
|
3953
5037
|
notificationsubscription_id: string;
|
|
@@ -3962,7 +5046,61 @@ export interface operations {
|
|
|
3962
5046
|
[name: string]: unknown;
|
|
3963
5047
|
};
|
|
3964
5048
|
content: {
|
|
3965
|
-
"application/json":
|
|
5049
|
+
"application/json": {
|
|
5050
|
+
/** @description NotificationSubscriptionEmail ID */
|
|
5051
|
+
id: string;
|
|
5052
|
+
events: string[];
|
|
5053
|
+
/** @enum {string} */
|
|
5054
|
+
channel: "email";
|
|
5055
|
+
/** @description Whether the subscription is active */
|
|
5056
|
+
active: boolean;
|
|
5057
|
+
config: {
|
|
5058
|
+
recipients: string[];
|
|
5059
|
+
};
|
|
5060
|
+
/** @description Object is related with this account */
|
|
5061
|
+
account: string;
|
|
5062
|
+
/**
|
|
5063
|
+
* @description NotificationSubscriptionEmailMetadata
|
|
5064
|
+
* @default {}
|
|
5065
|
+
*/
|
|
5066
|
+
metadata: {
|
|
5067
|
+
[key: string]: unknown;
|
|
5068
|
+
};
|
|
5069
|
+
/** @description NotificationSubscriptionEmail creation date */
|
|
5070
|
+
createdAt: string;
|
|
5071
|
+
/** @description NotificationSubscriptionEmail updated date */
|
|
5072
|
+
updatedAt?: string;
|
|
5073
|
+
} | {
|
|
5074
|
+
/** @description NotificationSubscriptionWebhook ID */
|
|
5075
|
+
id: string;
|
|
5076
|
+
events: string[];
|
|
5077
|
+
/** @enum {string} */
|
|
5078
|
+
channel: "webhook";
|
|
5079
|
+
/** @description Whether the subscription is active */
|
|
5080
|
+
active: boolean;
|
|
5081
|
+
config: {
|
|
5082
|
+
/**
|
|
5083
|
+
* Format: uri
|
|
5084
|
+
* @description Webhook URL
|
|
5085
|
+
*/
|
|
5086
|
+
url: string;
|
|
5087
|
+
/** @description Secret used to sign the webhook payload */
|
|
5088
|
+
secret: string;
|
|
5089
|
+
};
|
|
5090
|
+
/** @description Object is related with this account */
|
|
5091
|
+
account: string;
|
|
5092
|
+
/**
|
|
5093
|
+
* @description NotificationSubscriptionWebhookMetadata
|
|
5094
|
+
* @default {}
|
|
5095
|
+
*/
|
|
5096
|
+
metadata: {
|
|
5097
|
+
[key: string]: unknown;
|
|
5098
|
+
};
|
|
5099
|
+
/** @description NotificationSubscriptionWebhook creation date */
|
|
5100
|
+
createdAt: string;
|
|
5101
|
+
/** @description NotificationSubscriptionWebhook updated date */
|
|
5102
|
+
updatedAt?: string;
|
|
5103
|
+
};
|
|
3966
5104
|
};
|
|
3967
5105
|
};
|
|
3968
5106
|
};
|
|
@@ -3976,9 +5114,42 @@ export interface operations {
|
|
|
3976
5114
|
};
|
|
3977
5115
|
cookie?: never;
|
|
3978
5116
|
};
|
|
3979
|
-
|
|
5117
|
+
/** @description NotificationSubscriptionUpdate */
|
|
5118
|
+
requestBody: {
|
|
3980
5119
|
content: {
|
|
3981
|
-
"application/json":
|
|
5120
|
+
"application/json": {
|
|
5121
|
+
events?: string[];
|
|
5122
|
+
/** @enum {string} */
|
|
5123
|
+
channel?: "email";
|
|
5124
|
+
/** @description Whether the subscription is active */
|
|
5125
|
+
active?: boolean;
|
|
5126
|
+
config?: {
|
|
5127
|
+
recipients?: string[];
|
|
5128
|
+
};
|
|
5129
|
+
/** @description Metadata update */
|
|
5130
|
+
metadata?: {
|
|
5131
|
+
[key: string]: unknown;
|
|
5132
|
+
};
|
|
5133
|
+
} | {
|
|
5134
|
+
events?: string[];
|
|
5135
|
+
/** @enum {string} */
|
|
5136
|
+
channel?: "webhook";
|
|
5137
|
+
/** @description Whether the subscription is active */
|
|
5138
|
+
active?: boolean;
|
|
5139
|
+
config?: {
|
|
5140
|
+
/**
|
|
5141
|
+
* Format: uri
|
|
5142
|
+
* @description Webhook URL
|
|
5143
|
+
*/
|
|
5144
|
+
url?: string;
|
|
5145
|
+
/** @description Secret used to sign the webhook payload */
|
|
5146
|
+
secret?: string;
|
|
5147
|
+
};
|
|
5148
|
+
/** @description Metadata update */
|
|
5149
|
+
metadata?: {
|
|
5150
|
+
[key: string]: unknown;
|
|
5151
|
+
};
|
|
5152
|
+
};
|
|
3982
5153
|
};
|
|
3983
5154
|
};
|
|
3984
5155
|
responses: {
|
|
@@ -3988,7 +5159,61 @@ export interface operations {
|
|
|
3988
5159
|
[name: string]: unknown;
|
|
3989
5160
|
};
|
|
3990
5161
|
content: {
|
|
3991
|
-
"application/json":
|
|
5162
|
+
"application/json": {
|
|
5163
|
+
/** @description NotificationSubscriptionEmail ID */
|
|
5164
|
+
id: string;
|
|
5165
|
+
events: string[];
|
|
5166
|
+
/** @enum {string} */
|
|
5167
|
+
channel: "email";
|
|
5168
|
+
/** @description Whether the subscription is active */
|
|
5169
|
+
active: boolean;
|
|
5170
|
+
config: {
|
|
5171
|
+
recipients: string[];
|
|
5172
|
+
};
|
|
5173
|
+
/** @description Object is related with this account */
|
|
5174
|
+
account: string;
|
|
5175
|
+
/**
|
|
5176
|
+
* @description NotificationSubscriptionEmailMetadata
|
|
5177
|
+
* @default {}
|
|
5178
|
+
*/
|
|
5179
|
+
metadata: {
|
|
5180
|
+
[key: string]: unknown;
|
|
5181
|
+
};
|
|
5182
|
+
/** @description NotificationSubscriptionEmail creation date */
|
|
5183
|
+
createdAt: string;
|
|
5184
|
+
/** @description NotificationSubscriptionEmail updated date */
|
|
5185
|
+
updatedAt?: string;
|
|
5186
|
+
} | {
|
|
5187
|
+
/** @description NotificationSubscriptionWebhook ID */
|
|
5188
|
+
id: string;
|
|
5189
|
+
events: string[];
|
|
5190
|
+
/** @enum {string} */
|
|
5191
|
+
channel: "webhook";
|
|
5192
|
+
/** @description Whether the subscription is active */
|
|
5193
|
+
active: boolean;
|
|
5194
|
+
config: {
|
|
5195
|
+
/**
|
|
5196
|
+
* Format: uri
|
|
5197
|
+
* @description Webhook URL
|
|
5198
|
+
*/
|
|
5199
|
+
url: string;
|
|
5200
|
+
/** @description Secret used to sign the webhook payload */
|
|
5201
|
+
secret: string;
|
|
5202
|
+
};
|
|
5203
|
+
/** @description Object is related with this account */
|
|
5204
|
+
account: string;
|
|
5205
|
+
/**
|
|
5206
|
+
* @description NotificationSubscriptionWebhookMetadata
|
|
5207
|
+
* @default {}
|
|
5208
|
+
*/
|
|
5209
|
+
metadata: {
|
|
5210
|
+
[key: string]: unknown;
|
|
5211
|
+
};
|
|
5212
|
+
/** @description NotificationSubscriptionWebhook creation date */
|
|
5213
|
+
createdAt: string;
|
|
5214
|
+
/** @description NotificationSubscriptionWebhook updated date */
|
|
5215
|
+
updatedAt?: string;
|
|
5216
|
+
};
|
|
3992
5217
|
};
|
|
3993
5218
|
};
|
|
3994
5219
|
};
|
|
@@ -4013,12 +5238,97 @@ export interface operations {
|
|
|
4013
5238
|
};
|
|
4014
5239
|
};
|
|
4015
5240
|
};
|
|
5241
|
+
"log/list": {
|
|
5242
|
+
parameters: {
|
|
5243
|
+
query?: {
|
|
5244
|
+
/** @description Start from this cursor */
|
|
5245
|
+
cursor?: string;
|
|
5246
|
+
/** @description Start from this cursor */
|
|
5247
|
+
next?: string;
|
|
5248
|
+
/** @description Size of the results array */
|
|
5249
|
+
pageSize?: number;
|
|
5250
|
+
/** @description Filter using a FaableQL query */
|
|
5251
|
+
query?: string;
|
|
5252
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
5253
|
+
expand?: string[];
|
|
5254
|
+
};
|
|
5255
|
+
header?: never;
|
|
5256
|
+
path?: never;
|
|
5257
|
+
cookie?: never;
|
|
5258
|
+
};
|
|
5259
|
+
requestBody?: never;
|
|
5260
|
+
responses: {
|
|
5261
|
+
/** @description PaginatedResponse */
|
|
5262
|
+
200: {
|
|
5263
|
+
headers: {
|
|
5264
|
+
[name: string]: unknown;
|
|
5265
|
+
};
|
|
5266
|
+
content: {
|
|
5267
|
+
"application/json": {
|
|
5268
|
+
/** @description next cursor */
|
|
5269
|
+
next: string | null;
|
|
5270
|
+
/** @description List of results */
|
|
5271
|
+
results: components["schemas"]["Log"][];
|
|
5272
|
+
};
|
|
5273
|
+
};
|
|
5274
|
+
};
|
|
5275
|
+
};
|
|
5276
|
+
};
|
|
5277
|
+
"log/get": {
|
|
5278
|
+
parameters: {
|
|
5279
|
+
query?: {
|
|
5280
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
5281
|
+
expand?: string[];
|
|
5282
|
+
};
|
|
5283
|
+
header?: never;
|
|
5284
|
+
path: {
|
|
5285
|
+
log_id: string;
|
|
5286
|
+
};
|
|
5287
|
+
cookie?: never;
|
|
5288
|
+
};
|
|
5289
|
+
requestBody?: never;
|
|
5290
|
+
responses: {
|
|
5291
|
+
/** @description Log */
|
|
5292
|
+
200: {
|
|
5293
|
+
headers: {
|
|
5294
|
+
[name: string]: unknown;
|
|
5295
|
+
};
|
|
5296
|
+
content: {
|
|
5297
|
+
"application/json": {
|
|
5298
|
+
/** @description Log ID */
|
|
5299
|
+
id: string;
|
|
5300
|
+
/** @description Log type, e.g. email.user.created */
|
|
5301
|
+
type: string;
|
|
5302
|
+
/** @description Log status */
|
|
5303
|
+
status: "success" | "failed" | "skipped" | "info";
|
|
5304
|
+
/** @description Optional log message */
|
|
5305
|
+
message?: string;
|
|
5306
|
+
/** @description Type-specific structured payload */
|
|
5307
|
+
data?: unknown;
|
|
5308
|
+
/** @description Object is related with this account */
|
|
5309
|
+
account: string;
|
|
5310
|
+
/**
|
|
5311
|
+
* @description LogMetadata
|
|
5312
|
+
* @default {}
|
|
5313
|
+
*/
|
|
5314
|
+
metadata: {
|
|
5315
|
+
[key: string]: unknown;
|
|
5316
|
+
};
|
|
5317
|
+
/** @description Log creation date */
|
|
5318
|
+
createdAt: string;
|
|
5319
|
+
/** @description Log updated date */
|
|
5320
|
+
updatedAt?: string;
|
|
5321
|
+
};
|
|
5322
|
+
};
|
|
5323
|
+
};
|
|
5324
|
+
};
|
|
5325
|
+
};
|
|
4016
5326
|
"customdomain/retry": {
|
|
4017
5327
|
parameters: {
|
|
4018
5328
|
query?: never;
|
|
4019
5329
|
header?: never;
|
|
4020
5330
|
path: {
|
|
4021
|
-
|
|
5331
|
+
customdomain_id: string;
|
|
4022
5332
|
};
|
|
4023
5333
|
cookie?: never;
|
|
4024
5334
|
};
|
|
@@ -4044,6 +5354,7 @@ export interface operations {
|
|
|
4044
5354
|
pageSize?: number;
|
|
4045
5355
|
/** @description Filter using a FaableQL query */
|
|
4046
5356
|
query?: string;
|
|
5357
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
4047
5358
|
expand?: string[];
|
|
4048
5359
|
};
|
|
4049
5360
|
header?: never;
|
|
@@ -4075,9 +5386,16 @@ export interface operations {
|
|
|
4075
5386
|
path?: never;
|
|
4076
5387
|
cookie?: never;
|
|
4077
5388
|
};
|
|
4078
|
-
|
|
5389
|
+
/** @description CustomdomainCreate */
|
|
5390
|
+
requestBody: {
|
|
4079
5391
|
content: {
|
|
4080
|
-
"application/json":
|
|
5392
|
+
"application/json": {
|
|
5393
|
+
domain: string;
|
|
5394
|
+
/** @description Add Metadata */
|
|
5395
|
+
metadata?: {
|
|
5396
|
+
[key: string]: unknown;
|
|
5397
|
+
};
|
|
5398
|
+
};
|
|
4081
5399
|
};
|
|
4082
5400
|
};
|
|
4083
5401
|
responses: {
|
|
@@ -4087,14 +5405,46 @@ export interface operations {
|
|
|
4087
5405
|
[name: string]: unknown;
|
|
4088
5406
|
};
|
|
4089
5407
|
content: {
|
|
4090
|
-
"application/json":
|
|
5408
|
+
"application/json": {
|
|
5409
|
+
/** @description Customdomain ID */
|
|
5410
|
+
id: string;
|
|
5411
|
+
domain: string;
|
|
5412
|
+
token: string;
|
|
5413
|
+
/** @enum {unknown} */
|
|
5414
|
+
status: "PENDING" | "VERIFYING" | "ACTIVE" | "FAILED" | "DEGRADED";
|
|
5415
|
+
attempts: number;
|
|
5416
|
+
/** Format: date-time */
|
|
5417
|
+
nextCheck?: string;
|
|
5418
|
+
/** Format: date-time */
|
|
5419
|
+
lastCheck?: string;
|
|
5420
|
+
/** @description User feedback error from last check */
|
|
5421
|
+
errorLog?: string;
|
|
5422
|
+
/** Format: date-time */
|
|
5423
|
+
verifiedAt?: string;
|
|
5424
|
+
/** @description Object is related with this account */
|
|
5425
|
+
account: string;
|
|
5426
|
+
/**
|
|
5427
|
+
* @description CustomdomainMetadata
|
|
5428
|
+
* @default {}
|
|
5429
|
+
*/
|
|
5430
|
+
metadata: {
|
|
5431
|
+
[key: string]: unknown;
|
|
5432
|
+
};
|
|
5433
|
+
/** @description Customdomain creation date */
|
|
5434
|
+
createdAt: string;
|
|
5435
|
+
/** @description Customdomain updated date */
|
|
5436
|
+
updatedAt?: string;
|
|
5437
|
+
};
|
|
4091
5438
|
};
|
|
4092
5439
|
};
|
|
4093
5440
|
};
|
|
4094
5441
|
};
|
|
4095
5442
|
"customdomain/get": {
|
|
4096
5443
|
parameters: {
|
|
4097
|
-
query?:
|
|
5444
|
+
query?: {
|
|
5445
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `expand=user&expand=team`). */
|
|
5446
|
+
expand?: string[];
|
|
5447
|
+
};
|
|
4098
5448
|
header?: never;
|
|
4099
5449
|
path: {
|
|
4100
5450
|
customdomain_id: string;
|
|
@@ -4109,7 +5459,36 @@ export interface operations {
|
|
|
4109
5459
|
[name: string]: unknown;
|
|
4110
5460
|
};
|
|
4111
5461
|
content: {
|
|
4112
|
-
"application/json":
|
|
5462
|
+
"application/json": {
|
|
5463
|
+
/** @description Customdomain ID */
|
|
5464
|
+
id: string;
|
|
5465
|
+
domain: string;
|
|
5466
|
+
token: string;
|
|
5467
|
+
/** @enum {unknown} */
|
|
5468
|
+
status: "PENDING" | "VERIFYING" | "ACTIVE" | "FAILED" | "DEGRADED";
|
|
5469
|
+
attempts: number;
|
|
5470
|
+
/** Format: date-time */
|
|
5471
|
+
nextCheck?: string;
|
|
5472
|
+
/** Format: date-time */
|
|
5473
|
+
lastCheck?: string;
|
|
5474
|
+
/** @description User feedback error from last check */
|
|
5475
|
+
errorLog?: string;
|
|
5476
|
+
/** Format: date-time */
|
|
5477
|
+
verifiedAt?: string;
|
|
5478
|
+
/** @description Object is related with this account */
|
|
5479
|
+
account: string;
|
|
5480
|
+
/**
|
|
5481
|
+
* @description CustomdomainMetadata
|
|
5482
|
+
* @default {}
|
|
5483
|
+
*/
|
|
5484
|
+
metadata: {
|
|
5485
|
+
[key: string]: unknown;
|
|
5486
|
+
};
|
|
5487
|
+
/** @description Customdomain creation date */
|
|
5488
|
+
createdAt: string;
|
|
5489
|
+
/** @description Customdomain updated date */
|
|
5490
|
+
updatedAt?: string;
|
|
5491
|
+
};
|
|
4113
5492
|
};
|
|
4114
5493
|
};
|
|
4115
5494
|
};
|
|
@@ -4184,9 +5563,149 @@ export interface operations {
|
|
|
4184
5563
|
};
|
|
4185
5564
|
};
|
|
4186
5565
|
};
|
|
4187
|
-
|
|
5566
|
+
"session/me": {
|
|
4188
5567
|
parameters: {
|
|
4189
|
-
query
|
|
5568
|
+
query?: never;
|
|
5569
|
+
header?: never;
|
|
5570
|
+
path?: never;
|
|
5571
|
+
cookie?: never;
|
|
5572
|
+
};
|
|
5573
|
+
requestBody?: never;
|
|
5574
|
+
responses: {
|
|
5575
|
+
/** @description User */
|
|
5576
|
+
200: {
|
|
5577
|
+
headers: {
|
|
5578
|
+
[name: string]: unknown;
|
|
5579
|
+
};
|
|
5580
|
+
content: {
|
|
5581
|
+
"application/json": {
|
|
5582
|
+
/** @description User ID */
|
|
5583
|
+
id: string;
|
|
5584
|
+
/** @description User name */
|
|
5585
|
+
name?: string | null;
|
|
5586
|
+
/** @description unique username for this user */
|
|
5587
|
+
username?: string | null;
|
|
5588
|
+
/** @description Given name */
|
|
5589
|
+
given_name?: string | null;
|
|
5590
|
+
/** @description Family name */
|
|
5591
|
+
family_name?: string | null;
|
|
5592
|
+
/** @description Middle name (OIDC §5.1) */
|
|
5593
|
+
middle_name?: string | null;
|
|
5594
|
+
/** @description Casual name. Distinct from given_name (e.g. "Mike" vs "Michael"). OIDC §5.1 */
|
|
5595
|
+
nickname?: string | null;
|
|
5596
|
+
/** @description User email */
|
|
5597
|
+
email?: string | null;
|
|
5598
|
+
/**
|
|
5599
|
+
* @description true if email is verified
|
|
5600
|
+
* @default false
|
|
5601
|
+
*/
|
|
5602
|
+
email_verified: boolean;
|
|
5603
|
+
/** @description contact phone number */
|
|
5604
|
+
phone?: string | null;
|
|
5605
|
+
/** @description phone is verified */
|
|
5606
|
+
phone_verified: boolean;
|
|
5607
|
+
/** @description country iso code */
|
|
5608
|
+
country_iso?: string | null;
|
|
5609
|
+
/** @description user birth_date */
|
|
5610
|
+
birth_date?: string | null;
|
|
5611
|
+
/** @description User gender (free-form, OIDC §5.1) */
|
|
5612
|
+
gender?: string | null;
|
|
5613
|
+
/** @description IANA time-zone name (e.g. "Europe/Madrid"). OIDC §5.1 — used for the `zoneinfo` claim. */
|
|
5614
|
+
zoneinfo?: string | null;
|
|
5615
|
+
/** @description user main language */
|
|
5616
|
+
locale?: string;
|
|
5617
|
+
/** @description customer region */
|
|
5618
|
+
region?: string | null;
|
|
5619
|
+
/** @description URL of the User's personal Web page or blog (OIDC §5.1) */
|
|
5620
|
+
website?: string | null;
|
|
5621
|
+
address?: {
|
|
5622
|
+
/** @description Full mailing address, formatted for display (may contain newlines) */
|
|
5623
|
+
formatted?: string | null;
|
|
5624
|
+
street_address?: string | null;
|
|
5625
|
+
/** @description City or locality */
|
|
5626
|
+
locality?: string | null;
|
|
5627
|
+
/** @description State, province, or region */
|
|
5628
|
+
region?: string | null;
|
|
5629
|
+
postal_code?: string | null;
|
|
5630
|
+
/** @description Country name */
|
|
5631
|
+
country?: string | null;
|
|
5632
|
+
} | null;
|
|
5633
|
+
/** @description User picture url */
|
|
5634
|
+
picture?: string | null;
|
|
5635
|
+
/** @description Total number of logins this user has performed. */
|
|
5636
|
+
logins_count: number;
|
|
5637
|
+
/** @description Last IP address from which this user logged in */
|
|
5638
|
+
last_ip?: string | null;
|
|
5639
|
+
/** @description Last date and time this user logged in (ISO_8601 format) */
|
|
5640
|
+
last_login?: string | null;
|
|
5641
|
+
/**
|
|
5642
|
+
* @description User Metadata
|
|
5643
|
+
* @default {}
|
|
5644
|
+
*/
|
|
5645
|
+
user_metadata: {
|
|
5646
|
+
[key: string]: unknown;
|
|
5647
|
+
};
|
|
5648
|
+
/**
|
|
5649
|
+
* @description App Metadata
|
|
5650
|
+
* @default {}
|
|
5651
|
+
*/
|
|
5652
|
+
app_metadata: {
|
|
5653
|
+
[key: string]: unknown;
|
|
5654
|
+
};
|
|
5655
|
+
/** @description Object is related with this account */
|
|
5656
|
+
account: string;
|
|
5657
|
+
/**
|
|
5658
|
+
* @description UserMetadata
|
|
5659
|
+
* @default {}
|
|
5660
|
+
*/
|
|
5661
|
+
metadata: {
|
|
5662
|
+
[key: string]: unknown;
|
|
5663
|
+
};
|
|
5664
|
+
/** @description User creation date */
|
|
5665
|
+
createdAt: string;
|
|
5666
|
+
/** @description User updated date */
|
|
5667
|
+
updatedAt?: string;
|
|
5668
|
+
};
|
|
5669
|
+
};
|
|
5670
|
+
};
|
|
5671
|
+
};
|
|
5672
|
+
};
|
|
5673
|
+
"session/logout": {
|
|
5674
|
+
parameters: {
|
|
5675
|
+
query?: {
|
|
5676
|
+
/** @description Previously issued id_token. RECOMMENDED per OIDC §3 — used to identify the client/session being logged out. */
|
|
5677
|
+
id_token_hint?: string;
|
|
5678
|
+
/** @description Hint about the End-User that is logging out (e.g. session id, email). Provider-specific. */
|
|
5679
|
+
logout_hint?: string;
|
|
5680
|
+
/** @description OAuth Client identifier. Derived from `id_token_hint.aud` if omitted. */
|
|
5681
|
+
client_id?: string;
|
|
5682
|
+
/** @description URL to redirect the User to after logout. MUST be pre-registered in the client `logout_urls` (exact match). */
|
|
5683
|
+
post_logout_redirect_uri?: string;
|
|
5684
|
+
/** @description Opaque value echoed back as `state` query param on the post-logout redirect, to mitigate CSRF. */
|
|
5685
|
+
state?: string;
|
|
5686
|
+
/** @description Space-separated list of preferred UI languages. */
|
|
5687
|
+
ui_locales?: string;
|
|
5688
|
+
/** @description Deprecated alias of `post_logout_redirect_uri`. Kept for backwards compatibility. */
|
|
5689
|
+
returnTo?: string;
|
|
5690
|
+
};
|
|
5691
|
+
header?: never;
|
|
5692
|
+
path?: never;
|
|
5693
|
+
cookie?: never;
|
|
5694
|
+
};
|
|
5695
|
+
requestBody?: never;
|
|
5696
|
+
responses: {
|
|
5697
|
+
/** @description Default Response */
|
|
5698
|
+
200: {
|
|
5699
|
+
headers: {
|
|
5700
|
+
[name: string]: unknown;
|
|
5701
|
+
};
|
|
5702
|
+
content?: never;
|
|
5703
|
+
};
|
|
5704
|
+
};
|
|
5705
|
+
};
|
|
5706
|
+
authorize: {
|
|
5707
|
+
parameters: {
|
|
5708
|
+
query: {
|
|
4190
5709
|
response_type?: string;
|
|
4191
5710
|
/** @description Challenge method for PKCE. Only S256 is supported. */
|
|
4192
5711
|
code_challenge_method?: string;
|
|
@@ -4202,6 +5721,10 @@ export interface operations {
|
|
|
4202
5721
|
redirect_uri?: string;
|
|
4203
5722
|
/** @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
5723
|
state?: string;
|
|
5724
|
+
/** @description OIDC §3.1.2.1 — string value used to associate a Client session with an ID Token, to mitigate replay attacks. If passed at /authorize, the same value MUST appear in the issued id_token. */
|
|
5725
|
+
nonce?: string;
|
|
5726
|
+
/** @description OIDC §3.1.2.1 — maximum allowable elapsed time in seconds since the last End-User authentication. If exceeded, the OP re-authenticates and `auth_time` is REQUIRED in the resulting id_token. */
|
|
5727
|
+
max_age?: number;
|
|
4205
5728
|
prompt?: string;
|
|
4206
5729
|
};
|
|
4207
5730
|
header?: never;
|
|
@@ -4219,7 +5742,112 @@ export interface operations {
|
|
|
4219
5742
|
};
|
|
4220
5743
|
};
|
|
4221
5744
|
};
|
|
4222
|
-
"
|
|
5745
|
+
"oauth/tokenGet": {
|
|
5746
|
+
parameters: {
|
|
5747
|
+
query?: {
|
|
5748
|
+
/** @description Grant Type. https://oauth.net/2/grant-types/ */
|
|
5749
|
+
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";
|
|
5750
|
+
client_id?: string;
|
|
5751
|
+
client_secret?: string;
|
|
5752
|
+
scope?: string;
|
|
5753
|
+
code?: string;
|
|
5754
|
+
code_verifier?: string;
|
|
5755
|
+
username?: string;
|
|
5756
|
+
otp?: string;
|
|
5757
|
+
refresh_token?: string;
|
|
5758
|
+
subject_token?: string;
|
|
5759
|
+
subject_token_type?: string;
|
|
5760
|
+
/** @description The device code returned by the authorization server. */
|
|
5761
|
+
device_code?: string;
|
|
5762
|
+
};
|
|
5763
|
+
header?: never;
|
|
5764
|
+
path?: never;
|
|
5765
|
+
cookie?: never;
|
|
5766
|
+
};
|
|
5767
|
+
requestBody?: never;
|
|
5768
|
+
responses: {
|
|
5769
|
+
/** @description Default Response */
|
|
5770
|
+
200: {
|
|
5771
|
+
headers: {
|
|
5772
|
+
[name: string]: unknown;
|
|
5773
|
+
};
|
|
5774
|
+
content: {
|
|
5775
|
+
"application/json": {
|
|
5776
|
+
token_type: string;
|
|
5777
|
+
expires_in: number;
|
|
5778
|
+
access_token: string;
|
|
5779
|
+
refresh_token?: string;
|
|
5780
|
+
id_token?: string;
|
|
5781
|
+
scope?: string;
|
|
5782
|
+
};
|
|
5783
|
+
};
|
|
5784
|
+
};
|
|
5785
|
+
};
|
|
5786
|
+
};
|
|
5787
|
+
"oauth/token": {
|
|
5788
|
+
parameters: {
|
|
5789
|
+
query?: {
|
|
5790
|
+
/** @description Grant Type. https://oauth.net/2/grant-types/ */
|
|
5791
|
+
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";
|
|
5792
|
+
client_id?: string;
|
|
5793
|
+
client_secret?: string;
|
|
5794
|
+
scope?: string;
|
|
5795
|
+
code?: string;
|
|
5796
|
+
code_verifier?: string;
|
|
5797
|
+
username?: string;
|
|
5798
|
+
otp?: string;
|
|
5799
|
+
refresh_token?: string;
|
|
5800
|
+
subject_token?: string;
|
|
5801
|
+
subject_token_type?: string;
|
|
5802
|
+
/** @description The device code returned by the authorization server. */
|
|
5803
|
+
device_code?: string;
|
|
5804
|
+
};
|
|
5805
|
+
header?: never;
|
|
5806
|
+
path?: never;
|
|
5807
|
+
cookie?: never;
|
|
5808
|
+
};
|
|
5809
|
+
requestBody: {
|
|
5810
|
+
content: {
|
|
5811
|
+
"application/json": {
|
|
5812
|
+
/** @description Grant Type. https://oauth.net/2/grant-types/ */
|
|
5813
|
+
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";
|
|
5814
|
+
client_id?: string;
|
|
5815
|
+
client_secret?: string;
|
|
5816
|
+
scope?: string;
|
|
5817
|
+
code?: string;
|
|
5818
|
+
code_verifier?: string;
|
|
5819
|
+
username?: string;
|
|
5820
|
+
otp?: string;
|
|
5821
|
+
refresh_token?: string;
|
|
5822
|
+
subject_token?: string;
|
|
5823
|
+
subject_token_type?: string;
|
|
5824
|
+
/** @description The device code returned by the authorization server. */
|
|
5825
|
+
device_code?: string;
|
|
5826
|
+
} & {
|
|
5827
|
+
[key: string]: unknown;
|
|
5828
|
+
};
|
|
5829
|
+
};
|
|
5830
|
+
};
|
|
5831
|
+
responses: {
|
|
5832
|
+
/** @description Default Response */
|
|
5833
|
+
200: {
|
|
5834
|
+
headers: {
|
|
5835
|
+
[name: string]: unknown;
|
|
5836
|
+
};
|
|
5837
|
+
content: {
|
|
5838
|
+
"application/json": {
|
|
5839
|
+
token_type: string;
|
|
5840
|
+
expires_in: number;
|
|
5841
|
+
access_token: string;
|
|
5842
|
+
refresh_token?: string;
|
|
5843
|
+
id_token?: string;
|
|
5844
|
+
scope?: string;
|
|
5845
|
+
};
|
|
5846
|
+
};
|
|
5847
|
+
};
|
|
5848
|
+
};
|
|
5849
|
+
};
|
|
5850
|
+
"oauth/deviceCode": {
|
|
4223
5851
|
parameters: {
|
|
4224
5852
|
query?: never;
|
|
4225
5853
|
header?: never;
|
|
@@ -4255,6 +5883,106 @@ export interface operations {
|
|
|
4255
5883
|
};
|
|
4256
5884
|
};
|
|
4257
5885
|
};
|
|
5886
|
+
"oauth/deviceActivate": {
|
|
5887
|
+
parameters: {
|
|
5888
|
+
query?: {
|
|
5889
|
+
user_code?: string;
|
|
5890
|
+
};
|
|
5891
|
+
header?: never;
|
|
5892
|
+
path?: never;
|
|
5893
|
+
cookie?: never;
|
|
5894
|
+
};
|
|
5895
|
+
requestBody?: never;
|
|
5896
|
+
responses: {
|
|
5897
|
+
/** @description Default Response */
|
|
5898
|
+
200: {
|
|
5899
|
+
headers: {
|
|
5900
|
+
[name: string]: unknown;
|
|
5901
|
+
};
|
|
5902
|
+
content?: never;
|
|
5903
|
+
};
|
|
5904
|
+
};
|
|
5905
|
+
};
|
|
5906
|
+
"oauth/deviceConfirm": {
|
|
5907
|
+
parameters: {
|
|
5908
|
+
query?: {
|
|
5909
|
+
user_code?: string;
|
|
5910
|
+
};
|
|
5911
|
+
header?: never;
|
|
5912
|
+
path?: never;
|
|
5913
|
+
cookie?: never;
|
|
5914
|
+
};
|
|
5915
|
+
requestBody?: never;
|
|
5916
|
+
responses: {
|
|
5917
|
+
/** @description Default Response */
|
|
5918
|
+
200: {
|
|
5919
|
+
headers: {
|
|
5920
|
+
[name: string]: unknown;
|
|
5921
|
+
};
|
|
5922
|
+
content?: never;
|
|
5923
|
+
};
|
|
5924
|
+
};
|
|
5925
|
+
};
|
|
5926
|
+
"oauth/deviceVerify": {
|
|
5927
|
+
parameters: {
|
|
5928
|
+
query?: never;
|
|
5929
|
+
header?: never;
|
|
5930
|
+
path?: never;
|
|
5931
|
+
cookie?: never;
|
|
5932
|
+
};
|
|
5933
|
+
requestBody: {
|
|
5934
|
+
content: {
|
|
5935
|
+
"application/json": {
|
|
5936
|
+
user_code: string;
|
|
5937
|
+
};
|
|
5938
|
+
};
|
|
5939
|
+
};
|
|
5940
|
+
responses: {
|
|
5941
|
+
/** @description Default Response */
|
|
5942
|
+
200: {
|
|
5943
|
+
headers: {
|
|
5944
|
+
[name: string]: unknown;
|
|
5945
|
+
};
|
|
5946
|
+
content: {
|
|
5947
|
+
"application/json": {
|
|
5948
|
+
device_code: string;
|
|
5949
|
+
client: {
|
|
5950
|
+
name?: string;
|
|
5951
|
+
client_id?: string;
|
|
5952
|
+
};
|
|
5953
|
+
};
|
|
5954
|
+
};
|
|
5955
|
+
};
|
|
5956
|
+
};
|
|
5957
|
+
};
|
|
5958
|
+
"oauth/deviceAuthorize": {
|
|
5959
|
+
parameters: {
|
|
5960
|
+
query?: never;
|
|
5961
|
+
header?: never;
|
|
5962
|
+
path?: never;
|
|
5963
|
+
cookie?: never;
|
|
5964
|
+
};
|
|
5965
|
+
requestBody: {
|
|
5966
|
+
content: {
|
|
5967
|
+
"application/json": {
|
|
5968
|
+
device_code: string;
|
|
5969
|
+
};
|
|
5970
|
+
};
|
|
5971
|
+
};
|
|
5972
|
+
responses: {
|
|
5973
|
+
/** @description Default Response */
|
|
5974
|
+
200: {
|
|
5975
|
+
headers: {
|
|
5976
|
+
[name: string]: unknown;
|
|
5977
|
+
};
|
|
5978
|
+
content: {
|
|
5979
|
+
"application/json": {
|
|
5980
|
+
success: boolean;
|
|
5981
|
+
};
|
|
5982
|
+
};
|
|
5983
|
+
};
|
|
5984
|
+
};
|
|
5985
|
+
};
|
|
4258
5986
|
callback: {
|
|
4259
5987
|
parameters: {
|
|
4260
5988
|
query?: {
|
|
@@ -4299,6 +6027,271 @@ export interface operations {
|
|
|
4299
6027
|
};
|
|
4300
6028
|
};
|
|
4301
6029
|
};
|
|
6030
|
+
"oauth/openidConfiguration": {
|
|
6031
|
+
parameters: {
|
|
6032
|
+
query?: never;
|
|
6033
|
+
header?: never;
|
|
6034
|
+
path?: never;
|
|
6035
|
+
cookie?: never;
|
|
6036
|
+
};
|
|
6037
|
+
requestBody?: never;
|
|
6038
|
+
responses: {
|
|
6039
|
+
/** @description Default Response */
|
|
6040
|
+
200: {
|
|
6041
|
+
headers: {
|
|
6042
|
+
[name: string]: unknown;
|
|
6043
|
+
};
|
|
6044
|
+
content?: never;
|
|
6045
|
+
};
|
|
6046
|
+
};
|
|
6047
|
+
};
|
|
6048
|
+
"oauth/jwks": {
|
|
6049
|
+
parameters: {
|
|
6050
|
+
query?: never;
|
|
6051
|
+
header?: never;
|
|
6052
|
+
path?: never;
|
|
6053
|
+
cookie?: never;
|
|
6054
|
+
};
|
|
6055
|
+
requestBody?: never;
|
|
6056
|
+
responses: {
|
|
6057
|
+
/** @description Default Response */
|
|
6058
|
+
200: {
|
|
6059
|
+
headers: {
|
|
6060
|
+
[name: string]: unknown;
|
|
6061
|
+
};
|
|
6062
|
+
content?: never;
|
|
6063
|
+
};
|
|
6064
|
+
};
|
|
6065
|
+
};
|
|
6066
|
+
"oauth/userinfo": {
|
|
6067
|
+
parameters: {
|
|
6068
|
+
query?: never;
|
|
6069
|
+
header?: never;
|
|
6070
|
+
path?: never;
|
|
6071
|
+
cookie?: never;
|
|
6072
|
+
};
|
|
6073
|
+
requestBody?: never;
|
|
6074
|
+
responses: {
|
|
6075
|
+
/** @description OpenID Connect UserInfo response (https://openid.net/specs/openid-connect-core-1_0.html#UserInfoResponse). */
|
|
6076
|
+
200: {
|
|
6077
|
+
headers: {
|
|
6078
|
+
[name: string]: unknown;
|
|
6079
|
+
};
|
|
6080
|
+
content: {
|
|
6081
|
+
"application/json": {
|
|
6082
|
+
/** @description Subject identifier (user id) */
|
|
6083
|
+
sub: string;
|
|
6084
|
+
name?: string;
|
|
6085
|
+
family_name?: string;
|
|
6086
|
+
given_name?: string;
|
|
6087
|
+
nickname?: string;
|
|
6088
|
+
preferred_username?: string;
|
|
6089
|
+
picture?: string;
|
|
6090
|
+
birthdate?: string;
|
|
6091
|
+
locale?: string;
|
|
6092
|
+
updated_at?: number;
|
|
6093
|
+
email?: string;
|
|
6094
|
+
email_verified?: boolean;
|
|
6095
|
+
phone_number?: string;
|
|
6096
|
+
phone_number_verified?: boolean;
|
|
6097
|
+
} & {
|
|
6098
|
+
[key: string]: unknown;
|
|
6099
|
+
};
|
|
6100
|
+
};
|
|
6101
|
+
};
|
|
6102
|
+
};
|
|
6103
|
+
};
|
|
6104
|
+
"oauth/userinfoPost": {
|
|
6105
|
+
parameters: {
|
|
6106
|
+
query?: never;
|
|
6107
|
+
header?: never;
|
|
6108
|
+
path?: never;
|
|
6109
|
+
cookie?: never;
|
|
6110
|
+
};
|
|
6111
|
+
requestBody?: never;
|
|
6112
|
+
responses: {
|
|
6113
|
+
/** @description OpenID Connect UserInfo response (https://openid.net/specs/openid-connect-core-1_0.html#UserInfoResponse). */
|
|
6114
|
+
200: {
|
|
6115
|
+
headers: {
|
|
6116
|
+
[name: string]: unknown;
|
|
6117
|
+
};
|
|
6118
|
+
content: {
|
|
6119
|
+
"application/json": {
|
|
6120
|
+
/** @description Subject identifier (user id) */
|
|
6121
|
+
sub: string;
|
|
6122
|
+
name?: string;
|
|
6123
|
+
family_name?: string;
|
|
6124
|
+
given_name?: string;
|
|
6125
|
+
nickname?: string;
|
|
6126
|
+
preferred_username?: string;
|
|
6127
|
+
picture?: string;
|
|
6128
|
+
birthdate?: string;
|
|
6129
|
+
locale?: string;
|
|
6130
|
+
updated_at?: number;
|
|
6131
|
+
email?: string;
|
|
6132
|
+
email_verified?: boolean;
|
|
6133
|
+
phone_number?: string;
|
|
6134
|
+
phone_number_verified?: boolean;
|
|
6135
|
+
} & {
|
|
6136
|
+
[key: string]: unknown;
|
|
6137
|
+
};
|
|
6138
|
+
};
|
|
6139
|
+
};
|
|
6140
|
+
};
|
|
6141
|
+
};
|
|
6142
|
+
"oauth/register": {
|
|
6143
|
+
parameters: {
|
|
6144
|
+
query?: never;
|
|
6145
|
+
header?: never;
|
|
6146
|
+
path?: never;
|
|
6147
|
+
cookie?: never;
|
|
6148
|
+
};
|
|
6149
|
+
requestBody: {
|
|
6150
|
+
content: {
|
|
6151
|
+
"application/json": {
|
|
6152
|
+
/** @description Array of redirection URI values used by the client (RFC 7591 §2). REQUIRED for any client that uses an authorization grant. */
|
|
6153
|
+
redirect_uris: string[];
|
|
6154
|
+
/** @description Human-readable name of the client (RFC 7591 §2) */
|
|
6155
|
+
client_name?: string;
|
|
6156
|
+
/** @description URL of the home page of the client */
|
|
6157
|
+
client_uri?: string;
|
|
6158
|
+
logo_uri?: string;
|
|
6159
|
+
tos_uri?: string;
|
|
6160
|
+
policy_uri?: string;
|
|
6161
|
+
/** @description Array of email addresses responsible for the client */
|
|
6162
|
+
contacts?: string[];
|
|
6163
|
+
/** @description Grant types the client will use. Defaults to ["authorization_code"]. Must be a subset of what the server supports. */
|
|
6164
|
+
grant_types?: string[];
|
|
6165
|
+
/** @description Response types the client will use. Defaults to ["code"]. */
|
|
6166
|
+
response_types?: string[];
|
|
6167
|
+
/** @description How the client authenticates at the token endpoint. Defaults to "client_secret_basic". */
|
|
6168
|
+
token_endpoint_auth_method?: string;
|
|
6169
|
+
/** @description OIDC §2 — application type. Defaults to "web". */
|
|
6170
|
+
application_type?: "web" | "native";
|
|
6171
|
+
/** @description OIDC RP-Initiated Logout — URIs the OP MAY redirect to after end-session. */
|
|
6172
|
+
post_logout_redirect_uris?: string[];
|
|
6173
|
+
/** @description Space-separated list of scope values the client may use. */
|
|
6174
|
+
scope?: string;
|
|
6175
|
+
software_id?: string;
|
|
6176
|
+
software_version?: string;
|
|
6177
|
+
/** @description OIDC Front-Channel Logout 1.0 — URL the OP loads inside an iframe at end-session to let the RP clear its session. */
|
|
6178
|
+
frontchannel_logout_uri?: string;
|
|
6179
|
+
/** @description OIDC Front-Channel Logout 1.0 — when true, the OP MUST include `iss` and `sid` parameters when calling the frontchannel_logout_uri. */
|
|
6180
|
+
frontchannel_logout_session_required?: boolean;
|
|
6181
|
+
} & {
|
|
6182
|
+
[key: string]: unknown;
|
|
6183
|
+
};
|
|
6184
|
+
};
|
|
6185
|
+
};
|
|
6186
|
+
responses: {
|
|
6187
|
+
/** @description Default Response */
|
|
6188
|
+
201: {
|
|
6189
|
+
headers: {
|
|
6190
|
+
[name: string]: unknown;
|
|
6191
|
+
};
|
|
6192
|
+
content: {
|
|
6193
|
+
"application/json": {
|
|
6194
|
+
client_id: string;
|
|
6195
|
+
client_secret: string;
|
|
6196
|
+
/** @description Unix timestamp (seconds) at which the client_id was issued */
|
|
6197
|
+
client_id_issued_at: number;
|
|
6198
|
+
/** @description 0 if the client_secret does not expire */
|
|
6199
|
+
client_secret_expires_at: number;
|
|
6200
|
+
redirect_uris: string[];
|
|
6201
|
+
client_name?: string;
|
|
6202
|
+
client_uri?: string;
|
|
6203
|
+
logo_uri?: string;
|
|
6204
|
+
tos_uri?: string;
|
|
6205
|
+
policy_uri?: string;
|
|
6206
|
+
contacts?: string[];
|
|
6207
|
+
grant_types: string[];
|
|
6208
|
+
response_types: string[];
|
|
6209
|
+
token_endpoint_auth_method: string;
|
|
6210
|
+
application_type: string;
|
|
6211
|
+
post_logout_redirect_uris?: string[];
|
|
6212
|
+
scope?: string;
|
|
6213
|
+
software_id?: string;
|
|
6214
|
+
software_version?: string;
|
|
6215
|
+
frontchannel_logout_uri?: string;
|
|
6216
|
+
frontchannel_logout_session_required?: boolean;
|
|
6217
|
+
} & {
|
|
6218
|
+
[key: string]: unknown;
|
|
6219
|
+
};
|
|
6220
|
+
};
|
|
6221
|
+
};
|
|
6222
|
+
};
|
|
6223
|
+
};
|
|
6224
|
+
"usernamepassword/login": {
|
|
6225
|
+
parameters: {
|
|
6226
|
+
query?: never;
|
|
6227
|
+
header?: never;
|
|
6228
|
+
path?: never;
|
|
6229
|
+
cookie?: never;
|
|
6230
|
+
};
|
|
6231
|
+
/** @description UsernamepasswordLoginBody */
|
|
6232
|
+
requestBody: {
|
|
6233
|
+
content: {
|
|
6234
|
+
"application/json": {
|
|
6235
|
+
username: string;
|
|
6236
|
+
password: string;
|
|
6237
|
+
/** @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. */
|
|
6238
|
+
state?: string;
|
|
6239
|
+
response_type?: string;
|
|
6240
|
+
client_id: string;
|
|
6241
|
+
/** @description Deprecated. Use connection_id */
|
|
6242
|
+
connection?: string;
|
|
6243
|
+
/** @description Which oauth connection to use. Leave empty to use default connection */
|
|
6244
|
+
connection_id?: string;
|
|
6245
|
+
scope?: string;
|
|
6246
|
+
/** @description The URL to which Faable will redirect the browser after authorization has been granted by the user. */
|
|
6247
|
+
redirect_uri?: string;
|
|
6248
|
+
/** @description OIDC §3.1.2.1 — string value used to associate a Client session with an ID Token, to mitigate replay attacks. If passed at /authorize, the same value MUST appear in the issued id_token. */
|
|
6249
|
+
nonce?: string;
|
|
6250
|
+
/** @description OIDC §3.1.2.1 — maximum allowable elapsed time in seconds since the last End-User authentication. If exceeded, the OP re-authenticates and `auth_time` is REQUIRED in the resulting id_token. */
|
|
6251
|
+
max_age?: number;
|
|
6252
|
+
prompt?: string;
|
|
6253
|
+
};
|
|
6254
|
+
};
|
|
6255
|
+
};
|
|
6256
|
+
responses: {
|
|
6257
|
+
/** @description Default Response */
|
|
6258
|
+
200: {
|
|
6259
|
+
headers: {
|
|
6260
|
+
[name: string]: unknown;
|
|
6261
|
+
};
|
|
6262
|
+
content?: never;
|
|
6263
|
+
};
|
|
6264
|
+
};
|
|
6265
|
+
};
|
|
6266
|
+
"usernamepassword/loginCallback": {
|
|
6267
|
+
parameters: {
|
|
6268
|
+
query?: never;
|
|
6269
|
+
header?: never;
|
|
6270
|
+
path?: never;
|
|
6271
|
+
cookie?: never;
|
|
6272
|
+
};
|
|
6273
|
+
requestBody: {
|
|
6274
|
+
content: {
|
|
6275
|
+
"application/json": {
|
|
6276
|
+
/** @description is always wsignin1.0 */
|
|
6277
|
+
wa: string;
|
|
6278
|
+
/** @description JWT */
|
|
6279
|
+
wresult: string;
|
|
6280
|
+
/** @description Serialized JSON with context */
|
|
6281
|
+
wctx: string;
|
|
6282
|
+
};
|
|
6283
|
+
};
|
|
6284
|
+
};
|
|
6285
|
+
responses: {
|
|
6286
|
+
/** @description Default Response */
|
|
6287
|
+
200: {
|
|
6288
|
+
headers: {
|
|
6289
|
+
[name: string]: unknown;
|
|
6290
|
+
};
|
|
6291
|
+
content?: never;
|
|
6292
|
+
};
|
|
6293
|
+
};
|
|
6294
|
+
};
|
|
4302
6295
|
change_password: {
|
|
4303
6296
|
parameters: {
|
|
4304
6297
|
query?: never;
|