kb-cloud-client-typescript 2.4.0-alpha.93 → 2.4.0-alpha.95

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 (245) hide show
  1. package/dist/adminapi/apis/account-api.d.ts +1129 -38
  2. package/dist/adminapi/apis/account-api.d.ts.map +1 -1
  3. package/dist/adminapi/apis/account-api.js +1283 -149
  4. package/dist/adminapi/apis/account-api.js.map +1 -1
  5. package/dist/adminapi/apis/mongodb-api.d.ts +943 -4
  6. package/dist/adminapi/apis/mongodb-api.d.ts.map +1 -1
  7. package/dist/adminapi/apis/mongodb-api.js +1005 -0
  8. package/dist/adminapi/apis/mongodb-api.js.map +1 -1
  9. package/dist/adminapi/apis/rdbms-api.d.ts +186 -34
  10. package/dist/adminapi/apis/rdbms-api.d.ts.map +1 -1
  11. package/dist/adminapi/apis/rdbms-api.js +166 -37
  12. package/dist/adminapi/apis/rdbms-api.js.map +1 -1
  13. package/dist/adminapi/apis/shared-api.d.ts +1196 -105
  14. package/dist/adminapi/apis/shared-api.d.ts.map +1 -1
  15. package/dist/adminapi/apis/shared-api.js +1273 -139
  16. package/dist/adminapi/apis/shared-api.js.map +1 -1
  17. package/dist/adminapi/models/component-item-create.d.ts +12 -0
  18. package/dist/adminapi/models/component-item-create.d.ts.map +1 -1
  19. package/dist/adminapi/models/component-item.d.ts +19 -0
  20. package/dist/adminapi/models/component-item.d.ts.map +1 -1
  21. package/dist/adminapi/models/index.d.ts +12 -0
  22. package/dist/adminapi/models/index.d.ts.map +1 -1
  23. package/dist/adminapi/models/index.js +12 -0
  24. package/dist/adminapi/models/index.js.map +1 -1
  25. package/dist/adminapi/models/instance-template-attribute.d.ts +0 -1
  26. package/dist/adminapi/models/instance-template-attribute.d.ts.map +1 -1
  27. package/dist/adminapi/models/instance-template-attribute.js +0 -1
  28. package/dist/adminapi/models/instance-template-attribute.js.map +1 -1
  29. package/dist/adminapi/models/instance-template-create.d.ts +9 -3
  30. package/dist/adminapi/models/instance-template-create.d.ts.map +1 -1
  31. package/dist/adminapi/models/instance.d.ts +6 -0
  32. package/dist/adminapi/models/instance.d.ts.map +1 -1
  33. package/dist/adminapi/models/mode-option.d.ts +7 -0
  34. package/dist/adminapi/models/mode-option.d.ts.map +1 -1
  35. package/dist/adminapi/models/mongo-rbacbinding-change.d.ts +32 -0
  36. package/dist/adminapi/models/mongo-rbacbinding-change.d.ts.map +1 -0
  37. package/dist/adminapi/models/mongo-rbacbinding-change.js +16 -0
  38. package/dist/adminapi/models/mongo-rbacbinding-change.js.map +1 -0
  39. package/dist/adminapi/models/mongo-rbaccapabilities.d.ts +32 -0
  40. package/dist/adminapi/models/mongo-rbaccapabilities.d.ts.map +1 -0
  41. package/dist/adminapi/models/mongo-rbaccapabilities.js +16 -0
  42. package/dist/adminapi/models/mongo-rbaccapabilities.js.map +1 -0
  43. package/dist/adminapi/models/mongo-rbacpassword-change.d.ts +25 -0
  44. package/dist/adminapi/models/mongo-rbacpassword-change.d.ts.map +1 -0
  45. package/dist/adminapi/models/mongo-rbacpassword-change.js +16 -0
  46. package/dist/adminapi/models/mongo-rbacpassword-change.js.map +1 -0
  47. package/dist/adminapi/models/mongo-rbacprivilege.d.ts +32 -0
  48. package/dist/adminapi/models/mongo-rbacprivilege.d.ts.map +1 -0
  49. package/dist/adminapi/models/mongo-rbacprivilege.js +16 -0
  50. package/dist/adminapi/models/mongo-rbacprivilege.js.map +1 -0
  51. package/dist/adminapi/models/mongo-rbacresource-capability.d.ts +31 -0
  52. package/dist/adminapi/models/mongo-rbacresource-capability.d.ts.map +1 -0
  53. package/dist/adminapi/models/mongo-rbacresource-capability.js +16 -0
  54. package/dist/adminapi/models/mongo-rbacresource-capability.js.map +1 -0
  55. package/dist/adminapi/models/mongo-rbacresource.d.ts +43 -0
  56. package/dist/adminapi/models/mongo-rbacresource.d.ts.map +1 -0
  57. package/dist/adminapi/models/mongo-rbacresource.js +16 -0
  58. package/dist/adminapi/models/mongo-rbacresource.js.map +1 -0
  59. package/dist/adminapi/models/mongo-rbacrole-ref.d.ts +31 -0
  60. package/dist/adminapi/models/mongo-rbacrole-ref.d.ts.map +1 -0
  61. package/dist/adminapi/models/mongo-rbacrole-ref.js +16 -0
  62. package/dist/adminapi/models/mongo-rbacrole-ref.js.map +1 -0
  63. package/dist/adminapi/models/mongo-rbacrole-write.d.ts +51 -0
  64. package/dist/adminapi/models/mongo-rbacrole-write.d.ts.map +1 -0
  65. package/dist/adminapi/models/mongo-rbacrole-write.js +16 -0
  66. package/dist/adminapi/models/mongo-rbacrole-write.js.map +1 -0
  67. package/dist/adminapi/models/mongo-rbacrole.d.ts +69 -0
  68. package/dist/adminapi/models/mongo-rbacrole.d.ts.map +1 -0
  69. package/dist/adminapi/models/mongo-rbacrole.js +16 -0
  70. package/dist/adminapi/models/mongo-rbacrole.js.map +1 -0
  71. package/dist/adminapi/models/mongo-rbacuser-create.d.ts +44 -0
  72. package/dist/adminapi/models/mongo-rbacuser-create.d.ts.map +1 -0
  73. package/dist/adminapi/models/mongo-rbacuser-create.js +16 -0
  74. package/dist/adminapi/models/mongo-rbacuser-create.js.map +1 -0
  75. package/dist/adminapi/models/mongo-rbacuser.d.ts +57 -0
  76. package/dist/adminapi/models/mongo-rbacuser.d.ts.map +1 -0
  77. package/dist/adminapi/models/mongo-rbacuser.js +16 -0
  78. package/dist/adminapi/models/mongo-rbacuser.js.map +1 -0
  79. package/dist/adminapi/models/object-privilege-evidence.d.ts +6 -0
  80. package/dist/adminapi/models/object-privilege-evidence.d.ts.map +1 -1
  81. package/dist/adminapi/models/object-privilege-reset-step.d.ts +1 -1
  82. package/dist/adminapi/models/placement-scope.d.ts +22 -0
  83. package/dist/adminapi/models/placement-scope.d.ts.map +1 -0
  84. package/dist/adminapi/models/placement-scope.js +26 -0
  85. package/dist/adminapi/models/placement-scope.js.map +1 -0
  86. package/dist/internalapi/models/component-item.d.ts +19 -0
  87. package/dist/internalapi/models/component-item.d.ts.map +1 -1
  88. package/dist/internalapi/models/index.d.ts +2 -0
  89. package/dist/internalapi/models/index.d.ts.map +1 -1
  90. package/dist/internalapi/models/index.js +2 -0
  91. package/dist/internalapi/models/index.js.map +1 -1
  92. package/dist/internalapi/models/instance-template-create-env-inner.d.ts +31 -0
  93. package/dist/internalapi/models/instance-template-create-env-inner.d.ts.map +1 -0
  94. package/dist/internalapi/models/instance-template-create-env-inner.js +16 -0
  95. package/dist/internalapi/models/instance-template-create-env-inner.js.map +1 -0
  96. package/dist/internalapi/models/instance-template-create.d.ts +72 -0
  97. package/dist/internalapi/models/instance-template-create.d.ts.map +1 -0
  98. package/dist/internalapi/models/instance-template-create.js +16 -0
  99. package/dist/internalapi/models/instance-template-create.js.map +1 -0
  100. package/dist/openapi/apis/account-api.d.ts +1129 -38
  101. package/dist/openapi/apis/account-api.d.ts.map +1 -1
  102. package/dist/openapi/apis/account-api.js +1283 -149
  103. package/dist/openapi/apis/account-api.js.map +1 -1
  104. package/dist/openapi/apis/mongodb-api.d.ts +943 -4
  105. package/dist/openapi/apis/mongodb-api.d.ts.map +1 -1
  106. package/dist/openapi/apis/mongodb-api.js +1005 -0
  107. package/dist/openapi/apis/mongodb-api.js.map +1 -1
  108. package/dist/openapi/apis/rdbms-api.d.ts +186 -34
  109. package/dist/openapi/apis/rdbms-api.d.ts.map +1 -1
  110. package/dist/openapi/apis/rdbms-api.js +166 -37
  111. package/dist/openapi/apis/rdbms-api.js.map +1 -1
  112. package/dist/openapi/apis/shared-api.d.ts +1196 -105
  113. package/dist/openapi/apis/shared-api.d.ts.map +1 -1
  114. package/dist/openapi/apis/shared-api.js +1273 -139
  115. package/dist/openapi/apis/shared-api.js.map +1 -1
  116. package/dist/openapi/models/component-item-create.d.ts +12 -0
  117. package/dist/openapi/models/component-item-create.d.ts.map +1 -1
  118. package/dist/openapi/models/component-item.d.ts +19 -0
  119. package/dist/openapi/models/component-item.d.ts.map +1 -1
  120. package/dist/openapi/models/index.d.ts +12 -0
  121. package/dist/openapi/models/index.d.ts.map +1 -1
  122. package/dist/openapi/models/index.js +12 -0
  123. package/dist/openapi/models/index.js.map +1 -1
  124. package/dist/openapi/models/instance-template-attribute.d.ts +0 -1
  125. package/dist/openapi/models/instance-template-attribute.d.ts.map +1 -1
  126. package/dist/openapi/models/instance-template-attribute.js +0 -1
  127. package/dist/openapi/models/instance-template-attribute.js.map +1 -1
  128. package/dist/openapi/models/instance-template-create.d.ts +9 -3
  129. package/dist/openapi/models/instance-template-create.d.ts.map +1 -1
  130. package/dist/openapi/models/instance.d.ts +6 -0
  131. package/dist/openapi/models/instance.d.ts.map +1 -1
  132. package/dist/openapi/models/mode-option.d.ts +7 -0
  133. package/dist/openapi/models/mode-option.d.ts.map +1 -1
  134. package/dist/openapi/models/mongo-rbacbinding-change.d.ts +32 -0
  135. package/dist/openapi/models/mongo-rbacbinding-change.d.ts.map +1 -0
  136. package/dist/openapi/models/mongo-rbacbinding-change.js +16 -0
  137. package/dist/openapi/models/mongo-rbacbinding-change.js.map +1 -0
  138. package/dist/openapi/models/mongo-rbaccapabilities.d.ts +32 -0
  139. package/dist/openapi/models/mongo-rbaccapabilities.d.ts.map +1 -0
  140. package/dist/openapi/models/mongo-rbaccapabilities.js +16 -0
  141. package/dist/openapi/models/mongo-rbaccapabilities.js.map +1 -0
  142. package/dist/openapi/models/mongo-rbacpassword-change.d.ts +25 -0
  143. package/dist/openapi/models/mongo-rbacpassword-change.d.ts.map +1 -0
  144. package/dist/openapi/models/mongo-rbacpassword-change.js +16 -0
  145. package/dist/openapi/models/mongo-rbacpassword-change.js.map +1 -0
  146. package/dist/openapi/models/mongo-rbacprivilege.d.ts +32 -0
  147. package/dist/openapi/models/mongo-rbacprivilege.d.ts.map +1 -0
  148. package/dist/openapi/models/mongo-rbacprivilege.js +16 -0
  149. package/dist/openapi/models/mongo-rbacprivilege.js.map +1 -0
  150. package/dist/openapi/models/mongo-rbacresource-capability.d.ts +31 -0
  151. package/dist/openapi/models/mongo-rbacresource-capability.d.ts.map +1 -0
  152. package/dist/openapi/models/mongo-rbacresource-capability.js +16 -0
  153. package/dist/openapi/models/mongo-rbacresource-capability.js.map +1 -0
  154. package/dist/openapi/models/mongo-rbacresource.d.ts +43 -0
  155. package/dist/openapi/models/mongo-rbacresource.d.ts.map +1 -0
  156. package/dist/openapi/models/mongo-rbacresource.js +16 -0
  157. package/dist/openapi/models/mongo-rbacresource.js.map +1 -0
  158. package/dist/openapi/models/mongo-rbacrole-ref.d.ts +31 -0
  159. package/dist/openapi/models/mongo-rbacrole-ref.d.ts.map +1 -0
  160. package/dist/openapi/models/mongo-rbacrole-ref.js +16 -0
  161. package/dist/openapi/models/mongo-rbacrole-ref.js.map +1 -0
  162. package/dist/openapi/models/mongo-rbacrole-write.d.ts +51 -0
  163. package/dist/openapi/models/mongo-rbacrole-write.d.ts.map +1 -0
  164. package/dist/openapi/models/mongo-rbacrole-write.js +16 -0
  165. package/dist/openapi/models/mongo-rbacrole-write.js.map +1 -0
  166. package/dist/openapi/models/mongo-rbacrole.d.ts +69 -0
  167. package/dist/openapi/models/mongo-rbacrole.d.ts.map +1 -0
  168. package/dist/openapi/models/mongo-rbacrole.js +16 -0
  169. package/dist/openapi/models/mongo-rbacrole.js.map +1 -0
  170. package/dist/openapi/models/mongo-rbacuser-create.d.ts +44 -0
  171. package/dist/openapi/models/mongo-rbacuser-create.d.ts.map +1 -0
  172. package/dist/openapi/models/mongo-rbacuser-create.js +16 -0
  173. package/dist/openapi/models/mongo-rbacuser-create.js.map +1 -0
  174. package/dist/openapi/models/mongo-rbacuser.d.ts +57 -0
  175. package/dist/openapi/models/mongo-rbacuser.d.ts.map +1 -0
  176. package/dist/openapi/models/mongo-rbacuser.js +16 -0
  177. package/dist/openapi/models/mongo-rbacuser.js.map +1 -0
  178. package/dist/openapi/models/object-privilege-evidence.d.ts +6 -0
  179. package/dist/openapi/models/object-privilege-evidence.d.ts.map +1 -1
  180. package/dist/openapi/models/object-privilege-reset-step.d.ts +1 -1
  181. package/dist/openapi/models/placement-scope.d.ts +22 -0
  182. package/dist/openapi/models/placement-scope.d.ts.map +1 -0
  183. package/dist/openapi/models/placement-scope.js +26 -0
  184. package/dist/openapi/models/placement-scope.js.map +1 -0
  185. package/package.json +1 -1
  186. package/src/adminapi/.openapi-generator/FILES +12 -0
  187. package/src/adminapi/apis/account-api.ts +3961 -2069
  188. package/src/adminapi/apis/mongodb-api.ts +1757 -120
  189. package/src/adminapi/apis/rdbms-api.ts +298 -43
  190. package/src/adminapi/apis/shared-api.ts +2363 -471
  191. package/src/adminapi/models/component-item-create.ts +12 -0
  192. package/src/adminapi/models/component-item.ts +21 -0
  193. package/src/adminapi/models/index.ts +12 -0
  194. package/src/adminapi/models/instance-template-attribute.ts +0 -1
  195. package/src/adminapi/models/instance-template-create.ts +9 -3
  196. package/src/adminapi/models/instance.ts +6 -0
  197. package/src/adminapi/models/mode-option.ts +9 -0
  198. package/src/adminapi/models/mongo-rbacbinding-change.ts +39 -0
  199. package/src/adminapi/models/mongo-rbaccapabilities.ts +39 -0
  200. package/src/adminapi/models/mongo-rbacpassword-change.ts +30 -0
  201. package/src/adminapi/models/mongo-rbacprivilege.ts +39 -0
  202. package/src/adminapi/models/mongo-rbacresource-capability.ts +36 -0
  203. package/src/adminapi/models/mongo-rbacresource.ts +48 -0
  204. package/src/adminapi/models/mongo-rbacrole-ref.ts +36 -0
  205. package/src/adminapi/models/mongo-rbacrole-write.ts +60 -0
  206. package/src/adminapi/models/mongo-rbacrole.ts +78 -0
  207. package/src/adminapi/models/mongo-rbacuser-create.ts +51 -0
  208. package/src/adminapi/models/mongo-rbacuser.ts +66 -0
  209. package/src/adminapi/models/object-privilege-evidence.ts +6 -0
  210. package/src/adminapi/models/object-privilege-reset-step.ts +1 -1
  211. package/src/adminapi/models/placement-scope.ts +31 -0
  212. package/src/adminapi.yaml +935 -81
  213. package/src/internalapi/.openapi-generator/FILES +2 -0
  214. package/src/internalapi/models/component-item.ts +21 -0
  215. package/src/internalapi/models/index.ts +2 -0
  216. package/src/internalapi/models/instance-template-create-env-inner.ts +36 -0
  217. package/src/internalapi/models/instance-template-create.ts +75 -0
  218. package/src/internalapi.yaml +62 -0
  219. package/src/openapi/.openapi-generator/FILES +12 -0
  220. package/src/openapi/apis/account-api.ts +3961 -2069
  221. package/src/openapi/apis/mongodb-api.ts +1757 -120
  222. package/src/openapi/apis/rdbms-api.ts +298 -43
  223. package/src/openapi/apis/shared-api.ts +2168 -276
  224. package/src/openapi/models/component-item-create.ts +12 -0
  225. package/src/openapi/models/component-item.ts +21 -0
  226. package/src/openapi/models/index.ts +12 -0
  227. package/src/openapi/models/instance-template-attribute.ts +0 -1
  228. package/src/openapi/models/instance-template-create.ts +9 -3
  229. package/src/openapi/models/instance.ts +6 -0
  230. package/src/openapi/models/mode-option.ts +9 -0
  231. package/src/openapi/models/mongo-rbacbinding-change.ts +39 -0
  232. package/src/openapi/models/mongo-rbaccapabilities.ts +39 -0
  233. package/src/openapi/models/mongo-rbacpassword-change.ts +30 -0
  234. package/src/openapi/models/mongo-rbacprivilege.ts +39 -0
  235. package/src/openapi/models/mongo-rbacresource-capability.ts +36 -0
  236. package/src/openapi/models/mongo-rbacresource.ts +48 -0
  237. package/src/openapi/models/mongo-rbacrole-ref.ts +36 -0
  238. package/src/openapi/models/mongo-rbacrole-write.ts +60 -0
  239. package/src/openapi/models/mongo-rbacrole.ts +78 -0
  240. package/src/openapi/models/mongo-rbacuser-create.ts +51 -0
  241. package/src/openapi/models/mongo-rbacuser.ts +66 -0
  242. package/src/openapi/models/object-privilege-evidence.ts +6 -0
  243. package/src/openapi/models/object-privilege-reset-step.ts +1 -1
  244. package/src/openapi/models/placement-scope.ts +31 -0
  245. package/src/openapi.yaml +935 -81
