@meshery/schemas 1.2.15 → 1.2.16

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.
Files changed (147) hide show
  1. package/dist/constructs/v1alpha1/capability/Capability.d.ts +114 -0
  2. package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.ts +2 -0
  3. package/dist/constructs/v1alpha1/core/Core.d.ts +832 -0
  4. package/dist/constructs/v1alpha1/core/CoreSchema.d.ts +2 -0
  5. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +53 -0
  6. package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.ts +2 -0
  7. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1937 -0
  8. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.ts +2 -0
  9. package/dist/constructs/v1beta1/academy/Academy.d.ts +6417 -0
  10. package/dist/constructs/v1beta1/academy/AcademySchema.d.ts +2 -0
  11. package/dist/constructs/v1beta1/badge/Badge.d.ts +546 -0
  12. package/dist/constructs/v1beta1/badge/BadgeSchema.d.ts +2 -0
  13. package/dist/constructs/v1beta1/capability/Capability.d.ts +114 -0
  14. package/dist/constructs/v1beta1/capability/CapabilitySchema.d.ts +2 -0
  15. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +53 -0
  16. package/dist/constructs/v1beta1/catalog/CatalogSchema.d.ts +2 -0
  17. package/dist/constructs/v1beta1/category/Category.d.ts +46 -0
  18. package/dist/constructs/v1beta1/category/CategorySchema.d.ts +2 -0
  19. package/dist/constructs/v1beta1/component/Component.d.ts +869 -0
  20. package/dist/constructs/v1beta1/component/ComponentSchema.d.ts +2 -0
  21. package/dist/constructs/v1beta1/connection/Connection.d.ts +1300 -0
  22. package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +2 -0
  23. package/dist/constructs/v1beta1/core/Core.d.ts +832 -0
  24. package/dist/constructs/v1beta1/core/CoreSchema.d.ts +2 -0
  25. package/dist/constructs/v1beta1/credential/Credential.d.ts +530 -0
  26. package/dist/constructs/v1beta1/credential/CredentialSchema.d.ts +2 -0
  27. package/dist/constructs/v1beta1/environment/Environment.d.ts +759 -0
  28. package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.ts +2 -0
  29. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6338 -0
  30. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +2 -0
  31. package/dist/constructs/v1beta1/event/Event.d.ts +570 -0
  32. package/dist/constructs/v1beta1/event/EventSchema.d.ts +2 -0
  33. package/dist/constructs/v1beta1/feature/Feature.d.ts +308 -0
  34. package/dist/constructs/v1beta1/feature/FeatureSchema.d.ts +2 -0
  35. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +983 -0
  36. package/dist/constructs/v1beta1/invitation/InvitationSchema.d.ts +2 -0
  37. package/dist/constructs/v1beta1/key/Key.d.ts +514 -0
  38. package/dist/constructs/v1beta1/key/KeySchema.d.ts +2 -0
  39. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +642 -0
  40. package/dist/constructs/v1beta1/keychain/KeychainSchema.d.ts +2 -0
  41. package/dist/constructs/v1beta1/model/Model.d.ts +659 -0
  42. package/dist/constructs/v1beta1/model/ModelSchema.d.ts +2 -0
  43. package/dist/constructs/v1beta1/organization/Organization.d.ts +1598 -0
  44. package/dist/constructs/v1beta1/organization/OrganizationSchema.d.ts +2 -0
  45. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +18407 -0
  46. package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +2 -0
  47. package/dist/constructs/v1beta1/plan/Plan.d.ts +149 -0
  48. package/dist/constructs/v1beta1/plan/PlanSchema.d.ts +2 -0
  49. package/dist/constructs/v1beta1/relationship/Relationship.d.ts +1921 -0
  50. package/dist/constructs/v1beta1/relationship/RelationshipSchema.d.ts +2 -0
  51. package/dist/constructs/v1beta1/role/Role.d.ts +745 -0
  52. package/dist/constructs/v1beta1/role/RoleSchema.d.ts +2 -0
  53. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +374 -0
  54. package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.ts +2 -0
  55. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +68 -0
  56. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.ts +2 -0
  57. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +752 -0
  58. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.ts +2 -0
  59. package/dist/constructs/v1beta1/support/Support.d.ts +91 -0
  60. package/dist/constructs/v1beta1/support/SupportSchema.d.ts +2 -0
  61. package/dist/constructs/v1beta1/team/Team.d.ts +846 -0
  62. package/dist/constructs/v1beta1/team/TeamSchema.d.ts +2 -0
  63. package/dist/constructs/v1beta1/token/Token.d.ts +539 -0
  64. package/dist/constructs/v1beta1/token/TokenSchema.d.ts +2 -0
  65. package/dist/constructs/v1beta1/user/User.d.ts +1677 -0
  66. package/dist/constructs/v1beta1/user/UserSchema.d.ts +2 -0
  67. package/dist/constructs/v1beta1/view/View.d.ts +759 -0
  68. package/dist/constructs/v1beta1/view/ViewSchema.d.ts +2 -0
  69. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4947 -0
  70. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.ts +2 -0
  71. package/dist/constructs/v1beta2/academy/Academy.d.ts +7762 -0
  72. package/dist/constructs/v1beta2/academy/AcademySchema.d.ts +2 -0
  73. package/dist/constructs/v1beta2/badge/Badge.d.ts +563 -0
  74. package/dist/constructs/v1beta2/badge/BadgeSchema.d.ts +2 -0
  75. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +53 -0
  76. package/dist/constructs/v1beta2/catalog/CatalogSchema.d.ts +2 -0
  77. package/dist/constructs/v1beta2/component/Component.d.ts +887 -0
  78. package/dist/constructs/v1beta2/component/ComponentSchema.d.ts +2 -0
  79. package/dist/constructs/v1beta2/connection/Connection.d.ts +1330 -0
  80. package/dist/constructs/v1beta2/connection/ConnectionSchema.d.ts +2 -0
  81. package/dist/constructs/v1beta2/core/Core.d.ts +866 -0
  82. package/dist/constructs/v1beta2/core/CoreSchema.d.ts +2 -0
  83. package/dist/constructs/v1beta2/credential/Credential.d.ts +519 -0
  84. package/dist/constructs/v1beta2/credential/CredentialSchema.d.ts +2 -0
  85. package/dist/constructs/v1beta2/design/Design.d.ts +19039 -0
  86. package/dist/constructs/v1beta2/design/DesignSchema.d.ts +2 -0
  87. package/dist/constructs/v1beta2/event/Event.d.ts +626 -0
  88. package/dist/constructs/v1beta2/event/EventSchema.d.ts +2 -0
  89. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1052 -0
  90. package/dist/constructs/v1beta2/invitation/InvitationSchema.d.ts +2 -0
  91. package/dist/constructs/v1beta2/key/Key.d.ts +524 -0
  92. package/dist/constructs/v1beta2/key/KeySchema.d.ts +2 -0
  93. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +652 -0
  94. package/dist/constructs/v1beta2/keychain/KeychainSchema.d.ts +2 -0
  95. package/dist/constructs/v1beta2/model/Model.d.ts +697 -0
  96. package/dist/constructs/v1beta2/model/ModelSchema.d.ts +2 -0
  97. package/dist/constructs/v1beta2/organization/Organization.d.ts +1915 -0
  98. package/dist/constructs/v1beta2/organization/OrganizationSchema.d.ts +2 -0
  99. package/dist/constructs/v1beta2/plan/Plan.d.ts +162 -0
  100. package/dist/constructs/v1beta2/plan/PlanSchema.d.ts +2 -0
  101. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2134 -0
  102. package/dist/constructs/v1beta2/relationship/RelationshipSchema.d.ts +2 -0
  103. package/dist/constructs/v1beta2/role/Role.d.ts +752 -0
  104. package/dist/constructs/v1beta2/role/RoleSchema.d.ts +2 -0
  105. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +431 -0
  106. package/dist/constructs/v1beta2/schedule/ScheduleSchema.d.ts +2 -0
  107. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +785 -0
  108. package/dist/constructs/v1beta2/subscription/SubscriptionSchema.d.ts +2 -0
  109. package/dist/constructs/v1beta2/team/Team.d.ts +960 -0
  110. package/dist/constructs/v1beta2/team/TeamSchema.d.ts +2 -0
  111. package/dist/constructs/v1beta2/token/Token.d.ts +544 -0
  112. package/dist/constructs/v1beta2/token/TokenSchema.d.ts +2 -0
  113. package/dist/constructs/v1beta2/user/User.d.ts +1677 -0
  114. package/dist/constructs/v1beta2/user/UserSchema.d.ts +2 -0
  115. package/dist/constructs/v1beta2/view/View.d.ts +767 -0
  116. package/dist/constructs/v1beta2/view/ViewSchema.d.ts +2 -0
  117. package/dist/constructs/v1beta3/academy/Academy.d.ts +7762 -0
  118. package/dist/constructs/v1beta3/academy/AcademySchema.d.ts +2 -0
  119. package/dist/constructs/v1beta3/component/Component.d.ts +892 -0
  120. package/dist/constructs/v1beta3/component/ComponentSchema.d.ts +2 -0
  121. package/dist/constructs/v1beta3/connection/Connection.d.ts +1414 -0
  122. package/dist/constructs/v1beta3/connection/ConnectionSchema.d.ts +2 -0
  123. package/dist/constructs/v1beta3/design/Design.d.ts +5704 -0
  124. package/dist/constructs/v1beta3/design/DesignSchema.d.ts +2 -0
  125. package/dist/constructs/v1beta3/environment/Environment.d.ts +785 -0
  126. package/dist/constructs/v1beta3/environment/EnvironmentSchema.d.ts +2 -0
  127. package/dist/constructs/v1beta3/event/Event.d.ts +720 -0
  128. package/dist/constructs/v1beta3/event/EventSchema.d.ts +2 -0
  129. package/dist/constructs/v1beta3/filter/Filter.d.ts +1452 -0
  130. package/dist/constructs/v1beta3/filter/FilterSchema.d.ts +2 -0
  131. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1060 -0
  132. package/dist/constructs/v1beta3/invitation/InvitationSchema.d.ts +2 -0
  133. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +813 -0
  134. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.d.ts +2 -0
  135. package/dist/constructs/v1beta3/plan/Plan.d.ts +199 -0
  136. package/dist/constructs/v1beta3/plan/PlanSchema.d.ts +2 -0
  137. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2134 -0
  138. package/dist/constructs/v1beta3/relationship/RelationshipSchema.d.ts +2 -0
  139. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +915 -0
  140. package/dist/constructs/v1beta3/subscription/SubscriptionSchema.d.ts +2 -0
  141. package/dist/constructs/v1beta3/token/Token.d.ts +544 -0
  142. package/dist/constructs/v1beta3/token/TokenSchema.d.ts +2 -0
  143. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5086 -0
  144. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.d.ts +2 -0
  145. package/dist/index.js +1 -1
  146. package/dist/index.mjs +1 -1
  147. package/package.json +2 -2
