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