package/src/openapi.yaml CHANGED
@@ -114,6 +114,548 @@ tags:
114
114
  - name: blueGreenDeployment
115
115
  description: Blue Green Deployment APIs
116
116
  paths:
117
+ /api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/rbac/users/{database}/{username}/password:
118
+ put:
119
+ summary: ChangeRBACUserPassword
120
+ operationId: mongoChangeRBACUserPassword
121
+ tags:
122
+ - mongodb
123
+ - account
124
+ - shared
125
+ parameters:
126
+ - name: orgName
127
+ in: path
128
+ required: true
129
+ schema:
130
+ type: string
131
+ - name: clusterName
132
+ in: path
133
+ required: true
134
+ schema:
135
+ type: string
136
+ - name: database
137
+ in: path
138
+ required: true
139
+ schema:
140
+ type: string
141
+ - name: username
142
+ in: path
143
+ required: true
144
+ schema:
145
+ type: string
146
+ responses:
147
+ '204':
148
+ description: Success
149
+ '400':
150
+ $ref: '#/components/responses/400'
151
+ '401':
152
+ $ref: '#/components/responses/401'
153
+ '403':
154
+ $ref: '#/components/responses/403'
155
+ '404':
156
+ $ref: '#/components/responses/404'
157
+ '409':
158
+ description: Conflict; refresh or remove role bindings first
159
+ '500':
160
+ $ref: '#/components/responses/500'
161
+ requestBody:
162
+ required: true
163
+ content:
164
+ application/json:
165
+ schema:
166
+ $ref: '#/components/schemas/MongoRBACPasswordChange'
167
+ /api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/rbac/users:
168
+ get:
169
+ summary: ListRBACUsers
170
+ operationId: mongoListRBACUsers
171
+ tags:
172
+ - mongodb
173
+ - account
174
+ - shared
175
+ parameters:
176
+ - name: orgName
177
+ in: path
178
+ required: true
179
+ schema:
180
+ type: string
181
+ - name: clusterName
182
+ in: path
183
+ required: true
184
+ schema:
185
+ type: string
186
+ - name: database
187
+ in: query
188
+ schema:
189
+ type: string
190
+ default: admin
191
+ responses:
192
+ '200':
193
+ description: Success
194
+ content:
195
+ application/json:
196
+ schema:
197
+ type: array
198
+ items:
199
+ $ref: '#/components/schemas/MongoRBACUser'
200
+ '400':
201
+ $ref: '#/components/responses/400'
202
+ '401':
203
+ $ref: '#/components/responses/401'
204
+ '403':
205
+ $ref: '#/components/responses/403'
206
+ '404':
207
+ $ref: '#/components/responses/404'
208
+ '409':
209
+ description: Conflict; refresh or remove role bindings first
210
+ '500':
211
+ $ref: '#/components/responses/500'
212
+ post:
213
+ summary: CreateRBACUser
214
+ operationId: mongoCreateRBACUser
215
+ tags:
216
+ - mongodb
217
+ - account
218
+ - shared
219
+ parameters:
220
+ - name: orgName
221
+ in: path
222
+ required: true
223
+ schema:
224
+ type: string
225
+ - name: clusterName
226
+ in: path
227
+ required: true
228
+ schema:
229
+ type: string
230
+ responses:
231
+ '204':
232
+ description: Success
233
+ '400':
234
+ $ref: '#/components/responses/400'
235
+ '401':
236
+ $ref: '#/components/responses/401'
237
+ '403':
238
+ $ref: '#/components/responses/403'
239
+ '404':
240
+ $ref: '#/components/responses/404'
241
+ '409':
242
+ description: Conflict; refresh or remove role bindings first
243
+ '500':
244
+ $ref: '#/components/responses/500'
245
+ requestBody:
246
+ required: true
247
+ content:
248
+ application/json:
249
+ schema:
250
+ $ref: '#/components/schemas/MongoRBACUserCreate'
251
+ /api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/rbac/capabilities:
252
+ get:
253
+ summary: GetRBACCapabilities
254
+ operationId: mongoGetRBACCapabilities
255
+ tags:
256
+ - mongodb
257
+ - account
258
+ - shared
259
+ parameters:
260
+ - name: orgName
261
+ in: path
262
+ required: true
263
+ schema:
264
+ type: string
265
+ - name: clusterName
266
+ in: path
267
+ required: true
268
+ schema:
269
+ type: string
270
+ responses:
271
+ '200':
272
+ description: Success
273
+ content:
274
+ application/json:
275
+ schema:
276
+ $ref: '#/components/schemas/MongoRBACCapabilities'
277
+ '400':
278
+ $ref: '#/components/responses/400'
279
+ '401':
280
+ $ref: '#/components/responses/401'
281
+ '403':
282
+ $ref: '#/components/responses/403'
283
+ '404':
284
+ $ref: '#/components/responses/404'
285
+ '409':
286
+ description: Conflict; refresh or remove role bindings first
287
+ '500':
288
+ $ref: '#/components/responses/500'
289
+ /api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/rbac/roles:
290
+ get:
291
+ summary: ListRBACRoles
292
+ operationId: mongoListRBACRoles
293
+ tags:
294
+ - mongodb
295
+ - account
296
+ - shared
297
+ parameters:
298
+ - name: orgName
299
+ in: path
300
+ required: true
301
+ schema:
302
+ type: string
303
+ - name: clusterName
304
+ in: path
305
+ required: true
306
+ schema:
307
+ type: string
308
+ - name: database
309
+ in: query
310
+ schema:
311
+ type: string
312
+ default: admin
313
+ responses:
314
+ '200':
315
+ description: Success
316
+ content:
317
+ application/json:
318
+ schema:
319
+ type: array
320
+ items:
321
+ $ref: '#/components/schemas/MongoRBACRole'
322
+ '400':
323
+ $ref: '#/components/responses/400'
324
+ '401':
325
+ $ref: '#/components/responses/401'
326
+ '403':
327
+ $ref: '#/components/responses/403'
328
+ '404':
329
+ $ref: '#/components/responses/404'
330
+ '409':
331
+ description: Conflict; refresh or remove role bindings first
332
+ '500':
333
+ $ref: '#/components/responses/500'
334
+ post:
335
+ summary: CreateRBACRole
336
+ operationId: mongoCreateRBACRole
337
+ tags:
338
+ - mongodb
339
+ - account
340
+ - shared
341
+ parameters:
342
+ - name: orgName
343
+ in: path
344
+ required: true
345
+ schema:
346
+ type: string
347
+ - name: clusterName
348
+ in: path
349
+ required: true
350
+ schema:
351
+ type: string
352
+ responses:
353
+ '204':
354
+ description: Success
355
+ '400':
356
+ $ref: '#/components/responses/400'
357
+ '401':
358
+ $ref: '#/components/responses/401'
359
+ '403':
360
+ $ref: '#/components/responses/403'
361
+ '404':
362
+ $ref: '#/components/responses/404'
363
+ '409':
364
+ description: Conflict; refresh or remove role bindings first
365
+ '500':
366
+ $ref: '#/components/responses/500'
367
+ requestBody:
368
+ required: true
369
+ content:
370
+ application/json:
371
+ schema:
372
+ $ref: '#/components/schemas/MongoRBACRoleWrite'
373
+ /api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/rbac/roles/{database}/{roleName}:
374
+ get:
375
+ summary: GetRBACRole
376
+ operationId: mongoGetRBACRole
377
+ tags:
378
+ - mongodb
379
+ - account
380
+ - shared
381
+ parameters:
382
+ - name: orgName
383
+ in: path
384
+ required: true
385
+ schema:
386
+ type: string
387
+ - name: clusterName
388
+ in: path
389
+ required: true
390
+ schema:
391
+ type: string
392
+ - name: database
393
+ in: path
394
+ required: true
395
+ schema:
396
+ type: string
397
+ - name: roleName
398
+ in: path
399
+ required: true
400
+ schema:
401
+ type: string
402
+ responses:
403
+ '200':
404
+ description: Success
405
+ content:
406
+ application/json:
407
+ schema:
408
+ $ref: '#/components/schemas/MongoRBACRole'
409
+ '400':
410
+ $ref: '#/components/responses/400'
411
+ '401':
412
+ $ref: '#/components/responses/401'
413
+ '403':
414
+ $ref: '#/components/responses/403'
415
+ '404':
416
+ $ref: '#/components/responses/404'
417
+ '409':
418
+ description: Conflict; refresh or remove role bindings first
419
+ '500':
420
+ $ref: '#/components/responses/500'
421
+ put:
422
+ summary: UpdateRBACRole
423
+ operationId: mongoUpdateRBACRole
424
+ tags:
425
+ - mongodb
426
+ - account
427
+ - shared
428
+ parameters:
429
+ - name: orgName
430
+ in: path
431
+ required: true
432
+ schema:
433
+ type: string
434
+ - name: clusterName
435
+ in: path
436
+ required: true
437
+ schema:
438
+ type: string
439
+ - name: database
440
+ in: path
441
+ required: true
442
+ schema:
443
+ type: string
444
+ - name: roleName
445
+ in: path
446
+ required: true
447
+ schema:
448
+ type: string
449
+ responses:
450
+ '204':
451
+ description: Success
452
+ '400':
453
+ $ref: '#/components/responses/400'
454
+ '401':
455
+ $ref: '#/components/responses/401'
456
+ '403':
457
+ $ref: '#/components/responses/403'
458
+ '404':
459
+ $ref: '#/components/responses/404'
460
+ '409':
461
+ description: Conflict; refresh or remove role bindings first
462
+ '500':
463
+ $ref: '#/components/responses/500'
464
+ requestBody:
465
+ required: true
466
+ content:
467
+ application/json:
468
+ schema:
469
+ $ref: '#/components/schemas/MongoRBACRoleWrite'
470
+ delete:
471
+ summary: DeleteRBACRole
472
+ operationId: mongoDeleteRBACRole
473
+ tags:
474
+ - mongodb
475
+ - account
476
+ - shared
477
+ parameters:
478
+ - name: orgName
479
+ in: path
480
+ required: true
481
+ schema:
482
+ type: string
483
+ - name: clusterName
484
+ in: path
485
+ required: true
486
+ schema:
487
+ type: string
488
+ - name: database
489
+ in: path
490
+ required: true
491
+ schema:
492
+ type: string
493
+ - name: roleName
494
+ in: path
495
+ required: true
496
+ schema:
497
+ type: string
498
+ - name: expectedRevision
499
+ in: query
500
+ required: true
501
+ schema:
502
+ type: string
503
+ responses:
504
+ '204':
505
+ description: Success
506
+ '400':
507
+ $ref: '#/components/responses/400'
508
+ '401':
509
+ $ref: '#/components/responses/401'
510
+ '403':
511
+ $ref: '#/components/responses/403'
512
+ '404':
513
+ $ref: '#/components/responses/404'
514
+ '409':
515
+ description: Conflict; refresh or remove role bindings first
516
+ '500':
517
+ $ref: '#/components/responses/500'
518
+ /api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/rbac/users/{database}/{username}:
519
+ get:
520
+ summary: GetRBACUser
521
+ operationId: mongoGetRBACUser
522
+ tags:
523
+ - mongodb
524
+ - account
525
+ - shared
526
+ parameters:
527
+ - name: orgName
528
+ in: path
529
+ required: true
530
+ schema:
531
+ type: string
532
+ - name: clusterName
533
+ in: path
534
+ required: true
535
+ schema:
536
+ type: string
537
+ - name: database
538
+ in: path
539
+ required: true
540
+ schema:
541
+ type: string
542
+ - name: username
543
+ in: path
544
+ required: true
545
+ schema:
546
+ type: string
547
+ responses:
548
+ '200':
549
+ description: Success
550
+ content:
551
+ application/json:
552
+ schema:
553
+ $ref: '#/components/schemas/MongoRBACUser'
554
+ '400':
555
+ $ref: '#/components/responses/400'
556
+ '401':
557
+ $ref: '#/components/responses/401'
558
+ '403':
559
+ $ref: '#/components/responses/403'
560
+ '404':
561
+ $ref: '#/components/responses/404'
562
+ '409':
563
+ description: Conflict; refresh or remove role bindings first
564
+ '500':
565
+ $ref: '#/components/responses/500'
566
+ delete:
567
+ summary: DeleteRBACUser
568
+ operationId: mongoDeleteRBACUser
569
+ tags:
570
+ - mongodb
571
+ - account
572
+ - shared
573
+ parameters:
574
+ - name: orgName
575
+ in: path
576
+ required: true
577
+ schema:
578
+ type: string
579
+ - name: clusterName
580
+ in: path
581
+ required: true
582
+ schema:
583
+ type: string
584
+ - name: database
585
+ in: path
586
+ required: true
587
+ schema:
588
+ type: string
589
+ - name: username
590
+ in: path
591
+ required: true
592
+ schema:
593
+ type: string
594
+ responses:
595
+ '204':
596
+ description: Success
597
+ '400':
598
+ $ref: '#/components/responses/400'
599
+ '401':
600
+ $ref: '#/components/responses/401'
601
+ '403':
602
+ $ref: '#/components/responses/403'
603
+ '404':
604
+ $ref: '#/components/responses/404'
605
+ '409':
606
+ description: Conflict; refresh or remove role bindings first
607
+ '500':
608
+ $ref: '#/components/responses/500'
609
+ /api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/rbac/users/{database}/{username}/roles:
610
+ patch:
611
+ summary: ChangeRBACUserRoles
612
+ operationId: mongoChangeRBACUserRoles
613
+ tags:
614
+ - mongodb
615
+ - account
616
+ - shared
617
+ parameters:
618
+ - name: orgName
619
+ in: path
620
+ required: true
621
+ schema:
622
+ type: string
623
+ - name: clusterName
624
+ in: path
625
+ required: true
626
+ schema:
627
+ type: string
628
+ - name: database
629
+ in: path
630
+ required: true
631
+ schema:
632
+ type: string
633
+ - name: username
634
+ in: path
635
+ required: true
636
+ schema:
637
+ type: string
638
+ responses:
639
+ '204':
640
+ description: Success
641
+ '400':
642
+ $ref: '#/components/responses/400'
643
+ '401':
644
+ $ref: '#/components/responses/401'
645
+ '403':
646
+ $ref: '#/components/responses/403'
647
+ '404':
648
+ $ref: '#/components/responses/404'
649
+ '409':
650
+ description: Conflict; refresh or remove role bindings first
651
+ '500':
652
+ $ref: '#/components/responses/500'
653
+ requestBody:
654
+ required: true
655
+ content:
656
+ application/json:
657
+ schema:
658
+ $ref: '#/components/schemas/MongoRBACBindingChange'
117
659
  /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/config:
118
660
  get:
119
661
  operationId: getClusterJarConfig
@@ -19325,69 +19867,140 @@ paths:
19325
19867
  description: Deprecated MySQL host alias. Prefer subjectQualifiers. Do not specify host in both.
19326
19868
  - name: subjectQualifiers
19327
19869
  in: query
19328
- required: false
19870
+ required: false
19871
+ schema:
19872
+ type: string
19873
+ description: JSON object of string identity qualifiers, e.g. {"host":"%"}. Allowed keys and defaults come from capabilities. Unknown keys or duplicate identity inputs are rejected.
19874
+ requestBody:
19875
+ required: true
19876
+ content:
19877
+ application/json:
19878
+ schema:
19879
+ $ref: '#/components/schemas/ObjectPrivilegeChange'
19880
+ responses:
19881
+ '204':
19882
+ description: Native statement completed. Query privileges again to inspect remaining access.
19883
+ '400':
19884
+ $ref: '#/components/responses/400'
19885
+ '401':
19886
+ $ref: '#/components/responses/401'
19887
+ '403':
19888
+ $ref: '#/components/responses/403'
19889
+ '404':
19890
+ $ref: '#/components/responses/404'
19891
+ '409':
19892
+ $ref: '#/components/responses/409'
19893
+ '500':
19894
+ $ref: '#/components/responses/500'
19895
+ x-codegen-request-body-name: body
19896
+ /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}/object-privileges/capabilities:
19897
+ get:
19898
+ tags:
19899
+ - account
19900
+ - rdbms
19901
+ - shared
19902
+ summary: List native object privilege capabilities for the connected server
19903
+ operationId: getAccountObjectPrivilegeCapabilities
19904
+ description: Native object GRANT/REVOKE alongside presets. Consult capabilities for engine/version-specific object types and privileges. PostgreSQL RESTRICT is the default; MySQL static GRANT OPTION is scope-wide.
19905
+ parameters:
19906
+ - name: engineName
19907
+ in: path
19908
+ required: true
19909
+ schema:
19910
+ type: string
19911
+ - name: orgName
19912
+ in: path
19913
+ required: true
19914
+ schema:
19915
+ type: string
19916
+ - name: clusterName
19917
+ in: path
19918
+ required: true
19919
+ schema:
19920
+ type: string
19921
+ - name: accountName
19922
+ in: path
19923
+ required: true
19924
+ schema:
19925
+ type: string
19926
+ responses:
19927
+ '200':
19928
+ description: Native privilege snapshot
19929
+ content:
19930
+ application/json:
19931
+ schema:
19932
+ $ref: '#/components/schemas/ObjectPrivilegeCapabilities'
19933
+ '400':
19934
+ $ref: '#/components/responses/400'
19935
+ '401':
19936
+ $ref: '#/components/responses/401'
19937
+ '403':
19938
+ $ref: '#/components/responses/403'
19939
+ '404':
19940
+ $ref: '#/components/responses/404'
19941
+ '500':
19942
+ $ref: '#/components/responses/500'
19943
+ /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}/object-privileges/overview:
19944
+ get:
19945
+ tags:
19946
+ - account
19947
+ - rdbms
19948
+ - shared
19949
+ summary: Read native account privilege summary or selected database evidence
19950
+ operationId: getAccountPrivilegeOverview
19951
+ description: Without databaseName, returns role attributes, memberships, database access summaries and shared ACLs without connecting to other databases. PostgreSQL databaseName reads schema, object, ownership and PUBLIC evidence from that database only. Failed reads return an error, never an empty grant list. SQL is read-only evidence, not an exhaustive effective-access decision.
19952
+ parameters:
19953
+ - name: engineName
19954
+ in: path
19955
+ required: true
19956
+ schema:
19957
+ type: string
19958
+ - name: orgName
19959
+ in: path
19960
+ required: true
19961
+ schema:
19962
+ type: string
19963
+ - name: clusterName
19964
+ in: path
19965
+ required: true
19966
+ schema:
19967
+ type: string
19968
+ - name: accountName
19969
+ in: path
19970
+ required: true
19971
+ schema:
19972
+ type: string
19973
+ - name: subjectType
19974
+ in: query
19975
+ required: false
19976
+ schema:
19977
+ $ref: '#/components/schemas/ObjectPrivilegeSubjectType'
19978
+ description: Native subject kind; path account name identifies the subject.
19979
+ - name: host
19980
+ in: query
19981
+ required: false
19982
+ schema:
19983
+ type: string
19984
+ description: Deprecated MySQL host alias. Prefer subjectQualifiers. Do not specify host in both.
19985
+ - name: subjectQualifiers
19986
+ in: query
19329
19987
  schema:
