@robinmordasiewicz/f5xc-api-mcp 3.3.1 → 3.5.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 (262) hide show
  1. package/dist/generator/openapi-parser.d.ts +355 -0
  2. package/dist/generator/openapi-parser.d.ts.map +1 -1
  3. package/dist/generator/openapi-parser.js +202 -2
  4. package/dist/generator/openapi-parser.js.map +1 -1
  5. package/dist/generator/tool-generator.d.ts +29 -2
  6. package/dist/generator/tool-generator.d.ts.map +1 -1
  7. package/dist/generator/tool-generator.js +144 -28
  8. package/dist/generator/tool-generator.js.map +1 -1
  9. package/dist/index.d.ts +2 -10
  10. package/dist/index.d.ts.map +1 -1
  11. package/dist/index.js +28 -33
  12. package/dist/index.js.map +1 -1
  13. package/dist/prompts/workflows.d.ts.map +1 -1
  14. package/dist/prompts/workflows.js +30 -174
  15. package/dist/prompts/workflows.js.map +1 -1
  16. package/dist/resources/handlers.d.ts +0 -2
  17. package/dist/resources/handlers.d.ts.map +1 -1
  18. package/dist/resources/handlers.js +0 -51
  19. package/dist/resources/handlers.js.map +1 -1
  20. package/dist/server.d.ts +1 -1
  21. package/dist/server.d.ts.map +1 -1
  22. package/dist/server.js +1 -2
  23. package/dist/server.js.map +1 -1
  24. package/dist/tools/discovery/describe.d.ts +1 -0
  25. package/dist/tools/discovery/describe.d.ts.map +1 -1
  26. package/dist/tools/discovery/describe.js +10 -8
  27. package/dist/tools/discovery/describe.js.map +1 -1
  28. package/dist/tools/discovery/execute.d.ts +1 -3
  29. package/dist/tools/discovery/execute.d.ts.map +1 -1
  30. package/dist/tools/discovery/execute.js +1 -34
  31. package/dist/tools/discovery/execute.js.map +1 -1
  32. package/dist/tools/generated/admin_console_and_ui/index.d.ts +8 -0
  33. package/dist/tools/generated/admin_console_and_ui/index.d.ts.map +1 -0
  34. package/dist/tools/generated/admin_console_and_ui/index.js +259 -0
  35. package/dist/tools/generated/admin_console_and_ui/index.js.map +1 -0
  36. package/dist/tools/generated/api/index.d.ts +8 -0
  37. package/dist/tools/generated/{vpn → api}/index.d.ts.map +1 -1
  38. package/dist/tools/generated/api/index.js +5812 -0
  39. package/dist/tools/generated/api/index.js.map +1 -0
  40. package/dist/tools/generated/authentication/index.d.ts +8 -0
  41. package/dist/tools/generated/authentication/index.d.ts.map +1 -0
  42. package/dist/tools/generated/authentication/index.js +858 -0
  43. package/dist/tools/generated/authentication/index.js.map +1 -0
  44. package/dist/tools/generated/bigip/index.d.ts.map +1 -1
  45. package/dist/tools/generated/bigip/index.js +1660 -0
  46. package/dist/tools/generated/bigip/index.js.map +1 -1
  47. package/dist/tools/generated/billing_and_usage/index.d.ts +8 -0
  48. package/dist/tools/generated/billing_and_usage/index.d.ts.map +1 -0
  49. package/dist/tools/generated/billing_and_usage/index.js +2283 -0
  50. package/dist/tools/generated/billing_and_usage/index.js.map +1 -0
  51. package/dist/tools/generated/blindfold/index.d.ts +8 -0
  52. package/dist/tools/generated/blindfold/index.d.ts.map +1 -0
  53. package/dist/tools/generated/blindfold/index.js +3462 -0
  54. package/dist/tools/generated/blindfold/index.js.map +1 -0
  55. package/dist/tools/generated/bot_and_threat_defense/index.d.ts +8 -0
  56. package/dist/tools/generated/bot_and_threat_defense/index.d.ts.map +1 -0
  57. package/dist/tools/generated/bot_and_threat_defense/index.js +2264 -0
  58. package/dist/tools/generated/bot_and_threat_defense/index.js.map +1 -0
  59. package/dist/tools/generated/cdn/index.d.ts.map +1 -1
  60. package/dist/tools/generated/cdn/index.js +1498 -0
  61. package/dist/tools/generated/cdn/index.js.map +1 -1
  62. package/dist/tools/generated/ce_management/index.d.ts +8 -0
  63. package/dist/tools/generated/ce_management/index.d.ts.map +1 -0
  64. package/dist/tools/generated/ce_management/index.js +3437 -0
  65. package/dist/tools/generated/ce_management/index.js.map +1 -0
  66. package/dist/tools/generated/certificates/index.d.ts +8 -0
  67. package/dist/tools/generated/certificates/index.d.ts.map +1 -0
  68. package/dist/tools/generated/certificates/index.js +2279 -0
  69. package/dist/tools/generated/certificates/index.js.map +1 -0
  70. package/dist/tools/generated/cloud_infrastructure/index.d.ts +8 -0
  71. package/dist/tools/generated/cloud_infrastructure/index.d.ts.map +1 -0
  72. package/dist/tools/generated/cloud_infrastructure/index.js +3585 -0
  73. package/dist/tools/generated/cloud_infrastructure/index.js.map +1 -0
  74. package/dist/tools/generated/container_services/index.d.ts +8 -0
  75. package/dist/tools/generated/container_services/index.d.ts.map +1 -0
  76. package/dist/tools/generated/container_services/index.js +1806 -0
  77. package/dist/tools/generated/container_services/index.js.map +1 -0
  78. package/dist/tools/generated/data_and_privacy_security/index.d.ts +8 -0
  79. package/dist/tools/generated/data_and_privacy_security/index.d.ts.map +1 -0
  80. package/dist/tools/generated/data_and_privacy_security/index.js +1519 -0
  81. package/dist/tools/generated/data_and_privacy_security/index.js.map +1 -0
  82. package/dist/tools/generated/data_intelligence/index.d.ts +8 -0
  83. package/dist/tools/generated/data_intelligence/index.d.ts.map +1 -0
  84. package/dist/tools/generated/data_intelligence/index.js +1495 -0
  85. package/dist/tools/generated/data_intelligence/index.js.map +1 -0
  86. package/dist/tools/generated/ddos/index.d.ts +8 -0
  87. package/dist/tools/generated/ddos/index.d.ts.map +1 -0
  88. package/dist/tools/generated/ddos/index.js +7427 -0
  89. package/dist/tools/generated/ddos/index.js.map +1 -0
  90. package/dist/tools/generated/dns/index.d.ts +8 -0
  91. package/dist/tools/generated/dns/index.d.ts.map +1 -0
  92. package/dist/tools/generated/dns/index.js +5604 -0
  93. package/dist/tools/generated/dns/index.js.map +1 -0
  94. package/dist/tools/generated/generative_ai/index.d.ts +8 -0
  95. package/dist/tools/generated/generative_ai/index.d.ts.map +1 -0
  96. package/dist/tools/generated/generative_ai/index.js +972 -0
  97. package/dist/tools/generated/generative_ai/index.js.map +1 -0
  98. package/dist/tools/generated/managed_kubernetes/index.d.ts +8 -0
  99. package/dist/tools/generated/managed_kubernetes/index.d.ts.map +1 -0
  100. package/dist/tools/generated/managed_kubernetes/index.js +2858 -0
  101. package/dist/tools/generated/managed_kubernetes/index.js.map +1 -0
  102. package/dist/tools/generated/marketplace/index.d.ts +8 -0
  103. package/dist/tools/generated/marketplace/index.d.ts.map +1 -0
  104. package/dist/tools/generated/marketplace/index.js +4022 -0
  105. package/dist/tools/generated/marketplace/index.js.map +1 -0
  106. package/dist/tools/generated/network/index.d.ts +8 -0
  107. package/dist/tools/generated/network/index.d.ts.map +1 -0
  108. package/dist/tools/generated/network/index.js +11132 -0
  109. package/dist/tools/generated/network/index.js.map +1 -0
  110. package/dist/tools/generated/network_security/index.d.ts +8 -0
  111. package/dist/tools/generated/network_security/index.d.ts.map +1 -0
  112. package/dist/tools/generated/network_security/index.js +7827 -0
  113. package/dist/tools/generated/network_security/index.js.map +1 -0
  114. package/dist/tools/generated/nginx_one/index.d.ts +8 -0
  115. package/dist/tools/generated/nginx_one/index.d.ts.map +1 -0
  116. package/dist/tools/generated/nginx_one/index.js +1598 -0
  117. package/dist/tools/generated/nginx_one/index.js.map +1 -0
  118. package/dist/tools/generated/object_storage/index.d.ts +8 -0
  119. package/dist/tools/generated/object_storage/index.d.ts.map +1 -0
  120. package/dist/tools/generated/object_storage/index.js +964 -0
  121. package/dist/tools/generated/object_storage/index.js.map +1 -0
  122. package/dist/tools/generated/observability/index.d.ts.map +1 -1
  123. package/dist/tools/generated/observability/index.js +3521 -4641
  124. package/dist/tools/generated/observability/index.js.map +1 -1
  125. package/dist/tools/generated/rate_limiting/index.d.ts +8 -0
  126. package/dist/tools/generated/rate_limiting/index.d.ts.map +1 -0
  127. package/dist/tools/generated/rate_limiting/index.js +1712 -0
  128. package/dist/tools/generated/rate_limiting/index.js.map +1 -0
  129. package/dist/tools/generated/secops_and_incident_response/index.d.ts +8 -0
  130. package/dist/tools/generated/secops_and_incident_response/index.d.ts.map +1 -0
  131. package/dist/tools/generated/secops_and_incident_response/index.js +578 -0
  132. package/dist/tools/generated/secops_and_incident_response/index.js.map +1 -0
  133. package/dist/tools/generated/service_mesh/index.d.ts.map +1 -1
  134. package/dist/tools/generated/service_mesh/index.js +3810 -438
  135. package/dist/tools/generated/service_mesh/index.js.map +1 -1
  136. package/dist/tools/generated/shape/index.d.ts +8 -0
  137. package/dist/tools/generated/shape/index.d.ts.map +1 -0
  138. package/dist/tools/generated/shape/index.js +18464 -0
  139. package/dist/tools/generated/shape/index.js.map +1 -0
  140. package/dist/tools/generated/sites/index.d.ts +8 -0
  141. package/dist/tools/generated/sites/index.d.ts.map +1 -0
  142. package/dist/tools/generated/sites/index.js +11494 -0
  143. package/dist/tools/generated/sites/index.js.map +1 -0
  144. package/dist/tools/generated/statistics/index.d.ts +8 -0
  145. package/dist/tools/generated/statistics/index.d.ts.map +1 -0
  146. package/dist/tools/generated/statistics/index.js +7557 -0
  147. package/dist/tools/generated/statistics/index.js.map +1 -0
  148. package/dist/tools/generated/support/index.d.ts +8 -0
  149. package/dist/tools/generated/support/index.d.ts.map +1 -0
  150. package/dist/tools/generated/support/index.js +5334 -0
  151. package/dist/tools/generated/support/index.js.map +1 -0
  152. package/dist/tools/generated/telemetry_and_insights/index.d.ts +8 -0
  153. package/dist/tools/generated/telemetry_and_insights/index.d.ts.map +1 -0
  154. package/dist/tools/generated/telemetry_and_insights/index.js +2304 -0
  155. package/dist/tools/generated/telemetry_and_insights/index.js.map +1 -0
  156. package/dist/tools/generated/tenant_and_identity/index.d.ts +8 -0
  157. package/dist/tools/generated/tenant_and_identity/index.d.ts.map +1 -0
  158. package/dist/tools/generated/tenant_and_identity/index.js +17560 -0
  159. package/dist/tools/generated/tenant_and_identity/index.js.map +1 -0
  160. package/dist/tools/generated/threat_campaign/index.d.ts +8 -0
  161. package/dist/tools/generated/threat_campaign/index.d.ts.map +1 -0
  162. package/dist/tools/generated/threat_campaign/index.js +99 -0
  163. package/dist/tools/generated/threat_campaign/index.js.map +1 -0
  164. package/dist/tools/generated/users/index.d.ts +8 -0
  165. package/dist/tools/generated/users/index.d.ts.map +1 -0
  166. package/dist/tools/generated/users/index.js +1376 -0
  167. package/dist/tools/generated/users/index.js.map +1 -0
  168. package/dist/tools/generated/virtual/index.d.ts +8 -0
  169. package/dist/tools/generated/virtual/index.d.ts.map +1 -0
  170. package/dist/tools/generated/virtual/index.js +10103 -0
  171. package/dist/tools/generated/virtual/index.js.map +1 -0
  172. package/dist/tools/generated/vpm_and_node_management/index.d.ts +8 -0
  173. package/dist/tools/generated/vpm_and_node_management/index.d.ts.map +1 -0
  174. package/dist/tools/generated/vpm_and_node_management/index.js +85 -0
  175. package/dist/tools/generated/vpm_and_node_management/index.js.map +1 -0
  176. package/dist/tools/generated/waf/index.d.ts +8 -0
  177. package/dist/tools/generated/waf/index.d.ts.map +1 -0
  178. package/dist/tools/generated/waf/index.js +3802 -0
  179. package/dist/tools/generated/waf/index.js.map +1 -0
  180. package/dist/tools/registry.d.ts.map +1 -1
  181. package/dist/tools/registry.js +68 -36
  182. package/dist/tools/registry.js.map +1 -1
  183. package/package.json +3 -1
  184. package/dist/cli/index.d.ts +0 -16
  185. package/dist/cli/index.d.ts.map +0 -1
  186. package/dist/cli/index.js +0 -116
  187. package/dist/cli/index.js.map +0 -1
  188. package/dist/cli/setup.d.ts +0 -54
  189. package/dist/cli/setup.d.ts.map +0 -1
  190. package/dist/cli/setup.js +0 -347
  191. package/dist/cli/setup.js.map +0 -1
  192. package/dist/tools/generated/ai_intelligence/index.d.ts +0 -8
  193. package/dist/tools/generated/ai_intelligence/index.d.ts.map +0 -1
  194. package/dist/tools/generated/ai_intelligence/index.js +0 -282
  195. package/dist/tools/generated/ai_intelligence/index.js.map +0 -1
  196. package/dist/tools/generated/api_security/index.d.ts +0 -8
  197. package/dist/tools/generated/api_security/index.d.ts.map +0 -1
  198. package/dist/tools/generated/api_security/index.js +0 -1852
  199. package/dist/tools/generated/api_security/index.js.map +0 -1
  200. package/dist/tools/generated/applications/index.d.ts +0 -8
  201. package/dist/tools/generated/applications/index.d.ts.map +0 -1
  202. package/dist/tools/generated/applications/index.js +0 -1589
  203. package/dist/tools/generated/applications/index.js.map +0 -1
  204. package/dist/tools/generated/billing/index.d.ts +0 -8
  205. package/dist/tools/generated/billing/index.d.ts.map +0 -1
  206. package/dist/tools/generated/billing/index.js +0 -759
  207. package/dist/tools/generated/billing/index.js.map +0 -1
  208. package/dist/tools/generated/config/index.d.ts +0 -8
  209. package/dist/tools/generated/config/index.d.ts.map +0 -1
  210. package/dist/tools/generated/config/index.js +0 -316
  211. package/dist/tools/generated/config/index.js.map +0 -1
  212. package/dist/tools/generated/identity/index.d.ts +0 -8
  213. package/dist/tools/generated/identity/index.d.ts.map +0 -1
  214. package/dist/tools/generated/identity/index.js +0 -5371
  215. package/dist/tools/generated/identity/index.js.map +0 -1
  216. package/dist/tools/generated/infrastructure/index.d.ts +0 -8
  217. package/dist/tools/generated/infrastructure/index.d.ts.map +0 -1
  218. package/dist/tools/generated/infrastructure/index.js +0 -5342
  219. package/dist/tools/generated/infrastructure/index.js.map +0 -1
  220. package/dist/tools/generated/infrastructure_protection/index.d.ts +0 -8
  221. package/dist/tools/generated/infrastructure_protection/index.d.ts.map +0 -1
  222. package/dist/tools/generated/infrastructure_protection/index.js +0 -2919
  223. package/dist/tools/generated/infrastructure_protection/index.js.map +0 -1
  224. package/dist/tools/generated/integrations/index.d.ts +0 -8
  225. package/dist/tools/generated/integrations/index.d.ts.map +0 -1
  226. package/dist/tools/generated/integrations/index.js +0 -1995
  227. package/dist/tools/generated/integrations/index.js.map +0 -1
  228. package/dist/tools/generated/load_balancer/index.d.ts +0 -8
  229. package/dist/tools/generated/load_balancer/index.d.ts.map +0 -1
  230. package/dist/tools/generated/load_balancer/index.js +0 -2269
  231. package/dist/tools/generated/load_balancer/index.js.map +0 -1
  232. package/dist/tools/generated/networking/index.d.ts +0 -8
  233. package/dist/tools/generated/networking/index.d.ts.map +0 -1
  234. package/dist/tools/generated/networking/index.js +0 -11289
  235. package/dist/tools/generated/networking/index.js.map +0 -1
  236. package/dist/tools/generated/nginx/index.d.ts +0 -8
  237. package/dist/tools/generated/nginx/index.d.ts.map +0 -1
  238. package/dist/tools/generated/nginx/index.js +0 -680
  239. package/dist/tools/generated/nginx/index.js.map +0 -1
  240. package/dist/tools/generated/operations/index.d.ts +0 -8
  241. package/dist/tools/generated/operations/index.d.ts.map +0 -1
  242. package/dist/tools/generated/operations/index.js +0 -1759
  243. package/dist/tools/generated/operations/index.js.map +0 -1
  244. package/dist/tools/generated/security/index.d.ts +0 -8
  245. package/dist/tools/generated/security/index.d.ts.map +0 -1
  246. package/dist/tools/generated/security/index.js +0 -9111
  247. package/dist/tools/generated/security/index.js.map +0 -1
  248. package/dist/tools/generated/shape_security/index.d.ts +0 -8
  249. package/dist/tools/generated/shape_security/index.d.ts.map +0 -1
  250. package/dist/tools/generated/shape_security/index.js +0 -4121
  251. package/dist/tools/generated/shape_security/index.js.map +0 -1
  252. package/dist/tools/generated/subscriptions/index.d.ts +0 -8
  253. package/dist/tools/generated/subscriptions/index.d.ts.map +0 -1
  254. package/dist/tools/generated/subscriptions/index.js +0 -778
  255. package/dist/tools/generated/subscriptions/index.js.map +0 -1
  256. package/dist/tools/generated/tenant_management/index.d.ts +0 -8
  257. package/dist/tools/generated/tenant_management/index.d.ts.map +0 -1
  258. package/dist/tools/generated/tenant_management/index.js +0 -2292
  259. package/dist/tools/generated/tenant_management/index.js.map +0 -1
  260. package/dist/tools/generated/vpn/index.d.ts +0 -8
  261. package/dist/tools/generated/vpn/index.js +0 -1183
  262. package/dist/tools/generated/vpn/index.js.map +0 -1
