@robinmordasiewicz/f5xc-api-mcp 3.0.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.
Files changed (212) hide show
  1. package/CHANGELOG.md +74 -0
  2. package/README.md +234 -0
  3. package/dist/auth/credential-manager.d.ts +116 -0
  4. package/dist/auth/credential-manager.d.ts.map +1 -0
  5. package/dist/auth/credential-manager.js +208 -0
  6. package/dist/auth/credential-manager.js.map +1 -0
  7. package/dist/auth/http-client.d.ts +81 -0
  8. package/dist/auth/http-client.d.ts.map +1 -0
  9. package/dist/auth/http-client.js +197 -0
  10. package/dist/auth/http-client.js.map +1 -0
  11. package/dist/auth/index.d.ts +8 -0
  12. package/dist/auth/index.d.ts.map +1 -0
  13. package/dist/auth/index.js +6 -0
  14. package/dist/auth/index.js.map +1 -0
  15. package/dist/generator/index.d.ts +7 -0
  16. package/dist/generator/index.d.ts.map +1 -0
  17. package/dist/generator/index.js +7 -0
  18. package/dist/generator/index.js.map +1 -0
  19. package/dist/generator/naming/acronyms.d.ts +81 -0
  20. package/dist/generator/naming/acronyms.d.ts.map +1 -0
  21. package/dist/generator/naming/acronyms.js +253 -0
  22. package/dist/generator/naming/acronyms.js.map +1 -0
  23. package/dist/generator/naming/index.d.ts +6 -0
  24. package/dist/generator/naming/index.d.ts.map +1 -0
  25. package/dist/generator/naming/index.js +6 -0
  26. package/dist/generator/naming/index.js.map +1 -0
  27. package/dist/generator/naming/volterra-mapping.d.ts +102 -0
  28. package/dist/generator/naming/volterra-mapping.d.ts.map +1 -0
  29. package/dist/generator/naming/volterra-mapping.js +259 -0
  30. package/dist/generator/naming/volterra-mapping.js.map +1 -0
  31. package/dist/generator/openapi-parser.d.ts +339 -0
  32. package/dist/generator/openapi-parser.d.ts.map +1 -0
  33. package/dist/generator/openapi-parser.js +463 -0
  34. package/dist/generator/openapi-parser.js.map +1 -0
  35. package/dist/generator/tool-generator.d.ts +74 -0
  36. package/dist/generator/tool-generator.d.ts.map +1 -0
  37. package/dist/generator/tool-generator.js +387 -0
  38. package/dist/generator/tool-generator.js.map +1 -0
  39. package/dist/generator/transformers/index.d.ts +7 -0
  40. package/dist/generator/transformers/index.d.ts.map +1 -0
  41. package/dist/generator/transformers/index.js +7 -0
  42. package/dist/generator/transformers/index.js.map +1 -0
  43. package/dist/generator/transformers/normalize-examples.d.ts +48 -0
  44. package/dist/generator/transformers/normalize-examples.d.ts.map +1 -0
  45. package/dist/generator/transformers/normalize-examples.js +66 -0
  46. package/dist/generator/transformers/normalize-examples.js.map +1 -0
  47. package/dist/index.d.ts +21 -0
  48. package/dist/index.d.ts.map +1 -0
  49. package/dist/index.js +70 -0
  50. package/dist/index.js.map +1 -0
  51. package/dist/prompts/index.d.ts +6 -0
  52. package/dist/prompts/index.d.ts.map +1 -0
  53. package/dist/prompts/index.js +5 -0
  54. package/dist/prompts/index.js.map +1 -0
  55. package/dist/prompts/workflows.d.ts +59 -0
  56. package/dist/prompts/workflows.d.ts.map +1 -0
  57. package/dist/prompts/workflows.js +585 -0
  58. package/dist/prompts/workflows.js.map +1 -0
  59. package/dist/resources/handlers.d.ts +72 -0
  60. package/dist/resources/handlers.d.ts.map +1 -0
  61. package/dist/resources/handlers.js +279 -0
  62. package/dist/resources/handlers.js.map +1 -0
  63. package/dist/resources/index.d.ts +8 -0
  64. package/dist/resources/index.d.ts.map +1 -0
  65. package/dist/resources/index.js +6 -0
  66. package/dist/resources/index.js.map +1 -0
  67. package/dist/resources/templates.d.ts +86 -0
  68. package/dist/resources/templates.d.ts.map +1 -0
  69. package/dist/resources/templates.js +248 -0
  70. package/dist/resources/templates.js.map +1 -0
  71. package/dist/server.d.ts +78 -0
  72. package/dist/server.d.ts.map +1 -0
  73. package/dist/server.js +426 -0
  74. package/dist/server.js.map +1 -0
  75. package/dist/tools/discovery/consolidate.d.ts +97 -0
  76. package/dist/tools/discovery/consolidate.d.ts.map +1 -0
  77. package/dist/tools/discovery/consolidate.js +200 -0
  78. package/dist/tools/discovery/consolidate.js.map +1 -0
  79. package/dist/tools/discovery/describe.d.ts +132 -0
  80. package/dist/tools/discovery/describe.d.ts.map +1 -0
  81. package/dist/tools/discovery/describe.js +206 -0
  82. package/dist/tools/discovery/describe.js.map +1 -0
  83. package/dist/tools/discovery/execute.d.ts +98 -0
  84. package/dist/tools/discovery/execute.d.ts.map +1 -0
  85. package/dist/tools/discovery/execute.js +251 -0
  86. package/dist/tools/discovery/execute.js.map +1 -0
  87. package/dist/tools/discovery/index-loader.d.ts +28 -0
  88. package/dist/tools/discovery/index-loader.d.ts.map +1 -0
  89. package/dist/tools/discovery/index-loader.js +69 -0
  90. package/dist/tools/discovery/index-loader.js.map +1 -0
  91. package/dist/tools/discovery/index.d.ts +185 -0
  92. package/dist/tools/discovery/index.d.ts.map +1 -0
  93. package/dist/tools/discovery/index.js +177 -0
  94. package/dist/tools/discovery/index.js.map +1 -0
  95. package/dist/tools/discovery/search.d.ts +41 -0
  96. package/dist/tools/discovery/search.d.ts.map +1 -0
  97. package/dist/tools/discovery/search.js +155 -0
  98. package/dist/tools/discovery/search.js.map +1 -0
  99. package/dist/tools/discovery/types.d.ts +70 -0
  100. package/dist/tools/discovery/types.d.ts.map +1 -0
  101. package/dist/tools/discovery/types.js +9 -0
  102. package/dist/tools/discovery/types.js.map +1 -0
  103. package/dist/tools/generated/ai_intelligence/index.d.ts +8 -0
  104. package/dist/tools/generated/ai_intelligence/index.d.ts.map +1 -0
  105. package/dist/tools/generated/ai_intelligence/index.js +282 -0
  106. package/dist/tools/generated/ai_intelligence/index.js.map +1 -0
  107. package/dist/tools/generated/api_security/index.d.ts +8 -0
  108. package/dist/tools/generated/api_security/index.d.ts.map +1 -0
  109. package/dist/tools/generated/api_security/index.js +1852 -0
  110. package/dist/tools/generated/api_security/index.js.map +1 -0
  111. package/dist/tools/generated/applications/index.d.ts +8 -0
  112. package/dist/tools/generated/applications/index.d.ts.map +1 -0
  113. package/dist/tools/generated/applications/index.js +1589 -0
  114. package/dist/tools/generated/applications/index.js.map +1 -0
  115. package/dist/tools/generated/bigip/index.d.ts +8 -0
  116. package/dist/tools/generated/bigip/index.d.ts.map +1 -0
  117. package/dist/tools/generated/bigip/index.js +1173 -0
  118. package/dist/tools/generated/bigip/index.js.map +1 -0
  119. package/dist/tools/generated/billing/index.d.ts +8 -0
  120. package/dist/tools/generated/billing/index.d.ts.map +1 -0
  121. package/dist/tools/generated/billing/index.js +759 -0
  122. package/dist/tools/generated/billing/index.js.map +1 -0
  123. package/dist/tools/generated/cdn/index.d.ts +8 -0
  124. package/dist/tools/generated/cdn/index.d.ts.map +1 -0
  125. package/dist/tools/generated/cdn/index.js +841 -0
  126. package/dist/tools/generated/cdn/index.js.map +1 -0
  127. package/dist/tools/generated/config/index.d.ts +8 -0
  128. package/dist/tools/generated/config/index.d.ts.map +1 -0
  129. package/dist/tools/generated/config/index.js +316 -0
  130. package/dist/tools/generated/config/index.js.map +1 -0
  131. package/dist/tools/generated/identity/index.d.ts +8 -0
  132. package/dist/tools/generated/identity/index.d.ts.map +1 -0
  133. package/dist/tools/generated/identity/index.js +5371 -0
  134. package/dist/tools/generated/identity/index.js.map +1 -0
  135. package/dist/tools/generated/infrastructure/index.d.ts +8 -0
  136. package/dist/tools/generated/infrastructure/index.d.ts.map +1 -0
  137. package/dist/tools/generated/infrastructure/index.js +5342 -0
  138. package/dist/tools/generated/infrastructure/index.js.map +1 -0
  139. package/dist/tools/generated/infrastructure_protection/index.d.ts +8 -0
  140. package/dist/tools/generated/infrastructure_protection/index.d.ts.map +1 -0
  141. package/dist/tools/generated/infrastructure_protection/index.js +2919 -0
  142. package/dist/tools/generated/infrastructure_protection/index.js.map +1 -0
  143. package/dist/tools/generated/integrations/index.d.ts +8 -0
  144. package/dist/tools/generated/integrations/index.d.ts.map +1 -0
  145. package/dist/tools/generated/integrations/index.js +1995 -0
  146. package/dist/tools/generated/integrations/index.js.map +1 -0
  147. package/dist/tools/generated/load_balancer/index.d.ts +8 -0
  148. package/dist/tools/generated/load_balancer/index.d.ts.map +1 -0
  149. package/dist/tools/generated/load_balancer/index.js +2269 -0
  150. package/dist/tools/generated/load_balancer/index.js.map +1 -0
  151. package/dist/tools/generated/networking/index.d.ts +8 -0
  152. package/dist/tools/generated/networking/index.d.ts.map +1 -0
  153. package/dist/tools/generated/networking/index.js +11289 -0
  154. package/dist/tools/generated/networking/index.js.map +1 -0
  155. package/dist/tools/generated/nginx/index.d.ts +8 -0
  156. package/dist/tools/generated/nginx/index.d.ts.map +1 -0
  157. package/dist/tools/generated/nginx/index.js +680 -0
  158. package/dist/tools/generated/nginx/index.js.map +1 -0
  159. package/dist/tools/generated/observability/index.d.ts +8 -0
  160. package/dist/tools/generated/observability/index.d.ts.map +1 -0
  161. package/dist/tools/generated/observability/index.js +6140 -0
  162. package/dist/tools/generated/observability/index.js.map +1 -0
  163. package/dist/tools/generated/operations/index.d.ts +8 -0
  164. package/dist/tools/generated/operations/index.d.ts.map +1 -0
  165. package/dist/tools/generated/operations/index.js +1759 -0
  166. package/dist/tools/generated/operations/index.js.map +1 -0
  167. package/dist/tools/generated/security/index.d.ts +8 -0
  168. package/dist/tools/generated/security/index.d.ts.map +1 -0
  169. package/dist/tools/generated/security/index.js +9111 -0
  170. package/dist/tools/generated/security/index.js.map +1 -0
  171. package/dist/tools/generated/service_mesh/index.d.ts +8 -0
  172. package/dist/tools/generated/service_mesh/index.d.ts.map +1 -0
  173. package/dist/tools/generated/service_mesh/index.js +1628 -0
  174. package/dist/tools/generated/service_mesh/index.js.map +1 -0
  175. package/dist/tools/generated/shape_security/index.d.ts +8 -0
  176. package/dist/tools/generated/shape_security/index.d.ts.map +1 -0
  177. package/dist/tools/generated/shape_security/index.js +4121 -0
  178. package/dist/tools/generated/shape_security/index.js.map +1 -0
  179. package/dist/tools/generated/subscriptions/index.d.ts +8 -0
  180. package/dist/tools/generated/subscriptions/index.d.ts.map +1 -0
  181. package/dist/tools/generated/subscriptions/index.js +778 -0
  182. package/dist/tools/generated/subscriptions/index.js.map +1 -0
  183. package/dist/tools/generated/tenant_management/index.d.ts +8 -0
  184. package/dist/tools/generated/tenant_management/index.d.ts.map +1 -0
  185. package/dist/tools/generated/tenant_management/index.js +2292 -0
  186. package/dist/tools/generated/tenant_management/index.js.map +1 -0
  187. package/dist/tools/generated/vpn/index.d.ts +8 -0
  188. package/dist/tools/generated/vpn/index.d.ts.map +1 -0
  189. package/dist/tools/generated/vpn/index.js +1183 -0
  190. package/dist/tools/generated/vpn/index.js.map +1 -0
  191. package/dist/tools/index.d.ts +7 -0
  192. package/dist/tools/index.d.ts.map +1 -0
  193. package/dist/tools/index.js +6 -0
  194. package/dist/tools/index.js.map +1 -0
  195. package/dist/tools/registry.d.ts +27 -0
  196. package/dist/tools/registry.d.ts.map +1 -0
  197. package/dist/tools/registry.js +83 -0
  198. package/dist/tools/registry.js.map +1 -0
  199. package/dist/utils/error-handling.d.ts +109 -0
  200. package/dist/utils/error-handling.d.ts.map +1 -0
  201. package/dist/utils/error-handling.js +239 -0
  202. package/dist/utils/error-handling.js.map +1 -0
  203. package/dist/utils/index.d.ts +7 -0
  204. package/dist/utils/index.d.ts.map +1 -0
  205. package/dist/utils/index.js +6 -0
  206. package/dist/utils/index.js.map +1 -0
  207. package/dist/utils/logging.d.ts +75 -0
  208. package/dist/utils/logging.d.ts.map +1 -0
  209. package/dist/utils/logging.js +131 -0
  210. package/dist/utils/logging.js.map +1 -0
  211. package/manifest.json +143 -0
  212. package/package.json +95 -0