19330
19988
  type: string
19331
- description: JSON object of string identity qualifiers, e.g. {"host":"%"}. Allowed keys and defaults come from capabilities. Unknown keys or duplicate identity inputs are rejected.
19332
- requestBody:
19333
- required: true
19334
- content:
19335
- application/json:
19336
- schema:
19337
- $ref: '#/components/schemas/ObjectPrivilegeChange'
19338
- responses:
19339
- '204':
19340
- description: Native statement completed. Query privileges again to inspect remaining access.
19341
- '400':
19342
- $ref: '#/components/responses/400'
19343
- '401':
19344
- $ref: '#/components/responses/401'
19345
- '403':
19346
- $ref: '#/components/responses/403'
19347
- '404':
19348
- $ref: '#/components/responses/404'
19349
- '409':
19350
- $ref: '#/components/responses/409'
19351
- '500':
19352
- $ref: '#/components/responses/500'
19353
- x-codegen-request-body-name: body
19354
- /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}/object-privileges/capabilities:
19355
- get:
19356
- tags:
19357
- - account
19358
- - rdbms
19359
- - shared
19360
- summary: List native object privilege capabilities for the connected server
19361
- operationId: getAccountObjectPrivilegeCapabilities
19362
- description: Native object GRANT/REVOKE alongside presets. Consult capabilities for engine/version-specific object types and privileges. PostgreSQL RESTRICT is the default; MySQL static GRANT OPTION is scope-wide.
19363
- parameters:
19364
- - name: engineName
19365
- in: path
19366
- required: true
19367
- schema:
19368
- type: string
19369
- - name: orgName
19370
- in: path
19371
- required: true
19372
- schema:
19373
- type: string
19374
- - name: clusterName
19375
- in: path
19376
- required: true
19377
- schema:
19378
- type: string
19379
- - name: accountName
19380
- in: path
19381
- required: true
19989
+ - name: databaseName
19990
+ in: query
19991
+ description: PostgreSQL database to inspect on demand. Omit for the global summary.
19992
+ required: false
19382
19993
  schema:
