@meshery/schemas 1.2.22 → 1.3.0
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/cloudApi.d.mts +1719 -1518
- package/dist/cloudApi.d.ts +1719 -1518
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6648 -6029
- package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
- package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
- package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
- package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
- package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
- package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
- package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
- package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
- package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
- package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
- package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
- package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
- package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
- package/dist/constructs/v1beta1/system/System.d.ts +434 -0
- package/dist/constructs/v1beta1/system/System.js +1 -0
- package/dist/constructs/v1beta1/system/System.mjs +0 -0
- package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
- package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
- package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
- package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta1/view/View.d.ts +833 -664
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
- package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
- package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
- package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
- package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
- package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
- package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
- package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
- package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
- package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
- package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
- package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta2/view/View.d.ts +838 -669
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7836 -7218
- package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
- package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
- package/dist/constructs/v1beta3/design/Design.d.ts +5727 -5305
- package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
- package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
- package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
- package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
- package/dist/index.d.mts +5480 -5022
- package/dist/index.d.ts +5480 -5022
- package/dist/mesheryApi.d.mts +1314 -522
- package/dist/mesheryApi.d.ts +1314 -522
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -2
|
@@ -4,650 +4,255 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
get: operations["getInvitations"];
|
|
14
|
-
post: operations["createInvitation"];
|
|
15
|
-
};
|
|
16
|
-
"/api/organizations/invitations/{invitationId}/accept": {
|
|
17
|
-
post: operations["acceptInvitation"];
|
|
18
|
-
};
|
|
19
|
-
"/api/identity/orgs/{orgId}/users/invite": {
|
|
20
|
-
post: operations["handleUserInvite"];
|
|
21
|
-
};
|
|
22
|
-
"/api/identity/users/request": {
|
|
23
|
-
get: operations["getSignupRequests"];
|
|
24
|
-
post: operations["signupRequest"];
|
|
25
|
-
};
|
|
26
|
-
"/api/identity/users/request/approve": {
|
|
27
|
-
post: operations["approveSignupRequest"];
|
|
28
|
-
};
|
|
29
|
-
"/api/identity/users/request/deny": {
|
|
30
|
-
post: operations["denySignupRequest"];
|
|
31
|
-
};
|
|
32
|
-
"/api/identity/users/request/notification": {
|
|
33
|
-
get: operations["getSignupRequestNotification"];
|
|
34
|
-
};
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
export interface components {
|
|
38
|
-
schemas: {
|
|
39
|
-
/**
|
|
40
|
-
* Format: uuid
|
|
41
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
42
|
-
*/
|
|
43
|
-
Uuid: string;
|
|
44
|
-
/** @description Paginated list of invitations for an organization. */
|
|
45
|
-
InvitationsPage: {
|
|
46
|
-
/** @description Invitations returned on the current page. */
|
|
47
|
-
data: {
|
|
48
|
-
/**
|
|
49
|
-
* Format: uuid
|
|
50
|
-
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
51
|
-
*/
|
|
52
|
-
id: string;
|
|
53
|
-
/**
|
|
54
|
-
* Format: uuid
|
|
55
|
-
* @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
|
|
56
|
-
*/
|
|
57
|
-
ownerId: string;
|
|
58
|
-
/** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
|
|
59
|
-
isDefault?: boolean;
|
|
60
|
-
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
61
|
-
name: string;
|
|
62
|
-
/** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
|
|
63
|
-
description: string;
|
|
64
|
-
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
65
|
-
emails: string[];
|
|
66
|
-
/**
|
|
67
|
-
* Format: uuid
|
|
68
|
-
* @description ID of the organization to which the user is invited.
|
|
69
|
-
*/
|
|
70
|
-
orgId: string;
|
|
71
|
-
/**
|
|
72
|
-
* Format: date-time
|
|
73
|
-
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
74
|
-
*/
|
|
75
|
-
expiresAt?: string;
|
|
76
|
-
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
77
|
-
quota?: number;
|
|
78
|
-
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
79
|
-
acceptedBy: string[];
|
|
80
|
-
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
81
|
-
roles: string[];
|
|
82
|
-
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
83
|
-
teams: string[];
|
|
84
|
-
/**
|
|
85
|
-
* @description Activation status of the invitation.
|
|
86
|
-
* @enum {string}
|
|
87
|
-
*/
|
|
88
|
-
status: "enabled" | "disabled";
|
|
89
|
-
/**
|
|
90
|
-
* Format: date-time
|
|
91
|
-
* @description Timestamp when the invitation was created.
|
|
92
|
-
*/
|
|
93
|
-
createdAt: string;
|
|
94
|
-
/**
|
|
95
|
-
* Format: date-time
|
|
96
|
-
* @description Timestamp when the invitation was last updated.
|
|
97
|
-
*/
|
|
98
|
-
updatedAt: string;
|
|
99
|
-
/**
|
|
100
|
-
* Format: date-time
|
|
101
|
-
* @description Timestamp when the invitation was deleted, if applicable.
|
|
102
|
-
*/
|
|
103
|
-
deletedAt: string;
|
|
104
|
-
}[];
|
|
105
|
-
/** @description Total number of invitations available. */
|
|
106
|
-
total: number;
|
|
107
|
-
};
|
|
108
|
-
/** @description A signup request submitted for organization access. */
|
|
109
|
-
SignupRequest: { [key: string]: unknown };
|
|
110
|
-
/** @description Paginated list of signup requests. */
|
|
111
|
-
SignupRequestsPage: {
|
|
112
|
-
/** @description Current page number of the result set. */
|
|
113
|
-
page?: number;
|
|
114
|
-
/** @description Number of items per page. */
|
|
115
|
-
pageSize?: number;
|
|
116
|
-
/** @description Total number of items available. */
|
|
117
|
-
totalCount?: number;
|
|
118
|
-
/** @description Signup requests returned on the current page. */
|
|
119
|
-
data?: { [key: string]: unknown }[];
|
|
120
|
-
};
|
|
121
|
-
/** @description Payload for creating or updating an invitation. */
|
|
122
|
-
InvitationPayload: {
|
|
123
|
-
/**
|
|
124
|
-
* Format: uuid
|
|
125
|
-
* @description Existing invitation ID for updates; omit on create.
|
|
126
|
-
*/
|
|
127
|
-
id?: string;
|
|
128
|
-
/**
|
|
129
|
-
* Format: uuid
|
|
130
|
-
* @description ID of the user who created the invitation.
|
|
131
|
-
*/
|
|
132
|
-
ownerId?: string;
|
|
133
|
-
/** @description Indicates whether the invitation is a default invitation (open invite). */
|
|
134
|
-
isDefault?: boolean;
|
|
135
|
-
/** @description Name of the invitation. */
|
|
136
|
-
name: string;
|
|
137
|
-
/** @description Description of the invitation. */
|
|
138
|
-
description: string;
|
|
139
|
-
/** @description Email addresses or patterns this invitation is valid for. */
|
|
140
|
-
emails: string[];
|
|
141
|
-
/**
|
|
142
|
-
* Format: uuid
|
|
143
|
-
* @description ID of the organization to which the user is invited.
|
|
144
|
-
*/
|
|
145
|
-
orgId: string;
|
|
146
|
-
/**
|
|
147
|
-
* Format: date-time
|
|
148
|
-
* @description Timestamp when the invitation expires, if applicable.
|
|
149
|
-
*/
|
|
150
|
-
expiresAt?: string;
|
|
151
|
-
/** @description Quota for the invitation; limits the number of users that can accept it. */
|
|
152
|
-
quota?: number;
|
|
153
|
-
/** @description Roles that the user will have when accepting the invitation. */
|
|
154
|
-
roles: string[];
|
|
155
|
-
/** @description Teams that the user will be added to when accepting the invitation. */
|
|
156
|
-
teams: string[];
|
|
157
|
-
/**
|
|
158
|
-
* @description Activation status of the invitation.
|
|
159
|
-
* @enum {string}
|
|
160
|
-
*/
|
|
161
|
-
status: "enabled" | "disabled";
|
|
162
|
-
};
|
|
163
|
-
/**
|
|
164
|
-
* @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive. Disabled invitations can be re-enabled later.
|
|
165
|
-
* @enum {string}
|
|
166
|
-
*/
|
|
167
|
-
InvitationStatus: "enabled" | "disabled";
|
|
168
|
-
/** @description Invitation entity schema. */
|
|
169
|
-
Invitation: {
|
|
170
|
-
/**
|
|
171
|
-
* Format: uuid
|
|
172
|
-
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
173
|
-
*/
|
|
174
|
-
id: string;
|
|
175
|
-
/**
|
|
176
|
-
* Format: uuid
|
|
177
|
-
* @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
|
|
178
|
-
*/
|
|
179
|
-
ownerId: string;
|
|
180
|
-
/** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
|
|
181
|
-
isDefault?: boolean;
|
|
182
|
-
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
183
|
-
name: string;
|
|
184
|
-
/** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
|
|
185
|
-
description: string;
|
|
186
|
-
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
187
|
-
emails: string[];
|
|
188
|
-
/**
|
|
189
|
-
* Format: uuid
|
|
190
|
-
* @description ID of the organization to which the user is invited.
|
|
191
|
-
*/
|
|
192
|
-
orgId: string;
|
|
193
|
-
/**
|
|
194
|
-
* Format: date-time
|
|
195
|
-
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
196
|
-
*/
|
|
197
|
-
expiresAt?: string;
|
|
198
|
-
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
199
|
-
quota?: number;
|
|
200
|
-
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
201
|
-
acceptedBy: string[];
|
|
202
|
-
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
203
|
-
roles: string[];
|
|
204
|
-
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
205
|
-
teams: string[];
|
|
206
|
-
/**
|
|
207
|
-
* @description Activation status of the invitation.
|
|
208
|
-
* @enum {string}
|
|
209
|
-
*/
|
|
210
|
-
status: "enabled" | "disabled";
|
|
211
|
-
/**
|
|
212
|
-
* Format: date-time
|
|
213
|
-
* @description Timestamp when the invitation was created.
|
|
214
|
-
*/
|
|
215
|
-
createdAt: string;
|
|
216
|
-
/**
|
|
217
|
-
* Format: date-time
|
|
218
|
-
* @description Timestamp when the invitation was last updated.
|
|
219
|
-
*/
|
|
220
|
-
updatedAt: string;
|
|
221
|
-
/**
|
|
222
|
-
* Format: date-time
|
|
223
|
-
* @description Timestamp when the invitation was deleted, if applicable.
|
|
224
|
-
*/
|
|
225
|
-
deletedAt: string;
|
|
226
|
-
};
|
|
227
|
-
};
|
|
228
|
-
responses: {
|
|
229
|
-
/** Invalid request body or request param */
|
|
230
|
-
400: {
|
|
231
|
-
content: {
|
|
232
|
-
"text/plain": string;
|
|
233
|
-
};
|
|
234
|
-
};
|
|
235
|
-
/** Expired JWT token used or insufficient privilege */
|
|
236
|
-
401: {
|
|
237
|
-
content: {
|
|
238
|
-
"text/plain": string;
|
|
239
|
-
};
|
|
240
|
-
};
|
|
241
|
-
/** Result not found */
|
|
242
|
-
404: {
|
|
243
|
-
content: {
|
|
244
|
-
"text/plain": string;
|
|
245
|
-
};
|
|
246
|
-
};
|
|
247
|
-
/** Internal server error */
|
|
248
|
-
500: {
|
|
249
|
-
content: {
|
|
250
|
-
"text/plain": string;
|
|
251
|
-
};
|
|
252
|
-
};
|
|
253
|
-
};
|
|
254
|
-
parameters: {
|
|
255
|
-
/** @description The ID of the organization. */
|
|
256
|
-
orgId: string;
|
|
257
|
-
/** @description The ID of the invitation. */
|
|
258
|
-
invitationId: string;
|
|
259
|
-
};
|
|
260
|
-
}
|
|
261
|
-
|
|
262
|
-
export interface operations {
|
|
263
|
-
getInvitation: {
|
|
264
|
-
parameters: {
|
|
265
|
-
path: {
|
|
266
|
-
/** The ID of the invitation. */
|
|
267
|
-
invitationId: string;
|
|
268
|
-
};
|
|
269
|
-
};
|
|
270
|
-
responses: {
|
|
271
|
-
/** Invitation fetched */
|
|
272
|
-
200: {
|
|
273
|
-
content: {
|
|
274
|
-
"application/json": {
|
|
275
|
-
/**
|
|
276
|
-
* Format: uuid
|
|
277
|
-
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
278
|
-
*/
|
|
279
|
-
id: string;
|
|
280
|
-
/**
|
|
281
|
-
* Format: uuid
|
|
282
|
-
* @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
|
|
283
|
-
*/
|
|
284
|
-
ownerId: string;
|
|
285
|
-
/** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
|
|
286
|
-
isDefault?: boolean;
|
|
287
|
-
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
288
|
-
name: string;
|
|
289
|
-
/** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
|
|
290
|
-
description: string;
|
|
291
|
-
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
292
|
-
emails: string[];
|
|
293
|
-
/**
|
|
294
|
-
* Format: uuid
|
|
295
|
-
* @description ID of the organization to which the user is invited.
|
|
296
|
-
*/
|
|
297
|
-
orgId: string;
|
|
298
|
-
/**
|
|
299
|
-
* Format: date-time
|
|
300
|
-
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
301
|
-
*/
|
|
302
|
-
expiresAt?: string;
|
|
303
|
-
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
304
|
-
quota?: number;
|
|
305
|
-
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
306
|
-
acceptedBy: string[];
|
|
307
|
-
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
308
|
-
roles: string[];
|
|
309
|
-
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
310
|
-
teams: string[];
|
|
311
|
-
/**
|
|
312
|
-
* @description Activation status of the invitation.
|
|
313
|
-
* @enum {string}
|
|
314
|
-
*/
|
|
315
|
-
status: "enabled" | "disabled";
|
|
316
|
-
/**
|
|
317
|
-
* Format: date-time
|
|
318
|
-
* @description Timestamp when the invitation was created.
|
|
319
|
-
*/
|
|
320
|
-
createdAt: string;
|
|
321
|
-
/**
|
|
322
|
-
* Format: date-time
|
|
323
|
-
* @description Timestamp when the invitation was last updated.
|
|
324
|
-
*/
|
|
325
|
-
updatedAt: string;
|
|
326
|
-
/**
|
|
327
|
-
* Format: date-time
|
|
328
|
-
* @description Timestamp when the invitation was deleted, if applicable.
|
|
329
|
-
*/
|
|
330
|
-
deletedAt: string;
|
|
331
|
-
};
|
|
332
|
-
};
|
|
333
|
-
};
|
|
334
|
-
/** Invalid request body or request param */
|
|
335
|
-
400: {
|
|
336
|
-
content: {
|
|
337
|
-
"text/plain": string;
|
|
338
|
-
};
|
|
339
|
-
};
|
|
340
|
-
/** Expired JWT token used or insufficient privilege */
|
|
341
|
-
401: {
|
|
342
|
-
content: {
|
|
343
|
-
"text/plain": string;
|
|
344
|
-
};
|
|
345
|
-
};
|
|
346
|
-
/** Result not found */
|
|
347
|
-
404: {
|
|
348
|
-
content: {
|
|
349
|
-
"text/plain": string;
|
|
350
|
-
};
|
|
351
|
-
};
|
|
352
|
-
/** Internal server error */
|
|
353
|
-
500: {
|
|
354
|
-
content: {
|
|
355
|
-
"text/plain": string;
|
|
7
|
+
"/api/organizations/invitations/{invitationId}": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
356
13
|
};
|
|
357
|
-
|
|
14
|
+
/** Get an invitation by ID */
|
|
15
|
+
get: operations["getInvitation"];
|
|
16
|
+
/** Update an existing invitation */
|
|
17
|
+
put: operations["updateInvitation"];
|
|
18
|
+
post?: never;
|
|
19
|
+
/** Delete an invitation by ID */
|
|
20
|
+
delete: operations["deleteInvitation"];
|
|
21
|
+
options?: never;
|
|
22
|
+
head?: never;
|
|
23
|
+
patch?: never;
|
|
24
|
+
trace?: never;
|
|
358
25
|
};
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
};
|
|
366
|
-
};
|
|
367
|
-
responses: {
|
|
368
|
-
/** Invitation updated */
|
|
369
|
-
200: {
|
|
370
|
-
content: {
|
|
371
|
-
"application/json": {
|
|
372
|
-
/**
|
|
373
|
-
* Format: uuid
|
|
374
|
-
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
375
|
-
*/
|
|
376
|
-
id: string;
|
|
377
|
-
/**
|
|
378
|
-
* Format: uuid
|
|
379
|
-
* @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
|
|
380
|
-
*/
|
|
381
|
-
ownerId: string;
|
|
382
|
-
/** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
|
|
383
|
-
isDefault?: boolean;
|
|
384
|
-
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
385
|
-
name: string;
|
|
386
|
-
/** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
|
|
387
|
-
description: string;
|
|
388
|
-
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
389
|
-
emails: string[];
|
|
390
|
-
/**
|
|
391
|
-
* Format: uuid
|
|
392
|
-
* @description ID of the organization to which the user is invited.
|
|
393
|
-
*/
|
|
394
|
-
orgId: string;
|
|
395
|
-
/**
|
|
396
|
-
* Format: date-time
|
|
397
|
-
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
398
|
-
*/
|
|
399
|
-
expiresAt?: string;
|
|
400
|
-
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
401
|
-
quota?: number;
|
|
402
|
-
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
403
|
-
acceptedBy: string[];
|
|
404
|
-
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
405
|
-
roles: string[];
|
|
406
|
-
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
407
|
-
teams: string[];
|
|
408
|
-
/**
|
|
409
|
-
* @description Activation status of the invitation.
|
|
410
|
-
* @enum {string}
|
|
411
|
-
*/
|
|
412
|
-
status: "enabled" | "disabled";
|
|
413
|
-
/**
|
|
414
|
-
* Format: date-time
|
|
415
|
-
* @description Timestamp when the invitation was created.
|
|
416
|
-
*/
|
|
417
|
-
createdAt: string;
|
|
418
|
-
/**
|
|
419
|
-
* Format: date-time
|
|
420
|
-
* @description Timestamp when the invitation was last updated.
|
|
421
|
-
*/
|
|
422
|
-
updatedAt: string;
|
|
423
|
-
/**
|
|
424
|
-
* Format: date-time
|
|
425
|
-
* @description Timestamp when the invitation was deleted, if applicable.
|
|
426
|
-
*/
|
|
427
|
-
deletedAt: string;
|
|
428
|
-
};
|
|
429
|
-
};
|
|
430
|
-
};
|
|
431
|
-
/** Invalid request body or request param */
|
|
432
|
-
400: {
|
|
433
|
-
content: {
|
|
434
|
-
"text/plain": string;
|
|
26
|
+
"/api/organizations/invitations": {
|
|
27
|
+
parameters: {
|
|
28
|
+
query?: never;
|
|
29
|
+
header?: never;
|
|
30
|
+
path?: never;
|
|
31
|
+
cookie?: never;
|
|
435
32
|
};
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
"text/plain": string;
|
|
447
|
-
};
|
|
448
|
-
};
|
|
449
|
-
/** Internal server error */
|
|
450
|
-
500: {
|
|
451
|
-
content: {
|
|
452
|
-
"text/plain": string;
|
|
453
|
-
};
|
|
454
|
-
};
|
|
33
|
+
/** Get all invitations for the organization */
|
|
34
|
+
get: operations["getInvitations"];
|
|
35
|
+
put?: never;
|
|
36
|
+
/** Create a new invitation for the organization */
|
|
37
|
+
post: operations["createInvitation"];
|
|
38
|
+
delete?: never;
|
|
39
|
+
options?: never;
|
|
40
|
+
head?: never;
|
|
41
|
+
patch?: never;
|
|
42
|
+
trace?: never;
|
|
455
43
|
};
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
*/
|
|
463
|
-
id?: string;
|
|
464
|
-
/**
|
|
465
|
-
* Format: uuid
|
|
466
|
-
* @description ID of the user who created the invitation.
|
|
467
|
-
*/
|
|
468
|
-
ownerId?: string;
|
|
469
|
-
/** @description Indicates whether the invitation is a default invitation (open invite). */
|
|
470
|
-
isDefault?: boolean;
|
|
471
|
-
/** @description Name of the invitation. */
|
|
472
|
-
name: string;
|
|
473
|
-
/** @description Description of the invitation. */
|
|
474
|
-
description: string;
|
|
475
|
-
/** @description Email addresses or patterns this invitation is valid for. */
|
|
476
|
-
emails: string[];
|
|
477
|
-
/**
|
|
478
|
-
* Format: uuid
|
|
479
|
-
* @description ID of the organization to which the user is invited.
|
|
480
|
-
*/
|
|
481
|
-
orgId: string;
|
|
482
|
-
/**
|
|
483
|
-
* Format: date-time
|
|
484
|
-
* @description Timestamp when the invitation expires, if applicable.
|
|
485
|
-
*/
|
|
486
|
-
expiresAt?: string;
|
|
487
|
-
/** @description Quota for the invitation; limits the number of users that can accept it. */
|
|
488
|
-
quota?: number;
|
|
489
|
-
/** @description Roles that the user will have when accepting the invitation. */
|
|
490
|
-
roles: string[];
|
|
491
|
-
/** @description Teams that the user will be added to when accepting the invitation. */
|
|
492
|
-
teams: string[];
|
|
493
|
-
/**
|
|
494
|
-
* @description Activation status of the invitation.
|
|
495
|
-
* @enum {string}
|
|
496
|
-
*/
|
|
497
|
-
status: "enabled" | "disabled";
|
|
44
|
+
"/api/organizations/invitations/{invitationId}/accept": {
|
|
45
|
+
parameters: {
|
|
46
|
+
query?: never;
|
|
47
|
+
header?: never;
|
|
48
|
+
path?: never;
|
|
49
|
+
cookie?: never;
|
|
498
50
|
};
|
|
499
|
-
|
|
51
|
+
get?: never;
|
|
52
|
+
put?: never;
|
|
53
|
+
/** Accept an invitation by ID */
|
|
54
|
+
post: operations["acceptInvitation"];
|
|
55
|
+
delete?: never;
|
|
56
|
+
options?: never;
|
|
57
|
+
head?: never;
|
|
58
|
+
patch?: never;
|
|
59
|
+
trace?: never;
|
|
500
60
|
};
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
61
|
+
"/api/identity/orgs/{orgId}/users/invite": {
|
|
62
|
+
parameters: {
|
|
63
|
+
query?: never;
|
|
64
|
+
header?: never;
|
|
65
|
+
path?: never;
|
|
66
|
+
cookie?: never;
|
|
67
|
+
};
|
|
68
|
+
get?: never;
|
|
69
|
+
put?: never;
|
|
70
|
+
/** Invite users to an organization */
|
|
71
|
+
post: operations["handleUserInvite"];
|
|
72
|
+
delete?: never;
|
|
73
|
+
options?: never;
|
|
74
|
+
head?: never;
|
|
75
|
+
patch?: never;
|
|
76
|
+
trace?: never;
|
|
508
77
|
};
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
"text/plain": string;
|
|
78
|
+
"/api/identity/users/request": {
|
|
79
|
+
parameters: {
|
|
80
|
+
query?: never;
|
|
81
|
+
header?: never;
|
|
82
|
+
path?: never;
|
|
83
|
+
cookie?: never;
|
|
516
84
|
};
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
85
|
+
/** Get signup requests */
|
|
86
|
+
get: operations["getSignupRequests"];
|
|
87
|
+
put?: never;
|
|
88
|
+
/** Create a signup request */
|
|
89
|
+
post: operations["signupRequest"];
|
|
90
|
+
delete?: never;
|
|
91
|
+
options?: never;
|
|
92
|
+
head?: never;
|
|
93
|
+
patch?: never;
|
|
94
|
+
trace?: never;
|
|
95
|
+
};
|
|
96
|
+
"/api/identity/users/request/approve": {
|
|
97
|
+
parameters: {
|
|
98
|
+
query?: never;
|
|
99
|
+
header?: never;
|
|
100
|
+
path?: never;
|
|
101
|
+
cookie?: never;
|
|
522
102
|
};
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
103
|
+
get?: never;
|
|
104
|
+
put?: never;
|
|
105
|
+
/** Approve a signup request */
|
|
106
|
+
post: operations["approveSignupRequest"];
|
|
107
|
+
delete?: never;
|
|
108
|
+
options?: never;
|
|
109
|
+
head?: never;
|
|
110
|
+
patch?: never;
|
|
111
|
+
trace?: never;
|
|
112
|
+
};
|
|
113
|
+
"/api/identity/users/request/deny": {
|
|
114
|
+
parameters: {
|
|
115
|
+
query?: never;
|
|
116
|
+
header?: never;
|
|
117
|
+
path?: never;
|
|
118
|
+
cookie?: never;
|
|
528
119
|
};
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
120
|
+
get?: never;
|
|
121
|
+
put?: never;
|
|
122
|
+
/** Deny a signup request */
|
|
123
|
+
post: operations["denySignupRequest"];
|
|
124
|
+
delete?: never;
|
|
125
|
+
options?: never;
|
|
126
|
+
head?: never;
|
|
127
|
+
patch?: never;
|
|
128
|
+
trace?: never;
|
|
129
|
+
};
|
|
130
|
+
"/api/identity/users/request/notification": {
|
|
131
|
+
parameters: {
|
|
132
|
+
query?: never;
|
|
133
|
+
header?: never;
|
|
134
|
+
path?: never;
|
|
135
|
+
cookie?: never;
|
|
534
136
|
};
|
|
535
|
-
|
|
137
|
+
/** Get signup request notification summary */
|
|
138
|
+
get: operations["getSignupRequestNotification"];
|
|
139
|
+
put?: never;
|
|
140
|
+
post?: never;
|
|
141
|
+
delete?: never;
|
|
142
|
+
options?: never;
|
|
143
|
+
head?: never;
|
|
144
|
+
patch?: never;
|
|
145
|
+
trace?: never;
|
|
536
146
|
};
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
147
|
+
}
|
|
148
|
+
export type webhooks = Record<string, never>;
|
|
149
|
+
export interface components {
|
|
150
|
+
schemas: {
|
|
151
|
+
/**
|
|
152
|
+
* Format: uuid
|
|
153
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
154
|
+
*/
|
|
155
|
+
Uuid: string;
|
|
156
|
+
/** @description Paginated list of invitations for an organization. */
|
|
157
|
+
InvitationsPage: {
|
|
544
158
|
/** @description Invitations returned on the current page. */
|
|
545
159
|
data: {
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
160
|
+
/**
|
|
161
|
+
* Format: uuid
|
|
162
|
+
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
163
|
+
*/
|
|
164
|
+
id: string;
|
|
165
|
+
/**
|
|
166
|
+
* Format: uuid
|
|
167
|
+
* @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
|
|
168
|
+
*/
|
|
169
|
+
ownerId: string;
|
|
170
|
+
/** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
|
|
171
|
+
isDefault?: boolean;
|
|
172
|
+
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
173
|
+
name: string;
|
|
174
|
+
/** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
|
|
175
|
+
description: string;
|
|
176
|
+
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
177
|
+
emails: string[];
|
|
178
|
+
/**
|
|
179
|
+
* Format: uuid
|
|
180
|
+
* @description ID of the organization to which the user is invited.
|
|
181
|
+
*/
|
|
182
|
+
orgId: string;
|
|
183
|
+
/**
|
|
184
|
+
* Format: date-time
|
|
185
|
+
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
186
|
+
*/
|
|
187
|
+
expiresAt?: string;
|
|
188
|
+
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
189
|
+
quota?: number;
|
|
190
|
+
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
191
|
+
acceptedBy: string[];
|
|
192
|
+
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
193
|
+
roles: string[];
|
|
194
|
+
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
195
|
+
teams: string[];
|
|
196
|
+
/**
|
|
197
|
+
* @description Activation status of the invitation.
|
|
198
|
+
* @enum {string}
|
|
199
|
+
*/
|
|
200
|
+
status: "enabled" | "disabled";
|
|
201
|
+
/**
|
|
202
|
+
* Format: date-time
|
|
203
|
+
* @description Timestamp when the invitation was created.
|
|
204
|
+
*/
|
|
205
|
+
createdAt: string;
|
|
206
|
+
/**
|
|
207
|
+
* Format: date-time
|
|
208
|
+
* @description Timestamp when the invitation was last updated.
|
|
209
|
+
*/
|
|
210
|
+
updatedAt: string;
|
|
211
|
+
/**
|
|
212
|
+
* Format: date-time
|
|
213
|
+
* @description Timestamp when the invitation was deleted, if applicable.
|
|
214
|
+
*/
|
|
215
|
+
deletedAt: string;
|
|
602
216
|
}[];
|
|
603
217
|
/** @description Total number of invitations available. */
|
|
604
218
|
total: number;
|
|
605
|
-
};
|
|
606
219
|
};
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
content: {
|
|
611
|
-
"text/plain": string;
|
|
220
|
+
/** @description A signup request submitted for organization access. */
|
|
221
|
+
SignupRequest: {
|
|
222
|
+
[key: string]: unknown;
|
|
612
223
|
};
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
224
|
+
/** @description Paginated list of signup requests. */
|
|
225
|
+
SignupRequestsPage: {
|
|
226
|
+
/** @description Current page number of the result set. */
|
|
227
|
+
page?: number;
|
|
228
|
+
/** @description Number of items per page. */
|
|
229
|
+
pageSize?: number;
|
|
230
|
+
/** @description Total number of items available. */
|
|
231
|
+
totalCount?: number;
|
|
232
|
+
/** @description Signup requests returned on the current page. */
|
|
233
|
+
data?: {
|
|
234
|
+
[key: string]: unknown;
|
|
235
|
+
}[];
|
|
624
236
|
};
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
};
|
|
628
|
-
createInvitation: {
|
|
629
|
-
responses: {
|
|
630
|
-
/** Invitation created */
|
|
631
|
-
201: {
|
|
632
|
-
content: {
|
|
633
|
-
"application/json": {
|
|
237
|
+
/** @description Payload for creating or updating an invitation. */
|
|
238
|
+
InvitationPayload: {
|
|
634
239
|
/**
|
|
635
240
|
* Format: uuid
|
|
636
|
-
* @description
|
|
241
|
+
* @description Existing invitation ID for updates; omit on create.
|
|
637
242
|
*/
|
|
638
|
-
id
|
|
243
|
+
id?: string;
|
|
639
244
|
/**
|
|
640
245
|
* Format: uuid
|
|
641
|
-
* @description ID of the user who created the invitation.
|
|
246
|
+
* @description ID of the user who created the invitation.
|
|
642
247
|
*/
|
|
643
|
-
ownerId
|
|
644
|
-
/** @description Indicates whether the invitation is a default invitation (open invite)
|
|
248
|
+
ownerId?: string;
|
|
249
|
+
/** @description Indicates whether the invitation is a default invitation (open invite). */
|
|
645
250
|
isDefault?: boolean;
|
|
646
|
-
/** @description Name of the invitation
|
|
251
|
+
/** @description Name of the invitation. */
|
|
647
252
|
name: string;
|
|
648
|
-
/** @description Description of the invitation
|
|
253
|
+
/** @description Description of the invitation. */
|
|
649
254
|
description: string;
|
|
650
|
-
/** @description Email addresses or patterns
|
|
255
|
+
/** @description Email addresses or patterns this invitation is valid for. */
|
|
651
256
|
emails: string[];
|
|
652
257
|
/**
|
|
653
258
|
* Format: uuid
|
|
@@ -656,117 +261,28 @@ export interface operations {
|
|
|
656
261
|
orgId: string;
|
|
657
262
|
/**
|
|
658
263
|
* Format: date-time
|
|
659
|
-
* @description Timestamp when the invitation expires, if applicable.
|
|
264
|
+
* @description Timestamp when the invitation expires, if applicable.
|
|
660
265
|
*/
|
|
661
266
|
expiresAt?: string;
|
|
662
|
-
/** @description Quota for the invitation; limits the number of users that can accept it.
|
|
267
|
+
/** @description Quota for the invitation; limits the number of users that can accept it. */
|
|
663
268
|
quota?: number;
|
|
664
|
-
/** @description
|
|
665
|
-
acceptedBy: string[];
|
|
666
|
-
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
269
|
+
/** @description Roles that the user will have when accepting the invitation. */
|
|
667
270
|
roles: string[];
|
|
668
|
-
/** @description Teams that the user will be added to when accepting the invitation.
|
|
271
|
+
/** @description Teams that the user will be added to when accepting the invitation. */
|
|
669
272
|
teams: string[];
|
|
670
273
|
/**
|
|
671
274
|
* @description Activation status of the invitation.
|
|
672
275
|
* @enum {string}
|
|
673
276
|
*/
|
|
674
277
|
status: "enabled" | "disabled";
|
|
675
|
-
/**
|
|
676
|
-
* Format: date-time
|
|
677
|
-
* @description Timestamp when the invitation was created.
|
|
678
|
-
*/
|
|
679
|
-
createdAt: string;
|
|
680
|
-
/**
|
|
681
|
-
* Format: date-time
|
|
682
|
-
* @description Timestamp when the invitation was last updated.
|
|
683
|
-
*/
|
|
684
|
-
updatedAt: string;
|
|
685
|
-
/**
|
|
686
|
-
* Format: date-time
|
|
687
|
-
* @description Timestamp when the invitation was deleted, if applicable.
|
|
688
|
-
*/
|
|
689
|
-
deletedAt: string;
|
|
690
|
-
};
|
|
691
|
-
};
|
|
692
|
-
};
|
|
693
|
-
/** Invalid request body or request param */
|
|
694
|
-
400: {
|
|
695
|
-
content: {
|
|
696
|
-
"text/plain": string;
|
|
697
|
-
};
|
|
698
|
-
};
|
|
699
|
-
/** Expired JWT token used or insufficient privilege */
|
|
700
|
-
401: {
|
|
701
|
-
content: {
|
|
702
|
-
"text/plain": string;
|
|
703
|
-
};
|
|
704
|
-
};
|
|
705
|
-
/** Internal server error */
|
|
706
|
-
500: {
|
|
707
|
-
content: {
|
|
708
|
-
"text/plain": string;
|
|
709
|
-
};
|
|
710
|
-
};
|
|
711
|
-
};
|
|
712
|
-
requestBody: {
|
|
713
|
-
content: {
|
|
714
|
-
"application/json": {
|
|
715
|
-
/**
|
|
716
|
-
* Format: uuid
|
|
717
|
-
* @description Existing invitation ID for updates; omit on create.
|
|
718
|
-
*/
|
|
719
|
-
id?: string;
|
|
720
|
-
/**
|
|
721
|
-
* Format: uuid
|
|
722
|
-
* @description ID of the user who created the invitation.
|
|
723
|
-
*/
|
|
724
|
-
ownerId?: string;
|
|
725
|
-
/** @description Indicates whether the invitation is a default invitation (open invite). */
|
|
726
|
-
isDefault?: boolean;
|
|
727
|
-
/** @description Name of the invitation. */
|
|
728
|
-
name: string;
|
|
729
|
-
/** @description Description of the invitation. */
|
|
730
|
-
description: string;
|
|
731
|
-
/** @description Email addresses or patterns this invitation is valid for. */
|
|
732
|
-
emails: string[];
|
|
733
|
-
/**
|
|
734
|
-
* Format: uuid
|
|
735
|
-
* @description ID of the organization to which the user is invited.
|
|
736
|
-
*/
|
|
737
|
-
orgId: string;
|
|
738
|
-
/**
|
|
739
|
-
* Format: date-time
|
|
740
|
-
* @description Timestamp when the invitation expires, if applicable.
|
|
741
|
-
*/
|
|
742
|
-
expiresAt?: string;
|
|
743
|
-
/** @description Quota for the invitation; limits the number of users that can accept it. */
|
|
744
|
-
quota?: number;
|
|
745
|
-
/** @description Roles that the user will have when accepting the invitation. */
|
|
746
|
-
roles: string[];
|
|
747
|
-
/** @description Teams that the user will be added to when accepting the invitation. */
|
|
748
|
-
teams: string[];
|
|
749
|
-
/**
|
|
750
|
-
* @description Activation status of the invitation.
|
|
751
|
-
* @enum {string}
|
|
752
|
-
*/
|
|
753
|
-
status: "enabled" | "disabled";
|
|
754
278
|
};
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
invitationId: string;
|
|
763
|
-
};
|
|
764
|
-
};
|
|
765
|
-
responses: {
|
|
766
|
-
/** Invitation accepted */
|
|
767
|
-
200: {
|
|
768
|
-
content: {
|
|
769
|
-
"application/json": {
|
|
279
|
+
/**
|
|
280
|
+
* @description Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive. Disabled invitations can be re-enabled later.
|
|
281
|
+
* @enum {string}
|
|
282
|
+
*/
|
|
283
|
+
InvitationStatus: "enabled" | "disabled";
|
|
284
|
+
/** @description Invitation entity schema. */
|
|
285
|
+
Invitation: {
|
|
770
286
|
/**
|
|
771
287
|
* Format: uuid
|
|
772
288
|
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
@@ -823,238 +339,1089 @@ export interface operations {
|
|
|
823
339
|
* @description Timestamp when the invitation was deleted, if applicable.
|
|
824
340
|
*/
|
|
825
341
|
deletedAt: string;
|
|
826
|
-
};
|
|
827
342
|
};
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
343
|
+
};
|
|
344
|
+
responses: {
|
|
345
|
+
/** @description Invalid request body or request param */
|
|
346
|
+
400: {
|
|
347
|
+
headers: {
|
|
348
|
+
[name: string]: unknown;
|
|
349
|
+
};
|
|
350
|
+
content: {
|
|
351
|
+
"text/plain": string;
|
|
352
|
+
};
|
|
833
353
|
};
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
354
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
355
|
+
401: {
|
|
356
|
+
headers: {
|
|
357
|
+
[name: string]: unknown;
|
|
358
|
+
};
|
|
359
|
+
content: {
|
|
360
|
+
"text/plain": string;
|
|
361
|
+
};
|
|
839
362
|
};
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
363
|
+
/** @description Result not found */
|
|
364
|
+
404: {
|
|
365
|
+
headers: {
|
|
366
|
+
[name: string]: unknown;
|
|
367
|
+
};
|
|
368
|
+
content: {
|
|
369
|
+
"text/plain": string;
|
|
370
|
+
};
|
|
845
371
|
};
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
372
|
+
/** @description Internal server error */
|
|
373
|
+
500: {
|
|
374
|
+
headers: {
|
|
375
|
+
[name: string]: unknown;
|
|
376
|
+
};
|
|
377
|
+
content: {
|
|
378
|
+
"text/plain": string;
|
|
379
|
+
};
|
|
851
380
|
};
|
|
852
|
-
};
|
|
853
381
|
};
|
|
854
|
-
};
|
|
855
|
-
handleUserInvite: {
|
|
856
382
|
parameters: {
|
|
857
|
-
|
|
858
|
-
/** The ID of the organization. */
|
|
383
|
+
/** @description The ID of the organization. */
|
|
859
384
|
orgId: string;
|
|
860
|
-
|
|
385
|
+
/** @description The ID of the invitation. */
|
|
386
|
+
invitationId: string;
|
|
861
387
|
};
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
388
|
+
requestBodies: never;
|
|
389
|
+
headers: never;
|
|
390
|
+
pathItems: never;
|
|
391
|
+
}
|
|
392
|
+
export type $defs = Record<string, never>;
|
|
393
|
+
export interface operations {
|
|
394
|
+
getInvitation: {
|
|
395
|
+
parameters: {
|
|
396
|
+
query?: never;
|
|
397
|
+
header?: never;
|
|
398
|
+
path: {
|
|
399
|
+
/** @description The ID of the invitation. */
|
|
400
|
+
invitationId: string;
|
|
401
|
+
};
|
|
402
|
+
cookie?: never;
|
|
867
403
|
};
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
404
|
+
requestBody?: never;
|
|
405
|
+
responses: {
|
|
406
|
+
/** @description Invitation fetched */
|
|
407
|
+
200: {
|
|
408
|
+
headers: {
|
|
409
|
+
[name: string]: unknown;
|
|
410
|
+
};
|
|
411
|
+
content: {
|
|
412
|
+
"application/json": {
|
|
413
|
+
/**
|
|
414
|
+
* Format: uuid
|
|
415
|
+
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
416
|
+
*/
|
|
417
|
+
id: string;
|
|
418
|
+
/**
|
|
419
|
+
* Format: uuid
|
|
420
|
+
* @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
|
|
421
|
+
*/
|
|
422
|
+
ownerId: string;
|
|
423
|
+
/** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
|
|
424
|
+
isDefault?: boolean;
|
|
425
|
+
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
426
|
+
name: string;
|
|
427
|
+
/** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
|
|
428
|
+
description: string;
|
|
429
|
+
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
430
|
+
emails: string[];
|
|
431
|
+
/**
|
|
432
|
+
* Format: uuid
|
|
433
|
+
* @description ID of the organization to which the user is invited.
|
|
434
|
+
*/
|
|
435
|
+
orgId: string;
|
|
436
|
+
/**
|
|
437
|
+
* Format: date-time
|
|
438
|
+
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
439
|
+
*/
|
|
440
|
+
expiresAt?: string;
|
|
441
|
+
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
442
|
+
quota?: number;
|
|
443
|
+
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
444
|
+
acceptedBy: string[];
|
|
445
|
+
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
446
|
+
roles: string[];
|
|
447
|
+
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
448
|
+
teams: string[];
|
|
449
|
+
/**
|
|
450
|
+
* @description Activation status of the invitation.
|
|
451
|
+
* @enum {string}
|
|
452
|
+
*/
|
|
453
|
+
status: "enabled" | "disabled";
|
|
454
|
+
/**
|
|
455
|
+
* Format: date-time
|
|
456
|
+
* @description Timestamp when the invitation was created.
|
|
457
|
+
*/
|
|
458
|
+
createdAt: string;
|
|
459
|
+
/**
|
|
460
|
+
* Format: date-time
|
|
461
|
+
* @description Timestamp when the invitation was last updated.
|
|
462
|
+
*/
|
|
463
|
+
updatedAt: string;
|
|
464
|
+
/**
|
|
465
|
+
* Format: date-time
|
|
466
|
+
* @description Timestamp when the invitation was deleted, if applicable.
|
|
467
|
+
*/
|
|
468
|
+
deletedAt: string;
|
|
469
|
+
};
|
|
470
|
+
};
|
|
471
|
+
};
|
|
472
|
+
/** @description Invalid request body or request param */
|
|
473
|
+
400: {
|
|
474
|
+
headers: {
|
|
475
|
+
[name: string]: unknown;
|
|
476
|
+
};
|
|
477
|
+
content: {
|
|
478
|
+
"text/plain": string;
|
|
479
|
+
};
|
|
480
|
+
};
|
|
481
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
482
|
+
401: {
|
|
483
|
+
headers: {
|
|
484
|
+
[name: string]: unknown;
|
|
485
|
+
};
|
|
486
|
+
content: {
|
|
487
|
+
"text/plain": string;
|
|
488
|
+
};
|
|
489
|
+
};
|
|
490
|
+
/** @description Result not found */
|
|
491
|
+
404: {
|
|
492
|
+
headers: {
|
|
493
|
+
[name: string]: unknown;
|
|
494
|
+
};
|
|
495
|
+
content: {
|
|
496
|
+
"text/plain": string;
|
|
497
|
+
};
|
|
498
|
+
};
|
|
499
|
+
/** @description Internal server error */
|
|
500
|
+
500: {
|
|
501
|
+
headers: {
|
|
502
|
+
[name: string]: unknown;
|
|
503
|
+
};
|
|
504
|
+
content: {
|
|
505
|
+
"text/plain": string;
|
|
506
|
+
};
|
|
507
|
+
};
|
|
873
508
|
};
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
509
|
+
};
|
|
510
|
+
updateInvitation: {
|
|
511
|
+
parameters: {
|
|
512
|
+
query?: never;
|
|
513
|
+
header?: never;
|
|
514
|
+
path: {
|
|
515
|
+
/** @description The ID of the invitation. */
|
|
516
|
+
invitationId: string;
|
|
517
|
+
};
|
|
518
|
+
cookie?: never;
|
|
879
519
|
};
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
520
|
+
requestBody: {
|
|
521
|
+
content: {
|
|
522
|
+
"application/json": {
|
|
523
|
+
/**
|
|
524
|
+
* Format: uuid
|
|
525
|
+
* @description Existing invitation ID for updates; omit on create.
|
|
526
|
+
*/
|
|
527
|
+
id?: string;
|
|
528
|
+
/**
|
|
529
|
+
* Format: uuid
|
|
530
|
+
* @description ID of the user who created the invitation.
|
|
531
|
+
*/
|
|
532
|
+
ownerId?: string;
|
|
533
|
+
/** @description Indicates whether the invitation is a default invitation (open invite). */
|
|
534
|
+
isDefault?: boolean;
|
|
535
|
+
/** @description Name of the invitation. */
|
|
536
|
+
name: string;
|
|
537
|
+
/** @description Description of the invitation. */
|
|
538
|
+
description: string;
|
|
539
|
+
/** @description Email addresses or patterns this invitation is valid for. */
|
|
540
|
+
emails: string[];
|
|
541
|
+
/**
|
|
542
|
+
* Format: uuid
|
|
543
|
+
* @description ID of the organization to which the user is invited.
|
|
544
|
+
*/
|
|
545
|
+
orgId: string;
|
|
546
|
+
/**
|
|
547
|
+
* Format: date-time
|
|
548
|
+
* @description Timestamp when the invitation expires, if applicable.
|
|
549
|
+
*/
|
|
550
|
+
expiresAt?: string;
|
|
551
|
+
/** @description Quota for the invitation; limits the number of users that can accept it. */
|
|
552
|
+
quota?: number;
|
|
553
|
+
/** @description Roles that the user will have when accepting the invitation. */
|
|
554
|
+
roles: string[];
|
|
555
|
+
/** @description Teams that the user will be added to when accepting the invitation. */
|
|
556
|
+
teams: string[];
|
|
557
|
+
/**
|
|
558
|
+
* @description Activation status of the invitation.
|
|
559
|
+
* @enum {string}
|
|
560
|
+
*/
|
|
561
|
+
status: "enabled" | "disabled";
|
|
562
|
+
};
|
|
563
|
+
};
|
|
885
564
|
};
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
565
|
+
responses: {
|
|
566
|
+
/** @description Invitation updated */
|
|
567
|
+
200: {
|
|
568
|
+
headers: {
|
|
569
|
+
[name: string]: unknown;
|
|
570
|
+
};
|
|
571
|
+
content: {
|
|
572
|
+
"application/json": {
|
|
573
|
+
/**
|
|
574
|
+
* Format: uuid
|
|
575
|
+
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
576
|
+
*/
|
|
577
|
+
id: string;
|
|
578
|
+
/**
|
|
579
|
+
* Format: uuid
|
|
580
|
+
* @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
|
|
581
|
+
*/
|
|
582
|
+
ownerId: string;
|
|
583
|
+
/** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
|
|
584
|
+
isDefault?: boolean;
|
|
585
|
+
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
586
|
+
name: string;
|
|
587
|
+
/** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
|
|
588
|
+
description: string;
|
|
589
|
+
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
590
|
+
emails: string[];
|
|
591
|
+
/**
|
|
592
|
+
* Format: uuid
|
|
593
|
+
* @description ID of the organization to which the user is invited.
|
|
594
|
+
*/
|
|
595
|
+
orgId: string;
|
|
596
|
+
/**
|
|
597
|
+
* Format: date-time
|
|
598
|
+
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
599
|
+
*/
|
|
600
|
+
expiresAt?: string;
|
|
601
|
+
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
602
|
+
quota?: number;
|
|
603
|
+
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
604
|
+
acceptedBy: string[];
|
|
605
|
+
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
606
|
+
roles: string[];
|
|
607
|
+
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
608
|
+
teams: string[];
|
|
609
|
+
/**
|
|
610
|
+
* @description Activation status of the invitation.
|
|
611
|
+
* @enum {string}
|
|
612
|
+
*/
|
|
613
|
+
status: "enabled" | "disabled";
|
|
614
|
+
/**
|
|
615
|
+
* Format: date-time
|
|
616
|
+
* @description Timestamp when the invitation was created.
|
|
617
|
+
*/
|
|
618
|
+
createdAt: string;
|
|
619
|
+
/**
|
|
620
|
+
* Format: date-time
|
|
621
|
+
* @description Timestamp when the invitation was last updated.
|
|
622
|
+
*/
|
|
623
|
+
updatedAt: string;
|
|
624
|
+
/**
|
|
625
|
+
* Format: date-time
|
|
626
|
+
* @description Timestamp when the invitation was deleted, if applicable.
|
|
627
|
+
*/
|
|
628
|
+
deletedAt: string;
|
|
629
|
+
};
|
|
630
|
+
};
|
|
631
|
+
};
|
|
632
|
+
/** @description Invalid request body or request param */
|
|
633
|
+
400: {
|
|
634
|
+
headers: {
|
|
635
|
+
[name: string]: unknown;
|
|
636
|
+
};
|
|
637
|
+
content: {
|
|
638
|
+
"text/plain": string;
|
|
639
|
+
};
|
|
640
|
+
};
|
|
641
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
642
|
+
401: {
|
|
643
|
+
headers: {
|
|
644
|
+
[name: string]: unknown;
|
|
645
|
+
};
|
|
646
|
+
content: {
|
|
647
|
+
"text/plain": string;
|
|
648
|
+
};
|
|
649
|
+
};
|
|
650
|
+
/** @description Result not found */
|
|
651
|
+
404: {
|
|
652
|
+
headers: {
|
|
653
|
+
[name: string]: unknown;
|
|
654
|
+
};
|
|
655
|
+
content: {
|
|
656
|
+
"text/plain": string;
|
|
657
|
+
};
|
|
658
|
+
};
|
|
659
|
+
/** @description Internal server error */
|
|
660
|
+
500: {
|
|
661
|
+
headers: {
|
|
662
|
+
[name: string]: unknown;
|
|
663
|
+
};
|
|
664
|
+
content: {
|
|
665
|
+
"text/plain": string;
|
|
666
|
+
};
|
|
667
|
+
};
|
|
891
668
|
};
|
|
892
|
-
};
|
|
893
669
|
};
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
670
|
+
deleteInvitation: {
|
|
671
|
+
parameters: {
|
|
672
|
+
query?: never;
|
|
673
|
+
header?: never;
|
|
674
|
+
path: {
|
|
675
|
+
/** @description The ID of the invitation. */
|
|
676
|
+
invitationId: string;
|
|
677
|
+
};
|
|
678
|
+
cookie?: never;
|
|
679
|
+
};
|
|
680
|
+
requestBody?: never;
|
|
681
|
+
responses: {
|
|
682
|
+
/** @description Invitation deleted */
|
|
683
|
+
204: {
|
|
684
|
+
headers: {
|
|
685
|
+
[name: string]: unknown;
|
|
686
|
+
};
|
|
687
|
+
content?: never;
|
|
688
|
+
};
|
|
689
|
+
/** @description Invalid request body or request param */
|
|
690
|
+
400: {
|
|
691
|
+
headers: {
|
|
692
|
+
[name: string]: unknown;
|
|
693
|
+
};
|
|
694
|
+
content: {
|
|
695
|
+
"text/plain": string;
|
|
696
|
+
};
|
|
697
|
+
};
|
|
698
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
699
|
+
401: {
|
|
700
|
+
headers: {
|
|
701
|
+
[name: string]: unknown;
|
|
702
|
+
};
|
|
703
|
+
content: {
|
|
704
|
+
"text/plain": string;
|
|
705
|
+
};
|
|
706
|
+
};
|
|
707
|
+
/** @description Result not found */
|
|
708
|
+
404: {
|
|
709
|
+
headers: {
|
|
710
|
+
[name: string]: unknown;
|
|
711
|
+
};
|
|
712
|
+
content: {
|
|
713
|
+
"text/plain": string;
|
|
714
|
+
};
|
|
715
|
+
};
|
|
716
|
+
/** @description Internal server error */
|
|
717
|
+
500: {
|
|
718
|
+
headers: {
|
|
719
|
+
[name: string]: unknown;
|
|
720
|
+
};
|
|
721
|
+
content: {
|
|
722
|
+
"text/plain": string;
|
|
723
|
+
};
|
|
724
|
+
};
|
|
725
|
+
};
|
|
898
726
|
};
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
727
|
+
getInvitations: {
|
|
728
|
+
parameters: {
|
|
729
|
+
query?: never;
|
|
730
|
+
header?: never;
|
|
731
|
+
path?: never;
|
|
732
|
+
cookie?: never;
|
|
733
|
+
};
|
|
734
|
+
requestBody?: never;
|
|
735
|
+
responses: {
|
|
736
|
+
/** @description Invitations page */
|
|
737
|
+
200: {
|
|
738
|
+
headers: {
|
|
739
|
+
[name: string]: unknown;
|
|
740
|
+
};
|
|
741
|
+
content: {
|
|
742
|
+
"application/json": {
|
|
743
|
+
/** @description Invitations returned on the current page. */
|
|
744
|
+
data: {
|
|
745
|
+
/**
|
|
746
|
+
* Format: uuid
|
|
747
|
+
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
748
|
+
*/
|
|
749
|
+
id: string;
|
|
750
|
+
/**
|
|
751
|
+
* Format: uuid
|
|
752
|
+
* @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
|
|
753
|
+
*/
|
|
754
|
+
ownerId: string;
|
|
755
|
+
/** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
|
|
756
|
+
isDefault?: boolean;
|
|
757
|
+
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
758
|
+
name: string;
|
|
759
|
+
/** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
|
|
760
|
+
description: string;
|
|
761
|
+
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
762
|
+
emails: string[];
|
|
763
|
+
/**
|
|
764
|
+
* Format: uuid
|
|
765
|
+
* @description ID of the organization to which the user is invited.
|
|
766
|
+
*/
|
|
767
|
+
orgId: string;
|
|
768
|
+
/**
|
|
769
|
+
* Format: date-time
|
|
770
|
+
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
771
|
+
*/
|
|
772
|
+
expiresAt?: string;
|
|
773
|
+
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
774
|
+
quota?: number;
|
|
775
|
+
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
776
|
+
acceptedBy: string[];
|
|
777
|
+
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
778
|
+
roles: string[];
|
|
779
|
+
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
780
|
+
teams: string[];
|
|
781
|
+
/**
|
|
782
|
+
* @description Activation status of the invitation.
|
|
783
|
+
* @enum {string}
|
|
784
|
+
*/
|
|
785
|
+
status: "enabled" | "disabled";
|
|
786
|
+
/**
|
|
787
|
+
* Format: date-time
|
|
788
|
+
* @description Timestamp when the invitation was created.
|
|
789
|
+
*/
|
|
790
|
+
createdAt: string;
|
|
791
|
+
/**
|
|
792
|
+
* Format: date-time
|
|
793
|
+
* @description Timestamp when the invitation was last updated.
|
|
794
|
+
*/
|
|
795
|
+
updatedAt: string;
|
|
796
|
+
/**
|
|
797
|
+
* Format: date-time
|
|
798
|
+
* @description Timestamp when the invitation was deleted, if applicable.
|
|
799
|
+
*/
|
|
800
|
+
deletedAt: string;
|
|
801
|
+
}[];
|
|
802
|
+
/** @description Total number of invitations available. */
|
|
803
|
+
total: number;
|
|
804
|
+
};
|
|
805
|
+
};
|
|
806
|
+
};
|
|
807
|
+
/** @description Invalid request body or request param */
|
|
808
|
+
400: {
|
|
809
|
+
headers: {
|
|
810
|
+
[name: string]: unknown;
|
|
811
|
+
};
|
|
812
|
+
content: {
|
|
813
|
+
"text/plain": string;
|
|
814
|
+
};
|
|
815
|
+
};
|
|
816
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
817
|
+
401: {
|
|
818
|
+
headers: {
|
|
819
|
+
[name: string]: unknown;
|
|
820
|
+
};
|
|
821
|
+
content: {
|
|
822
|
+
"text/plain": string;
|
|
823
|
+
};
|
|
824
|
+
};
|
|
825
|
+
/** @description Internal server error */
|
|
826
|
+
500: {
|
|
827
|
+
headers: {
|
|
828
|
+
[name: string]: unknown;
|
|
829
|
+
};
|
|
830
|
+
content: {
|
|
831
|
+
"text/plain": string;
|
|
832
|
+
};
|
|
833
|
+
};
|
|
834
|
+
};
|
|
914
835
|
};
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
page?: number;
|
|
922
|
-
/** @description Number of items per page. */
|
|
923
|
-
pageSize?: number;
|
|
924
|
-
/** @description Total number of items available. */
|
|
925
|
-
totalCount?: number;
|
|
926
|
-
/** @description Signup requests returned on the current page. */
|
|
927
|
-
data?: { [key: string]: unknown }[];
|
|
928
|
-
};
|
|
836
|
+
createInvitation: {
|
|
837
|
+
parameters: {
|
|
838
|
+
query?: never;
|
|
839
|
+
header?: never;
|
|
840
|
+
path?: never;
|
|
841
|
+
cookie?: never;
|
|
929
842
|
};
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
843
|
+
requestBody: {
|
|
844
|
+
content: {
|
|
845
|
+
"application/json": {
|
|
846
|
+
/**
|
|
847
|
+
* Format: uuid
|
|
848
|
+
* @description Existing invitation ID for updates; omit on create.
|
|
849
|
+
*/
|
|
850
|
+
id?: string;
|
|
851
|
+
/**
|
|
852
|
+
* Format: uuid
|
|
853
|
+
* @description ID of the user who created the invitation.
|
|
854
|
+
*/
|
|
855
|
+
ownerId?: string;
|
|
856
|
+
/** @description Indicates whether the invitation is a default invitation (open invite). */
|
|
857
|
+
isDefault?: boolean;
|
|
858
|
+
/** @description Name of the invitation. */
|
|
859
|
+
name: string;
|
|
860
|
+
/** @description Description of the invitation. */
|
|
861
|
+
description: string;
|
|
862
|
+
/** @description Email addresses or patterns this invitation is valid for. */
|
|
863
|
+
emails: string[];
|
|
864
|
+
/**
|
|
865
|
+
* Format: uuid
|
|
866
|
+
* @description ID of the organization to which the user is invited.
|
|
867
|
+
*/
|
|
868
|
+
orgId: string;
|
|
869
|
+
/**
|
|
870
|
+
* Format: date-time
|
|
871
|
+
* @description Timestamp when the invitation expires, if applicable.
|
|
872
|
+
*/
|
|
873
|
+
expiresAt?: string;
|
|
874
|
+
/** @description Quota for the invitation; limits the number of users that can accept it. */
|
|
875
|
+
quota?: number;
|
|
876
|
+
/** @description Roles that the user will have when accepting the invitation. */
|
|
877
|
+
roles: string[];
|
|
878
|
+
/** @description Teams that the user will be added to when accepting the invitation. */
|
|
879
|
+
teams: string[];
|
|
880
|
+
/**
|
|
881
|
+
* @description Activation status of the invitation.
|
|
882
|
+
* @enum {string}
|
|
883
|
+
*/
|
|
884
|
+
status: "enabled" | "disabled";
|
|
885
|
+
};
|
|
886
|
+
};
|
|
935
887
|
};
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
888
|
+
responses: {
|
|
889
|
+
/** @description Invitation created */
|
|
890
|
+
201: {
|
|
891
|
+
headers: {
|
|
892
|
+
[name: string]: unknown;
|
|
893
|
+
};
|
|
894
|
+
content: {
|
|
895
|
+
"application/json": {
|
|
896
|
+
/**
|
|
897
|
+
* Format: uuid
|
|
898
|
+
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
899
|
+
*/
|
|
900
|
+
id: string;
|
|
901
|
+
/**
|
|
902
|
+
* Format: uuid
|
|
903
|
+
* @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
|
|
904
|
+
*/
|
|
905
|
+
ownerId: string;
|
|
906
|
+
/** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
|
|
907
|
+
isDefault?: boolean;
|
|
908
|
+
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
909
|
+
name: string;
|
|
910
|
+
/** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
|
|
911
|
+
description: string;
|
|
912
|
+
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
913
|
+
emails: string[];
|
|
914
|
+
/**
|
|
915
|
+
* Format: uuid
|
|
916
|
+
* @description ID of the organization to which the user is invited.
|
|
917
|
+
*/
|
|
918
|
+
orgId: string;
|
|
919
|
+
/**
|
|
920
|
+
* Format: date-time
|
|
921
|
+
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
922
|
+
*/
|
|
923
|
+
expiresAt?: string;
|
|
924
|
+
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
925
|
+
quota?: number;
|
|
926
|
+
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
927
|
+
acceptedBy: string[];
|
|
928
|
+
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
929
|
+
roles: string[];
|
|
930
|
+
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
931
|
+
teams: string[];
|
|
932
|
+
/**
|
|
933
|
+
* @description Activation status of the invitation.
|
|
934
|
+
* @enum {string}
|
|
935
|
+
*/
|
|
936
|
+
status: "enabled" | "disabled";
|
|
937
|
+
/**
|
|
938
|
+
* Format: date-time
|
|
939
|
+
* @description Timestamp when the invitation was created.
|
|
940
|
+
*/
|
|
941
|
+
createdAt: string;
|
|
942
|
+
/**
|
|
943
|
+
* Format: date-time
|
|
944
|
+
* @description Timestamp when the invitation was last updated.
|
|
945
|
+
*/
|
|
946
|
+
updatedAt: string;
|
|
947
|
+
/**
|
|
948
|
+
* Format: date-time
|
|
949
|
+
* @description Timestamp when the invitation was deleted, if applicable.
|
|
950
|
+
*/
|
|
951
|
+
deletedAt: string;
|
|
952
|
+
};
|
|
953
|
+
};
|
|
954
|
+
};
|
|
955
|
+
/** @description Invalid request body or request param */
|
|
956
|
+
400: {
|
|
957
|
+
headers: {
|
|
958
|
+
[name: string]: unknown;
|
|
959
|
+
};
|
|
960
|
+
content: {
|
|
961
|
+
"text/plain": string;
|
|
962
|
+
};
|
|
963
|
+
};
|
|
964
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
965
|
+
401: {
|
|
966
|
+
headers: {
|
|
967
|
+
[name: string]: unknown;
|
|
968
|
+
};
|
|
969
|
+
content: {
|
|
970
|
+
"text/plain": string;
|
|
971
|
+
};
|
|
972
|
+
};
|
|
973
|
+
/** @description Internal server error */
|
|
974
|
+
500: {
|
|
975
|
+
headers: {
|
|
976
|
+
[name: string]: unknown;
|
|
977
|
+
};
|
|
978
|
+
content: {
|
|
979
|
+
"text/plain": string;
|
|
980
|
+
};
|
|
981
|
+
};
|
|
941
982
|
};
|
|
942
|
-
};
|
|
943
983
|
};
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
984
|
+
acceptInvitation: {
|
|
985
|
+
parameters: {
|
|
986
|
+
query?: never;
|
|
987
|
+
header?: never;
|
|
988
|
+
path: {
|
|
989
|
+
/** @description The ID of the invitation. */
|
|
990
|
+
invitationId: string;
|
|
991
|
+
};
|
|
992
|
+
cookie?: never;
|
|
993
|
+
};
|
|
994
|
+
requestBody?: never;
|
|
995
|
+
responses: {
|
|
996
|
+
/** @description Invitation accepted */
|
|
997
|
+
200: {
|
|
998
|
+
headers: {
|
|
999
|
+
[name: string]: unknown;
|
|
1000
|
+
};
|
|
1001
|
+
content: {
|
|
1002
|
+
"application/json": {
|
|
1003
|
+
/**
|
|
1004
|
+
* Format: uuid
|
|
1005
|
+
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
1006
|
+
*/
|
|
1007
|
+
id: string;
|
|
1008
|
+
/**
|
|
1009
|
+
* Format: uuid
|
|
1010
|
+
* @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
|
|
1011
|
+
*/
|
|
1012
|
+
ownerId: string;
|
|
1013
|
+
/** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
|
|
1014
|
+
isDefault?: boolean;
|
|
1015
|
+
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
1016
|
+
name: string;
|
|
1017
|
+
/** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
|
|
1018
|
+
description: string;
|
|
1019
|
+
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
1020
|
+
emails: string[];
|
|
1021
|
+
/**
|
|
1022
|
+
* Format: uuid
|
|
1023
|
+
* @description ID of the organization to which the user is invited.
|
|
1024
|
+
*/
|
|
1025
|
+
orgId: string;
|
|
1026
|
+
/**
|
|
1027
|
+
* Format: date-time
|
|
1028
|
+
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
1029
|
+
*/
|
|
1030
|
+
expiresAt?: string;
|
|
1031
|
+
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
1032
|
+
quota?: number;
|
|
1033
|
+
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
1034
|
+
acceptedBy: string[];
|
|
1035
|
+
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
1036
|
+
roles: string[];
|
|
1037
|
+
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
1038
|
+
teams: string[];
|
|
1039
|
+
/**
|
|
1040
|
+
* @description Activation status of the invitation.
|
|
1041
|
+
* @enum {string}
|
|
1042
|
+
*/
|
|
1043
|
+
status: "enabled" | "disabled";
|
|
1044
|
+
/**
|
|
1045
|
+
* Format: date-time
|
|
1046
|
+
* @description Timestamp when the invitation was created.
|
|
1047
|
+
*/
|
|
1048
|
+
createdAt: string;
|
|
1049
|
+
/**
|
|
1050
|
+
* Format: date-time
|
|
1051
|
+
* @description Timestamp when the invitation was last updated.
|
|
1052
|
+
*/
|
|
1053
|
+
updatedAt: string;
|
|
1054
|
+
/**
|
|
1055
|
+
* Format: date-time
|
|
1056
|
+
* @description Timestamp when the invitation was deleted, if applicable.
|
|
1057
|
+
*/
|
|
1058
|
+
deletedAt: string;
|
|
1059
|
+
};
|
|
1060
|
+
};
|
|
1061
|
+
};
|
|
1062
|
+
/** @description Invalid request body or request param */
|
|
1063
|
+
400: {
|
|
1064
|
+
headers: {
|
|
1065
|
+
[name: string]: unknown;
|
|
1066
|
+
};
|
|
1067
|
+
content: {
|
|
1068
|
+
"text/plain": string;
|
|
1069
|
+
};
|
|
1070
|
+
};
|
|
1071
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1072
|
+
401: {
|
|
1073
|
+
headers: {
|
|
1074
|
+
[name: string]: unknown;
|
|
1075
|
+
};
|
|
1076
|
+
content: {
|
|
1077
|
+
"text/plain": string;
|
|
1078
|
+
};
|
|
1079
|
+
};
|
|
1080
|
+
/** @description Result not found */
|
|
1081
|
+
404: {
|
|
1082
|
+
headers: {
|
|
1083
|
+
[name: string]: unknown;
|
|
1084
|
+
};
|
|
1085
|
+
content: {
|
|
1086
|
+
"text/plain": string;
|
|
1087
|
+
};
|
|
1088
|
+
};
|
|
1089
|
+
/** @description Internal server error */
|
|
1090
|
+
500: {
|
|
1091
|
+
headers: {
|
|
1092
|
+
[name: string]: unknown;
|
|
1093
|
+
};
|
|
1094
|
+
content: {
|
|
1095
|
+
"text/plain": string;
|
|
1096
|
+
};
|
|
1097
|
+
};
|
|
951
1098
|
};
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
1099
|
+
};
|
|
1100
|
+
handleUserInvite: {
|
|
1101
|
+
parameters: {
|
|
1102
|
+
query?: never;
|
|
1103
|
+
header?: never;
|
|
1104
|
+
path: {
|
|
1105
|
+
/** @description The ID of the organization. */
|
|
1106
|
+
orgId: string;
|
|
1107
|
+
};
|
|
1108
|
+
cookie?: never;
|
|
957
1109
|
};
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
1110
|
+
requestBody: {
|
|
1111
|
+
content: {
|
|
1112
|
+
"application/json": {
|
|
1113
|
+
[key: string]: unknown;
|
|
1114
|
+
};
|
|
1115
|
+
};
|
|
963
1116
|
};
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
1117
|
+
responses: {
|
|
1118
|
+
/** @description Invitation request accepted */
|
|
1119
|
+
200: {
|
|
1120
|
+
headers: {
|
|
1121
|
+
[name: string]: unknown;
|
|
1122
|
+
};
|
|
1123
|
+
content: {
|
|
1124
|
+
"application/json": {
|
|
1125
|
+
[key: string]: unknown;
|
|
1126
|
+
};
|
|
1127
|
+
};
|
|
1128
|
+
};
|
|
1129
|
+
/** @description Invalid request body or request param */
|
|
1130
|
+
400: {
|
|
1131
|
+
headers: {
|
|
1132
|
+
[name: string]: unknown;
|
|
1133
|
+
};
|
|
1134
|
+
content: {
|
|
1135
|
+
"text/plain": string;
|
|
1136
|
+
};
|
|
1137
|
+
};
|
|
1138
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1139
|
+
401: {
|
|
1140
|
+
headers: {
|
|
1141
|
+
[name: string]: unknown;
|
|
1142
|
+
};
|
|
1143
|
+
content: {
|
|
1144
|
+
"text/plain": string;
|
|
1145
|
+
};
|
|
1146
|
+
};
|
|
1147
|
+
/** @description Result not found */
|
|
1148
|
+
404: {
|
|
1149
|
+
headers: {
|
|
1150
|
+
[name: string]: unknown;
|
|
1151
|
+
};
|
|
1152
|
+
content: {
|
|
1153
|
+
"text/plain": string;
|
|
1154
|
+
};
|
|
1155
|
+
};
|
|
1156
|
+
/** @description Internal server error */
|
|
1157
|
+
500: {
|
|
1158
|
+
headers: {
|
|
1159
|
+
[name: string]: unknown;
|
|
1160
|
+
};
|
|
1161
|
+
content: {
|
|
1162
|
+
"text/plain": string;
|
|
1163
|
+
};
|
|
1164
|
+
};
|
|
969
1165
|
};
|
|
970
|
-
};
|
|
971
|
-
};
|
|
972
|
-
requestBody: {
|
|
973
|
-
content: {
|
|
974
|
-
"application/json": { [key: string]: unknown };
|
|
975
|
-
};
|
|
976
1166
|
};
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
1167
|
+
getSignupRequests: {
|
|
1168
|
+
parameters: {
|
|
1169
|
+
query?: {
|
|
1170
|
+
/** @description Get responses by page */
|
|
1171
|
+
page?: string;
|
|
1172
|
+
/** @description Get responses by pagesize */
|
|
1173
|
+
pagesize?: string;
|
|
1174
|
+
/** @description Get responses that match search param value */
|
|
1175
|
+
search?: string;
|
|
1176
|
+
/** @description Get ordered responses */
|
|
1177
|
+
order?: string;
|
|
1178
|
+
/** @description Get filtered reponses */
|
|
1179
|
+
filter?: string;
|
|
1180
|
+
};
|
|
1181
|
+
header?: never;
|
|
1182
|
+
path?: never;
|
|
1183
|
+
cookie?: never;
|
|
1184
|
+
};
|
|
1185
|
+
requestBody?: never;
|
|
1186
|
+
responses: {
|
|
1187
|
+
/** @description Signup requests page */
|
|
1188
|
+
200: {
|
|
1189
|
+
headers: {
|
|
1190
|
+
[name: string]: unknown;
|
|
1191
|
+
};
|
|
1192
|
+
content: {
|
|
1193
|
+
"application/json": {
|
|
1194
|
+
/** @description Current page number of the result set. */
|
|
1195
|
+
page?: number;
|
|
1196
|
+
/** @description Number of items per page. */
|
|
1197
|
+
pageSize?: number;
|
|
1198
|
+
/** @description Total number of items available. */
|
|
1199
|
+
totalCount?: number;
|
|
1200
|
+
/** @description Signup requests returned on the current page. */
|
|
1201
|
+
data?: {
|
|
1202
|
+
[key: string]: unknown;
|
|
1203
|
+
}[];
|
|
1204
|
+
};
|
|
1205
|
+
};
|
|
1206
|
+
};
|
|
1207
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1208
|
+
401: {
|
|
1209
|
+
headers: {
|
|
1210
|
+
[name: string]: unknown;
|
|
1211
|
+
};
|
|
1212
|
+
content: {
|
|
1213
|
+
"text/plain": string;
|
|
1214
|
+
};
|
|
1215
|
+
};
|
|
1216
|
+
/** @description Internal server error */
|
|
1217
|
+
500: {
|
|
1218
|
+
headers: {
|
|
1219
|
+
[name: string]: unknown;
|
|
1220
|
+
};
|
|
1221
|
+
content: {
|
|
1222
|
+
"text/plain": string;
|
|
1223
|
+
};
|
|
1224
|
+
};
|
|
984
1225
|
};
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
1226
|
+
};
|
|
1227
|
+
signupRequest: {
|
|
1228
|
+
parameters: {
|
|
1229
|
+
query?: never;
|
|
1230
|
+
header?: never;
|
|
1231
|
+
path?: never;
|
|
1232
|
+
cookie?: never;
|
|
990
1233
|
};
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
1234
|
+
requestBody: {
|
|
1235
|
+
content: {
|
|
1236
|
+
"application/json": {
|
|
1237
|
+
[key: string]: unknown;
|
|
1238
|
+
};
|
|
1239
|
+
};
|
|
996
1240
|
};
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1241
|
+
responses: {
|
|
1242
|
+
/** @description Signup request created */
|
|
1243
|
+
201: {
|
|
1244
|
+
headers: {
|
|
1245
|
+
[name: string]: unknown;
|
|
1246
|
+
};
|
|
1247
|
+
content: {
|
|
1248
|
+
"application/json": {
|
|
1249
|
+
[key: string]: unknown;
|
|
1250
|
+
};
|
|
1251
|
+
};
|
|
1252
|
+
};
|
|
1253
|
+
/** @description Invalid request body or request param */
|
|
1254
|
+
400: {
|
|
1255
|
+
headers: {
|
|
1256
|
+
[name: string]: unknown;
|
|
1257
|
+
};
|
|
1258
|
+
content: {
|
|
1259
|
+
"text/plain": string;
|
|
1260
|
+
};
|
|
1261
|
+
};
|
|
1262
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1263
|
+
401: {
|
|
1264
|
+
headers: {
|
|
1265
|
+
[name: string]: unknown;
|
|
1266
|
+
};
|
|
1267
|
+
content: {
|
|
1268
|
+
"text/plain": string;
|
|
1269
|
+
};
|
|
1270
|
+
};
|
|
1271
|
+
/** @description Internal server error */
|
|
1272
|
+
500: {
|
|
1273
|
+
headers: {
|
|
1274
|
+
[name: string]: unknown;
|
|
1275
|
+
};
|
|
1276
|
+
content: {
|
|
1277
|
+
"text/plain": string;
|
|
1278
|
+
};
|
|
1279
|
+
};
|
|
1002
1280
|
};
|
|
1003
|
-
};
|
|
1004
1281
|
};
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
"application/json": { [key: string]: unknown };
|
|
1282
|
+
approveSignupRequest: {
|
|
1283
|
+
parameters: {
|
|
1284
|
+
query?: never;
|
|
1285
|
+
header?: never;
|
|
1286
|
+
path?: never;
|
|
1287
|
+
cookie?: never;
|
|
1012
1288
|
};
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1289
|
+
requestBody?: never;
|
|
1290
|
+
responses: {
|
|
1291
|
+
/** @description Signup request approved */
|
|
1292
|
+
200: {
|
|
1293
|
+
headers: {
|
|
1294
|
+
[name: string]: unknown;
|
|
1295
|
+
};
|
|
1296
|
+
content: {
|
|
1297
|
+
"application/json": {
|
|
1298
|
+
[key: string]: unknown;
|
|
1299
|
+
};
|
|
1300
|
+
};
|
|
1301
|
+
};
|
|
1302
|
+
/** @description Invalid request body or request param */
|
|
1303
|
+
400: {
|
|
1304
|
+
headers: {
|
|
1305
|
+
[name: string]: unknown;
|
|
1306
|
+
};
|
|
1307
|
+
content: {
|
|
1308
|
+
"text/plain": string;
|
|
1309
|
+
};
|
|
1310
|
+
};
|
|
1311
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1312
|
+
401: {
|
|
1313
|
+
headers: {
|
|
1314
|
+
[name: string]: unknown;
|
|
1315
|
+
};
|
|
1316
|
+
content: {
|
|
1317
|
+
"text/plain": string;
|
|
1318
|
+
};
|
|
1319
|
+
};
|
|
1320
|
+
/** @description Internal server error */
|
|
1321
|
+
500: {
|
|
1322
|
+
headers: {
|
|
1323
|
+
[name: string]: unknown;
|
|
1324
|
+
};
|
|
1325
|
+
content: {
|
|
1326
|
+
"text/plain": string;
|
|
1327
|
+
};
|
|
1328
|
+
};
|
|
1018
1329
|
};
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1330
|
+
};
|
|
1331
|
+
denySignupRequest: {
|
|
1332
|
+
parameters: {
|
|
1333
|
+
query?: never;
|
|
1334
|
+
header?: never;
|
|
1335
|
+
path?: never;
|
|
1336
|
+
cookie?: never;
|
|
1024
1337
|
};
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1338
|
+
requestBody?: never;
|
|
1339
|
+
responses: {
|
|
1340
|
+
/** @description Signup request denied */
|
|
1341
|
+
200: {
|
|
1342
|
+
headers: {
|
|
1343
|
+
[name: string]: unknown;
|
|
1344
|
+
};
|
|
1345
|
+
content: {
|
|
1346
|
+
"application/json": {
|
|
1347
|
+
[key: string]: unknown;
|
|
1348
|
+
};
|
|
1349
|
+
};
|
|
1350
|
+
};
|
|
1351
|
+
/** @description Invalid request body or request param */
|
|
1352
|
+
400: {
|
|
1353
|
+
headers: {
|
|
1354
|
+
[name: string]: unknown;
|
|
1355
|
+
};
|
|
1356
|
+
content: {
|
|
1357
|
+
"text/plain": string;
|
|
1358
|
+
};
|
|
1359
|
+
};
|
|
1360
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1361
|
+
401: {
|
|
1362
|
+
headers: {
|
|
1363
|
+
[name: string]: unknown;
|
|
1364
|
+
};
|
|
1365
|
+
content: {
|
|
1366
|
+
"text/plain": string;
|
|
1367
|
+
};
|
|
1368
|
+
};
|
|
1369
|
+
/** @description Internal server error */
|
|
1370
|
+
500: {
|
|
1371
|
+
headers: {
|
|
1372
|
+
[name: string]: unknown;
|
|
1373
|
+
};
|
|
1374
|
+
content: {
|
|
1375
|
+
"text/plain": string;
|
|
1376
|
+
};
|
|
1377
|
+
};
|
|
1030
1378
|
};
|
|
1031
|
-
};
|
|
1032
1379
|
};
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
"application/json": { [key: string]: unknown };
|
|
1380
|
+
getSignupRequestNotification: {
|
|
1381
|
+
parameters: {
|
|
1382
|
+
query?: never;
|
|
1383
|
+
header?: never;
|
|
1384
|
+
path?: never;
|
|
1385
|
+
cookie?: never;
|
|
1040
1386
|
};
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1387
|
+
requestBody?: never;
|
|
1388
|
+
responses: {
|
|
1389
|
+
/** @description Signup request notification payload */
|
|
1390
|
+
200: {
|
|
1391
|
+
headers: {
|
|
1392
|
+
[name: string]: unknown;
|
|
1393
|
+
};
|
|
1394
|
+
content: {
|
|
1395
|
+
"application/json": {
|
|
1396
|
+
[key: string]: unknown;
|
|
1397
|
+
};
|
|
1398
|
+
};
|
|
1399
|
+
};
|
|
1400
|
+
/** @description No pending signup request notifications */
|
|
1401
|
+
204: {
|
|
1402
|
+
headers: {
|
|
1403
|
+
[name: string]: unknown;
|
|
1404
|
+
};
|
|
1405
|
+
content?: never;
|
|
1406
|
+
};
|
|
1407
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1408
|
+
401: {
|
|
1409
|
+
headers: {
|
|
1410
|
+
[name: string]: unknown;
|
|
1411
|
+
};
|
|
1412
|
+
content: {
|
|
1413
|
+
"text/plain": string;
|
|
1414
|
+
};
|
|
1415
|
+
};
|
|
1416
|
+
/** @description Internal server error */
|
|
1417
|
+
500: {
|
|
1418
|
+
headers: {
|
|
1419
|
+
[name: string]: unknown;
|
|
1420
|
+
};
|
|
1421
|
+
content: {
|
|
1422
|
+
"text/plain": string;
|
|
1423
|
+
};
|
|
1424
|
+
};
|
|
1048
1425
|
};
|
|
1049
|
-
};
|
|
1050
|
-
/** Internal server error */
|
|
1051
|
-
500: {
|
|
1052
|
-
content: {
|
|
1053
|
-
"text/plain": string;
|
|
1054
|
-
};
|
|
1055
|
-
};
|
|
1056
1426
|
};
|
|
1057
|
-
};
|
|
1058
1427
|
}
|
|
1059
|
-
|
|
1060
|
-
export interface external {}
|