@@ -0,0 +1,2292 @@
1
+ /**
2
+ * Generated tool definitions for tenant_management domain
3
+ * DO NOT EDIT - This file is auto-generated by scripts/generate.ts
4
+ */
5
+ export const tenant_managementTools = [
6
+ {
7
+ toolName: "f5xc-api-tenantmanagement-acces-create",
8
+ method: "POST",
9
+ path: "/api/web/namespaces/system/allowed_tenants/support-tenant/access",
10
+ operation: "create",
11
+ domain: "tenant_management",
12
+ resource: "acces",
13
+ summary: "Update Support Tenant Access.",
14
+ description: "This RPC can be used to manage user access for all flavors of support tenants currently\nsupported by the platform. Use read-only, read-write with specific namespaces or\nadmin can specify custom groups to control access by the support tenant user.\nName is well-known identifier for a specific support related tenant.",
15
+ pathParameters: [],
16
+ queryParameters: [],
17
+ requestBodySchema: {
18
+ $ref: "#/components/schemas/allowed_tenantUpdateSupportTenantAccessReq",
19
+ },
20
+ responseSchema: {
21
+ $ref: "#/components/schemas/allowed_tenantUpdateSupportTenantAccessResp",
22
+ },
23
+ requiredParams: ["body"],
24
+ operationId: "ves.io.schema.tenant_management.allowed_tenant.CustomAPI.UpdateSupportTenantAccess",
25
+ tags: ["Other"],
26
+ sourceFile: "domains/tenant_management.json",
27
+ },
28
+ {
29
+ toolName: "f5xc-api-tenantmanagement-acces-list",
30
+ method: "GET",
31
+ path: "/api/web/namespaces/system/allowed_tenants/support-tenant/access",
32
+ operation: "list",
33
+ domain: "tenant_management",
34
+ resource: "acces",
35
+ summary: "GET Support Tenant Access.",
36
+ description: "GET current access details for the support tenant.",
37
+ pathParameters: [],
38
+ queryParameters: [],
39
+ requestBodySchema: null,
40
+ responseSchema: {
41
+ $ref: "#/components/schemas/allowed_tenantGetSupportTenantAccessResp",
42
+ },
43
+ requiredParams: [],
44
+ operationId: "ves.io.schema.tenant_management.allowed_tenant.CustomAPI.GetSupportTenantAccess",
45
+ tags: ["Other"],
46
+ sourceFile: "domains/tenant_management.json",
47
+ },
48
+ {
49
+ toolName: "f5xc-api-tenantmanagement-allowed-tenant-create",
50
+ method: "POST",
51
+ path: "/api/web/namespaces/{metadata.namespace}/allowed_tenants",
52
+ operation: "create",
53
+ domain: "tenant_management",
54
+ resource: "allowed-tenant",
55
+ summary: "Create Allowed Tenant.",
56
+ description: "Creates a allowed_tenant config instance. Name of the object is name of the tenant that is allowed to manage.",
57
+ pathParameters: [
58
+ {
59
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
60
+ in: "path",
61
+ name: "metadata.namespace",
62
+ required: true,
63
+ schema: {
64
+ type: "string",
65
+ },
66
+ },
67
+ ],
68
+ queryParameters: [],
69
+ requestBodySchema: {
70
+ $ref: "#/components/schemas/tenant_managementallowed_tenantCreateRequest",
71
+ },
72
+ responseSchema: {
73
+ $ref: "#/components/schemas/tenant_managementallowed_tenantCreateResponse",
74
+ },
75
+ requiredParams: ["body", "metadata.namespace"],
76
+ operationId: "ves.io.schema.tenant_management.allowed_tenant.API.Create",
77
+ tags: ["Other"],
78
+ sourceFile: "domains/tenant_management.json",
79
+ },
80
+ {
81
+ toolName: "f5xc-api-tenantmanagement-allowed-tenant-delete",
82
+ method: "DELETE",
83
+ path: "/api/web/namespaces/{namespace}/allowed_tenants/{name}",
84
+ operation: "delete",
85
+ domain: "tenant_management",
86
+ resource: "allowed-tenant",
87
+ summary: "DELETE Allowed Tenant.",
88
+ description: "DELETE the specified allowed_tenant.",
89
+ pathParameters: [
90
+ {
91
+ description: "Name\nName of the configuration object.",
92
+ in: "path",
93
+ name: "name",
94
+ required: true,
95
+ schema: {
96
+ type: "string",
97
+ },
98
+ },
99
+ {
100
+ description: "Namespace\nNamespace in which the configuration object is present.",
101
+ in: "path",
102
+ name: "namespace",
103
+ required: true,
104
+ schema: {
105
+ type: "string",
106
+ },
107
+ },
108
+ ],
109
+ queryParameters: [],
110
+ requestBodySchema: {
111
+ $ref: "#/components/schemas/allowed_tenantDeleteRequest",
112
+ },
113
+ responseSchema: {},
114
+ requiredParams: ["body", "name", "namespace"],
115
+ operationId: "ves.io.schema.tenant_management.allowed_tenant.API.Delete",
116
+ tags: ["Other"],
117
+ sourceFile: "domains/tenant_management.json",
118
+ },
119
+ {
120
+ toolName: "f5xc-api-tenantmanagement-allowed-tenant-get",
121
+ method: "GET",
122
+ path: "/api/web/namespaces/{namespace}/allowed_tenants/{name}",
123
+ operation: "get",
124
+ domain: "tenant_management",
125
+ resource: "allowed-tenant",
126
+ summary: "GET Allowed Tenant.",
127
+ description: "GET allowed_tenant reads a given object from storage backend for metadata.namespace.",
128
+ pathParameters: [
129
+ {
130
+ description: "Name\nThe name of the configuration object to be fetched.",
131
+ in: "path",
132
+ name: "name",
133
+ required: true,
134
+ schema: {
135
+ type: "string",
136
+ },
137
+ },
138
+ {
139
+ description: "Namespace\nThe namespace in which the configuration object is present.",
140
+ in: "path",
141
+ name: "namespace",
142
+ required: true,
143
+ schema: {
144
+ type: "string",
145
+ },
146
+ },
147
+ ],
148
+ queryParameters: [
149
+ {
150
+ description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
151
+ in: "query",
152
+ name: "response_format",
153
+ required: false,
154
+ schema: {
155
+ default: "GET_RSP_FORMAT_DEFAULT",
156
+ enum: [
157
+ "GET_RSP_FORMAT_DEFAULT",
158
+ "GET_RSP_FORMAT_FOR_CREATE",
159
+ "GET_RSP_FORMAT_FOR_REPLACE",
160
+ "GET_RSP_FORMAT_STATUS",
161
+ "GET_RSP_FORMAT_READ",
162
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
163
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
164
+ ],
165
+ type: "string",
166
+ },
167
+ },
168
+ ],
169
+ requestBodySchema: null,
170
+ responseSchema: {
171
+ $ref: "#/components/schemas/tenant_managementallowed_tenantGetResponse",
172
+ },
173
+ requiredParams: ["name", "namespace"],
174
+ operationId: "ves.io.schema.tenant_management.allowed_tenant.API.Get",
175
+ tags: ["Other"],
176
+ sourceFile: "domains/tenant_management.json",
177
+ },
178
+ {
179
+ toolName: "f5xc-api-tenantmanagement-allowed-tenant-list",
180
+ method: "GET",
181
+ path: "/api/web/namespaces/{namespace}/allowed_tenants",
182
+ operation: "list",
183
+ domain: "tenant_management",
184
+ resource: "allowed-tenant",
185
+ summary: "List Allowed Tenant.",
186
+ description: "List the set of allowed_tenant in a namespace.",
187
+ pathParameters: [
188
+ {
189
+ description: "Namespace\nNamespace to scope the listing of allowed_tenant.",
190
+ in: "path",
191
+ name: "namespace",
192
+ required: true,
193
+ schema: {
194
+ type: "string",
195
+ },
196
+ },
197
+ ],
198
+ queryParameters: [
199
+ {
200
+ description: "A LabelSelectorType expression that every item in list response will satisfy.",
201
+ in: "query",
202
+ name: "label_filter",
203
+ required: false,
204
+ schema: {
205
+ type: "string",
206
+ },
207
+ },
208
+ {
209
+ description: 'X-example: ""\nExtra fields to return along with summary fields.',
210
+ in: "query",
211
+ name: "report_fields",
212
+ required: false,
213
+ schema: {
214
+ items: {
215
+ type: "string",
216
+ },
217
+ type: "array",
218
+ },
219
+ },
220
+ {
221
+ description: 'X-example: ""\nExtra status fields to return along with summary fields.',
222
+ in: "query",
223
+ name: "report_status_fields",
224
+ required: false,
225
+ schema: {
226
+ items: {
227
+ type: "string",
228
+ },
229
+ type: "array",
230
+ },
231
+ },
232
+ ],
233
+ requestBodySchema: null,
234
+ responseSchema: {
235
+ $ref: "#/components/schemas/tenant_managementallowed_tenantListResponse",
236
+ },
237
+ requiredParams: ["namespace"],
238
+ operationId: "ves.io.schema.tenant_management.allowed_tenant.API.List",
239
+ tags: ["Other"],
240
+ sourceFile: "domains/tenant_management.json",
241
+ },
242
+ {
243
+ toolName: "f5xc-api-tenantmanagement-allowed-tenant-update",
244
+ method: "PUT",
245
+ path: "/api/web/namespaces/{metadata.namespace}/allowed_tenants/{metadata.name}",
246
+ operation: "update",
247
+ domain: "tenant_management",
248
+ resource: "allowed-tenant",
249
+ summary: "Replace Allowed Tenant.",
250
+ description: "Replaces attributes of a allowed_tenant instance including its metadata like labels, description etc.",
251
+ pathParameters: [
252
+ {
253
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
254
+ in: "path",
255
+ name: "metadata.name",
256
+ required: true,
257
+ schema: {
258
+ type: "string",
259
+ },
260
+ },
261
+ {
262
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
263
+ in: "path",
264
+ name: "metadata.namespace",
265
+ required: true,
266
+ schema: {
267
+ type: "string",
268
+ },
269
+ },
270
+ ],
271
+ queryParameters: [],
272
+ requestBodySchema: {
273
+ $ref: "#/components/schemas/allowed_tenantReplaceRequest",
274
+ },
275
+ responseSchema: {
276
+ $ref: "#/components/schemas/allowed_tenantReplaceResponse",
277
+ },
278
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
279
+ operationId: "ves.io.schema.tenant_management.allowed_tenant.API.Replace",
280
+ tags: ["Other"],
281
+ sourceFile: "domains/tenant_management.json",
282
+ },
283
+ {
284
+ toolName: "f5xc-api-tenantmanagement-assign-create",
285
+ method: "POST",
286
+ path: "/api/web/namespaces/system/tenant/domain_owner/assign",
287
+ operation: "create",
288
+ domain: "tenant_management",
289
+ resource: "assign",
290
+ summary: "Assign domain owner.",
291
+ description: "Assign domain owner tries to assign domain owner to user in the request. It checks that requester is domain owner as well.\nIt implies such steps:\n1) mark user as domain owner\n2) if user is SSO\n- mark user as F5 Distributed Cloud managed\n- send update password email\n3) set admin roles in system, shared, * namespaces\nNOTE: previous roles (which was explicitly assigned to this user) will be deleted.",
292
+ pathParameters: [],
293
+ queryParameters: [],
294
+ requestBodySchema: {
295
+ $ref: "#/components/schemas/tenantAssignDomainOwnerRequest",
296
+ },
297
+ responseSchema: {
298
+ $ref: "#/components/schemas/schematenantEmpty",
299
+ },
300
+ requiredParams: ["body"],
301
+ operationId: "ves.io.schema.tenant.CustomAPI.AssignDomainOwner",
302
+ tags: ["Tenant Management"],
303
+ sourceFile: "domains/tenant_management.json",
304
+ },
305
+ {
306
+ toolName: "f5xc-api-tenantmanagement-child-tenant-create",
307
+ method: "POST",
308
+ path: "/api/web/namespaces/{metadata.namespace}/child_tenants",
309
+ operation: "create",
310
+ domain: "tenant_management",
311
+ resource: "child-tenant",
312
+ summary: "Child Tenant.",
313
+ description: "Creates a child_tenant config instance. Name of the object is the name of the child tenant to be created.",
314
+ pathParameters: [
315
+ {
316
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
317
+ in: "path",
318
+ name: "metadata.namespace",
319
+ required: true,
320
+ schema: {
321
+ type: "string",
322
+ },
323
+ },
324
+ ],
325
+ queryParameters: [],
326
+ requestBodySchema: {
327
+ $ref: "#/components/schemas/tenant_managementchild_tenantCreateRequest",
328
+ },
329
+ responseSchema: {
330
+ $ref: "#/components/schemas/tenant_managementchild_tenantCreateResponse",
331
+ },
332
+ requiredParams: ["body", "metadata.namespace"],
333
+ operationId: "ves.io.schema.tenant_management.child_tenant.API.Create",
334
+ tags: ["Other"],
335
+ sourceFile: "domains/tenant_management.json",
336
+ },
337
+ {
338
+ toolName: "f5xc-api-tenantmanagement-child-tenant-delete",
339
+ method: "DELETE",
340
+ path: "/api/web/namespaces/{namespace}/child_tenants/{name}",
341
+ operation: "delete",
342
+ domain: "tenant_management",
343
+ resource: "child-tenant",
344
+ summary: "DELETE Child Tenant.",
345
+ description: "DELETE the specified child_tenant.",
346
+ pathParameters: [
347
+ {
348
+ description: "Name\nName of the configuration object.",
349
+ in: "path",
350
+ name: "name",
351
+ required: true,
352
+ schema: {
353
+ type: "string",
354
+ },
355
+ },
356
+ {
357
+ description: "Namespace\nNamespace in which the configuration object is present.",
358
+ in: "path",
359
+ name: "namespace",
360
+ required: true,
361
+ schema: {
362
+ type: "string",
363
+ },
364
+ },
365
+ ],
366
+ queryParameters: [],
367
+ requestBodySchema: {
368
+ $ref: "#/components/schemas/child_tenantDeleteRequest",
369
+ },
370
+ responseSchema: {},
371
+ requiredParams: ["body", "name", "namespace"],
372
+ operationId: "ves.io.schema.tenant_management.child_tenant.API.Delete",
373
+ tags: ["Other"],
374
+ sourceFile: "domains/tenant_management.json",
375
+ },
376
+ {
377
+ toolName: "f5xc-api-tenantmanagement-child-tenant-get",
378
+ method: "GET",
379
+ path: "/api/web/namespaces/system/partner-management/child_tenant_managers/{name}/child_tenants",
380
+ operation: "get",
381
+ domain: "tenant_management",
382
+ resource: "child-tenant",
383
+ summary: "List child tenants for a given child tenant manager.",
384
+ description: "GET list of child tenants managed by a child tenant manager.",
385
+ pathParameters: [
386
+ {
387
+ description: "Name\n\nx-required\nName of the Child Tenant Manager.",
388
+ in: "path",
389
+ name: "name",
390
+ required: true,
391
+ schema: {
392
+ type: "string",
393
+ },
394
+ },
395
+ ],
396
+ queryParameters: [],
397
+ requestBodySchema: null,
398
+ responseSchema: {
399
+ $ref: "#/components/schemas/child_tenant_managerListChildTenantsByCTMResp",
400
+ },
401
+ requiredParams: ["name"],
402
+ operationId: "ves.io.schema.tenant_management.child_tenant_manager.CustomAPI.ListChildTenants",
403
+ tags: ["Other"],
404
+ sourceFile: "domains/tenant_management.json",
405
+ },
406
+ {
407
+ toolName: "f5xc-api-tenantmanagement-child-tenant-list",
408
+ method: "GET",
409
+ path: "/api/web/namespaces/system/partner-management/child_tenants",
410
+ operation: "list",
411
+ domain: "tenant_management",
412
+ resource: "child-tenant",
413
+ summary: "List of Child Tenants.",
414
+ description: "GET list of child tenants user has access to based on assigned membership.\nThis is an optimized list generated based on the requesting user's current group assignments\nthat will allow access to child tenant.",
415
+ pathParameters: [],
416
+ queryParameters: [
417
+ {
418
+ description: "Name of the Child Tenant Manager.\nIf this field set, child tenant list will be filtered by given CTM.",
419
+ in: "query",
420
+ name: "ctm",
421
+ required: false,
422
+ schema: {
423
+ type: "string",
424
+ },
425
+ },
426
+ {
427
+ description: "Filter child tenant list using name of child tenant.",
428
+ in: "query",
429
+ name: "name",
430
+ required: false,
431
+ schema: {
432
+ type: "string",
433
+ },
434
+ },
435
+ {
436
+ description: "PageLimit will hold the limit of items required per query.\nDefault value is set as 100.",
437
+ in: "query",
438
+ name: "page_limit",
439
+ required: false,
440
+ schema: {
441
+ format: "int32",
442
+ type: "integer",
443
+ },
444
+ },
445
+ {
446
+ description: "PageStart will hold the UUID of the first item in the requested page.\nResponse will contain items upto count specified in PageLimit starting from PageStart.\nIf this is empty then first page will be served.",
447
+ in: "query",
448
+ name: "page_start",
449
+ required: false,
450
+ schema: {
451
+ type: "string",
452
+ },
453
+ },
454
+ ],
455
+ requestBodySchema: null,
456
+ responseSchema: {
457
+ $ref: "#/components/schemas/child_tenantListChildTenantsResp",
458
+ },
459
+ requiredParams: [],
460
+ operationId: "ves.io.schema.tenant_management.child_tenant.CustomAPI.ListChildTenants",
461
+ tags: ["Other"],
462
+ sourceFile: "domains/tenant_management.json",
463
+ },
464
+ {
465
+ toolName: "f5xc-api-tenantmanagement-child-tenant-manager-create",
466
+ method: "POST",
467
+ path: "/api/web/namespaces/{metadata.namespace}/child_tenant_managers",
468
+ operation: "create",
469
+ domain: "tenant_management",
470
+ resource: "child-tenant-manager",
471
+ summary: "Child Tenant Manager.",
472
+ description: "Creates a child_tenant_manager config instance. Name of the object is the name of the child tenant manager to be created.",
473
+ pathParameters: [
474
+ {
475
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
476
+ in: "path",
477
+ name: "metadata.namespace",
478
+ required: true,
479
+ schema: {
480
+ type: "string",
481
+ },
482
+ },
483
+ ],
484
+ queryParameters: [],
485
+ requestBodySchema: {
486
+ $ref: "#/components/schemas/tenant_managementchild_tenant_managerCreateRequest",
487
+ },
488
+ responseSchema: {
489
+ $ref: "#/components/schemas/tenant_managementchild_tenant_managerCreateResponse",
490
+ },
491
+ requiredParams: ["body", "metadata.namespace"],
492
+ operationId: "ves.io.schema.tenant_management.child_tenant_manager.API.Create",
493
+ tags: ["Other"],
494
+ sourceFile: "domains/tenant_management.json",
495
+ },
496
+ {
497
+ toolName: "f5xc-api-tenantmanagement-child-tenant-manager-delete",
498
+ method: "DELETE",
499
+ path: "/api/web/namespaces/{namespace}/child_tenant_managers/{name}",
500
+ operation: "delete",
501
+ domain: "tenant_management",
502
+ resource: "child-tenant-manager",
503
+ summary: "DELETE Child Tenant Manager.",
504
+ description: "DELETE the specified child_tenant_manager.",
505
+ pathParameters: [
506
+ {
507
+ description: "Name\nName of the configuration object.",
508
+ in: "path",
509
+ name: "name",
510
+ required: true,
511
+ schema: {
512
+ type: "string",
513
+ },
514
+ },
515
+ {
516
+ description: "Namespace\nNamespace in which the configuration object is present.",
517
+ in: "path",
518
+ name: "namespace",
519
+ required: true,
520
+ schema: {
521
+ type: "string",
522
+ },
523
+ },
524
+ ],
525
+ queryParameters: [],
526
+ requestBodySchema: {
527
+ $ref: "#/components/schemas/child_tenant_managerDeleteRequest",
528
+ },
529
+ responseSchema: {},
530
+ requiredParams: ["body", "name", "namespace"],
531
+ operationId: "ves.io.schema.tenant_management.child_tenant_manager.API.Delete",
532
+ tags: ["Other"],
533
+ sourceFile: "domains/tenant_management.json",
534
+ },
535
+ {
536
+ toolName: "f5xc-api-tenantmanagement-child-tenant-manager-get",
537
+ method: "GET",
538
+ path: "/api/web/namespaces/{namespace}/child_tenant_managers/{name}",
539
+ operation: "get",
540
+ domain: "tenant_management",
541
+ resource: "child-tenant-manager",
542
+ summary: "GET Child Tenant Manager.",
543
+ description: "GET child_tenant_manager reads a given object from storage backend for metadata.namespace.",
544
+ pathParameters: [
545
+ {
546
+ description: "Name\nThe name of the configuration object to be fetched.",
547
+ in: "path",
548
+ name: "name",
549
+ required: true,
550
+ schema: {
551
+ type: "string",
552
+ },
553
+ },
554
+ {
555
+ description: "Namespace\nThe namespace in which the configuration object is present.",
556
+ in: "path",
557
+ name: "namespace",
558
+ required: true,
559
+ schema: {
560
+ type: "string",
561
+ },
562
+ },
563
+ ],
564
+ queryParameters: [
565
+ {
566
+ description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
567
+ in: "query",
568
+ name: "response_format",
569
+ required: false,
570
+ schema: {
571
+ default: "GET_RSP_FORMAT_DEFAULT",
572
+ enum: [
573
+ "GET_RSP_FORMAT_DEFAULT",
574
+ "GET_RSP_FORMAT_FOR_CREATE",
575
+ "GET_RSP_FORMAT_FOR_REPLACE",
576
+ "GET_RSP_FORMAT_READ",
577
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
578
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
579
+ ],
580
+ type: "string",
581
+ },
582
+ },
583
+ ],
584
+ requestBodySchema: null,
585
+ responseSchema: {
586
+ $ref: "#/components/schemas/tenant_managementchild_tenant_managerGetResponse",
587
+ },
588
+ requiredParams: ["name", "namespace"],
589
+ operationId: "ves.io.schema.tenant_management.child_tenant_manager.API.Get",
590
+ tags: ["Other"],
591
+ sourceFile: "domains/tenant_management.json",
592
+ },
593
+ {
594
+ toolName: "f5xc-api-tenantmanagement-child-tenant-manager-list",
595
+ method: "GET",
596
+ path: "/api/web/namespaces/{namespace}/child_tenant_managers",
597
+ operation: "list",
598
+ domain: "tenant_management",
599
+ resource: "child-tenant-manager",
600
+ summary: "List Child Tenant Manager.",
601
+ description: "List the set of child_tenant_manager in a namespace.",
602
+ pathParameters: [
603
+ {
604
+ description: "Namespace\nNamespace to scope the listing of child_tenant_manager.",
605
+ in: "path",
606
+ name: "namespace",
607
+ required: true,
608
+ schema: {
609
+ type: "string",
610
+ },
611
+ },
612
+ ],
613
+ queryParameters: [
614
+ {
615
+ description: "A LabelSelectorType expression that every item in list response will satisfy.",
616
+ in: "query",
617
+ name: "label_filter",
618
+ required: false,
619
+ schema: {
620
+ type: "string",
621
+ },
622
+ },
623
+ {
624
+ description: 'X-example: ""\nExtra fields to return along with summary fields.',
625
+ in: "query",
626
+ name: "report_fields",
627
+ required: false,
628
+ schema: {
629
+ items: {
630
+ type: "string",
631
+ },
632
+ type: "array",
633
+ },
634
+ },
635
+ {
636
+ description: 'X-example: ""\nExtra status fields to return along with summary fields.',
637
+ in: "query",
638
+ name: "report_status_fields",
639
+ required: false,
640
+ schema: {
641
+ items: {
642
+ type: "string",
643
+ },
644
+ type: "array",
645
+ },
646
+ },
647
+ ],
648
+ requestBodySchema: null,
649
+ responseSchema: {
650
+ $ref: "#/components/schemas/tenant_managementchild_tenant_managerListResponse",
651
+ },
652
+ requiredParams: ["namespace"],
653
+ operationId: "ves.io.schema.tenant_management.child_tenant_manager.API.List",
654
+ tags: ["Other"],
655
+ sourceFile: "domains/tenant_management.json",
656
+ },
657
+ {
658
+ toolName: "f5xc-api-tenantmanagement-child-tenant-manager-update",
659
+ method: "PUT",
660
+ path: "/api/web/namespaces/{metadata.namespace}/child_tenant_managers/{metadata.name}",
661
+ operation: "update",
662
+ domain: "tenant_management",
663
+ resource: "child-tenant-manager",
664
+ summary: "Replace Child Tenant Manager.",
665
+ description: "Replaces attributes of a child_tenant_manager configuration.",
666
+ pathParameters: [
667
+ {
668
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
669
+ in: "path",
670
+ name: "metadata.name",
671
+ required: true,
672
+ schema: {
673
+ type: "string",
674
+ },
675
+ },
676
+ {
677
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
678
+ in: "path",
679
+ name: "metadata.namespace",
680
+ required: true,
681
+ schema: {
682
+ type: "string",
683
+ },
684
+ },
685
+ ],
686
+ queryParameters: [],
687
+ requestBodySchema: {
688
+ $ref: "#/components/schemas/child_tenant_managerReplaceRequest",
689
+ },
690
+ responseSchema: {
691
+ $ref: "#/components/schemas/child_tenant_managerReplaceResponse",
692
+ },
693
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
694
+ operationId: "ves.io.schema.tenant_management.child_tenant_manager.API.Replace",
695
+ tags: ["Other"],
696
+ sourceFile: "domains/tenant_management.json",
697
+ },
698
+ {
699
+ toolName: "f5xc-api-tenantmanagement-child-tenant-update",
700
+ method: "PUT",
701
+ path: "/api/web/namespaces/{metadata.namespace}/child_tenants/{metadata.name}",
702
+ operation: "update",
703
+ domain: "tenant_management",
704
+ resource: "child-tenant",
705
+ summary: "Replace Child Tenant.",
706
+ description: "Replaces attributes of a child_tenant configuration.",
707
+ pathParameters: [
708
+ {
709
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
710
+ in: "path",
711
+ name: "metadata.name",
712
+ required: true,
713
+ schema: {
714
+ type: "string",
715
+ },
716
+ },
717
+ {
718
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
719
+ in: "path",
720
+ name: "metadata.namespace",
721
+ required: true,
722
+ schema: {
723
+ type: "string",
724
+ },
725
+ },
726
+ ],
727
+ queryParameters: [],
728
+ requestBodySchema: {
729
+ $ref: "#/components/schemas/child_tenantReplaceRequest",
730
+ },
731
+ responseSchema: {
732
+ $ref: "#/components/schemas/child_tenantReplaceResponse",
733
+ },
734
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
735
+ operationId: "ves.io.schema.tenant_management.child_tenant.API.Replace",
736
+ tags: ["Other"],
737
+ sourceFile: "domains/tenant_management.json",
738
+ },
739
+ {
740
+ toolName: "f5xc-api-tenantmanagement-close-create",
741
+ method: "POST",
742
+ path: "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/close",
743
+ operation: "create",
744
+ domain: "tenant_management",
745
+ resource: "close",
746
+ summary: "Close a customer support ticket in managed tenant.",
747
+ description: "Closes selected customer support ticket (if not already closed). You can always attempt to reopen if needed to be.",
748
+ pathParameters: [
749
+ {
750
+ description: "Third party ID\nID assigned to this ticket by our support provider.",
751
+ in: "path",
752
+ name: "tp_id",
753
+ required: true,
754
+ schema: {
755
+ type: "string",
756
+ },
757
+ },
758
+ ],
759
+ queryParameters: [],
760
+ requestBodySchema: null,
761
+ responseSchema: {
762
+ $ref: "#/components/schemas/customer_supportCloseResponse",
763
+ },
764
+ requiredParams: ["tp_id"],
765
+ operationId: "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Close",
766
+ tags: ["Other"],
767
+ sourceFile: "domains/tenant_management.json",
768
+ },
769
+ {
770
+ toolName: "f5xc-api-tenantmanagement-comment-create",
771
+ method: "POST",
772
+ path: "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/comment",
773
+ operation: "create",
774
+ domain: "tenant_management",
775
+ resource: "comment",
776
+ summary: "Add comment to a customer support ticket in managed tenant.",
777
+ description: "Adds additional comment to a specified customer support ticket. The comment may include an attachment.",
778
+ pathParameters: [
779
+ {
780
+ description: "Third party ID\nID assigned to this ticket by our support provider.",
781
+ in: "path",
782
+ name: "tp_id",
783
+ required: true,
784
+ schema: {
785
+ type: "string",
786
+ },
787
+ },
788
+ ],
789
+ queryParameters: [],
790
+ requestBodySchema: {
791
+ $ref: "#/components/schemas/schematenant_managementCommentRequest",
792
+ },
793
+ responseSchema: {
794
+ $ref: "#/components/schemas/customer_supportCommentResponse",
795
+ },
796
+ requiredParams: ["body", "tp_id"],
797
+ operationId: "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Comment",
798
+ tags: ["Other"],
799
+ sourceFile: "domains/tenant_management.json",
800
+ },
801
+ {
802
+ toolName: "f5xc-api-tenantmanagement-customer-support-create",
803
+ method: "POST",
804
+ path: "/api/web/namespaces/system/managed_client/customer_supports",
805
+ operation: "create",
806
+ domain: "tenant_management",
807
+ resource: "customer-support",
808
+ summary: "Create customer support ticket in managed tenant.",
809
+ description: "Creates a new customer support ticket in our customer support provider system.",
810
+ pathParameters: [],
811
+ queryParameters: [],
812
+ requestBodySchema: {
813
+ $ref: "#/components/schemas/schemacustomer_supportCreateRequest",
814
+ },
815
+ responseSchema: {
816
+ $ref: "#/components/schemas/schemacustomer_supportCreateResponse",
817
+ },
818
+ requiredParams: ["body"],
819
+ operationId: "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Create",
820
+ tags: ["Other"],
821
+ sourceFile: "domains/tenant_management.json",
822
+ },
823
+ {
824
+ toolName: "f5xc-api-tenantmanagement-customer-support-list",
825
+ method: "GET",
826
+ path: "/api/web/namespaces/system/managed_client/customer_supports",
827
+ operation: "list",
828
+ domain: "tenant_management",
829
+ resource: "customer-support",
830
+ summary: "List tickets of managed tenant.",
831
+ description: "Returns list of customer support tickets of managed tenant.",
832
+ pathParameters: [],
833
+ queryParameters: [],
834
+ requestBodySchema: null,
835
+ responseSchema: {
836
+ $ref: "#/components/schemas/tenant_managementListSupportTicketResponse",
837
+ },
838
+ requiredParams: [],
839
+ operationId: "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.List",
840
+ tags: ["Other"],
841
+ sourceFile: "domains/tenant_management.json",
842
+ },
843
+ {
844
+ toolName: "f5xc-api-tenantmanagement-deactivate-update",
845
+ method: "PUT",
846
+ path: "/api/saas/namespaces/system/v2/tenant/deactivate",
847
+ operation: "update",
848
+ domain: "tenant_management",
849
+ resource: "deactivate",
850
+ summary: "DeactivateTenant.",
851
+ description: "This API mark tenant for deletion queue, after approve it will completely removed from the system. This API proxies the request to eywa’s tenant disable API.",
852
+ pathParameters: [],
853
+ queryParameters: [],
854
+ requestBodySchema: {
855
+ $ref: "#/components/schemas/tenantDeactivateTenantRequest",
856
+ },
857
+ responseSchema: {
858
+ $ref: "#/components/schemas/tenantDeactivateTenantResponse",
859
+ },
860
+ requiredParams: ["body"],
861
+ operationId: "ves.io.schema.tenant.CustomAPIEywaprime.DeactivateTenant",
862
+ tags: ["Tenant Management"],
863
+ sourceFile: "domains/tenant_management.json",
864
+ },
865
+ {
866
+ toolName: "f5xc-api-tenantmanagement-disable-update",
867
+ method: "PUT",
868
+ path: "/api/web/namespaces/system/tenant/settings/otp/disable",
869
+ operation: "update",
870
+ domain: "tenant_management",
871
+ resource: "disable",
872
+ summary: "Disable tenant level OTP.",
873
+ description: "Disable tenant level OTP disables OTP on tenant-level. After it's disabled it's up to user whether to enable OTP.",
874
+ pathParameters: [],
875
+ queryParameters: [],
876
+ requestBodySchema: null,
877
+ responseSchema: {
878
+ $ref: "#/components/schemas/schematenantEmpty",
879
+ },
880
+ requiredParams: [],
881
+ operationId: "ves.io.schema.tenant.CustomAPI.DisableTenantLevelOTP",
882
+ tags: ["Tenant Management"],
883
+ sourceFile: "domains/tenant_management.json",
884
+ },
885
+ {
886
+ toolName: "f5xc-api-tenantmanagement-enable-update",
887
+ method: "PUT",
888
+ path: "/api/web/namespaces/system/tenant/settings/otp/enable",
889
+ operation: "update",
890
+ domain: "tenant_management",
891
+ resource: "enable",
892
+ summary: "Enable tenant level OTP.",
893
+ description: "Enable tenant level OTP enables OTP on tenant-level. It enforces each user within a tenant to enable OTP.",
894
+ pathParameters: [],
895
+ queryParameters: [],
896
+ requestBodySchema: null,
897
+ responseSchema: {
898
+ $ref: "#/components/schemas/schematenantEmpty",
899
+ },
900
+ requiredParams: [],
901
+ operationId: "ves.io.schema.tenant.CustomAPI.EnableTenantLevelOTP",
902
+ tags: ["Tenant Management"],
903
+ sourceFile: "domains/tenant_management.json",
904
+ },
905
+ {
906
+ toolName: "f5xc-api-tenantmanagement-escalate-create",
907
+ method: "POST",
908
+ path: "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/escalate",
909
+ operation: "create",
910
+ domain: "tenant_management",
911
+ resource: "escalate",
912
+ summary: "Escalate a ticket in managed tenant.",
913
+ description: "Escalates a selected ticket. Only certain customers (depending on their contract) are allowed to escalate tickets.",
914
+ pathParameters: [
915
+ {
916
+ description: "Third party ID\nID assigned to this ticket by our support provider.",
917
+ in: "path",
918
+ name: "tp_id",
919
+ required: true,
920
+ schema: {
921
+ type: "string",
922
+ },
923
+ },
924
+ ],
925
+ queryParameters: [],
926
+ requestBodySchema: null,
927
+ responseSchema: {
928
+ $ref: "#/components/schemas/customer_supportEscalationResponse",
929
+ },
930
+ requiredParams: ["tp_id"],
931
+ operationId: "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Escalate",
932
+ tags: ["Other"],
933
+ sourceFile: "domains/tenant_management.json",
934
+ },
935
+ {
936
+ toolName: "f5xc-api-tenantmanagement-favicon-list",
937
+ method: "GET",
938
+ path: "/api/web/namespaces/system/tenant/settings/tenant/favicon",
939
+ operation: "list",
940
+ domain: "tenant_management",
941
+ resource: "favicon",
942
+ summary: "Tenant favicon.",
943
+ description: "Receive current tenant favicon.",
944
+ pathParameters: [],
945
+ queryParameters: [],
946
+ requestBodySchema: null,
947
+ responseSchema: {
948
+ $ref: "#/components/schemas/apiHttpBody",
949
+ },
950
+ requiredParams: [],
951
+ operationId: "ves.io.schema.tenant.CustomAPI.GetFavIcon",
952
+ tags: ["Tenant Management"],
953
+ sourceFile: "domains/tenant_management.json",
954
+ },
955
+ {
956
+ toolName: "f5xc-api-tenantmanagement-image-delete",
957
+ method: "DELETE",
958
+ path: "/api/web/namespaces/system/tenant/settings/tenant/image",
959
+ operation: "delete",
960
+ domain: "tenant_management",
961
+ resource: "image",
962
+ summary: "DELETE tenant profile image.",
963
+ description: "DELETE profile image for the tenant entity.",
964
+ pathParameters: [],
965
+ queryParameters: [],
966
+ requestBodySchema: null,
967
+ responseSchema: {
968
+ $ref: "#/components/schemas/schematenantEmpty",
969
+ },
970
+ requiredParams: [],
971
+ operationId: "ves.io.schema.tenant.CustomAPI.DeleteImage",
972
+ tags: ["Tenant Management"],
973
+ sourceFile: "domains/tenant_management.json",
974
+ },
975
+ {
976
+ toolName: "f5xc-api-tenantmanagement-image-list",
977
+ method: "GET",
978
+ path: "/api/web/namespaces/system/tenant/settings/tenant/image",
979
+ operation: "list",
980
+ domain: "tenant_management",
981
+ resource: "image",
982
+ summary: "Tenant profile image.",
983
+ description: "Receive current tenant profile image.",
984
+ pathParameters: [],
985
+ queryParameters: [],
986
+ requestBodySchema: null,
987
+ responseSchema: {
988
+ $ref: "#/components/schemas/apiHttpBody",
989
+ },
990
+ requiredParams: [],
991
+ operationId: "ves.io.schema.tenant.CustomAPI.GetImage",
992
+ tags: ["Tenant Management"],
993
+ sourceFile: "domains/tenant_management.json",
994
+ },
995
+ {
996
+ toolName: "f5xc-api-tenantmanagement-image-update",
997
+ method: "PUT",
998
+ path: "/api/web/namespaces/system/tenant/settings/tenant/image",
999
+ operation: "update",
1000
+ domain: "tenant_management",
1001
+ resource: "image",
1002
+ summary: "Update tenant profile image.",
1003
+ description: "Uploads new profile image for the tenant entity.",
1004
+ pathParameters: [],
1005
+ queryParameters: [],
1006
+ requestBodySchema: {
1007
+ $ref: "#/components/schemas/tenantUpdateImageRequest",
1008
+ },
1009
+ responseSchema: {
1010
+ $ref: "#/components/schemas/schematenantEmpty",
1011
+ },
1012
+ requiredParams: ["body"],
1013
+ operationId: "ves.io.schema.tenant.CustomAPI.UpdateImage",
1014
+ tags: ["Tenant Management"],
1015
+ sourceFile: "domains/tenant_management.json",
1016
+ },
1017
+ {
1018
+ toolName: "f5xc-api-tenantmanagement-inactive-list",
1019
+ method: "GET",
1020
+ path: "/api/web/namespaces/system/tenant/idm/users/inactive",
1021
+ operation: "list",
1022
+ domain: "tenant_management",
1023
+ resource: "inactive",
1024
+ summary: "ListInactiveUsers.",
1025
+ description: "Returns list of users for which no login events was found for last 90 days of time.\nIt consider all users within current tenant.",
1026
+ pathParameters: [],
1027
+ queryParameters: [],
1028
+ requestBodySchema: null,
1029
+ responseSchema: {
1030
+ $ref: "#/components/schemas/tenantUserList",
1031
+ },
1032
+ requiredParams: [],
1033
+ operationId: "ves.io.schema.tenant.CustomAPI.ListInactiveUsers",
1034
+ tags: ["Tenant Management"],
1035
+ sourceFile: "domains/tenant_management.json",
1036
+ },
1037
+ {
1038
+ toolName: "f5xc-api-tenantmanagement-last-login-list",
1039
+ method: "GET",
1040
+ path: "/api/web/namespaces/system/tenant/idm/events/last_login",
1041
+ operation: "list",
1042
+ domain: "tenant_management",
1043
+ resource: "last-login",
1044
+ summary: "GetLastLoginMap.",
1045
+ description: "GetLastLoginMap returns last login timestamp for each user within a tenant.",
1046
+ pathParameters: [],
1047
+ queryParameters: [],
1048
+ requestBodySchema: null,
1049
+ responseSchema: {
1050
+ $ref: "#/components/schemas/tenantLastLoginMap",
1051
+ },
1052
+ requiredParams: [],
1053
+ operationId: "ves.io.schema.tenant.CustomAPI.GetLastLoginMap",
1054
+ tags: ["Tenant Management"],
1055
+ sourceFile: "domains/tenant_management.json",
1056
+ },
1057
+ {
1058
+ toolName: "f5xc-api-tenantmanagement-login-in-time-create",
1059
+ method: "POST",
1060
+ path: "/api/web/namespaces/system/tenant/idm/events/login_in_time",
1061
+ operation: "create",
1062
+ domain: "tenant_management",
1063
+ resource: "login-in-time",
1064
+ summary: "GetLoginEventsInTimeFrame.",
1065
+ description: "GetLoginEventsInTimeFrame returns login events for specified period of time. It consider all users specified by context tenant.",
1066
+ pathParameters: [],
1067
+ queryParameters: [],
1068
+ requestBodySchema: {
1069
+ $ref: "#/components/schemas/tenantGetLoginEventsInTimeFrameRequest",
1070
+ },
1071
+ responseSchema: {
1072
+ $ref: "#/components/schemas/tenantLoginEventsMap",
1073
+ },
1074
+ requiredParams: ["body"],
1075
+ operationId: "ves.io.schema.tenant.CustomAPI.GetLoginEventsInTimeFrame",
1076
+ tags: ["Tenant Management"],
1077
+ sourceFile: "domains/tenant_management.json",
1078
+ },
1079
+ {
1080
+ toolName: "f5xc-api-tenantmanagement-login-list",
1081
+ method: "GET",
1082
+ path: "/api/web/namespaces/system/tenant/idm/events/login",
1083
+ operation: "list",
1084
+ domain: "tenant_management",
1085
+ resource: "login",
1086
+ summary: "GetLoginEvents.",
1087
+ description: "GetLoginEvents returns login events for specified in config period of time. It consider all users within current tenant.\nLogin events are extracted directly from IDM.",
1088
+ pathParameters: [],
1089
+ queryParameters: [
1090
+ {
1091
+ description: "Start offset.",
1092
+ in: "query",
1093
+ name: "first",
1094
+ required: false,
1095
+ schema: {
1096
+ format: "int64",
1097
+ type: "integer",
1098
+ },
1099
+ },
1100
+ {
1101
+ description: "Records per page.",
1102
+ in: "query",
1103
+ name: "max",
1104
+ required: false,
1105
+ schema: {
1106
+ format: "int64",
1107
+ type: "integer",
1108
+ },
1109
+ },
1110
+ ],
1111
+ requestBodySchema: null,
1112
+ responseSchema: {
1113
+ $ref: "#/components/schemas/tenantLoginEventsMap",
1114
+ },
1115
+ requiredParams: [],
1116
+ operationId: "ves.io.schema.tenant.CustomAPI.GetLoginEvents",
1117
+ tags: ["Tenant Management"],
1118
+ sourceFile: "domains/tenant_management.json",
1119
+ },
1120
+ {
1121
+ toolName: "f5xc-api-tenantmanagement-logo-list",
1122
+ method: "GET",
1123
+ path: "/api/web/namespaces/system/tenant/settings/tenant/logo",
1124
+ operation: "list",
1125
+ domain: "tenant_management",
1126
+ resource: "logo",
1127
+ summary: "Tenant logo.",
1128
+ description: "Receive current tenant logo.",
1129
+ pathParameters: [],
1130
+ queryParameters: [],
1131
+ requestBodySchema: null,
1132
+ responseSchema: {
1133
+ $ref: "#/components/schemas/apiHttpBody",
1134
+ },
1135
+ requiredParams: [],
1136
+ operationId: "ves.io.schema.tenant.CustomAPI.GetLogo",
1137
+ tags: ["Tenant Management"],
1138
+ sourceFile: "domains/tenant_management.json",
1139
+ },
1140
+ {
1141
+ toolName: "f5xc-api-tenantmanagement-lookup-list",
1142
+ method: "GET",
1143
+ path: "/api/web/namespaces/system/tenant/lookup",
1144
+ operation: "list",
1145
+ domain: "tenant_management",
1146
+ resource: "lookup",
1147
+ summary: "Lookup cname.",
1148
+ description: "Checks if a cname is available.",
1149
+ pathParameters: [],
1150
+ queryParameters: [
1151
+ {
1152
+ description: "Cname to look-uo.",
1153
+ in: "query",
1154
+ name: "cname",
1155
+ required: false,
1156
+ schema: {
1157
+ type: "string",
1158
+ },
1159
+ },
1160
+ {
1161
+ description: "Namespace to query.",
1162
+ in: "query",
1163
+ name: "namespace",
1164
+ required: false,
1165
+ schema: {
1166
+ type: "string",
1167
+ },
1168
+ },
1169
+ ],
1170
+ requestBodySchema: null,
1171
+ responseSchema: {
1172
+ $ref: "#/components/schemas/tenantStatusResponse",
1173
+ },
1174
+ requiredParams: [],
1175
+ operationId: "docs_cloud_f5_com_0233_public_ves_io_schema_tenant_ves_swagger_ves.io.schema.tenant.CustomAPI.LookupCname",
1176
+ tags: ["Tenant Management"],
1177
+ sourceFile: "domains/tenant_management.json",
1178
+ },
1179
+ {
1180
+ toolName: "f5xc-api-tenantmanagement-managed-tenant-create",
1181
+ method: "POST",
1182
+ path: "/api/web/namespaces/{metadata.namespace}/managed_tenants",
1183
+ operation: "create",
1184
+ domain: "tenant_management",
1185
+ resource: "managed-tenant",
1186
+ summary: "Create Managed Tenant.",
1187
+ description: "Creates a managed_tenant config instance. Name of the object is name of the tenant that is allowed to manage.",
1188
+ pathParameters: [
1189
+ {
1190
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
1191
+ in: "path",
1192
+ name: "metadata.namespace",
1193
+ required: true,
1194
+ schema: {
1195
+ type: "string",
1196
+ },
1197
+ },
1198
+ ],
1199
+ queryParameters: [],
1200
+ requestBodySchema: {
1201
+ $ref: "#/components/schemas/tenant_managementmanaged_tenantCreateRequest",
1202
+ },
1203
+ responseSchema: {
1204
+ $ref: "#/components/schemas/tenant_managementmanaged_tenantCreateResponse",
1205
+ },
1206
+ requiredParams: ["body", "metadata.namespace"],
1207
+ operationId: "ves.io.schema.tenant_management.managed_tenant.API.Create",
1208
+ tags: ["Other"],
1209
+ sourceFile: "domains/tenant_management.json",
1210
+ },
1211
+ {
1212
+ toolName: "f5xc-api-tenantmanagement-managed-tenant-delete",
1213
+ method: "DELETE",
1214
+ path: "/api/web/namespaces/{namespace}/managed_tenants/{name}",
1215
+ operation: "delete",
1216
+ domain: "tenant_management",
1217
+ resource: "managed-tenant",
1218
+ summary: "DELETE Managed Tenant.",
1219
+ description: "DELETE the specified managed_tenant.",
1220
+ pathParameters: [
1221
+ {
1222
+ description: "Name\nName of the configuration object.",
1223
+ in: "path",
1224
+ name: "name",
1225
+ required: true,
1226
+ schema: {
1227
+ type: "string",
1228
+ },
1229
+ },
1230
+ {
1231
+ description: "Namespace\nNamespace in which the configuration object is present.",
1232
+ in: "path",
1233
+ name: "namespace",
1234
+ required: true,
1235
+ schema: {
1236
+ type: "string",
1237
+ },
1238
+ },
1239
+ ],
1240
+ queryParameters: [],
1241
+ requestBodySchema: {
1242
+ $ref: "#/components/schemas/managed_tenantDeleteRequest",
1243
+ },
1244
+ responseSchema: {},
1245
+ requiredParams: ["body", "name", "namespace"],
1246
+ operationId: "ves.io.schema.tenant_management.managed_tenant.API.Delete",
1247
+ tags: ["Other"],
1248
+ sourceFile: "domains/tenant_management.json",
1249
+ },
1250
+ {
1251
+ toolName: "f5xc-api-tenantmanagement-managed-tenant-get",
1252
+ method: "GET",
1253
+ path: "/api/web/namespaces/{namespace}/managed_tenants/{name}",
1254
+ operation: "get",
1255
+ domain: "tenant_management",
1256
+ resource: "managed-tenant",
1257
+ summary: "GET Managed Tenant.",
1258
+ description: "GET managed_tenant reads a given object from storage backend for metadata.namespace.",
1259
+ pathParameters: [
1260
+ {
1261
+ description: "Name\nThe name of the configuration object to be fetched.",
1262
+ in: "path",
1263
+ name: "name",
1264
+ required: true,
1265
+ schema: {
1266
+ type: "string",
1267
+ },
1268
+ },
1269
+ {
1270
+ description: "Namespace\nThe namespace in which the configuration object is present.",
1271
+ in: "path",
1272
+ name: "namespace",
1273
+ required: true,
1274
+ schema: {
1275
+ type: "string",
1276
+ },
1277
+ },
1278
+ ],
1279
+ queryParameters: [
1280
+ {
1281
+ description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
1282
+ in: "query",
1283
+ name: "response_format",
1284
+ required: false,
1285
+ schema: {
1286
+ default: "GET_RSP_FORMAT_DEFAULT",
1287
+ enum: [
1288
+ "GET_RSP_FORMAT_DEFAULT",
1289
+ "GET_RSP_FORMAT_FOR_CREATE",
1290
+ "GET_RSP_FORMAT_FOR_REPLACE",
1291
+ "GET_RSP_FORMAT_STATUS",
1292
+ "GET_RSP_FORMAT_READ",
1293
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
1294
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
1295
+ ],
1296
+ type: "string",
1297
+ },
1298
+ },
1299
+ ],
1300
+ requestBodySchema: null,
1301
+ responseSchema: {
1302
+ $ref: "#/components/schemas/tenant_managementmanaged_tenantGetResponse",
1303
+ },
1304
+ requiredParams: ["name", "namespace"],
1305
+ operationId: "ves.io.schema.tenant_management.managed_tenant.API.Get",
1306
+ tags: ["Other"],
1307
+ sourceFile: "domains/tenant_management.json",
1308
+ },
1309
+ {
1310
+ toolName: "f5xc-api-tenantmanagement-managed-tenant-list",
1311
+ method: "GET",
1312
+ path: "/api/web/namespaces/system/support-tenant/managed_tenants",
1313
+ operation: "list",
1314
+ domain: "tenant_management",
1315
+ resource: "managed-tenant",
1316
+ summary: "List of Managed Tenant By User For Support Operations.",
1317
+ description: "GET list of managed tenants that user have access to based on assingned membership.\nThis is an optimized list generated based on the requesting user's current group assignments\nthat will allow access to managed tenant.",
1318
+ pathParameters: [],
1319
+ queryParameters: [
1320
+ {
1321
+ description: "PageLimit will hold the limit of items required per query.\nDefault value is set as 100.",
1322
+ in: "query",
1323
+ name: "page_limit",
1324
+ required: false,
1325
+ schema: {
1326
+ format: "int32",
1327
+ type: "integer",
1328
+ },
1329
+ },
1330
+ {
1331
+ description: "PageStart will hold the UUID of the first item in the requested page.\nResponse will contain items upto count specified in PageLimit starting from PageStart.\nIf this is empty then first page will be served.",
1332
+ in: "query",
1333
+ name: "page_start",
1334
+ required: false,
1335
+ schema: {
1336
+ type: "string",
1337
+ },
1338
+ },
1339
+ {
1340
+ description: "Search Keyword for filtering the Managed Tenant List.",
1341
+ in: "query",
1342
+ name: "search_keyword",
1343
+ required: false,
1344
+ schema: {
1345
+ type: "string",
1346
+ },
1347
+ },
1348
+ ],
1349
+ requestBodySchema: null,
1350
+ responseSchema: {
1351
+ $ref: "#/components/schemas/managed_tenantListSupportTenantMTResp",
1352
+ },
1353
+ requiredParams: [],
1354
+ operationId: "ves.io.schema.tenant_management.managed_tenant.CustomAPI.ListSupportTenantMT",
1355
+ tags: ["Other"],
1356
+ sourceFile: "domains/tenant_management.json",
1357
+ },
1358
+ {
1359
+ toolName: "f5xc-api-tenantmanagement-managed-tenant-update",
1360
+ method: "PUT",
1361
+ path: "/api/web/namespaces/{metadata.namespace}/managed_tenants/{metadata.name}",
1362
+ operation: "update",
1363
+ domain: "tenant_management",
1364
+ resource: "managed-tenant",
1365
+ summary: "Replace Managed Tenant.",
1366
+ description: "Replaces attributes of a managed_tenant configuration.\nUpdate of existing tenant_choice selection is not supported but user may update existing group assignments.",
1367
+ pathParameters: [
1368
+ {
1369
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
1370
+ in: "path",
1371
+ name: "metadata.name",
1372
+ required: true,
1373
+ schema: {
1374
+ type: "string",
1375
+ },
1376
+ },
1377
+ {
1378
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
1379
+ in: "path",
1380
+ name: "metadata.namespace",
1381
+ required: true,
1382
+ schema: {
1383
+ type: "string",
1384
+ },
1385
+ },
1386
+ ],
1387
+ queryParameters: [],
1388
+ requestBodySchema: {
1389
+ $ref: "#/components/schemas/managed_tenantReplaceRequest",
1390
+ },
1391
+ responseSchema: {
1392
+ $ref: "#/components/schemas/managed_tenantReplaceResponse",
1393
+ },
1394
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
1395
+ operationId: "ves.io.schema.tenant_management.managed_tenant.API.Replace",
1396
+ tags: ["Other"],
1397
+ sourceFile: "domains/tenant_management.json",
1398
+ },
1399
+ {
1400
+ toolName: "f5xc-api-tenantmanagement-managed-tenants-by-user-list",
1401
+ method: "GET",
1402
+ path: "/api/web/namespaces/system/managed_tenants_by_user",
1403
+ operation: "list",
1404
+ domain: "tenant_management",
1405
+ resource: "managed-tenants-by-user",
1406
+ summary: "GET List of Managed Tenant By User.",
1407
+ description: "GET list of managed tenants that user have access to based on assigned membership.\nThis is an optimized list generated based on the requesting user's current group assignments\nthat will allow access to managed tenant.",
1408
+ pathParameters: [],
1409
+ queryParameters: [
1410
+ {
1411
+ description: "PageLimit will hold the limit of items required per query.\nDefault value is set as 100.",
1412
+ in: "query",
1413
+ name: "page_limit",
1414
+ required: false,
1415
+ schema: {
1416
+ format: "int32",
1417
+ type: "integer",
1418
+ },
1419
+ },
1420
+ {
1421
+ description: "PageStart will hold the UUID of the first item in the requested page.\nResponse will contain items upto count specified in PageLimit starting from PageStart.\nIf this is empty then first page will be served.",
1422
+ in: "query",
1423
+ name: "page_start",
1424
+ required: false,
1425
+ schema: {
1426
+ type: "string",
1427
+ },
1428
+ },
1429
+ {
1430
+ description: "Search Keyword for filtering the Managed Tenant List.",
1431
+ in: "query",
1432
+ name: "search_keyword",
1433
+ required: false,
1434
+ schema: {
1435
+ type: "string",
1436
+ },
1437
+ },
1438
+ ],
1439
+ requestBodySchema: null,
1440
+ responseSchema: {
1441
+ $ref: "#/components/schemas/managed_tenantGetManagedTenantListResp",
1442
+ },
1443
+ requiredParams: [],
1444
+ operationId: "ves.io.schema.tenant_management.managed_tenant.CustomAPI.GetManagedTenantListByUser",
1445
+ tags: ["Other"],
1446
+ sourceFile: "domains/tenant_management.json",
1447
+ },
1448
+ {
1449
+ toolName: "f5xc-api-tenantmanagement-managed-tenants-list-list",
1450
+ method: "GET",
1451
+ path: "/api/web/namespaces/system/managed_tenants_list",
1452
+ operation: "list",
1453
+ domain: "tenant_management",
1454
+ resource: "managed-tenants-list",
1455
+ summary: "GET List of Managed Tenant.",
1456
+ description: "GET full list of managed tenants access details.\nThis response will contain full list of managed tenant based on the configuration\nand is not filtered by requesting user's group membership that enable access.",
1457
+ pathParameters: [],
1458
+ queryParameters: [
1459
+ {
1460
+ description: "PageLimit will hold the limit of items required per query.\nDefault value is set as 100.",
1461
+ in: "query",
1462
+ name: "page_limit",
1463
+ required: false,
1464
+ schema: {
1465
+ format: "int32",
1466
+ type: "integer",
1467
+ },
1468
+ },
1469
+ {
1470
+ description: "PageStart will hold the UUID of the first item in the requested page.\nResponse will contain items upto count specified in PageLimit starting from PageStart.\nIf this is empty then first page will be served.",
1471
+ in: "query",
1472
+ name: "page_start",
1473
+ required: false,
1474
+ schema: {
1475
+ type: "string",
1476
+ },
1477
+ },
1478
+ {
1479
+ description: "Search Keyword for filtering the Managed Tenant List.",
1480
+ in: "query",
1481
+ name: "search_keyword",
1482
+ required: false,
1483
+ schema: {
1484
+ type: "string",
1485
+ },
1486
+ },
1487
+ ],
1488
+ requestBodySchema: null,
1489
+ responseSchema: {
1490
+ $ref: "#/components/schemas/managed_tenantGetManagedTenantListResp",
1491
+ },
1492
+ requiredParams: [],
1493
+ operationId: "ves.io.schema.tenant_management.managed_tenant.CustomAPI.GetManagedTenantList",
1494
+ tags: ["Other"],
1495
+ sourceFile: "domains/tenant_management.json",
1496
+ },
1497
+ {
1498
+ toolName: "f5xc-api-tenantmanagement-migrate-create",
1499
+ method: "POST",
1500
+ path: "/api/web/namespaces/system/partner-management/child_tenant_managers/{name}/child_tenants/migrate",
1501
+ operation: "create",
1502
+ domain: "tenant_management",
1503
+ resource: "migrate",
1504
+ summary: "Migrate CTM child tenants.",
1505
+ description: "Migrate ACTIVE child tenants from existing CTM to a specified new CTM.",
1506
+ pathParameters: [
1507
+ {
1508
+ description: "Name\n\nx-required\nName of the child tenant manager.",
1509
+ in: "path",
1510
+ name: "name",
1511
+ required: true,
1512
+ schema: {
1513
+ type: "string",
1514
+ },
1515
+ },
1516
+ ],
1517
+ queryParameters: [],
1518
+ requestBodySchema: {
1519
+ $ref: "#/components/schemas/child_tenant_managerMigrateCTMChildTenantsReq",
1520
+ },
1521
+ responseSchema: {
1522
+ $ref: "#/components/schemas/child_tenant_managerMigrateCTMChildTenantsResp",
1523
+ },
1524
+ requiredParams: ["body", "name"],
1525
+ operationId: "ves.io.schema.tenant_management.child_tenant_manager.CustomAPI.MigrateCTMChildTenants",
1526
+ tags: ["Other"],
1527
+ sourceFile: "domains/tenant_management.json",
1528
+ },
1529
+ {
1530
+ toolName: "f5xc-api-tenantmanagement-password-policy-list",
1531
+ method: "GET",
1532
+ path: "/no_auth/tenant/idm/settings/password_policy",
1533
+ operation: "list",
1534
+ domain: "tenant_management",
1535
+ resource: "password-policy",
1536
+ summary: "GetPasswordPolicy.",
1537
+ description: "GetPasswordPolicy returns password policy for tenant.",
1538
+ pathParameters: [],
1539
+ queryParameters: [
1540
+ {
1541
+ description: "User's email.",
1542
+ in: "query",
1543
+ name: "realm_id",
1544
+ required: false,
1545
+ schema: {
1546
+ type: "string",
1547
+ },
1548
+ },
1549
+ ],
1550
+ requestBodySchema: null,
1551
+ responseSchema: {
1552
+ $ref: "#/components/schemas/tenantPasswordPolicyPublicAccess",
1553
+ },
1554
+ requiredParams: [],
1555
+ operationId: "ves.io.schema.tenant.CustomAPI.GetPasswordPolicy",
1556
+ tags: ["Tenant Management"],
1557
+ sourceFile: "domains/tenant_management.json",
1558
+ },
1559
+ {
1560
+ toolName: "f5xc-api-tenantmanagement-priority-create",
1561
+ method: "POST",
1562
+ path: "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/priority",
1563
+ operation: "create",
1564
+ domain: "tenant_management",
1565
+ resource: "priority",
1566
+ summary: "Priority of a ticket in managed tenant.",
1567
+ description: "Priority of a selected ticket. Not possible if ticket's already closed.",
1568
+ pathParameters: [
1569
+ {
1570
+ description: "Third party ID\nID assigned to this ticket by our support provider.",
1571
+ in: "path",
1572
+ name: "tp_id",
1573
+ required: true,
1574
+ schema: {
1575
+ type: "string",
1576
+ },
1577
+ },
1578
+ ],
1579
+ queryParameters: [],
1580
+ requestBodySchema: {
1581
+ $ref: "#/components/schemas/schematenant_managementPriorityRequest",
1582
+ },
1583
+ responseSchema: {
1584
+ $ref: "#/components/schemas/customer_supportPriorityResponse",
1585
+ },
1586
+ requiredParams: ["body", "tp_id"],
1587
+ operationId: "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Priority",
1588
+ tags: ["Other"],
1589
+ sourceFile: "domains/tenant_management.json",
1590
+ },
1591
+ {
1592
+ toolName: "f5xc-api-tenantmanagement-reopen-create",
1593
+ method: "POST",
1594
+ path: "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/reopen",
1595
+ operation: "create",
1596
+ domain: "tenant_management",
1597
+ resource: "reopen",
1598
+ summary: "Reopen a closed customer support ticket in managed tenant.",
1599
+ description: "Reopens a selected closed customer support ticket.",
1600
+ pathParameters: [
1601
+ {
1602
+ description: "Third party ID\nID assigned to this ticket by our support provider.",
1603
+ in: "path",
1604
+ name: "tp_id",
1605
+ required: true,
1606
+ schema: {
1607
+ type: "string",
1608
+ },
1609
+ },
1610
+ ],
1611
+ queryParameters: [],
1612
+ requestBodySchema: null,
1613
+ responseSchema: {
1614
+ $ref: "#/components/schemas/customer_supportReopenResponse",
1615
+ },
1616
+ requiredParams: ["tp_id"],
1617
+ operationId: "ves.io.schema.tenant_management.managed_tenant.CustomerSupportCustomAPI.Reopen",
1618
+ tags: ["Other"],
1619
+ sourceFile: "domains/tenant_management.json",
1620
+ },
1621
+ {
1622
+ toolName: "f5xc-api-tenantmanagement-request-delete-create",
1623
+ method: "POST",
1624
+ path: "/api/web/namespaces/system/tenant/request-delete",
1625
+ operation: "create",
1626
+ domain: "tenant_management",
1627
+ resource: "request-delete",
1628
+ summary: "DELETE Tenant.",
1629
+ description: "Request to mark Tenant for deletion queue, after approve it will completely removed from the system.",
1630
+ pathParameters: [],
1631
+ queryParameters: [],
1632
+ requestBodySchema: {
1633
+ $ref: "#/components/schemas/tenantDeleteTenantRequest",
1634
+ },
1635
+ responseSchema: {
1636
+ $ref: "#/components/schemas/tenantStatusResponse",
1637
+ },
1638
+ requiredParams: ["body"],
1639
+ operationId: "ves.io.schema.tenant.CustomAPI.DeleteTenant",
1640
+ tags: ["Tenant Management"],
1641
+ sourceFile: "domains/tenant_management.json",
1642
+ },
1643
+ {
1644
+ toolName: "f5xc-api-tenantmanagement-setting-list",
1645
+ method: "GET",
1646
+ path: "/api/web/namespaces/system/tenant/idm/settings",
1647
+ operation: "list",
1648
+ domain: "tenant_management",
1649
+ resource: "setting",
1650
+ summary: "GetIDMSettings.",
1651
+ description: "GetIDMSettings returns IDM settings for tenant. IDM settings contains info like password policy,\nbrute-force detection policy, etc...",
1652
+ pathParameters: [],
1653
+ queryParameters: [],
1654
+ requestBodySchema: null,
1655
+ responseSchema: {
1656
+ $ref: "#/components/schemas/viewstenant_configurationGlobalSpecType",
1657
+ },
1658
+ requiredParams: [],
1659
+ operationId: "ves.io.schema.tenant.CustomAPI.GetIDMSettings",
1660
+ tags: ["Tenant Management"],
1661
+ sourceFile: "domains/tenant_management.json",
1662
+ },
1663
+ {
1664
+ toolName: "f5xc-api-tenantmanagement-setting-update",
1665
+ method: "PUT",
1666
+ path: "/api/web/namespaces/system/tenant/idm/settings",
1667
+ operation: "update",
1668
+ domain: "tenant_management",
1669
+ resource: "setting",
1670
+ summary: "UpdateIDMSettings.",
1671
+ description: "UpdateIDMSettings allows to adjust IDM settings for tenant, like password policy, brute-force detection policy, etc...",
1672
+ pathParameters: [],
1673
+ queryParameters: [],
1674
+ requestBodySchema: {
1675
+ $ref: "#/components/schemas/viewstenant_configurationGlobalSpecType",
1676
+ },
1677
+ responseSchema: {
1678
+ $ref: "#/components/schemas/schematenantEmpty",
1679
+ },
1680
+ requiredParams: ["body"],
1681
+ operationId: "ves.io.schema.tenant.CustomAPI.UpdateIDMSettings",
1682
+ tags: ["Tenant Management"],
1683
+ sourceFile: "domains/tenant_management.json",
1684
+ },
1685
+ {
1686
+ toolName: "f5xc-api-tenantmanagement-subscribe-create",
1687
+ method: "POST",
1688
+ path: "/api/web/namespaces/system/tenant_management/delegated_access/subscribe",
1689
+ operation: "create",
1690
+ domain: "tenant_management",
1691
+ resource: "subscribe",
1692
+ summary: "Subscribe Delegated Access Addon Service.",
1693
+ description: "Subscribe Delegated Access addon service feature. A support request will be created and feature will be enabled upon approval.",
1694
+ pathParameters: [],
1695
+ queryParameters: [],
1696
+ requestBodySchema: {
1697
+ $ref: "#/components/schemas/tenant_managementSubscribeRequest",
1698
+ },
1699
+ responseSchema: {
1700
+ $ref: "#/components/schemas/tenant_managementSubscribeResponse",
1701
+ },
1702
+ requiredParams: ["body"],
1703
+ operationId: "ves.io.schema.tenant_management.CustomAPI.DelegatedAccessSubscribe",
1704
+ tags: ["Tenant Management"],
1705
+ sourceFile: "domains/tenant_management.json",
1706
+ },
1707
+ {
1708
+ toolName: "f5xc-api-tenantmanagement-summary-list",
1709
+ method: "GET",
1710
+ path: "/api/config/tenants/{tenant}/summary",
1711
+ operation: "list",
1712
+ domain: "tenant_management",
1713
+ resource: "summary",
1714
+ summary: "Summary",
1715
+ description: "This API returns tenant summary.",
1716
+ pathParameters: [
1717
+ {
1718
+ description: "Tenant ID\n\nTenant ID.",
1719
+ in: "path",
1720
+ name: "tenant",
1721
+ required: true,
1722
+ schema: {
1723
+ type: "string",
1724
+ },
1725
+ },
1726
+ ],
1727
+ queryParameters: [],
1728
+ requestBodySchema: null,
1729
+ responseSchema: {
1730
+ $ref: "#/components/schemas/tenantSummaryResponse",
1731
+ },
1732
+ requiredParams: ["tenant"],
1733
+ operationId: "ves.io.schema.tenant.TenantSummaryCustomAPI.Summary",
1734
+ tags: ["Other"],
1735
+ sourceFile: "domains/tenant_management.json",
1736
+ },
1737
+ {
1738
+ toolName: "f5xc-api-tenantmanagement-support-info-list",
1739
+ method: "GET",
1740
+ path: "/api/web/namespaces/system/tenant/support-info",
1741
+ operation: "list",
1742
+ domain: "tenant_management",
1743
+ resource: "support-info",
1744
+ summary: "Support Info.",
1745
+ description: "Receive support information for tenant.",
1746
+ pathParameters: [],
1747
+ queryParameters: [],
1748
+ requestBodySchema: null,
1749
+ responseSchema: {
1750
+ $ref: "#/components/schemas/tenantSupportInfo",
1751
+ },
1752
+ requiredParams: [],
1753
+ operationId: "ves.io.schema.tenant.CustomAPI.GetSupportInfo",
1754
+ tags: ["Tenant Management"],
1755
+ sourceFile: "domains/tenant_management.json",
1756
+ },
1757
+ {
1758
+ toolName: "f5xc-api-tenantmanagement-tenant-configuration-create",
1759
+ method: "POST",
1760
+ path: "/api/config/namespaces/{metadata.namespace}/tenant_configurations",
1761
+ operation: "create",
1762
+ domain: "tenant_management",
1763
+ resource: "tenant-configuration",
1764
+ summary: "Create tenant configuration.",
1765
+ description: "Shape of the tenant configuration specification.",
1766
+ pathParameters: [
1767
+ {
1768
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
1769
+ in: "path",
1770
+ name: "metadata.namespace",
1771
+ required: true,
1772
+ schema: {
1773
+ type: "string",
1774
+ },
1775
+ },
1776
+ ],
1777
+ queryParameters: [],
1778
+ requestBodySchema: {
1779
+ $ref: "#/components/schemas/tenant_configurationCreateRequest",
1780
+ },
1781
+ responseSchema: {
1782
+ $ref: "#/components/schemas/tenant_configurationCreateResponse",
1783
+ },
1784
+ requiredParams: ["body", "metadata.namespace"],
1785
+ operationId: "ves.io.schema.views.tenant_configuration.API.Create",
1786
+ tags: ["Other"],
1787
+ sourceFile: "domains/tenant_management.json",
1788
+ },
1789
+ {
1790
+ toolName: "f5xc-api-tenantmanagement-tenant-configuration-delete",
1791
+ method: "DELETE",
1792
+ path: "/api/config/namespaces/{namespace}/tenant_configurations/{name}",
1793
+ operation: "delete",
1794
+ domain: "tenant_management",
1795
+ resource: "tenant-configuration",
1796
+ summary: "DELETE Tenant Configuration.",
1797
+ description: "DELETE the specified tenant_configuration.",
1798
+ pathParameters: [
1799
+ {
1800
+ description: "Name\nName of the configuration object.",
1801
+ in: "path",
1802
+ name: "name",
1803
+ required: true,
1804
+ schema: {
1805
+ type: "string",
1806
+ },
1807
+ },
1808
+ {
1809
+ description: "Namespace\nNamespace in which the configuration object is present.",
1810
+ in: "path",
1811
+ name: "namespace",
1812
+ required: true,
1813
+ schema: {
1814
+ type: "string",
1815
+ },
1816
+ },
1817
+ ],
1818
+ queryParameters: [],
1819
+ requestBodySchema: {
1820
+ $ref: "#/components/schemas/tenant_configurationDeleteRequest",
1821
+ },
1822
+ responseSchema: {},
1823
+ requiredParams: ["body", "name", "namespace"],
1824
+ operationId: "ves.io.schema.views.tenant_configuration.API.Delete",
1825
+ tags: ["Other"],
1826
+ sourceFile: "domains/tenant_management.json",
1827
+ },
1828
+ {
1829
+ toolName: "f5xc-api-tenantmanagement-tenant-configuration-get",
1830
+ method: "GET",
1831
+ path: "/api/config/namespaces/{namespace}/tenant_configurations/{name}",
1832
+ operation: "get",
1833
+ domain: "tenant_management",
1834
+ resource: "tenant-configuration",
1835
+ summary: "GET tenant configuration.",
1836
+ description: "Shape of the tenant configuration specification.",
1837
+ pathParameters: [
1838
+ {
1839
+ description: "Name\nThe name of the configuration object to be fetched.",
1840
+ in: "path",
1841
+ name: "name",
1842
+ required: true,
1843
+ schema: {
1844
+ type: "string",
1845
+ },
1846
+ },
1847
+ {
1848
+ description: "Namespace\nThe namespace in which the configuration object is present.",
1849
+ in: "path",
1850
+ name: "namespace",
1851
+ required: true,
1852
+ schema: {
1853
+ type: "string",
1854
+ },
1855
+ },
1856
+ ],
1857
+ queryParameters: [
1858
+ {
1859
+ description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
1860
+ in: "query",
1861
+ name: "response_format",
1862
+ required: false,
1863
+ schema: {
1864
+ default: "GET_RSP_FORMAT_DEFAULT",
1865
+ enum: [
1866
+ "GET_RSP_FORMAT_DEFAULT",
1867
+ "GET_RSP_FORMAT_FOR_CREATE",
1868
+ "GET_RSP_FORMAT_FOR_REPLACE",
1869
+ "GET_RSP_FORMAT_STATUS",
1870
+ "GET_RSP_FORMAT_READ",
1871
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
1872
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
1873
+ ],
1874
+ type: "string",
1875
+ },
1876
+ },
1877
+ ],
1878
+ requestBodySchema: null,
1879
+ responseSchema: {
1880
+ $ref: "#/components/schemas/tenant_configurationGetResponse",
1881
+ },
1882
+ requiredParams: ["name", "namespace"],
1883
+ operationId: "ves.io.schema.views.tenant_configuration.API.Get",
1884
+ tags: ["Other"],
1885
+ sourceFile: "domains/tenant_management.json",
1886
+ },
1887
+ {
1888
+ toolName: "f5xc-api-tenantmanagement-tenant-configuration-list",
1889
+ method: "GET",
1890
+ path: "/api/config/namespaces/{namespace}/tenant_configurations",
1891
+ operation: "list",
1892
+ domain: "tenant_management",
1893
+ resource: "tenant-configuration",
1894
+ summary: "List Tenant Configuration.",
1895
+ description: "List the set of tenant_configuration in a namespace.",
1896
+ pathParameters: [
1897
+ {
1898
+ description: "Namespace\nNamespace to scope the listing of tenant_configuration.",
1899
+ in: "path",
1900
+ name: "namespace",
1901
+ required: true,
1902
+ schema: {
1903
+ type: "string",
1904
+ },
1905
+ },
1906
+ ],
1907
+ queryParameters: [
1908
+ {
1909
+ description: "A LabelSelectorType expression that every item in list response will satisfy.",
1910
+ in: "query",
1911
+ name: "label_filter",
1912
+ required: false,
1913
+ schema: {
1914
+ type: "string",
1915
+ },
1916
+ },
1917
+ {
1918
+ description: 'X-example: ""\nExtra fields to return along with summary fields.',
1919
+ in: "query",
1920
+ name: "report_fields",
1921
+ required: false,
1922
+ schema: {
1923
+ items: {
1924
+ type: "string",
1925
+ },
1926
+ type: "array",
1927
+ },
1928
+ },
1929
+ {
1930
+ description: 'X-example: ""\nExtra status fields to return along with summary fields.',
1931
+ in: "query",
1932
+ name: "report_status_fields",
1933
+ required: false,
1934
+ schema: {
1935
+ items: {
1936
+ type: "string",
1937
+ },
1938
+ type: "array",
1939
+ },
1940
+ },
1941
+ ],
1942
+ requestBodySchema: null,
1943
+ responseSchema: {
1944
+ $ref: "#/components/schemas/tenant_configurationListResponse",
1945
+ },
1946
+ requiredParams: ["namespace"],
1947
+ operationId: "ves.io.schema.views.tenant_configuration.API.List",
1948
+ tags: ["Other"],
1949
+ sourceFile: "domains/tenant_management.json",
1950
+ },
1951
+ {
1952
+ toolName: "f5xc-api-tenantmanagement-tenant-configuration-update",
1953
+ method: "PUT",
1954
+ path: "/api/config/namespaces/{metadata.namespace}/tenant_configurations/{metadata.name}",
1955
+ operation: "update",
1956
+ domain: "tenant_management",
1957
+ resource: "tenant-configuration",
1958
+ summary: "Replace tenant configuration.",
1959
+ description: "Shape of the tenant configuration specification.",
1960
+ pathParameters: [
1961
+ {
1962
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
1963
+ in: "path",
1964
+ name: "metadata.name",
1965
+ required: true,
1966
+ schema: {
1967
+ type: "string",
1968
+ },
1969
+ },
1970
+ {
1971
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
1972
+ in: "path",
1973
+ name: "metadata.namespace",
1974
+ required: true,
1975
+ schema: {
1976
+ type: "string",
1977
+ },
1978
+ },
1979
+ ],
1980
+ queryParameters: [],
1981
+ requestBodySchema: {
1982
+ $ref: "#/components/schemas/tenant_configurationReplaceRequest",
1983
+ },
1984
+ responseSchema: {
1985
+ $ref: "#/components/schemas/tenant_configurationReplaceResponse",
1986
+ },
1987
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
1988
+ operationId: "ves.io.schema.views.tenant_configuration.API.Replace",
1989
+ tags: ["Other"],
1990
+ sourceFile: "domains/tenant_management.json",
1991
+ },
1992
+ {
1993
+ toolName: "f5xc-api-tenantmanagement-tenant-escalation-doc-list",
1994
+ method: "GET",
1995
+ path: "/api/web/namespaces/system/tenant/tenant-escalation-doc",
1996
+ operation: "list",
1997
+ domain: "tenant_management",
1998
+ resource: "tenant-escalation-doc",
1999
+ summary: "Tenant escalation document.",
2000
+ description: "Receive current tenant escalation document.",
2001
+ pathParameters: [],
2002
+ queryParameters: [],
2003
+ requestBodySchema: null,
2004
+ responseSchema: {
2005
+ $ref: "#/components/schemas/apiHttpBody",
2006
+ },
2007
+ requiredParams: [],
2008
+ operationId: "ves.io.schema.tenant.CustomAPI.GetTenantEscalationDoc",
2009
+ tags: ["Tenant Management"],
2010
+ sourceFile: "domains/tenant_management.json",
2011
+ },
2012
+ {
2013
+ toolName: "f5xc-api-tenantmanagement-tenant-profile-create",
2014
+ method: "POST",
2015
+ path: "/api/web/namespaces/{metadata.namespace}/tenant_profiles",
2016
+ operation: "create",
2017
+ domain: "tenant_management",
2018
+ resource: "tenant-profile",
2019
+ summary: "Create Tenant Profile.",
2020
+ description: "Creates a tenant_profile config instance. Name of the object is the name of the tenant profile to be created.",
2021
+ pathParameters: [
2022
+ {
2023
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
2024
+ in: "path",
2025
+ name: "metadata.namespace",
2026
+ required: true,
2027
+ schema: {
2028
+ type: "string",
2029
+ },
2030
+ },
2031
+ ],
2032
+ queryParameters: [],
2033
+ requestBodySchema: {
2034
+ $ref: "#/components/schemas/tenant_profileCreateRequest",
2035
+ },
2036
+ responseSchema: {
2037
+ $ref: "#/components/schemas/tenant_profileCreateResponse",
2038
+ },
2039
+ requiredParams: ["body", "metadata.namespace"],
2040
+ operationId: "ves.io.schema.tenant_management.tenant_profile.API.Create",
2041
+ tags: ["Other"],
2042
+ sourceFile: "domains/tenant_management.json",
2043
+ },
2044
+ {
2045
+ toolName: "f5xc-api-tenantmanagement-tenant-profile-delete",
2046
+ method: "DELETE",
2047
+ path: "/api/web/namespaces/{namespace}/tenant_profiles/{name}",
2048
+ operation: "delete",
2049
+ domain: "tenant_management",
2050
+ resource: "tenant-profile",
2051
+ summary: "DELETE Tenant Profile.",
2052
+ description: "DELETE the specified tenant_profile.",
2053
+ pathParameters: [
2054
+ {
2055
+ description: "Name\nName of the configuration object.",
2056
+ in: "path",
2057
+ name: "name",
2058
+ required: true,
2059
+ schema: {
2060
+ type: "string",
2061
+ },
2062
+ },
2063
+ {
2064
+ description: "Namespace\nNamespace in which the configuration object is present.",
2065
+ in: "path",
2066
+ name: "namespace",
2067
+ required: true,
2068
+ schema: {
2069
+ type: "string",
2070
+ },
2071
+ },
2072
+ ],
2073
+ queryParameters: [],
2074
+ requestBodySchema: {
2075
+ $ref: "#/components/schemas/tenant_profileDeleteRequest",
2076
+ },
2077
+ responseSchema: {},
2078
+ requiredParams: ["body", "name", "namespace"],
2079
+ operationId: "ves.io.schema.tenant_management.tenant_profile.API.Delete",
2080
+ tags: ["Other"],
2081
+ sourceFile: "domains/tenant_management.json",
2082
+ },
2083
+ {
2084
+ toolName: "f5xc-api-tenantmanagement-tenant-profile-get",
2085
+ method: "GET",
2086
+ path: "/api/web/namespaces/{namespace}/tenant_profiles/{name}",
2087
+ operation: "get",
2088
+ domain: "tenant_management",
2089
+ resource: "tenant-profile",
2090
+ summary: "GET Tenant Profile.",
2091
+ description: "GET tenant_profile reads a given object from storage backend for metadata.namespace.",
2092
+ pathParameters: [
2093
+ {
2094
+ description: "Name\nThe name of the configuration object to be fetched.",
2095
+ in: "path",
2096
+ name: "name",
2097
+ required: true,
2098
+ schema: {
2099
+ type: "string",
2100
+ },
2101
+ },
2102
+ {
2103
+ description: "Namespace\nThe namespace in which the configuration object is present.",
2104
+ in: "path",
2105
+ name: "namespace",
2106
+ required: true,
2107
+ schema: {
2108
+ type: "string",
2109
+ },
2110
+ },
2111
+ ],
2112
+ queryParameters: [
2113
+ {
2114
+ description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
2115
+ in: "query",
2116
+ name: "response_format",
2117
+ required: false,
2118
+ schema: {
2119
+ default: "GET_RSP_FORMAT_DEFAULT",
2120
+ enum: [
2121
+ "GET_RSP_FORMAT_DEFAULT",
2122
+ "GET_RSP_FORMAT_FOR_CREATE",
2123
+ "GET_RSP_FORMAT_FOR_REPLACE",
2124
+ "GET_RSP_FORMAT_READ",
2125
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
2126
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
2127
+ ],
2128
+ type: "string",
2129
+ },
2130
+ },
2131
+ ],
2132
+ requestBodySchema: null,
2133
+ responseSchema: {
2134
+ $ref: "#/components/schemas/tenant_profileGetResponse",
2135
+ },
2136
+ requiredParams: ["name", "namespace"],
2137
+ operationId: "ves.io.schema.tenant_management.tenant_profile.API.Get",
2138
+ tags: ["Other"],
2139
+ sourceFile: "domains/tenant_management.json",
2140
+ },
2141
+ {
2142
+ toolName: "f5xc-api-tenantmanagement-tenant-profile-list",
2143
+ method: "GET",
2144
+ path: "/api/web/namespaces/{namespace}/tenant_profiles",
2145
+ operation: "list",
2146
+ domain: "tenant_management",
2147
+ resource: "tenant-profile",
2148
+ summary: "List Tenant Profile.",
2149
+ description: "List the set of tenant_profile in a namespace.",
2150
+ pathParameters: [
2151
+ {
2152
+ description: "Namespace\nNamespace to scope the listing of tenant_profile.",
2153
+ in: "path",
2154
+ name: "namespace",
2155
+ required: true,
2156
+ schema: {
2157
+ type: "string",
2158
+ },
2159
+ },
2160
+ ],
2161
+ queryParameters: [
2162
+ {
2163
+ description: "A LabelSelectorType expression that every item in list response will satisfy.",
2164
+ in: "query",
2165
+ name: "label_filter",
2166
+ required: false,
2167
+ schema: {
2168
+ type: "string",
2169
+ },
2170
+ },
2171
+ {
2172
+ description: 'X-example: ""\nExtra fields to return along with summary fields.',
2173
+ in: "query",
2174
+ name: "report_fields",
2175
+ required: false,
2176
+ schema: {
2177
+ items: {
2178
+ type: "string",
2179
+ },
2180
+ type: "array",
2181
+ },
2182
+ },
2183
+ {
2184
+ description: 'X-example: ""\nExtra status fields to return along with summary fields.',
2185
+ in: "query",
2186
+ name: "report_status_fields",
2187
+ required: false,
2188
+ schema: {
2189
+ items: {
2190
+ type: "string",
2191
+ },
2192
+ type: "array",
2193
+ },
2194
+ },
2195
+ ],
2196
+ requestBodySchema: null,
2197
+ responseSchema: {
2198
+ $ref: "#/components/schemas/tenant_profileListResponse",
2199
+ },
2200
+ requiredParams: ["namespace"],
2201
+ operationId: "ves.io.schema.tenant_management.tenant_profile.API.List",
2202
+ tags: ["Other"],
2203
+ sourceFile: "domains/tenant_management.json",
2204
+ },
2205
+ {
2206
+ toolName: "f5xc-api-tenantmanagement-tenant-profile-update",
2207
+ method: "PUT",
2208
+ path: "/api/web/namespaces/{metadata.namespace}/tenant_profiles/{metadata.name}",
2209
+ operation: "update",
2210
+ domain: "tenant_management",
2211
+ resource: "tenant-profile",
2212
+ summary: "Replace Tenant Profile.",
2213
+ description: "Replaces attributes of a tenant_profile configuration.",
2214
+ pathParameters: [
2215
+ {
2216
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
2217
+ in: "path",
2218
+ name: "metadata.name",
2219
+ required: true,
2220
+ schema: {
2221
+ type: "string",
2222
+ },
2223
+ },
2224
+ {
2225
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
2226
+ in: "path",
2227
+ name: "metadata.namespace",
2228
+ required: true,
2229
+ schema: {
2230
+ type: "string",
2231
+ },
2232
+ },
2233
+ ],
2234
+ queryParameters: [],
2235
+ requestBodySchema: {
2236
+ $ref: "#/components/schemas/tenant_profileReplaceRequest",
2237
+ },
2238
+ responseSchema: {
2239
+ $ref: "#/components/schemas/tenant_profileReplaceResponse",
2240
+ },
2241
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
2242
+ operationId: "ves.io.schema.tenant_management.tenant_profile.API.Replace",
2243
+ tags: ["Other"],
2244
+ sourceFile: "domains/tenant_management.json",
2245
+ },
2246
+ {
2247
+ toolName: "f5xc-api-tenantmanagement-unassign-create",
2248
+ method: "POST",
2249
+ path: "/api/web/namespaces/system/tenant/domain_owner/unassign",
2250
+ operation: "create",
2251
+ domain: "tenant_management",
2252
+ resource: "unassign",
2253
+ summary: "Unassign domain owner.",
2254
+ description: "Unassign domain owner tries to remove domain owner privilege from user in the request.\nIt checks that requester is domain owner.\nIt implies such steps:\n1) remove domain owner boolean flag\n2) if tenant has SSO enabled:\n- mark user as SSO\n- DELETE password credential\n- DELETE OTP credential (if exists)\nNOTE: previously granted roles (including admin roles) will be retained.",
2255
+ pathParameters: [],
2256
+ queryParameters: [],
2257
+ requestBodySchema: {
2258
+ $ref: "#/components/schemas/tenantUnassignDomainOwnerRequest",
2259
+ },
2260
+ responseSchema: {
2261
+ $ref: "#/components/schemas/schematenantEmpty",
2262
+ },
2263
+ requiredParams: ["body"],
2264
+ operationId: "ves.io.schema.tenant.CustomAPI.UnassignDomainOwner",
2265
+ tags: ["Tenant Management"],
2266
+ sourceFile: "domains/tenant_management.json",
2267
+ },
2268
+ {
2269
+ toolName: "f5xc-api-tenantmanagement-unsubscribe-create",
2270
+ method: "POST",
2271
+ path: "/api/web/namespaces/system/tenant_management/delegated_access/unsubscribe",
2272
+ operation: "create",
2273
+ domain: "tenant_management",
2274
+ resource: "unsubscribe",
2275
+ summary: "Unsubscribe Delegated Access Addon Service.",
2276
+ description: "Unsubscribe Delegated Access addon service feature. A support request will be created and request will be processed upon approval.",
2277
+ pathParameters: [],
2278
+ queryParameters: [],
2279
+ requestBodySchema: {
2280
+ $ref: "#/components/schemas/tenant_managementUnsubscribeRequest",
2281
+ },
2282
+ responseSchema: {
2283
+ $ref: "#/components/schemas/tenant_managementUnsubscribeResponse",
2284
+ },
2285
+ requiredParams: ["body"],
2286
+ operationId: "ves.io.schema.tenant_management.CustomAPI.DelegatedAccessUnsubscribe",
2287
+ tags: ["Tenant Management"],
2288
+ sourceFile: "domains/tenant_management.json",
2289
+ },
2290
+ ];
2291
+ export default tenant_managementTools;
2292
+ //# sourceMappingURL=index.js.map