19383
19994
  type: string
19384
19995
  responses:
19385
19996
  '200':
19386
- description: Native privilege snapshot
19997
+ description: Native evidence groups for the requested scope
19387
19998
  content:
19388
19999
  application/json:
19389
20000
  schema:
19390
- $ref: '#/components/schemas/ObjectPrivilegeCapabilities'
20001
+ type: array
20002
+ items:
20003
+ $ref: '#/components/schemas/ObjectPrivilegeEvidence'
19391
20004
  '400':
19392
20005
  $ref: '#/components/responses/400'
19393
20006
  '401':
@@ -19404,9 +20017,9 @@ paths:
19404
20017
  - account
19405
20018
  - rdbms
19406
20019
  - shared
19407
- summary: Preview clearing all MySQL account privileges
20020
+ summary: Preview clearing explicit account privileges
19408
20021
  operationId: previewAccountPrivilegeReset
19409
- description: MySQL only. Clears direct privileges at every scope (including columns, routines, dynamic privileges and grant options), explicit role memberships and PROXY grants for one exact user/host. Rejects protected accounts and servers with mandatory roles before writing. Preview does not mutate. Execution re-reads current grants; concurrent new grants can be included. Statements are not atomic; on failure refresh and preview before retrying. Existing sessions follow MySQL privilege-cache semantics; this does not lock the account or terminate connections.
20022
+ description: MySQL clears direct privileges at every scope (including columns, routines, dynamic privileges and grant options), explicit role memberships and PROXY grants for one exact user/host. Rejects protected accounts and servers with mandatory roles before writing. Preview does not mutate. Execution re-reads current grants; concurrent new grants can be included. Statements are not atomic; on failure refresh and preview before retrying. Existing sessions follow MySQL privilege-cache semantics; this does not lock the account or terminate connections. PostgreSQL requires selected databaseNames or explicit allDatabases=true. Selected scope clears direct database/local/default ACLs only. It preserves global memberships, role attributes and privileges in other databases. Whole-account scope additionally clears memberships and elevated attributes. PUBLIC access remains. Object ownership prevents reset; RESTRICT protects dependent grants. Each database is transactional, but cross-database reset is not atomic. No objects are dropped or reassigned.
19410
20023
  parameters:
19411
20024
  - name: engineName
19412
20025
  in: path
@@ -19445,6 +20058,21 @@ paths:
19445
20058
  schema:
19446
20059
  type: string
19447
20060
  description: JSON identity qualifiers; MySQL host defaults to %.
20061
+ - name: databaseNames
20062
+ in: query
20063
+ style: form
20064
+ explode: true
20065
+ description: PostgreSQL only; exact selected database names as repeated parameters. Mutually exclusive with allDatabases.
20066
+ schema:
20067
+ type: array
20068
+ items:
20069
+ type: string
20070
+ - name: allDatabases
20071
+ in: query
20072
+ description: PostgreSQL whole-account reset requires explicit true; otherwise databaseNames must be nonempty. Selected scope preserves global memberships/attributes and privileges outside those databases.
20073
+ schema:
20074
+ type: boolean
20075
+ default: false
19448
20076
  responses:
19449
20077
  '200':
19450
20078
  description: Server-generated steps with connection database, in execution order
@@ -19469,9 +20097,9 @@ paths:
19469
20097
  - account
19470
20098
  - rdbms
19471
20099
  - shared
19472
- summary: Clear all MySQL account privileges
20100
+ summary: Clear explicit account privileges
19473
20101
  operationId: resetAccountPrivileges
19474
- description: MySQL only. Clears direct privileges at every scope (including columns, routines, dynamic privileges and grant options), explicit role memberships and PROXY grants for one exact user/host. Rejects protected accounts and servers with mandatory roles before writing. Preview does not mutate. Execution re-reads current grants; concurrent new grants can be included. Statements are not atomic; on failure refresh and preview before retrying. Existing sessions follow MySQL privilege-cache semantics; this does not lock the account or terminate connections.
20102
+ description: MySQL clears direct privileges at every scope (including columns, routines, dynamic privileges and grant options), explicit role memberships and PROXY grants for one exact user/host. Rejects protected accounts and servers with mandatory roles before writing. Preview does not mutate. Execution re-reads current grants; concurrent new grants can be included. Statements are not atomic; on failure refresh and preview before retrying. Existing sessions follow MySQL privilege-cache semantics; this does not lock the account or terminate connections. PostgreSQL requires selected databaseNames or explicit allDatabases=true. Selected scope clears direct database/local/default ACLs only. It preserves global memberships, role attributes and privileges in other databases. Whole-account scope additionally clears memberships and elevated attributes. PUBLIC access remains. Object ownership prevents reset; RESTRICT protects dependent grants. Each database is transactional, but cross-database reset is not atomic. No objects are dropped or reassigned.
19475
20103
  parameters:
19476
20104
  - name: engineName
19477
20105
  in: path
@@ -19510,6 +20138,21 @@ paths:
19510
20138
  schema:
19511
20139
  type: string
19512
20140
  description: JSON identity qualifiers; MySQL host defaults to %.
20141
+ - name: databaseNames
20142
+ in: query
20143
+ style: form
20144
+ explode: true
20145
+ description: PostgreSQL only; exact selected database names as repeated parameters. Mutually exclusive with allDatabases.
20146
+ schema:
20147
+ type: array
20148
+ items:
20149
+ type: string
20150
+ - name: allDatabases
20151
+ in: query
20152
+ description: PostgreSQL whole-account reset requires explicit true; otherwise databaseNames must be nonempty. Selected scope preserves global memberships/attributes and privileges outside those databases.
20153
+ schema:
20154
+ type: boolean
20155
+ default: false
19513
20156
  responses:
