@meshery/schemas 1.3.9 → 1.4.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 +28 -28
- package/dist/cloudApi.d.ts +28 -28
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +106 -111
- package/dist/constructs/v1alpha1/core/Core.d.ts +822 -734
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +45 -40
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1829 -1716
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6023 -6642
- package/dist/constructs/v1beta1/badge/Badge.d.ts +439 -600
- package/dist/constructs/v1beta1/capability/Capability.d.ts +106 -111
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +45 -40
- package/dist/constructs/v1beta1/category/Category.d.ts +38 -26
- package/dist/constructs/v1beta1/component/Component.d.ts +833 -729
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1170 -1357
- package/dist/constructs/v1beta1/core/Core.d.ts +822 -734
- package/dist/constructs/v1beta1/credential/Credential.d.ts +458 -593
- package/dist/constructs/v1beta1/environment/Environment.d.ts +666 -835
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6142 -5619
- package/dist/constructs/v1beta1/event/Event.d.ts +527 -898
- package/dist/constructs/v1beta1/feature/Feature.d.ts +343 -389
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +877 -1244
- package/dist/constructs/v1beta1/key/Key.d.ts +444 -589
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +575 -796
- package/dist/constructs/v1beta1/model/Model.d.ts +598 -572
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1410 -1829
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17988 -17171
- package/dist/constructs/v1beta1/plan/Plan.d.ts +115 -159
- package/dist/constructs/v1beta1/role/Role.d.ts +688 -933
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +315 -425
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +61 -18
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +674 -839
- package/dist/constructs/v1beta1/support/Support.d.ts +74 -115
- package/dist/constructs/v1beta1/system/System.d.ts +250 -385
- package/dist/constructs/v1beta1/team/Team.d.ts +762 -1028
- package/dist/constructs/v1beta1/token/Token.d.ts +475 -612
- package/dist/constructs/v1beta1/user/User.d.ts +1553 -1722
- package/dist/constructs/v1beta1/view/View.d.ts +664 -833
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4705 -4910
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7246 -7864
- package/dist/constructs/v1beta2/badge/Badge.d.ts +453 -610
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +45 -40
- package/dist/constructs/v1beta2/component/Component.d.ts +851 -747
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1189 -1376
- package/dist/constructs/v1beta2/core/Core.d.ts +856 -768
- package/dist/constructs/v1beta2/credential/Credential.d.ts +437 -572
- package/dist/constructs/v1beta2/design/Design.d.ts +18631 -17846
- package/dist/constructs/v1beta2/event/Event.d.ts +575 -946
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +901 -1268
- package/dist/constructs/v1beta2/key/Key.d.ts +454 -599
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +585 -806
- package/dist/constructs/v1beta2/model/Model.d.ts +636 -610
- package/dist/constructs/v1beta2/organization/Organization.d.ts +2017 -2458
- package/dist/constructs/v1beta2/plan/Plan.d.ts +128 -169
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2013 -1844
- package/dist/constructs/v1beta2/role/Role.d.ts +695 -940
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +356 -466
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +701 -866
- package/dist/constructs/v1beta2/team/Team.d.ts +852 -1118
- package/dist/constructs/v1beta2/token/Token.d.ts +479 -616
- package/dist/constructs/v1beta2/user/User.d.ts +1553 -1722
- package/dist/constructs/v1beta2/view/View.d.ts +669 -838
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7246 -7864
- package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta3/component/Component.d.ts +857 -753
- package/dist/constructs/v1beta3/connection/Connection.d.ts +5559 -5053
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +6 -6
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +6 -6
- package/dist/constructs/v1beta3/design/Design.d.ts +5297 -5719
- package/dist/constructs/v1beta3/design/DesignSchema.js +2 -2
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +2 -2
- package/dist/constructs/v1beta3/environment/Environment.d.ts +689 -858
- package/dist/constructs/v1beta3/event/Event.d.ts +666 -1041
- package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
- package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1300 -1438
- package/dist/constructs/v1beta3/filter/FilterSchema.js +7 -7
- package/dist/constructs/v1beta3/filter/FilterSchema.mjs +7 -7
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +911 -1278
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +1114 -1412
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.js +1 -1
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.mjs +1 -1
- package/dist/constructs/v1beta3/plan/Plan.d.ts +156 -197
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2013 -1844
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +804 -969
- package/dist/constructs/v1beta3/token/Token.d.ts +480 -617
- package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +4825 -5033
- package/dist/index.d.mts +5032 -5501
- package/dist/index.d.ts +5032 -5501
- package/dist/mesheryApi.d.mts +8 -8
- package/dist/mesheryApi.d.ts +8 -8
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/dist/permissions.d.mts +25 -1
- package/dist/permissions.d.ts +25 -1
- package/dist/permissions.js +1 -1
- package/dist/permissions.mjs +1 -1
- package/package.json +1 -1
|
@@ -4,255 +4,650 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
7
|
+
"/api/organizations/invitations/{invitationId}": {
|
|
8
|
+
get: operations["getInvitation"];
|
|
9
|
+
put: operations["updateInvitation"];
|
|
10
|
+
delete: operations["deleteInvitation"];
|
|
11
|
+
};
|
|
12
|
+
"/api/organizations/invitations": {
|
|
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
|
+
owner: 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;
|
|
25
107
|
};
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
delete?: never;
|
|
39
|
-
options?: never;
|
|
40
|
-
head?: never;
|
|
41
|
-
patch?: never;
|
|
42
|
-
trace?: never;
|
|
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 }[];
|
|
43
120
|
};
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
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";
|
|
60
162
|
};
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
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
|
+
owner: 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
|
+
};
|
|
77
234
|
};
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
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
|
+
owner: 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;
|
|
84
350
|
};
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
351
|
+
};
|
|
352
|
+
/** Internal server error */
|
|
353
|
+
500: {
|
|
354
|
+
content: {
|
|
355
|
+
"text/plain": string;
|
|
356
|
+
};
|
|
357
|
+
};
|
|
358
|
+
};
|
|
359
|
+
};
|
|
360
|
+
updateInvitation: {
|
|
361
|
+
parameters: {
|
|
362
|
+
path: {
|
|
363
|
+
/** The ID of the invitation. */
|
|
364
|
+
invitationId: string;
|
|
365
|
+
};
|
|
95
366
|
};
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
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
|
+
owner: 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;
|
|
102
435
|
};
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
436
|
+
};
|
|
437
|
+
/** Expired JWT token used or insufficient privilege */
|
|
438
|
+
401: {
|
|
439
|
+
content: {
|
|
440
|
+
"text/plain": string;
|
|
441
|
+
};
|
|
442
|
+
};
|
|
443
|
+
/** Result not found */
|
|
444
|
+
404: {
|
|
445
|
+
content: {
|
|
446
|
+
"text/plain": string;
|
|
447
|
+
};
|
|
448
|
+
};
|
|
449
|
+
/** Internal server error */
|
|
450
|
+
500: {
|
|
451
|
+
content: {
|
|
452
|
+
"text/plain": string;
|
|
453
|
+
};
|
|
454
|
+
};
|
|
112
455
|
};
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
456
|
+
requestBody: {
|
|
457
|
+
content: {
|
|
458
|
+
"application/json": {
|
|
459
|
+
/**
|
|
460
|
+
* Format: uuid
|
|
461
|
+
* @description Existing invitation ID for updates; omit on create.
|
|
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";
|
|
119
498
|
};
|
|
120
|
-
|
|
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;
|
|
499
|
+
};
|
|
129
500
|
};
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
501
|
+
};
|
|
502
|
+
deleteInvitation: {
|
|
503
|
+
parameters: {
|
|
504
|
+
path: {
|
|
505
|
+
/** The ID of the invitation. */
|
|
506
|
+
invitationId: string;
|
|
507
|
+
};
|
|
508
|
+
};
|
|
509
|
+
responses: {
|
|
510
|
+
/** Invitation deleted */
|
|
511
|
+
204: never;
|
|
512
|
+
/** Invalid request body or request param */
|
|
513
|
+
400: {
|
|
514
|
+
content: {
|
|
515
|
+
"text/plain": string;
|
|
516
|
+
};
|
|
517
|
+
};
|
|
518
|
+
/** Expired JWT token used or insufficient privilege */
|
|
519
|
+
401: {
|
|
520
|
+
content: {
|
|
521
|
+
"text/plain": string;
|
|
136
522
|
};
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
523
|
+
};
|
|
524
|
+
/** Result not found */
|
|
525
|
+
404: {
|
|
526
|
+
content: {
|
|
527
|
+
"text/plain": string;
|
|
528
|
+
};
|
|
529
|
+
};
|
|
530
|
+
/** Internal server error */
|
|
531
|
+
500: {
|
|
532
|
+
content: {
|
|
533
|
+
"text/plain": string;
|
|
534
|
+
};
|
|
535
|
+
};
|
|
146
536
|
};
|
|
147
|
-
}
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
*/
|
|
155
|
-
Uuid: string;
|
|
156
|
-
/** @description Paginated list of invitations for an organization. */
|
|
157
|
-
InvitationsPage: {
|
|
537
|
+
};
|
|
538
|
+
getInvitations: {
|
|
539
|
+
responses: {
|
|
540
|
+
/** Invitations page */
|
|
541
|
+
200: {
|
|
542
|
+
content: {
|
|
543
|
+
"application/json": {
|
|
158
544
|
/** @description Invitations returned on the current page. */
|
|
159
545
|
data: {
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
546
|
+
/**
|
|
547
|
+
* Format: uuid
|
|
548
|
+
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
549
|
+
*/
|
|
550
|
+
id: string;
|
|
551
|
+
/**
|
|
552
|
+
* Format: uuid
|
|
553
|
+
* @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
|
|
554
|
+
*/
|
|
555
|
+
owner: string;
|
|
556
|
+
/** @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. */
|
|
557
|
+
isDefault?: boolean;
|
|
558
|
+
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
559
|
+
name: string;
|
|
560
|
+
/** @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. */
|
|
561
|
+
description: string;
|
|
562
|
+
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
563
|
+
emails: string[];
|
|
564
|
+
/**
|
|
565
|
+
* Format: uuid
|
|
566
|
+
* @description ID of the organization to which the user is invited.
|
|
567
|
+
*/
|
|
568
|
+
orgId: string;
|
|
569
|
+
/**
|
|
570
|
+
* Format: date-time
|
|
571
|
+
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
572
|
+
*/
|
|
573
|
+
expiresAt?: string;
|
|
574
|
+
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
575
|
+
quota?: number;
|
|
576
|
+
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
577
|
+
acceptedBy: string[];
|
|
578
|
+
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
579
|
+
roles: string[];
|
|
580
|
+
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
581
|
+
teams: string[];
|
|
582
|
+
/**
|
|
583
|
+
* @description Activation status of the invitation.
|
|
584
|
+
* @enum {string}
|
|
585
|
+
*/
|
|
586
|
+
status: "enabled" | "disabled";
|
|
587
|
+
/**
|
|
588
|
+
* Format: date-time
|
|
589
|
+
* @description Timestamp when the invitation was created.
|
|
590
|
+
*/
|
|
591
|
+
createdAt: string;
|
|
592
|
+
/**
|
|
593
|
+
* Format: date-time
|
|
594
|
+
* @description Timestamp when the invitation was last updated.
|
|
595
|
+
*/
|
|
596
|
+
updatedAt: string;
|
|
597
|
+
/**
|
|
598
|
+
* Format: date-time
|
|
599
|
+
* @description Timestamp when the invitation was deleted, if applicable.
|
|
600
|
+
*/
|
|
601
|
+
deletedAt: string;
|
|
216
602
|
}[];
|
|
217
603
|
/** @description Total number of invitations available. */
|
|
218
604
|
total: number;
|
|
605
|
+
};
|
|
219
606
|
};
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
607
|
+
};
|
|
608
|
+
/** Invalid request body or request param */
|
|
609
|
+
400: {
|
|
610
|
+
content: {
|
|
611
|
+
"text/plain": string;
|
|
223
612
|
};
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
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
|
-
}[];
|
|
613
|
+
};
|
|
614
|
+
/** Expired JWT token used or insufficient privilege */
|
|
615
|
+
401: {
|
|
616
|
+
content: {
|
|
617
|
+
"text/plain": string;
|
|
236
618
|
};
|
|
237
|
-
|
|
238
|
-
|
|
619
|
+
};
|
|
620
|
+
/** Internal server error */
|
|
621
|
+
500: {
|
|
622
|
+
content: {
|
|
623
|
+
"text/plain": string;
|
|
624
|
+
};
|
|
625
|
+
};
|
|
626
|
+
};
|
|
627
|
+
};
|
|
628
|
+
createInvitation: {
|
|
629
|
+
responses: {
|
|
630
|
+
/** Invitation created */
|
|
631
|
+
201: {
|
|
632
|
+
content: {
|
|
633
|
+
"application/json": {
|
|
239
634
|
/**
|
|
240
635
|
* Format: uuid
|
|
241
|
-
* @description
|
|
636
|
+
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
242
637
|
*/
|
|
243
|
-
id
|
|
638
|
+
id: string;
|
|
244
639
|
/**
|
|
245
640
|
* Format: uuid
|
|
246
|
-
* @description ID of the user who created the invitation.
|
|
641
|
+
* @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
|
|
247
642
|
*/
|
|
248
|
-
|
|
249
|
-
/** @description Indicates whether the invitation is a default invitation (open invite). */
|
|
643
|
+
owner: string;
|
|
644
|
+
/** @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. */
|
|
250
645
|
isDefault?: boolean;
|
|
251
|
-
/** @description Name of the invitation. */
|
|
646
|
+
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
252
647
|
name: string;
|
|
253
|
-
/** @description Description of the invitation. */
|
|
648
|
+
/** @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. */
|
|
254
649
|
description: string;
|
|
255
|
-
/** @description Email addresses or patterns
|
|
650
|
+
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
256
651
|
emails: string[];
|
|
257
652
|
/**
|
|
258
653
|
* Format: uuid
|
|
@@ -261,28 +656,117 @@ export interface components {
|
|
|
261
656
|
orgId: string;
|
|
262
657
|
/**
|
|
263
658
|
* Format: date-time
|
|
264
|
-
* @description Timestamp when the invitation expires, if applicable.
|
|
659
|
+
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
265
660
|
*/
|
|
266
661
|
expiresAt?: string;
|
|
267
|
-
/** @description Quota for the invitation; limits the number of users that can accept it. */
|
|
662
|
+
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
268
663
|
quota?: number;
|
|
269
|
-
/** @description
|
|
664
|
+
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
665
|
+
acceptedBy: string[];
|
|
666
|
+
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
270
667
|
roles: string[];
|
|
271
|
-
/** @description Teams that the user will be added to when accepting the invitation. */
|
|
668
|
+
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
272
669
|
teams: string[];
|
|
273
670
|
/**
|
|
274
671
|
* @description Activation status of the invitation.
|
|
275
672
|
* @enum {string}
|
|
276
673
|
*/
|
|
277
674
|
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
|
+
};
|
|
278
691
|
};
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
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
|
+
};
|
|
755
|
+
};
|
|
756
|
+
};
|
|
757
|
+
};
|
|
758
|
+
acceptInvitation: {
|
|
759
|
+
parameters: {
|
|
760
|
+
path: {
|
|
761
|
+
/** The ID of the invitation. */
|
|
762
|
+
invitationId: string;
|
|
763
|
+
};
|
|
764
|
+
};
|
|
765
|
+
responses: {
|
|
766
|
+
/** Invitation accepted */
|
|
767
|
+
200: {
|
|
768
|
+
content: {
|
|
769
|
+
"application/json": {
|
|
286
770
|
/**
|
|
287
771
|
* Format: uuid
|
|
288
772
|
* @description Unique identifier for the invitation, also used as the invitation code.
|
|
@@ -292,7 +776,7 @@ export interface components {
|
|
|
292
776
|
* Format: uuid
|
|
293
777
|
* @description ID of the user who created the invitation. Tracks who created the invitation for auditing purposes.
|
|
294
778
|
*/
|
|
295
|
-
|
|
779
|
+
owner: string;
|
|
296
780
|
/** @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. */
|
|
297
781
|
isDefault?: boolean;
|
|
298
782
|
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
@@ -339,1089 +823,238 @@ export interface components {
|
|
|
339
823
|
* @description Timestamp when the invitation was deleted, if applicable.
|
|
340
824
|
*/
|
|
341
825
|
deletedAt: string;
|
|
826
|
+
};
|
|
342
827
|
};
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
[name: string]: unknown;
|
|
349
|
-
};
|
|
350
|
-
content: {
|
|
351
|
-
"text/plain": string;
|
|
352
|
-
};
|
|
828
|
+
};
|
|
829
|
+
/** Invalid request body or request param */
|
|
830
|
+
400: {
|
|
831
|
+
content: {
|
|
832
|
+
"text/plain": string;
|
|
353
833
|
};
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
content: {
|
|
360
|
-
"text/plain": string;
|
|
361
|
-
};
|
|
834
|
+
};
|
|
835
|
+
/** Expired JWT token used or insufficient privilege */
|
|
836
|
+
401: {
|
|
837
|
+
content: {
|
|
838
|
+
"text/plain": string;
|
|
362
839
|
};
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
content: {
|
|
369
|
-
"text/plain": string;
|
|
370
|
-
};
|
|
840
|
+
};
|
|
841
|
+
/** Result not found */
|
|
842
|
+
404: {
|
|
843
|
+
content: {
|
|
844
|
+
"text/plain": string;
|
|
371
845
|
};
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
content: {
|
|
378
|
-
"text/plain": string;
|
|
379
|
-
};
|
|
846
|
+
};
|
|
847
|
+
/** Internal server error */
|
|
848
|
+
500: {
|
|
849
|
+
content: {
|
|
850
|
+
"text/plain": string;
|
|
380
851
|
};
|
|
852
|
+
};
|
|
381
853
|
};
|
|
854
|
+
};
|
|
855
|
+
handleUserInvite: {
|
|
382
856
|
parameters: {
|
|
383
|
-
|
|
857
|
+
path: {
|
|
858
|
+
/** The ID of the organization. */
|
|
384
859
|
orgId: string;
|
|
385
|
-
|
|
386
|
-
invitationId: string;
|
|
860
|
+
};
|
|
387
861
|
};
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
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;
|
|
862
|
+
responses: {
|
|
863
|
+
/** Invitation request accepted */
|
|
864
|
+
200: {
|
|
865
|
+
content: {
|
|
866
|
+
"application/json": { [key: string]: unknown };
|
|
403
867
|
};
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
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
|
-
};
|
|
868
|
+
};
|
|
869
|
+
/** Invalid request body or request param */
|
|
870
|
+
400: {
|
|
871
|
+
content: {
|
|
872
|
+
"text/plain": string;
|
|
508
873
|
};
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
path: {
|
|
515
|
-
/** @description The ID of the invitation. */
|
|
516
|
-
invitationId: string;
|
|
517
|
-
};
|
|
518
|
-
cookie?: never;
|
|
874
|
+
};
|
|
875
|
+
/** Expired JWT token used or insufficient privilege */
|
|
876
|
+
401: {
|
|
877
|
+
content: {
|
|
878
|
+
"text/plain": string;
|
|
519
879
|
};
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
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
|
-
};
|
|
880
|
+
};
|
|
881
|
+
/** Result not found */
|
|
882
|
+
404: {
|
|
883
|
+
content: {
|
|
884
|
+
"text/plain": string;
|
|
564
885
|
};
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
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
|
-
};
|
|
886
|
+
};
|
|
887
|
+
/** Internal server error */
|
|
888
|
+
500: {
|
|
889
|
+
content: {
|
|
890
|
+
"text/plain": string;
|
|
668
891
|
};
|
|
892
|
+
};
|
|
669
893
|
};
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
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
|
-
};
|
|
894
|
+
requestBody: {
|
|
895
|
+
content: {
|
|
896
|
+
"application/json": { [key: string]: unknown };
|
|
897
|
+
};
|
|
726
898
|
};
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
responses
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
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
|
-
};
|
|
899
|
+
};
|
|
900
|
+
getSignupRequests: {
|
|
901
|
+
parameters: {
|
|
902
|
+
query: {
|
|
903
|
+
/** Get responses by page */
|
|
904
|
+
page?: string;
|
|
905
|
+
/** Get responses by pagesize */
|
|
906
|
+
pagesize?: string;
|
|
907
|
+
/** Get responses that match search param value */
|
|
908
|
+
search?: string;
|
|
909
|
+
/** Get ordered responses */
|
|
910
|
+
order?: string;
|
|
911
|
+
/** Get filtered reponses */
|
|
912
|
+
filter?: string;
|
|
913
|
+
};
|
|
835
914
|
};
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
915
|
+
responses: {
|
|
916
|
+
/** Signup requests page */
|
|
917
|
+
200: {
|
|
918
|
+
content: {
|
|
919
|
+
"application/json": {
|
|
920
|
+
/** @description Current page number of the result set. */
|
|
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
|
+
};
|
|
842
929
|
};
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
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
|
-
};
|
|
930
|
+
};
|
|
931
|
+
/** Expired JWT token used or insufficient privilege */
|
|
932
|
+
401: {
|
|
933
|
+
content: {
|
|
934
|
+
"text/plain": string;
|
|
887
935
|
};
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
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
|
-
};
|
|
936
|
+
};
|
|
937
|
+
/** Internal server error */
|
|
938
|
+
500: {
|
|
939
|
+
content: {
|
|
940
|
+
"text/plain": string;
|
|
982
941
|
};
|
|
942
|
+
};
|
|
983
943
|
};
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
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
|
-
};
|
|
944
|
+
};
|
|
945
|
+
signupRequest: {
|
|
946
|
+
responses: {
|
|
947
|
+
/** Signup request created */
|
|
948
|
+
201: {
|
|
949
|
+
content: {
|
|
950
|
+
"application/json": { [key: string]: unknown };
|
|
1098
951
|
};
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
path: {
|
|
1105
|
-
/** @description The ID of the organization. */
|
|
1106
|
-
orgId: string;
|
|
1107
|
-
};
|
|
1108
|
-
cookie?: never;
|
|
952
|
+
};
|
|
953
|
+
/** Invalid request body or request param */
|
|
954
|
+
400: {
|
|
955
|
+
content: {
|
|
956
|
+
"text/plain": string;
|
|
1109
957
|
};
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
};
|
|
958
|
+
};
|
|
959
|
+
/** Expired JWT token used or insufficient privilege */
|
|
960
|
+
401: {
|
|
961
|
+
content: {
|
|
962
|
+
"text/plain": string;
|
|
1116
963
|
};
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
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
|
-
};
|
|
964
|
+
};
|
|
965
|
+
/** Internal server error */
|
|
966
|
+
500: {
|
|
967
|
+
content: {
|
|
968
|
+
"text/plain": string;
|
|
1165
969
|
};
|
|
970
|
+
};
|
|
1166
971
|
};
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
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
|
-
};
|
|
1225
|
-
};
|
|
972
|
+
requestBody: {
|
|
973
|
+
content: {
|
|
974
|
+
"application/json": { [key: string]: unknown };
|
|
975
|
+
};
|
|
1226
976
|
};
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
|
|
977
|
+
};
|
|
978
|
+
approveSignupRequest: {
|
|
979
|
+
responses: {
|
|
980
|
+
/** Signup request approved */
|
|
981
|
+
200: {
|
|
982
|
+
content: {
|
|
983
|
+
"application/json": { [key: string]: unknown };
|
|
1233
984
|
};
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
};
|
|
985
|
+
};
|
|
986
|
+
/** Invalid request body or request param */
|
|
987
|
+
400: {
|
|
988
|
+
content: {
|
|
989
|
+
"text/plain": string;
|
|
1240
990
|
};
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
|
|
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
|
-
};
|
|
991
|
+
};
|
|
992
|
+
/** Expired JWT token used or insufficient privilege */
|
|
993
|
+
401: {
|
|
994
|
+
content: {
|
|
995
|
+
"text/plain": string;
|
|
1280
996
|
};
|
|
997
|
+
};
|
|
998
|
+
/** Internal server error */
|
|
999
|
+
500: {
|
|
1000
|
+
content: {
|
|
1001
|
+
"text/plain": string;
|
|
1002
|
+
};
|
|
1003
|
+
};
|
|
1281
1004
|
};
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1005
|
+
};
|
|
1006
|
+
denySignupRequest: {
|
|
1007
|
+
responses: {
|
|
1008
|
+
/** Signup request denied */
|
|
1009
|
+
200: {
|
|
1010
|
+
content: {
|
|
1011
|
+
"application/json": { [key: string]: unknown };
|
|
1288
1012
|
};
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
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
|
-
};
|
|
1013
|
+
};
|
|
1014
|
+
/** Invalid request body or request param */
|
|
1015
|
+
400: {
|
|
1016
|
+
content: {
|
|
1017
|
+
"text/plain": string;
|
|
1329
1018
|
};
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
path?: never;
|
|
1336
|
-
cookie?: never;
|
|
1019
|
+
};
|
|
1020
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1021
|
+
401: {
|
|
1022
|
+
content: {
|
|
1023
|
+
"text/plain": string;
|
|
1337
1024
|
};
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
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
|
-
};
|
|
1025
|
+
};
|
|
1026
|
+
/** Internal server error */
|
|
1027
|
+
500: {
|
|
1028
|
+
content: {
|
|
1029
|
+
"text/plain": string;
|
|
1378
1030
|
};
|
|
1031
|
+
};
|
|
1379
1032
|
};
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
|
|
1033
|
+
};
|
|
1034
|
+
getSignupRequestNotification: {
|
|
1035
|
+
responses: {
|
|
1036
|
+
/** Signup request notification payload */
|
|
1037
|
+
200: {
|
|
1038
|
+
content: {
|
|
1039
|
+
"application/json": { [key: string]: unknown };
|
|
1386
1040
|
};
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
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
|
-
};
|
|
1041
|
+
};
|
|
1042
|
+
/** No pending signup request notifications */
|
|
1043
|
+
204: never;
|
|
1044
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1045
|
+
401: {
|
|
1046
|
+
content: {
|
|
1047
|
+
"text/plain": string;
|
|
1425
1048
|
};
|
|
1049
|
+
};
|
|
1050
|
+
/** Internal server error */
|
|
1051
|
+
500: {
|
|
1052
|
+
content: {
|
|
1053
|
+
"text/plain": string;
|
|
1054
|
+
};
|
|
1055
|
+
};
|
|
1426
1056
|
};
|
|
1057
|
+
};
|
|
1427
1058
|
}
|
|
1059
|
+
|
|
1060
|
+
export interface external {}
|