@@ -0,0 +1,1677 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+
6
+ export interface paths {
7
+ "/api/identity/orgs/{orgId}/users": {
8
+ /** Returns organization users, optionally filtered by team membership. */
9
+ get: operations["getUsersForOrg"];
10
+ };
11
+ "/api/users": {
12
+ /** Returns publicly viewable user records. */
13
+ get: operations["getUsers"];
14
+ };
15
+ "/api/identity/users/profile/{id}": {
16
+ get: operations["getUserProfileById"];
17
+ };
18
+ "/api/identity/users/profile": {
19
+ get: operations["getUser"];
20
+ };
21
+ }
22
+
23
+ export interface components {
24
+ schemas: {
25
+ /** @description Represents a user in Layer5 Cloud (Meshery) */
26
+ User: {
27
+ /**
28
+ * Format: uuid
29
+ * @description Unique identifier for the user
30
+ */
31
+ id: string;
32
+ /** @description User identifier (username or external ID) */
33
+ userId: string;
34
+ /**
35
+ * @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
36
+ * @example [
37
+ * "local",
38
+ * "github",
39
+ * "google",
40
+ * "twitter"
41
+ * ]
42
+ */
43
+ provider: string;
44
+ /**
45
+ * Format: email
46
+ * @description User's email address
47
+ */
48
+ email: string;
49
+ /** @description User's first name */
50
+ firstName: string;
51
+ /** @description User's last name */
52
+ lastName: string;
53
+ /**
54
+ * Format: uri
55
+ * @description URL to user's avatar image
56
+ */
57
+ avatarUrl?: string;
58
+ /**
59
+ * @description User account status
60
+ * @enum {string}
61
+ */
62
+ status: "active" | "inactive" | "pending" | "anonymous";
63
+ /**
64
+ * @description User's biography or description
65
+ * @default
66
+ */
67
+ bio?: string;
68
+ /** @description User's country information stored as JSONB */
69
+ country?: { [key: string]: unknown };
70
+ /** @description User's region information stored as JSONB */
71
+ region?: { [key: string]: unknown };
72
+ /** @description User preferences stored as JSONB */
73
+ preferences?: {
74
+ /** @description The mesh adapters of the preference. */
75
+ meshAdapters?: { [key: string]: unknown }[];
76
+ grafana?: {
77
+ /** @description Grafana URL for the user configuration. */
78
+ grafanaUrl?: string;
79
+ /** @description Grafana API key for the user configuration. */
80
+ grafanaApiKey?: string;
81
+ /** @description Selected Grafana board configurations for the user. */
82
+ selectedBoardsConfigs?: {
83
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
84
+ board?: { [key: string]: unknown };
85
+ /** @description Panels selected for the Grafana board configuration. */
86
+ panels?: { [key: string]: unknown }[];
87
+ /** @description Template variables applied to the selected Grafana board configuration. */
88
+ templateVars?: string[];
89
+ }[];
90
+ };
91
+ prometheus?: {
92
+ /** @description The prometheus URL of the prometheus. */
93
+ prometheusUrl?: string;
94
+ /** @description The selected prometheus boards configs of the prometheus. */
95
+ selectedPrometheusBoardsConfigs?: {
96
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
97
+ board?: { [key: string]: unknown };
98
+ /** @description Panels selected for the Grafana board configuration. */
99
+ panels?: { [key: string]: unknown }[];
100
+ /** @description Template variables applied to the selected Grafana board configuration. */
101
+ templateVars?: string[];
102
+ }[];
103
+ };
104
+ loadTestPrefs?: {
105
+ /** @description Concurrent requests */
106
+ c?: number;
107
+ /** @description Queries per second */
108
+ qps?: number;
109
+ /** @description Duration */
110
+ t?: string;
111
+ /** @description Load generator */
112
+ gen?: string;
113
+ };
114
+ /** @description The anonymous usage stats of the preference. */
115
+ anonymousUsageStats: boolean;
116
+ /** @description The anonymous perf results of the preference. */
117
+ anonymousPerfResults: boolean;
118
+ /**
119
+ * Format: date-time
120
+ * @description Timestamp of when the resource was last updated.
121
+ */
122
+ updatedAt: string;
123
+ /** @description The dashboard preferences of the preference. */
124
+ dashboardPreferences: { [key: string]: unknown };
125
+ /**
126
+ * Format: uuid
127
+ * @description ID of the associated selectedOrganization.
128
+ */
129
+ selectedOrganizationId: string;
130
+ /** @description The selected workspace for organizations of the preference. */
131
+ selectedWorkspaceForOrganizations: { [key: string]: string };
132
+ /** @description The users extension preferences of the preference. */
133
+ usersExtensionPreferences: { [key: string]: unknown };
134
+ /** @description The remote provider preferences of the preference. */
135
+ remoteProviderPreferences: { [key: string]: unknown };
136
+ };
137
+ /**
138
+ * Format: date-time
139
+ * @description Timestamp when user accepted terms and conditions
140
+ */
141
+ acceptedTermsAt?: string;
142
+ /**
143
+ * Format: date-time
144
+ * @description Timestamp of user's first login
145
+ */
146
+ firstLoginTime?: string;
147
+ /**
148
+ * Format: date-time
149
+ * @description Timestamp of user's most recent login
150
+ */
151
+ lastLoginTime: string;
152
+ /**
153
+ * Format: date-time
154
+ * @description Timestamp when the user record was created
155
+ */
156
+ createdAt: string;
157
+ /**
158
+ * Format: date-time
159
+ * @description Timestamp when the user record was last updated
160
+ */
161
+ updatedAt: string;
162
+ /** @description Various online profiles associated with the user account */
163
+ socials?: {
164
+ /** @description The site of the social. */
165
+ site: string;
166
+ /**
167
+ * Format: uri
168
+ * @description The link of the social.
169
+ */
170
+ link: string;
171
+ }[];
172
+ /**
173
+ * Format: date-time
174
+ * @description Timestamp when the user record was soft-deleted (null if not deleted)
175
+ */
176
+ deletedAt: string | null;
177
+ /**
178
+ * @description List of global roles assigned to the user
179
+ * @example [
180
+ * "admin",
181
+ * "meshmap"
182
+ * ]
183
+ */
184
+ roleNames?: (
185
+ | "admin"
186
+ | "meshmap"
187
+ | "curator"
188
+ | "team admin"
189
+ | "workspace admin"
190
+ | "workspace manager"
191
+ | "organization admin"
192
+ | "user"
193
+ )[];
194
+ /** @description Teams the user belongs to with role information */
195
+ teams?: {
196
+ /** @description Team memberships for the user with their assigned roles. */
197
+ teamsWithRoles?: { [key: string]: unknown }[];
198
+ /** @description Total number of team memberships returned for the user. */
199
+ totalCount?: number;
200
+ };
201
+ /** @description Organizations the user belongs to with role information */
202
+ organizations?: {
203
+ /** @description Organization memberships for the user with their assigned roles. */
204
+ organizationsWithRoles?: { [key: string]: unknown }[];
205
+ /** @description Total number of organization memberships returned for the user. */
206
+ totalCount?: number;
207
+ };
208
+ };
209
+ /** @description Paginated list of users with organization and team role context */
210
+ UsersPageForAdmin: {
211
+ /** @description Current page number of the result set. */
212
+ page?: number;
213
+ /** @description Number of items per page. */
214
+ pageSize?: number;
215
+ /** @description Total number of items available. */
216
+ totalCount?: number;
217
+ /** @description The data of the userspageforadmin. */
218
+ data?: {
219
+ /**
220
+ * Format: uuid
221
+ * @description Unique identifier for the user
222
+ */
223
+ id: string;
224
+ /** @description User identifier (username or external ID) */
225
+ userId: string;
226
+ /**
227
+ * @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
228
+ * @example [
229
+ * "local",
230
+ * "github",
231
+ * "google",
232
+ * "twitter"
233
+ * ]
234
+ */
235
+ provider: string;
236
+ /**
237
+ * Format: email
238
+ * @description User's email address
239
+ */
240
+ email: string;
241
+ /** @description User's first name */
242
+ firstName: string;
243
+ /** @description User's last name */
244
+ lastName: string;
245
+ /**
246
+ * Format: uri
247
+ * @description URL to user's avatar image
248
+ */
249
+ avatarUrl?: string;
250
+ /**
251
+ * @description User account status
252
+ * @enum {string}
253
+ */
254
+ status: "active" | "inactive" | "pending" | "anonymous";
255
+ /**
256
+ * @description User's biography or description
257
+ * @default
258
+ */
259
+ bio?: string;
260
+ /** @description User's country information stored as JSONB */
261
+ country?: { [key: string]: unknown };
262
+ /** @description User's region information stored as JSONB */
263
+ region?: { [key: string]: unknown };
264
+ /** @description User preferences stored as JSONB */
265
+ preferences?: {
266
+ /** @description The mesh adapters of the preference. */
267
+ meshAdapters?: { [key: string]: unknown }[];
268
+ grafana?: {
269
+ /** @description Grafana URL for the user configuration. */
270
+ grafanaUrl?: string;
271
+ /** @description Grafana API key for the user configuration. */
272
+ grafanaApiKey?: string;
273
+ /** @description Selected Grafana board configurations for the user. */
274
+ selectedBoardsConfigs?: {
275
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
276
+ board?: { [key: string]: unknown };
277
+ /** @description Panels selected for the Grafana board configuration. */
278
+ panels?: { [key: string]: unknown }[];
279
+ /** @description Template variables applied to the selected Grafana board configuration. */
280
+ templateVars?: string[];
281
+ }[];
282
+ };
283
+ prometheus?: {
284
+ /** @description The prometheus URL of the prometheus. */
285
+ prometheusUrl?: string;
286
+ /** @description The selected prometheus boards configs of the prometheus. */
287
+ selectedPrometheusBoardsConfigs?: {
288
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
289
+ board?: { [key: string]: unknown };
290
+ /** @description Panels selected for the Grafana board configuration. */
291
+ panels?: { [key: string]: unknown }[];
292
+ /** @description Template variables applied to the selected Grafana board configuration. */
293
+ templateVars?: string[];
294
+ }[];
295
+ };
296
+ loadTestPrefs?: {
297
+ /** @description Concurrent requests */
298
+ c?: number;
299
+ /** @description Queries per second */
300
+ qps?: number;
301
+ /** @description Duration */
302
+ t?: string;
303
+ /** @description Load generator */
304
+ gen?: string;
305
+ };
306
+ /** @description The anonymous usage stats of the preference. */
307
+ anonymousUsageStats: boolean;
308
+ /** @description The anonymous perf results of the preference. */
309
+ anonymousPerfResults: boolean;
310
+ /**
311
+ * Format: date-time
312
+ * @description Timestamp of when the resource was last updated.
313
+ */
314
+ updatedAt: string;
315
+ /** @description The dashboard preferences of the preference. */
316
+ dashboardPreferences: { [key: string]: unknown };
317
+ /**
318
+ * Format: uuid
319
+ * @description ID of the associated selectedOrganization.
320
+ */
321
+ selectedOrganizationId: string;
322
+ /** @description The selected workspace for organizations of the preference. */
323
+ selectedWorkspaceForOrganizations: { [key: string]: string };
324
+ /** @description The users extension preferences of the preference. */
325
+ usersExtensionPreferences: { [key: string]: unknown };
326
+ /** @description The remote provider preferences of the preference. */
327
+ remoteProviderPreferences: { [key: string]: unknown };
328
+ };
329
+ /**
330
+ * Format: date-time
331
+ * @description Timestamp when user accepted terms and conditions
332
+ */
333
+ acceptedTermsAt?: string;
334
+ /**
335
+ * Format: date-time
336
+ * @description Timestamp of user's first login
337
+ */
338
+ firstLoginTime?: string;
339
+ /**
340
+ * Format: date-time
341
+ * @description Timestamp of user's most recent login
342
+ */
343
+ lastLoginTime: string;
344
+ /**
345
+ * Format: date-time
346
+ * @description Timestamp when the user record was created
347
+ */
348
+ createdAt: string;
349
+ /**
350
+ * Format: date-time
351
+ * @description Timestamp when the user record was last updated
352
+ */
353
+ updatedAt: string;
354
+ /** @description Various online profiles associated with the user account */
355
+ socials?: {
356
+ /** @description The site of the social. */
357
+ site: string;
358
+ /**
359
+ * Format: uri
360
+ * @description The link of the social.
361
+ */
362
+ link: string;
363
+ }[];
364
+ /**
365
+ * Format: date-time
366
+ * @description Timestamp when the user record was soft-deleted (null if not deleted)
367
+ */
368
+ deletedAt: string | null;
369
+ /**
370
+ * @description List of global roles assigned to the user
371
+ * @example [
372
+ * "admin",
373
+ * "meshmap"
374
+ * ]
375
+ */
376
+ roleNames?: (
377
+ | "admin"
378
+ | "meshmap"
379
+ | "curator"
380
+ | "team admin"
381
+ | "workspace admin"
382
+ | "workspace manager"
383
+ | "organization admin"
384
+ | "user"
385
+ )[];
386
+ /** @description Teams the user belongs to with role information */
387
+ teams?: {
388
+ /** @description Team memberships for the user with their assigned roles. */
389
+ teamsWithRoles?: { [key: string]: unknown }[];
390
+ /** @description Total number of team memberships returned for the user. */
391
+ totalCount?: number;
392
+ };
393
+ /** @description Organizations the user belongs to with role information */
394
+ organizations?: {
395
+ /** @description Organization memberships for the user with their assigned roles. */
396
+ organizationsWithRoles?: { [key: string]: unknown }[];
397
+ /** @description Total number of organization memberships returned for the user. */
398
+ totalCount?: number;
399
+ };
400
+ }[];
401
+ };
402
+ /** @description Paginated list of public user records */
403
+ UsersPageForNonAdmin: {
404
+ /** @description Current page number of the result set. */
405
+ page?: number;
406
+ /** @description Number of items per page. */
407
+ pageSize?: number;
408
+ /** @description Total number of items available. */
409
+ totalCount?: number;
410
+ /** @description The data of the userspagefornonadmin. */
411
+ data?: {
412
+ /**
413
+ * Format: uuid
414
+ * @description Unique identifier for the user
415
+ */
416
+ id: string;
417
+ /** @description User identifier (username or external ID) */
418
+ userId: string;
419
+ /**
420
+ * @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
421
+ * @example [
422
+ * "local",
423
+ * "github",
424
+ * "google",
425
+ * "twitter"
426
+ * ]
427
+ */
428
+ provider: string;
429
+ /**
430
+ * Format: email
431
+ * @description User's email address
432
+ */
433
+ email: string;
434
+ /** @description User's first name */
435
+ firstName: string;
436
+ /** @description User's last name */
437
+ lastName: string;
438
+ /**
439
+ * Format: uri
440
+ * @description URL to user's avatar image
441
+ */
442
+ avatarUrl?: string;
443
+ /**
444
+ * @description User account status
445
+ * @enum {string}
446
+ */
447
+ status: "active" | "inactive" | "pending" | "anonymous";
448
+ /**
449
+ * @description User's biography or description
450
+ * @default
451
+ */
452
+ bio?: string;
453
+ /** @description User's country information stored as JSONB */
454
+ country?: { [key: string]: unknown };
455
+ /** @description User's region information stored as JSONB */
456
+ region?: { [key: string]: unknown };
457
+ /** @description User preferences stored as JSONB */
458
+ preferences?: {
459
+ /** @description The mesh adapters of the preference. */
460
+ meshAdapters?: { [key: string]: unknown }[];
461
+ grafana?: {
462
+ /** @description Grafana URL for the user configuration. */
463
+ grafanaUrl?: string;
464
+ /** @description Grafana API key for the user configuration. */
465
+ grafanaApiKey?: string;
466
+ /** @description Selected Grafana board configurations for the user. */
467
+ selectedBoardsConfigs?: {
468
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
469
+ board?: { [key: string]: unknown };
470
+ /** @description Panels selected for the Grafana board configuration. */
471
+ panels?: { [key: string]: unknown }[];
472
+ /** @description Template variables applied to the selected Grafana board configuration. */
473
+ templateVars?: string[];
474
+ }[];
475
+ };
476
+ prometheus?: {
477
+ /** @description The prometheus URL of the prometheus. */
478
+ prometheusUrl?: string;
479
+ /** @description The selected prometheus boards configs of the prometheus. */
480
+ selectedPrometheusBoardsConfigs?: {
481
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
482
+ board?: { [key: string]: unknown };
483
+ /** @description Panels selected for the Grafana board configuration. */
484
+ panels?: { [key: string]: unknown }[];
485
+ /** @description Template variables applied to the selected Grafana board configuration. */
486
+ templateVars?: string[];
487
+ }[];
488
+ };
489
+ loadTestPrefs?: {
490
+ /** @description Concurrent requests */
491
+ c?: number;
492
+ /** @description Queries per second */
493
+ qps?: number;
494
+ /** @description Duration */
495
+ t?: string;
496
+ /** @description Load generator */
497
+ gen?: string;
498
+ };
499
+ /** @description The anonymous usage stats of the preference. */
500
+ anonymousUsageStats: boolean;
501
+ /** @description The anonymous perf results of the preference. */
502
+ anonymousPerfResults: boolean;
503
+ /**
504
+ * Format: date-time
505
+ * @description Timestamp of when the resource was last updated.
506
+ */
507
+ updatedAt: string;
508
+ /** @description The dashboard preferences of the preference. */
509
+ dashboardPreferences: { [key: string]: unknown };
510
+ /**
511
+ * Format: uuid
512
+ * @description ID of the associated selectedOrganization.
513
+ */
514
+ selectedOrganizationId: string;
515
+ /** @description The selected workspace for organizations of the preference. */
516
+ selectedWorkspaceForOrganizations: { [key: string]: string };
517
+ /** @description The users extension preferences of the preference. */
518
+ usersExtensionPreferences: { [key: string]: unknown };
519
+ /** @description The remote provider preferences of the preference. */
520
+ remoteProviderPreferences: { [key: string]: unknown };
521
+ };
522
+ /**
523
+ * Format: date-time
524
+ * @description Timestamp when user accepted terms and conditions
525
+ */
526
+ acceptedTermsAt?: string;
527
+ /**
528
+ * Format: date-time
529
+ * @description Timestamp of user's first login
530
+ */
531
+ firstLoginTime?: string;
532
+ /**
533
+ * Format: date-time
534
+ * @description Timestamp of user's most recent login
535
+ */
536
+ lastLoginTime: string;
537
+ /**
538
+ * Format: date-time
539
+ * @description Timestamp when the user record was created
540
+ */
541
+ createdAt: string;
542
+ /**
543
+ * Format: date-time
544
+ * @description Timestamp when the user record was last updated
545
+ */
546
+ updatedAt: string;
547
+ /** @description Various online profiles associated with the user account */
548
+ socials?: {
549
+ /** @description The site of the social. */
550
+ site: string;
551
+ /**
552
+ * Format: uri
553
+ * @description The link of the social.
554
+ */
555
+ link: string;
556
+ }[];
557
+ /**
558
+ * Format: date-time
559
+ * @description Timestamp when the user record was soft-deleted (null if not deleted)
560
+ */
561
+ deletedAt: string | null;
562
+ /**
563
+ * @description List of global roles assigned to the user
564
+ * @example [
565
+ * "admin",
566
+ * "meshmap"
567
+ * ]
568
+ */
569
+ roleNames?: (
570
+ | "admin"
571
+ | "meshmap"
572
+ | "curator"
573
+ | "team admin"
574
+ | "workspace admin"
575
+ | "workspace manager"
576
+ | "organization admin"
577
+ | "user"
578
+ )[];
579
+ /** @description Teams the user belongs to with role information */
580
+ teams?: {
581
+ /** @description Team memberships for the user with their assigned roles. */
582
+ teamsWithRoles?: { [key: string]: unknown }[];
583
+ /** @description Total number of team memberships returned for the user. */
584
+ totalCount?: number;
585
+ };
586
+ /** @description Organizations the user belongs to with role information */
587
+ organizations?: {
588
+ /** @description Organization memberships for the user with their assigned roles. */
589
+ organizationsWithRoles?: { [key: string]: unknown }[];
590
+ /** @description Total number of organization memberships returned for the user. */
591
+ totalCount?: number;
592
+ };
593
+ }[];
594
+ };
595
+ Preference: {
596
+ /** @description The mesh adapters of the preference. */
597
+ meshAdapters?: { [key: string]: unknown }[];
598
+ grafana?: {
599
+ /** @description Grafana URL for the user configuration. */
600
+ grafanaUrl?: string;
601
+ /** @description Grafana API key for the user configuration. */
602
+ grafanaApiKey?: string;
603
+ /** @description Selected Grafana board configurations for the user. */
604
+ selectedBoardsConfigs?: {
605
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
606
+ board?: { [key: string]: unknown };
607
+ /** @description Panels selected for the Grafana board configuration. */
608
+ panels?: { [key: string]: unknown }[];
609
+ /** @description Template variables applied to the selected Grafana board configuration. */
610
+ templateVars?: string[];
611
+ }[];
612
+ };
613
+ prometheus?: {
614
+ /** @description The prometheus URL of the prometheus. */
615
+ prometheusUrl?: string;
616
+ /** @description The selected prometheus boards configs of the prometheus. */
617
+ selectedPrometheusBoardsConfigs?: {
618
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
619
+ board?: { [key: string]: unknown };
620
+ /** @description Panels selected for the Grafana board configuration. */
621
+ panels?: { [key: string]: unknown }[];
622
+ /** @description Template variables applied to the selected Grafana board configuration. */
623
+ templateVars?: string[];
624
+ }[];
625
+ };
626
+ loadTestPrefs?: {
627
+ /** @description Concurrent requests */
628
+ c?: number;
629
+ /** @description Queries per second */
630
+ qps?: number;
631
+ /** @description Duration */
632
+ t?: string;
633
+ /** @description Load generator */
634
+ gen?: string;
635
+ };
636
+ /** @description The anonymous usage stats of the preference. */
637
+ anonymousUsageStats: boolean;
638
+ /** @description The anonymous perf results of the preference. */
639
+ anonymousPerfResults: boolean;
640
+ /**
641
+ * Format: date-time
642
+ * @description Timestamp of when the resource was last updated.
643
+ */
644
+ updatedAt: string;
645
+ /** @description The dashboard preferences of the preference. */
646
+ dashboardPreferences: { [key: string]: unknown };
647
+ /**
648
+ * Format: uuid
649
+ * @description ID of the associated selectedOrganization.
650
+ */
651
+ selectedOrganizationId: string;
652
+ /** @description The selected workspace for organizations of the preference. */
653
+ selectedWorkspaceForOrganizations: { [key: string]: string };
654
+ /** @description The users extension preferences of the preference. */
655
+ usersExtensionPreferences: { [key: string]: unknown };
656
+ /** @description The remote provider preferences of the preference. */
657
+ remoteProviderPreferences: { [key: string]: unknown };
658
+ };
659
+ /** @description Placeholder for Adapter struct definition. */
660
+ Adapter: { [key: string]: unknown };
661
+ Grafana: {
662
+ /** @description Grafana URL for the user configuration. */
663
+ grafanaUrl?: string;
664
+ /** @description Grafana API key for the user configuration. */
665
+ grafanaApiKey?: string;
666
+ /** @description Selected Grafana board configurations for the user. */
667
+ selectedBoardsConfigs?: {
668
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
669
+ board?: { [key: string]: unknown };
670
+ /** @description Panels selected for the Grafana board configuration. */
671
+ panels?: { [key: string]: unknown }[];
672
+ /** @description Template variables applied to the selected Grafana board configuration. */
673
+ templateVars?: string[];
674
+ }[];
675
+ };
676
+ SelectedGrafanaConfig: {
677
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
678
+ board?: { [key: string]: unknown };
679
+ /** @description Panels selected for the Grafana board configuration. */
680
+ panels?: { [key: string]: unknown }[];
681
+ /** @description Template variables applied to the selected Grafana board configuration. */
682
+ templateVars?: string[];
683
+ };
684
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
685
+ GrafanaBoard: { [key: string]: unknown };
686
+ /** @description Grafana panel structure imported from github.com/grafana-tools/sdk */
687
+ Panel: { [key: string]: unknown };
688
+ Prometheus: {
689
+ /** @description The prometheus URL of the prometheus. */
690
+ prometheusUrl?: string;
691
+ /** @description The selected prometheus boards configs of the prometheus. */
692
+ selectedPrometheusBoardsConfigs?: {
693
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
694
+ board?: { [key: string]: unknown };
695
+ /** @description Panels selected for the Grafana board configuration. */
696
+ panels?: { [key: string]: unknown }[];
697
+ /** @description Template variables applied to the selected Grafana board configuration. */
698
+ templateVars?: string[];
699
+ }[];
700
+ };
701
+ LoadTestPreferences: {
702
+ /** @description Concurrent requests */
703
+ c?: number;
704
+ /** @description Queries per second */
705
+ qps?: number;
706
+ /** @description Duration */
707
+ t?: string;
708
+ /** @description Load generator */
709
+ gen?: string;
710
+ };
711
+ /** @description Various online profiles associated with the user account, like GitHub, LinkedIn, X, and so on. */
712
+ Social: {
713
+ /** @description The site of the social. */
714
+ site: string;
715
+ /**
716
+ * Format: uri
717
+ * @description The link of the social.
718
+ */
719
+ link: string;
720
+ };
721
+ };
722
+ responses: {
723
+ /** Invalid request body or request param */
724
+ 400: {
725
+ content: {
726
+ "text/plain": string;
727
+ };
728
+ };
729
+ /** Expired JWT token used or insufficient privilege */
730
+ 401: {
731
+ content: {
732
+ "text/plain": string;
733
+ };
734
+ };
735
+ /** Result not found */
736
+ 404: {
737
+ content: {
738
+ "text/plain": string;
739
+ };
740
+ };
741
+ /** Internal server error */
742
+ 500: {
743
+ content: {
744
+ "text/plain": string;
745
+ };
746
+ };
747
+ };
748
+ parameters: {
749
+ /** @description User ID */
750
+ id: string;
751
+ /** @description Organization ID */
752
+ orgId: string;
753
+ /** @description Get responses by page */
754
+ page: string;
755
+ /** @description Get responses by page size */
756
+ pageSize: string;
757
+ /** @description Get responses that match search param value */
758
+ search: string;
759
+ /** @description Get ordered responses */
760
+ order: string;
761
+ /** @description Get filtered reponses */
762
+ filter: string;
763
+ /** @description Optional team filter when listing organization users */
764
+ teamId: string;
765
+ };
766
+ }
767
+
768
+ export interface operations {
769
+ /** Returns organization users, optionally filtered by team membership. */
770
+ getUsersForOrg: {
771
+ parameters: {
772
+ path: {
773
+ /** Organization ID */
774
+ orgId: string;
775
+ };
776
+ query: {
777
+ /** Get responses by page */
778
+ page?: string;
779
+ /** Get responses by page size */
780
+ pageSize?: string;
781
+ /** Get responses that match search param value */
782
+ search?: string;
783
+ /** Get ordered responses */
784
+ order?: string;
785
+ /** Get filtered reponses */
786
+ filter?: string;
787
+ /** Optional team filter when listing organization users */
788
+ teamId?: string;
789
+ };
790
+ };
791
+ responses: {
792
+ /** Paginated list of organization users */
793
+ 200: {
794
+ content: {
795
+ "application/json": {
796
+ /** @description Current page number of the result set. */
797
+ page?: number;
798
+ /** @description Number of items per page. */
799
+ pageSize?: number;
800
+ /** @description Total number of items available. */
801
+ totalCount?: number;
802
+ /** @description The data of the userspageforadmin. */
803
+ data?: {
804
+ /**
805
+ * Format: uuid
806
+ * @description Unique identifier for the user
807
+ */
808
+ id: string;
809
+ /** @description User identifier (username or external ID) */
810
+ userId: string;
811
+ /**
812
+ * @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
813
+ * @example [
814
+ * "local",
815
+ * "github",
816
+ * "google",
817
+ * "twitter"
818
+ * ]
819
+ */
820
+ provider: string;
821
+ /**
822
+ * Format: email
823
+ * @description User's email address
824
+ */
825
+ email: string;
826
+ /** @description User's first name */
827
+ firstName: string;
828
+ /** @description User's last name */
829
+ lastName: string;
830
+ /**
831
+ * Format: uri
832
+ * @description URL to user's avatar image
833
+ */
834
+ avatarUrl?: string;
835
+ /**
836
+ * @description User account status
837
+ * @enum {string}
838
+ */
839
+ status: "active" | "inactive" | "pending" | "anonymous";
840
+ /**
841
+ * @description User's biography or description
842
+ * @default
843
+ */
844
+ bio?: string;
845
+ /** @description User's country information stored as JSONB */
846
+ country?: { [key: string]: unknown };
847
+ /** @description User's region information stored as JSONB */
848
+ region?: { [key: string]: unknown };
849
+ /** @description User preferences stored as JSONB */
850
+ preferences?: {
851
+ /** @description The mesh adapters of the preference. */
852
+ meshAdapters?: { [key: string]: unknown }[];
853
+ grafana?: {
854
+ /** @description Grafana URL for the user configuration. */
855
+ grafanaUrl?: string;
856
+ /** @description Grafana API key for the user configuration. */
857
+ grafanaApiKey?: string;
858
+ /** @description Selected Grafana board configurations for the user. */
859
+ selectedBoardsConfigs?: {
860
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
861
+ board?: { [key: string]: unknown };
862
+ /** @description Panels selected for the Grafana board configuration. */
863
+ panels?: { [key: string]: unknown }[];
864
+ /** @description Template variables applied to the selected Grafana board configuration. */
865
+ templateVars?: string[];
866
+ }[];
867
+ };
868
+ prometheus?: {
869
+ /** @description The prometheus URL of the prometheus. */
870
+ prometheusUrl?: string;
871
+ /** @description The selected prometheus boards configs of the prometheus. */
872
+ selectedPrometheusBoardsConfigs?: {
873
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
874
+ board?: { [key: string]: unknown };
875
+ /** @description Panels selected for the Grafana board configuration. */
876
+ panels?: { [key: string]: unknown }[];
877
+ /** @description Template variables applied to the selected Grafana board configuration. */
878
+ templateVars?: string[];
879
+ }[];
880
+ };
881
+ loadTestPrefs?: {
882
+ /** @description Concurrent requests */
883
+ c?: number;
884
+ /** @description Queries per second */
885
+ qps?: number;
886
+ /** @description Duration */
887
+ t?: string;
888
+ /** @description Load generator */
889
+ gen?: string;
890
+ };
891
+ /** @description The anonymous usage stats of the preference. */
892
+ anonymousUsageStats: boolean;
893
+ /** @description The anonymous perf results of the preference. */
894
+ anonymousPerfResults: boolean;
895
+ /**
896
+ * Format: date-time
897
+ * @description Timestamp of when the resource was last updated.
898
+ */
899
+ updatedAt: string;
900
+ /** @description The dashboard preferences of the preference. */
901
+ dashboardPreferences: { [key: string]: unknown };
902
+ /**
903
+ * Format: uuid
904
+ * @description ID of the associated selectedOrganization.
905
+ */
906
+ selectedOrganizationId: string;
907
+ /** @description The selected workspace for organizations of the preference. */
908
+ selectedWorkspaceForOrganizations: { [key: string]: string };
909
+ /** @description The users extension preferences of the preference. */
910
+ usersExtensionPreferences: { [key: string]: unknown };
911
+ /** @description The remote provider preferences of the preference. */
912
+ remoteProviderPreferences: { [key: string]: unknown };
913
+ };
914
+ /**
915
+ * Format: date-time
916
+ * @description Timestamp when user accepted terms and conditions
917
+ */
918
+ acceptedTermsAt?: string;
919
+ /**
920
+ * Format: date-time
921
+ * @description Timestamp of user's first login
922
+ */
923
+ firstLoginTime?: string;
924
+ /**
925
+ * Format: date-time
926
+ * @description Timestamp of user's most recent login
927
+ */
928
+ lastLoginTime: string;
929
+ /**
930
+ * Format: date-time
931
+ * @description Timestamp when the user record was created
932
+ */
933
+ createdAt: string;
934
+ /**
935
+ * Format: date-time
936
+ * @description Timestamp when the user record was last updated
937
+ */
938
+ updatedAt: string;
939
+ /** @description Various online profiles associated with the user account */
940
+ socials?: {
941
+ /** @description The site of the social. */
942
+ site: string;
943
+ /**
944
+ * Format: uri
945
+ * @description The link of the social.
946
+ */
947
+ link: string;
948
+ }[];
949
+ /**
950
+ * Format: date-time
951
+ * @description Timestamp when the user record was soft-deleted (null if not deleted)
952
+ */
953
+ deletedAt: string | null;
954
+ /**
955
+ * @description List of global roles assigned to the user
956
+ * @example [
957
+ * "admin",
958
+ * "meshmap"
959
+ * ]
960
+ */
961
+ roleNames?: (
962
+ | "admin"
963
+ | "meshmap"
964
+ | "curator"
965
+ | "team admin"
966
+ | "workspace admin"
967
+ | "workspace manager"
968
+ | "organization admin"
969
+ | "user"
970
+ )[];
971
+ /** @description Teams the user belongs to with role information */
972
+ teams?: {
973
+ /** @description Team memberships for the user with their assigned roles. */
974
+ teamsWithRoles?: { [key: string]: unknown }[];
975
+ /** @description Total number of team memberships returned for the user. */
976
+ totalCount?: number;
977
+ };
978
+ /** @description Organizations the user belongs to with role information */
979
+ organizations?: {
980
+ /** @description Organization memberships for the user with their assigned roles. */
981
+ organizationsWithRoles?: { [key: string]: unknown }[];
982
+ /** @description Total number of organization memberships returned for the user. */
983
+ totalCount?: number;
984
+ };
985
+ }[];
986
+ };
987
+ };
988
+ };
989
+ /** Invalid request body or request param */
990
+ 400: {
991
+ content: {
992
+ "text/plain": string;
993
+ };
994
+ };
995
+ /** Expired JWT token used or insufficient privilege */
996
+ 401: {
997
+ content: {
998
+ "text/plain": string;
999
+ };
1000
+ };
1001
+ /** Result not found */
1002
+ 404: {
1003
+ content: {
1004
+ "text/plain": string;
1005
+ };
1006
+ };
1007
+ /** Internal server error */
1008
+ 500: {
1009
+ content: {
1010
+ "text/plain": string;
1011
+ };
1012
+ };
1013
+ };
1014
+ };
1015
+ /** Returns publicly viewable user records. */
1016
+ getUsers: {
1017
+ parameters: {
1018
+ query: {
1019
+ /** Get responses by page */
1020
+ page?: string;
1021
+ /** Get responses by page size */
1022
+ pageSize?: string;
1023
+ /** Get responses that match search param value */
1024
+ search?: string;
1025
+ /** Get ordered responses */
1026
+ order?: string;
1027
+ /** Get filtered reponses */
1028
+ filter?: string;
1029
+ };
1030
+ };
1031
+ responses: {
1032
+ /** Paginated list of public users */
1033
+ 200: {
1034
+ content: {
1035
+ "application/json": {
1036
+ /** @description Current page number of the result set. */
1037
+ page?: number;
1038
+ /** @description Number of items per page. */
1039
+ pageSize?: number;
1040
+ /** @description Total number of items available. */
1041
+ totalCount?: number;
1042
+ /** @description The data of the userspagefornonadmin. */
1043
+ data?: {
1044
+ /**
1045
+ * Format: uuid
1046
+ * @description Unique identifier for the user
1047
+ */
1048
+ id: string;
1049
+ /** @description User identifier (username or external ID) */
1050
+ userId: string;
1051
+ /**
1052
+ * @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
1053
+ * @example [
1054
+ * "local",
1055
+ * "github",
1056
+ * "google",
1057
+ * "twitter"
1058
+ * ]
1059
+ */
1060
+ provider: string;
1061
+ /**
1062
+ * Format: email
1063
+ * @description User's email address
1064
+ */
1065
+ email: string;
1066
+ /** @description User's first name */
1067
+ firstName: string;
1068
+ /** @description User's last name */
1069
+ lastName: string;
1070
+ /**
1071
+ * Format: uri
1072
+ * @description URL to user's avatar image
1073
+ */
1074
+ avatarUrl?: string;
1075
+ /**
1076
+ * @description User account status
1077
+ * @enum {string}
1078
+ */
1079
+ status: "active" | "inactive" | "pending" | "anonymous";
1080
+ /**
1081
+ * @description User's biography or description
1082
+ * @default
1083
+ */
1084
+ bio?: string;
1085
+ /** @description User's country information stored as JSONB */
1086
+ country?: { [key: string]: unknown };
1087
+ /** @description User's region information stored as JSONB */
1088
+ region?: { [key: string]: unknown };
1089
+ /** @description User preferences stored as JSONB */
1090
+ preferences?: {
1091
+ /** @description The mesh adapters of the preference. */
1092
+ meshAdapters?: { [key: string]: unknown }[];
1093
+ grafana?: {
1094
+ /** @description Grafana URL for the user configuration. */
1095
+ grafanaUrl?: string;
1096
+ /** @description Grafana API key for the user configuration. */
1097
+ grafanaApiKey?: string;
1098
+ /** @description Selected Grafana board configurations for the user. */
1099
+ selectedBoardsConfigs?: {
1100
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
1101
+ board?: { [key: string]: unknown };
1102
+ /** @description Panels selected for the Grafana board configuration. */
1103
+ panels?: { [key: string]: unknown }[];
1104
+ /** @description Template variables applied to the selected Grafana board configuration. */
1105
+ templateVars?: string[];
1106
+ }[];
1107
+ };
1108
+ prometheus?: {
1109
+ /** @description The prometheus URL of the prometheus. */
1110
+ prometheusUrl?: string;
1111
+ /** @description The selected prometheus boards configs of the prometheus. */
1112
+ selectedPrometheusBoardsConfigs?: {
1113
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
1114
+ board?: { [key: string]: unknown };
1115
+ /** @description Panels selected for the Grafana board configuration. */
1116
+ panels?: { [key: string]: unknown }[];
1117
+ /** @description Template variables applied to the selected Grafana board configuration. */
1118
+ templateVars?: string[];
1119
+ }[];
1120
+ };
1121
+ loadTestPrefs?: {
1122
+ /** @description Concurrent requests */
1123
+ c?: number;
1124
+ /** @description Queries per second */
1125
+ qps?: number;
1126
+ /** @description Duration */
1127
+ t?: string;
1128
+ /** @description Load generator */
1129
+ gen?: string;
1130
+ };
1131
+ /** @description The anonymous usage stats of the preference. */
1132
+ anonymousUsageStats: boolean;
1133
+ /** @description The anonymous perf results of the preference. */
1134
+ anonymousPerfResults: boolean;
1135
+ /**
1136
+ * Format: date-time
1137
+ * @description Timestamp of when the resource was last updated.
1138
+ */
1139
+ updatedAt: string;
1140
+ /** @description The dashboard preferences of the preference. */
1141
+ dashboardPreferences: { [key: string]: unknown };
1142
+ /**
1143
+ * Format: uuid
1144
+ * @description ID of the associated selectedOrganization.
1145
+ */
1146
+ selectedOrganizationId: string;
1147
+ /** @description The selected workspace for organizations of the preference. */
1148
+ selectedWorkspaceForOrganizations: { [key: string]: string };
1149
+ /** @description The users extension preferences of the preference. */
1150
+ usersExtensionPreferences: { [key: string]: unknown };
1151
+ /** @description The remote provider preferences of the preference. */
1152
+ remoteProviderPreferences: { [key: string]: unknown };
1153
+ };
1154
+ /**
1155
+ * Format: date-time
1156
+ * @description Timestamp when user accepted terms and conditions
1157
+ */
1158
+ acceptedTermsAt?: string;
1159
+ /**
1160
+ * Format: date-time
1161
+ * @description Timestamp of user's first login
1162
+ */
1163
+ firstLoginTime?: string;
1164
+ /**
1165
+ * Format: date-time
1166
+ * @description Timestamp of user's most recent login
1167
+ */
1168
+ lastLoginTime: string;
1169
+ /**
1170
+ * Format: date-time
1171
+ * @description Timestamp when the user record was created
1172
+ */
1173
+ createdAt: string;
1174
+ /**
1175
+ * Format: date-time
1176
+ * @description Timestamp when the user record was last updated
1177
+ */
1178
+ updatedAt: string;
1179
+ /** @description Various online profiles associated with the user account */
1180
+ socials?: {
1181
+ /** @description The site of the social. */
1182
+ site: string;
1183
+ /**
1184
+ * Format: uri
1185
+ * @description The link of the social.
1186
+ */
1187
+ link: string;
1188
+ }[];
1189
+ /**
1190
+ * Format: date-time
1191
+ * @description Timestamp when the user record was soft-deleted (null if not deleted)
1192
+ */
1193
+ deletedAt: string | null;
1194
+ /**
1195
+ * @description List of global roles assigned to the user
1196
+ * @example [
1197
+ * "admin",
1198
+ * "meshmap"
1199
+ * ]
1200
+ */
1201
+ roleNames?: (
1202
+ | "admin"
1203
+ | "meshmap"
1204
+ | "curator"
1205
+ | "team admin"
1206
+ | "workspace admin"
1207
+ | "workspace manager"
1208
+ | "organization admin"
1209
+ | "user"
1210
+ )[];
1211
+ /** @description Teams the user belongs to with role information */
1212
+ teams?: {
1213
+ /** @description Team memberships for the user with their assigned roles. */
1214
+ teamsWithRoles?: { [key: string]: unknown }[];
1215
+ /** @description Total number of team memberships returned for the user. */
1216
+ totalCount?: number;
1217
+ };
1218
+ /** @description Organizations the user belongs to with role information */
1219
+ organizations?: {
1220
+ /** @description Organization memberships for the user with their assigned roles. */
1221
+ organizationsWithRoles?: { [key: string]: unknown }[];
1222
+ /** @description Total number of organization memberships returned for the user. */
1223
+ totalCount?: number;
1224
+ };
1225
+ }[];
1226
+ };
1227
+ };
1228
+ };
1229
+ /** Invalid request body or request param */
1230
+ 400: {
1231
+ content: {
1232
+ "text/plain": string;
1233
+ };
1234
+ };
1235
+ /** Expired JWT token used or insufficient privilege */
1236
+ 401: {
1237
+ content: {
1238
+ "text/plain": string;
1239
+ };
1240
+ };
1241
+ /** Internal server error */
1242
+ 500: {
1243
+ content: {
1244
+ "text/plain": string;
1245
+ };
1246
+ };
1247
+ };
1248
+ };
1249
+ getUserProfileById: {
1250
+ parameters: {
1251
+ path: {
1252
+ /** User ID */
1253
+ id: string;
1254
+ };
1255
+ };
1256
+ responses: {
1257
+ /** User profile for the requested ID */
1258
+ 200: {
1259
+ content: {
1260
+ "application/json": {
1261
+ /**
1262
+ * Format: uuid
1263
+ * @description Unique identifier for the user
1264
+ */
1265
+ id: string;
1266
+ /** @description User identifier (username or external ID) */
1267
+ userId: string;
1268
+ /**
1269
+ * @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
1270
+ * @example [
1271
+ * "local",
1272
+ * "github",
1273
+ * "google",
1274
+ * "twitter"
1275
+ * ]
1276
+ */
1277
+ provider: string;
1278
+ /**
1279
+ * Format: email
1280
+ * @description User's email address
1281
+ */
1282
+ email: string;
1283
+ /** @description User's first name */
1284
+ firstName: string;
1285
+ /** @description User's last name */
1286
+ lastName: string;
1287
+ /**
1288
+ * Format: uri
1289
+ * @description URL to user's avatar image
1290
+ */
1291
+ avatarUrl?: string;
1292
+ /**
1293
+ * @description User account status
1294
+ * @enum {string}
1295
+ */
1296
+ status: "active" | "inactive" | "pending" | "anonymous";
1297
+ /**
1298
+ * @description User's biography or description
1299
+ * @default
1300
+ */
1301
+ bio?: string;
1302
+ /** @description User's country information stored as JSONB */
1303
+ country?: { [key: string]: unknown };
1304
+ /** @description User's region information stored as JSONB */
1305
+ region?: { [key: string]: unknown };
1306
+ /** @description User preferences stored as JSONB */
1307
+ preferences?: {
1308
+ /** @description The mesh adapters of the preference. */
1309
+ meshAdapters?: { [key: string]: unknown }[];
1310
+ grafana?: {
1311
+ /** @description Grafana URL for the user configuration. */
1312
+ grafanaUrl?: string;
1313
+ /** @description Grafana API key for the user configuration. */
1314
+ grafanaApiKey?: string;
1315
+ /** @description Selected Grafana board configurations for the user. */
1316
+ selectedBoardsConfigs?: {
1317
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
1318
+ board?: { [key: string]: unknown };
1319
+ /** @description Panels selected for the Grafana board configuration. */
1320
+ panels?: { [key: string]: unknown }[];
1321
+ /** @description Template variables applied to the selected Grafana board configuration. */
1322
+ templateVars?: string[];
1323
+ }[];
1324
+ };
1325
+ prometheus?: {
1326
+ /** @description The prometheus URL of the prometheus. */
1327
+ prometheusUrl?: string;
1328
+ /** @description The selected prometheus boards configs of the prometheus. */
1329
+ selectedPrometheusBoardsConfigs?: {
1330
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
1331
+ board?: { [key: string]: unknown };
1332
+ /** @description Panels selected for the Grafana board configuration. */
1333
+ panels?: { [key: string]: unknown }[];
1334
+ /** @description Template variables applied to the selected Grafana board configuration. */
1335
+ templateVars?: string[];
1336
+ }[];
1337
+ };
1338
+ loadTestPrefs?: {
1339
+ /** @description Concurrent requests */
1340
+ c?: number;
1341
+ /** @description Queries per second */
1342
+ qps?: number;
1343
+ /** @description Duration */
1344
+ t?: string;
1345
+ /** @description Load generator */
1346
+ gen?: string;
1347
+ };
1348
+ /** @description The anonymous usage stats of the preference. */
1349
+ anonymousUsageStats: boolean;
1350
+ /** @description The anonymous perf results of the preference. */
1351
+ anonymousPerfResults: boolean;
1352
+ /**
1353
+ * Format: date-time
1354
+ * @description Timestamp of when the resource was last updated.
1355
+ */
1356
+ updatedAt: string;
1357
+ /** @description The dashboard preferences of the preference. */
1358
+ dashboardPreferences: { [key: string]: unknown };
1359
+ /**
1360
+ * Format: uuid
1361
+ * @description ID of the associated selectedOrganization.
1362
+ */
1363
+ selectedOrganizationId: string;
1364
+ /** @description The selected workspace for organizations of the preference. */
1365
+ selectedWorkspaceForOrganizations: { [key: string]: string };
1366
+ /** @description The users extension preferences of the preference. */
1367
+ usersExtensionPreferences: { [key: string]: unknown };
1368
+ /** @description The remote provider preferences of the preference. */
1369
+ remoteProviderPreferences: { [key: string]: unknown };
1370
+ };
1371
+ /**
1372
+ * Format: date-time
1373
+ * @description Timestamp when user accepted terms and conditions
1374
+ */
1375
+ acceptedTermsAt?: string;
1376
+ /**
1377
+ * Format: date-time
1378
+ * @description Timestamp of user's first login
1379
+ */
1380
+ firstLoginTime?: string;
1381
+ /**
1382
+ * Format: date-time
1383
+ * @description Timestamp of user's most recent login
1384
+ */
1385
+ lastLoginTime: string;
1386
+ /**
1387
+ * Format: date-time
1388
+ * @description Timestamp when the user record was created
1389
+ */
1390
+ createdAt: string;
1391
+ /**
1392
+ * Format: date-time
1393
+ * @description Timestamp when the user record was last updated
1394
+ */
1395
+ updatedAt: string;
1396
+ /** @description Various online profiles associated with the user account */
1397
+ socials?: {
1398
+ /** @description The site of the social. */
1399
+ site: string;
1400
+ /**
1401
+ * Format: uri
1402
+ * @description The link of the social.
1403
+ */
1404
+ link: string;
1405
+ }[];
1406
+ /**
1407
+ * Format: date-time
1408
+ * @description Timestamp when the user record was soft-deleted (null if not deleted)
1409
+ */
1410
+ deletedAt: string | null;
1411
+ /**
1412
+ * @description List of global roles assigned to the user
1413
+ * @example [
1414
+ * "admin",
1415
+ * "meshmap"
1416
+ * ]
1417
+ */
1418
+ roleNames?: (
1419
+ | "admin"
1420
+ | "meshmap"
1421
+ | "curator"
1422
+ | "team admin"
1423
+ | "workspace admin"
1424
+ | "workspace manager"
1425
+ | "organization admin"
1426
+ | "user"
1427
+ )[];
1428
+ /** @description Teams the user belongs to with role information */
1429
+ teams?: {
1430
+ /** @description Team memberships for the user with their assigned roles. */
1431
+ teamsWithRoles?: { [key: string]: unknown }[];
1432
+ /** @description Total number of team memberships returned for the user. */
1433
+ totalCount?: number;
1434
+ };
1435
+ /** @description Organizations the user belongs to with role information */
1436
+ organizations?: {
1437
+ /** @description Organization memberships for the user with their assigned roles. */
1438
+ organizationsWithRoles?: { [key: string]: unknown }[];
1439
+ /** @description Total number of organization memberships returned for the user. */
1440
+ totalCount?: number;
1441
+ };
1442
+ };
1443
+ };
1444
+ };
1445
+ /** Invalid request body or request param */
1446
+ 400: {
1447
+ content: {
1448
+ "text/plain": string;
1449
+ };
1450
+ };
1451
+ /** Expired JWT token used or insufficient privilege */
1452
+ 401: {
1453
+ content: {
1454
+ "text/plain": string;
1455
+ };
1456
+ };
1457
+ /** Result not found */
1458
+ 404: {
1459
+ content: {
1460
+ "text/plain": string;
1461
+ };
1462
+ };
1463
+ /** Internal server error */
1464
+ 500: {
1465
+ content: {
1466
+ "text/plain": string;
1467
+ };
1468
+ };
1469
+ };
1470
+ };
1471
+ getUser: {
1472
+ responses: {
1473
+ /** Current user profile and role context */
1474
+ 200: {
1475
+ content: {
1476
+ "application/json": {
1477
+ /**
1478
+ * Format: uuid
1479
+ * @description Unique identifier for the user
1480
+ */
1481
+ id: string;
1482
+ /** @description User identifier (username or external ID) */
1483
+ userId: string;
1484
+ /**
1485
+ * @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
1486
+ * @example [
1487
+ * "local",
1488
+ * "github",
1489
+ * "google",
1490
+ * "twitter"
1491
+ * ]
1492
+ */
1493
+ provider: string;
1494
+ /**
1495
+ * Format: email
1496
+ * @description User's email address
1497
+ */
1498
+ email: string;
1499
+ /** @description User's first name */
1500
+ firstName: string;
1501
+ /** @description User's last name */
1502
+ lastName: string;
1503
+ /**
1504
+ * Format: uri
1505
+ * @description URL to user's avatar image
1506
+ */
1507
+ avatarUrl?: string;
1508
+ /**
1509
+ * @description User account status
1510
+ * @enum {string}
1511
+ */
1512
+ status: "active" | "inactive" | "pending" | "anonymous";
1513
+ /**
1514
+ * @description User's biography or description
1515
+ * @default
1516
+ */
1517
+ bio?: string;
1518
+ /** @description User's country information stored as JSONB */
1519
+ country?: { [key: string]: unknown };
1520
+ /** @description User's region information stored as JSONB */
1521
+ region?: { [key: string]: unknown };
1522
+ /** @description User preferences stored as JSONB */
1523
+ preferences?: {
1524
+ /** @description The mesh adapters of the preference. */
1525
+ meshAdapters?: { [key: string]: unknown }[];
1526
+ grafana?: {
1527
+ /** @description Grafana URL for the user configuration. */
1528
+ grafanaUrl?: string;
1529
+ /** @description Grafana API key for the user configuration. */
1530
+ grafanaApiKey?: string;
1531
+ /** @description Selected Grafana board configurations for the user. */
1532
+ selectedBoardsConfigs?: {
1533
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
1534
+ board?: { [key: string]: unknown };
1535
+ /** @description Panels selected for the Grafana board configuration. */
1536
+ panels?: { [key: string]: unknown }[];
1537
+ /** @description Template variables applied to the selected Grafana board configuration. */
1538
+ templateVars?: string[];
1539
+ }[];
1540
+ };
1541
+ prometheus?: {
1542
+ /** @description The prometheus URL of the prometheus. */
1543
+ prometheusUrl?: string;
1544
+ /** @description The selected prometheus boards configs of the prometheus. */
1545
+ selectedPrometheusBoardsConfigs?: {
1546
+ /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
1547
+ board?: { [key: string]: unknown };
1548
+ /** @description Panels selected for the Grafana board configuration. */
1549
+ panels?: { [key: string]: unknown }[];
1550
+ /** @description Template variables applied to the selected Grafana board configuration. */
1551
+ templateVars?: string[];
1552
+ }[];
1553
+ };
1554
+ loadTestPrefs?: {
1555
+ /** @description Concurrent requests */
1556
+ c?: number;
1557
+ /** @description Queries per second */
1558
+ qps?: number;
1559
+ /** @description Duration */
1560
+ t?: string;
1561
+ /** @description Load generator */
1562
+ gen?: string;
1563
+ };
1564
+ /** @description The anonymous usage stats of the preference. */
1565
+ anonymousUsageStats: boolean;
1566
+ /** @description The anonymous perf results of the preference. */
1567
+ anonymousPerfResults: boolean;
1568
+ /**
1569
+ * Format: date-time
1570
+ * @description Timestamp of when the resource was last updated.
1571
+ */
1572
+ updatedAt: string;
1573
+ /** @description The dashboard preferences of the preference. */
1574
+ dashboardPreferences: { [key: string]: unknown };
1575
+ /**
1576
+ * Format: uuid
1577
+ * @description ID of the associated selectedOrganization.
1578
+ */
1579
+ selectedOrganizationId: string;
1580
+ /** @description The selected workspace for organizations of the preference. */
1581
+ selectedWorkspaceForOrganizations: { [key: string]: string };
1582
+ /** @description The users extension preferences of the preference. */
1583
+ usersExtensionPreferences: { [key: string]: unknown };
1584
+ /** @description The remote provider preferences of the preference. */
1585
+ remoteProviderPreferences: { [key: string]: unknown };
1586
+ };
1587
+ /**
1588
+ * Format: date-time
1589
+ * @description Timestamp when user accepted terms and conditions
1590
+ */
1591
+ acceptedTermsAt?: string;
1592
+ /**
1593
+ * Format: date-time
1594
+ * @description Timestamp of user's first login
1595
+ */
1596
+ firstLoginTime?: string;
1597
+ /**
1598
+ * Format: date-time
1599
+ * @description Timestamp of user's most recent login
1600
+ */
1601
+ lastLoginTime: string;
1602
+ /**
1603
+ * Format: date-time
1604
+ * @description Timestamp when the user record was created
1605
+ */
1606
+ createdAt: string;
1607
+ /**
1608
+ * Format: date-time
1609
+ * @description Timestamp when the user record was last updated
1610
+ */
1611
+ updatedAt: string;
1612
+ /** @description Various online profiles associated with the user account */
1613
+ socials?: {
1614
+ /** @description The site of the social. */
1615
+ site: string;
1616
+ /**
1617
+ * Format: uri
1618
+ * @description The link of the social.
1619
+ */
1620
+ link: string;
1621
+ }[];
1622
+ /**
1623
+ * Format: date-time
1624
+ * @description Timestamp when the user record was soft-deleted (null if not deleted)
1625
+ */
1626
+ deletedAt: string | null;
1627
+ /**
1628
+ * @description List of global roles assigned to the user
1629
+ * @example [
1630
+ * "admin",
1631
+ * "meshmap"
1632
+ * ]
1633
+ */
1634
+ roleNames?: (
1635
+ | "admin"
1636
+ | "meshmap"
1637
+ | "curator"
1638
+ | "team admin"
1639
+ | "workspace admin"
1640
+ | "workspace manager"
1641
+ | "organization admin"
1642
+ | "user"
1643
+ )[];
1644
+ /** @description Teams the user belongs to with role information */
1645
+ teams?: {
1646
+ /** @description Team memberships for the user with their assigned roles. */
1647
+ teamsWithRoles?: { [key: string]: unknown }[];
1648
+ /** @description Total number of team memberships returned for the user. */
1649
+ totalCount?: number;
1650
+ };
1651
+ /** @description Organizations the user belongs to with role information */
1652
+ organizations?: {
1653
+ /** @description Organization memberships for the user with their assigned roles. */
1654
+ organizationsWithRoles?: { [key: string]: unknown }[];
1655
+ /** @description Total number of organization memberships returned for the user. */
1656
+ totalCount?: number;
1657
+ };
1658
+ };
1659
+ };
1660
+ };
1661
+ /** Expired JWT token used or insufficient privilege */
1662
+ 401: {
1663
+ content: {
1664
+ "text/plain": string;
1665
+ };
1666
+ };
1667
+ /** Internal server error */
1668
+ 500: {
1669
+ content: {
1670
+ "text/plain": string;
1671
+ };
1672
+ };
1673
+ };
1674
+ };
1675
+ }
1676
+
1677
+ export interface external {}