19514
20157
  '204':
19515
20158
  description: Privileges cleared; account and password preserved
@@ -19531,7 +20174,7 @@ paths:
19531
20174
  - shared
19532
20175
  summary: List exact column names for account object privileges
19533
20176
  operationId: listAccountObjectPrivilegeColumns
19534
- description: Read MySQL table or view column names using the account management connection. No workbench datasource is required. Names are returned verbatim for column-level grants.
20177
+ description: Read MySQL or PostgreSQL relation column names using the account management connection. No workbench datasource is required. Names are returned verbatim for column-level grants.
19535
20178
  parameters:
19536
20179
  - name: engineName
19537
20180
  in: path
@@ -19556,7 +20199,7 @@ paths:
19556
20199
  - name: objectType
19557
20200
  in: query
19558
20201
  required: true
19559
- description: Object type, either table or view
20202
+ description: Object type, table/view; PostgreSQL also supports materializedView/foreignTable
19560
20203
  schema:
19561
20204
  type: string
19562
20205
  - name: databaseName
@@ -19569,6 +20212,11 @@ paths:
19569
20212
  required: true
19570
20213
  schema:
19571
20214
  type: string
20215
+ - name: schemaName
20216
+ in: query
20217
+ description: Required for PostgreSQL; not accepted for MySQL
20218
+ schema:
20219
+ type: string
19572
20220
  responses:
19573
20221
  '200':
19574
20222
  description: Exact column names in catalog order; empty if no visible columns exist
@@ -23916,6 +24564,194 @@ components:
23916
24564
  curl --digest -u "accessKey:secretKey" https://api.example.com/api/v1/user
