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