@@ -0,0 +1,858 @@
1
+ /**
2
+ * Generated tool definitions for authentication domain
3
+ * DO NOT EDIT - This file is auto-generated by scripts/generate.ts
4
+ */
5
+ export const authenticationTools = [
6
+ {
7
+ toolName: "f5xc-api-authentication-api-credential-create",
8
+ method: "POST",
9
+ path: "/api/web/namespaces/system/bulk_revoke/api_credentials",
10
+ operation: "create",
11
+ domain: "authentication",
12
+ resource: "api-credential",
13
+ summary: "Bulk Revoke API credentials.",
14
+ description: "It is used to revoke multiple API credentials. This API would disable the credentials and mark them for deletion.\nThe actual removal of objects would be done in the background.\nDepending upon if user is admin or not, following behaviour is supported:-\n* for admins : user has the access to DELETE their own as well as credentials created by others\n* for non-admins: user can only DELETE their own credentials.",
15
+ pathParameters: [],
16
+ queryParameters: [],
17
+ requestBodySchema: null,
18
+ responseSchema: {
19
+ $ref: "#/components/schemas/api_credentialBulkRevokeResponse",
20
+ },
21
+ requiredParams: [],
22
+ operationId: "ves.io.schema.api_credential.CustomAPI.BulkRevoke",
23
+ tags: ["Other"],
24
+ sourceFile: "domains/authentication.json",
25
+ displayName: null,
26
+ dangerLevel: "medium",
27
+ sideEffects: {
28
+ creates: ["api-credential"],
29
+ },
30
+ requiredFields: ["metadata.name", "metadata.namespace"],
31
+ confirmationRequired: false,
32
+ parameterExamples: {},
33
+ validationRules: {},
34
+ operationMetadata: {
35
+ common_errors: [
36
+ {
37
+ code: 401,
38
+ message: "Authentication required",
39
+ solution: "Provide valid API credentials",
40
+ },
41
+ {
42
+ code: 403,
43
+ message: "Permission denied",
44
+ solution: "Check access permissions for this operation",
45
+ },
46
+ {
47
+ code: 404,
48
+ message: "Resource not found",
49
+ solution: "Verify resource name, namespace, and path",
50
+ },
51
+ {
52
+ code: 409,
53
+ message: "Resource already exists",
54
+ solution: "Use different name or update existing resource",
55
+ },
56
+ {
57
+ code: 429,
58
+ message: "Rate limit exceeded",
59
+ solution: "Wait before retrying the operation",
60
+ },
61
+ {
62
+ code: 500,
63
+ message: "Server error",
64
+ solution: "Retry operation or contact support",
65
+ },
66
+ ],
67
+ conditions: {
68
+ postconditions: ["Api-credential resource created", "Resource assigned unique identifier"],
69
+ prerequisites: ["Active namespace"],
70
+ },
71
+ confirmation_required: false,
72
+ danger_level: "medium",
73
+ field_docs: {},
74
+ optional_fields: [],
75
+ performance_impact: {
76
+ latency: "high",
77
+ resource_usage: "high",
78
+ },
79
+ purpose: "Create new api-credential",
80
+ required_fields: ["metadata.name", "metadata.namespace"],
81
+ side_effects: {
82
+ creates: ["api-credential"],
83
+ },
84
+ },
85
+ curlExample: null,
86
+ },
87
+ {
88
+ toolName: "f5xc-api-authentication-api-credential-get",
89
+ method: "GET",
90
+ path: "/api/web/namespaces/{namespace}/api_credentials/{name}",
91
+ operation: "get",
92
+ domain: "authentication",
93
+ resource: "api-credential",
94
+ summary: "GET API Credentials.",
95
+ description: "GET implements API credential query by name.\nReturns API credential object. Query will look into tenants system namespace for API credential by name.",
96
+ pathParameters: [
97
+ {
98
+ description: "Credential name\n\nx-required\nName of API credential.",
99
+ in: "path",
100
+ name: "name",
101
+ required: true,
102
+ schema: {
103
+ type: "string",
104
+ },
105
+ "x-displayname": "Name",
106
+ "x-ves-example": "Value",
107
+ },
108
+ {
109
+ description: 'Namespace\n\nx-required\nValue of namespace is always "system".',
110
+ in: "path",
111
+ name: "namespace",
112
+ required: true,
113
+ schema: {
114
+ type: "string",
115
+ },
116
+ "x-displayname": "Namespace",
117
+ "x-ves-example": "System",
118
+ },
119
+ ],
120
+ queryParameters: [],
121
+ requestBodySchema: null,
122
+ responseSchema: {
123
+ $ref: "#/components/schemas/api_credentialGetResponse",
124
+ },
125
+ requiredParams: ["name", "namespace"],
126
+ operationId: "ves.io.schema.api_credential.CustomAPI.Get",
127
+ tags: ["Other"],
128
+ sourceFile: "domains/authentication.json",
129
+ displayName: null,
130
+ dangerLevel: "low",
131
+ sideEffects: null,
132
+ requiredFields: ["path.name", "path.namespace"],
133
+ confirmationRequired: false,
134
+ parameterExamples: {
135
+ name: "Value",
136
+ namespace: "System",
137
+ },
138
+ validationRules: {},
139
+ operationMetadata: {
140
+ common_errors: [
141
+ {
142
+ code: 401,
143
+ message: "Authentication required",
144
+ solution: "Provide valid API credentials",
145
+ },
146
+ {
147
+ code: 403,
148
+ message: "Permission denied",
149
+ solution: "Check access permissions for this operation",
150
+ },
151
+ {
152
+ code: 404,
153
+ message: "Resource not found",
154
+ solution: "Verify resource name, namespace, and path",
155
+ },
156
+ {
157
+ code: 409,
158
+ message: "Resource already exists",
159
+ solution: "Use different name or update existing resource",
160
+ },
161
+ {
162
+ code: 429,
163
+ message: "Rate limit exceeded",
164
+ solution: "Wait before retrying the operation",
165
+ },
166
+ {
167
+ code: 500,
168
+ message: "Server error",
169
+ solution: "Retry operation or contact support",
170
+ },
171
+ ],
172
+ conditions: {
173
+ postconditions: [],
174
+ prerequisites: ["Active namespace"],
175
+ },
176
+ confirmation_required: false,
177
+ danger_level: "low",
178
+ field_docs: {},
179
+ optional_fields: [],
180
+ performance_impact: {
181
+ latency: "low",
182
+ resource_usage: "low",
183
+ },
184
+ purpose: "Retrieve specific api-credential",
185
+ required_fields: ["path.name", "path.namespace"],
186
+ side_effects: {},
187
+ },
188
+ curlExample: null,
189
+ },
190
+ {
191
+ toolName: "f5xc-api-authentication-api-credential-list",
192
+ method: "GET",
193
+ path: "/api/web/namespaces/{namespace}/api_credentials",
194
+ operation: "list",
195
+ domain: "authentication",
196
+ resource: "api-credential",
197
+ summary: "List API Credentials.",
198
+ description: "Returns list of API credential of all types created by the user.\nQuery will look into tenants system namespace.",
199
+ pathParameters: [
200
+ {
201
+ description: 'Namespace\nValue of namespace is always "system".',
202
+ in: "path",
203
+ name: "namespace",
204
+ required: true,
205
+ schema: {
206
+ type: "string",
207
+ },
208
+ "x-displayname": "Namespace",
209
+ "x-ves-example": "Value",
210
+ },
211
+ ],
212
+ queryParameters: [],
213
+ requestBodySchema: null,
214
+ responseSchema: {
215
+ $ref: "#/components/schemas/api_credentialListResponse",
216
+ },
217
+ requiredParams: ["namespace"],
218
+ operationId: "ves.io.schema.api_credential.CustomAPI.List",
219
+ tags: ["Other"],
220
+ sourceFile: "domains/authentication.json",
221
+ displayName: null,
222
+ dangerLevel: "low",
223
+ sideEffects: null,
224
+ requiredFields: ["path.namespace"],
225
+ confirmationRequired: false,
226
+ parameterExamples: {
227
+ namespace: "Value",
228
+ },
229
+ validationRules: {},
230
+ operationMetadata: {
231
+ common_errors: [
232
+ {
233
+ code: 401,
234
+ message: "Authentication required",
235
+ solution: "Provide valid API credentials",
236
+ },
237
+ {
238
+ code: 403,
239
+ message: "Permission denied",
240
+ solution: "Check access permissions for this operation",
241
+ },
242
+ {
243
+ code: 404,
244
+ message: "Resource not found",
245
+ solution: "Verify resource name, namespace, and path",
246
+ },
247
+ {
248
+ code: 409,
249
+ message: "Resource already exists",
250
+ solution: "Use different name or update existing resource",
251
+ },
252
+ {
253
+ code: 429,
254
+ message: "Rate limit exceeded",
255
+ solution: "Wait before retrying the operation",
256
+ },
257
+ {
258
+ code: 500,
259
+ message: "Server error",
260
+ solution: "Retry operation or contact support",
261
+ },
262
+ ],
263
+ conditions: {
264
+ postconditions: [],
265
+ prerequisites: ["Active namespace"],
266
+ },
267
+ confirmation_required: false,
268
+ danger_level: "low",
269
+ field_docs: {},
270
+ optional_fields: [],
271
+ performance_impact: {
272
+ latency: "moderate",
273
+ resource_usage: "moderate",
274
+ },
275
+ purpose: "List all api-credentials",
276
+ required_fields: ["path.namespace"],
277
+ side_effects: {},
278
+ },
279
+ curlExample: null,
280
+ },
281
+ {
282
+ toolName: "f5xc-api-authentication-scim-token-create",
283
+ method: "POST",
284
+ path: "/api/web/namespaces/{namespace}/revoke/scim_token",
285
+ operation: "create",
286
+ domain: "authentication",
287
+ resource: "scim-token",
288
+ summary: "Revoke SCIM API credential.",
289
+ description: "For SCIM API credential revoke/deletion.",
290
+ pathParameters: [
291
+ {
292
+ description: 'Namespace\n\nx-required\nValue of namespace is always "system".',
293
+ in: "path",
294
+ name: "namespace",
295
+ required: true,
296
+ schema: {
297
+ type: "string",
298
+ },
299
+ "x-displayname": "Namespace",
300
+ "x-ves-example": "System",
301
+ },
302
+ ],
303
+ queryParameters: [],
304
+ requestBodySchema: {
305
+ $ref: "#/components/schemas/api_credentialScimTokenRequest",
306
+ },
307
+ responseSchema: {
308
+ $ref: "#/components/schemas/api_credentialStatusResponse",
309
+ },
310
+ requiredParams: ["body", "namespace"],
311
+ operationId: "ves.io.schema.api_credential.CustomAPI.RevokeScimToken",
312
+ tags: ["Other"],
313
+ sourceFile: "domains/authentication.json",
314
+ displayName: null,
315
+ dangerLevel: "medium",
316
+ sideEffects: {
317
+ creates: ["scim-token"],
318
+ },
319
+ requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
320
+ confirmationRequired: false,
321
+ parameterExamples: {
322
+ namespace: "System",
323
+ },
324
+ validationRules: {},
325
+ operationMetadata: {
326
+ common_errors: [
327
+ {
328
+ code: 401,
329
+ message: "Authentication required",
330
+ solution: "Provide valid API credentials",
331
+ },
332
+ {
333
+ code: 403,
334
+ message: "Permission denied",
335
+ solution: "Check access permissions for this operation",
336
+ },
337
+ {
338
+ code: 404,
339
+ message: "Resource not found",
340
+ solution: "Verify resource name, namespace, and path",
341
+ },
342
+ {
343
+ code: 409,
344
+ message: "Resource already exists",
345
+ solution: "Use different name or update existing resource",
346
+ },
347
+ {
348
+ code: 429,
349
+ message: "Rate limit exceeded",
350
+ solution: "Wait before retrying the operation",
351
+ },
352
+ {
353
+ code: 500,
354
+ message: "Server error",
355
+ solution: "Retry operation or contact support",
356
+ },
357
+ ],
358
+ conditions: {
359
+ postconditions: ["Scim-token resource created", "Resource assigned unique identifier"],
360
+ prerequisites: ["Active namespace"],
361
+ },
362
+ confirmation_required: false,
363
+ danger_level: "medium",
364
+ field_docs: {},
365
+ optional_fields: [],
366
+ performance_impact: {
367
+ latency: "low",
368
+ resource_usage: "low",
369
+ },
370
+ purpose: "Create new scim-token",
371
+ required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
372
+ side_effects: {
373
+ creates: ["scim-token"],
374
+ },
375
+ },
376
+ curlExample: null,
377
+ },
378
+ {
379
+ toolName: "f5xc-api-authentication-scim-token-list",
380
+ method: "GET",
381
+ path: "/api/web/namespaces/{namespace}/scim_token",
382
+ operation: "list",
383
+ domain: "authentication",
384
+ resource: "scim-token",
385
+ summary: "GET Scim Token.",
386
+ description: "GetScimToken implements querying of scim token.\nSCIM API token value will be visible only on create API response.\nThis detail RPC will show the current token's expiry. Returns API credential object.",
387
+ pathParameters: [
388
+ {
389
+ description: 'Namespace\n\nx-required\nValue of namespace is always "system".',
390
+ in: "path",
391
+ name: "namespace",
392
+ required: true,
393
+ schema: {
394
+ type: "string",
395
+ },
396
+ "x-displayname": "Namespace",
397
+ "x-ves-example": "System",
398
+ },
399
+ ],
400
+ queryParameters: [],
401
+ requestBodySchema: null,
402
+ responseSchema: {
403
+ $ref: "#/components/schemas/api_credentialGetResponse",
404
+ },
405
+ requiredParams: ["namespace"],
406
+ operationId: "ves.io.schema.api_credential.CustomAPI.GetScimToken",
407
+ tags: ["Other"],
408
+ sourceFile: "domains/authentication.json",
409
+ displayName: null,
410
+ dangerLevel: "low",
411
+ sideEffects: null,
412
+ requiredFields: ["path.namespace"],
413
+ confirmationRequired: false,
414
+ parameterExamples: {
415
+ namespace: "System",
416
+ },
417
+ validationRules: {},
418
+ operationMetadata: {
419
+ common_errors: [
420
+ {
421
+ code: 401,
422
+ message: "Authentication required",
423
+ solution: "Provide valid API credentials",
424
+ },
425
+ {
426
+ code: 403,
427
+ message: "Permission denied",
428
+ solution: "Check access permissions for this operation",
429
+ },
430
+ {
431
+ code: 404,
432
+ message: "Resource not found",
433
+ solution: "Verify resource name, namespace, and path",
434
+ },
435
+ {
436
+ code: 409,
437
+ message: "Resource already exists",
438
+ solution: "Use different name or update existing resource",
439
+ },
440
+ {
441
+ code: 429,
442
+ message: "Rate limit exceeded",
443
+ solution: "Wait before retrying the operation",
444
+ },
445
+ {
446
+ code: 500,
447
+ message: "Server error",
448
+ solution: "Retry operation or contact support",
449
+ },
450
+ ],
451
+ conditions: {
452
+ postconditions: [],
453
+ prerequisites: ["Active namespace"],
454
+ },
455
+ confirmation_required: false,
456
+ danger_level: "low",
457
+ field_docs: {},
458
+ optional_fields: [],
459
+ performance_impact: {
460
+ latency: "moderate",
461
+ resource_usage: "moderate",
462
+ },
463
+ purpose: "List all scim-tokens",
464
+ required_fields: ["path.namespace"],
465
+ side_effects: {},
466
+ },
467
+ curlExample: null,
468
+ },
469
+ {
470
+ toolName: "f5xc-api-authentication-service-credential-create",
471
+ method: "POST",
472
+ path: "/api/web/namespaces/system/bulk_revoke/service_credentials",
473
+ operation: "create",
474
+ domain: "authentication",
475
+ resource: "service-credential",
476
+ summary: "Bulk Revoke service credential.",
477
+ description: "It is used to revoke multiple service credentials. This API would disable the credentials and mark them for deletion.\nThe actual removal of objects would be done in the background. Only admins are allowed to access this API.",
478
+ pathParameters: [],
479
+ queryParameters: [],
480
+ requestBodySchema: null,
481
+ responseSchema: {
482
+ $ref: "#/components/schemas/api_credentialBulkRevokeResponse",
483
+ },
484
+ requiredParams: [],
485
+ operationId: "ves.io.schema.api_credential.CustomAPI.BulkRevokeServiceCredentials",
486
+ tags: ["Other"],
487
+ sourceFile: "domains/authentication.json",
488
+ displayName: null,
489
+ dangerLevel: "medium",
490
+ sideEffects: {
491
+ creates: ["service-credential"],
492
+ },
493
+ requiredFields: ["metadata.name", "metadata.namespace"],
494
+ confirmationRequired: false,
495
+ parameterExamples: {},
496
+ validationRules: {},
497
+ operationMetadata: {
498
+ common_errors: [
499
+ {
500
+ code: 401,
501
+ message: "Authentication required",
502
+ solution: "Provide valid API credentials",
503
+ },
504
+ {
505
+ code: 403,
506
+ message: "Permission denied",
507
+ solution: "Check access permissions for this operation",
508
+ },
509
+ {
510
+ code: 404,
511
+ message: "Resource not found",
512
+ solution: "Verify resource name, namespace, and path",
513
+ },
514
+ {
515
+ code: 409,
516
+ message: "Resource already exists",
517
+ solution: "Use different name or update existing resource",
518
+ },
519
+ {
520
+ code: 429,
521
+ message: "Rate limit exceeded",
522
+ solution: "Wait before retrying the operation",
523
+ },
524
+ {
525
+ code: 500,
526
+ message: "Server error",
527
+ solution: "Retry operation or contact support",
528
+ },
529
+ ],
530
+ conditions: {
531
+ postconditions: [
532
+ "Service-credential resource created",
533
+ "Resource assigned unique identifier",
534
+ ],
535
+ prerequisites: ["Active namespace"],
536
+ },
537
+ confirmation_required: false,
538
+ danger_level: "medium",
539
+ field_docs: {},
540
+ optional_fields: [],
541
+ performance_impact: {
542
+ latency: "high",
543
+ resource_usage: "high",
544
+ },
545
+ purpose: "Create new service-credential",
546
+ required_fields: ["metadata.name", "metadata.namespace"],
547
+ side_effects: {
548
+ creates: ["service-credential"],
549
+ },
550
+ },
551
+ curlExample: null,
552
+ },
553
+ {
554
+ toolName: "f5xc-api-authentication-service-credential-get",
555
+ method: "GET",
556
+ path: "/api/web/namespaces/{namespace}/service_credentials/{name}",
557
+ operation: "get",
558
+ domain: "authentication",
559
+ resource: "service-credential",
560
+ summary: "GET Service Credential.",
561
+ description: "GET implements service credential query by name.\nReturns service credential object. Query will look into tenants system namespace for service credential by name.",
562
+ pathParameters: [
563
+ {
564
+ description: "Credential name\n\nx-required\nName of API credential.",
565
+ in: "path",
566
+ name: "name",
567
+ required: true,
568
+ schema: {
569
+ type: "string",
570
+ },
571
+ "x-displayname": "Name",
572
+ "x-ves-example": "Value",
573
+ },
574
+ {
575
+ description: 'Namespace\n\nx-required\nValue of namespace is always "system".',
576
+ in: "path",
577
+ name: "namespace",
578
+ required: true,
579
+ schema: {
580
+ type: "string",
581
+ },
582
+ "x-displayname": "Namespace",
583
+ "x-ves-example": "System",
584
+ },
585
+ ],
586
+ queryParameters: [],
587
+ requestBodySchema: null,
588
+ responseSchema: {
589
+ $ref: "#/components/schemas/api_credentialGetServiceCredentialsResponse",
590
+ },
591
+ requiredParams: ["name", "namespace"],
592
+ operationId: "ves.io.schema.api_credential.CustomAPI.GetServiceCredentials",
593
+ tags: ["Other"],
594
+ sourceFile: "domains/authentication.json",
595
+ displayName: null,
596
+ dangerLevel: "low",
597
+ sideEffects: null,
598
+ requiredFields: ["path.name", "path.namespace"],
599
+ confirmationRequired: false,
600
+ parameterExamples: {
601
+ name: "Value",
602
+ namespace: "System",
603
+ },
604
+ validationRules: {},
605
+ operationMetadata: {
606
+ common_errors: [
607
+ {
608
+ code: 401,
609
+ message: "Authentication required",
610
+ solution: "Provide valid API credentials",
611
+ },
612
+ {
613
+ code: 403,
614
+ message: "Permission denied",
615
+ solution: "Check access permissions for this operation",
616
+ },
617
+ {
618
+ code: 404,
619
+ message: "Resource not found",
620
+ solution: "Verify resource name, namespace, and path",
621
+ },
622
+ {
623
+ code: 409,
624
+ message: "Resource already exists",
625
+ solution: "Use different name or update existing resource",
626
+ },
627
+ {
628
+ code: 429,
629
+ message: "Rate limit exceeded",
630
+ solution: "Wait before retrying the operation",
631
+ },
632
+ {
633
+ code: 500,
634
+ message: "Server error",
635
+ solution: "Retry operation or contact support",
636
+ },
637
+ ],
638
+ conditions: {
639
+ postconditions: [],
640
+ prerequisites: ["Active namespace"],
641
+ },
642
+ confirmation_required: false,
643
+ danger_level: "low",
644
+ field_docs: {},
645
+ optional_fields: [],
646
+ performance_impact: {
647
+ latency: "low",
648
+ resource_usage: "low",
649
+ },
650
+ purpose: "Retrieve specific service-credential",
651
+ required_fields: ["path.name", "path.namespace"],
652
+ side_effects: {},
653
+ },
654
+ curlExample: null,
655
+ },
656
+ {
657
+ toolName: "f5xc-api-authentication-service-credential-list",
658
+ method: "GET",
659
+ path: "/api/web/namespaces/{namespace}/service_credentials",
660
+ operation: "list",
661
+ domain: "authentication",
662
+ resource: "service-credential",
663
+ summary: "List service credentials.",
664
+ description: "Request to list service credentials created by user.",
665
+ pathParameters: [
666
+ {
667
+ description: 'Namespace\nValue of namespace is always "system".',
668
+ in: "path",
669
+ name: "namespace",
670
+ required: true,
671
+ schema: {
672
+ type: "string",
673
+ },
674
+ "x-displayname": "Namespace",
675
+ "x-ves-example": "Value",
676
+ },
677
+ ],
678
+ queryParameters: [],
679
+ requestBodySchema: null,
680
+ responseSchema: {
681
+ $ref: "#/components/schemas/api_credentialListServiceCredentialsResponse",
682
+ },
683
+ requiredParams: ["namespace"],
684
+ operationId: "ves.io.schema.api_credential.CustomAPI.ListServiceCredentials",
685
+ tags: ["Other"],
686
+ sourceFile: "domains/authentication.json",
687
+ displayName: null,
688
+ dangerLevel: "low",
689
+ sideEffects: null,
690
+ requiredFields: ["path.namespace"],
691
+ confirmationRequired: false,
692
+ parameterExamples: {
693
+ namespace: "Value",
694
+ },
695
+ validationRules: {},
696
+ operationMetadata: {
697
+ common_errors: [
698
+ {
699
+ code: 401,
700
+ message: "Authentication required",
701
+ solution: "Provide valid API credentials",
702
+ },
703
+ {
704
+ code: 403,
705
+ message: "Permission denied",
706
+ solution: "Check access permissions for this operation",
707
+ },
708
+ {
709
+ code: 404,
710
+ message: "Resource not found",
711
+ solution: "Verify resource name, namespace, and path",
712
+ },
713
+ {
714
+ code: 409,
715
+ message: "Resource already exists",
716
+ solution: "Use different name or update existing resource",
717
+ },
718
+ {
719
+ code: 429,
720
+ message: "Rate limit exceeded",
721
+ solution: "Wait before retrying the operation",
722
+ },
723
+ {
724
+ code: 500,
725
+ message: "Server error",
726
+ solution: "Retry operation or contact support",
727
+ },
728
+ ],
729
+ conditions: {
730
+ postconditions: [],
731
+ prerequisites: ["Active namespace"],
732
+ },
733
+ confirmation_required: false,
734
+ danger_level: "low",
735
+ field_docs: {},
736
+ optional_fields: [],
737
+ performance_impact: {
738
+ latency: "moderate",
739
+ resource_usage: "moderate",
740
+ },
741
+ purpose: "List all service-credentials",
742
+ required_fields: ["path.namespace"],
743
+ side_effects: {},
744
+ },
745
+ curlExample: null,
746
+ },
747
+ {
748
+ toolName: "f5xc-api-authentication-service-credential-update",
749
+ method: "PUT",
750
+ path: "/api/web/namespaces/{namespace}/service_credentials/{name}",
751
+ operation: "update",
752
+ domain: "authentication",
753
+ resource: "service-credential",
754
+ summary: "Replace service credentials.",
755
+ description: "Request to replace user_groups and roles in service credentials.\nNote - for updating expiry use RenewServiceCredentials and to active/inactive service credential use ActivateServiceCredentials API.",
756
+ pathParameters: [
757
+ {
758
+ description: "Service Credential name\n\nx-required\nName of service credential object.",
759
+ in: "path",
760
+ name: "name",
761
+ required: true,
762
+ schema: {
763
+ type: "string",
764
+ },
765
+ "x-displayname": "Name",
766
+ "x-ves-example": "API-cred-73c7cbd9-1342-4ce0-97a5-6c515c0b147a.",
767
+ },
768
+ {
769
+ description: 'Namespace\nNamespace of the service credential user.\nValue of namespace is always "system".',
770
+ in: "path",
771
+ name: "namespace",
772
+ required: true,
773
+ schema: {
774
+ type: "string",
775
+ },
776
+ "x-displayname": "Namespace",
777
+ "x-ves-example": "System",
778
+ },
779
+ ],
780
+ queryParameters: [],
781
+ requestBodySchema: {
782
+ $ref: "#/components/schemas/api_credentialReplaceServiceCredentialsRequest",
783
+ },
784
+ responseSchema: {
785
+ $ref: "#/components/schemas/api_credentialReplaceServiceCredentialsResponse",
786
+ },
787
+ requiredParams: ["body", "name", "namespace"],
788
+ operationId: "ves.io.schema.api_credential.CustomAPI.ReplaceServiceCredentials",
789
+ tags: ["Other"],
790
+ sourceFile: "domains/authentication.json",
791
+ displayName: null,
792
+ dangerLevel: "medium",
793
+ sideEffects: {
794
+ modifies: ["service-credential"],
795
+ },
796
+ requiredFields: ["path.name", "path.namespace"],
797
+ confirmationRequired: false,
798
+ parameterExamples: {
799
+ name: "API-cred-73c7cbd9-1342-4ce0-97a5-6c515c0b147a.",
800
+ namespace: "System",
801
+ },
802
+ validationRules: {},
803
+ operationMetadata: {
804
+ common_errors: [
805
+ {
806
+ code: 401,
807
+ message: "Authentication required",
808
+ solution: "Provide valid API credentials",
809
+ },
810
+ {
811
+ code: 403,
812
+ message: "Permission denied",
813
+ solution: "Check access permissions for this operation",
814
+ },
815
+ {
816
+ code: 404,
817
+ message: "Resource not found",
818
+ solution: "Verify resource name, namespace, and path",
819
+ },
820
+ {
821
+ code: 409,
822
+ message: "Resource already exists",
823
+ solution: "Use different name or update existing resource",
824
+ },
825
+ {
826
+ code: 429,
827
+ message: "Rate limit exceeded",
828
+ solution: "Wait before retrying the operation",
829
+ },
830
+ {
831
+ code: 500,
832
+ message: "Server error",
833
+ solution: "Retry operation or contact support",
834
+ },
835
+ ],
836
+ conditions: {
837
+ postconditions: ["Resource updated with new values"],
838
+ prerequisites: ["Active namespace"],
839
+ },
840
+ confirmation_required: false,
841
+ danger_level: "medium",
842
+ field_docs: {},
843
+ optional_fields: [],
844
+ performance_impact: {
845
+ latency: "low",
846
+ resource_usage: "low",
847
+ },
848
+ purpose: "Replace existing service-credential",
849
+ required_fields: ["path.name", "path.namespace"],
850
+ side_effects: {
851
+ modifies: ["service-credential"],
852
+ },
853
+ },
854
+ curlExample: null,
855
+ },
856
+ ];
857
+ export default authenticationTools;
858
+ //# sourceMappingURL=index.js.map