23917
24565
  ```
23918
24566
  schemas:
24567
+ MongoRBACPasswordChange:
24568
+ type: object
24569
+ required:
24570
+ - password
24571
+ properties:
24572
+ password:
24573
+ type: string
24574
+ format: password
24575
+ APIErrorResponse:
24576
+ description: API error response.
24577
+ properties:
24578
+ code:
24579
+ description: The HTTP status code.
24580
+ type: integer
24581
+ reason:
24582
+ description: The reason for the error.
24583
+ type: string
24584
+ message:
24585
+ description: The message for the error.
24586
+ type: string
24587
+ required:
24588
+ - code
24589
+ type: object
24590
+ MongoRBACRoleRef:
24591
+ type: object
24592
+ properties:
24593
+ role:
24594
+ type: string
24595
+ db:
24596
+ type: string
24597
+ required:
24598
+ - role
24599
+ - db
24600
+ MongoRBACResource:
24601
+ type: object
24602
+ properties:
24603
+ cluster:
24604
+ type: boolean
24605
+ db:
24606
+ type: string
24607
+ x-nullable: true
24608
+ description: Preserve an explicit empty string for native wildcard scope; omit only for cluster resources.
24609
+ collection:
24610
+ type: string
24611
+ x-nullable: true
24612
+ description: Preserve an explicit empty string for native wildcard scope; omit only for cluster resources.
24613
+ anyResource:
24614
+ type: boolean
24615
+ description: Read-only native evidence; write requests reject this internal resource.
24616
+ description: Native MongoDB resource. cluster:true is system operations, not all database data. Empty db/collection are explicit wildcard scopes; system collections need explicit resources.
24617
+ MongoRBACPrivilege:
24618
+ type: object
24619
+ properties:
24620
+ resource:
24621
+ $ref: '#/components/schemas/MongoRBACResource'
24622
+ actions:
24623
+ type: array
24624
+ items:
24625
+ type: string
24626
+ required:
24627
+ - resource
24628
+ - actions
24629
+ MongoRBACUser:
24630
+ type: object
24631
+ properties:
24632
+ db:
24633
+ type: string
24634
+ roles:
24635
+ type: array
24636
+ items:
24637
+ $ref: '#/components/schemas/MongoRBACRoleRef'
24638
+ inheritedRoles:
24639
+ type: array
24640
+ items:
24641
+ $ref: '#/components/schemas/MongoRBACRoleRef'
24642
+ inheritedPrivileges:
24643
+ type: array
24644
+ items:
24645
+ $ref: '#/components/schemas/MongoRBACPrivilege'
24646
+ user:
24647
+ type: string
24648
+ readOnly:
24649
+ type: boolean
24650
+ description: Platform-protected account; mutations are rejected.
24651
+ MongoRBACUserCreate:
24652
+ type: object
24653
+ required:
24654
+ - user
24655
+ - db
24656
+ - password
24657
+ - roles
24658
+ properties:
24659
+ user:
24660
+ type: string
24661
+ db:
24662
+ type: string
24663
+ password:
24664
+ type: string
24665
+ format: password
24666
+ roles:
24667
+ type: array
24668
+ items:
24669
+ $ref: '#/components/schemas/MongoRBACRoleRef'
24670
+ MongoRBACResourceCapability:
24671
+ type: object
24672
+ properties:
24673
+ type:
24674
+ type: string
24675
+ description: cluster, database, collection, allDatabases, collectionAcrossDatabases
24676
+ actions:
24677
+ type: array
24678
+ items:
24679
+ type: string
24680
+ required:
24681
+ - type
24682
+ - actions
24683
+ MongoRBACCapabilities:
24684
+ type: object
24685
+ properties:
24686
+ engineVersion:
24687
+ type: string
24688
+ resources:
24689
+ type: array
24690
+ items:
24691
+ $ref: '#/components/schemas/MongoRBACResourceCapability'
24692
+ MongoRBACRole:
24693
+ type: object
24694
+ properties:
24695
+ role:
24696
+ type: string
24697
+ db:
24698
+ type: string
24699
+ isBuiltin:
24700
+ type: boolean
24701
+ privileges:
24702
+ type: array
24703
+ items:
24704
+ $ref: '#/components/schemas/MongoRBACPrivilege'
24705
+ roles:
24706
+ type: array
24707
+ items:
24708
+ $ref: '#/components/schemas/MongoRBACRoleRef'
24709
+ inheritedRoles:
24710
+ type: array
24711
+ items:
24712
+ $ref: '#/components/schemas/MongoRBACRoleRef'
24713
+ inheritedPrivileges:
24714
+ type: array
24715
+ items:
24716
+ $ref: '#/components/schemas/MongoRBACPrivilege'
24717
+ revision:
24718
+ type: string
24719
+ description: Stale-form fingerprint. updateRole has no native CAS; external concurrent writes are not transactional.
24720
+ MongoRBACRoleWrite:
24721
+ type: object
24722
+ properties:
24723
+ role:
24724
+ type: string
24725
+ db:
24726
+ type: string
24727
+ privileges:
24728
+ type: array
24729
+ items:
24730
+ $ref: '#/components/schemas/MongoRBACPrivilege'
24731
+ roles:
24732
+ type: array
24733
+ items:
24734
+ $ref: '#/components/schemas/MongoRBACRoleRef'
24735
+ expectedRevision:
24736
+ type: string
24737
+ required:
24738
+ - role
24739
+ - db
24740
+ - privileges
24741
+ - roles
24742
+ MongoRBACBindingChange:
24743
+ type: object
24744
+ properties:
24745
+ action:
24746
+ type: string
24747
+ description: grant or revoke. Incremental; all other native roles are retained.
24748
+ roles:
24749
+ type: array
24750
+ items:
24751
+ $ref: '#/components/schemas/MongoRBACRoleRef'
24752
+ required:
24753
+ - action
24754
+ - roles
23919
24755
  clusterJarConfig:
23920
24756
  type: object
23921
24757
  properties:
@@ -23943,21 +24779,6 @@ components:
23943
24779
  - maxFileBytes
23944
24780
  - maxTotalBytes
23945
24781
  - usedBytes
23946
- APIErrorResponse:
23947
- description: API error response.
23948
- properties:
23949
- code:
23950
- description: The HTTP status code.
23951
- type: integer
23952
- reason:
23953
- description: The reason for the error.
23954
- type: string
23955
- message:
23956
- description: The message for the error.
23957
- type: string
23958
- required:
23959
- - code
23960
- type: object
23961
24782
  clusterJarKind:
23962
24783
  type: string
23963
24784
  enum:
@@ -26221,12 +27042,14 @@ components:
26221
27042
  instanceTemplateCreate:
26222
27043
  type: object
26223
27044
  additionalProperties: false
26224
- description: |
26225
- Create assignment for one instance template. name and replicas are required. env, annotations, labels, availabilityZone, and storageClass are optional overlays onto the chart-rendered instance. The request must include every chart-rendered instance template exactly once. A template with an explicit zone uses single-zone scheduling: hostname anti-affinity follows the scheduling policy, while explicit rules and additional topology keys are preserved. Component scheduling remains unchanged; templates without a zone inherit it, including its zone anti-affinity constraints. Chart instance scheduling policies are cleared; an omitted or empty availabilityZone leaves the instance policy unset to inherit the component policy.
27045
+ description: Create assignment for one instance template. name and replicas are required. env, annotations, labels, availabilityZone, nodeGroup and storageClass are optional overlays. The request must include every chart-rendered instance template exactly once. Explicit placement requires availabilityZone and optionally accepts nodeGroup, without inheriting upper-level AZ or NodeGroup. Omitting both leaves SchedulingPolicy unset for KubeBlocks default inheritance. Hostname, user scheduling rules and additional topology keys are preserved.
26226
27046
  required:
26227
27047
  - name
26228
27048
  - replicas
26229
27049
  properties:
27050
+ nodeGroup:
27051
+ type: string
27052
+ description: Optional host group in this environment and the explicitly selected availabilityZone. Requires availabilityZone; no upper-level host group is inherited.
26230
27053
  name:
26231
27054
  type: string
26232
27055
  minLength: 1
@@ -26237,7 +27060,7 @@ components:
26237
27060
  description: Replica count for this instance template.
26238
27061
  availabilityZone:
26239
27062
  type: string
26240
- description: Availability zone for this template (topology.kubernetes.io/zone); omitted or empty inherits the component zone selection. Must be enabled in the environment. If the request explicitly supplies a non-empty cluster availabilityZones list, the template zone must also belong to that list.
27063
+ description: Single AZ for explicit template placement (topology.kubernetes.io/zone). Must be enabled in the environment and is required when nodeGroup is specified. An omitted nodeGroup does not inherit the component or cluster host group. Omitting both leaves SchedulingPolicy unset for KubeBlocks inheritance.
26241
27064
  storageClass:
26242
27065
  type: string
26243
27066
  description: StorageClass name for all persistent volumes in this template. Copied from component volumeClaimTemplates, preserving volume sizes and other settings while overriding storageClassName. Chart instance volume templates are cleared; omitted or empty leaves instance volumeClaimTemplates unset.
@@ -26265,7 +27088,7 @@ components:
26265
27088
  type: object
26266
27089
  additionalProperties:
26267
27090
  type: string
26268
- description: Label map (string key to string value). Merged into this template; same-name keys overwritten. Chart keys are not deleted.
27091
+ description: Label map (string key to string value). Merged into this template; same-name keys overwritten. Chart keys are not deleted. The apps.kubeblocks.io/instance-template label is managed by the system and must equal the template name if supplied.
26269
27092
  ioQuantity:
26270
27093
  description: IO Quantity describes IOPS and BPS of a volume
26271
27094
  properties:
@@ -26333,6 +27156,12 @@ components:
26333
27156
  required:
26334
27157
  - component
26335
27158
  properties:
27159
+ nodeGroup:
27160
+ type: string
27161
+ description: Optional host group in this environment and the explicitly selected availabilityZone. Requires availabilityZone; no upper-level host group is inherited.
27162
+ availabilityZone:
27163
+ type: string
27164
+ description: Single AZ for explicit component placement. Must be enabled in the environment and is required when nodeGroup is specified. An omitted nodeGroup does not inherit the cluster host group. Omitting both retains cluster scheduling.
26336
27165
  component:
26337
27166
  type: string
26338
27167
  description: component type, refer to componentDef and support NamePrefix
@@ -26659,6 +27488,18 @@ components:
26659
27488
  type: object
26660
27489
  description: ComponentItem is the information of a component
26661
27490
  properties:
27491
+ nodeGroup:
27492
+ type: string
27493
+ description: Optional host group in this environment. Explicit placement does not inherit an upper-level host group.
27494
+ availabilityZone:
27495
+ type: string
27496
+ description: Explicit component AZ selection, if configured.
27497
+ instanceTemplates:
27498
+ type: array
27499
+ x-omitempty: true
27500
+ description: Instance template assignments with effective replicas, placement and storage class, and user-provided env, labels and annotations.
27501
+ items:
27502
+ $ref: '#/components/schemas/instanceTemplateCreate'
26662
27503
  name:
26663
27504
  type: string
26664
27505
  description: component name
@@ -27004,6 +27845,9 @@ components:
27004
27845
  componentDef:
27005
27846
  description: ComponentDefinition name
27006
27847
  type: string
27848
+ instanceTemplate:
27849
+ description: Instance template name within the actual component. Omitted when no template identity is available.
27850
+ type: string
27007
27851
  component:
27008
27852
  description: component type, refer to componentDef and support NamePrefix
27009
27853
  type: string
@@ -33603,6 +34447,12 @@ components:
33603
34447
  type: boolean
33604
34448
  description: whether the component supports custom secret
33605
34449
  x-nullable: false
34450
+ placementScope:
34451
+ type: string
34452
+ description: UI placement input scope for this mode. Omitted defaults to cluster. cluster displays AZ and NodeGroup selection for the cluster. component hides cluster placement and displays selection for each component, or for each instance template when the component declares templates. This does not restrict API placement overrides.
34453
+ enum:
34454
+ - cluster
34455
+ - component
33606
34456
  modeCompatibleKubeblocksVersion:
33607
34457
  type: string
33608
34458
  description: |
@@ -33624,7 +34474,6 @@ components:
33624
34474
  - env
33625
34475
  - annotations
33626
34476
  - labels
33627
- - availabilityZone
33628
34477
  - storageClass
33629
34478
  instanceTemplateEnv:
33630
34479
  type: object
@@ -34000,6 +34849,8 @@ components:
34000
34849
  - description
34001
34850
  - components
34002
34851
  properties:
34852
+ placementScope:
34853
+ $ref: '#/components/schemas/placementScope'
34003
34854
  name:
34004
34855
  type: string
34005
34856
  title:
@@ -40502,6 +41353,9 @@ components:
40502
41353
  - format
40503
41354
  - items
40504
41355
  properties:
41356
+ databaseName:
41357
+ type: string
41358
+ description: Connection database for native privilege evidence.
40505
41359
  kind:
40506
41360
  type: string
40507
41361
  x-nullable: false
@@ -40771,7 +41625,7 @@ components:
40771
41625
  type: string
40772
41626
  x-nullable: false
40773
41627
  minLength: 1
40774
- description: Engine-generated SQL for display. Callers cannot submit or modify these steps for execution; reset rebuilds the plan from current grants.
41628
+ description: Engine-generated statement for display (SQL, or a native MongoDB command encoded as JSON). Callers cannot submit or modify these steps for execution; reset rebuilds the plan from current grants.
40775
41629
  ObjectPrivilegeObject:
40776
41630
  type: object
40777
41631
  required: