@meshery/schemas 1.3.9 → 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 +28 -28
- package/dist/cloudApi.d.ts +28 -28
- 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 +5559 -5053
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +6 -6
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +6 -6
- 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 +8 -8
- package/dist/mesheryApi.d.ts +8 -8
- 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,218 +4,356 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
7
|
+
"/api/identity/orgs": {
|
|
8
|
+
/** Returns organizations for the current user. */
|
|
9
|
+
get: operations["getOrgs"];
|
|
10
|
+
/** Creates a new organization. */
|
|
11
|
+
post: operations["createOrg"];
|
|
12
|
+
};
|
|
13
|
+
"/api/identity/orgs/by-domain": {
|
|
14
|
+
get: operations["getOrgByDomain"];
|
|
15
|
+
};
|
|
16
|
+
"/api/identity/orgs/{orgId}": {
|
|
17
|
+
/** Returns the organization in the single-item page wrapper currently emitted by meshery-cloud. */
|
|
18
|
+
get: operations["getOrg"];
|
|
19
|
+
/** Updates the organization. */
|
|
20
|
+
put: operations["updateOrg"];
|
|
21
|
+
/** Deletes the organization. */
|
|
22
|
+
delete: operations["deleteOrg"];
|
|
23
|
+
};
|
|
24
|
+
"/api/identity/orgs/{orgId}/preferences": {
|
|
25
|
+
/** Returns preferences for the specified organization. */
|
|
26
|
+
get: operations["getOrgPreferences"];
|
|
27
|
+
};
|
|
28
|
+
"/api/identity/orgs/{orgId}/teams/{teamId}": {
|
|
29
|
+
/** Adds a team to an organization. If request body contains action=delete, tombstones a team by setting its deletedAt timestamp. The team's organization mapping remains intact. */
|
|
30
|
+
post: operations["addTeamToOrg"];
|
|
31
|
+
};
|
|
32
|
+
"/api/identity/orgs/{orgId}/teams/{teamId}/remove": {
|
|
33
|
+
/** Removes (unassigns) a team from an organization. */
|
|
34
|
+
post: operations["removeTeamFromOrg"];
|
|
35
|
+
};
|
|
36
|
+
"/api/identity/orgs/{orgId}/users/{userId}": {
|
|
37
|
+
post: operations["addUserToOrg"];
|
|
38
|
+
delete: operations["deleteUserFromOrg"];
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface components {
|
|
43
|
+
schemas: {
|
|
44
|
+
/**
|
|
45
|
+
* Format: uuid
|
|
46
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
47
|
+
*/
|
|
48
|
+
UUID: string;
|
|
49
|
+
/** Format: date-time */
|
|
50
|
+
NullableTime: string;
|
|
51
|
+
/** Format: date-time */
|
|
52
|
+
Time: string;
|
|
53
|
+
Text: string;
|
|
54
|
+
MapObject: { [key: string]: string };
|
|
55
|
+
/** @description Optional action payload for POST on /api/identity/orgs/{orgId}/teams/{teamId}. */
|
|
56
|
+
OrgTeamActionPayload: {
|
|
57
|
+
/**
|
|
58
|
+
* @description Internal action to perform on the team resource.
|
|
59
|
+
* @enum {string}
|
|
60
|
+
*/
|
|
61
|
+
action?: "delete";
|
|
30
62
|
};
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
};
|
|
38
|
-
/** Get organization by domain */
|
|
39
|
-
get: operations["getOrgByDomain"];
|
|
40
|
-
put?: never;
|
|
41
|
-
post?: never;
|
|
42
|
-
delete?: never;
|
|
43
|
-
options?: never;
|
|
44
|
-
head?: never;
|
|
45
|
-
patch?: never;
|
|
46
|
-
trace?: never;
|
|
63
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
64
|
+
Location: {
|
|
65
|
+
/** @description SVG markup for the asset. */
|
|
66
|
+
svg: string;
|
|
67
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
68
|
+
location: string;
|
|
47
69
|
};
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
/**
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
70
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
71
|
+
Logo: {
|
|
72
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
73
|
+
desktopView: {
|
|
74
|
+
/** @description SVG markup for the asset. */
|
|
75
|
+
svg: string;
|
|
76
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
77
|
+
location: string;
|
|
78
|
+
};
|
|
79
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
80
|
+
mobileView: {
|
|
81
|
+
/** @description SVG markup for the asset. */
|
|
82
|
+
svg: string;
|
|
83
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
84
|
+
location: string;
|
|
85
|
+
};
|
|
86
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
87
|
+
darkDesktopView: {
|
|
88
|
+
/** @description SVG markup for the asset. */
|
|
89
|
+
svg: string;
|
|
90
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
91
|
+
location: string;
|
|
92
|
+
};
|
|
93
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
94
|
+
darkMobileView: {
|
|
95
|
+
/** @description SVG markup for the asset. */
|
|
96
|
+
svg: string;
|
|
97
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
98
|
+
location: string;
|
|
99
|
+
};
|
|
75
100
|
};
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
101
|
+
/** @description UI theme configured for an organization. */
|
|
102
|
+
Theme: {
|
|
103
|
+
/**
|
|
104
|
+
* Format: uuid
|
|
105
|
+
* @description Theme identifier.
|
|
106
|
+
*/
|
|
107
|
+
id: string;
|
|
108
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
109
|
+
logo: {
|
|
110
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
111
|
+
desktopView: {
|
|
112
|
+
/** @description SVG markup for the asset. */
|
|
113
|
+
svg: string;
|
|
114
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
115
|
+
location: string;
|
|
82
116
|
};
|
|
83
|
-
/**
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
post?: never;
|
|
90
|
-
delete?: never;
|
|
91
|
-
options?: never;
|
|
92
|
-
head?: never;
|
|
93
|
-
patch?: never;
|
|
94
|
-
trace?: never;
|
|
95
|
-
};
|
|
96
|
-
"/api/identity/orgs/{orgId}/teams/{teamId}": {
|
|
97
|
-
parameters: {
|
|
98
|
-
query?: never;
|
|
99
|
-
header?: never;
|
|
100
|
-
path?: never;
|
|
101
|
-
cookie?: never;
|
|
117
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
118
|
+
mobileView: {
|
|
119
|
+
/** @description SVG markup for the asset. */
|
|
120
|
+
svg: string;
|
|
121
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
122
|
+
location: string;
|
|
102
123
|
};
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
post: operations["addTeamToOrg"];
|
|
110
|
-
delete?: never;
|
|
111
|
-
options?: never;
|
|
112
|
-
head?: never;
|
|
113
|
-
patch?: never;
|
|
114
|
-
trace?: never;
|
|
115
|
-
};
|
|
116
|
-
"/api/identity/orgs/{orgId}/teams/{teamId}/remove": {
|
|
117
|
-
parameters: {
|
|
118
|
-
query?: never;
|
|
119
|
-
header?: never;
|
|
120
|
-
path?: never;
|
|
121
|
-
cookie?: never;
|
|
124
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
125
|
+
darkDesktopView: {
|
|
126
|
+
/** @description SVG markup for the asset. */
|
|
127
|
+
svg: string;
|
|
128
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
129
|
+
location: string;
|
|
122
130
|
};
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
post: operations["removeTeamFromOrg"];
|
|
130
|
-
delete?: never;
|
|
131
|
-
options?: never;
|
|
132
|
-
head?: never;
|
|
133
|
-
patch?: never;
|
|
134
|
-
trace?: never;
|
|
135
|
-
};
|
|
136
|
-
"/api/identity/orgs/{orgId}/users/{userId}": {
|
|
137
|
-
parameters: {
|
|
138
|
-
query?: never;
|
|
139
|
-
header?: never;
|
|
140
|
-
path?: never;
|
|
141
|
-
cookie?: never;
|
|
131
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
132
|
+
darkMobileView: {
|
|
133
|
+
/** @description SVG markup for the asset. */
|
|
134
|
+
svg: string;
|
|
135
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
136
|
+
location: string;
|
|
142
137
|
};
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
post: operations["addUserToOrg"];
|
|
147
|
-
/** Remove user from organization */
|
|
148
|
-
delete: operations["deleteUserFromOrg"];
|
|
149
|
-
options?: never;
|
|
150
|
-
head?: never;
|
|
151
|
-
patch?: never;
|
|
152
|
-
trace?: never;
|
|
138
|
+
};
|
|
139
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
140
|
+
vars?: { [key: string]: unknown };
|
|
153
141
|
};
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
142
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
143
|
+
DashboardPrefs: { [key: string]: unknown };
|
|
144
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
145
|
+
Links: {
|
|
146
|
+
/**
|
|
147
|
+
* Format: uri
|
|
148
|
+
* @description URL of the organization's Terms of Service page.
|
|
149
|
+
*/
|
|
150
|
+
termsOfService?: string;
|
|
151
|
+
/**
|
|
152
|
+
* Format: uri
|
|
153
|
+
* @description URL of the organization's Privacy Policy page.
|
|
154
|
+
*/
|
|
155
|
+
privacy?: string;
|
|
156
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
157
|
+
support?: { [key: string]: string };
|
|
158
|
+
};
|
|
159
|
+
/** @description Organization-level user experience preferences. */
|
|
160
|
+
Preferences: {
|
|
161
|
+
/** @description UI theme configured for an organization. */
|
|
162
|
+
theme: {
|
|
158
163
|
/**
|
|
159
164
|
* Format: uuid
|
|
160
|
-
* @description
|
|
165
|
+
* @description Theme identifier.
|
|
161
166
|
*/
|
|
162
|
-
|
|
163
|
-
/**
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
167
|
+
id: string;
|
|
168
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
169
|
+
logo: {
|
|
170
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
171
|
+
desktopView: {
|
|
172
|
+
/** @description SVG markup for the asset. */
|
|
173
|
+
svg: string;
|
|
174
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
175
|
+
location: string;
|
|
176
|
+
};
|
|
177
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
178
|
+
mobileView: {
|
|
179
|
+
/** @description SVG markup for the asset. */
|
|
180
|
+
svg: string;
|
|
181
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
182
|
+
location: string;
|
|
183
|
+
};
|
|
184
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
185
|
+
darkDesktopView: {
|
|
186
|
+
/** @description SVG markup for the asset. */
|
|
187
|
+
svg: string;
|
|
188
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
189
|
+
location: string;
|
|
190
|
+
};
|
|
191
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
192
|
+
darkMobileView: {
|
|
181
193
|
/** @description SVG markup for the asset. */
|
|
182
194
|
svg: string;
|
|
183
195
|
/** @description Named location of the asset (e.g. header, footer). */
|
|
184
196
|
location: string;
|
|
197
|
+
};
|
|
185
198
|
};
|
|
186
|
-
/** @description
|
|
187
|
-
|
|
199
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
200
|
+
vars?: { [key: string]: unknown };
|
|
201
|
+
};
|
|
202
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
203
|
+
dashboard: { [key: string]: unknown };
|
|
204
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
205
|
+
links?: {
|
|
206
|
+
/**
|
|
207
|
+
* Format: uri
|
|
208
|
+
* @description URL of the organization's Terms of Service page.
|
|
209
|
+
*/
|
|
210
|
+
termsOfService?: string;
|
|
211
|
+
/**
|
|
212
|
+
* Format: uri
|
|
213
|
+
* @description URL of the organization's Privacy Policy page.
|
|
214
|
+
*/
|
|
215
|
+
privacy?: string;
|
|
216
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
217
|
+
support?: { [key: string]: string };
|
|
218
|
+
};
|
|
219
|
+
/**
|
|
220
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
221
|
+
* @default true
|
|
222
|
+
*/
|
|
223
|
+
showAuthCarousel?: boolean;
|
|
224
|
+
};
|
|
225
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
226
|
+
OrgMetadata: {
|
|
227
|
+
/** @description Organization-level user experience preferences. */
|
|
228
|
+
preferences: {
|
|
229
|
+
/** @description UI theme configured for an organization. */
|
|
230
|
+
theme: {
|
|
231
|
+
/**
|
|
232
|
+
* Format: uuid
|
|
233
|
+
* @description Theme identifier.
|
|
234
|
+
*/
|
|
235
|
+
id: string;
|
|
236
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
237
|
+
logo: {
|
|
188
238
|
/** @description Image asset anchored to a named location within an organization theme. */
|
|
189
239
|
desktopView: {
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
240
|
+
/** @description SVG markup for the asset. */
|
|
241
|
+
svg: string;
|
|
242
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
243
|
+
location: string;
|
|
194
244
|
};
|
|
195
245
|
/** @description Image asset anchored to a named location within an organization theme. */
|
|
196
246
|
mobileView: {
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
247
|
+
/** @description SVG markup for the asset. */
|
|
248
|
+
svg: string;
|
|
249
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
250
|
+
location: string;
|
|
201
251
|
};
|
|
202
252
|
/** @description Image asset anchored to a named location within an organization theme. */
|
|
203
253
|
darkDesktopView: {
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
254
|
+
/** @description SVG markup for the asset. */
|
|
255
|
+
svg: string;
|
|
256
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
257
|
+
location: string;
|
|
208
258
|
};
|
|
209
259
|
/** @description Image asset anchored to a named location within an organization theme. */
|
|
210
260
|
darkMobileView: {
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
};
|
|
261
|
+
/** @description SVG markup for the asset. */
|
|
262
|
+
svg: string;
|
|
263
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
264
|
+
location: string;
|
|
265
|
+
};
|
|
266
|
+
};
|
|
267
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
268
|
+
vars?: { [key: string]: unknown };
|
|
216
269
|
};
|
|
217
|
-
/** @description
|
|
218
|
-
|
|
270
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
271
|
+
dashboard: { [key: string]: unknown };
|
|
272
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
273
|
+
links?: {
|
|
274
|
+
/**
|
|
275
|
+
* Format: uri
|
|
276
|
+
* @description URL of the organization's Terms of Service page.
|
|
277
|
+
*/
|
|
278
|
+
termsOfService?: string;
|
|
279
|
+
/**
|
|
280
|
+
* Format: uri
|
|
281
|
+
* @description URL of the organization's Privacy Policy page.
|
|
282
|
+
*/
|
|
283
|
+
privacy?: string;
|
|
284
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
285
|
+
support?: { [key: string]: string };
|
|
286
|
+
};
|
|
287
|
+
/**
|
|
288
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
289
|
+
* @default true
|
|
290
|
+
*/
|
|
291
|
+
showAuthCarousel?: boolean;
|
|
292
|
+
};
|
|
293
|
+
};
|
|
294
|
+
/** @description An organization in Meshery Cloud. Organizations are the top-level tenancy boundary and own teams, workspaces, environments, designs, and other resources. Learn more at https://docs.meshery.io/concepts/logical/organizations */
|
|
295
|
+
Organization: {
|
|
296
|
+
/**
|
|
297
|
+
* Format: uuid
|
|
298
|
+
* @description Organization ID.
|
|
299
|
+
*/
|
|
300
|
+
id: string;
|
|
301
|
+
/** @description Name of the organization. */
|
|
302
|
+
name: string;
|
|
303
|
+
/** @description Country of the organization. */
|
|
304
|
+
country: string;
|
|
305
|
+
/** @description Region of the organization. */
|
|
306
|
+
region: string;
|
|
307
|
+
/** @description Description of the organization. */
|
|
308
|
+
description: string;
|
|
309
|
+
/**
|
|
310
|
+
* Format: uuid
|
|
311
|
+
* @description Owner user ID of the organization.
|
|
312
|
+
*/
|
|
313
|
+
owner: string;
|
|
314
|
+
/** @description Free-form metadata associated with the organization, including preferences. */
|
|
315
|
+
metadata: { [key: string]: unknown };
|
|
316
|
+
/** @description Domain of the organization. */
|
|
317
|
+
domain?: string | null;
|
|
318
|
+
/**
|
|
319
|
+
* Format: date-time
|
|
320
|
+
* @description Timestamp when the organization was created.
|
|
321
|
+
*/
|
|
322
|
+
createdAt: string;
|
|
323
|
+
/**
|
|
324
|
+
* Format: date-time
|
|
325
|
+
* @description Timestamp when the organization was last updated.
|
|
326
|
+
*/
|
|
327
|
+
updatedAt: string;
|
|
328
|
+
/**
|
|
329
|
+
* Format: date-time
|
|
330
|
+
* @description Timestamp when the organization was soft-deleted. Null while the organization is active.
|
|
331
|
+
*/
|
|
332
|
+
deletedAt?: string;
|
|
333
|
+
};
|
|
334
|
+
/** @description Organization listing record used in list and get responses. */
|
|
335
|
+
AvailableOrganization: {
|
|
336
|
+
/**
|
|
337
|
+
* Format: uuid
|
|
338
|
+
* @description Organization ID.
|
|
339
|
+
*/
|
|
340
|
+
id?: string;
|
|
341
|
+
/** @description Name of the organization. */
|
|
342
|
+
name?: string;
|
|
343
|
+
/** @description Description of the organization. */
|
|
344
|
+
description?: string;
|
|
345
|
+
/** @description Country of the organization. */
|
|
346
|
+
country?: string;
|
|
347
|
+
/** @description Region of the organization. */
|
|
348
|
+
region?: string;
|
|
349
|
+
/** @description Display name of the organization owner. */
|
|
350
|
+
owner?: string;
|
|
351
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
352
|
+
metadata?: {
|
|
353
|
+
/** @description Organization-level user experience preferences. */
|
|
354
|
+
preferences: {
|
|
355
|
+
/** @description UI theme configured for an organization. */
|
|
356
|
+
theme: {
|
|
219
357
|
/**
|
|
220
358
|
* Format: uuid
|
|
221
359
|
* @description Theme identifier.
|
|
@@ -223,46 +361,42 @@ export interface components {
|
|
|
223
361
|
id: string;
|
|
224
362
|
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
225
363
|
logo: {
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
364
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
365
|
+
desktopView: {
|
|
366
|
+
/** @description SVG markup for the asset. */
|
|
367
|
+
svg: string;
|
|
368
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
369
|
+
location: string;
|
|
370
|
+
};
|
|
371
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
372
|
+
mobileView: {
|
|
373
|
+
/** @description SVG markup for the asset. */
|
|
374
|
+
svg: string;
|
|
375
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
376
|
+
location: string;
|
|
377
|
+
};
|
|
378
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
379
|
+
darkDesktopView: {
|
|
380
|
+
/** @description SVG markup for the asset. */
|
|
381
|
+
svg: string;
|
|
382
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
383
|
+
location: string;
|
|
384
|
+
};
|
|
385
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
386
|
+
darkMobileView: {
|
|
387
|
+
/** @description SVG markup for the asset. */
|
|
388
|
+
svg: string;
|
|
389
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
390
|
+
location: string;
|
|
391
|
+
};
|
|
254
392
|
};
|
|
255
393
|
/** @description Arbitrary theme variables keyed by name. */
|
|
256
|
-
vars?: {
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
[key: string]: unknown;
|
|
263
|
-
};
|
|
264
|
-
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
265
|
-
Links: {
|
|
394
|
+
vars?: { [key: string]: unknown };
|
|
395
|
+
};
|
|
396
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
397
|
+
dashboard: { [key: string]: unknown };
|
|
398
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
399
|
+
links?: {
|
|
266
400
|
/**
|
|
267
401
|
* Format: uri
|
|
268
402
|
* @description URL of the organization's Terms of Service page.
|
|
@@ -274,307 +408,632 @@ export interface components {
|
|
|
274
408
|
*/
|
|
275
409
|
privacy?: string;
|
|
276
410
|
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
277
|
-
support?: {
|
|
278
|
-
|
|
279
|
-
|
|
411
|
+
support?: { [key: string]: string };
|
|
412
|
+
};
|
|
413
|
+
/**
|
|
414
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
415
|
+
* @default true
|
|
416
|
+
*/
|
|
417
|
+
showAuthCarousel?: boolean;
|
|
280
418
|
};
|
|
281
|
-
|
|
282
|
-
|
|
419
|
+
};
|
|
420
|
+
/**
|
|
421
|
+
* Format: date-time
|
|
422
|
+
* @description Timestamp when the organization was created.
|
|
423
|
+
*/
|
|
424
|
+
createdAt?: string;
|
|
425
|
+
/**
|
|
426
|
+
* Format: date-time
|
|
427
|
+
* @description Timestamp when the organization was last updated.
|
|
428
|
+
*/
|
|
429
|
+
updatedAt?: string;
|
|
430
|
+
/**
|
|
431
|
+
* Format: date-time
|
|
432
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
433
|
+
*/
|
|
434
|
+
deletedAt?: string;
|
|
435
|
+
};
|
|
436
|
+
/** @description Paginated list of organizations. */
|
|
437
|
+
OrganizationsPage: {
|
|
438
|
+
/** @description Zero-based page index returned in this response. */
|
|
439
|
+
page?: number;
|
|
440
|
+
/** @description Maximum number of items returned on each page. */
|
|
441
|
+
pageSize?: number;
|
|
442
|
+
/** @description Total number of items across all pages. */
|
|
443
|
+
totalCount?: number;
|
|
444
|
+
/** @description Organizations in this page. */
|
|
445
|
+
organizations?: {
|
|
446
|
+
/**
|
|
447
|
+
* Format: uuid
|
|
448
|
+
* @description Organization ID.
|
|
449
|
+
*/
|
|
450
|
+
id?: string;
|
|
451
|
+
/** @description Name of the organization. */
|
|
452
|
+
name?: string;
|
|
453
|
+
/** @description Description of the organization. */
|
|
454
|
+
description?: string;
|
|
455
|
+
/** @description Country of the organization. */
|
|
456
|
+
country?: string;
|
|
457
|
+
/** @description Region of the organization. */
|
|
458
|
+
region?: string;
|
|
459
|
+
/** @description Display name of the organization owner. */
|
|
460
|
+
owner?: string;
|
|
461
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
462
|
+
metadata?: {
|
|
463
|
+
/** @description Organization-level user experience preferences. */
|
|
464
|
+
preferences: {
|
|
283
465
|
/** @description UI theme configured for an organization. */
|
|
284
466
|
theme: {
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
};
|
|
299
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
300
|
-
mobileView: {
|
|
301
|
-
/** @description SVG markup for the asset. */
|
|
302
|
-
svg: string;
|
|
303
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
304
|
-
location: string;
|
|
305
|
-
};
|
|
306
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
307
|
-
darkDesktopView: {
|
|
308
|
-
/** @description SVG markup for the asset. */
|
|
309
|
-
svg: string;
|
|
310
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
311
|
-
location: string;
|
|
312
|
-
};
|
|
313
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
314
|
-
darkMobileView: {
|
|
315
|
-
/** @description SVG markup for the asset. */
|
|
316
|
-
svg: string;
|
|
317
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
318
|
-
location: string;
|
|
319
|
-
};
|
|
467
|
+
/**
|
|
468
|
+
* Format: uuid
|
|
469
|
+
* @description Theme identifier.
|
|
470
|
+
*/
|
|
471
|
+
id: string;
|
|
472
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
473
|
+
logo: {
|
|
474
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
475
|
+
desktopView: {
|
|
476
|
+
/** @description SVG markup for the asset. */
|
|
477
|
+
svg: string;
|
|
478
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
479
|
+
location: string;
|
|
320
480
|
};
|
|
321
|
-
/** @description
|
|
322
|
-
|
|
323
|
-
|
|
481
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
482
|
+
mobileView: {
|
|
483
|
+
/** @description SVG markup for the asset. */
|
|
484
|
+
svg: string;
|
|
485
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
486
|
+
location: string;
|
|
487
|
+
};
|
|
488
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
489
|
+
darkDesktopView: {
|
|
490
|
+
/** @description SVG markup for the asset. */
|
|
491
|
+
svg: string;
|
|
492
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
493
|
+
location: string;
|
|
494
|
+
};
|
|
495
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
496
|
+
darkMobileView: {
|
|
497
|
+
/** @description SVG markup for the asset. */
|
|
498
|
+
svg: string;
|
|
499
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
500
|
+
location: string;
|
|
324
501
|
};
|
|
502
|
+
};
|
|
503
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
504
|
+
vars?: { [key: string]: unknown };
|
|
325
505
|
};
|
|
326
506
|
/** @description Preferences specific to dashboard behavior. */
|
|
327
|
-
dashboard: {
|
|
328
|
-
[key: string]: unknown;
|
|
329
|
-
};
|
|
507
|
+
dashboard: { [key: string]: unknown };
|
|
330
508
|
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
331
509
|
links?: {
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
[key: string]: string;
|
|
345
|
-
};
|
|
510
|
+
/**
|
|
511
|
+
* Format: uri
|
|
512
|
+
* @description URL of the organization's Terms of Service page.
|
|
513
|
+
*/
|
|
514
|
+
termsOfService?: string;
|
|
515
|
+
/**
|
|
516
|
+
* Format: uri
|
|
517
|
+
* @description URL of the organization's Privacy Policy page.
|
|
518
|
+
*/
|
|
519
|
+
privacy?: string;
|
|
520
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
521
|
+
support?: { [key: string]: string };
|
|
346
522
|
};
|
|
347
523
|
/**
|
|
348
524
|
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
349
525
|
* @default true
|
|
350
526
|
*/
|
|
351
|
-
showAuthCarousel
|
|
527
|
+
showAuthCarousel?: boolean;
|
|
528
|
+
};
|
|
352
529
|
};
|
|
530
|
+
/**
|
|
531
|
+
* Format: date-time
|
|
532
|
+
* @description Timestamp when the organization was created.
|
|
533
|
+
*/
|
|
534
|
+
createdAt?: string;
|
|
535
|
+
/**
|
|
536
|
+
* Format: date-time
|
|
537
|
+
* @description Timestamp when the organization was last updated.
|
|
538
|
+
*/
|
|
539
|
+
updatedAt?: string;
|
|
540
|
+
/**
|
|
541
|
+
* Format: date-time
|
|
542
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
543
|
+
*/
|
|
544
|
+
deletedAt?: string;
|
|
545
|
+
}[];
|
|
546
|
+
};
|
|
547
|
+
/** @description Single-organization wrapper used by current meshery-cloud organization handlers. */
|
|
548
|
+
OrganizationPage: {
|
|
549
|
+
/** @description Zero-based page index returned in this response. */
|
|
550
|
+
page?: number;
|
|
551
|
+
/** @description Maximum number of items returned on each page. */
|
|
552
|
+
pageSize?: number;
|
|
553
|
+
/** @description Total number of items across all pages. */
|
|
554
|
+
totalCount?: number;
|
|
555
|
+
/** @description Organizations returned in this single-item page wrapper. */
|
|
556
|
+
organizations?: {
|
|
557
|
+
/**
|
|
558
|
+
* Format: uuid
|
|
559
|
+
* @description Organization ID.
|
|
560
|
+
*/
|
|
561
|
+
id?: string;
|
|
562
|
+
/** @description Name of the organization. */
|
|
563
|
+
name?: string;
|
|
564
|
+
/** @description Description of the organization. */
|
|
565
|
+
description?: string;
|
|
566
|
+
/** @description Country of the organization. */
|
|
567
|
+
country?: string;
|
|
568
|
+
/** @description Region of the organization. */
|
|
569
|
+
region?: string;
|
|
570
|
+
/** @description Display name of the organization owner. */
|
|
571
|
+
owner?: string;
|
|
353
572
|
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
};
|
|
373
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
374
|
-
mobileView: {
|
|
375
|
-
/** @description SVG markup for the asset. */
|
|
376
|
-
svg: string;
|
|
377
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
378
|
-
location: string;
|
|
379
|
-
};
|
|
380
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
381
|
-
darkDesktopView: {
|
|
382
|
-
/** @description SVG markup for the asset. */
|
|
383
|
-
svg: string;
|
|
384
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
385
|
-
location: string;
|
|
386
|
-
};
|
|
387
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
388
|
-
darkMobileView: {
|
|
389
|
-
/** @description SVG markup for the asset. */
|
|
390
|
-
svg: string;
|
|
391
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
392
|
-
location: string;
|
|
393
|
-
};
|
|
394
|
-
};
|
|
395
|
-
/** @description Arbitrary theme variables keyed by name. */
|
|
396
|
-
vars?: {
|
|
397
|
-
[key: string]: unknown;
|
|
398
|
-
};
|
|
573
|
+
metadata?: {
|
|
574
|
+
/** @description Organization-level user experience preferences. */
|
|
575
|
+
preferences: {
|
|
576
|
+
/** @description UI theme configured for an organization. */
|
|
577
|
+
theme: {
|
|
578
|
+
/**
|
|
579
|
+
* Format: uuid
|
|
580
|
+
* @description Theme identifier.
|
|
581
|
+
*/
|
|
582
|
+
id: string;
|
|
583
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
584
|
+
logo: {
|
|
585
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
586
|
+
desktopView: {
|
|
587
|
+
/** @description SVG markup for the asset. */
|
|
588
|
+
svg: string;
|
|
589
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
590
|
+
location: string;
|
|
399
591
|
};
|
|
400
|
-
/** @description
|
|
401
|
-
|
|
402
|
-
|
|
592
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
593
|
+
mobileView: {
|
|
594
|
+
/** @description SVG markup for the asset. */
|
|
595
|
+
svg: string;
|
|
596
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
597
|
+
location: string;
|
|
403
598
|
};
|
|
404
|
-
/** @description
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
termsOfService?: string;
|
|
411
|
-
/**
|
|
412
|
-
* Format: uri
|
|
413
|
-
* @description URL of the organization's Privacy Policy page.
|
|
414
|
-
*/
|
|
415
|
-
privacy?: string;
|
|
416
|
-
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
417
|
-
support?: {
|
|
418
|
-
[key: string]: string;
|
|
419
|
-
};
|
|
599
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
600
|
+
darkDesktopView: {
|
|
601
|
+
/** @description SVG markup for the asset. */
|
|
602
|
+
svg: string;
|
|
603
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
604
|
+
location: string;
|
|
420
605
|
};
|
|
421
|
-
/**
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
606
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
607
|
+
darkMobileView: {
|
|
608
|
+
/** @description SVG markup for the asset. */
|
|
609
|
+
svg: string;
|
|
610
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
611
|
+
location: string;
|
|
612
|
+
};
|
|
613
|
+
};
|
|
614
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
615
|
+
vars?: { [key: string]: unknown };
|
|
616
|
+
};
|
|
617
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
618
|
+
dashboard: { [key: string]: unknown };
|
|
619
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
620
|
+
links?: {
|
|
621
|
+
/**
|
|
622
|
+
* Format: uri
|
|
623
|
+
* @description URL of the organization's Terms of Service page.
|
|
624
|
+
*/
|
|
625
|
+
termsOfService?: string;
|
|
626
|
+
/**
|
|
627
|
+
* Format: uri
|
|
628
|
+
* @description URL of the organization's Privacy Policy page.
|
|
629
|
+
*/
|
|
630
|
+
privacy?: string;
|
|
631
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
632
|
+
support?: { [key: string]: string };
|
|
426
633
|
};
|
|
427
|
-
};
|
|
428
|
-
/** @description An organization in Meshery Cloud. Organizations are the top-level tenancy boundary and own teams, workspaces, environments, designs, and other resources. Learn more at https://docs.meshery.io/concepts/logical/organizations */
|
|
429
|
-
Organization: {
|
|
430
634
|
/**
|
|
431
|
-
*
|
|
432
|
-
* @
|
|
635
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
636
|
+
* @default true
|
|
433
637
|
*/
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
name: string;
|
|
437
|
-
/** @description Country of the organization. */
|
|
438
|
-
country: string;
|
|
439
|
-
/** @description Region of the organization. */
|
|
440
|
-
region: string;
|
|
441
|
-
/** @description Description of the organization. */
|
|
442
|
-
description: string;
|
|
443
|
-
/**
|
|
444
|
-
* Format: uuid
|
|
445
|
-
* @description Owner user ID of the organization.
|
|
446
|
-
*/
|
|
447
|
-
owner: string;
|
|
448
|
-
/** @description Free-form metadata associated with the organization, including preferences. */
|
|
449
|
-
metadata: Record<string, never>;
|
|
450
|
-
/** @description Domain of the organization. */
|
|
451
|
-
domain?: string | null;
|
|
452
|
-
/**
|
|
453
|
-
* Format: date-time
|
|
454
|
-
* @description Timestamp when the organization was created.
|
|
455
|
-
*/
|
|
456
|
-
createdAt: string;
|
|
457
|
-
/**
|
|
458
|
-
* Format: date-time
|
|
459
|
-
* @description Timestamp when the organization was last updated.
|
|
460
|
-
*/
|
|
461
|
-
updatedAt: string;
|
|
462
|
-
/**
|
|
463
|
-
* Format: date-time
|
|
464
|
-
* @description Timestamp when the organization was soft-deleted. Null while the organization is active.
|
|
465
|
-
*/
|
|
466
|
-
deletedAt?: string;
|
|
638
|
+
showAuthCarousel?: boolean;
|
|
639
|
+
};
|
|
467
640
|
};
|
|
468
|
-
/**
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
641
|
+
/**
|
|
642
|
+
* Format: date-time
|
|
643
|
+
* @description Timestamp when the organization was created.
|
|
644
|
+
*/
|
|
645
|
+
createdAt?: string;
|
|
646
|
+
/**
|
|
647
|
+
* Format: date-time
|
|
648
|
+
* @description Timestamp when the organization was last updated.
|
|
649
|
+
*/
|
|
650
|
+
updatedAt?: string;
|
|
651
|
+
/**
|
|
652
|
+
* Format: date-time
|
|
653
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
654
|
+
*/
|
|
655
|
+
deletedAt?: string;
|
|
656
|
+
}[];
|
|
657
|
+
};
|
|
658
|
+
/** @description Payload for creating or updating an organization. Contains only client-settable fields. */
|
|
659
|
+
OrganizationPayload: {
|
|
660
|
+
/** @description Name of the organization. */
|
|
661
|
+
name?: string;
|
|
662
|
+
/** @description Country of the organization. */
|
|
663
|
+
country?: string;
|
|
664
|
+
/** @description Region of the organization. */
|
|
665
|
+
region?: string;
|
|
666
|
+
/** @description Description of the organization. */
|
|
667
|
+
description?: string;
|
|
668
|
+
/** @description Indicates whether organization members should be notified of this update. */
|
|
669
|
+
notifyOrgUpdate?: boolean;
|
|
670
|
+
/** @description Organization-level user experience preferences. */
|
|
671
|
+
preferences?: {
|
|
672
|
+
/** @description UI theme configured for an organization. */
|
|
673
|
+
theme: {
|
|
674
|
+
/**
|
|
675
|
+
* Format: uuid
|
|
676
|
+
* @description Theme identifier.
|
|
677
|
+
*/
|
|
678
|
+
id: string;
|
|
679
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
680
|
+
logo: {
|
|
681
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
682
|
+
desktopView: {
|
|
683
|
+
/** @description SVG markup for the asset. */
|
|
684
|
+
svg: string;
|
|
685
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
686
|
+
location: string;
|
|
687
|
+
};
|
|
688
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
689
|
+
mobileView: {
|
|
690
|
+
/** @description SVG markup for the asset. */
|
|
691
|
+
svg: string;
|
|
692
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
693
|
+
location: string;
|
|
694
|
+
};
|
|
695
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
696
|
+
darkDesktopView: {
|
|
697
|
+
/** @description SVG markup for the asset. */
|
|
698
|
+
svg: string;
|
|
699
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
700
|
+
location: string;
|
|
701
|
+
};
|
|
702
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
703
|
+
darkMobileView: {
|
|
704
|
+
/** @description SVG markup for the asset. */
|
|
705
|
+
svg: string;
|
|
706
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
707
|
+
location: string;
|
|
708
|
+
};
|
|
709
|
+
};
|
|
710
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
711
|
+
vars?: { [key: string]: unknown };
|
|
712
|
+
};
|
|
713
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
714
|
+
dashboard: { [key: string]: unknown };
|
|
715
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
716
|
+
links?: {
|
|
717
|
+
/**
|
|
718
|
+
* Format: uri
|
|
719
|
+
* @description URL of the organization's Terms of Service page.
|
|
720
|
+
*/
|
|
721
|
+
termsOfService?: string;
|
|
722
|
+
/**
|
|
723
|
+
* Format: uri
|
|
724
|
+
* @description URL of the organization's Privacy Policy page.
|
|
725
|
+
*/
|
|
726
|
+
privacy?: string;
|
|
727
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
728
|
+
support?: { [key: string]: string };
|
|
729
|
+
};
|
|
730
|
+
/**
|
|
731
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
732
|
+
* @default true
|
|
733
|
+
*/
|
|
734
|
+
showAuthCarousel?: boolean;
|
|
735
|
+
};
|
|
736
|
+
};
|
|
737
|
+
/** @description Team listing record used in team listings associated with an organization. */
|
|
738
|
+
AvailableTeam: {
|
|
739
|
+
/**
|
|
740
|
+
* Format: uuid
|
|
741
|
+
* @description Team ID.
|
|
742
|
+
*/
|
|
743
|
+
id?: string;
|
|
744
|
+
/** @description Name of the team. */
|
|
745
|
+
name?: string;
|
|
746
|
+
/** @description Description of the team. */
|
|
747
|
+
description?: string;
|
|
748
|
+
/** @description Display name of the team owner. */
|
|
749
|
+
owner?: string;
|
|
750
|
+
/** @description Free-form team metadata. */
|
|
751
|
+
metadata?: { [key: string]: string };
|
|
752
|
+
/**
|
|
753
|
+
* Format: date-time
|
|
754
|
+
* @description Timestamp when the team was created.
|
|
755
|
+
*/
|
|
756
|
+
createdAt?: string;
|
|
757
|
+
/**
|
|
758
|
+
* Format: date-time
|
|
759
|
+
* @description Timestamp when the team was last updated.
|
|
760
|
+
*/
|
|
761
|
+
updatedAt?: string;
|
|
762
|
+
/**
|
|
763
|
+
* Format: date-time
|
|
764
|
+
* @description Timestamp when the team was soft-deleted.
|
|
765
|
+
*/
|
|
766
|
+
deletedAt?: string;
|
|
767
|
+
};
|
|
768
|
+
/** @description Paginated list of teams. */
|
|
769
|
+
TeamsPage: {
|
|
770
|
+
/** @description Zero-based page index returned in this response. */
|
|
771
|
+
page?: number;
|
|
772
|
+
/** @description Maximum number of items returned on each page. */
|
|
773
|
+
pageSize?: number;
|
|
774
|
+
/** @description Total number of items across all pages. */
|
|
775
|
+
totalCount?: number;
|
|
776
|
+
/** @description Teams in this page. */
|
|
777
|
+
teams?: {
|
|
778
|
+
/**
|
|
779
|
+
* Format: uuid
|
|
780
|
+
* @description Team ID.
|
|
781
|
+
*/
|
|
782
|
+
id?: string;
|
|
783
|
+
/** @description Name of the team. */
|
|
784
|
+
name?: string;
|
|
785
|
+
/** @description Description of the team. */
|
|
786
|
+
description?: string;
|
|
787
|
+
/** @description Display name of the team owner. */
|
|
788
|
+
owner?: string;
|
|
789
|
+
/** @description Free-form team metadata. */
|
|
790
|
+
metadata?: { [key: string]: string };
|
|
791
|
+
/**
|
|
792
|
+
* Format: date-time
|
|
793
|
+
* @description Timestamp when the team was created.
|
|
794
|
+
*/
|
|
795
|
+
createdAt?: string;
|
|
796
|
+
/**
|
|
797
|
+
* Format: date-time
|
|
798
|
+
* @description Timestamp when the team was last updated.
|
|
799
|
+
*/
|
|
800
|
+
updatedAt?: string;
|
|
801
|
+
/**
|
|
802
|
+
* Format: date-time
|
|
803
|
+
* @description Timestamp when the team was soft-deleted.
|
|
804
|
+
*/
|
|
805
|
+
deletedAt?: string;
|
|
806
|
+
}[];
|
|
807
|
+
};
|
|
808
|
+
/** @description Junction record linking a team to an organization. */
|
|
809
|
+
TeamsOrganizationsMapping: {
|
|
810
|
+
/**
|
|
811
|
+
* Format: uuid
|
|
812
|
+
* @description Mapping record ID.
|
|
813
|
+
*/
|
|
814
|
+
id?: string;
|
|
815
|
+
/**
|
|
816
|
+
* Format: uuid
|
|
817
|
+
* @description Organization ID for this mapping.
|
|
818
|
+
*/
|
|
819
|
+
orgId?: string;
|
|
820
|
+
/**
|
|
821
|
+
* Format: uuid
|
|
822
|
+
* @description Team ID for this mapping.
|
|
823
|
+
*/
|
|
824
|
+
teamId?: string;
|
|
825
|
+
/**
|
|
826
|
+
* Format: date-time
|
|
827
|
+
* @description Timestamp when the mapping was created.
|
|
828
|
+
*/
|
|
829
|
+
createdAt?: string;
|
|
830
|
+
/**
|
|
831
|
+
* Format: date-time
|
|
832
|
+
* @description Timestamp when the mapping was last updated.
|
|
833
|
+
*/
|
|
834
|
+
updatedAt?: string;
|
|
835
|
+
/**
|
|
836
|
+
* Format: date-time
|
|
837
|
+
* @description Timestamp when the mapping was soft-deleted.
|
|
838
|
+
*/
|
|
839
|
+
deletedAt?: string;
|
|
840
|
+
};
|
|
841
|
+
/** @description Paginated list of team-organization mappings. */
|
|
842
|
+
TeamsOrganizationsMappingPage: {
|
|
843
|
+
/** @description Zero-based page index returned in this response. */
|
|
844
|
+
page?: number;
|
|
845
|
+
/** @description Maximum number of items returned on each page. */
|
|
846
|
+
pageSize?: number;
|
|
847
|
+
/** @description Total number of items across all pages. */
|
|
848
|
+
totalCount?: number;
|
|
849
|
+
/** @description Team-organization mapping entries. */
|
|
850
|
+
teamsOrganizationsMapping?: {
|
|
851
|
+
/**
|
|
852
|
+
* Format: uuid
|
|
853
|
+
* @description Mapping record ID.
|
|
854
|
+
*/
|
|
855
|
+
id?: string;
|
|
856
|
+
/**
|
|
857
|
+
* Format: uuid
|
|
858
|
+
* @description Organization ID for this mapping.
|
|
859
|
+
*/
|
|
860
|
+
orgId?: string;
|
|
861
|
+
/**
|
|
862
|
+
* Format: uuid
|
|
863
|
+
* @description Team ID for this mapping.
|
|
864
|
+
*/
|
|
865
|
+
teamId?: string;
|
|
866
|
+
/**
|
|
867
|
+
* Format: date-time
|
|
868
|
+
* @description Timestamp when the mapping was created.
|
|
869
|
+
*/
|
|
870
|
+
createdAt?: string;
|
|
871
|
+
/**
|
|
872
|
+
* Format: date-time
|
|
873
|
+
* @description Timestamp when the mapping was last updated.
|
|
874
|
+
*/
|
|
875
|
+
updatedAt?: string;
|
|
876
|
+
/**
|
|
877
|
+
* Format: date-time
|
|
878
|
+
* @description Timestamp when the mapping was soft-deleted.
|
|
879
|
+
*/
|
|
880
|
+
deletedAt?: string;
|
|
881
|
+
}[];
|
|
882
|
+
};
|
|
883
|
+
};
|
|
884
|
+
responses: {
|
|
885
|
+
/** Invalid request body or request param */
|
|
886
|
+
400: {
|
|
887
|
+
content: {
|
|
888
|
+
"text/plain": string;
|
|
889
|
+
};
|
|
890
|
+
};
|
|
891
|
+
/** Expired JWT token used or insufficient privilege */
|
|
892
|
+
401: {
|
|
893
|
+
content: {
|
|
894
|
+
"text/plain": string;
|
|
895
|
+
};
|
|
896
|
+
};
|
|
897
|
+
/** Result not found */
|
|
898
|
+
404: {
|
|
899
|
+
content: {
|
|
900
|
+
"text/plain": string;
|
|
901
|
+
};
|
|
902
|
+
};
|
|
903
|
+
/** Internal server error */
|
|
904
|
+
500: {
|
|
905
|
+
content: {
|
|
906
|
+
"text/plain": string;
|
|
907
|
+
};
|
|
908
|
+
};
|
|
909
|
+
};
|
|
910
|
+
parameters: {
|
|
911
|
+
/** @description Organization ID. */
|
|
912
|
+
orgId: string;
|
|
913
|
+
/** @description User ID. */
|
|
914
|
+
userId: string;
|
|
915
|
+
/** @description Team ID. */
|
|
916
|
+
teamId: string;
|
|
917
|
+
/** @description Zero-based index of the result page to return. */
|
|
918
|
+
page: number;
|
|
919
|
+
/** @description Maximum number of items returned on each page. */
|
|
920
|
+
pageSize: number;
|
|
921
|
+
/** @description Get responses that match search param value */
|
|
922
|
+
search: string;
|
|
923
|
+
/** @description Get ordered responses */
|
|
924
|
+
order: string;
|
|
925
|
+
/** @description Get all possible entries */
|
|
926
|
+
all: boolean;
|
|
927
|
+
};
|
|
928
|
+
requestBodies: {
|
|
929
|
+
/** Body for creating or updating an organization */
|
|
930
|
+
organizationPayload: {
|
|
931
|
+
content: {
|
|
932
|
+
"application/json": {
|
|
933
|
+
/** @description Name of the organization. */
|
|
934
|
+
name?: string;
|
|
935
|
+
/** @description Country of the organization. */
|
|
936
|
+
country?: string;
|
|
937
|
+
/** @description Region of the organization. */
|
|
938
|
+
region?: string;
|
|
939
|
+
/** @description Description of the organization. */
|
|
940
|
+
description?: string;
|
|
941
|
+
/** @description Indicates whether organization members should be notified of this update. */
|
|
942
|
+
notifyOrgUpdate?: boolean;
|
|
943
|
+
/** @description Organization-level user experience preferences. */
|
|
944
|
+
preferences?: {
|
|
945
|
+
/** @description UI theme configured for an organization. */
|
|
946
|
+
theme: {
|
|
947
|
+
/**
|
|
948
|
+
* Format: uuid
|
|
949
|
+
* @description Theme identifier.
|
|
950
|
+
*/
|
|
951
|
+
id: string;
|
|
952
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
953
|
+
logo: {
|
|
954
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
955
|
+
desktopView: {
|
|
956
|
+
/** @description SVG markup for the asset. */
|
|
957
|
+
svg: string;
|
|
958
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
959
|
+
location: string;
|
|
960
|
+
};
|
|
961
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
962
|
+
mobileView: {
|
|
963
|
+
/** @description SVG markup for the asset. */
|
|
964
|
+
svg: string;
|
|
965
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
966
|
+
location: string;
|
|
967
|
+
};
|
|
968
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
969
|
+
darkDesktopView: {
|
|
970
|
+
/** @description SVG markup for the asset. */
|
|
971
|
+
svg: string;
|
|
972
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
973
|
+
location: string;
|
|
974
|
+
};
|
|
975
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
976
|
+
darkMobileView: {
|
|
977
|
+
/** @description SVG markup for the asset. */
|
|
978
|
+
svg: string;
|
|
979
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
980
|
+
location: string;
|
|
558
981
|
};
|
|
982
|
+
};
|
|
983
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
984
|
+
vars?: { [key: string]: unknown };
|
|
985
|
+
};
|
|
986
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
987
|
+
dashboard: { [key: string]: unknown };
|
|
988
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
989
|
+
links?: {
|
|
990
|
+
/**
|
|
991
|
+
* Format: uri
|
|
992
|
+
* @description URL of the organization's Terms of Service page.
|
|
993
|
+
*/
|
|
994
|
+
termsOfService?: string;
|
|
995
|
+
/**
|
|
996
|
+
* Format: uri
|
|
997
|
+
* @description URL of the organization's Privacy Policy page.
|
|
998
|
+
*/
|
|
999
|
+
privacy?: string;
|
|
1000
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
1001
|
+
support?: { [key: string]: string };
|
|
559
1002
|
};
|
|
560
1003
|
/**
|
|
561
|
-
*
|
|
562
|
-
* @
|
|
563
|
-
*/
|
|
564
|
-
createdAt?: string;
|
|
565
|
-
/**
|
|
566
|
-
* Format: date-time
|
|
567
|
-
* @description Timestamp when the organization was last updated.
|
|
568
|
-
*/
|
|
569
|
-
updatedAt?: string;
|
|
570
|
-
/**
|
|
571
|
-
* Format: date-time
|
|
572
|
-
* @description Timestamp when the organization was soft-deleted.
|
|
1004
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1005
|
+
* @default true
|
|
573
1006
|
*/
|
|
574
|
-
|
|
1007
|
+
showAuthCarousel?: boolean;
|
|
1008
|
+
};
|
|
575
1009
|
};
|
|
576
|
-
|
|
577
|
-
|
|
1010
|
+
};
|
|
1011
|
+
};
|
|
1012
|
+
};
|
|
1013
|
+
}
|
|
1014
|
+
|
|
1015
|
+
export interface operations {
|
|
1016
|
+
/** Returns organizations for the current user. */
|
|
1017
|
+
getOrgs: {
|
|
1018
|
+
parameters: {
|
|
1019
|
+
query: {
|
|
1020
|
+
/** Zero-based index of the result page to return. */
|
|
1021
|
+
page?: number;
|
|
1022
|
+
/** Maximum number of items returned on each page. */
|
|
1023
|
+
pageSize?: number;
|
|
1024
|
+
/** Get responses that match search param value */
|
|
1025
|
+
search?: string;
|
|
1026
|
+
/** Get ordered responses */
|
|
1027
|
+
order?: string;
|
|
1028
|
+
/** Get all possible entries */
|
|
1029
|
+
all?: boolean;
|
|
1030
|
+
};
|
|
1031
|
+
};
|
|
1032
|
+
responses: {
|
|
1033
|
+
/** Organizations response */
|
|
1034
|
+
200: {
|
|
1035
|
+
content: {
|
|
1036
|
+
"application/json": {
|
|
578
1037
|
/** @description Zero-based page index returned in this response. */
|
|
579
1038
|
page?: number;
|
|
580
1039
|
/** @description Maximum number of items returned on each page. */
|
|
@@ -583,115 +1042,132 @@ export interface components {
|
|
|
583
1042
|
totalCount?: number;
|
|
584
1043
|
/** @description Organizations in this page. */
|
|
585
1044
|
organizations?: {
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
};
|
|
643
|
-
/** @description Arbitrary theme variables keyed by name. */
|
|
644
|
-
vars?: {
|
|
645
|
-
[key: string]: unknown;
|
|
646
|
-
};
|
|
647
|
-
};
|
|
648
|
-
/** @description Preferences specific to dashboard behavior. */
|
|
649
|
-
dashboard: {
|
|
650
|
-
[key: string]: unknown;
|
|
651
|
-
};
|
|
652
|
-
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
653
|
-
links?: {
|
|
654
|
-
/**
|
|
655
|
-
* Format: uri
|
|
656
|
-
* @description URL of the organization's Terms of Service page.
|
|
657
|
-
*/
|
|
658
|
-
termsOfService?: string;
|
|
659
|
-
/**
|
|
660
|
-
* Format: uri
|
|
661
|
-
* @description URL of the organization's Privacy Policy page.
|
|
662
|
-
*/
|
|
663
|
-
privacy?: string;
|
|
664
|
-
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
665
|
-
support?: {
|
|
666
|
-
[key: string]: string;
|
|
667
|
-
};
|
|
668
|
-
};
|
|
669
|
-
/**
|
|
670
|
-
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
671
|
-
* @default true
|
|
672
|
-
*/
|
|
673
|
-
showAuthCarousel: boolean;
|
|
1045
|
+
/**
|
|
1046
|
+
* Format: uuid
|
|
1047
|
+
* @description Organization ID.
|
|
1048
|
+
*/
|
|
1049
|
+
id?: string;
|
|
1050
|
+
/** @description Name of the organization. */
|
|
1051
|
+
name?: string;
|
|
1052
|
+
/** @description Description of the organization. */
|
|
1053
|
+
description?: string;
|
|
1054
|
+
/** @description Country of the organization. */
|
|
1055
|
+
country?: string;
|
|
1056
|
+
/** @description Region of the organization. */
|
|
1057
|
+
region?: string;
|
|
1058
|
+
/** @description Display name of the organization owner. */
|
|
1059
|
+
owner?: string;
|
|
1060
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1061
|
+
metadata?: {
|
|
1062
|
+
/** @description Organization-level user experience preferences. */
|
|
1063
|
+
preferences: {
|
|
1064
|
+
/** @description UI theme configured for an organization. */
|
|
1065
|
+
theme: {
|
|
1066
|
+
/**
|
|
1067
|
+
* Format: uuid
|
|
1068
|
+
* @description Theme identifier.
|
|
1069
|
+
*/
|
|
1070
|
+
id: string;
|
|
1071
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1072
|
+
logo: {
|
|
1073
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1074
|
+
desktopView: {
|
|
1075
|
+
/** @description SVG markup for the asset. */
|
|
1076
|
+
svg: string;
|
|
1077
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1078
|
+
location: string;
|
|
1079
|
+
};
|
|
1080
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1081
|
+
mobileView: {
|
|
1082
|
+
/** @description SVG markup for the asset. */
|
|
1083
|
+
svg: string;
|
|
1084
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1085
|
+
location: string;
|
|
1086
|
+
};
|
|
1087
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1088
|
+
darkDesktopView: {
|
|
1089
|
+
/** @description SVG markup for the asset. */
|
|
1090
|
+
svg: string;
|
|
1091
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1092
|
+
location: string;
|
|
1093
|
+
};
|
|
1094
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1095
|
+
darkMobileView: {
|
|
1096
|
+
/** @description SVG markup for the asset. */
|
|
1097
|
+
svg: string;
|
|
1098
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1099
|
+
location: string;
|
|
1100
|
+
};
|
|
674
1101
|
};
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
1102
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1103
|
+
vars?: { [key: string]: unknown };
|
|
1104
|
+
};
|
|
1105
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1106
|
+
dashboard: { [key: string]: unknown };
|
|
1107
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
1108
|
+
links?: {
|
|
1109
|
+
/**
|
|
1110
|
+
* Format: uri
|
|
1111
|
+
* @description URL of the organization's Terms of Service page.
|
|
1112
|
+
*/
|
|
1113
|
+
termsOfService?: string;
|
|
1114
|
+
/**
|
|
1115
|
+
* Format: uri
|
|
1116
|
+
* @description URL of the organization's Privacy Policy page.
|
|
1117
|
+
*/
|
|
1118
|
+
privacy?: string;
|
|
1119
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
1120
|
+
support?: { [key: string]: string };
|
|
1121
|
+
};
|
|
1122
|
+
/**
|
|
1123
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1124
|
+
* @default true
|
|
1125
|
+
*/
|
|
1126
|
+
showAuthCarousel?: boolean;
|
|
1127
|
+
};
|
|
1128
|
+
};
|
|
1129
|
+
/**
|
|
1130
|
+
* Format: date-time
|
|
1131
|
+
* @description Timestamp when the organization was created.
|
|
1132
|
+
*/
|
|
1133
|
+
createdAt?: string;
|
|
1134
|
+
/**
|
|
1135
|
+
* Format: date-time
|
|
1136
|
+
* @description Timestamp when the organization was last updated.
|
|
1137
|
+
*/
|
|
1138
|
+
updatedAt?: string;
|
|
1139
|
+
/**
|
|
1140
|
+
* Format: date-time
|
|
1141
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
1142
|
+
*/
|
|
1143
|
+
deletedAt?: string;
|
|
691
1144
|
}[];
|
|
1145
|
+
};
|
|
1146
|
+
};
|
|
1147
|
+
};
|
|
1148
|
+
/** No content */
|
|
1149
|
+
204: never;
|
|
1150
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1151
|
+
401: {
|
|
1152
|
+
content: {
|
|
1153
|
+
"text/plain": string;
|
|
1154
|
+
};
|
|
1155
|
+
};
|
|
1156
|
+
/** Internal server error */
|
|
1157
|
+
500: {
|
|
1158
|
+
content: {
|
|
1159
|
+
"text/plain": string;
|
|
692
1160
|
};
|
|
693
|
-
|
|
694
|
-
|
|
1161
|
+
};
|
|
1162
|
+
};
|
|
1163
|
+
};
|
|
1164
|
+
/** Creates a new organization. */
|
|
1165
|
+
createOrg: {
|
|
1166
|
+
responses: {
|
|
1167
|
+
/** Single-organization page response */
|
|
1168
|
+
201: {
|
|
1169
|
+
content: {
|
|
1170
|
+
"application/json": {
|
|
695
1171
|
/** @description Zero-based page index returned in this response. */
|
|
696
1172
|
page?: number;
|
|
697
1173
|
/** @description Maximum number of items returned on each page. */
|
|
@@ -700,129 +1176,27 @@ export interface components {
|
|
|
700
1176
|
totalCount?: number;
|
|
701
1177
|
/** @description Organizations returned in this single-item page wrapper. */
|
|
702
1178
|
organizations?: {
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
/**
|
|
725
|
-
* Format: uuid
|
|
726
|
-
* @description Theme identifier.
|
|
727
|
-
*/
|
|
728
|
-
id: string;
|
|
729
|
-
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
730
|
-
logo: {
|
|
731
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
732
|
-
desktopView: {
|
|
733
|
-
/** @description SVG markup for the asset. */
|
|
734
|
-
svg: string;
|
|
735
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
736
|
-
location: string;
|
|
737
|
-
};
|
|
738
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
739
|
-
mobileView: {
|
|
740
|
-
/** @description SVG markup for the asset. */
|
|
741
|
-
svg: string;
|
|
742
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
743
|
-
location: string;
|
|
744
|
-
};
|
|
745
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
746
|
-
darkDesktopView: {
|
|
747
|
-
/** @description SVG markup for the asset. */
|
|
748
|
-
svg: string;
|
|
749
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
750
|
-
location: string;
|
|
751
|
-
};
|
|
752
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
753
|
-
darkMobileView: {
|
|
754
|
-
/** @description SVG markup for the asset. */
|
|
755
|
-
svg: string;
|
|
756
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
757
|
-
location: string;
|
|
758
|
-
};
|
|
759
|
-
};
|
|
760
|
-
/** @description Arbitrary theme variables keyed by name. */
|
|
761
|
-
vars?: {
|
|
762
|
-
[key: string]: unknown;
|
|
763
|
-
};
|
|
764
|
-
};
|
|
765
|
-
/** @description Preferences specific to dashboard behavior. */
|
|
766
|
-
dashboard: {
|
|
767
|
-
[key: string]: unknown;
|
|
768
|
-
};
|
|
769
|
-
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
770
|
-
links?: {
|
|
771
|
-
/**
|
|
772
|
-
* Format: uri
|
|
773
|
-
* @description URL of the organization's Terms of Service page.
|
|
774
|
-
*/
|
|
775
|
-
termsOfService?: string;
|
|
776
|
-
/**
|
|
777
|
-
* Format: uri
|
|
778
|
-
* @description URL of the organization's Privacy Policy page.
|
|
779
|
-
*/
|
|
780
|
-
privacy?: string;
|
|
781
|
-
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
782
|
-
support?: {
|
|
783
|
-
[key: string]: string;
|
|
784
|
-
};
|
|
785
|
-
};
|
|
786
|
-
/**
|
|
787
|
-
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
788
|
-
* @default true
|
|
789
|
-
*/
|
|
790
|
-
showAuthCarousel: boolean;
|
|
791
|
-
};
|
|
792
|
-
};
|
|
793
|
-
/**
|
|
794
|
-
* Format: date-time
|
|
795
|
-
* @description Timestamp when the organization was created.
|
|
796
|
-
*/
|
|
797
|
-
createdAt?: string;
|
|
798
|
-
/**
|
|
799
|
-
* Format: date-time
|
|
800
|
-
* @description Timestamp when the organization was last updated.
|
|
801
|
-
*/
|
|
802
|
-
updatedAt?: string;
|
|
803
|
-
/**
|
|
804
|
-
* Format: date-time
|
|
805
|
-
* @description Timestamp when the organization was soft-deleted.
|
|
806
|
-
*/
|
|
807
|
-
deletedAt?: string;
|
|
808
|
-
}[];
|
|
809
|
-
};
|
|
810
|
-
/** @description Payload for creating or updating an organization. Contains only client-settable fields. */
|
|
811
|
-
OrganizationPayload: {
|
|
812
|
-
/** @description Name of the organization. */
|
|
813
|
-
name?: string;
|
|
814
|
-
/** @description Country of the organization. */
|
|
815
|
-
country?: string;
|
|
816
|
-
/** @description Region of the organization. */
|
|
817
|
-
region?: string;
|
|
818
|
-
/** @description Description of the organization. */
|
|
819
|
-
description?: string;
|
|
820
|
-
/** @description Indicates whether organization members should be notified of this update. */
|
|
821
|
-
notifyOrgUpdate?: boolean;
|
|
822
|
-
/** @description Organization-level user experience preferences. */
|
|
823
|
-
preferences?: {
|
|
824
|
-
/** @description UI theme configured for an organization. */
|
|
825
|
-
theme: {
|
|
1179
|
+
/**
|
|
1180
|
+
* Format: uuid
|
|
1181
|
+
* @description Organization ID.
|
|
1182
|
+
*/
|
|
1183
|
+
id?: string;
|
|
1184
|
+
/** @description Name of the organization. */
|
|
1185
|
+
name?: string;
|
|
1186
|
+
/** @description Description of the organization. */
|
|
1187
|
+
description?: string;
|
|
1188
|
+
/** @description Country of the organization. */
|
|
1189
|
+
country?: string;
|
|
1190
|
+
/** @description Region of the organization. */
|
|
1191
|
+
region?: string;
|
|
1192
|
+
/** @description Display name of the organization owner. */
|
|
1193
|
+
owner?: string;
|
|
1194
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1195
|
+
metadata?: {
|
|
1196
|
+
/** @description Organization-level user experience preferences. */
|
|
1197
|
+
preferences: {
|
|
1198
|
+
/** @description UI theme configured for an organization. */
|
|
1199
|
+
theme: {
|
|
826
1200
|
/**
|
|
827
1201
|
* Format: uuid
|
|
828
1202
|
* @description Theme identifier.
|
|
@@ -830,46 +1204,42 @@ export interface components {
|
|
|
830
1204
|
id: string;
|
|
831
1205
|
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
832
1206
|
logo: {
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
1207
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1208
|
+
desktopView: {
|
|
1209
|
+
/** @description SVG markup for the asset. */
|
|
1210
|
+
svg: string;
|
|
1211
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1212
|
+
location: string;
|
|
1213
|
+
};
|
|
1214
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1215
|
+
mobileView: {
|
|
1216
|
+
/** @description SVG markup for the asset. */
|
|
1217
|
+
svg: string;
|
|
1218
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1219
|
+
location: string;
|
|
1220
|
+
};
|
|
1221
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1222
|
+
darkDesktopView: {
|
|
1223
|
+
/** @description SVG markup for the asset. */
|
|
1224
|
+
svg: string;
|
|
1225
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1226
|
+
location: string;
|
|
1227
|
+
};
|
|
1228
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1229
|
+
darkMobileView: {
|
|
1230
|
+
/** @description SVG markup for the asset. */
|
|
1231
|
+
svg: string;
|
|
1232
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1233
|
+
location: string;
|
|
1234
|
+
};
|
|
861
1235
|
};
|
|
862
1236
|
/** @description Arbitrary theme variables keyed by name. */
|
|
863
|
-
vars?: {
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
[key: string]: unknown;
|
|
870
|
-
};
|
|
871
|
-
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
872
|
-
links?: {
|
|
1237
|
+
vars?: { [key: string]: unknown };
|
|
1238
|
+
};
|
|
1239
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1240
|
+
dashboard: { [key: string]: unknown };
|
|
1241
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
1242
|
+
links?: {
|
|
873
1243
|
/**
|
|
874
1244
|
* Format: uri
|
|
875
1245
|
* @description URL of the organization's Terms of Service page.
|
|
@@ -881,1771 +1251,960 @@ export interface components {
|
|
|
881
1251
|
*/
|
|
882
1252
|
privacy?: string;
|
|
883
1253
|
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
884
|
-
support?: {
|
|
885
|
-
|
|
886
|
-
|
|
1254
|
+
support?: { [key: string]: string };
|
|
1255
|
+
};
|
|
1256
|
+
/**
|
|
1257
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1258
|
+
* @default true
|
|
1259
|
+
*/
|
|
1260
|
+
showAuthCarousel?: boolean;
|
|
1261
|
+
};
|
|
1262
|
+
};
|
|
1263
|
+
/**
|
|
1264
|
+
* Format: date-time
|
|
1265
|
+
* @description Timestamp when the organization was created.
|
|
1266
|
+
*/
|
|
1267
|
+
createdAt?: string;
|
|
1268
|
+
/**
|
|
1269
|
+
* Format: date-time
|
|
1270
|
+
* @description Timestamp when the organization was last updated.
|
|
1271
|
+
*/
|
|
1272
|
+
updatedAt?: string;
|
|
1273
|
+
/**
|
|
1274
|
+
* Format: date-time
|
|
1275
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
1276
|
+
*/
|
|
1277
|
+
deletedAt?: string;
|
|
1278
|
+
}[];
|
|
1279
|
+
};
|
|
1280
|
+
};
|
|
1281
|
+
};
|
|
1282
|
+
/** Invalid request body or request param */
|
|
1283
|
+
400: {
|
|
1284
|
+
content: {
|
|
1285
|
+
"text/plain": string;
|
|
1286
|
+
};
|
|
1287
|
+
};
|
|
1288
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1289
|
+
401: {
|
|
1290
|
+
content: {
|
|
1291
|
+
"text/plain": string;
|
|
1292
|
+
};
|
|
1293
|
+
};
|
|
1294
|
+
/** Internal server error */
|
|
1295
|
+
500: {
|
|
1296
|
+
content: {
|
|
1297
|
+
"text/plain": string;
|
|
1298
|
+
};
|
|
1299
|
+
};
|
|
1300
|
+
};
|
|
1301
|
+
/** Body for creating or updating an organization */
|
|
1302
|
+
requestBody: {
|
|
1303
|
+
content: {
|
|
1304
|
+
"application/json": {
|
|
1305
|
+
/** @description Name of the organization. */
|
|
1306
|
+
name?: string;
|
|
1307
|
+
/** @description Country of the organization. */
|
|
1308
|
+
country?: string;
|
|
1309
|
+
/** @description Region of the organization. */
|
|
1310
|
+
region?: string;
|
|
1311
|
+
/** @description Description of the organization. */
|
|
1312
|
+
description?: string;
|
|
1313
|
+
/** @description Indicates whether organization members should be notified of this update. */
|
|
1314
|
+
notifyOrgUpdate?: boolean;
|
|
1315
|
+
/** @description Organization-level user experience preferences. */
|
|
1316
|
+
preferences?: {
|
|
1317
|
+
/** @description UI theme configured for an organization. */
|
|
1318
|
+
theme: {
|
|
1319
|
+
/**
|
|
1320
|
+
* Format: uuid
|
|
1321
|
+
* @description Theme identifier.
|
|
1322
|
+
*/
|
|
1323
|
+
id: string;
|
|
1324
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1325
|
+
logo: {
|
|
1326
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1327
|
+
desktopView: {
|
|
1328
|
+
/** @description SVG markup for the asset. */
|
|
1329
|
+
svg: string;
|
|
1330
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1331
|
+
location: string;
|
|
887
1332
|
};
|
|
888
|
-
/**
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
1333
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1334
|
+
mobileView: {
|
|
1335
|
+
/** @description SVG markup for the asset. */
|
|
1336
|
+
svg: string;
|
|
1337
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1338
|
+
location: string;
|
|
1339
|
+
};
|
|
1340
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1341
|
+
darkDesktopView: {
|
|
1342
|
+
/** @description SVG markup for the asset. */
|
|
1343
|
+
svg: string;
|
|
1344
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1345
|
+
location: string;
|
|
1346
|
+
};
|
|
1347
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1348
|
+
darkMobileView: {
|
|
1349
|
+
/** @description SVG markup for the asset. */
|
|
1350
|
+
svg: string;
|
|
1351
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1352
|
+
location: string;
|
|
1353
|
+
};
|
|
1354
|
+
};
|
|
1355
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1356
|
+
vars?: { [key: string]: unknown };
|
|
1357
|
+
};
|
|
1358
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1359
|
+
dashboard: { [key: string]: unknown };
|
|
1360
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
1361
|
+
links?: {
|
|
1362
|
+
/**
|
|
1363
|
+
* Format: uri
|
|
1364
|
+
* @description URL of the organization's Terms of Service page.
|
|
1365
|
+
*/
|
|
1366
|
+
termsOfService?: string;
|
|
1367
|
+
/**
|
|
1368
|
+
* Format: uri
|
|
1369
|
+
* @description URL of the organization's Privacy Policy page.
|
|
1370
|
+
*/
|
|
1371
|
+
privacy?: string;
|
|
1372
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
1373
|
+
support?: { [key: string]: string };
|
|
893
1374
|
};
|
|
1375
|
+
/**
|
|
1376
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1377
|
+
* @default true
|
|
1378
|
+
*/
|
|
1379
|
+
showAuthCarousel?: boolean;
|
|
1380
|
+
};
|
|
894
1381
|
};
|
|
895
|
-
|
|
896
|
-
|
|
1382
|
+
};
|
|
1383
|
+
};
|
|
1384
|
+
};
|
|
1385
|
+
getOrgByDomain: {
|
|
1386
|
+
parameters: {
|
|
1387
|
+
query: {
|
|
1388
|
+
/** Domain name of the organization to look up. */
|
|
1389
|
+
domain: string;
|
|
1390
|
+
};
|
|
1391
|
+
};
|
|
1392
|
+
responses: {
|
|
1393
|
+
/** Organization response */
|
|
1394
|
+
200: {
|
|
1395
|
+
content: {
|
|
1396
|
+
"application/json": {
|
|
897
1397
|
/**
|
|
898
1398
|
* Format: uuid
|
|
899
|
-
* @description
|
|
1399
|
+
* @description Organization ID.
|
|
900
1400
|
*/
|
|
901
|
-
id
|
|
902
|
-
/** @description Name of the
|
|
903
|
-
name
|
|
904
|
-
/** @description
|
|
905
|
-
|
|
906
|
-
/** @description
|
|
907
|
-
|
|
908
|
-
/** @description
|
|
909
|
-
|
|
910
|
-
[key: string]: string;
|
|
911
|
-
};
|
|
912
|
-
/**
|
|
913
|
-
* Format: date-time
|
|
914
|
-
* @description Timestamp when the team was created.
|
|
915
|
-
*/
|
|
916
|
-
createdAt?: string;
|
|
917
|
-
/**
|
|
918
|
-
* Format: date-time
|
|
919
|
-
* @description Timestamp when the team was last updated.
|
|
920
|
-
*/
|
|
921
|
-
updatedAt?: string;
|
|
922
|
-
/**
|
|
923
|
-
* Format: date-time
|
|
924
|
-
* @description Timestamp when the team was soft-deleted.
|
|
925
|
-
*/
|
|
926
|
-
deletedAt?: string;
|
|
927
|
-
};
|
|
928
|
-
/** @description Paginated list of teams. */
|
|
929
|
-
TeamsPage: {
|
|
930
|
-
/** @description Zero-based page index returned in this response. */
|
|
931
|
-
page?: number;
|
|
932
|
-
/** @description Maximum number of items returned on each page. */
|
|
933
|
-
pageSize?: number;
|
|
934
|
-
/** @description Total number of items across all pages. */
|
|
935
|
-
totalCount?: number;
|
|
936
|
-
/** @description Teams in this page. */
|
|
937
|
-
teams?: {
|
|
938
|
-
/**
|
|
939
|
-
* Format: uuid
|
|
940
|
-
* @description Team ID.
|
|
941
|
-
*/
|
|
942
|
-
id?: string;
|
|
943
|
-
/** @description Name of the team. */
|
|
944
|
-
name?: string;
|
|
945
|
-
/** @description Description of the team. */
|
|
946
|
-
description?: string;
|
|
947
|
-
/** @description Display name of the team owner. */
|
|
948
|
-
owner?: string;
|
|
949
|
-
/** @description Free-form team metadata. */
|
|
950
|
-
metadata?: {
|
|
951
|
-
[key: string]: string;
|
|
952
|
-
};
|
|
953
|
-
/**
|
|
954
|
-
* Format: date-time
|
|
955
|
-
* @description Timestamp when the team was created.
|
|
956
|
-
*/
|
|
957
|
-
createdAt?: string;
|
|
958
|
-
/**
|
|
959
|
-
* Format: date-time
|
|
960
|
-
* @description Timestamp when the team was last updated.
|
|
961
|
-
*/
|
|
962
|
-
updatedAt?: string;
|
|
963
|
-
/**
|
|
964
|
-
* Format: date-time
|
|
965
|
-
* @description Timestamp when the team was soft-deleted.
|
|
966
|
-
*/
|
|
967
|
-
deletedAt?: string;
|
|
968
|
-
}[];
|
|
969
|
-
};
|
|
970
|
-
/** @description Junction record linking a team to an organization. */
|
|
971
|
-
TeamsOrganizationsMapping: {
|
|
972
|
-
/**
|
|
973
|
-
* Format: uuid
|
|
974
|
-
* @description Mapping record ID.
|
|
975
|
-
*/
|
|
976
|
-
id?: string;
|
|
977
|
-
/**
|
|
978
|
-
* Format: uuid
|
|
979
|
-
* @description Organization ID for this mapping.
|
|
980
|
-
*/
|
|
981
|
-
orgId?: string;
|
|
1401
|
+
id: string;
|
|
1402
|
+
/** @description Name of the organization. */
|
|
1403
|
+
name: string;
|
|
1404
|
+
/** @description Country of the organization. */
|
|
1405
|
+
country: string;
|
|
1406
|
+
/** @description Region of the organization. */
|
|
1407
|
+
region: string;
|
|
1408
|
+
/** @description Description of the organization. */
|
|
1409
|
+
description: string;
|
|
982
1410
|
/**
|
|
983
1411
|
* Format: uuid
|
|
984
|
-
* @description
|
|
1412
|
+
* @description Owner user ID of the organization.
|
|
985
1413
|
*/
|
|
986
|
-
|
|
1414
|
+
owner: string;
|
|
1415
|
+
/** @description Free-form metadata associated with the organization, including preferences. */
|
|
1416
|
+
metadata: { [key: string]: unknown };
|
|
1417
|
+
/** @description Domain of the organization. */
|
|
1418
|
+
domain?: string | null;
|
|
987
1419
|
/**
|
|
988
1420
|
* Format: date-time
|
|
989
|
-
* @description Timestamp when the
|
|
1421
|
+
* @description Timestamp when the organization was created.
|
|
990
1422
|
*/
|
|
991
|
-
createdAt
|
|
1423
|
+
createdAt: string;
|
|
992
1424
|
/**
|
|
993
1425
|
* Format: date-time
|
|
994
|
-
* @description Timestamp when the
|
|
1426
|
+
* @description Timestamp when the organization was last updated.
|
|
995
1427
|
*/
|
|
996
|
-
updatedAt
|
|
1428
|
+
updatedAt: string;
|
|
997
1429
|
/**
|
|
998
1430
|
* Format: date-time
|
|
999
|
-
* @description Timestamp when the
|
|
1431
|
+
* @description Timestamp when the organization was soft-deleted. Null while the organization is active.
|
|
1000
1432
|
*/
|
|
1001
1433
|
deletedAt?: string;
|
|
1434
|
+
};
|
|
1435
|
+
};
|
|
1436
|
+
};
|
|
1437
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1438
|
+
401: {
|
|
1439
|
+
content: {
|
|
1440
|
+
"text/plain": string;
|
|
1002
1441
|
};
|
|
1003
|
-
|
|
1004
|
-
|
|
1442
|
+
};
|
|
1443
|
+
/** Organization not found */
|
|
1444
|
+
404: unknown;
|
|
1445
|
+
/** Internal server error */
|
|
1446
|
+
500: unknown;
|
|
1447
|
+
};
|
|
1448
|
+
};
|
|
1449
|
+
/** Returns the organization in the single-item page wrapper currently emitted by meshery-cloud. */
|
|
1450
|
+
getOrg: {
|
|
1451
|
+
parameters: {
|
|
1452
|
+
path: {
|
|
1453
|
+
/** Organization ID. */
|
|
1454
|
+
orgId: string;
|
|
1455
|
+
};
|
|
1456
|
+
};
|
|
1457
|
+
responses: {
|
|
1458
|
+
/** Single-organization page response */
|
|
1459
|
+
200: {
|
|
1460
|
+
content: {
|
|
1461
|
+
"application/json": {
|
|
1005
1462
|
/** @description Zero-based page index returned in this response. */
|
|
1006
1463
|
page?: number;
|
|
1007
1464
|
/** @description Maximum number of items returned on each page. */
|
|
1008
1465
|
pageSize?: number;
|
|
1009
1466
|
/** @description Total number of items across all pages. */
|
|
1010
1467
|
totalCount?: number;
|
|
1011
|
-
/** @description
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1468
|
+
/** @description Organizations returned in this single-item page wrapper. */
|
|
1469
|
+
organizations?: {
|
|
1470
|
+
/**
|
|
1471
|
+
* Format: uuid
|
|
1472
|
+
* @description Organization ID.
|
|
1473
|
+
*/
|
|
1474
|
+
id?: string;
|
|
1475
|
+
/** @description Name of the organization. */
|
|
1476
|
+
name?: string;
|
|
1477
|
+
/** @description Description of the organization. */
|
|
1478
|
+
description?: string;
|
|
1479
|
+
/** @description Country of the organization. */
|
|
1480
|
+
country?: string;
|
|
1481
|
+
/** @description Region of the organization. */
|
|
1482
|
+
region?: string;
|
|
1483
|
+
/** @description Display name of the organization owner. */
|
|
1484
|
+
owner?: string;
|
|
1485
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1486
|
+
metadata?: {
|
|
1487
|
+
/** @description Organization-level user experience preferences. */
|
|
1488
|
+
preferences: {
|
|
1489
|
+
/** @description UI theme configured for an organization. */
|
|
1490
|
+
theme: {
|
|
1491
|
+
/**
|
|
1492
|
+
* Format: uuid
|
|
1493
|
+
* @description Theme identifier.
|
|
1494
|
+
*/
|
|
1495
|
+
id: string;
|
|
1496
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1497
|
+
logo: {
|
|
1498
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1499
|
+
desktopView: {
|
|
1500
|
+
/** @description SVG markup for the asset. */
|
|
1501
|
+
svg: string;
|
|
1502
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1503
|
+
location: string;
|
|
1504
|
+
};
|
|
1505
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1506
|
+
mobileView: {
|
|
1507
|
+
/** @description SVG markup for the asset. */
|
|
1508
|
+
svg: string;
|
|
1509
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1510
|
+
location: string;
|
|
1511
|
+
};
|
|
1512
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1513
|
+
darkDesktopView: {
|
|
1514
|
+
/** @description SVG markup for the asset. */
|
|
1515
|
+
svg: string;
|
|
1516
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1517
|
+
location: string;
|
|
1518
|
+
};
|
|
1519
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1520
|
+
darkMobileView: {
|
|
1521
|
+
/** @description SVG markup for the asset. */
|
|
1522
|
+
svg: string;
|
|
1523
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1524
|
+
location: string;
|
|
1525
|
+
};
|
|
1526
|
+
};
|
|
1527
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1528
|
+
vars?: { [key: string]: unknown };
|
|
1529
|
+
};
|
|
1530
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1531
|
+
dashboard: { [key: string]: unknown };
|
|
1532
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
1533
|
+
links?: {
|
|
1534
|
+
/**
|
|
1535
|
+
* Format: uri
|
|
1536
|
+
* @description URL of the organization's Terms of Service page.
|
|
1537
|
+
*/
|
|
1538
|
+
termsOfService?: string;
|
|
1539
|
+
/**
|
|
1540
|
+
* Format: uri
|
|
1541
|
+
* @description URL of the organization's Privacy Policy page.
|
|
1542
|
+
*/
|
|
1543
|
+
privacy?: string;
|
|
1544
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
1545
|
+
support?: { [key: string]: string };
|
|
1546
|
+
};
|
|
1547
|
+
/**
|
|
1548
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1549
|
+
* @default true
|
|
1550
|
+
*/
|
|
1551
|
+
showAuthCarousel?: boolean;
|
|
1552
|
+
};
|
|
1553
|
+
};
|
|
1554
|
+
/**
|
|
1555
|
+
* Format: date-time
|
|
1556
|
+
* @description Timestamp when the organization was created.
|
|
1557
|
+
*/
|
|
1558
|
+
createdAt?: string;
|
|
1559
|
+
/**
|
|
1560
|
+
* Format: date-time
|
|
1561
|
+
* @description Timestamp when the organization was last updated.
|
|
1562
|
+
*/
|
|
1563
|
+
updatedAt?: string;
|
|
1564
|
+
/**
|
|
1565
|
+
* Format: date-time
|
|
1566
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
1567
|
+
*/
|
|
1568
|
+
deletedAt?: string;
|
|
1043
1569
|
}[];
|
|
1570
|
+
};
|
|
1044
1571
|
};
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
[name: string]: unknown;
|
|
1051
|
-
};
|
|
1052
|
-
content: {
|
|
1053
|
-
"text/plain": string;
|
|
1054
|
-
};
|
|
1055
|
-
};
|
|
1056
|
-
/** @description Expired JWT token used or insufficient privilege */
|
|
1057
|
-
401: {
|
|
1058
|
-
headers: {
|
|
1059
|
-
[name: string]: unknown;
|
|
1060
|
-
};
|
|
1061
|
-
content: {
|
|
1062
|
-
"text/plain": string;
|
|
1063
|
-
};
|
|
1572
|
+
};
|
|
1573
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1574
|
+
401: {
|
|
1575
|
+
content: {
|
|
1576
|
+
"text/plain": string;
|
|
1064
1577
|
};
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
content: {
|
|
1071
|
-
"text/plain": string;
|
|
1072
|
-
};
|
|
1578
|
+
};
|
|
1579
|
+
/** Result not found */
|
|
1580
|
+
404: {
|
|
1581
|
+
content: {
|
|
1582
|
+
"text/plain": string;
|
|
1073
1583
|
};
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
content: {
|
|
1080
|
-
"text/plain": string;
|
|
1081
|
-
};
|
|
1584
|
+
};
|
|
1585
|
+
/** Internal server error */
|
|
1586
|
+
500: {
|
|
1587
|
+
content: {
|
|
1588
|
+
"text/plain": string;
|
|
1082
1589
|
};
|
|
1590
|
+
};
|
|
1083
1591
|
};
|
|
1592
|
+
};
|
|
1593
|
+
/** Updates the organization. */
|
|
1594
|
+
updateOrg: {
|
|
1084
1595
|
parameters: {
|
|
1085
|
-
|
|
1596
|
+
path: {
|
|
1597
|
+
/** Organization ID. */
|
|
1086
1598
|
orgId: string;
|
|
1087
|
-
|
|
1088
|
-
userId: string;
|
|
1089
|
-
/** @description Team ID. */
|
|
1090
|
-
teamId: string;
|
|
1091
|
-
/** @description Zero-based index of the result page to return. */
|
|
1092
|
-
page: number;
|
|
1093
|
-
/** @description Maximum number of items returned on each page. */
|
|
1094
|
-
pageSize: number;
|
|
1095
|
-
/** @description Get responses that match search param value */
|
|
1096
|
-
search: string;
|
|
1097
|
-
/** @description Get ordered responses */
|
|
1098
|
-
order: string;
|
|
1099
|
-
/** @description Get all possible entries */
|
|
1100
|
-
all: boolean;
|
|
1599
|
+
};
|
|
1101
1600
|
};
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
/** @description
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
*/
|
|
1172
|
-
termsOfService?: string;
|
|
1173
|
-
/**
|
|
1174
|
-
* Format: uri
|
|
1175
|
-
* @description URL of the organization's Privacy Policy page.
|
|
1176
|
-
*/
|
|
1177
|
-
privacy?: string;
|
|
1178
|
-
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
1179
|
-
support?: {
|
|
1180
|
-
[key: string]: string;
|
|
1181
|
-
};
|
|
1182
|
-
};
|
|
1183
|
-
/**
|
|
1184
|
-
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1185
|
-
* @default true
|
|
1186
|
-
*/
|
|
1187
|
-
showAuthCarousel?: boolean;
|
|
1601
|
+
responses: {
|
|
1602
|
+
/** Single-organization page response for the updated organization */
|
|
1603
|
+
200: {
|
|
1604
|
+
content: {
|
|
1605
|
+
"application/json": {
|
|
1606
|
+
/** @description Zero-based page index returned in this response. */
|
|
1607
|
+
page?: number;
|
|
1608
|
+
/** @description Maximum number of items returned on each page. */
|
|
1609
|
+
pageSize?: number;
|
|
1610
|
+
/** @description Total number of items across all pages. */
|
|
1611
|
+
totalCount?: number;
|
|
1612
|
+
/** @description Organizations returned in this single-item page wrapper. */
|
|
1613
|
+
organizations?: {
|
|
1614
|
+
/**
|
|
1615
|
+
* Format: uuid
|
|
1616
|
+
* @description Organization ID.
|
|
1617
|
+
*/
|
|
1618
|
+
id?: string;
|
|
1619
|
+
/** @description Name of the organization. */
|
|
1620
|
+
name?: string;
|
|
1621
|
+
/** @description Description of the organization. */
|
|
1622
|
+
description?: string;
|
|
1623
|
+
/** @description Country of the organization. */
|
|
1624
|
+
country?: string;
|
|
1625
|
+
/** @description Region of the organization. */
|
|
1626
|
+
region?: string;
|
|
1627
|
+
/** @description Display name of the organization owner. */
|
|
1628
|
+
owner?: string;
|
|
1629
|
+
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1630
|
+
metadata?: {
|
|
1631
|
+
/** @description Organization-level user experience preferences. */
|
|
1632
|
+
preferences: {
|
|
1633
|
+
/** @description UI theme configured for an organization. */
|
|
1634
|
+
theme: {
|
|
1635
|
+
/**
|
|
1636
|
+
* Format: uuid
|
|
1637
|
+
* @description Theme identifier.
|
|
1638
|
+
*/
|
|
1639
|
+
id: string;
|
|
1640
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1641
|
+
logo: {
|
|
1642
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1643
|
+
desktopView: {
|
|
1644
|
+
/** @description SVG markup for the asset. */
|
|
1645
|
+
svg: string;
|
|
1646
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1647
|
+
location: string;
|
|
1648
|
+
};
|
|
1649
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1650
|
+
mobileView: {
|
|
1651
|
+
/** @description SVG markup for the asset. */
|
|
1652
|
+
svg: string;
|
|
1653
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1654
|
+
location: string;
|
|
1655
|
+
};
|
|
1656
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1657
|
+
darkDesktopView: {
|
|
1658
|
+
/** @description SVG markup for the asset. */
|
|
1659
|
+
svg: string;
|
|
1660
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1661
|
+
location: string;
|
|
1662
|
+
};
|
|
1663
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1664
|
+
darkMobileView: {
|
|
1665
|
+
/** @description SVG markup for the asset. */
|
|
1666
|
+
svg: string;
|
|
1667
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1668
|
+
location: string;
|
|
1669
|
+
};
|
|
1188
1670
|
};
|
|
1189
|
-
|
|
1190
|
-
|
|
1671
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1672
|
+
vars?: { [key: string]: unknown };
|
|
1673
|
+
};
|
|
1674
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1675
|
+
dashboard: { [key: string]: unknown };
|
|
1676
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
1677
|
+
links?: {
|
|
1678
|
+
/**
|
|
1679
|
+
* Format: uri
|
|
1680
|
+
* @description URL of the organization's Terms of Service page.
|
|
1681
|
+
*/
|
|
1682
|
+
termsOfService?: string;
|
|
1683
|
+
/**
|
|
1684
|
+
* Format: uri
|
|
1685
|
+
* @description URL of the organization's Privacy Policy page.
|
|
1686
|
+
*/
|
|
1687
|
+
privacy?: string;
|
|
1688
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
1689
|
+
support?: { [key: string]: string };
|
|
1690
|
+
};
|
|
1691
|
+
/**
|
|
1692
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1693
|
+
* @default true
|
|
1694
|
+
*/
|
|
1695
|
+
showAuthCarousel?: boolean;
|
|
1696
|
+
};
|
|
1697
|
+
};
|
|
1698
|
+
/**
|
|
1699
|
+
* Format: date-time
|
|
1700
|
+
* @description Timestamp when the organization was created.
|
|
1701
|
+
*/
|
|
1702
|
+
createdAt?: string;
|
|
1703
|
+
/**
|
|
1704
|
+
* Format: date-time
|
|
1705
|
+
* @description Timestamp when the organization was last updated.
|
|
1706
|
+
*/
|
|
1707
|
+
updatedAt?: string;
|
|
1708
|
+
/**
|
|
1709
|
+
* Format: date-time
|
|
1710
|
+
* @description Timestamp when the organization was soft-deleted.
|
|
1711
|
+
*/
|
|
1712
|
+
deletedAt?: string;
|
|
1713
|
+
}[];
|
|
1714
|
+
};
|
|
1191
1715
|
};
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
export interface operations {
|
|
1198
|
-
getOrgs: {
|
|
1199
|
-
parameters: {
|
|
1200
|
-
query?: {
|
|
1201
|
-
/** @description Zero-based index of the result page to return. */
|
|
1202
|
-
page?: number;
|
|
1203
|
-
/** @description Maximum number of items returned on each page. */
|
|
1204
|
-
pageSize?: number;
|
|
1205
|
-
/** @description Get responses that match search param value */
|
|
1206
|
-
search?: string;
|
|
1207
|
-
/** @description Get ordered responses */
|
|
1208
|
-
order?: string;
|
|
1209
|
-
/** @description Get all possible entries */
|
|
1210
|
-
all?: boolean;
|
|
1211
|
-
};
|
|
1212
|
-
header?: never;
|
|
1213
|
-
path?: never;
|
|
1214
|
-
cookie?: never;
|
|
1716
|
+
};
|
|
1717
|
+
/** Invalid request body or request param */
|
|
1718
|
+
400: {
|
|
1719
|
+
content: {
|
|
1720
|
+
"text/plain": string;
|
|
1215
1721
|
};
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
[name: string]: unknown;
|
|
1222
|
-
};
|
|
1223
|
-
content: {
|
|
1224
|
-
"application/json": {
|
|
1225
|
-
/** @description Zero-based page index returned in this response. */
|
|
1226
|
-
page?: number;
|
|
1227
|
-
/** @description Maximum number of items returned on each page. */
|
|
1228
|
-
pageSize?: number;
|
|
1229
|
-
/** @description Total number of items across all pages. */
|
|
1230
|
-
totalCount?: number;
|
|
1231
|
-
/** @description Organizations in this page. */
|
|
1232
|
-
organizations?: {
|
|
1233
|
-
/**
|
|
1234
|
-
* Format: uuid
|
|
1235
|
-
* @description Organization ID.
|
|
1236
|
-
*/
|
|
1237
|
-
id?: string;
|
|
1238
|
-
/** @description Name of the organization. */
|
|
1239
|
-
name?: string;
|
|
1240
|
-
/** @description Description of the organization. */
|
|
1241
|
-
description?: string;
|
|
1242
|
-
/** @description Country of the organization. */
|
|
1243
|
-
country?: string;
|
|
1244
|
-
/** @description Region of the organization. */
|
|
1245
|
-
region?: string;
|
|
1246
|
-
/** @description Display name of the organization owner. */
|
|
1247
|
-
owner?: string;
|
|
1248
|
-
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1249
|
-
metadata?: {
|
|
1250
|
-
/** @description Organization-level user experience preferences. */
|
|
1251
|
-
preferences: {
|
|
1252
|
-
/** @description UI theme configured for an organization. */
|
|
1253
|
-
theme: {
|
|
1254
|
-
/**
|
|
1255
|
-
* Format: uuid
|
|
1256
|
-
* @description Theme identifier.
|
|
1257
|
-
*/
|
|
1258
|
-
id: string;
|
|
1259
|
-
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1260
|
-
logo: {
|
|
1261
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1262
|
-
desktopView: {
|
|
1263
|
-
/** @description SVG markup for the asset. */
|
|
1264
|
-
svg: string;
|
|
1265
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1266
|
-
location: string;
|
|
1267
|
-
};
|
|
1268
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1269
|
-
mobileView: {
|
|
1270
|
-
/** @description SVG markup for the asset. */
|
|
1271
|
-
svg: string;
|
|
1272
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1273
|
-
location: string;
|
|
1274
|
-
};
|
|
1275
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1276
|
-
darkDesktopView: {
|
|
1277
|
-
/** @description SVG markup for the asset. */
|
|
1278
|
-
svg: string;
|
|
1279
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1280
|
-
location: string;
|
|
1281
|
-
};
|
|
1282
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1283
|
-
darkMobileView: {
|
|
1284
|
-
/** @description SVG markup for the asset. */
|
|
1285
|
-
svg: string;
|
|
1286
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1287
|
-
location: string;
|
|
1288
|
-
};
|
|
1289
|
-
};
|
|
1290
|
-
/** @description Arbitrary theme variables keyed by name. */
|
|
1291
|
-
vars?: {
|
|
1292
|
-
[key: string]: unknown;
|
|
1293
|
-
};
|
|
1294
|
-
};
|
|
1295
|
-
/** @description Preferences specific to dashboard behavior. */
|
|
1296
|
-
dashboard: {
|
|
1297
|
-
[key: string]: unknown;
|
|
1298
|
-
};
|
|
1299
|
-
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
1300
|
-
links?: {
|
|
1301
|
-
/**
|
|
1302
|
-
* Format: uri
|
|
1303
|
-
* @description URL of the organization's Terms of Service page.
|
|
1304
|
-
*/
|
|
1305
|
-
termsOfService?: string;
|
|
1306
|
-
/**
|
|
1307
|
-
* Format: uri
|
|
1308
|
-
* @description URL of the organization's Privacy Policy page.
|
|
1309
|
-
*/
|
|
1310
|
-
privacy?: string;
|
|
1311
|
-
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
1312
|
-
support?: {
|
|
1313
|
-
[key: string]: string;
|
|
1314
|
-
};
|
|
1315
|
-
};
|
|
1316
|
-
/**
|
|
1317
|
-
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1318
|
-
* @default true
|
|
1319
|
-
*/
|
|
1320
|
-
showAuthCarousel: boolean;
|
|
1321
|
-
};
|
|
1322
|
-
};
|
|
1323
|
-
/**
|
|
1324
|
-
* Format: date-time
|
|
1325
|
-
* @description Timestamp when the organization was created.
|
|
1326
|
-
*/
|
|
1327
|
-
createdAt?: string;
|
|
1328
|
-
/**
|
|
1329
|
-
* Format: date-time
|
|
1330
|
-
* @description Timestamp when the organization was last updated.
|
|
1331
|
-
*/
|
|
1332
|
-
updatedAt?: string;
|
|
1333
|
-
/**
|
|
1334
|
-
* Format: date-time
|
|
1335
|
-
* @description Timestamp when the organization was soft-deleted.
|
|
1336
|
-
*/
|
|
1337
|
-
deletedAt?: string;
|
|
1338
|
-
}[];
|
|
1339
|
-
};
|
|
1340
|
-
};
|
|
1341
|
-
};
|
|
1342
|
-
/** @description No content */
|
|
1343
|
-
204: {
|
|
1344
|
-
headers: {
|
|
1345
|
-
[name: string]: unknown;
|
|
1346
|
-
};
|
|
1347
|
-
content?: never;
|
|
1348
|
-
};
|
|
1349
|
-
/** @description Expired JWT token used or insufficient privilege */
|
|
1350
|
-
401: {
|
|
1351
|
-
headers: {
|
|
1352
|
-
[name: string]: unknown;
|
|
1353
|
-
};
|
|
1354
|
-
content: {
|
|
1355
|
-
"text/plain": string;
|
|
1356
|
-
};
|
|
1357
|
-
};
|
|
1358
|
-
/** @description Internal server error */
|
|
1359
|
-
500: {
|
|
1360
|
-
headers: {
|
|
1361
|
-
[name: string]: unknown;
|
|
1362
|
-
};
|
|
1363
|
-
content: {
|
|
1364
|
-
"text/plain": string;
|
|
1365
|
-
};
|
|
1366
|
-
};
|
|
1722
|
+
};
|
|
1723
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1724
|
+
401: {
|
|
1725
|
+
content: {
|
|
1726
|
+
"text/plain": string;
|
|
1367
1727
|
};
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
path?: never;
|
|
1374
|
-
cookie?: never;
|
|
1728
|
+
};
|
|
1729
|
+
/** Result not found */
|
|
1730
|
+
404: {
|
|
1731
|
+
content: {
|
|
1732
|
+
"text/plain": string;
|
|
1375
1733
|
};
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
name?: string;
|
|
1382
|
-
/** @description Country of the organization. */
|
|
1383
|
-
country?: string;
|
|
1384
|
-
/** @description Region of the organization. */
|
|
1385
|
-
region?: string;
|
|
1386
|
-
/** @description Description of the organization. */
|
|
1387
|
-
description?: string;
|
|
1388
|
-
/** @description Indicates whether organization members should be notified of this update. */
|
|
1389
|
-
notifyOrgUpdate?: boolean;
|
|
1390
|
-
/** @description Organization-level user experience preferences. */
|
|
1391
|
-
preferences?: {
|
|
1392
|
-
/** @description UI theme configured for an organization. */
|
|
1393
|
-
theme: {
|
|
1394
|
-
/**
|
|
1395
|
-
* Format: uuid
|
|
1396
|
-
* @description Theme identifier.
|
|
1397
|
-
*/
|
|
1398
|
-
id: string;
|
|
1399
|
-
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1400
|
-
logo: {
|
|
1401
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1402
|
-
desktopView: {
|
|
1403
|
-
/** @description SVG markup for the asset. */
|
|
1404
|
-
svg: string;
|
|
1405
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1406
|
-
location: string;
|
|
1407
|
-
};
|
|
1408
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1409
|
-
mobileView: {
|
|
1410
|
-
/** @description SVG markup for the asset. */
|
|
1411
|
-
svg: string;
|
|
1412
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1413
|
-
location: string;
|
|
1414
|
-
};
|
|
1415
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1416
|
-
darkDesktopView: {
|
|
1417
|
-
/** @description SVG markup for the asset. */
|
|
1418
|
-
svg: string;
|
|
1419
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1420
|
-
location: string;
|
|
1421
|
-
};
|
|
1422
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1423
|
-
darkMobileView: {
|
|
1424
|
-
/** @description SVG markup for the asset. */
|
|
1425
|
-
svg: string;
|
|
1426
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1427
|
-
location: string;
|
|
1428
|
-
};
|
|
1429
|
-
};
|
|
1430
|
-
/** @description Arbitrary theme variables keyed by name. */
|
|
1431
|
-
vars?: {
|
|
1432
|
-
[key: string]: unknown;
|
|
1433
|
-
};
|
|
1434
|
-
};
|
|
1435
|
-
/** @description Preferences specific to dashboard behavior. */
|
|
1436
|
-
dashboard: {
|
|
1437
|
-
[key: string]: unknown;
|
|
1438
|
-
};
|
|
1439
|
-
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
1440
|
-
links?: {
|
|
1441
|
-
/**
|
|
1442
|
-
* Format: uri
|
|
1443
|
-
* @description URL of the organization's Terms of Service page.
|
|
1444
|
-
*/
|
|
1445
|
-
termsOfService?: string;
|
|
1446
|
-
/**
|
|
1447
|
-
* Format: uri
|
|
1448
|
-
* @description URL of the organization's Privacy Policy page.
|
|
1449
|
-
*/
|
|
1450
|
-
privacy?: string;
|
|
1451
|
-
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
1452
|
-
support?: {
|
|
1453
|
-
[key: string]: string;
|
|
1454
|
-
};
|
|
1455
|
-
};
|
|
1456
|
-
/**
|
|
1457
|
-
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1458
|
-
* @default true
|
|
1459
|
-
*/
|
|
1460
|
-
showAuthCarousel?: boolean;
|
|
1461
|
-
};
|
|
1462
|
-
};
|
|
1463
|
-
};
|
|
1734
|
+
};
|
|
1735
|
+
/** Internal server error */
|
|
1736
|
+
500: {
|
|
1737
|
+
content: {
|
|
1738
|
+
"text/plain": string;
|
|
1464
1739
|
};
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
|
|
1485
|
-
|
|
1486
|
-
|
|
1487
|
-
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
/** @description Organization-level user experience preferences. */
|
|
1499
|
-
preferences: {
|
|
1500
|
-
/** @description UI theme configured for an organization. */
|
|
1501
|
-
theme: {
|
|
1502
|
-
/**
|
|
1503
|
-
* Format: uuid
|
|
1504
|
-
* @description Theme identifier.
|
|
1505
|
-
*/
|
|
1506
|
-
id: string;
|
|
1507
|
-
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1508
|
-
logo: {
|
|
1509
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1510
|
-
desktopView: {
|
|
1511
|
-
/** @description SVG markup for the asset. */
|
|
1512
|
-
svg: string;
|
|
1513
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1514
|
-
location: string;
|
|
1515
|
-
};
|
|
1516
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1517
|
-
mobileView: {
|
|
1518
|
-
/** @description SVG markup for the asset. */
|
|
1519
|
-
svg: string;
|
|
1520
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1521
|
-
location: string;
|
|
1522
|
-
};
|
|
1523
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1524
|
-
darkDesktopView: {
|
|
1525
|
-
/** @description SVG markup for the asset. */
|
|
1526
|
-
svg: string;
|
|
1527
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1528
|
-
location: string;
|
|
1529
|
-
};
|
|
1530
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1531
|
-
darkMobileView: {
|
|
1532
|
-
/** @description SVG markup for the asset. */
|
|
1533
|
-
svg: string;
|
|
1534
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1535
|
-
location: string;
|
|
1536
|
-
};
|
|
1537
|
-
};
|
|
1538
|
-
/** @description Arbitrary theme variables keyed by name. */
|
|
1539
|
-
vars?: {
|
|
1540
|
-
[key: string]: unknown;
|
|
1541
|
-
};
|
|
1542
|
-
};
|
|
1543
|
-
/** @description Preferences specific to dashboard behavior. */
|
|
1544
|
-
dashboard: {
|
|
1545
|
-
[key: string]: unknown;
|
|
1546
|
-
};
|
|
1547
|
-
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
1548
|
-
links?: {
|
|
1549
|
-
/**
|
|
1550
|
-
* Format: uri
|
|
1551
|
-
* @description URL of the organization's Terms of Service page.
|
|
1552
|
-
*/
|
|
1553
|
-
termsOfService?: string;
|
|
1554
|
-
/**
|
|
1555
|
-
* Format: uri
|
|
1556
|
-
* @description URL of the organization's Privacy Policy page.
|
|
1557
|
-
*/
|
|
1558
|
-
privacy?: string;
|
|
1559
|
-
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
1560
|
-
support?: {
|
|
1561
|
-
[key: string]: string;
|
|
1562
|
-
};
|
|
1563
|
-
};
|
|
1564
|
-
/**
|
|
1565
|
-
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1566
|
-
* @default true
|
|
1567
|
-
*/
|
|
1568
|
-
showAuthCarousel: boolean;
|
|
1569
|
-
};
|
|
1570
|
-
};
|
|
1571
|
-
/**
|
|
1572
|
-
* Format: date-time
|
|
1573
|
-
* @description Timestamp when the organization was created.
|
|
1574
|
-
*/
|
|
1575
|
-
createdAt?: string;
|
|
1576
|
-
/**
|
|
1577
|
-
* Format: date-time
|
|
1578
|
-
* @description Timestamp when the organization was last updated.
|
|
1579
|
-
*/
|
|
1580
|
-
updatedAt?: string;
|
|
1581
|
-
/**
|
|
1582
|
-
* Format: date-time
|
|
1583
|
-
* @description Timestamp when the organization was soft-deleted.
|
|
1584
|
-
*/
|
|
1585
|
-
deletedAt?: string;
|
|
1586
|
-
}[];
|
|
1587
|
-
};
|
|
1588
|
-
};
|
|
1589
|
-
};
|
|
1590
|
-
/** @description Invalid request body or request param */
|
|
1591
|
-
400: {
|
|
1592
|
-
headers: {
|
|
1593
|
-
[name: string]: unknown;
|
|
1740
|
+
};
|
|
1741
|
+
};
|
|
1742
|
+
/** Body for creating or updating an organization */
|
|
1743
|
+
requestBody: {
|
|
1744
|
+
content: {
|
|
1745
|
+
"application/json": {
|
|
1746
|
+
/** @description Name of the organization. */
|
|
1747
|
+
name?: string;
|
|
1748
|
+
/** @description Country of the organization. */
|
|
1749
|
+
country?: string;
|
|
1750
|
+
/** @description Region of the organization. */
|
|
1751
|
+
region?: string;
|
|
1752
|
+
/** @description Description of the organization. */
|
|
1753
|
+
description?: string;
|
|
1754
|
+
/** @description Indicates whether organization members should be notified of this update. */
|
|
1755
|
+
notifyOrgUpdate?: boolean;
|
|
1756
|
+
/** @description Organization-level user experience preferences. */
|
|
1757
|
+
preferences?: {
|
|
1758
|
+
/** @description UI theme configured for an organization. */
|
|
1759
|
+
theme: {
|
|
1760
|
+
/**
|
|
1761
|
+
* Format: uuid
|
|
1762
|
+
* @description Theme identifier.
|
|
1763
|
+
*/
|
|
1764
|
+
id: string;
|
|
1765
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1766
|
+
logo: {
|
|
1767
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1768
|
+
desktopView: {
|
|
1769
|
+
/** @description SVG markup for the asset. */
|
|
1770
|
+
svg: string;
|
|
1771
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1772
|
+
location: string;
|
|
1594
1773
|
};
|
|
1595
|
-
|
|
1596
|
-
|
|
1774
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1775
|
+
mobileView: {
|
|
1776
|
+
/** @description SVG markup for the asset. */
|
|
1777
|
+
svg: string;
|
|
1778
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1779
|
+
location: string;
|
|
1597
1780
|
};
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
|
|
1781
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1782
|
+
darkDesktopView: {
|
|
1783
|
+
/** @description SVG markup for the asset. */
|
|
1784
|
+
svg: string;
|
|
1785
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1786
|
+
location: string;
|
|
1603
1787
|
};
|
|
1604
|
-
|
|
1605
|
-
|
|
1788
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1789
|
+
darkMobileView: {
|
|
1790
|
+
/** @description SVG markup for the asset. */
|
|
1791
|
+
svg: string;
|
|
1792
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1793
|
+
location: string;
|
|
1606
1794
|
};
|
|
1795
|
+
};
|
|
1796
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1797
|
+
vars?: { [key: string]: unknown };
|
|
1607
1798
|
};
|
|
1608
|
-
/** @description
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1799
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1800
|
+
dashboard: { [key: string]: unknown };
|
|
1801
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
1802
|
+
links?: {
|
|
1803
|
+
/**
|
|
1804
|
+
* Format: uri
|
|
1805
|
+
* @description URL of the organization's Terms of Service page.
|
|
1806
|
+
*/
|
|
1807
|
+
termsOfService?: string;
|
|
1808
|
+
/**
|
|
1809
|
+
* Format: uri
|
|
1810
|
+
* @description URL of the organization's Privacy Policy page.
|
|
1811
|
+
*/
|
|
1812
|
+
privacy?: string;
|
|
1813
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
1814
|
+
support?: { [key: string]: string };
|
|
1616
1815
|
};
|
|
1816
|
+
/**
|
|
1817
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1818
|
+
* @default true
|
|
1819
|
+
*/
|
|
1820
|
+
showAuthCarousel?: boolean;
|
|
1821
|
+
};
|
|
1617
1822
|
};
|
|
1823
|
+
};
|
|
1618
1824
|
};
|
|
1619
|
-
|
|
1620
|
-
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
|
|
1625
|
-
|
|
1626
|
-
|
|
1627
|
-
|
|
1825
|
+
};
|
|
1826
|
+
/** Deletes the organization. */
|
|
1827
|
+
deleteOrg: {
|
|
1828
|
+
parameters: {
|
|
1829
|
+
path: {
|
|
1830
|
+
/** Organization ID. */
|
|
1831
|
+
orgId: string;
|
|
1832
|
+
};
|
|
1833
|
+
};
|
|
1834
|
+
responses: {
|
|
1835
|
+
/** Organization deleted */
|
|
1836
|
+
204: never;
|
|
1837
|
+
/** Invalid request body or request param */
|
|
1838
|
+
400: {
|
|
1839
|
+
content: {
|
|
1840
|
+
"text/plain": string;
|
|
1628
1841
|
};
|
|
1629
|
-
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
[name: string]: unknown;
|
|
1635
|
-
};
|
|
1636
|
-
content: {
|
|
1637
|
-
"application/json": {
|
|
1638
|
-
/**
|
|
1639
|
-
* Format: uuid
|
|
1640
|
-
* @description Organization ID.
|
|
1641
|
-
*/
|
|
1642
|
-
id: string;
|
|
1643
|
-
/** @description Name of the organization. */
|
|
1644
|
-
name: string;
|
|
1645
|
-
/** @description Country of the organization. */
|
|
1646
|
-
country: string;
|
|
1647
|
-
/** @description Region of the organization. */
|
|
1648
|
-
region: string;
|
|
1649
|
-
/** @description Description of the organization. */
|
|
1650
|
-
description: string;
|
|
1651
|
-
/**
|
|
1652
|
-
* Format: uuid
|
|
1653
|
-
* @description Owner user ID of the organization.
|
|
1654
|
-
*/
|
|
1655
|
-
owner: string;
|
|
1656
|
-
/** @description Free-form metadata associated with the organization, including preferences. */
|
|
1657
|
-
metadata: Record<string, never>;
|
|
1658
|
-
/** @description Domain of the organization. */
|
|
1659
|
-
domain?: string | null;
|
|
1660
|
-
/**
|
|
1661
|
-
* Format: date-time
|
|
1662
|
-
* @description Timestamp when the organization was created.
|
|
1663
|
-
*/
|
|
1664
|
-
createdAt: string;
|
|
1665
|
-
/**
|
|
1666
|
-
* Format: date-time
|
|
1667
|
-
* @description Timestamp when the organization was last updated.
|
|
1668
|
-
*/
|
|
1669
|
-
updatedAt: string;
|
|
1670
|
-
/**
|
|
1671
|
-
* Format: date-time
|
|
1672
|
-
* @description Timestamp when the organization was soft-deleted. Null while the organization is active.
|
|
1673
|
-
*/
|
|
1674
|
-
deletedAt?: string;
|
|
1675
|
-
};
|
|
1676
|
-
};
|
|
1677
|
-
};
|
|
1678
|
-
/** @description Expired JWT token used or insufficient privilege */
|
|
1679
|
-
401: {
|
|
1680
|
-
headers: {
|
|
1681
|
-
[name: string]: unknown;
|
|
1682
|
-
};
|
|
1683
|
-
content: {
|
|
1684
|
-
"text/plain": string;
|
|
1685
|
-
};
|
|
1686
|
-
};
|
|
1687
|
-
/** @description Organization not found */
|
|
1688
|
-
404: {
|
|
1689
|
-
headers: {
|
|
1690
|
-
[name: string]: unknown;
|
|
1691
|
-
};
|
|
1692
|
-
content?: never;
|
|
1693
|
-
};
|
|
1694
|
-
/** @description Internal server error */
|
|
1695
|
-
500: {
|
|
1696
|
-
headers: {
|
|
1697
|
-
[name: string]: unknown;
|
|
1698
|
-
};
|
|
1699
|
-
content?: never;
|
|
1700
|
-
};
|
|
1842
|
+
};
|
|
1843
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1844
|
+
401: {
|
|
1845
|
+
content: {
|
|
1846
|
+
"text/plain": string;
|
|
1701
1847
|
};
|
|
1702
|
-
|
|
1703
|
-
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
path: {
|
|
1708
|
-
/** @description Organization ID. */
|
|
1709
|
-
orgId: string;
|
|
1710
|
-
};
|
|
1711
|
-
cookie?: never;
|
|
1848
|
+
};
|
|
1849
|
+
/** Result not found */
|
|
1850
|
+
404: {
|
|
1851
|
+
content: {
|
|
1852
|
+
"text/plain": string;
|
|
1712
1853
|
};
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
[name: string]: unknown;
|
|
1719
|
-
};
|
|
1720
|
-
content: {
|
|
1721
|
-
"application/json": {
|
|
1722
|
-
/** @description Zero-based page index returned in this response. */
|
|
1723
|
-
page?: number;
|
|
1724
|
-
/** @description Maximum number of items returned on each page. */
|
|
1725
|
-
pageSize?: number;
|
|
1726
|
-
/** @description Total number of items across all pages. */
|
|
1727
|
-
totalCount?: number;
|
|
1728
|
-
/** @description Organizations returned in this single-item page wrapper. */
|
|
1729
|
-
organizations?: {
|
|
1730
|
-
/**
|
|
1731
|
-
* Format: uuid
|
|
1732
|
-
* @description Organization ID.
|
|
1733
|
-
*/
|
|
1734
|
-
id?: string;
|
|
1735
|
-
/** @description Name of the organization. */
|
|
1736
|
-
name?: string;
|
|
1737
|
-
/** @description Description of the organization. */
|
|
1738
|
-
description?: string;
|
|
1739
|
-
/** @description Country of the organization. */
|
|
1740
|
-
country?: string;
|
|
1741
|
-
/** @description Region of the organization. */
|
|
1742
|
-
region?: string;
|
|
1743
|
-
/** @description Display name of the organization owner. */
|
|
1744
|
-
owner?: string;
|
|
1745
|
-
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1746
|
-
metadata?: {
|
|
1747
|
-
/** @description Organization-level user experience preferences. */
|
|
1748
|
-
preferences: {
|
|
1749
|
-
/** @description UI theme configured for an organization. */
|
|
1750
|
-
theme: {
|
|
1751
|
-
/**
|
|
1752
|
-
* Format: uuid
|
|
1753
|
-
* @description Theme identifier.
|
|
1754
|
-
*/
|
|
1755
|
-
id: string;
|
|
1756
|
-
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1757
|
-
logo: {
|
|
1758
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1759
|
-
desktopView: {
|
|
1760
|
-
/** @description SVG markup for the asset. */
|
|
1761
|
-
svg: string;
|
|
1762
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1763
|
-
location: string;
|
|
1764
|
-
};
|
|
1765
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1766
|
-
mobileView: {
|
|
1767
|
-
/** @description SVG markup for the asset. */
|
|
1768
|
-
svg: string;
|
|
1769
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1770
|
-
location: string;
|
|
1771
|
-
};
|
|
1772
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1773
|
-
darkDesktopView: {
|
|
1774
|
-
/** @description SVG markup for the asset. */
|
|
1775
|
-
svg: string;
|
|
1776
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1777
|
-
location: string;
|
|
1778
|
-
};
|
|
1779
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1780
|
-
darkMobileView: {
|
|
1781
|
-
/** @description SVG markup for the asset. */
|
|
1782
|
-
svg: string;
|
|
1783
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1784
|
-
location: string;
|
|
1785
|
-
};
|
|
1786
|
-
};
|
|
1787
|
-
/** @description Arbitrary theme variables keyed by name. */
|
|
1788
|
-
vars?: {
|
|
1789
|
-
[key: string]: unknown;
|
|
1790
|
-
};
|
|
1791
|
-
};
|
|
1792
|
-
/** @description Preferences specific to dashboard behavior. */
|
|
1793
|
-
dashboard: {
|
|
1794
|
-
[key: string]: unknown;
|
|
1795
|
-
};
|
|
1796
|
-
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
1797
|
-
links?: {
|
|
1798
|
-
/**
|
|
1799
|
-
* Format: uri
|
|
1800
|
-
* @description URL of the organization's Terms of Service page.
|
|
1801
|
-
*/
|
|
1802
|
-
termsOfService?: string;
|
|
1803
|
-
/**
|
|
1804
|
-
* Format: uri
|
|
1805
|
-
* @description URL of the organization's Privacy Policy page.
|
|
1806
|
-
*/
|
|
1807
|
-
privacy?: string;
|
|
1808
|
-
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
1809
|
-
support?: {
|
|
1810
|
-
[key: string]: string;
|
|
1811
|
-
};
|
|
1812
|
-
};
|
|
1813
|
-
/**
|
|
1814
|
-
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1815
|
-
* @default true
|
|
1816
|
-
*/
|
|
1817
|
-
showAuthCarousel: boolean;
|
|
1818
|
-
};
|
|
1819
|
-
};
|
|
1820
|
-
/**
|
|
1821
|
-
* Format: date-time
|
|
1822
|
-
* @description Timestamp when the organization was created.
|
|
1823
|
-
*/
|
|
1824
|
-
createdAt?: string;
|
|
1825
|
-
/**
|
|
1826
|
-
* Format: date-time
|
|
1827
|
-
* @description Timestamp when the organization was last updated.
|
|
1828
|
-
*/
|
|
1829
|
-
updatedAt?: string;
|
|
1830
|
-
/**
|
|
1831
|
-
* Format: date-time
|
|
1832
|
-
* @description Timestamp when the organization was soft-deleted.
|
|
1833
|
-
*/
|
|
1834
|
-
deletedAt?: string;
|
|
1835
|
-
}[];
|
|
1836
|
-
};
|
|
1837
|
-
};
|
|
1838
|
-
};
|
|
1839
|
-
/** @description Expired JWT token used or insufficient privilege */
|
|
1840
|
-
401: {
|
|
1841
|
-
headers: {
|
|
1842
|
-
[name: string]: unknown;
|
|
1843
|
-
};
|
|
1844
|
-
content: {
|
|
1845
|
-
"text/plain": string;
|
|
1846
|
-
};
|
|
1847
|
-
};
|
|
1848
|
-
/** @description Result not found */
|
|
1849
|
-
404: {
|
|
1850
|
-
headers: {
|
|
1851
|
-
[name: string]: unknown;
|
|
1852
|
-
};
|
|
1853
|
-
content: {
|
|
1854
|
-
"text/plain": string;
|
|
1855
|
-
};
|
|
1856
|
-
};
|
|
1857
|
-
/** @description Internal server error */
|
|
1858
|
-
500: {
|
|
1859
|
-
headers: {
|
|
1860
|
-
[name: string]: unknown;
|
|
1861
|
-
};
|
|
1862
|
-
content: {
|
|
1863
|
-
"text/plain": string;
|
|
1864
|
-
};
|
|
1865
|
-
};
|
|
1854
|
+
};
|
|
1855
|
+
/** Internal server error */
|
|
1856
|
+
500: {
|
|
1857
|
+
content: {
|
|
1858
|
+
"text/plain": string;
|
|
1866
1859
|
};
|
|
1860
|
+
};
|
|
1867
1861
|
};
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
|
|
1885
|
-
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
|
|
1892
|
-
|
|
1893
|
-
|
|
1894
|
-
|
|
1895
|
-
|
|
1896
|
-
|
|
1897
|
-
|
|
1898
|
-
|
|
1899
|
-
|
|
1900
|
-
|
|
1901
|
-
|
|
1902
|
-
|
|
1903
|
-
|
|
1904
|
-
|
|
1905
|
-
|
|
1906
|
-
|
|
1907
|
-
|
|
1908
|
-
|
|
1909
|
-
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
|
|
1917
|
-
|
|
1918
|
-
|
|
1919
|
-
|
|
1920
|
-
|
|
1921
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1922
|
-
location: string;
|
|
1923
|
-
};
|
|
1924
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1925
|
-
darkMobileView: {
|
|
1926
|
-
/** @description SVG markup for the asset. */
|
|
1927
|
-
svg: string;
|
|
1928
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
1929
|
-
location: string;
|
|
1930
|
-
};
|
|
1931
|
-
};
|
|
1932
|
-
/** @description Arbitrary theme variables keyed by name. */
|
|
1933
|
-
vars?: {
|
|
1934
|
-
[key: string]: unknown;
|
|
1935
|
-
};
|
|
1936
|
-
};
|
|
1937
|
-
/** @description Preferences specific to dashboard behavior. */
|
|
1938
|
-
dashboard: {
|
|
1939
|
-
[key: string]: unknown;
|
|
1940
|
-
};
|
|
1941
|
-
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
1942
|
-
links?: {
|
|
1943
|
-
/**
|
|
1944
|
-
* Format: uri
|
|
1945
|
-
* @description URL of the organization's Terms of Service page.
|
|
1946
|
-
*/
|
|
1947
|
-
termsOfService?: string;
|
|
1948
|
-
/**
|
|
1949
|
-
* Format: uri
|
|
1950
|
-
* @description URL of the organization's Privacy Policy page.
|
|
1951
|
-
*/
|
|
1952
|
-
privacy?: string;
|
|
1953
|
-
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
1954
|
-
support?: {
|
|
1955
|
-
[key: string]: string;
|
|
1956
|
-
};
|
|
1957
|
-
};
|
|
1958
|
-
/**
|
|
1959
|
-
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1960
|
-
* @default true
|
|
1961
|
-
*/
|
|
1962
|
-
showAuthCarousel?: boolean;
|
|
1963
|
-
};
|
|
1862
|
+
};
|
|
1863
|
+
/** Returns preferences for the specified organization. */
|
|
1864
|
+
getOrgPreferences: {
|
|
1865
|
+
parameters: {
|
|
1866
|
+
path: {
|
|
1867
|
+
/** Organization ID. */
|
|
1868
|
+
orgId: string;
|
|
1869
|
+
};
|
|
1870
|
+
};
|
|
1871
|
+
responses: {
|
|
1872
|
+
/** Organization metadata, including preferences */
|
|
1873
|
+
200: {
|
|
1874
|
+
content: {
|
|
1875
|
+
"application/json": {
|
|
1876
|
+
/** @description Organization-level user experience preferences. */
|
|
1877
|
+
preferences: {
|
|
1878
|
+
/** @description UI theme configured for an organization. */
|
|
1879
|
+
theme: {
|
|
1880
|
+
/**
|
|
1881
|
+
* Format: uuid
|
|
1882
|
+
* @description Theme identifier.
|
|
1883
|
+
*/
|
|
1884
|
+
id: string;
|
|
1885
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
1886
|
+
logo: {
|
|
1887
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1888
|
+
desktopView: {
|
|
1889
|
+
/** @description SVG markup for the asset. */
|
|
1890
|
+
svg: string;
|
|
1891
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1892
|
+
location: string;
|
|
1893
|
+
};
|
|
1894
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1895
|
+
mobileView: {
|
|
1896
|
+
/** @description SVG markup for the asset. */
|
|
1897
|
+
svg: string;
|
|
1898
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1899
|
+
location: string;
|
|
1900
|
+
};
|
|
1901
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1902
|
+
darkDesktopView: {
|
|
1903
|
+
/** @description SVG markup for the asset. */
|
|
1904
|
+
svg: string;
|
|
1905
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1906
|
+
location: string;
|
|
1907
|
+
};
|
|
1908
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
1909
|
+
darkMobileView: {
|
|
1910
|
+
/** @description SVG markup for the asset. */
|
|
1911
|
+
svg: string;
|
|
1912
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
1913
|
+
location: string;
|
|
1914
|
+
};
|
|
1964
1915
|
};
|
|
1965
|
-
|
|
1916
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
1917
|
+
vars?: { [key: string]: unknown };
|
|
1918
|
+
};
|
|
1919
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
1920
|
+
dashboard: { [key: string]: unknown };
|
|
1921
|
+
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
1922
|
+
links?: {
|
|
1923
|
+
/**
|
|
1924
|
+
* Format: uri
|
|
1925
|
+
* @description URL of the organization's Terms of Service page.
|
|
1926
|
+
*/
|
|
1927
|
+
termsOfService?: string;
|
|
1928
|
+
/**
|
|
1929
|
+
* Format: uri
|
|
1930
|
+
* @description URL of the organization's Privacy Policy page.
|
|
1931
|
+
*/
|
|
1932
|
+
privacy?: string;
|
|
1933
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
1934
|
+
support?: { [key: string]: string };
|
|
1935
|
+
};
|
|
1936
|
+
/**
|
|
1937
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
1938
|
+
* @default true
|
|
1939
|
+
*/
|
|
1940
|
+
showAuthCarousel?: boolean;
|
|
1941
|
+
};
|
|
1942
|
+
};
|
|
1966
1943
|
};
|
|
1967
|
-
|
|
1968
|
-
|
|
1969
|
-
|
|
1970
|
-
|
|
1971
|
-
|
|
1972
|
-
};
|
|
1973
|
-
content: {
|
|
1974
|
-
"application/json": {
|
|
1975
|
-
/** @description Zero-based page index returned in this response. */
|
|
1976
|
-
page?: number;
|
|
1977
|
-
/** @description Maximum number of items returned on each page. */
|
|
1978
|
-
pageSize?: number;
|
|
1979
|
-
/** @description Total number of items across all pages. */
|
|
1980
|
-
totalCount?: number;
|
|
1981
|
-
/** @description Organizations returned in this single-item page wrapper. */
|
|
1982
|
-
organizations?: {
|
|
1983
|
-
/**
|
|
1984
|
-
* Format: uuid
|
|
1985
|
-
* @description Organization ID.
|
|
1986
|
-
*/
|
|
1987
|
-
id?: string;
|
|
1988
|
-
/** @description Name of the organization. */
|
|
1989
|
-
name?: string;
|
|
1990
|
-
/** @description Description of the organization. */
|
|
1991
|
-
description?: string;
|
|
1992
|
-
/** @description Country of the organization. */
|
|
1993
|
-
country?: string;
|
|
1994
|
-
/** @description Region of the organization. */
|
|
1995
|
-
region?: string;
|
|
1996
|
-
/** @description Display name of the organization owner. */
|
|
1997
|
-
owner?: string;
|
|
1998
|
-
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
1999
|
-
metadata?: {
|
|
2000
|
-
/** @description Organization-level user experience preferences. */
|
|
2001
|
-
preferences: {
|
|
2002
|
-
/** @description UI theme configured for an organization. */
|
|
2003
|
-
theme: {
|
|
2004
|
-
/**
|
|
2005
|
-
* Format: uuid
|
|
2006
|
-
* @description Theme identifier.
|
|
2007
|
-
*/
|
|
2008
|
-
id: string;
|
|
2009
|
-
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
2010
|
-
logo: {
|
|
2011
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
2012
|
-
desktopView: {
|
|
2013
|
-
/** @description SVG markup for the asset. */
|
|
2014
|
-
svg: string;
|
|
2015
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
2016
|
-
location: string;
|
|
2017
|
-
};
|
|
2018
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
2019
|
-
mobileView: {
|
|
2020
|
-
/** @description SVG markup for the asset. */
|
|
2021
|
-
svg: string;
|
|
2022
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
2023
|
-
location: string;
|
|
2024
|
-
};
|
|
2025
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
2026
|
-
darkDesktopView: {
|
|
2027
|
-
/** @description SVG markup for the asset. */
|
|
2028
|
-
svg: string;
|
|
2029
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
2030
|
-
location: string;
|
|
2031
|
-
};
|
|
2032
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
2033
|
-
darkMobileView: {
|
|
2034
|
-
/** @description SVG markup for the asset. */
|
|
2035
|
-
svg: string;
|
|
2036
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
2037
|
-
location: string;
|
|
2038
|
-
};
|
|
2039
|
-
};
|
|
2040
|
-
/** @description Arbitrary theme variables keyed by name. */
|
|
2041
|
-
vars?: {
|
|
2042
|
-
[key: string]: unknown;
|
|
2043
|
-
};
|
|
2044
|
-
};
|
|
2045
|
-
/** @description Preferences specific to dashboard behavior. */
|
|
2046
|
-
dashboard: {
|
|
2047
|
-
[key: string]: unknown;
|
|
2048
|
-
};
|
|
2049
|
-
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
2050
|
-
links?: {
|
|
2051
|
-
/**
|
|
2052
|
-
* Format: uri
|
|
2053
|
-
* @description URL of the organization's Terms of Service page.
|
|
2054
|
-
*/
|
|
2055
|
-
termsOfService?: string;
|
|
2056
|
-
/**
|
|
2057
|
-
* Format: uri
|
|
2058
|
-
* @description URL of the organization's Privacy Policy page.
|
|
2059
|
-
*/
|
|
2060
|
-
privacy?: string;
|
|
2061
|
-
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
2062
|
-
support?: {
|
|
2063
|
-
[key: string]: string;
|
|
2064
|
-
};
|
|
2065
|
-
};
|
|
2066
|
-
/**
|
|
2067
|
-
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
2068
|
-
* @default true
|
|
2069
|
-
*/
|
|
2070
|
-
showAuthCarousel: boolean;
|
|
2071
|
-
};
|
|
2072
|
-
};
|
|
2073
|
-
/**
|
|
2074
|
-
* Format: date-time
|
|
2075
|
-
* @description Timestamp when the organization was created.
|
|
2076
|
-
*/
|
|
2077
|
-
createdAt?: string;
|
|
2078
|
-
/**
|
|
2079
|
-
* Format: date-time
|
|
2080
|
-
* @description Timestamp when the organization was last updated.
|
|
2081
|
-
*/
|
|
2082
|
-
updatedAt?: string;
|
|
2083
|
-
/**
|
|
2084
|
-
* Format: date-time
|
|
2085
|
-
* @description Timestamp when the organization was soft-deleted.
|
|
2086
|
-
*/
|
|
2087
|
-
deletedAt?: string;
|
|
2088
|
-
}[];
|
|
2089
|
-
};
|
|
2090
|
-
};
|
|
2091
|
-
};
|
|
2092
|
-
/** @description Invalid request body or request param */
|
|
2093
|
-
400: {
|
|
2094
|
-
headers: {
|
|
2095
|
-
[name: string]: unknown;
|
|
2096
|
-
};
|
|
2097
|
-
content: {
|
|
2098
|
-
"text/plain": string;
|
|
2099
|
-
};
|
|
2100
|
-
};
|
|
2101
|
-
/** @description Expired JWT token used or insufficient privilege */
|
|
2102
|
-
401: {
|
|
2103
|
-
headers: {
|
|
2104
|
-
[name: string]: unknown;
|
|
2105
|
-
};
|
|
2106
|
-
content: {
|
|
2107
|
-
"text/plain": string;
|
|
2108
|
-
};
|
|
2109
|
-
};
|
|
2110
|
-
/** @description Result not found */
|
|
2111
|
-
404: {
|
|
2112
|
-
headers: {
|
|
2113
|
-
[name: string]: unknown;
|
|
2114
|
-
};
|
|
2115
|
-
content: {
|
|
2116
|
-
"text/plain": string;
|
|
2117
|
-
};
|
|
2118
|
-
};
|
|
2119
|
-
/** @description Internal server error */
|
|
2120
|
-
500: {
|
|
2121
|
-
headers: {
|
|
2122
|
-
[name: string]: unknown;
|
|
2123
|
-
};
|
|
2124
|
-
content: {
|
|
2125
|
-
"text/plain": string;
|
|
2126
|
-
};
|
|
2127
|
-
};
|
|
1944
|
+
};
|
|
1945
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1946
|
+
401: {
|
|
1947
|
+
content: {
|
|
1948
|
+
"text/plain": string;
|
|
2128
1949
|
};
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
path: {
|
|
2135
|
-
/** @description Organization ID. */
|
|
2136
|
-
orgId: string;
|
|
2137
|
-
};
|
|
2138
|
-
cookie?: never;
|
|
1950
|
+
};
|
|
1951
|
+
/** Result not found */
|
|
1952
|
+
404: {
|
|
1953
|
+
content: {
|
|
1954
|
+
"text/plain": string;
|
|
2139
1955
|
};
|
|
2140
|
-
|
|
2141
|
-
|
|
2142
|
-
|
|
2143
|
-
|
|
2144
|
-
|
|
2145
|
-
[name: string]: unknown;
|
|
2146
|
-
};
|
|
2147
|
-
content?: never;
|
|
2148
|
-
};
|
|
2149
|
-
/** @description Invalid request body or request param */
|
|
2150
|
-
400: {
|
|
2151
|
-
headers: {
|
|
2152
|
-
[name: string]: unknown;
|
|
2153
|
-
};
|
|
2154
|
-
content: {
|
|
2155
|
-
"text/plain": string;
|
|
2156
|
-
};
|
|
2157
|
-
};
|
|
2158
|
-
/** @description Expired JWT token used or insufficient privilege */
|
|
2159
|
-
401: {
|
|
2160
|
-
headers: {
|
|
2161
|
-
[name: string]: unknown;
|
|
2162
|
-
};
|
|
2163
|
-
content: {
|
|
2164
|
-
"text/plain": string;
|
|
2165
|
-
};
|
|
2166
|
-
};
|
|
2167
|
-
/** @description Result not found */
|
|
2168
|
-
404: {
|
|
2169
|
-
headers: {
|
|
2170
|
-
[name: string]: unknown;
|
|
2171
|
-
};
|
|
2172
|
-
content: {
|
|
2173
|
-
"text/plain": string;
|
|
2174
|
-
};
|
|
2175
|
-
};
|
|
2176
|
-
/** @description Internal server error */
|
|
2177
|
-
500: {
|
|
2178
|
-
headers: {
|
|
2179
|
-
[name: string]: unknown;
|
|
2180
|
-
};
|
|
2181
|
-
content: {
|
|
2182
|
-
"text/plain": string;
|
|
2183
|
-
};
|
|
2184
|
-
};
|
|
1956
|
+
};
|
|
1957
|
+
/** Internal server error */
|
|
1958
|
+
500: {
|
|
1959
|
+
content: {
|
|
1960
|
+
"text/plain": string;
|
|
2185
1961
|
};
|
|
1962
|
+
};
|
|
2186
1963
|
};
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
|
|
2194
|
-
|
|
2195
|
-
|
|
2196
|
-
|
|
2197
|
-
requestBody?: never;
|
|
2198
|
-
responses: {
|
|
2199
|
-
/** @description Organization metadata, including preferences */
|
|
2200
|
-
200: {
|
|
2201
|
-
headers: {
|
|
2202
|
-
[name: string]: unknown;
|
|
2203
|
-
};
|
|
2204
|
-
content: {
|
|
2205
|
-
"application/json": {
|
|
2206
|
-
/** @description Organization-level user experience preferences. */
|
|
2207
|
-
preferences: {
|
|
2208
|
-
/** @description UI theme configured for an organization. */
|
|
2209
|
-
theme: {
|
|
2210
|
-
/**
|
|
2211
|
-
* Format: uuid
|
|
2212
|
-
* @description Theme identifier.
|
|
2213
|
-
*/
|
|
2214
|
-
id: string;
|
|
2215
|
-
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
2216
|
-
logo: {
|
|
2217
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
2218
|
-
desktopView: {
|
|
2219
|
-
/** @description SVG markup for the asset. */
|
|
2220
|
-
svg: string;
|
|
2221
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
2222
|
-
location: string;
|
|
2223
|
-
};
|
|
2224
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
2225
|
-
mobileView: {
|
|
2226
|
-
/** @description SVG markup for the asset. */
|
|
2227
|
-
svg: string;
|
|
2228
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
2229
|
-
location: string;
|
|
2230
|
-
};
|
|
2231
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
2232
|
-
darkDesktopView: {
|
|
2233
|
-
/** @description SVG markup for the asset. */
|
|
2234
|
-
svg: string;
|
|
2235
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
2236
|
-
location: string;
|
|
2237
|
-
};
|
|
2238
|
-
/** @description Image asset anchored to a named location within an organization theme. */
|
|
2239
|
-
darkMobileView: {
|
|
2240
|
-
/** @description SVG markup for the asset. */
|
|
2241
|
-
svg: string;
|
|
2242
|
-
/** @description Named location of the asset (e.g. header, footer). */
|
|
2243
|
-
location: string;
|
|
2244
|
-
};
|
|
2245
|
-
};
|
|
2246
|
-
/** @description Arbitrary theme variables keyed by name. */
|
|
2247
|
-
vars?: {
|
|
2248
|
-
[key: string]: unknown;
|
|
2249
|
-
};
|
|
2250
|
-
};
|
|
2251
|
-
/** @description Preferences specific to dashboard behavior. */
|
|
2252
|
-
dashboard: {
|
|
2253
|
-
[key: string]: unknown;
|
|
2254
|
-
};
|
|
2255
|
-
/** @description Per-organization overrides for the legal and support links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links. Empty or omitted fields fall back to the platform defaults. */
|
|
2256
|
-
links?: {
|
|
2257
|
-
/**
|
|
2258
|
-
* Format: uri
|
|
2259
|
-
* @description URL of the organization's Terms of Service page.
|
|
2260
|
-
*/
|
|
2261
|
-
termsOfService?: string;
|
|
2262
|
-
/**
|
|
2263
|
-
* Format: uri
|
|
2264
|
-
* @description URL of the organization's Privacy Policy page.
|
|
2265
|
-
*/
|
|
2266
|
-
privacy?: string;
|
|
2267
|
-
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
2268
|
-
support?: {
|
|
2269
|
-
[key: string]: string;
|
|
2270
|
-
};
|
|
2271
|
-
};
|
|
2272
|
-
/**
|
|
2273
|
-
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
2274
|
-
* @default true
|
|
2275
|
-
*/
|
|
2276
|
-
showAuthCarousel: boolean;
|
|
2277
|
-
};
|
|
2278
|
-
};
|
|
2279
|
-
};
|
|
2280
|
-
};
|
|
2281
|
-
/** @description Expired JWT token used or insufficient privilege */
|
|
2282
|
-
401: {
|
|
2283
|
-
headers: {
|
|
2284
|
-
[name: string]: unknown;
|
|
2285
|
-
};
|
|
2286
|
-
content: {
|
|
2287
|
-
"text/plain": string;
|
|
2288
|
-
};
|
|
2289
|
-
};
|
|
2290
|
-
/** @description Result not found */
|
|
2291
|
-
404: {
|
|
2292
|
-
headers: {
|
|
2293
|
-
[name: string]: unknown;
|
|
2294
|
-
};
|
|
2295
|
-
content: {
|
|
2296
|
-
"text/plain": string;
|
|
2297
|
-
};
|
|
2298
|
-
};
|
|
2299
|
-
/** @description Internal server error */
|
|
2300
|
-
500: {
|
|
2301
|
-
headers: {
|
|
2302
|
-
[name: string]: unknown;
|
|
2303
|
-
};
|
|
2304
|
-
content: {
|
|
2305
|
-
"text/plain": string;
|
|
2306
|
-
};
|
|
2307
|
-
};
|
|
2308
|
-
};
|
|
1964
|
+
};
|
|
1965
|
+
/** Adds a team to an organization. If request body contains action=delete, tombstones a team by setting its deletedAt timestamp. The team's organization mapping remains intact. */
|
|
1966
|
+
addTeamToOrg: {
|
|
1967
|
+
parameters: {
|
|
1968
|
+
path: {
|
|
1969
|
+
/** Organization ID. */
|
|
1970
|
+
orgId: string;
|
|
1971
|
+
/** Team ID. */
|
|
1972
|
+
teamId: string;
|
|
1973
|
+
};
|
|
2309
1974
|
};
|
|
2310
|
-
|
|
2311
|
-
|
|
2312
|
-
|
|
2313
|
-
|
|
2314
|
-
|
|
2315
|
-
|
|
2316
|
-
|
|
2317
|
-
|
|
2318
|
-
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
|
|
2329
|
-
|
|
2330
|
-
|
|
2331
|
-
|
|
2332
|
-
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
|
|
2337
|
-
|
|
2338
|
-
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
|
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
|
|
2346
|
-
|
|
2347
|
-
|
|
2348
|
-
|
|
2349
|
-
|
|
2350
|
-
|
|
2351
|
-
|
|
2352
|
-
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
|
|
2356
|
-
|
|
2357
|
-
|
|
2358
|
-
|
|
2359
|
-
|
|
2360
|
-
|
|
2361
|
-
|
|
2362
|
-
|
|
2363
|
-
|
|
2364
|
-
|
|
2365
|
-
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
|
|
2369
|
-
|
|
2370
|
-
|
|
2371
|
-
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
|
-
|
|
2375
|
-
|
|
2376
|
-
|
|
2377
|
-
|
|
2378
|
-
|
|
2379
|
-
|
|
2380
|
-
|
|
2381
|
-
|
|
2382
|
-
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
|
|
2387
|
-
|
|
2388
|
-
|
|
2389
|
-
|
|
2390
|
-
|
|
2391
|
-
|
|
2392
|
-
|
|
2393
|
-
|
|
2394
|
-
|
|
2395
|
-
name?: string;
|
|
2396
|
-
/** @description Description of the team. */
|
|
2397
|
-
description?: string;
|
|
2398
|
-
/** @description Display name of the team owner. */
|
|
2399
|
-
owner?: string;
|
|
2400
|
-
/** @description Free-form team metadata. */
|
|
2401
|
-
metadata?: {
|
|
2402
|
-
[key: string]: string;
|
|
2403
|
-
};
|
|
2404
|
-
/**
|
|
2405
|
-
* Format: date-time
|
|
2406
|
-
* @description Timestamp when the team was created.
|
|
2407
|
-
*/
|
|
2408
|
-
createdAt?: string;
|
|
2409
|
-
/**
|
|
2410
|
-
* Format: date-time
|
|
2411
|
-
* @description Timestamp when the team was last updated.
|
|
2412
|
-
*/
|
|
2413
|
-
updatedAt?: string;
|
|
2414
|
-
/**
|
|
2415
|
-
* Format: date-time
|
|
2416
|
-
* @description Timestamp when the team was soft-deleted.
|
|
2417
|
-
*/
|
|
2418
|
-
deletedAt?: string;
|
|
2419
|
-
}[];
|
|
2420
|
-
};
|
|
2421
|
-
};
|
|
2422
|
-
};
|
|
2423
|
-
/** @description Bad request */
|
|
2424
|
-
400: {
|
|
2425
|
-
headers: {
|
|
2426
|
-
[name: string]: unknown;
|
|
2427
|
-
};
|
|
2428
|
-
content?: never;
|
|
2429
|
-
};
|
|
2430
|
-
/** @description Unauthorized */
|
|
2431
|
-
401: {
|
|
2432
|
-
headers: {
|
|
2433
|
-
[name: string]: unknown;
|
|
2434
|
-
};
|
|
2435
|
-
content?: never;
|
|
2436
|
-
};
|
|
2437
|
-
/** @description Not found */
|
|
2438
|
-
404: {
|
|
2439
|
-
headers: {
|
|
2440
|
-
[name: string]: unknown;
|
|
2441
|
-
};
|
|
2442
|
-
content?: never;
|
|
2443
|
-
};
|
|
2444
|
-
/** @description Internal server error */
|
|
2445
|
-
500: {
|
|
2446
|
-
headers: {
|
|
2447
|
-
[name: string]: unknown;
|
|
2448
|
-
};
|
|
2449
|
-
content?: never;
|
|
2450
|
-
};
|
|
1975
|
+
responses: {
|
|
1976
|
+
/** Team added to organization or team tombstoned */
|
|
1977
|
+
201: {
|
|
1978
|
+
content: {
|
|
1979
|
+
"application/json":
|
|
1980
|
+
| {
|
|
1981
|
+
/** @description Zero-based page index returned in this response. */
|
|
1982
|
+
page?: number;
|
|
1983
|
+
/** @description Maximum number of items returned on each page. */
|
|
1984
|
+
pageSize?: number;
|
|
1985
|
+
/** @description Total number of items across all pages. */
|
|
1986
|
+
totalCount?: number;
|
|
1987
|
+
/** @description Team-organization mapping entries. */
|
|
1988
|
+
teamsOrganizationsMapping?: {
|
|
1989
|
+
/**
|
|
1990
|
+
* Format: uuid
|
|
1991
|
+
* @description Mapping record ID.
|
|
1992
|
+
*/
|
|
1993
|
+
id?: string;
|
|
1994
|
+
/**
|
|
1995
|
+
* Format: uuid
|
|
1996
|
+
* @description Organization ID for this mapping.
|
|
1997
|
+
*/
|
|
1998
|
+
orgId?: string;
|
|
1999
|
+
/**
|
|
2000
|
+
* Format: uuid
|
|
2001
|
+
* @description Team ID for this mapping.
|
|
2002
|
+
*/
|
|
2003
|
+
teamId?: string;
|
|
2004
|
+
/**
|
|
2005
|
+
* Format: date-time
|
|
2006
|
+
* @description Timestamp when the mapping was created.
|
|
2007
|
+
*/
|
|
2008
|
+
createdAt?: string;
|
|
2009
|
+
/**
|
|
2010
|
+
* Format: date-time
|
|
2011
|
+
* @description Timestamp when the mapping was last updated.
|
|
2012
|
+
*/
|
|
2013
|
+
updatedAt?: string;
|
|
2014
|
+
/**
|
|
2015
|
+
* Format: date-time
|
|
2016
|
+
* @description Timestamp when the mapping was soft-deleted.
|
|
2017
|
+
*/
|
|
2018
|
+
deletedAt?: string;
|
|
2019
|
+
}[];
|
|
2020
|
+
}
|
|
2021
|
+
| {
|
|
2022
|
+
/** @description Zero-based page index returned in this response. */
|
|
2023
|
+
page?: number;
|
|
2024
|
+
/** @description Maximum number of items returned on each page. */
|
|
2025
|
+
pageSize?: number;
|
|
2026
|
+
/** @description Total number of items across all pages. */
|
|
2027
|
+
totalCount?: number;
|
|
2028
|
+
/** @description Teams in this page. */
|
|
2029
|
+
teams?: {
|
|
2030
|
+
/**
|
|
2031
|
+
* Format: uuid
|
|
2032
|
+
* @description Team ID.
|
|
2033
|
+
*/
|
|
2034
|
+
id?: string;
|
|
2035
|
+
/** @description Name of the team. */
|
|
2036
|
+
name?: string;
|
|
2037
|
+
/** @description Description of the team. */
|
|
2038
|
+
description?: string;
|
|
2039
|
+
/** @description Display name of the team owner. */
|
|
2040
|
+
owner?: string;
|
|
2041
|
+
/** @description Free-form team metadata. */
|
|
2042
|
+
metadata?: { [key: string]: string };
|
|
2043
|
+
/**
|
|
2044
|
+
* Format: date-time
|
|
2045
|
+
* @description Timestamp when the team was created.
|
|
2046
|
+
*/
|
|
2047
|
+
createdAt?: string;
|
|
2048
|
+
/**
|
|
2049
|
+
* Format: date-time
|
|
2050
|
+
* @description Timestamp when the team was last updated.
|
|
2051
|
+
*/
|
|
2052
|
+
updatedAt?: string;
|
|
2053
|
+
/**
|
|
2054
|
+
* Format: date-time
|
|
2055
|
+
* @description Timestamp when the team was soft-deleted.
|
|
2056
|
+
*/
|
|
2057
|
+
deletedAt?: string;
|
|
2058
|
+
}[];
|
|
2059
|
+
};
|
|
2451
2060
|
};
|
|
2061
|
+
};
|
|
2062
|
+
/** Bad request */
|
|
2063
|
+
400: unknown;
|
|
2064
|
+
/** Unauthorized */
|
|
2065
|
+
401: unknown;
|
|
2066
|
+
/** Not found */
|
|
2067
|
+
404: unknown;
|
|
2068
|
+
/** Internal server error */
|
|
2069
|
+
500: unknown;
|
|
2452
2070
|
};
|
|
2453
|
-
|
|
2454
|
-
|
|
2455
|
-
|
|
2456
|
-
|
|
2457
|
-
|
|
2458
|
-
|
|
2459
|
-
|
|
2460
|
-
|
|
2461
|
-
teamId: string;
|
|
2462
|
-
};
|
|
2463
|
-
cookie?: never;
|
|
2071
|
+
requestBody: {
|
|
2072
|
+
content: {
|
|
2073
|
+
"application/json": {
|
|
2074
|
+
/**
|
|
2075
|
+
* @description Internal action to perform on the team resource.
|
|
2076
|
+
* @enum {string}
|
|
2077
|
+
*/
|
|
2078
|
+
action?: "delete";
|
|
2464
2079
|
};
|
|
2465
|
-
|
|
2466
|
-
|
|
2467
|
-
|
|
2468
|
-
|
|
2469
|
-
|
|
2470
|
-
|
|
2471
|
-
|
|
2472
|
-
|
|
2473
|
-
|
|
2474
|
-
|
|
2475
|
-
|
|
2476
|
-
|
|
2477
|
-
|
|
2478
|
-
|
|
2479
|
-
|
|
2480
|
-
|
|
2481
|
-
|
|
2482
|
-
|
|
2483
|
-
|
|
2484
|
-
|
|
2485
|
-
|
|
2486
|
-
|
|
2487
|
-
|
|
2488
|
-
|
|
2489
|
-
|
|
2490
|
-
|
|
2491
|
-
|
|
2492
|
-
|
|
2493
|
-
|
|
2494
|
-
|
|
2495
|
-
|
|
2496
|
-
|
|
2497
|
-
|
|
2498
|
-
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
|
-
|
|
2510
|
-
|
|
2511
|
-
|
|
2512
|
-
|
|
2513
|
-
|
|
2514
|
-
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
|
-
|
|
2522
|
-
|
|
2523
|
-
/** @description Unauthorized */
|
|
2524
|
-
401: {
|
|
2525
|
-
headers: {
|
|
2526
|
-
[name: string]: unknown;
|
|
2527
|
-
};
|
|
2528
|
-
content?: never;
|
|
2529
|
-
};
|
|
2530
|
-
/** @description Not found */
|
|
2531
|
-
404: {
|
|
2532
|
-
headers: {
|
|
2533
|
-
[name: string]: unknown;
|
|
2534
|
-
};
|
|
2535
|
-
content?: never;
|
|
2536
|
-
};
|
|
2537
|
-
/** @description Internal server error */
|
|
2538
|
-
500: {
|
|
2539
|
-
headers: {
|
|
2540
|
-
[name: string]: unknown;
|
|
2541
|
-
};
|
|
2542
|
-
content?: never;
|
|
2543
|
-
};
|
|
2080
|
+
};
|
|
2081
|
+
};
|
|
2082
|
+
};
|
|
2083
|
+
/** Removes (unassigns) a team from an organization. */
|
|
2084
|
+
removeTeamFromOrg: {
|
|
2085
|
+
parameters: {
|
|
2086
|
+
path: {
|
|
2087
|
+
/** Organization ID. */
|
|
2088
|
+
orgId: string;
|
|
2089
|
+
/** Team ID. */
|
|
2090
|
+
teamId: string;
|
|
2091
|
+
};
|
|
2092
|
+
};
|
|
2093
|
+
responses: {
|
|
2094
|
+
/** Team removed from organization */
|
|
2095
|
+
200: {
|
|
2096
|
+
content: {
|
|
2097
|
+
"application/json": {
|
|
2098
|
+
/** @description Zero-based page index returned in this response. */
|
|
2099
|
+
page?: number;
|
|
2100
|
+
/** @description Maximum number of items returned on each page. */
|
|
2101
|
+
pageSize?: number;
|
|
2102
|
+
/** @description Total number of items across all pages. */
|
|
2103
|
+
totalCount?: number;
|
|
2104
|
+
/** @description Team-organization mapping entries. */
|
|
2105
|
+
teamsOrganizationsMapping?: {
|
|
2106
|
+
/**
|
|
2107
|
+
* Format: uuid
|
|
2108
|
+
* @description Mapping record ID.
|
|
2109
|
+
*/
|
|
2110
|
+
id?: string;
|
|
2111
|
+
/**
|
|
2112
|
+
* Format: uuid
|
|
2113
|
+
* @description Organization ID for this mapping.
|
|
2114
|
+
*/
|
|
2115
|
+
orgId?: string;
|
|
2116
|
+
/**
|
|
2117
|
+
* Format: uuid
|
|
2118
|
+
* @description Team ID for this mapping.
|
|
2119
|
+
*/
|
|
2120
|
+
teamId?: string;
|
|
2121
|
+
/**
|
|
2122
|
+
* Format: date-time
|
|
2123
|
+
* @description Timestamp when the mapping was created.
|
|
2124
|
+
*/
|
|
2125
|
+
createdAt?: string;
|
|
2126
|
+
/**
|
|
2127
|
+
* Format: date-time
|
|
2128
|
+
* @description Timestamp when the mapping was last updated.
|
|
2129
|
+
*/
|
|
2130
|
+
updatedAt?: string;
|
|
2131
|
+
/**
|
|
2132
|
+
* Format: date-time
|
|
2133
|
+
* @description Timestamp when the mapping was soft-deleted.
|
|
2134
|
+
*/
|
|
2135
|
+
deletedAt?: string;
|
|
2136
|
+
}[];
|
|
2137
|
+
};
|
|
2544
2138
|
};
|
|
2139
|
+
};
|
|
2140
|
+
/** Bad request */
|
|
2141
|
+
400: unknown;
|
|
2142
|
+
/** Unauthorized */
|
|
2143
|
+
401: unknown;
|
|
2144
|
+
/** Not found */
|
|
2145
|
+
404: unknown;
|
|
2146
|
+
/** Internal server error */
|
|
2147
|
+
500: unknown;
|
|
2545
2148
|
};
|
|
2546
|
-
|
|
2547
|
-
|
|
2548
|
-
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
|
|
2556
|
-
|
|
2149
|
+
};
|
|
2150
|
+
addUserToOrg: {
|
|
2151
|
+
parameters: {
|
|
2152
|
+
path: {
|
|
2153
|
+
/** Organization ID. */
|
|
2154
|
+
orgId: string;
|
|
2155
|
+
/** User ID. */
|
|
2156
|
+
userId: string;
|
|
2157
|
+
};
|
|
2158
|
+
};
|
|
2159
|
+
responses: {
|
|
2160
|
+
/** User added to organization */
|
|
2161
|
+
201: {
|
|
2162
|
+
content: {
|
|
2163
|
+
"application/json": { [key: string]: unknown };
|
|
2557
2164
|
};
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
[name: string]: unknown;
|
|
2564
|
-
};
|
|
2565
|
-
content: {
|
|
2566
|
-
"application/json": {
|
|
2567
|
-
[key: string]: unknown;
|
|
2568
|
-
};
|
|
2569
|
-
};
|
|
2570
|
-
};
|
|
2571
|
-
/** @description Invalid request body or request param */
|
|
2572
|
-
400: {
|
|
2573
|
-
headers: {
|
|
2574
|
-
[name: string]: unknown;
|
|
2575
|
-
};
|
|
2576
|
-
content: {
|
|
2577
|
-
"text/plain": string;
|
|
2578
|
-
};
|
|
2579
|
-
};
|
|
2580
|
-
/** @description Unauthorized */
|
|
2581
|
-
401: {
|
|
2582
|
-
headers: {
|
|
2583
|
-
[name: string]: unknown;
|
|
2584
|
-
};
|
|
2585
|
-
content?: never;
|
|
2586
|
-
};
|
|
2587
|
-
/** @description Result not found */
|
|
2588
|
-
404: {
|
|
2589
|
-
headers: {
|
|
2590
|
-
[name: string]: unknown;
|
|
2591
|
-
};
|
|
2592
|
-
content: {
|
|
2593
|
-
"text/plain": string;
|
|
2594
|
-
};
|
|
2595
|
-
};
|
|
2596
|
-
/** @description Internal server error */
|
|
2597
|
-
500: {
|
|
2598
|
-
headers: {
|
|
2599
|
-
[name: string]: unknown;
|
|
2600
|
-
};
|
|
2601
|
-
content?: never;
|
|
2602
|
-
};
|
|
2165
|
+
};
|
|
2166
|
+
/** Invalid request body or request param */
|
|
2167
|
+
400: {
|
|
2168
|
+
content: {
|
|
2169
|
+
"text/plain": string;
|
|
2603
2170
|
};
|
|
2604
|
-
|
|
2605
|
-
|
|
2606
|
-
|
|
2607
|
-
|
|
2608
|
-
|
|
2609
|
-
|
|
2610
|
-
|
|
2611
|
-
orgId: string;
|
|
2612
|
-
/** @description User ID. */
|
|
2613
|
-
userId: string;
|
|
2614
|
-
};
|
|
2615
|
-
cookie?: never;
|
|
2171
|
+
};
|
|
2172
|
+
/** Unauthorized */
|
|
2173
|
+
401: unknown;
|
|
2174
|
+
/** Result not found */
|
|
2175
|
+
404: {
|
|
2176
|
+
content: {
|
|
2177
|
+
"text/plain": string;
|
|
2616
2178
|
};
|
|
2617
|
-
|
|
2618
|
-
|
|
2619
|
-
|
|
2620
|
-
|
|
2621
|
-
|
|
2622
|
-
|
|
2623
|
-
|
|
2624
|
-
|
|
2625
|
-
|
|
2626
|
-
|
|
2627
|
-
|
|
2628
|
-
|
|
2629
|
-
|
|
2630
|
-
|
|
2631
|
-
|
|
2632
|
-
|
|
2633
|
-
|
|
2634
|
-
|
|
2635
|
-
|
|
2636
|
-
|
|
2637
|
-
|
|
2638
|
-
|
|
2639
|
-
|
|
2640
|
-
};
|
|
2641
|
-
};
|
|
2642
|
-
/** @description Internal server error */
|
|
2643
|
-
500: {
|
|
2644
|
-
headers: {
|
|
2645
|
-
[name: string]: unknown;
|
|
2646
|
-
};
|
|
2647
|
-
content?: never;
|
|
2648
|
-
};
|
|
2179
|
+
};
|
|
2180
|
+
/** Internal server error */
|
|
2181
|
+
500: unknown;
|
|
2182
|
+
};
|
|
2183
|
+
};
|
|
2184
|
+
deleteUserFromOrg: {
|
|
2185
|
+
parameters: {
|
|
2186
|
+
path: {
|
|
2187
|
+
/** Organization ID. */
|
|
2188
|
+
orgId: string;
|
|
2189
|
+
/** User ID. */
|
|
2190
|
+
userId: string;
|
|
2191
|
+
};
|
|
2192
|
+
};
|
|
2193
|
+
responses: {
|
|
2194
|
+
/** User removed from organization */
|
|
2195
|
+
204: never;
|
|
2196
|
+
/** Unauthorized */
|
|
2197
|
+
401: unknown;
|
|
2198
|
+
/** Result not found */
|
|
2199
|
+
404: {
|
|
2200
|
+
content: {
|
|
2201
|
+
"text/plain": string;
|
|
2649
2202
|
};
|
|
2203
|
+
};
|
|
2204
|
+
/** Internal server error */
|
|
2205
|
+
500: unknown;
|
|
2650
2206
|
};
|
|
2207
|
+
};
|
|
2651
2208
|
}
|
|
2209
|
+
|
|
2210
|
+
export interface external {}
|