@meshery/schemas 1.3.8 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +4154 -1704
- package/dist/cloudApi.d.ts +4154 -1704
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +106 -111
- package/dist/constructs/v1alpha1/core/Core.d.ts +822 -734
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +45 -40
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1829 -1716
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6023 -6642
- package/dist/constructs/v1beta1/badge/Badge.d.ts +439 -600
- package/dist/constructs/v1beta1/capability/Capability.d.ts +106 -111
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +45 -40
- package/dist/constructs/v1beta1/category/Category.d.ts +38 -26
- package/dist/constructs/v1beta1/component/Component.d.ts +833 -729
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1170 -1357
- package/dist/constructs/v1beta1/core/Core.d.ts +822 -734
- package/dist/constructs/v1beta1/credential/Credential.d.ts +458 -593
- package/dist/constructs/v1beta1/environment/Environment.d.ts +666 -835
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6142 -5619
- package/dist/constructs/v1beta1/event/Event.d.ts +527 -898
- package/dist/constructs/v1beta1/feature/Feature.d.ts +343 -389
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +877 -1244
- package/dist/constructs/v1beta1/key/Key.d.ts +444 -589
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +575 -796
- package/dist/constructs/v1beta1/model/Model.d.ts +598 -572
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1410 -1829
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17988 -17171
- package/dist/constructs/v1beta1/plan/Plan.d.ts +115 -159
- package/dist/constructs/v1beta1/role/Role.d.ts +688 -933
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +315 -425
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +61 -18
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +674 -839
- package/dist/constructs/v1beta1/support/Support.d.ts +74 -115
- package/dist/constructs/v1beta1/system/System.d.ts +250 -385
- package/dist/constructs/v1beta1/team/Team.d.ts +762 -1028
- package/dist/constructs/v1beta1/token/Token.d.ts +475 -612
- package/dist/constructs/v1beta1/user/User.d.ts +1553 -1722
- package/dist/constructs/v1beta1/view/View.d.ts +664 -833
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4705 -4910
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7246 -7864
- package/dist/constructs/v1beta2/badge/Badge.d.ts +453 -610
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +45 -40
- package/dist/constructs/v1beta2/component/Component.d.ts +851 -747
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1189 -1376
- package/dist/constructs/v1beta2/core/Core.d.ts +856 -768
- package/dist/constructs/v1beta2/credential/Credential.d.ts +437 -572
- package/dist/constructs/v1beta2/design/Design.d.ts +18631 -17846
- package/dist/constructs/v1beta2/event/Event.d.ts +575 -946
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +901 -1268
- package/dist/constructs/v1beta2/key/Key.d.ts +454 -599
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +585 -806
- package/dist/constructs/v1beta2/model/Model.d.ts +636 -610
- package/dist/constructs/v1beta2/organization/Organization.d.ts +2017 -2458
- package/dist/constructs/v1beta2/plan/Plan.d.ts +128 -169
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2013 -1844
- package/dist/constructs/v1beta2/role/Role.d.ts +695 -940
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +356 -466
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +701 -866
- package/dist/constructs/v1beta2/team/Team.d.ts +852 -1118
- package/dist/constructs/v1beta2/token/Token.d.ts +479 -616
- package/dist/constructs/v1beta2/user/User.d.ts +1553 -1722
- package/dist/constructs/v1beta2/view/View.d.ts +669 -838
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7246 -7864
- package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta3/component/Component.d.ts +857 -753
- package/dist/constructs/v1beta3/connection/Connection.d.ts +5919 -1416
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +25 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +25 -1
- package/dist/constructs/v1beta3/design/Design.d.ts +5297 -5719
- package/dist/constructs/v1beta3/design/DesignSchema.js +2 -2
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +2 -2
- package/dist/constructs/v1beta3/environment/Environment.d.ts +689 -858
- package/dist/constructs/v1beta3/event/Event.d.ts +666 -1041
- package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
- package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1300 -1438
- package/dist/constructs/v1beta3/filter/FilterSchema.js +7 -7
- package/dist/constructs/v1beta3/filter/FilterSchema.mjs +7 -7
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +911 -1278
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +1114 -1412
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.js +1 -1
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.mjs +1 -1
- package/dist/constructs/v1beta3/plan/Plan.d.ts +156 -197
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2013 -1844
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +804 -969
- package/dist/constructs/v1beta3/token/Token.d.ts +480 -617
- package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +4825 -5033
- package/dist/index.d.mts +5032 -5501
- package/dist/index.d.ts +5032 -5501
- package/dist/mesheryApi.d.mts +3334 -884
- package/dist/mesheryApi.d.ts +3334 -884
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/dist/permissions.d.mts +25 -1
- package/dist/permissions.d.ts +25 -1
- package/dist/permissions.js +1 -1
- package/dist/permissions.mjs +1 -1
- package/package.json +1 -1
|
@@ -4,163 +4,360 @@
|
|
|
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
|
-
|
|
7
|
+
"/api/identity/roles": {
|
|
8
|
+
/** Assigns a role to a user identified by email. */
|
|
9
|
+
post: operations["addRoleHolder"];
|
|
10
|
+
};
|
|
11
|
+
"/api/identity/roles/{roleId}": {
|
|
12
|
+
/** Removes a role assignment by ID. */
|
|
13
|
+
delete: operations["deleteRole"];
|
|
14
|
+
};
|
|
15
|
+
"/api/identity/orgs/{orgId}/roles": {
|
|
16
|
+
/** Returns all roles defined for the specified organization. */
|
|
17
|
+
get: operations["getAllRoles"];
|
|
18
|
+
/** Updates role assignments for multiple users in the organization. */
|
|
19
|
+
put: operations["bulkEditRoleHolder"];
|
|
20
|
+
/** Creates or updates a role for the specified organization. */
|
|
21
|
+
post: operations["upsertRole"];
|
|
22
|
+
};
|
|
23
|
+
"/api/identity/orgs/{orgId}/roles/{roleId}/keychains": {
|
|
24
|
+
/** Returns all keychains assigned to the specified role. */
|
|
25
|
+
get: operations["getRoleKeychains"];
|
|
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;
|
|
26
63
|
};
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
* Delete role
|
|
39
|
-
* @description Removes a role assignment by ID.
|
|
40
|
-
*/
|
|
41
|
-
delete: operations["deleteRole"];
|
|
42
|
-
options?: never;
|
|
43
|
-
head?: never;
|
|
44
|
-
patch?: never;
|
|
45
|
-
trace?: never;
|
|
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;
|
|
46
75
|
};
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
76
|
+
/** @description A paginated list of roles. */
|
|
77
|
+
RolesPage: {
|
|
78
|
+
/** @description Current page number (zero-based). */
|
|
79
|
+
page: number;
|
|
80
|
+
/** @description Number of roles per page. */
|
|
81
|
+
pageSize: number;
|
|
82
|
+
/** @description Total number of roles across all pages. */
|
|
83
|
+
totalCount: number;
|
|
84
|
+
/** @description The roles of the rolespage. */
|
|
85
|
+
roles: {
|
|
54
86
|
/**
|
|
55
|
-
*
|
|
56
|
-
* @description
|
|
87
|
+
* Format: uuid
|
|
88
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
57
89
|
*/
|
|
58
|
-
|
|
90
|
+
id?: string;
|
|
91
|
+
/** @description Unique name of the role. */
|
|
92
|
+
roleName: string;
|
|
93
|
+
/** @description Human-readable description of the role. */
|
|
94
|
+
description: string;
|
|
59
95
|
/**
|
|
60
|
-
*
|
|
61
|
-
* @description
|
|
96
|
+
* Format: date-time
|
|
97
|
+
* @description Timestamp when the role was created.
|
|
62
98
|
*/
|
|
63
|
-
|
|
99
|
+
createdAt?: string;
|
|
64
100
|
/**
|
|
65
|
-
*
|
|
66
|
-
* @description
|
|
101
|
+
* Format: date-time
|
|
102
|
+
* @description Timestamp when the role was last updated.
|
|
67
103
|
*/
|
|
68
|
-
|
|
69
|
-
delete?: never;
|
|
70
|
-
options?: never;
|
|
71
|
-
head?: never;
|
|
72
|
-
patch?: never;
|
|
73
|
-
trace?: never;
|
|
74
|
-
};
|
|
75
|
-
"/api/identity/orgs/{orgId}/roles/{roleId}/keychains": {
|
|
76
|
-
parameters: {
|
|
77
|
-
query?: never;
|
|
78
|
-
header?: never;
|
|
79
|
-
path?: never;
|
|
80
|
-
cookie?: never;
|
|
81
|
-
};
|
|
104
|
+
updatedAt?: string;
|
|
82
105
|
/**
|
|
83
|
-
*
|
|
84
|
-
* @description
|
|
106
|
+
* Format: date-time
|
|
107
|
+
* @description Timestamp when the role was soft-deleted, if applicable.
|
|
85
108
|
*/
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
post?: never;
|
|
89
|
-
delete?: never;
|
|
90
|
-
options?: never;
|
|
91
|
-
head?: never;
|
|
92
|
-
patch?: never;
|
|
93
|
-
trace?: never;
|
|
109
|
+
deletedAt?: string;
|
|
110
|
+
}[];
|
|
94
111
|
};
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
112
|
+
/** @description Mapping between a role and a keychain. */
|
|
113
|
+
RolesKeychainsMapping: {
|
|
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[];
|
|
154
|
+
};
|
|
155
|
+
/** @description Request to update role assignments for a user. */
|
|
156
|
+
UserRoleUpdateRequest: {
|
|
157
|
+
/**
|
|
158
|
+
* Format: uuid
|
|
159
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
160
|
+
*/
|
|
161
|
+
id?: string;
|
|
162
|
+
/**
|
|
163
|
+
* Format: uuid
|
|
164
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
165
|
+
*/
|
|
166
|
+
userId?: string;
|
|
167
|
+
/** @description The username of the user. */
|
|
168
|
+
username?: string;
|
|
169
|
+
/**
|
|
170
|
+
* Format: email
|
|
171
|
+
* @description Email address of the user.
|
|
172
|
+
*/
|
|
173
|
+
email?: string;
|
|
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
|
+
};
|
|
118
224
|
};
|
|
225
|
+
/** Internal server error */
|
|
226
|
+
500: {
|
|
227
|
+
content: {
|
|
228
|
+
"text/plain": string;
|
|
229
|
+
};
|
|
230
|
+
};
|
|
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
|
+
};
|
|
119
254
|
}
|
|
120
|
-
|
|
121
|
-
export interface
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
255
|
+
|
|
256
|
+
export interface operations {
|
|
257
|
+
/** Assigns a role to a user identified by email. */
|
|
258
|
+
addRoleHolder: {
|
|
259
|
+
responses: {
|
|
260
|
+
/** Role holder added */
|
|
261
|
+
201: unknown;
|
|
262
|
+
/** Invalid request body or request param */
|
|
263
|
+
400: {
|
|
264
|
+
content: {
|
|
265
|
+
"text/plain": string;
|
|
266
|
+
};
|
|
267
|
+
};
|
|
268
|
+
/** Expired JWT token used or insufficient privilege */
|
|
269
|
+
401: {
|
|
270
|
+
content: {
|
|
271
|
+
"text/plain": string;
|
|
272
|
+
};
|
|
273
|
+
};
|
|
274
|
+
/** Internal server error */
|
|
275
|
+
500: {
|
|
276
|
+
content: {
|
|
277
|
+
"text/plain": string;
|
|
278
|
+
};
|
|
279
|
+
};
|
|
280
|
+
};
|
|
281
|
+
requestBody: {
|
|
282
|
+
content: {
|
|
283
|
+
"application/json": {
|
|
284
|
+
/**
|
|
285
|
+
* Format: email
|
|
286
|
+
* @description Email of the user to assign roles to.
|
|
287
|
+
*/
|
|
288
|
+
email: string;
|
|
289
|
+
/** @description List of role names to assign. */
|
|
290
|
+
roleNames: string[];
|
|
291
|
+
};
|
|
292
|
+
};
|
|
293
|
+
};
|
|
294
|
+
};
|
|
295
|
+
/** Removes a role assignment by ID. */
|
|
296
|
+
deleteRole: {
|
|
297
|
+
parameters: {
|
|
298
|
+
path: {
|
|
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": {
|
|
164
361
|
/** @description Current page number (zero-based). */
|
|
165
362
|
page: number;
|
|
166
363
|
/** @description Number of roles per page. */
|
|
@@ -169,829 +366,387 @@ export interface components {
|
|
|
169
366
|
totalCount: number;
|
|
170
367
|
/** @description The roles of the rolespage. */
|
|
171
368
|
roles: {
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
369
|
+
/**
|
|
370
|
+
* Format: uuid
|
|
371
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
372
|
+
*/
|
|
373
|
+
id?: string;
|
|
374
|
+
/** @description Unique name of the role. */
|
|
375
|
+
roleName: string;
|
|
376
|
+
/** @description Human-readable description of the role. */
|
|
377
|
+
description: string;
|
|
378
|
+
/**
|
|
379
|
+
* Format: date-time
|
|
380
|
+
* @description Timestamp when the role was created.
|
|
381
|
+
*/
|
|
382
|
+
createdAt?: string;
|
|
383
|
+
/**
|
|
384
|
+
* Format: date-time
|
|
385
|
+
* @description Timestamp when the role was last updated.
|
|
386
|
+
*/
|
|
387
|
+
updatedAt?: string;
|
|
388
|
+
/**
|
|
389
|
+
* Format: date-time
|
|
390
|
+
* @description Timestamp when the role was soft-deleted, if applicable.
|
|
391
|
+
*/
|
|
392
|
+
deletedAt?: string;
|
|
196
393
|
}[];
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
394
|
+
};
|
|
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
|
+
};
|
|
417
|
+
/** Updates role assignments for multiple users in the organization. */
|
|
418
|
+
bulkEditRoleHolder: {
|
|
419
|
+
parameters: {
|
|
420
|
+
path: {
|
|
421
|
+
/** Organization ID */
|
|
422
|
+
orgId: string;
|
|
423
|
+
};
|
|
424
|
+
};
|
|
425
|
+
responses: {
|
|
426
|
+
/** Role holders updated */
|
|
427
|
+
200: unknown;
|
|
428
|
+
/** Invalid request body or request param */
|
|
429
|
+
400: {
|
|
430
|
+
content: {
|
|
431
|
+
"text/plain": string;
|
|
432
|
+
};
|
|
433
|
+
};
|
|
434
|
+
/** Expired JWT token used or insufficient privilege */
|
|
435
|
+
401: {
|
|
436
|
+
content: {
|
|
437
|
+
"text/plain": string;
|
|
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": {
|
|
243
513
|
/**
|
|
244
514
|
* Format: uuid
|
|
245
515
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
246
516
|
*/
|
|
247
517
|
id?: string;
|
|
248
|
-
/**
|
|
249
|
-
|
|
250
|
-
|
|
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[];
|
|
518
|
+
/** @description Unique name of the role. */
|
|
519
|
+
roleName: string;
|
|
520
|
+
/** @description Human-readable description of the role. */
|
|
521
|
+
description: string;
|
|
268
522
|
/**
|
|
269
523
|
* Format: date-time
|
|
270
|
-
* @description Timestamp when the
|
|
524
|
+
* @description Timestamp when the role was created.
|
|
271
525
|
*/
|
|
272
526
|
createdAt?: string;
|
|
273
527
|
/**
|
|
274
528
|
* Format: date-time
|
|
275
|
-
* @description Timestamp when the
|
|
529
|
+
* @description Timestamp when the role was last updated.
|
|
276
530
|
*/
|
|
277
531
|
updatedAt?: string;
|
|
278
532
|
/**
|
|
279
533
|
* Format: date-time
|
|
280
|
-
* @description Timestamp when the
|
|
534
|
+
* @description Timestamp when the role was soft-deleted, if applicable.
|
|
281
535
|
*/
|
|
282
536
|
deletedAt?: string;
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
};
|
|
537
|
+
};
|
|
538
|
+
};
|
|
539
|
+
};
|
|
540
|
+
/** Invalid request body or request param */
|
|
541
|
+
400: {
|
|
542
|
+
content: {
|
|
543
|
+
"text/plain": string;
|
|
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
|
+
};
|
|
291
564
|
};
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
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
|
-
};
|
|
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
|
+
};
|
|
329
579
|
};
|
|
580
|
+
};
|
|
581
|
+
/** Returns all keychains assigned to the specified role. */
|
|
582
|
+
getRoleKeychains: {
|
|
330
583
|
parameters: {
|
|
331
|
-
|
|
584
|
+
path: {
|
|
585
|
+
/** Organization ID */
|
|
332
586
|
orgId: string;
|
|
333
|
-
/**
|
|
587
|
+
/** Role ID */
|
|
334
588
|
roleId: string;
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
/**
|
|
338
|
-
page
|
|
339
|
-
/**
|
|
340
|
-
pageSize
|
|
341
|
-
/**
|
|
342
|
-
search
|
|
343
|
-
/**
|
|
344
|
-
order
|
|
345
|
-
|
|
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;
|
|
351
|
-
};
|
|
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
|
-
};
|
|
414
|
-
};
|
|
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
|
-
};
|
|
471
|
-
};
|
|
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
|
-
};
|
|
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
|
+
};
|
|
570
600
|
};
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
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
|
-
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
|
-
};
|
|
601
|
+
responses: {
|
|
602
|
+
/** Keychains response */
|
|
603
|
+
200: {
|
|
604
|
+
content: {
|
|
605
|
+
"application/json": {
|
|
606
|
+
page: number;
|
|
607
|
+
page_size: number;
|
|
608
|
+
total_count: number;
|
|
609
|
+
/** @description The keychains of the keychainpage. */
|
|
610
|
+
keychains: {
|
|
611
|
+
/**
|
|
612
|
+
* Format: uuid
|
|
613
|
+
* @description Unique identifier for the keychain.
|
|
614
|
+
*/
|
|
615
|
+
id: string;
|
|
616
|
+
/** @description Name of the keychain. */
|
|
617
|
+
name: string;
|
|
618
|
+
/**
|
|
619
|
+
* Format: uuid
|
|
620
|
+
* @description Owner of the keychain.
|
|
621
|
+
*/
|
|
622
|
+
owner: string;
|
|
623
|
+
/**
|
|
624
|
+
* Format: date-time
|
|
625
|
+
* @description Timestamp when the resource was created.
|
|
626
|
+
*/
|
|
627
|
+
created_at: string;
|
|
628
|
+
/**
|
|
629
|
+
* Format: date-time
|
|
630
|
+
* @description Timestamp when the resource was updated.
|
|
631
|
+
*/
|
|
632
|
+
updated_at: string;
|
|
633
|
+
/**
|
|
634
|
+
* Format: date-time
|
|
635
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
636
|
+
*/
|
|
637
|
+
deleted_at?: string;
|
|
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
|
+
};
|
|
672
666
|
};
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
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
|
-
};
|
|
667
|
+
};
|
|
668
|
+
/** Associates a keychain with the specified role. */
|
|
669
|
+
assignKeychainToRole: {
|
|
670
|
+
parameters: {
|
|
671
|
+
path: {
|
|
672
|
+
/** Organization ID */
|
|
673
|
+
orgId: string;
|
|
674
|
+
/** Role ID */
|
|
675
|
+
roleId: string;
|
|
676
|
+
/** Keychain ID */
|
|
677
|
+
keychainId: string;
|
|
678
|
+
};
|
|
770
679
|
};
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
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
|
-
};
|
|
680
|
+
responses: {
|
|
681
|
+
/** Keychain assigned to role */
|
|
682
|
+
200: unknown;
|
|
683
|
+
/** Invalid request body or request param */
|
|
684
|
+
400: {
|
|
685
|
+
content: {
|
|
686
|
+
"text/plain": string;
|
|
687
|
+
};
|
|
688
|
+
};
|
|
689
|
+
/** Expired JWT token used or insufficient privilege */
|
|
690
|
+
401: {
|
|
691
|
+
content: {
|
|
692
|
+
"text/plain": string;
|
|
693
|
+
};
|
|
694
|
+
};
|
|
695
|
+
/** Result not found */
|
|
696
|
+
404: {
|
|
697
|
+
content: {
|
|
698
|
+
"text/plain": string;
|
|
699
|
+
};
|
|
700
|
+
};
|
|
701
|
+
/** Internal server error */
|
|
702
|
+
500: {
|
|
703
|
+
content: {
|
|
704
|
+
"text/plain": string;
|
|
705
|
+
};
|
|
706
|
+
};
|
|
874
707
|
};
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
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
|
-
};
|
|
708
|
+
};
|
|
709
|
+
/** Removes the association between a keychain and a role. */
|
|
710
|
+
unassignKeychainFromRole: {
|
|
711
|
+
parameters: {
|
|
712
|
+
path: {
|
|
713
|
+
/** Organization ID */
|
|
714
|
+
orgId: string;
|
|
715
|
+
/** Role ID */
|
|
716
|
+
roleId: string;
|
|
717
|
+
/** Keychain ID */
|
|
718
|
+
keychainId: string;
|
|
719
|
+
};
|
|
935
720
|
};
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
};
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
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
|
-
};
|
|
721
|
+
responses: {
|
|
722
|
+
/** Keychain unassigned from role */
|
|
723
|
+
204: never;
|
|
724
|
+
/** Invalid request body or request param */
|
|
725
|
+
400: {
|
|
726
|
+
content: {
|
|
727
|
+
"text/plain": string;
|
|
728
|
+
};
|
|
729
|
+
};
|
|
730
|
+
/** Expired JWT token used or insufficient privilege */
|
|
731
|
+
401: {
|
|
732
|
+
content: {
|
|
733
|
+
"text/plain": string;
|
|
734
|
+
};
|
|
735
|
+
};
|
|
736
|
+
/** Result not found */
|
|
737
|
+
404: {
|
|
738
|
+
content: {
|
|
739
|
+
"text/plain": string;
|
|
740
|
+
};
|
|
741
|
+
};
|
|
742
|
+
/** Internal server error */
|
|
743
|
+
500: {
|
|
744
|
+
content: {
|
|
745
|
+
"text/plain": string;
|
|
746
|
+
};
|
|
747
|
+
};
|
|
996
748
|
};
|
|
749
|
+
};
|
|
997
750
|
}
|
|
751
|
+
|
|
752
|
+
export interface external {}
|