@meshery/schemas 1.2.22 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +1719 -1518
- package/dist/cloudApi.d.ts +1719 -1518
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6648 -6029
- package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
- package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
- package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
- package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
- package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
- package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
- package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
- package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
- package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
- package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
- package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
- package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
- package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
- package/dist/constructs/v1beta1/system/System.d.ts +434 -0
- package/dist/constructs/v1beta1/system/System.js +1 -0
- package/dist/constructs/v1beta1/system/System.mjs +0 -0
- package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
- package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
- package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
- package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta1/view/View.d.ts +833 -664
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
- package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
- package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
- package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
- package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
- package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
- package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
- package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
- package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
- package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
- package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
- package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta2/view/View.d.ts +838 -669
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7836 -7218
- package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
- package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
- package/dist/constructs/v1beta3/design/Design.d.ts +5727 -5305
- package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
- package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
- package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
- package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
- package/dist/index.d.mts +5480 -5022
- package/dist/index.d.ts +5480 -5022
- package/dist/mesheryApi.d.mts +1314 -522
- package/dist/mesheryApi.d.ts +1314 -522
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -2
|
@@ -4,360 +4,163 @@
|
|
|
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
|
-
};
|
|
27
|
-
"/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}": {
|
|
28
|
-
/** Associates a keychain with the specified role. */
|
|
29
|
-
post: operations["assignKeychainToRole"];
|
|
30
|
-
/** Removes the association between a keychain and a role. */
|
|
31
|
-
delete: operations["unassignKeychainFromRole"];
|
|
32
|
-
};
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
export interface components {
|
|
36
|
-
schemas: {
|
|
37
|
-
/** @description Role definition */
|
|
38
|
-
Role: {
|
|
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
|
-
id?: string;
|
|
44
|
-
/** @description Unique name of the role. */
|
|
45
|
-
roleName: string;
|
|
46
|
-
/** @description Human-readable description of the role. */
|
|
47
|
-
description: string;
|
|
48
|
-
/**
|
|
49
|
-
* Format: date-time
|
|
50
|
-
* @description Timestamp when the role was created.
|
|
51
|
-
*/
|
|
52
|
-
createdAt?: string;
|
|
53
|
-
/**
|
|
54
|
-
* Format: date-time
|
|
55
|
-
* @description Timestamp when the role was last updated.
|
|
56
|
-
*/
|
|
57
|
-
updatedAt?: string;
|
|
58
|
-
/**
|
|
59
|
-
* Format: date-time
|
|
60
|
-
* @description Timestamp when the role was soft-deleted, if applicable.
|
|
61
|
-
*/
|
|
62
|
-
deletedAt?: string;
|
|
63
|
-
};
|
|
64
|
-
/** @description Payload for upserting a role. Includes only client-settable fields. */
|
|
65
|
-
RolePayload: {
|
|
66
|
-
/**
|
|
67
|
-
* Format: uuid
|
|
68
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
69
|
-
*/
|
|
70
|
-
id?: string;
|
|
71
|
-
/** @description Unique name of the role. */
|
|
72
|
-
roleName: string;
|
|
73
|
-
/** @description Human-readable description of the role. */
|
|
74
|
-
description: string;
|
|
7
|
+
"/api/identity/roles": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
get?: never;
|
|
15
|
+
put?: never;
|
|
16
|
+
/**
|
|
17
|
+
* Add role holder
|
|
18
|
+
* @description Assigns a role to a user identified by email.
|
|
19
|
+
*/
|
|
20
|
+
post: operations["addRoleHolder"];
|
|
21
|
+
delete?: never;
|
|
22
|
+
options?: never;
|
|
23
|
+
head?: never;
|
|
24
|
+
patch?: never;
|
|
25
|
+
trace?: never;
|
|
75
26
|
};
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
27
|
+
"/api/identity/roles/{roleId}": {
|
|
28
|
+
parameters: {
|
|
29
|
+
query?: never;
|
|
30
|
+
header?: never;
|
|
31
|
+
path?: never;
|
|
32
|
+
cookie?: never;
|
|
33
|
+
};
|
|
34
|
+
get?: never;
|
|
35
|
+
put?: never;
|
|
36
|
+
post?: never;
|
|
86
37
|
/**
|
|
87
|
-
*
|
|
88
|
-
* @description
|
|
38
|
+
* Delete role
|
|
39
|
+
* @description Removes a role assignment by ID.
|
|
89
40
|
*/
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
41
|
+
delete: operations["deleteRole"];
|
|
42
|
+
options?: never;
|
|
43
|
+
head?: never;
|
|
44
|
+
patch?: never;
|
|
45
|
+
trace?: never;
|
|
46
|
+
};
|
|
47
|
+
"/api/identity/orgs/{orgId}/roles": {
|
|
48
|
+
parameters: {
|
|
49
|
+
query?: never;
|
|
50
|
+
header?: never;
|
|
51
|
+
path?: never;
|
|
52
|
+
cookie?: never;
|
|
53
|
+
};
|
|
95
54
|
/**
|
|
96
|
-
*
|
|
97
|
-
* @description
|
|
55
|
+
* Get organization roles
|
|
56
|
+
* @description Returns all roles defined for the specified organization.
|
|
98
57
|
*/
|
|
99
|
-
|
|
58
|
+
get: operations["getAllRoles"];
|
|
100
59
|
/**
|
|
101
|
-
*
|
|
102
|
-
* @description
|
|
60
|
+
* Bulk edit role holders
|
|
61
|
+
* @description Updates role assignments for multiple users in the organization.
|
|
103
62
|
*/
|
|
104
|
-
|
|
63
|
+
put: operations["bulkEditRoleHolder"];
|
|
105
64
|
/**
|
|
106
|
-
*
|
|
107
|
-
* @description
|
|
65
|
+
* Upsert organization role
|
|
66
|
+
* @description Creates or updates a role for the specified organization.
|
|
108
67
|
*/
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
* Format: uuid
|
|
116
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
117
|
-
*/
|
|
118
|
-
id: string;
|
|
119
|
-
/**
|
|
120
|
-
* Format: uuid
|
|
121
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
122
|
-
*/
|
|
123
|
-
keychainId: string;
|
|
124
|
-
/**
|
|
125
|
-
* Format: uuid
|
|
126
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
127
|
-
*/
|
|
128
|
-
roleId: string;
|
|
129
|
-
/**
|
|
130
|
-
* Format: date-time
|
|
131
|
-
* @description Timestamp when the mapping was created.
|
|
132
|
-
*/
|
|
133
|
-
createdAt: string;
|
|
134
|
-
/**
|
|
135
|
-
* Format: date-time
|
|
136
|
-
* @description Timestamp when the mapping was last updated.
|
|
137
|
-
*/
|
|
138
|
-
updatedAt: string;
|
|
139
|
-
/**
|
|
140
|
-
* Format: date-time
|
|
141
|
-
* @description Timestamp when the mapping was soft-deleted, if applicable.
|
|
142
|
-
*/
|
|
143
|
-
deletedAt?: string;
|
|
144
|
-
};
|
|
145
|
-
/** @description Request body for assigning a role to a user. */
|
|
146
|
-
RoleHolderRequest: {
|
|
147
|
-
/**
|
|
148
|
-
* Format: email
|
|
149
|
-
* @description Email of the user to assign roles to.
|
|
150
|
-
*/
|
|
151
|
-
email: string;
|
|
152
|
-
/** @description List of role names to assign. */
|
|
153
|
-
roleNames: string[];
|
|
68
|
+
post: operations["upsertRole"];
|
|
69
|
+
delete?: never;
|
|
70
|
+
options?: never;
|
|
71
|
+
head?: never;
|
|
72
|
+
patch?: never;
|
|
73
|
+
trace?: never;
|
|
154
74
|
};
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
/** @description First name of the user. */
|
|
175
|
-
firstName?: string;
|
|
176
|
-
/** @description Last name of the user. */
|
|
177
|
-
lastName?: string;
|
|
178
|
-
/** @description Current status of the user. */
|
|
179
|
-
status?: string;
|
|
180
|
-
/** @description Role names currently or newly assigned to the user. */
|
|
181
|
-
roleNames?: string[];
|
|
182
|
-
/**
|
|
183
|
-
* Format: date-time
|
|
184
|
-
* @description Timestamp when the user was created.
|
|
185
|
-
*/
|
|
186
|
-
createdAt?: string;
|
|
187
|
-
/**
|
|
188
|
-
* Format: date-time
|
|
189
|
-
* @description Timestamp when the user was last updated.
|
|
190
|
-
*/
|
|
191
|
-
updatedAt?: string;
|
|
192
|
-
/**
|
|
193
|
-
* Format: date-time
|
|
194
|
-
* @description Timestamp when the user was soft-deleted, if applicable.
|
|
195
|
-
*/
|
|
196
|
-
deletedAt?: string;
|
|
197
|
-
};
|
|
198
|
-
/** @description User notification preferences. */
|
|
199
|
-
Preference: {
|
|
200
|
-
/** @description Whether to send a welcome email to new users. */
|
|
201
|
-
welcomeEmail: boolean;
|
|
202
|
-
/** @description Whether to notify the user of role changes. */
|
|
203
|
-
notifyRoleChange: boolean;
|
|
204
|
-
};
|
|
205
|
-
};
|
|
206
|
-
responses: {
|
|
207
|
-
/** Invalid request body or request param */
|
|
208
|
-
400: {
|
|
209
|
-
content: {
|
|
210
|
-
"text/plain": string;
|
|
211
|
-
};
|
|
212
|
-
};
|
|
213
|
-
/** Expired JWT token used or insufficient privilege */
|
|
214
|
-
401: {
|
|
215
|
-
content: {
|
|
216
|
-
"text/plain": string;
|
|
217
|
-
};
|
|
218
|
-
};
|
|
219
|
-
/** Result not found */
|
|
220
|
-
404: {
|
|
221
|
-
content: {
|
|
222
|
-
"text/plain": string;
|
|
223
|
-
};
|
|
75
|
+
"/api/identity/orgs/{orgId}/roles/{roleId}/keychains": {
|
|
76
|
+
parameters: {
|
|
77
|
+
query?: never;
|
|
78
|
+
header?: never;
|
|
79
|
+
path?: never;
|
|
80
|
+
cookie?: never;
|
|
81
|
+
};
|
|
82
|
+
/**
|
|
83
|
+
* Get keychains for role
|
|
84
|
+
* @description Returns all keychains assigned to the specified role.
|
|
85
|
+
*/
|
|
86
|
+
get: operations["getRoleKeychains"];
|
|
87
|
+
put?: never;
|
|
88
|
+
post?: never;
|
|
89
|
+
delete?: never;
|
|
90
|
+
options?: never;
|
|
91
|
+
head?: never;
|
|
92
|
+
patch?: never;
|
|
93
|
+
trace?: never;
|
|
224
94
|
};
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
95
|
+
"/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}": {
|
|
96
|
+
parameters: {
|
|
97
|
+
query?: never;
|
|
98
|
+
header?: never;
|
|
99
|
+
path?: never;
|
|
100
|
+
cookie?: never;
|
|
101
|
+
};
|
|
102
|
+
get?: never;
|
|
103
|
+
put?: never;
|
|
104
|
+
/**
|
|
105
|
+
* Assign keychain to role
|
|
106
|
+
* @description Associates a keychain with the specified role.
|
|
107
|
+
*/
|
|
108
|
+
post: operations["assignKeychainToRole"];
|
|
109
|
+
/**
|
|
110
|
+
* Unassign keychain from role
|
|
111
|
+
* @description Removes the association between a keychain and a role.
|
|
112
|
+
*/
|
|
113
|
+
delete: operations["unassignKeychainFromRole"];
|
|
114
|
+
options?: never;
|
|
115
|
+
head?: never;
|
|
116
|
+
patch?: never;
|
|
117
|
+
trace?: never;
|
|
230
118
|
};
|
|
231
|
-
};
|
|
232
|
-
parameters: {
|
|
233
|
-
/** @description Organization ID */
|
|
234
|
-
orgId: string;
|
|
235
|
-
/** @description Role ID */
|
|
236
|
-
roleId: string;
|
|
237
|
-
/** @description Keychain ID */
|
|
238
|
-
keychainId: string;
|
|
239
|
-
/** @description Get responses by page */
|
|
240
|
-
page: string;
|
|
241
|
-
/** @description Get responses by page size */
|
|
242
|
-
pageSize: string;
|
|
243
|
-
/** @description Get responses that match search param value */
|
|
244
|
-
search: string;
|
|
245
|
-
/** @description Get ordered responses */
|
|
246
|
-
order: string;
|
|
247
|
-
/** @description Get all possible entries */
|
|
248
|
-
all: boolean;
|
|
249
|
-
/** @description Role grouping selector such as provider, organization, or team. */
|
|
250
|
-
selector: string;
|
|
251
|
-
/** @description Team ID used when selector is team. */
|
|
252
|
-
teamIdQuery: string;
|
|
253
|
-
};
|
|
254
119
|
}
|
|
255
|
-
|
|
256
|
-
export interface
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
/** Role ID */
|
|
300
|
-
roleId: string;
|
|
301
|
-
};
|
|
302
|
-
};
|
|
303
|
-
responses: {
|
|
304
|
-
/** Role deleted */
|
|
305
|
-
204: never;
|
|
306
|
-
/** Invalid request body or request param */
|
|
307
|
-
400: {
|
|
308
|
-
content: {
|
|
309
|
-
"text/plain": string;
|
|
310
|
-
};
|
|
311
|
-
};
|
|
312
|
-
/** Expired JWT token used or insufficient privilege */
|
|
313
|
-
401: {
|
|
314
|
-
content: {
|
|
315
|
-
"text/plain": string;
|
|
316
|
-
};
|
|
317
|
-
};
|
|
318
|
-
/** Result not found */
|
|
319
|
-
404: {
|
|
320
|
-
content: {
|
|
321
|
-
"text/plain": string;
|
|
322
|
-
};
|
|
323
|
-
};
|
|
324
|
-
/** Internal server error */
|
|
325
|
-
500: {
|
|
326
|
-
content: {
|
|
327
|
-
"text/plain": string;
|
|
328
|
-
};
|
|
329
|
-
};
|
|
330
|
-
};
|
|
331
|
-
};
|
|
332
|
-
/** Returns all roles defined for the specified organization. */
|
|
333
|
-
getAllRoles: {
|
|
334
|
-
parameters: {
|
|
335
|
-
path: {
|
|
336
|
-
/** Organization ID */
|
|
337
|
-
orgId: string;
|
|
338
|
-
};
|
|
339
|
-
query: {
|
|
340
|
-
/** Get responses by page */
|
|
341
|
-
page?: string;
|
|
342
|
-
/** Get responses by page size */
|
|
343
|
-
pageSize?: string;
|
|
344
|
-
/** Get responses that match search param value */
|
|
345
|
-
search?: string;
|
|
346
|
-
/** Get ordered responses */
|
|
347
|
-
order?: string;
|
|
348
|
-
/** Get all possible entries */
|
|
349
|
-
all?: boolean;
|
|
350
|
-
/** Role grouping selector such as provider, organization, or team. */
|
|
351
|
-
selector?: string;
|
|
352
|
-
/** Team ID used when selector is team. */
|
|
353
|
-
teamId?: string;
|
|
354
|
-
};
|
|
355
|
-
};
|
|
356
|
-
responses: {
|
|
357
|
-
/** Roles response */
|
|
358
|
-
200: {
|
|
359
|
-
content: {
|
|
360
|
-
"application/json": {
|
|
120
|
+
export type webhooks = Record<string, never>;
|
|
121
|
+
export interface components {
|
|
122
|
+
schemas: {
|
|
123
|
+
/** @description Role definition */
|
|
124
|
+
Role: {
|
|
125
|
+
/**
|
|
126
|
+
* Format: uuid
|
|
127
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
128
|
+
*/
|
|
129
|
+
id?: string;
|
|
130
|
+
/** @description Unique name of the role. */
|
|
131
|
+
roleName: string;
|
|
132
|
+
/** @description Human-readable description of the role. */
|
|
133
|
+
description: string;
|
|
134
|
+
/**
|
|
135
|
+
* Format: date-time
|
|
136
|
+
* @description Timestamp when the role was created.
|
|
137
|
+
*/
|
|
138
|
+
createdAt?: string;
|
|
139
|
+
/**
|
|
140
|
+
* Format: date-time
|
|
141
|
+
* @description Timestamp when the role was last updated.
|
|
142
|
+
*/
|
|
143
|
+
updatedAt?: string;
|
|
144
|
+
/**
|
|
145
|
+
* Format: date-time
|
|
146
|
+
* @description Timestamp when the role was soft-deleted, if applicable.
|
|
147
|
+
*/
|
|
148
|
+
deletedAt?: string;
|
|
149
|
+
};
|
|
150
|
+
/** @description Payload for upserting a role. Includes only client-settable fields. */
|
|
151
|
+
RolePayload: {
|
|
152
|
+
/**
|
|
153
|
+
* Format: uuid
|
|
154
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
155
|
+
*/
|
|
156
|
+
id?: string;
|
|
157
|
+
/** @description Unique name of the role. */
|
|
158
|
+
roleName: string;
|
|
159
|
+
/** @description Human-readable description of the role. */
|
|
160
|
+
description: string;
|
|
161
|
+
};
|
|
162
|
+
/** @description A paginated list of roles. */
|
|
163
|
+
RolesPage: {
|
|
361
164
|
/** @description Current page number (zero-based). */
|
|
362
165
|
page: number;
|
|
363
166
|
/** @description Number of roles per page. */
|
|
@@ -366,387 +169,829 @@ export interface operations {
|
|
|
366
169
|
totalCount: number;
|
|
367
170
|
/** @description The roles of the rolespage. */
|
|
368
171
|
roles: {
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
172
|
+
/**
|
|
173
|
+
* Format: uuid
|
|
174
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
175
|
+
*/
|
|
176
|
+
id?: string;
|
|
177
|
+
/** @description Unique name of the role. */
|
|
178
|
+
roleName: string;
|
|
179
|
+
/** @description Human-readable description of the role. */
|
|
180
|
+
description: string;
|
|
181
|
+
/**
|
|
182
|
+
* Format: date-time
|
|
183
|
+
* @description Timestamp when the role was created.
|
|
184
|
+
*/
|
|
185
|
+
createdAt?: string;
|
|
186
|
+
/**
|
|
187
|
+
* Format: date-time
|
|
188
|
+
* @description Timestamp when the role was last updated.
|
|
189
|
+
*/
|
|
190
|
+
updatedAt?: string;
|
|
191
|
+
/**
|
|
192
|
+
* Format: date-time
|
|
193
|
+
* @description Timestamp when the role was soft-deleted, if applicable.
|
|
194
|
+
*/
|
|
195
|
+
deletedAt?: string;
|
|
393
196
|
}[];
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
/** Result not found */
|
|
441
|
-
404: {
|
|
442
|
-
content: {
|
|
443
|
-
"text/plain": string;
|
|
444
|
-
};
|
|
445
|
-
};
|
|
446
|
-
/** Internal server error */
|
|
447
|
-
500: {
|
|
448
|
-
content: {
|
|
449
|
-
"text/plain": string;
|
|
450
|
-
};
|
|
451
|
-
};
|
|
452
|
-
};
|
|
453
|
-
requestBody: {
|
|
454
|
-
content: {
|
|
455
|
-
"application/json": {
|
|
456
|
-
/**
|
|
457
|
-
* Format: uuid
|
|
458
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
459
|
-
*/
|
|
460
|
-
id?: string;
|
|
461
|
-
/**
|
|
462
|
-
* Format: uuid
|
|
463
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
464
|
-
*/
|
|
465
|
-
userId?: string;
|
|
466
|
-
/** @description The username of the user. */
|
|
467
|
-
username?: string;
|
|
468
|
-
/**
|
|
469
|
-
* Format: email
|
|
470
|
-
* @description Email address of the user.
|
|
471
|
-
*/
|
|
472
|
-
email?: string;
|
|
473
|
-
/** @description First name of the user. */
|
|
474
|
-
firstName?: string;
|
|
475
|
-
/** @description Last name of the user. */
|
|
476
|
-
lastName?: string;
|
|
477
|
-
/** @description Current status of the user. */
|
|
478
|
-
status?: string;
|
|
479
|
-
/** @description Role names currently or newly assigned to the user. */
|
|
480
|
-
roleNames?: string[];
|
|
481
|
-
/**
|
|
482
|
-
* Format: date-time
|
|
483
|
-
* @description Timestamp when the user was created.
|
|
484
|
-
*/
|
|
485
|
-
createdAt?: string;
|
|
486
|
-
/**
|
|
487
|
-
* Format: date-time
|
|
488
|
-
* @description Timestamp when the user was last updated.
|
|
489
|
-
*/
|
|
490
|
-
updatedAt?: string;
|
|
491
|
-
/**
|
|
492
|
-
* Format: date-time
|
|
493
|
-
* @description Timestamp when the user was soft-deleted, if applicable.
|
|
494
|
-
*/
|
|
495
|
-
deletedAt?: string;
|
|
496
|
-
}[];
|
|
497
|
-
};
|
|
498
|
-
};
|
|
499
|
-
};
|
|
500
|
-
/** Creates or updates a role for the specified organization. */
|
|
501
|
-
upsertRole: {
|
|
502
|
-
parameters: {
|
|
503
|
-
path: {
|
|
504
|
-
/** Organization ID */
|
|
505
|
-
orgId: string;
|
|
506
|
-
};
|
|
507
|
-
};
|
|
508
|
-
responses: {
|
|
509
|
-
/** Role upserted */
|
|
510
|
-
200: {
|
|
511
|
-
content: {
|
|
512
|
-
"application/json": {
|
|
197
|
+
};
|
|
198
|
+
/** @description Mapping between a role and a keychain. */
|
|
199
|
+
RolesKeychainsMapping: {
|
|
200
|
+
/**
|
|
201
|
+
* Format: uuid
|
|
202
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
203
|
+
*/
|
|
204
|
+
id: string;
|
|
205
|
+
/**
|
|
206
|
+
* Format: uuid
|
|
207
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
208
|
+
*/
|
|
209
|
+
keychainId: string;
|
|
210
|
+
/**
|
|
211
|
+
* Format: uuid
|
|
212
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
213
|
+
*/
|
|
214
|
+
roleId: string;
|
|
215
|
+
/**
|
|
216
|
+
* Format: date-time
|
|
217
|
+
* @description Timestamp when the mapping was created.
|
|
218
|
+
*/
|
|
219
|
+
createdAt: string;
|
|
220
|
+
/**
|
|
221
|
+
* Format: date-time
|
|
222
|
+
* @description Timestamp when the mapping was last updated.
|
|
223
|
+
*/
|
|
224
|
+
updatedAt: string;
|
|
225
|
+
/**
|
|
226
|
+
* Format: date-time
|
|
227
|
+
* @description Timestamp when the mapping was soft-deleted, if applicable.
|
|
228
|
+
*/
|
|
229
|
+
deletedAt?: string;
|
|
230
|
+
};
|
|
231
|
+
/** @description Request body for assigning a role to a user. */
|
|
232
|
+
RoleHolderRequest: {
|
|
233
|
+
/**
|
|
234
|
+
* Format: email
|
|
235
|
+
* @description Email of the user to assign roles to.
|
|
236
|
+
*/
|
|
237
|
+
email: string;
|
|
238
|
+
/** @description List of role names to assign. */
|
|
239
|
+
roleNames: string[];
|
|
240
|
+
};
|
|
241
|
+
/** @description Request to update role assignments for a user. */
|
|
242
|
+
UserRoleUpdateRequest: {
|
|
513
243
|
/**
|
|
514
244
|
* Format: uuid
|
|
515
245
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
516
246
|
*/
|
|
517
247
|
id?: string;
|
|
518
|
-
/**
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
248
|
+
/**
|
|
249
|
+
* Format: uuid
|
|
250
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
251
|
+
*/
|
|
252
|
+
userId?: string;
|
|
253
|
+
/** @description The username of the user. */
|
|
254
|
+
username?: string;
|
|
255
|
+
/**
|
|
256
|
+
* Format: email
|
|
257
|
+
* @description Email address of the user.
|
|
258
|
+
*/
|
|
259
|
+
email?: string;
|
|
260
|
+
/** @description First name of the user. */
|
|
261
|
+
firstName?: string;
|
|
262
|
+
/** @description Last name of the user. */
|
|
263
|
+
lastName?: string;
|
|
264
|
+
/** @description Current status of the user. */
|
|
265
|
+
status?: string;
|
|
266
|
+
/** @description Role names currently or newly assigned to the user. */
|
|
267
|
+
roleNames?: string[];
|
|
522
268
|
/**
|
|
523
269
|
* Format: date-time
|
|
524
|
-
* @description Timestamp when the
|
|
270
|
+
* @description Timestamp when the user was created.
|
|
525
271
|
*/
|
|
526
272
|
createdAt?: string;
|
|
527
273
|
/**
|
|
528
274
|
* Format: date-time
|
|
529
|
-
* @description Timestamp when the
|
|
275
|
+
* @description Timestamp when the user was last updated.
|
|
530
276
|
*/
|
|
531
277
|
updatedAt?: string;
|
|
532
278
|
/**
|
|
533
279
|
* Format: date-time
|
|
534
|
-
* @description Timestamp when the
|
|
280
|
+
* @description Timestamp when the user was soft-deleted, if applicable.
|
|
535
281
|
*/
|
|
536
282
|
deletedAt?: string;
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
};
|
|
545
|
-
};
|
|
546
|
-
/** Expired JWT token used or insufficient privilege */
|
|
547
|
-
401: {
|
|
548
|
-
content: {
|
|
549
|
-
"text/plain": string;
|
|
550
|
-
};
|
|
551
|
-
};
|
|
552
|
-
/** Result not found */
|
|
553
|
-
404: {
|
|
554
|
-
content: {
|
|
555
|
-
"text/plain": string;
|
|
556
|
-
};
|
|
557
|
-
};
|
|
558
|
-
/** Internal server error */
|
|
559
|
-
500: {
|
|
560
|
-
content: {
|
|
561
|
-
"text/plain": string;
|
|
562
|
-
};
|
|
563
|
-
};
|
|
564
|
-
};
|
|
565
|
-
requestBody: {
|
|
566
|
-
content: {
|
|
567
|
-
"application/json": {
|
|
568
|
-
/**
|
|
569
|
-
* Format: uuid
|
|
570
|
-
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
571
|
-
*/
|
|
572
|
-
id?: string;
|
|
573
|
-
/** @description Unique name of the role. */
|
|
574
|
-
roleName: string;
|
|
575
|
-
/** @description Human-readable description of the role. */
|
|
576
|
-
description: string;
|
|
577
|
-
};
|
|
578
|
-
};
|
|
579
|
-
};
|
|
580
|
-
};
|
|
581
|
-
/** Returns all keychains assigned to the specified role. */
|
|
582
|
-
getRoleKeychains: {
|
|
583
|
-
parameters: {
|
|
584
|
-
path: {
|
|
585
|
-
/** Organization ID */
|
|
586
|
-
orgId: string;
|
|
587
|
-
/** Role ID */
|
|
588
|
-
roleId: string;
|
|
589
|
-
};
|
|
590
|
-
query: {
|
|
591
|
-
/** Get responses by page */
|
|
592
|
-
page?: string;
|
|
593
|
-
/** Get responses by page size */
|
|
594
|
-
pageSize?: string;
|
|
595
|
-
/** Get responses that match search param value */
|
|
596
|
-
search?: string;
|
|
597
|
-
/** Get ordered responses */
|
|
598
|
-
order?: string;
|
|
599
|
-
};
|
|
283
|
+
};
|
|
284
|
+
/** @description User notification preferences. */
|
|
285
|
+
Preference: {
|
|
286
|
+
/** @description Whether to send a welcome email to new users. */
|
|
287
|
+
welcomeEmail: boolean;
|
|
288
|
+
/** @description Whether to notify the user of role changes. */
|
|
289
|
+
notifyRoleChange: boolean;
|
|
290
|
+
};
|
|
600
291
|
};
|
|
601
292
|
responses: {
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
}[];
|
|
639
|
-
};
|
|
640
|
-
};
|
|
641
|
-
};
|
|
642
|
-
/** Invalid request body or request param */
|
|
643
|
-
400: {
|
|
644
|
-
content: {
|
|
645
|
-
"text/plain": string;
|
|
646
|
-
};
|
|
647
|
-
};
|
|
648
|
-
/** Expired JWT token used or insufficient privilege */
|
|
649
|
-
401: {
|
|
650
|
-
content: {
|
|
651
|
-
"text/plain": string;
|
|
652
|
-
};
|
|
653
|
-
};
|
|
654
|
-
/** Result not found */
|
|
655
|
-
404: {
|
|
656
|
-
content: {
|
|
657
|
-
"text/plain": string;
|
|
658
|
-
};
|
|
659
|
-
};
|
|
660
|
-
/** Internal server error */
|
|
661
|
-
500: {
|
|
662
|
-
content: {
|
|
663
|
-
"text/plain": string;
|
|
664
|
-
};
|
|
665
|
-
};
|
|
293
|
+
/** @description Invalid request body or request param */
|
|
294
|
+
400: {
|
|
295
|
+
headers: {
|
|
296
|
+
[name: string]: unknown;
|
|
297
|
+
};
|
|
298
|
+
content: {
|
|
299
|
+
"text/plain": string;
|
|
300
|
+
};
|
|
301
|
+
};
|
|
302
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
303
|
+
401: {
|
|
304
|
+
headers: {
|
|
305
|
+
[name: string]: unknown;
|
|
306
|
+
};
|
|
307
|
+
content: {
|
|
308
|
+
"text/plain": string;
|
|
309
|
+
};
|
|
310
|
+
};
|
|
311
|
+
/** @description Result not found */
|
|
312
|
+
404: {
|
|
313
|
+
headers: {
|
|
314
|
+
[name: string]: unknown;
|
|
315
|
+
};
|
|
316
|
+
content: {
|
|
317
|
+
"text/plain": string;
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
/** @description Internal server error */
|
|
321
|
+
500: {
|
|
322
|
+
headers: {
|
|
323
|
+
[name: string]: unknown;
|
|
324
|
+
};
|
|
325
|
+
content: {
|
|
326
|
+
"text/plain": string;
|
|
327
|
+
};
|
|
328
|
+
};
|
|
666
329
|
};
|
|
667
|
-
};
|
|
668
|
-
/** Associates a keychain with the specified role. */
|
|
669
|
-
assignKeychainToRole: {
|
|
670
330
|
parameters: {
|
|
671
|
-
|
|
672
|
-
/** Organization ID */
|
|
331
|
+
/** @description Organization ID */
|
|
673
332
|
orgId: string;
|
|
674
|
-
/** Role ID */
|
|
333
|
+
/** @description Role ID */
|
|
675
334
|
roleId: string;
|
|
676
|
-
/** Keychain ID */
|
|
335
|
+
/** @description Keychain ID */
|
|
677
336
|
keychainId: string;
|
|
678
|
-
|
|
337
|
+
/** @description Get responses by page */
|
|
338
|
+
page: string;
|
|
339
|
+
/** @description Get responses by page size */
|
|
340
|
+
pageSize: string;
|
|
341
|
+
/** @description Get responses that match search param value */
|
|
342
|
+
search: string;
|
|
343
|
+
/** @description Get ordered responses */
|
|
344
|
+
order: string;
|
|
345
|
+
/** @description Get all possible entries */
|
|
346
|
+
all: boolean;
|
|
347
|
+
/** @description Role grouping selector such as provider, organization, or team. */
|
|
348
|
+
selector: string;
|
|
349
|
+
/** @description Team ID used when selector is team. */
|
|
350
|
+
teamIdQuery: string;
|
|
679
351
|
};
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
};
|
|
706
|
-
|
|
352
|
+
requestBodies: never;
|
|
353
|
+
headers: never;
|
|
354
|
+
pathItems: never;
|
|
355
|
+
}
|
|
356
|
+
export type $defs = Record<string, never>;
|
|
357
|
+
export interface operations {
|
|
358
|
+
addRoleHolder: {
|
|
359
|
+
parameters: {
|
|
360
|
+
query?: never;
|
|
361
|
+
header?: never;
|
|
362
|
+
path?: never;
|
|
363
|
+
cookie?: never;
|
|
364
|
+
};
|
|
365
|
+
requestBody: {
|
|
366
|
+
content: {
|
|
367
|
+
"application/json": {
|
|
368
|
+
/**
|
|
369
|
+
* Format: email
|
|
370
|
+
* @description Email of the user to assign roles to.
|
|
371
|
+
*/
|
|
372
|
+
email: string;
|
|
373
|
+
/** @description List of role names to assign. */
|
|
374
|
+
roleNames: string[];
|
|
375
|
+
};
|
|
376
|
+
};
|
|
377
|
+
};
|
|
378
|
+
responses: {
|
|
379
|
+
/** @description Role holder added */
|
|
380
|
+
201: {
|
|
381
|
+
headers: {
|
|
382
|
+
[name: string]: unknown;
|
|
383
|
+
};
|
|
384
|
+
content?: never;
|
|
385
|
+
};
|
|
386
|
+
/** @description Invalid request body or request param */
|
|
387
|
+
400: {
|
|
388
|
+
headers: {
|
|
389
|
+
[name: string]: unknown;
|
|
390
|
+
};
|
|
391
|
+
content: {
|
|
392
|
+
"text/plain": string;
|
|
393
|
+
};
|
|
394
|
+
};
|
|
395
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
396
|
+
401: {
|
|
397
|
+
headers: {
|
|
398
|
+
[name: string]: unknown;
|
|
399
|
+
};
|
|
400
|
+
content: {
|
|
401
|
+
"text/plain": string;
|
|
402
|
+
};
|
|
403
|
+
};
|
|
404
|
+
/** @description Internal server error */
|
|
405
|
+
500: {
|
|
406
|
+
headers: {
|
|
407
|
+
[name: string]: unknown;
|
|
408
|
+
};
|
|
409
|
+
content: {
|
|
410
|
+
"text/plain": string;
|
|
411
|
+
};
|
|
412
|
+
};
|
|
413
|
+
};
|
|
707
414
|
};
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
415
|
+
deleteRole: {
|
|
416
|
+
parameters: {
|
|
417
|
+
query?: never;
|
|
418
|
+
header?: never;
|
|
419
|
+
path: {
|
|
420
|
+
/** @description Role ID */
|
|
421
|
+
roleId: string;
|
|
422
|
+
};
|
|
423
|
+
cookie?: never;
|
|
424
|
+
};
|
|
425
|
+
requestBody?: never;
|
|
426
|
+
responses: {
|
|
427
|
+
/** @description Role deleted */
|
|
428
|
+
204: {
|
|
429
|
+
headers: {
|
|
430
|
+
[name: string]: unknown;
|
|
431
|
+
};
|
|
432
|
+
content?: never;
|
|
433
|
+
};
|
|
434
|
+
/** @description Invalid request body or request param */
|
|
435
|
+
400: {
|
|
436
|
+
headers: {
|
|
437
|
+
[name: string]: unknown;
|
|
438
|
+
};
|
|
439
|
+
content: {
|
|
440
|
+
"text/plain": string;
|
|
441
|
+
};
|
|
442
|
+
};
|
|
443
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
444
|
+
401: {
|
|
445
|
+
headers: {
|
|
446
|
+
[name: string]: unknown;
|
|
447
|
+
};
|
|
448
|
+
content: {
|
|
449
|
+
"text/plain": string;
|
|
450
|
+
};
|
|
451
|
+
};
|
|
452
|
+
/** @description Result not found */
|
|
453
|
+
404: {
|
|
454
|
+
headers: {
|
|
455
|
+
[name: string]: unknown;
|
|
456
|
+
};
|
|
457
|
+
content: {
|
|
458
|
+
"text/plain": string;
|
|
459
|
+
};
|
|
460
|
+
};
|
|
461
|
+
/** @description Internal server error */
|
|
462
|
+
500: {
|
|
463
|
+
headers: {
|
|
464
|
+
[name: string]: unknown;
|
|
465
|
+
};
|
|
466
|
+
content: {
|
|
467
|
+
"text/plain": string;
|
|
468
|
+
};
|
|
469
|
+
};
|
|
470
|
+
};
|
|
720
471
|
};
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
472
|
+
getAllRoles: {
|
|
473
|
+
parameters: {
|
|
474
|
+
query?: {
|
|
475
|
+
/** @description Get responses by page */
|
|
476
|
+
page?: string;
|
|
477
|
+
/** @description Get responses by page size */
|
|
478
|
+
pageSize?: string;
|
|
479
|
+
/** @description Get responses that match search param value */
|
|
480
|
+
search?: string;
|
|
481
|
+
/** @description Get ordered responses */
|
|
482
|
+
order?: string;
|
|
483
|
+
/** @description Get all possible entries */
|
|
484
|
+
all?: boolean;
|
|
485
|
+
/** @description Role grouping selector such as provider, organization, or team. */
|
|
486
|
+
selector?: string;
|
|
487
|
+
/** @description Team ID used when selector is team. */
|
|
488
|
+
teamId?: string;
|
|
489
|
+
};
|
|
490
|
+
header?: never;
|
|
491
|
+
path: {
|
|
492
|
+
/** @description Organization ID */
|
|
493
|
+
orgId: string;
|
|
494
|
+
};
|
|
495
|
+
cookie?: never;
|
|
496
|
+
};
|
|
497
|
+
requestBody?: never;
|
|
498
|
+
responses: {
|
|
499
|
+
/** @description Roles response */
|
|
500
|
+
200: {
|
|
501
|
+
headers: {
|
|
502
|
+
[name: string]: unknown;
|
|
503
|
+
};
|
|
504
|
+
content: {
|
|
505
|
+
"application/json": {
|
|
506
|
+
/** @description Current page number (zero-based). */
|
|
507
|
+
page: number;
|
|
508
|
+
/** @description Number of roles per page. */
|
|
509
|
+
pageSize: number;
|
|
510
|
+
/** @description Total number of roles across all pages. */
|
|
511
|
+
totalCount: number;
|
|
512
|
+
/** @description The roles of the rolespage. */
|
|
513
|
+
roles: {
|
|
514
|
+
/**
|
|
515
|
+
* Format: uuid
|
|
516
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
517
|
+
*/
|
|
518
|
+
id?: string;
|
|
519
|
+
/** @description Unique name of the role. */
|
|
520
|
+
roleName: string;
|
|
521
|
+
/** @description Human-readable description of the role. */
|
|
522
|
+
description: string;
|
|
523
|
+
/**
|
|
524
|
+
* Format: date-time
|
|
525
|
+
* @description Timestamp when the role was created.
|
|
526
|
+
*/
|
|
527
|
+
createdAt?: string;
|
|
528
|
+
/**
|
|
529
|
+
* Format: date-time
|
|
530
|
+
* @description Timestamp when the role was last updated.
|
|
531
|
+
*/
|
|
532
|
+
updatedAt?: string;
|
|
533
|
+
/**
|
|
534
|
+
* Format: date-time
|
|
535
|
+
* @description Timestamp when the role was soft-deleted, if applicable.
|
|
536
|
+
*/
|
|
537
|
+
deletedAt?: string;
|
|
538
|
+
}[];
|
|
539
|
+
};
|
|
540
|
+
};
|
|
541
|
+
};
|
|
542
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
543
|
+
401: {
|
|
544
|
+
headers: {
|
|
545
|
+
[name: string]: unknown;
|
|
546
|
+
};
|
|
547
|
+
content: {
|
|
548
|
+
"text/plain": string;
|
|
549
|
+
};
|
|
550
|
+
};
|
|
551
|
+
/** @description Result not found */
|
|
552
|
+
404: {
|
|
553
|
+
headers: {
|
|
554
|
+
[name: string]: unknown;
|
|
555
|
+
};
|
|
556
|
+
content: {
|
|
557
|
+
"text/plain": string;
|
|
558
|
+
};
|
|
559
|
+
};
|
|
560
|
+
/** @description Internal server error */
|
|
561
|
+
500: {
|
|
562
|
+
headers: {
|
|
563
|
+
[name: string]: unknown;
|
|
564
|
+
};
|
|
565
|
+
content: {
|
|
566
|
+
"text/plain": string;
|
|
567
|
+
};
|
|
568
|
+
};
|
|
569
|
+
};
|
|
570
|
+
};
|
|
571
|
+
bulkEditRoleHolder: {
|
|
572
|
+
parameters: {
|
|
573
|
+
query?: never;
|
|
574
|
+
header?: never;
|
|
575
|
+
path: {
|
|
576
|
+
/** @description Organization ID */
|
|
577
|
+
orgId: string;
|
|
578
|
+
};
|
|
579
|
+
cookie?: never;
|
|
580
|
+
};
|
|
581
|
+
requestBody: {
|
|
582
|
+
content: {
|
|
583
|
+
"application/json": {
|
|
584
|
+
/**
|
|
585
|
+
* Format: uuid
|
|
586
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
587
|
+
*/
|
|
588
|
+
id?: string;
|
|
589
|
+
/**
|
|
590
|
+
* Format: uuid
|
|
591
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
592
|
+
*/
|
|
593
|
+
userId?: string;
|
|
594
|
+
/** @description The username of the user. */
|
|
595
|
+
username?: string;
|
|
596
|
+
/**
|
|
597
|
+
* Format: email
|
|
598
|
+
* @description Email address of the user.
|
|
599
|
+
*/
|
|
600
|
+
email?: string;
|
|
601
|
+
/** @description First name of the user. */
|
|
602
|
+
firstName?: string;
|
|
603
|
+
/** @description Last name of the user. */
|
|
604
|
+
lastName?: string;
|
|
605
|
+
/** @description Current status of the user. */
|
|
606
|
+
status?: string;
|
|
607
|
+
/** @description Role names currently or newly assigned to the user. */
|
|
608
|
+
roleNames?: string[];
|
|
609
|
+
/**
|
|
610
|
+
* Format: date-time
|
|
611
|
+
* @description Timestamp when the user was created.
|
|
612
|
+
*/
|
|
613
|
+
createdAt?: string;
|
|
614
|
+
/**
|
|
615
|
+
* Format: date-time
|
|
616
|
+
* @description Timestamp when the user was last updated.
|
|
617
|
+
*/
|
|
618
|
+
updatedAt?: string;
|
|
619
|
+
/**
|
|
620
|
+
* Format: date-time
|
|
621
|
+
* @description Timestamp when the user was soft-deleted, if applicable.
|
|
622
|
+
*/
|
|
623
|
+
deletedAt?: string;
|
|
624
|
+
}[];
|
|
625
|
+
};
|
|
626
|
+
};
|
|
627
|
+
responses: {
|
|
628
|
+
/** @description Role holders updated */
|
|
629
|
+
200: {
|
|
630
|
+
headers: {
|
|
631
|
+
[name: string]: unknown;
|
|
632
|
+
};
|
|
633
|
+
content?: never;
|
|
634
|
+
};
|
|
635
|
+
/** @description Invalid request body or request param */
|
|
636
|
+
400: {
|
|
637
|
+
headers: {
|
|
638
|
+
[name: string]: unknown;
|
|
639
|
+
};
|
|
640
|
+
content: {
|
|
641
|
+
"text/plain": string;
|
|
642
|
+
};
|
|
643
|
+
};
|
|
644
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
645
|
+
401: {
|
|
646
|
+
headers: {
|
|
647
|
+
[name: string]: unknown;
|
|
648
|
+
};
|
|
649
|
+
content: {
|
|
650
|
+
"text/plain": string;
|
|
651
|
+
};
|
|
652
|
+
};
|
|
653
|
+
/** @description Result not found */
|
|
654
|
+
404: {
|
|
655
|
+
headers: {
|
|
656
|
+
[name: string]: unknown;
|
|
657
|
+
};
|
|
658
|
+
content: {
|
|
659
|
+
"text/plain": string;
|
|
660
|
+
};
|
|
661
|
+
};
|
|
662
|
+
/** @description Internal server error */
|
|
663
|
+
500: {
|
|
664
|
+
headers: {
|
|
665
|
+
[name: string]: unknown;
|
|
666
|
+
};
|
|
667
|
+
content: {
|
|
668
|
+
"text/plain": string;
|
|
669
|
+
};
|
|
670
|
+
};
|
|
671
|
+
};
|
|
672
|
+
};
|
|
673
|
+
upsertRole: {
|
|
674
|
+
parameters: {
|
|
675
|
+
query?: never;
|
|
676
|
+
header?: never;
|
|
677
|
+
path: {
|
|
678
|
+
/** @description Organization ID */
|
|
679
|
+
orgId: string;
|
|
680
|
+
};
|
|
681
|
+
cookie?: never;
|
|
682
|
+
};
|
|
683
|
+
requestBody: {
|
|
684
|
+
content: {
|
|
685
|
+
"application/json": {
|
|
686
|
+
/**
|
|
687
|
+
* Format: uuid
|
|
688
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
689
|
+
*/
|
|
690
|
+
id?: string;
|
|
691
|
+
/** @description Unique name of the role. */
|
|
692
|
+
roleName: string;
|
|
693
|
+
/** @description Human-readable description of the role. */
|
|
694
|
+
description: string;
|
|
695
|
+
};
|
|
696
|
+
};
|
|
697
|
+
};
|
|
698
|
+
responses: {
|
|
699
|
+
/** @description Role upserted */
|
|
700
|
+
200: {
|
|
701
|
+
headers: {
|
|
702
|
+
[name: string]: unknown;
|
|
703
|
+
};
|
|
704
|
+
content: {
|
|
705
|
+
"application/json": {
|
|
706
|
+
/**
|
|
707
|
+
* Format: uuid
|
|
708
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
709
|
+
*/
|
|
710
|
+
id?: string;
|
|
711
|
+
/** @description Unique name of the role. */
|
|
712
|
+
roleName: string;
|
|
713
|
+
/** @description Human-readable description of the role. */
|
|
714
|
+
description: string;
|
|
715
|
+
/**
|
|
716
|
+
* Format: date-time
|
|
717
|
+
* @description Timestamp when the role was created.
|
|
718
|
+
*/
|
|
719
|
+
createdAt?: string;
|
|
720
|
+
/**
|
|
721
|
+
* Format: date-time
|
|
722
|
+
* @description Timestamp when the role was last updated.
|
|
723
|
+
*/
|
|
724
|
+
updatedAt?: string;
|
|
725
|
+
/**
|
|
726
|
+
* Format: date-time
|
|
727
|
+
* @description Timestamp when the role was soft-deleted, if applicable.
|
|
728
|
+
*/
|
|
729
|
+
deletedAt?: string;
|
|
730
|
+
};
|
|
731
|
+
};
|
|
732
|
+
};
|
|
733
|
+
/** @description Invalid request body or request param */
|
|
734
|
+
400: {
|
|
735
|
+
headers: {
|
|
736
|
+
[name: string]: unknown;
|
|
737
|
+
};
|
|
738
|
+
content: {
|
|
739
|
+
"text/plain": string;
|
|
740
|
+
};
|
|
741
|
+
};
|
|
742
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
743
|
+
401: {
|
|
744
|
+
headers: {
|
|
745
|
+
[name: string]: unknown;
|
|
746
|
+
};
|
|
747
|
+
content: {
|
|
748
|
+
"text/plain": string;
|
|
749
|
+
};
|
|
750
|
+
};
|
|
751
|
+
/** @description Result not found */
|
|
752
|
+
404: {
|
|
753
|
+
headers: {
|
|
754
|
+
[name: string]: unknown;
|
|
755
|
+
};
|
|
756
|
+
content: {
|
|
757
|
+
"text/plain": string;
|
|
758
|
+
};
|
|
759
|
+
};
|
|
760
|
+
/** @description Internal server error */
|
|
761
|
+
500: {
|
|
762
|
+
headers: {
|
|
763
|
+
[name: string]: unknown;
|
|
764
|
+
};
|
|
765
|
+
content: {
|
|
766
|
+
"text/plain": string;
|
|
767
|
+
};
|
|
768
|
+
};
|
|
769
|
+
};
|
|
770
|
+
};
|
|
771
|
+
getRoleKeychains: {
|
|
772
|
+
parameters: {
|
|
773
|
+
query?: {
|
|
774
|
+
/** @description Get responses by page */
|
|
775
|
+
page?: string;
|
|
776
|
+
/** @description Get responses by page size */
|
|
777
|
+
pageSize?: string;
|
|
778
|
+
/** @description Get responses that match search param value */
|
|
779
|
+
search?: string;
|
|
780
|
+
/** @description Get ordered responses */
|
|
781
|
+
order?: string;
|
|
782
|
+
};
|
|
783
|
+
header?: never;
|
|
784
|
+
path: {
|
|
785
|
+
/** @description Organization ID */
|
|
786
|
+
orgId: string;
|
|
787
|
+
/** @description Role ID */
|
|
788
|
+
roleId: string;
|
|
789
|
+
};
|
|
790
|
+
cookie?: never;
|
|
791
|
+
};
|
|
792
|
+
requestBody?: never;
|
|
793
|
+
responses: {
|
|
794
|
+
/** @description Keychains response */
|
|
795
|
+
200: {
|
|
796
|
+
headers: {
|
|
797
|
+
[name: string]: unknown;
|
|
798
|
+
};
|
|
799
|
+
content: {
|
|
800
|
+
"application/json": {
|
|
801
|
+
page: number;
|
|
802
|
+
page_size: number;
|
|
803
|
+
total_count: number;
|
|
804
|
+
/** @description The keychains of the keychainpage. */
|
|
805
|
+
keychains: {
|
|
806
|
+
/**
|
|
807
|
+
* Format: uuid
|
|
808
|
+
* @description Unique identifier for the keychain.
|
|
809
|
+
*/
|
|
810
|
+
id: string;
|
|
811
|
+
/** @description Name of the keychain. */
|
|
812
|
+
name: string;
|
|
813
|
+
/**
|
|
814
|
+
* Format: uuid
|
|
815
|
+
* @description Owner of the keychain.
|
|
816
|
+
*/
|
|
817
|
+
owner: string;
|
|
818
|
+
/**
|
|
819
|
+
* Format: date-time
|
|
820
|
+
* @description Timestamp when the resource was created.
|
|
821
|
+
*/
|
|
822
|
+
created_at: string;
|
|
823
|
+
/**
|
|
824
|
+
* Format: date-time
|
|
825
|
+
* @description Timestamp when the resource was updated.
|
|
826
|
+
*/
|
|
827
|
+
updated_at: string;
|
|
828
|
+
/**
|
|
829
|
+
* Format: date-time
|
|
830
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
831
|
+
*/
|
|
832
|
+
deleted_at?: string;
|
|
833
|
+
}[];
|
|
834
|
+
};
|
|
835
|
+
};
|
|
836
|
+
};
|
|
837
|
+
/** @description Invalid request body or request param */
|
|
838
|
+
400: {
|
|
839
|
+
headers: {
|
|
840
|
+
[name: string]: unknown;
|
|
841
|
+
};
|
|
842
|
+
content: {
|
|
843
|
+
"text/plain": string;
|
|
844
|
+
};
|
|
845
|
+
};
|
|
846
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
847
|
+
401: {
|
|
848
|
+
headers: {
|
|
849
|
+
[name: string]: unknown;
|
|
850
|
+
};
|
|
851
|
+
content: {
|
|
852
|
+
"text/plain": string;
|
|
853
|
+
};
|
|
854
|
+
};
|
|
855
|
+
/** @description Result not found */
|
|
856
|
+
404: {
|
|
857
|
+
headers: {
|
|
858
|
+
[name: string]: unknown;
|
|
859
|
+
};
|
|
860
|
+
content: {
|
|
861
|
+
"text/plain": string;
|
|
862
|
+
};
|
|
863
|
+
};
|
|
864
|
+
/** @description Internal server error */
|
|
865
|
+
500: {
|
|
866
|
+
headers: {
|
|
867
|
+
[name: string]: unknown;
|
|
868
|
+
};
|
|
869
|
+
content: {
|
|
870
|
+
"text/plain": string;
|
|
871
|
+
};
|
|
872
|
+
};
|
|
873
|
+
};
|
|
874
|
+
};
|
|
875
|
+
assignKeychainToRole: {
|
|
876
|
+
parameters: {
|
|
877
|
+
query?: never;
|
|
878
|
+
header?: never;
|
|
879
|
+
path: {
|
|
880
|
+
/** @description Organization ID */
|
|
881
|
+
orgId: string;
|
|
882
|
+
/** @description Role ID */
|
|
883
|
+
roleId: string;
|
|
884
|
+
/** @description Keychain ID */
|
|
885
|
+
keychainId: string;
|
|
886
|
+
};
|
|
887
|
+
cookie?: never;
|
|
888
|
+
};
|
|
889
|
+
requestBody?: never;
|
|
890
|
+
responses: {
|
|
891
|
+
/** @description Keychain assigned to role */
|
|
892
|
+
200: {
|
|
893
|
+
headers: {
|
|
894
|
+
[name: string]: unknown;
|
|
895
|
+
};
|
|
896
|
+
content?: never;
|
|
897
|
+
};
|
|
898
|
+
/** @description Invalid request body or request param */
|
|
899
|
+
400: {
|
|
900
|
+
headers: {
|
|
901
|
+
[name: string]: unknown;
|
|
902
|
+
};
|
|
903
|
+
content: {
|
|
904
|
+
"text/plain": string;
|
|
905
|
+
};
|
|
906
|
+
};
|
|
907
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
908
|
+
401: {
|
|
909
|
+
headers: {
|
|
910
|
+
[name: string]: unknown;
|
|
911
|
+
};
|
|
912
|
+
content: {
|
|
913
|
+
"text/plain": string;
|
|
914
|
+
};
|
|
915
|
+
};
|
|
916
|
+
/** @description Result not found */
|
|
917
|
+
404: {
|
|
918
|
+
headers: {
|
|
919
|
+
[name: string]: unknown;
|
|
920
|
+
};
|
|
921
|
+
content: {
|
|
922
|
+
"text/plain": string;
|
|
923
|
+
};
|
|
924
|
+
};
|
|
925
|
+
/** @description Internal server error */
|
|
926
|
+
500: {
|
|
927
|
+
headers: {
|
|
928
|
+
[name: string]: unknown;
|
|
929
|
+
};
|
|
930
|
+
content: {
|
|
931
|
+
"text/plain": string;
|
|
932
|
+
};
|
|
933
|
+
};
|
|
934
|
+
};
|
|
935
|
+
};
|
|
936
|
+
unassignKeychainFromRole: {
|
|
937
|
+
parameters: {
|
|
938
|
+
query?: never;
|
|
939
|
+
header?: never;
|
|
940
|
+
path: {
|
|
941
|
+
/** @description Organization ID */
|
|
942
|
+
orgId: string;
|
|
943
|
+
/** @description Role ID */
|
|
944
|
+
roleId: string;
|
|
945
|
+
/** @description Keychain ID */
|
|
946
|
+
keychainId: string;
|
|
947
|
+
};
|
|
948
|
+
cookie?: never;
|
|
949
|
+
};
|
|
950
|
+
requestBody?: never;
|
|
951
|
+
responses: {
|
|
952
|
+
/** @description Keychain unassigned from role */
|
|
953
|
+
204: {
|
|
954
|
+
headers: {
|
|
955
|
+
[name: string]: unknown;
|
|
956
|
+
};
|
|
957
|
+
content?: never;
|
|
958
|
+
};
|
|
959
|
+
/** @description Invalid request body or request param */
|
|
960
|
+
400: {
|
|
961
|
+
headers: {
|
|
962
|
+
[name: string]: unknown;
|
|
963
|
+
};
|
|
964
|
+
content: {
|
|
965
|
+
"text/plain": string;
|
|
966
|
+
};
|
|
967
|
+
};
|
|
968
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
969
|
+
401: {
|
|
970
|
+
headers: {
|
|
971
|
+
[name: string]: unknown;
|
|
972
|
+
};
|
|
973
|
+
content: {
|
|
974
|
+
"text/plain": string;
|
|
975
|
+
};
|
|
976
|
+
};
|
|
977
|
+
/** @description Result not found */
|
|
978
|
+
404: {
|
|
979
|
+
headers: {
|
|
980
|
+
[name: string]: unknown;
|
|
981
|
+
};
|
|
982
|
+
content: {
|
|
983
|
+
"text/plain": string;
|
|
984
|
+
};
|
|
985
|
+
};
|
|
986
|
+
/** @description Internal server error */
|
|
987
|
+
500: {
|
|
988
|
+
headers: {
|
|
989
|
+
[name: string]: unknown;
|
|
990
|
+
};
|
|
991
|
+
content: {
|
|
992
|
+
"text/plain": string;
|
|
993
|
+
};
|
|
994
|
+
};
|
|
995
|
+
};
|
|
748
996
|
};
|
|
749
|
-
};
|
|
750
997
|
}
|
|
751
|
-
|
|
752
|
-
export interface external {}
|