@alicloud/agentcore20260804 2.5.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (329) hide show
  1. package/dist/client.d.ts +1222 -72
  2. package/dist/client.js +1609 -72
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AddMemoriesRequest.d.ts +10 -10
  5. package/dist/models/AddMemoriesResponseBody.d.ts +4 -4
  6. package/dist/models/AddMemoriesShrinkRequest.d.ts +1 -1
  7. package/dist/models/CreateCustomAgentRequest.d.ts +43 -43
  8. package/dist/models/CreateCustomAgentResponseBody.d.ts +118 -61
  9. package/dist/models/CreateCustomAgentResponseBody.js +33 -1
  10. package/dist/models/CreateCustomAgentResponseBody.js.map +1 -1
  11. package/dist/models/CreateIdentityProviderRequest.d.ts +51 -10
  12. package/dist/models/CreateIdentityProviderRequest.js +32 -1
  13. package/dist/models/CreateIdentityProviderRequest.js.map +1 -1
  14. package/dist/models/CreateIdentityProviderResponseBody.d.ts +150 -8
  15. package/dist/models/CreateIdentityProviderResponseBody.js +95 -1
  16. package/dist/models/CreateIdentityProviderResponseBody.js.map +1 -1
  17. package/dist/models/CreateIdentityProviderScimcredentialRequest.d.ts +13 -0
  18. package/dist/models/CreateIdentityProviderScimcredentialRequest.js +54 -0
  19. package/dist/models/CreateIdentityProviderScimcredentialRequest.js.map +1 -0
  20. package/dist/models/CreateIdentityProviderScimcredentialResponse.d.ts +19 -0
  21. package/dist/models/CreateIdentityProviderScimcredentialResponse.js +69 -0
  22. package/dist/models/CreateIdentityProviderScimcredentialResponse.js.map +1 -0
  23. package/dist/models/CreateIdentityProviderScimcredentialResponseBody.d.ts +157 -0
  24. package/dist/models/CreateIdentityProviderScimcredentialResponseBody.js +146 -0
  25. package/dist/models/CreateIdentityProviderScimcredentialResponseBody.js.map +1 -0
  26. package/dist/models/CreateIdentityProviderShrinkRequest.d.ts +1 -1
  27. package/dist/models/CreateIdentityProviderSyncJobRequest.d.ts +13 -0
  28. package/dist/models/CreateIdentityProviderSyncJobRequest.js +54 -0
  29. package/dist/models/CreateIdentityProviderSyncJobRequest.js.map +1 -0
  30. package/dist/models/CreateIdentityProviderSyncJobResponse.d.ts +19 -0
  31. package/dist/models/CreateIdentityProviderSyncJobResponse.js +69 -0
  32. package/dist/models/CreateIdentityProviderSyncJobResponse.js.map +1 -0
  33. package/dist/models/CreateIdentityProviderSyncJobResponseBody.d.ts +121 -0
  34. package/dist/models/CreateIdentityProviderSyncJobResponseBody.js +100 -0
  35. package/dist/models/CreateIdentityProviderSyncJobResponseBody.js.map +1 -0
  36. package/dist/models/CreateMemoryStoreRequest.d.ts +6 -6
  37. package/dist/models/CreateMemoryStoreResponseBody.d.ts +7 -7
  38. package/dist/models/CreateMemoryStoreShrinkRequest.d.ts +2 -2
  39. package/dist/models/CreateWorkspaceRequest.d.ts +23 -7
  40. package/dist/models/CreateWorkspaceRequest.js +4 -0
  41. package/dist/models/CreateWorkspaceRequest.js.map +1 -1
  42. package/dist/models/CreateWorkspaceResponseBody.d.ts +11 -11
  43. package/dist/models/CreateWorkspaceShrinkRequest.d.ts +1 -1
  44. package/dist/models/DeleteIdentityProviderResponseBody.d.ts +110 -17
  45. package/dist/models/DeleteIdentityProviderResponseBody.js +66 -1
  46. package/dist/models/DeleteIdentityProviderResponseBody.js.map +1 -1
  47. package/dist/models/DeleteIdentityProviderScimcredentialRequest.d.ts +13 -0
  48. package/dist/models/DeleteIdentityProviderScimcredentialRequest.js +54 -0
  49. package/dist/models/DeleteIdentityProviderScimcredentialRequest.js.map +1 -0
  50. package/dist/models/DeleteIdentityProviderScimcredentialResponse.d.ts +19 -0
  51. package/dist/models/DeleteIdentityProviderScimcredentialResponse.js +69 -0
  52. package/dist/models/DeleteIdentityProviderScimcredentialResponse.js.map +1 -0
  53. package/dist/models/DeleteIdentityProviderScimcredentialResponseBody.d.ts +50 -0
  54. package/dist/models/DeleteIdentityProviderScimcredentialResponseBody.js +66 -0
  55. package/dist/models/DeleteIdentityProviderScimcredentialResponseBody.js.map +1 -0
  56. package/dist/models/DeleteMemoryStoreResponseBody.d.ts +3 -3
  57. package/dist/models/GetAgentCodePackageDownloadUrlRequest.d.ts +13 -0
  58. package/dist/models/GetAgentCodePackageDownloadUrlRequest.js +54 -0
  59. package/dist/models/GetAgentCodePackageDownloadUrlRequest.js.map +1 -0
  60. package/dist/models/GetAgentCodePackageDownloadUrlResponse.d.ts +19 -0
  61. package/dist/models/GetAgentCodePackageDownloadUrlResponse.js +69 -0
  62. package/dist/models/GetAgentCodePackageDownloadUrlResponse.js.map +1 -0
  63. package/dist/models/GetAgentCodePackageDownloadUrlResponseBody.d.ts +131 -0
  64. package/dist/models/GetAgentCodePackageDownloadUrlResponseBody.js +104 -0
  65. package/dist/models/GetAgentCodePackageDownloadUrlResponseBody.js.map +1 -0
  66. package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlRequest.d.ts +23 -0
  67. package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlRequest.js +58 -0
  68. package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlRequest.js.map +1 -0
  69. package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponse.d.ts +19 -0
  70. package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponse.js +69 -0
  71. package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponse.js.map +1 -0
  72. package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponseBody.d.ts +99 -0
  73. package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponseBody.js +96 -0
  74. package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponseBody.js.map +1 -0
  75. package/dist/models/GetAgentCodePackageUploadUrlRequest.d.ts +62 -0
  76. package/dist/models/GetAgentCodePackageUploadUrlRequest.js +84 -0
  77. package/dist/models/GetAgentCodePackageUploadUrlRequest.js.map +1 -0
  78. package/dist/models/GetAgentCodePackageUploadUrlResponse.d.ts +19 -0
  79. package/dist/models/GetAgentCodePackageUploadUrlResponse.js +69 -0
  80. package/dist/models/GetAgentCodePackageUploadUrlResponse.js.map +1 -0
  81. package/dist/models/GetAgentCodePackageUploadUrlResponseBody.d.ts +114 -0
  82. package/dist/models/GetAgentCodePackageUploadUrlResponseBody.js +103 -0
  83. package/dist/models/GetAgentCodePackageUploadUrlResponseBody.js.map +1 -0
  84. package/dist/models/GetAgentCodePackageUploadUrlShrinkRequest.d.ts +20 -0
  85. package/dist/models/GetAgentCodePackageUploadUrlShrinkRequest.js +58 -0
  86. package/dist/models/GetAgentCodePackageUploadUrlShrinkRequest.js.map +1 -0
  87. package/dist/models/GetCustomAgentResponseBody.d.ts +105 -48
  88. package/dist/models/GetCustomAgentResponseBody.js +33 -1
  89. package/dist/models/GetCustomAgentResponseBody.js.map +1 -1
  90. package/dist/models/GetIdentityProviderResponseBody.d.ts +183 -9
  91. package/dist/models/GetIdentityProviderResponseBody.js +103 -1
  92. package/dist/models/GetIdentityProviderResponseBody.js.map +1 -1
  93. package/dist/models/GetIdentityProviderScimrequest.d.ts +13 -0
  94. package/dist/models/GetIdentityProviderScimrequest.js +54 -0
  95. package/dist/models/GetIdentityProviderScimrequest.js.map +1 -0
  96. package/dist/models/GetIdentityProviderScimresponse.d.ts +19 -0
  97. package/dist/models/GetIdentityProviderScimresponse.js +69 -0
  98. package/dist/models/GetIdentityProviderScimresponse.js.map +1 -0
  99. package/dist/models/GetIdentityProviderScimresponseBody.d.ts +123 -0
  100. package/dist/models/GetIdentityProviderScimresponseBody.js +118 -0
  101. package/dist/models/GetIdentityProviderScimresponseBody.js.map +1 -0
  102. package/dist/models/GetIdentityProviderServiceProviderRequest.d.ts +23 -0
  103. package/dist/models/GetIdentityProviderServiceProviderRequest.js +58 -0
  104. package/dist/models/GetIdentityProviderServiceProviderRequest.js.map +1 -0
  105. package/dist/models/GetIdentityProviderServiceProviderResponse.d.ts +19 -0
  106. package/dist/models/GetIdentityProviderServiceProviderResponse.js +69 -0
  107. package/dist/models/GetIdentityProviderServiceProviderResponse.js.map +1 -0
  108. package/dist/models/GetIdentityProviderServiceProviderResponseBody.d.ts +99 -0
  109. package/dist/models/GetIdentityProviderServiceProviderResponseBody.js +96 -0
  110. package/dist/models/GetIdentityProviderServiceProviderResponseBody.js.map +1 -0
  111. package/dist/models/GetIdentityProviderSyncJobRequest.d.ts +13 -0
  112. package/dist/models/GetIdentityProviderSyncJobRequest.js +54 -0
  113. package/dist/models/GetIdentityProviderSyncJobRequest.js.map +1 -0
  114. package/dist/models/GetIdentityProviderSyncJobResponse.d.ts +19 -0
  115. package/dist/models/GetIdentityProviderSyncJobResponse.js +69 -0
  116. package/dist/models/GetIdentityProviderSyncJobResponse.js.map +1 -0
  117. package/dist/models/GetIdentityProviderSyncJobResponseBody.d.ts +128 -0
  118. package/dist/models/GetIdentityProviderSyncJobResponseBody.js +100 -0
  119. package/dist/models/GetIdentityProviderSyncJobResponseBody.js.map +1 -0
  120. package/dist/models/GetIdentityProviderSyncScopeRequest.d.ts +13 -0
  121. package/dist/models/GetIdentityProviderSyncScopeRequest.js +54 -0
  122. package/dist/models/GetIdentityProviderSyncScopeRequest.js.map +1 -0
  123. package/dist/models/GetIdentityProviderSyncScopeResponse.d.ts +19 -0
  124. package/dist/models/GetIdentityProviderSyncScopeResponse.js +69 -0
  125. package/dist/models/GetIdentityProviderSyncScopeResponse.js.map +1 -0
  126. package/dist/models/GetIdentityProviderSyncScopeResponseBody.d.ts +177 -0
  127. package/dist/models/GetIdentityProviderSyncScopeResponseBody.js +151 -0
  128. package/dist/models/GetIdentityProviderSyncScopeResponseBody.js.map +1 -0
  129. package/dist/models/GetMemoryResponseBody.d.ts +4 -4
  130. package/dist/models/GetMemoryStoreResponseBody.d.ts +3 -3
  131. package/dist/models/ListAgentCodeRuntimesRequest.d.ts +29 -0
  132. package/dist/models/ListAgentCodeRuntimesRequest.js +60 -0
  133. package/dist/models/ListAgentCodeRuntimesRequest.js.map +1 -0
  134. package/dist/models/ListAgentCodeRuntimesResponse.d.ts +19 -0
  135. package/dist/models/ListAgentCodeRuntimesResponse.js +69 -0
  136. package/dist/models/ListAgentCodeRuntimesResponse.js.map +1 -0
  137. package/dist/models/ListAgentCodeRuntimesResponseBody.d.ts +115 -0
  138. package/dist/models/ListAgentCodeRuntimesResponseBody.js +100 -0
  139. package/dist/models/ListAgentCodeRuntimesResponseBody.js.map +1 -0
  140. package/dist/models/ListCustomAgentsRequest.d.ts +2 -2
  141. package/dist/models/ListCustomAgentsResponseBody.d.ts +221 -25
  142. package/dist/models/ListCustomAgentsResponseBody.js +119 -1
  143. package/dist/models/ListCustomAgentsResponseBody.js.map +1 -1
  144. package/dist/models/ListIdentityProviderDepartmentsRequest.d.ts +37 -0
  145. package/dist/models/ListIdentityProviderDepartmentsRequest.js +62 -0
  146. package/dist/models/ListIdentityProviderDepartmentsRequest.js.map +1 -0
  147. package/dist/models/ListIdentityProviderDepartmentsResponse.d.ts +19 -0
  148. package/dist/models/ListIdentityProviderDepartmentsResponse.js +69 -0
  149. package/dist/models/ListIdentityProviderDepartmentsResponse.js.map +1 -0
  150. package/dist/models/ListIdentityProviderDepartmentsResponseBody.d.ts +137 -0
  151. package/dist/models/ListIdentityProviderDepartmentsResponseBody.js +104 -0
  152. package/dist/models/ListIdentityProviderDepartmentsResponseBody.js.map +1 -0
  153. package/dist/models/ListIdentityProviderScimcredentialsRequest.d.ts +13 -0
  154. package/dist/models/ListIdentityProviderScimcredentialsRequest.js +54 -0
  155. package/dist/models/ListIdentityProviderScimcredentialsRequest.js.map +1 -0
  156. package/dist/models/ListIdentityProviderScimcredentialsResponse.d.ts +19 -0
  157. package/dist/models/ListIdentityProviderScimcredentialsResponse.js +69 -0
  158. package/dist/models/ListIdentityProviderScimcredentialsResponse.js.map +1 -0
  159. package/dist/models/ListIdentityProviderScimcredentialsResponseBody.d.ts +99 -0
  160. package/dist/models/ListIdentityProviderScimcredentialsResponseBody.js +96 -0
  161. package/dist/models/ListIdentityProviderScimcredentialsResponseBody.js.map +1 -0
  162. package/dist/models/ListIdentityProvidersResponseBody.d.ts +187 -25
  163. package/dist/models/ListIdentityProvidersResponseBody.js +103 -1
  164. package/dist/models/ListIdentityProvidersResponseBody.js.map +1 -1
  165. package/dist/models/ListMemoriesResponseBody.d.ts +1 -1
  166. package/dist/models/ListMemorySessionMessagesRequest.d.ts +3 -3
  167. package/dist/models/ListMemorySessionsRequest.d.ts +2 -2
  168. package/dist/models/ListMemorySessionsResponseBody.d.ts +1 -1
  169. package/dist/models/ListMemoryStoresResponseBody.d.ts +2 -2
  170. package/dist/models/PrepareIdentityProviderScimrequest.d.ts +13 -0
  171. package/dist/models/PrepareIdentityProviderScimrequest.js +54 -0
  172. package/dist/models/PrepareIdentityProviderScimrequest.js.map +1 -0
  173. package/dist/models/PrepareIdentityProviderScimresponse.d.ts +19 -0
  174. package/dist/models/PrepareIdentityProviderScimresponse.js +69 -0
  175. package/dist/models/PrepareIdentityProviderScimresponse.js.map +1 -0
  176. package/dist/models/PrepareIdentityProviderScimresponseBody.d.ts +157 -0
  177. package/dist/models/PrepareIdentityProviderScimresponseBody.js +146 -0
  178. package/dist/models/PrepareIdentityProviderScimresponseBody.js.map +1 -0
  179. package/dist/models/SearchMemoriesRequest.d.ts +3 -3
  180. package/dist/models/SearchMemoriesResponseBody.d.ts +3 -3
  181. package/dist/models/UpdateCustomAgentRequest.d.ts +49 -49
  182. package/dist/models/UpdateCustomAgentResponseBody.d.ts +124 -77
  183. package/dist/models/UpdateCustomAgentResponseBody.js +33 -1
  184. package/dist/models/UpdateCustomAgentResponseBody.js.map +1 -1
  185. package/dist/models/UpdateCustomAgentShrinkRequest.d.ts +1 -1
  186. package/dist/models/UpdateIdentityProviderRequest.d.ts +111 -10
  187. package/dist/models/UpdateIdentityProviderRequest.js +67 -1
  188. package/dist/models/UpdateIdentityProviderRequest.js.map +1 -1
  189. package/dist/models/UpdateIdentityProviderResponseBody.d.ts +159 -19
  190. package/dist/models/UpdateIdentityProviderResponseBody.js +95 -1
  191. package/dist/models/UpdateIdentityProviderResponseBody.js.map +1 -1
  192. package/dist/models/UpdateIdentityProviderScimrequest.d.ts +39 -0
  193. package/dist/models/UpdateIdentityProviderScimrequest.js +80 -0
  194. package/dist/models/UpdateIdentityProviderScimrequest.js.map +1 -0
  195. package/dist/models/UpdateIdentityProviderScimresponse.d.ts +19 -0
  196. package/dist/models/UpdateIdentityProviderScimresponse.js +69 -0
  197. package/dist/models/UpdateIdentityProviderScimresponse.js.map +1 -0
  198. package/dist/models/UpdateIdentityProviderScimresponseBody.d.ts +288 -0
  199. package/dist/models/UpdateIdentityProviderScimresponseBody.js +201 -0
  200. package/dist/models/UpdateIdentityProviderScimresponseBody.js.map +1 -0
  201. package/dist/models/UpdateIdentityProviderScimshrinkRequest.d.ts +20 -0
  202. package/dist/models/UpdateIdentityProviderScimshrinkRequest.js +58 -0
  203. package/dist/models/UpdateIdentityProviderScimshrinkRequest.js.map +1 -0
  204. package/dist/models/UpdateIdentityProviderShrinkRequest.d.ts +1 -1
  205. package/dist/models/UpdateMemoryRequest.d.ts +3 -3
  206. package/dist/models/UpdateMemoryShrinkRequest.d.ts +1 -1
  207. package/dist/models/UpdateMemoryStoreRequest.d.ts +2 -2
  208. package/dist/models/UpdateMemoryStoreResponseBody.d.ts +1 -1
  209. package/dist/models/ValidateAgentCodePackageFromOssRequest.d.ts +52 -0
  210. package/dist/models/ValidateAgentCodePackageFromOssRequest.js +82 -0
  211. package/dist/models/ValidateAgentCodePackageFromOssRequest.js.map +1 -0
  212. package/dist/models/ValidateAgentCodePackageFromOssResponse.d.ts +19 -0
  213. package/dist/models/ValidateAgentCodePackageFromOssResponse.js +69 -0
  214. package/dist/models/ValidateAgentCodePackageFromOssResponse.js.map +1 -0
  215. package/dist/models/ValidateAgentCodePackageFromOssResponseBody.d.ts +99 -0
  216. package/dist/models/ValidateAgentCodePackageFromOssResponseBody.js +96 -0
  217. package/dist/models/ValidateAgentCodePackageFromOssResponseBody.js.map +1 -0
  218. package/dist/models/ValidateAgentCodePackageFromOssShrinkRequest.d.ts +20 -0
  219. package/dist/models/ValidateAgentCodePackageFromOssShrinkRequest.js +58 -0
  220. package/dist/models/ValidateAgentCodePackageFromOssShrinkRequest.js.map +1 -0
  221. package/dist/models/VerifyAgentCodePackageOssRamAuthorizationRequest.d.ts +23 -0
  222. package/dist/models/VerifyAgentCodePackageOssRamAuthorizationRequest.js +58 -0
  223. package/dist/models/VerifyAgentCodePackageOssRamAuthorizationRequest.js.map +1 -0
  224. package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponse.d.ts +19 -0
  225. package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponse.js +69 -0
  226. package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponse.js.map +1 -0
  227. package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.d.ts +99 -0
  228. package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.js +96 -0
  229. package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.js.map +1 -0
  230. package/dist/models/model.d.ts +107 -0
  231. package/dist/models/model.js +328 -112
  232. package/dist/models/model.js.map +1 -1
  233. package/package.json +1 -1
  234. package/src/client.ts +1666 -81
  235. package/src/models/AddMemoriesRequest.ts +10 -10
  236. package/src/models/AddMemoriesResponseBody.ts +4 -4
  237. package/src/models/AddMemoriesShrinkRequest.ts +1 -1
  238. package/src/models/CreateCustomAgentRequest.ts +43 -43
  239. package/src/models/CreateCustomAgentResponseBody.ts +141 -61
  240. package/src/models/CreateIdentityProviderRequest.ts +73 -10
  241. package/src/models/CreateIdentityProviderResponseBody.ts +217 -8
  242. package/src/models/CreateIdentityProviderScimcredentialRequest.ts +24 -0
  243. package/src/models/CreateIdentityProviderScimcredentialResponse.ts +40 -0
  244. package/src/models/CreateIdentityProviderScimcredentialResponseBody.ts +231 -0
  245. package/src/models/CreateIdentityProviderShrinkRequest.ts +1 -1
  246. package/src/models/CreateIdentityProviderSyncJobRequest.ts +24 -0
  247. package/src/models/CreateIdentityProviderSyncJobResponse.ts +40 -0
  248. package/src/models/CreateIdentityProviderSyncJobResponseBody.ts +167 -0
  249. package/src/models/CreateMemoryStoreRequest.ts +6 -6
  250. package/src/models/CreateMemoryStoreResponseBody.ts +7 -7
  251. package/src/models/CreateMemoryStoreShrinkRequest.ts +2 -2
  252. package/src/models/CreateWorkspaceRequest.ts +27 -7
  253. package/src/models/CreateWorkspaceResponseBody.ts +11 -11
  254. package/src/models/CreateWorkspaceShrinkRequest.ts +1 -1
  255. package/src/models/DeleteIdentityProviderResponseBody.ts +157 -17
  256. package/src/models/DeleteIdentityProviderScimcredentialRequest.ts +24 -0
  257. package/src/models/DeleteIdentityProviderScimcredentialResponse.ts +40 -0
  258. package/src/models/DeleteIdentityProviderScimcredentialResponseBody.ts +71 -0
  259. package/src/models/DeleteMemoryStoreResponseBody.ts +3 -3
  260. package/src/models/GetAgentCodePackageDownloadUrlRequest.ts +24 -0
  261. package/src/models/GetAgentCodePackageDownloadUrlResponse.ts +40 -0
  262. package/src/models/GetAgentCodePackageDownloadUrlResponseBody.ts +181 -0
  263. package/src/models/GetAgentCodePackageOssRamAuthorizeUrlRequest.ts +36 -0
  264. package/src/models/GetAgentCodePackageOssRamAuthorizeUrlResponse.ts +40 -0
  265. package/src/models/GetAgentCodePackageOssRamAuthorizeUrlResponseBody.ts +141 -0
  266. package/src/models/GetAgentCodePackageUploadUrlRequest.ts +92 -0
  267. package/src/models/GetAgentCodePackageUploadUrlResponse.ts +40 -0
  268. package/src/models/GetAgentCodePackageUploadUrlResponseBody.ts +161 -0
  269. package/src/models/GetAgentCodePackageUploadUrlShrinkRequest.ts +33 -0
  270. package/src/models/GetCustomAgentResponseBody.ts +128 -48
  271. package/src/models/GetIdentityProviderResponseBody.ts +258 -9
  272. package/src/models/GetIdentityProviderScimrequest.ts +24 -0
  273. package/src/models/GetIdentityProviderScimresponse.ts +40 -0
  274. package/src/models/GetIdentityProviderScimresponseBody.ts +178 -0
  275. package/src/models/GetIdentityProviderServiceProviderRequest.ts +36 -0
  276. package/src/models/GetIdentityProviderServiceProviderResponse.ts +40 -0
  277. package/src/models/GetIdentityProviderServiceProviderResponseBody.ts +141 -0
  278. package/src/models/GetIdentityProviderSyncJobRequest.ts +24 -0
  279. package/src/models/GetIdentityProviderSyncJobResponse.ts +40 -0
  280. package/src/models/GetIdentityProviderSyncJobResponseBody.ts +174 -0
  281. package/src/models/GetIdentityProviderSyncScopeRequest.ts +24 -0
  282. package/src/models/GetIdentityProviderSyncScopeResponse.ts +40 -0
  283. package/src/models/GetIdentityProviderSyncScopeResponseBody.ts +256 -0
  284. package/src/models/GetMemoryResponseBody.ts +4 -4
  285. package/src/models/GetMemoryStoreResponseBody.ts +3 -3
  286. package/src/models/ListAgentCodeRuntimesRequest.ts +44 -0
  287. package/src/models/ListAgentCodeRuntimesResponse.ts +40 -0
  288. package/src/models/ListAgentCodeRuntimesResponseBody.ts +161 -0
  289. package/src/models/ListCustomAgentsRequest.ts +2 -2
  290. package/src/models/ListCustomAgentsResponseBody.ts +303 -25
  291. package/src/models/ListIdentityProviderDepartmentsRequest.ts +54 -0
  292. package/src/models/ListIdentityProviderDepartmentsResponse.ts +40 -0
  293. package/src/models/ListIdentityProviderDepartmentsResponseBody.ts +187 -0
  294. package/src/models/ListIdentityProviderScimcredentialsRequest.ts +24 -0
  295. package/src/models/ListIdentityProviderScimcredentialsResponse.ts +40 -0
  296. package/src/models/ListIdentityProviderScimcredentialsResponseBody.ts +141 -0
  297. package/src/models/ListIdentityProvidersResponseBody.ts +262 -25
  298. package/src/models/ListMemoriesResponseBody.ts +1 -1
  299. package/src/models/ListMemorySessionMessagesRequest.ts +3 -3
  300. package/src/models/ListMemorySessionsRequest.ts +2 -2
  301. package/src/models/ListMemorySessionsResponseBody.ts +1 -1
  302. package/src/models/ListMemoryStoresResponseBody.ts +2 -2
  303. package/src/models/PrepareIdentityProviderScimrequest.ts +24 -0
  304. package/src/models/PrepareIdentityProviderScimresponse.ts +40 -0
  305. package/src/models/PrepareIdentityProviderScimresponseBody.ts +231 -0
  306. package/src/models/SearchMemoriesRequest.ts +3 -3
  307. package/src/models/SearchMemoriesResponseBody.ts +3 -3
  308. package/src/models/UpdateCustomAgentRequest.ts +49 -49
  309. package/src/models/UpdateCustomAgentResponseBody.ts +147 -77
  310. package/src/models/UpdateCustomAgentShrinkRequest.ts +1 -1
  311. package/src/models/UpdateIdentityProviderRequest.ts +159 -10
  312. package/src/models/UpdateIdentityProviderResponseBody.ts +226 -19
  313. package/src/models/UpdateIdentityProviderScimrequest.ts +65 -0
  314. package/src/models/UpdateIdentityProviderScimresponse.ts +40 -0
  315. package/src/models/UpdateIdentityProviderScimresponseBody.ts +408 -0
  316. package/src/models/UpdateIdentityProviderScimshrinkRequest.ts +33 -0
  317. package/src/models/UpdateIdentityProviderShrinkRequest.ts +1 -1
  318. package/src/models/UpdateMemoryRequest.ts +3 -3
  319. package/src/models/UpdateMemoryShrinkRequest.ts +1 -1
  320. package/src/models/UpdateMemoryStoreRequest.ts +2 -2
  321. package/src/models/UpdateMemoryStoreResponseBody.ts +1 -1
  322. package/src/models/ValidateAgentCodePackageFromOssRequest.ts +80 -0
  323. package/src/models/ValidateAgentCodePackageFromOssResponse.ts +40 -0
  324. package/src/models/ValidateAgentCodePackageFromOssResponseBody.ts +141 -0
  325. package/src/models/ValidateAgentCodePackageFromOssShrinkRequest.ts +33 -0
  326. package/src/models/VerifyAgentCodePackageOssRamAuthorizationRequest.ts +36 -0
  327. package/src/models/VerifyAgentCodePackageOssRamAuthorizationResponse.ts +40 -0
  328. package/src/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.ts +141 -0
  329. package/src/models/model.ts +107 -0
package/dist/client.d.ts CHANGED
@@ -9,10 +9,10 @@ export default class Client extends OpenApi {
9
9
  [key: string]: string;
10
10
  }, endpoint: string): string;
11
11
  /**
12
- * Writes messages or text to a memory store. By default, sync is set to true, which synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId that can be queried by using GetMemoryTask.
12
+ * Writes messages or text to a memory store. By default, sync is set to true, which means the operation synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId, which you can query by calling GetMemoryTask.
13
13
  *
14
14
  * @remarks
15
- * Writes messages or text to a memory store. By default, sync is set to true, which synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId that can be queried by using GetMemoryTask.
15
+ * Writes messages or text to a memory store. By default, sync is set to true, which means the operation synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId, which you can query by calling GetMemoryTask.
16
16
  *
17
17
  * @param tmpReq - AddMemoriesRequest
18
18
  * @param headers - map
@@ -23,10 +23,10 @@ export default class Client extends OpenApi {
23
23
  [key: string]: string;
24
24
  }, runtime: $dara.RuntimeOptions): Promise<$_model.AddMemoriesResponse>;
25
25
  /**
26
- * Writes messages or text to a memory store. By default, sync is set to true, which synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId that can be queried by using GetMemoryTask.
26
+ * Writes messages or text to a memory store. By default, sync is set to true, which means the operation synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId, which you can query by calling GetMemoryTask.
27
27
  *
28
28
  * @remarks
29
- * Writes messages or text to a memory store. By default, sync is set to true, which synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId that can be queried by using GetMemoryTask.
29
+ * Writes messages or text to a memory store. By default, sync is set to true, which means the operation synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId, which you can query by calling GetMemoryTask.
30
30
  *
31
31
  * @param request - AddMemoriesRequest
32
32
  * @returns AddMemoriesResponse
@@ -201,13 +201,15 @@ export default class Client extends OpenApi {
201
201
  */
202
202
  createCredential(workspaceId: string, request: $_model.CreateCredentialRequest): Promise<$_model.CreateCredentialResponse>;
203
203
  /**
204
- * Creates a custom agent in a specified workspace and submits a container image deployment configuration. The creation is an asynchronous process. You can call GetCustomAgent to query the deployment result.
204
+ * Creates a custom agent in a specified workspace. Container image and code package deployments are supported. The creation process is asynchronous. You can call GetCustomAgent to query the deployment result.
205
205
  *
206
206
  * @remarks
207
- * Before you call this operation, prepare a writable workspace, a RAM role ARN, an ACR container image, and a runtime configuration. You must specify name, artifact, roleArn, and runtime. The runtime parameter must include both compute and sessionPolicy.
208
- * Currently, only ACR container image deployment is supported. Use artifact.container and specify the service listening port in artifact.port. Omit artifact.code. The image must have the required access permissions and be accessible over the network allowed by the workspace.
209
- * The creation is an asynchronous process. A successful response indicates that the request is accepted. Use the returned agentId to call GetCustomAgent and check latestVersionStatus, latestExecutionError, and status for the corresponding latestSpecVersion to confirm the deployment result. After the deployment is ready, you can call CreateServiceEndpoint to configure an access endpoint.
210
- * The clientToken parameter does not currently provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold parameter for health checks does not currently take effect. Omit this parameter.
207
+ * Before you call this operation, prepare a writable workspace, a RAM role ARN, a container image or code package, and runtime configurations. You must specify name, artifact, roleArn, and runtime. The runtime parameter must include both compute and sessionPolicy.
208
+ * In container mode, use artifact.container and specify artifact.port. The image must have the required access permissions and be accessible over the network allowed by the workspace.
209
+ * In code package pattern, specify artifact.port, and the sourceUri, languageRuntime, and entrypoint of artifact.code. Do not specify container at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported. The compressed package size cannot exceed 500,000,000 bytes. You can call ListAgentCodeRuntimes to query the runtime environment identity. The sourceUri parameter supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, call GetAgentCodePackageUploadUrl to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
210
+ * When you submit a new code package source, the backend rechecks the read permissions, object, and size. The configuration is saved only after the transfer succeeds. If the transfer fails, the configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not mean that the agent is ready to run.
211
+ * The creation process is asynchronous. A successful response indicates that the request is accepted. You can use the returned agentId to call GetCustomAgent and check the latestVersionStatus, latestExecutionError, and status corresponding to latestSpecVersion to confirm the deployment result. After the deployment is ready, you can call CreateServiceEndpoint to configure the access endpoint.
212
+ * The clientToken parameter does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold parameter for health checks does not take effect. Omit this parameter.
211
213
  *
212
214
  * @param tmpReq - CreateCustomAgentRequest
213
215
  * @param headers - map
@@ -218,13 +220,15 @@ export default class Client extends OpenApi {
218
220
  [key: string]: string;
219
221
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateCustomAgentResponse>;
220
222
  /**
221
- * Creates a custom agent in a specified workspace and submits a container image deployment configuration. The creation is an asynchronous process. You can call GetCustomAgent to query the deployment result.
223
+ * Creates a custom agent in a specified workspace. Container image and code package deployments are supported. The creation process is asynchronous. You can call GetCustomAgent to query the deployment result.
222
224
  *
223
225
  * @remarks
224
- * Before you call this operation, prepare a writable workspace, a RAM role ARN, an ACR container image, and a runtime configuration. You must specify name, artifact, roleArn, and runtime. The runtime parameter must include both compute and sessionPolicy.
225
- * Currently, only ACR container image deployment is supported. Use artifact.container and specify the service listening port in artifact.port. Omit artifact.code. The image must have the required access permissions and be accessible over the network allowed by the workspace.
226
- * The creation is an asynchronous process. A successful response indicates that the request is accepted. Use the returned agentId to call GetCustomAgent and check latestVersionStatus, latestExecutionError, and status for the corresponding latestSpecVersion to confirm the deployment result. After the deployment is ready, you can call CreateServiceEndpoint to configure an access endpoint.
227
- * The clientToken parameter does not currently provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold parameter for health checks does not currently take effect. Omit this parameter.
226
+ * Before you call this operation, prepare a writable workspace, a RAM role ARN, a container image or code package, and runtime configurations. You must specify name, artifact, roleArn, and runtime. The runtime parameter must include both compute and sessionPolicy.
227
+ * In container mode, use artifact.container and specify artifact.port. The image must have the required access permissions and be accessible over the network allowed by the workspace.
228
+ * In code package pattern, specify artifact.port, and the sourceUri, languageRuntime, and entrypoint of artifact.code. Do not specify container at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported. The compressed package size cannot exceed 500,000,000 bytes. You can call ListAgentCodeRuntimes to query the runtime environment identity. The sourceUri parameter supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, call GetAgentCodePackageUploadUrl to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
229
+ * When you submit a new code package source, the backend rechecks the read permissions, object, and size. The configuration is saved only after the transfer succeeds. If the transfer fails, the configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not mean that the agent is ready to run.
230
+ * The creation process is asynchronous. A successful response indicates that the request is accepted. You can use the returned agentId to call GetCustomAgent and check the latestVersionStatus, latestExecutionError, and status corresponding to latestSpecVersion to confirm the deployment result. After the deployment is ready, you can call CreateServiceEndpoint to configure the access endpoint.
231
+ * The clientToken parameter does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold parameter for health checks does not take effect. Omit this parameter.
228
232
  *
229
233
  * @param request - CreateCustomAgentRequest
230
234
  * @returns CreateCustomAgentResponse
@@ -279,7 +283,34 @@ export default class Client extends OpenApi {
279
283
  */
280
284
  createExternalAgentBootstrapToken(workspaceId: string, agentId: string, request: $_model.CreateExternalAgentBootstrapTokenRequest): Promise<$_model.CreateExternalAgentBootstrapTokenResponse>;
281
285
  /**
282
- * Binds an external identity provider to a specified workspace to enable single sign-on and organization member synchronization for workspace users. Each workspace can be bound to a maximum of one external identity provider. This is an asynchronous operation. After the API call returns, you can call GetIdentityProvider to query the status and track the progress.
286
+ * Binds an external identity provider to a specified workspace for single sign-on and organization member synchronization of workspace users. A maximum of one external identity provider can be bound to each workspace. The binding is an asynchronous operation. After the API returns, you can query the status by calling GetIdentityProvider to track the progress.
287
+ *
288
+ * @remarks
289
+ * ## Features and prerequisites
290
+ * A workspace can be bound to only one external identity provider. The identityProviderType parameter supports DingTalk, Feishu, and CustomSSO. CustomSSO only initializes the shared user pool. Do not pass non-empty metadata, and do not pass true for loginEnabled or syncEnabled. By default, both switches are turned off. Protocols and SAML configurations are saved by calling UpdateIdentityProvider. SCIM is configured through a separate API. Saving SAML first is not required. After the request is accepted and CONFIGURED is returned, call GetIdentityProvider and wait for the user pool initialization to complete. READY only indicates that the resource is ready, not that SAML is configured. If the same CustomSSO binding is in the CONFIGURED or READY state, the existing binding may be returned. Not all states can be treated as repeatedly creatable.
291
+ * For DingTalk, appKey, appSecret, and corpId are required in metadata. For Feishu, appId and appSecret are required. The vendor login switch is enabled by default. The synchronization switch is disabled by default. When synchronization is enabled, encryptKey and verificationToken are also required. The vendor syncOnBind and syncScope parameters retain the existing department-based synchronization definitions. Do not use these vendor pull parameters to replace SCIM configurations during CustomSSO initialization.
292
+ * ## Requests and examples
293
+ * POST /workspaces/{workspaceId}/identity-providers
294
+ * Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. The ws-example, URL, certificate, and token in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
295
+ * ```text
296
+ * POST /workspaces/ws-example/identity-providers
297
+ * {"identityProviderType": "CustomSSO"}
298
+ * ```
299
+ * ## Response example
300
+ * ```json
301
+ * {
302
+ * "data": {
303
+ * "workspaceId": "ws-example",
304
+ * "identityProviderType": "CustomSSO",
305
+ * "loginEnabled": false,
306
+ * "syncEnabled": false,
307
+ * "status": "CONFIGURED"
308
+ * }
309
+ * }
310
+ * ```
311
+ * ## Errors and handling
312
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. A synchronous call failure to an upstream service may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
313
+ * 409 IdentityProviderAlreadyBound: An external binding already exists. Query and reuse the correct binding first. Do not automatically unbind the entire binding. Asynchronous initialization failure does not equal HTTP request failure. You must continue to query the status.
283
314
  *
284
315
  * @param tmpReq - CreateIdentityProviderRequest
285
316
  * @param headers - map
@@ -290,12 +321,185 @@ export default class Client extends OpenApi {
290
321
  [key: string]: string;
291
322
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateIdentityProviderResponse>;
292
323
  /**
293
- * Binds an external identity provider to a specified workspace to enable single sign-on and organization member synchronization for workspace users. Each workspace can be bound to a maximum of one external identity provider. This is an asynchronous operation. After the API call returns, you can call GetIdentityProvider to query the status and track the progress.
324
+ * Binds an external identity provider to a specified workspace for single sign-on and organization member synchronization of workspace users. A maximum of one external identity provider can be bound to each workspace. The binding is an asynchronous operation. After the API returns, you can query the status by calling GetIdentityProvider to track the progress.
325
+ *
326
+ * @remarks
327
+ * ## Features and prerequisites
328
+ * A workspace can be bound to only one external identity provider. The identityProviderType parameter supports DingTalk, Feishu, and CustomSSO. CustomSSO only initializes the shared user pool. Do not pass non-empty metadata, and do not pass true for loginEnabled or syncEnabled. By default, both switches are turned off. Protocols and SAML configurations are saved by calling UpdateIdentityProvider. SCIM is configured through a separate API. Saving SAML first is not required. After the request is accepted and CONFIGURED is returned, call GetIdentityProvider and wait for the user pool initialization to complete. READY only indicates that the resource is ready, not that SAML is configured. If the same CustomSSO binding is in the CONFIGURED or READY state, the existing binding may be returned. Not all states can be treated as repeatedly creatable.
329
+ * For DingTalk, appKey, appSecret, and corpId are required in metadata. For Feishu, appId and appSecret are required. The vendor login switch is enabled by default. The synchronization switch is disabled by default. When synchronization is enabled, encryptKey and verificationToken are also required. The vendor syncOnBind and syncScope parameters retain the existing department-based synchronization definitions. Do not use these vendor pull parameters to replace SCIM configurations during CustomSSO initialization.
330
+ * ## Requests and examples
331
+ * POST /workspaces/{workspaceId}/identity-providers
332
+ * Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. The ws-example, URL, certificate, and token in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
333
+ * ```text
334
+ * POST /workspaces/ws-example/identity-providers
335
+ * {"identityProviderType": "CustomSSO"}
336
+ * ```
337
+ * ## Response example
338
+ * ```json
339
+ * {
340
+ * "data": {
341
+ * "workspaceId": "ws-example",
342
+ * "identityProviderType": "CustomSSO",
343
+ * "loginEnabled": false,
344
+ * "syncEnabled": false,
345
+ * "status": "CONFIGURED"
346
+ * }
347
+ * }
348
+ * ```
349
+ * ## Errors and handling
350
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. A synchronous call failure to an upstream service may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
351
+ * 409 IdentityProviderAlreadyBound: An external binding already exists. Query and reuse the correct binding first. Do not automatically unbind the entire binding. Asynchronous initialization failure does not equal HTTP request failure. You must continue to query the status.
294
352
  *
295
353
  * @param request - CreateIdentityProviderRequest
296
354
  * @returns CreateIdentityProviderResponse
297
355
  */
298
356
  createIdentityProvider(workspaceId: string, request: $_model.CreateIdentityProviderRequest): Promise<$_model.CreateIdentityProviderResponse>;
357
+ /**
358
+ * Issues a SCIM credential explicitly and returns the plaintext token only for the current call. A maximum of two credentials are allowed in the same pool. This operation does not automatically revoke old credentials or enable AC user synchronization.
359
+ *
360
+ * @remarks
361
+ * ## Features and prerequisites
362
+ * Issues a new credential explicitly. This requires an available shared pool and the AgentIdentity SCIM reception to be Enabled. This operation does not automatically enable reception. If it is not enabled, call prepare first. Returns the configuration, credential summary, and the current token. The limit of a maximum of two credentials is enforced by AgentIdentity. An existing available token does not prevent users from explicitly creating a second one. Old credentials are not automatically revoked, and no extended rotation process is provided.
363
+ * The token is returned only once and cannot be retrieved again in subsequent list and query operations. Do not automatically retry the issuance. If the response is lost, check the list first to verify whether it has been created. Creating a credential does not enable AC syncEnabled, start a full user import, or switch SAML logon. Deleting an old token should be performed explicitly after the user confirms the actual usage of the external provisioning system.
364
+ * ## Request and examples
365
+ * POST /workspaces/{workspaceId}/scim-provisioning/credentials
366
+ * Call conventions: Call the operation in the region of the target workspace, using an AK/STS identity that has permissions for the identity source resources of the corresponding workspace. The ws-example, URL, certificate, and token in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameter content of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log the key. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
367
+ * ```text
368
+ * POST /workspaces/ws-example/scim-provisioning/credentials
369
+ * No business request body.
370
+ * ```
371
+ * ## Response example
372
+ * ```json
373
+ * {
374
+ * "data": {
375
+ * "configuration": {
376
+ * "status": "Enabled",
377
+ * "baseUrl": "https://example.com/scim/v2"
378
+ * },
379
+ * "credential": {
380
+ * "credentialId": "credential-example",
381
+ * "status": "Enabled",
382
+ * "expireTime": "<Upstream expiration time>"
383
+ * },
384
+ * "token": "<Newly issued token for the current request>"
385
+ * }
386
+ * }
387
+ * ```
388
+ * ## Errors and handling
389
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that there is no binding of the matching type. Synchronous calls to the upstream may fail and return 503 IdentityProviderProvisioningUnavailable. Keep the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
390
+ * 400 LimitExceeded.ScimCredential: A maximum of two credentials are allowed. Delete one before you can continue to create. 400 InvalidParameter: Reception is not enabled or the shared pool is unavailable. Do not retry quota errors as system failures.
391
+ * ## Call relationships and usage boundaries
392
+ * After creation, securely save the token that is returned only once and configure it in the external provisioning system. Existing tokens remain valid. Only DeleteIdentityProviderSCIMCredential revokes the specified credential. Do not automatically retry when the response is lost. Call ListIdentityProviderSCIMCredentials to check first. This operation does not provide automatic rotation or scaling.
393
+ *
394
+ * @param request - CreateIdentityProviderSCIMCredentialRequest
395
+ * @param headers - map
396
+ * @param runtime - runtime options for this request RuntimeOptions
397
+ * @returns CreateIdentityProviderSCIMCredentialResponse
398
+ */
399
+ createIdentityProviderSCIMCredentialWithOptions(workspaceId: string, request: $_model.CreateIdentityProviderSCIMCredentialRequest, headers: {
400
+ [key: string]: string;
401
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateIdentityProviderSCIMCredentialResponse>;
402
+ /**
403
+ * Issues a SCIM credential explicitly and returns the plaintext token only for the current call. A maximum of two credentials are allowed in the same pool. This operation does not automatically revoke old credentials or enable AC user synchronization.
404
+ *
405
+ * @remarks
406
+ * ## Features and prerequisites
407
+ * Issues a new credential explicitly. This requires an available shared pool and the AgentIdentity SCIM reception to be Enabled. This operation does not automatically enable reception. If it is not enabled, call prepare first. Returns the configuration, credential summary, and the current token. The limit of a maximum of two credentials is enforced by AgentIdentity. An existing available token does not prevent users from explicitly creating a second one. Old credentials are not automatically revoked, and no extended rotation process is provided.
408
+ * The token is returned only once and cannot be retrieved again in subsequent list and query operations. Do not automatically retry the issuance. If the response is lost, check the list first to verify whether it has been created. Creating a credential does not enable AC syncEnabled, start a full user import, or switch SAML logon. Deleting an old token should be performed explicitly after the user confirms the actual usage of the external provisioning system.
409
+ * ## Request and examples
410
+ * POST /workspaces/{workspaceId}/scim-provisioning/credentials
411
+ * Call conventions: Call the operation in the region of the target workspace, using an AK/STS identity that has permissions for the identity source resources of the corresponding workspace. The ws-example, URL, certificate, and token in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameter content of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log the key. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
412
+ * ```text
413
+ * POST /workspaces/ws-example/scim-provisioning/credentials
414
+ * No business request body.
415
+ * ```
416
+ * ## Response example
417
+ * ```json
418
+ * {
419
+ * "data": {
420
+ * "configuration": {
421
+ * "status": "Enabled",
422
+ * "baseUrl": "https://example.com/scim/v2"
423
+ * },
424
+ * "credential": {
425
+ * "credentialId": "credential-example",
426
+ * "status": "Enabled",
427
+ * "expireTime": "<Upstream expiration time>"
428
+ * },
429
+ * "token": "<Newly issued token for the current request>"
430
+ * }
431
+ * }
432
+ * ```
433
+ * ## Errors and handling
434
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that there is no binding of the matching type. Synchronous calls to the upstream may fail and return 503 IdentityProviderProvisioningUnavailable. Keep the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
435
+ * 400 LimitExceeded.ScimCredential: A maximum of two credentials are allowed. Delete one before you can continue to create. 400 InvalidParameter: Reception is not enabled or the shared pool is unavailable. Do not retry quota errors as system failures.
436
+ * ## Call relationships and usage boundaries
437
+ * After creation, securely save the token that is returned only once and configure it in the external provisioning system. Existing tokens remain valid. Only DeleteIdentityProviderSCIMCredential revokes the specified credential. Do not automatically retry when the response is lost. Call ListIdentityProviderSCIMCredentials to check first. This operation does not provide automatic rotation or scaling.
438
+ *
439
+ * @param request - CreateIdentityProviderSCIMCredentialRequest
440
+ * @returns CreateIdentityProviderSCIMCredentialResponse
441
+ */
442
+ createIdentityProviderSCIMCredential(workspaceId: string, request: $_model.CreateIdentityProviderSCIMCredentialRequest): Promise<$_model.CreateIdentityProviderSCIMCredentialResponse>;
443
+ /**
444
+ * Initiates a manual synchronization of an identity provider.
445
+ *
446
+ * @remarks
447
+ * Initiates a one-time user synchronization based on the saved scope without saving the configuration or requiring syncEnabled=true. Prerequisites: the identity provider is in the READY or SYNC_FAILED state, a user pool exists, and no other pending identity provider operations are in progress. The returned taskId only indicates that the request is accepted. Call GetIdentityProviderSyncJob to poll the status until it reaches SUCCESS, FAILED, or CANCELED. If the task fails, check the failureReason. The workspace user quota still applies, and previously synchronized users are not automatically deleted if the scope is reduced.
448
+ * Authorization information: RAM action agentcore:CreateIdentityProviderSyncJob, access level Write, resource ARN: acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is required for authorization.
449
+ * Idempotency and retry: This operation does not provide a ClientToken parameter for conditional idempotency. Repeated submissions do not guarantee the same task is returned. If an operation is already in progress, an operation conflict is returned. Submitting again after the task ends creates a new synchronization task. If a submission times out, query the identity provider status first to avoid blindly resubmitting the request.
450
+ * Calling this API is free of charge, and operation records support ActionTrail auditing.
451
+ * Initial selective synchronization process: CreateIdentityProvider (syncOnBind=false, it is recommended to keep syncEnabled=false initially) → GetIdentityProvider and wait for READY → ListIdentityProviderDepartments to select departments → UpdateIdentityProvider to save syncScope and wait for READY → CreateIdentityProviderSyncJob → GetIdentityProviderSyncJob to query the terminal state. If incremental synchronization is required, configure callbacks and event subscriptions, and then update syncEnabled=true.
452
+ * Response example:
453
+ * ```json
454
+ * {
455
+ * "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
456
+ * "message": "success",
457
+ * "httpStatusCode": 200,
458
+ * "code": "SUCCESS",
459
+ * "success": true,
460
+ * "data": {
461
+ * "taskId": "12345678-1234-4234-8234-123456789abc",
462
+ * "status": "PENDING"
463
+ * }
464
+ * }
465
+ * ```
466
+ *
467
+ * @param request - CreateIdentityProviderSyncJobRequest
468
+ * @param headers - map
469
+ * @param runtime - runtime options for this request RuntimeOptions
470
+ * @returns CreateIdentityProviderSyncJobResponse
471
+ */
472
+ createIdentityProviderSyncJobWithOptions(workspaceId: string, identityProviderType: string, request: $_model.CreateIdentityProviderSyncJobRequest, headers: {
473
+ [key: string]: string;
474
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateIdentityProviderSyncJobResponse>;
475
+ /**
476
+ * Initiates a manual synchronization of an identity provider.
477
+ *
478
+ * @remarks
479
+ * Initiates a one-time user synchronization based on the saved scope without saving the configuration or requiring syncEnabled=true. Prerequisites: the identity provider is in the READY or SYNC_FAILED state, a user pool exists, and no other pending identity provider operations are in progress. The returned taskId only indicates that the request is accepted. Call GetIdentityProviderSyncJob to poll the status until it reaches SUCCESS, FAILED, or CANCELED. If the task fails, check the failureReason. The workspace user quota still applies, and previously synchronized users are not automatically deleted if the scope is reduced.
480
+ * Authorization information: RAM action agentcore:CreateIdentityProviderSyncJob, access level Write, resource ARN: acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is required for authorization.
481
+ * Idempotency and retry: This operation does not provide a ClientToken parameter for conditional idempotency. Repeated submissions do not guarantee the same task is returned. If an operation is already in progress, an operation conflict is returned. Submitting again after the task ends creates a new synchronization task. If a submission times out, query the identity provider status first to avoid blindly resubmitting the request.
482
+ * Calling this API is free of charge, and operation records support ActionTrail auditing.
483
+ * Initial selective synchronization process: CreateIdentityProvider (syncOnBind=false, it is recommended to keep syncEnabled=false initially) → GetIdentityProvider and wait for READY → ListIdentityProviderDepartments to select departments → UpdateIdentityProvider to save syncScope and wait for READY → CreateIdentityProviderSyncJob → GetIdentityProviderSyncJob to query the terminal state. If incremental synchronization is required, configure callbacks and event subscriptions, and then update syncEnabled=true.
484
+ * Response example:
485
+ * ```json
486
+ * {
487
+ * "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
488
+ * "message": "success",
489
+ * "httpStatusCode": 200,
490
+ * "code": "SUCCESS",
491
+ * "success": true,
492
+ * "data": {
493
+ * "taskId": "12345678-1234-4234-8234-123456789abc",
494
+ * "status": "PENDING"
495
+ * }
496
+ * }
497
+ * ```
498
+ *
499
+ * @param request - CreateIdentityProviderSyncJobRequest
500
+ * @returns CreateIdentityProviderSyncJobResponse
501
+ */
502
+ createIdentityProviderSyncJob(workspaceId: string, identityProviderType: string, request: $_model.CreateIdentityProviderSyncJobRequest): Promise<$_model.CreateIdentityProviderSyncJobResponse>;
299
503
  /**
300
504
  * Creates an image cache.
301
505
  *
@@ -681,7 +885,33 @@ export default class Client extends OpenApi {
681
885
  */
682
886
  deleteExternalAgent(workspaceId: string, agentId: string, request: $_model.DeleteExternalAgentRequest): Promise<$_model.DeleteExternalAgentResponse>;
683
887
  /**
684
- * Unbinds the external identity provider from a specified workspace and cleans up users synchronized by that identity provider. The unbinding is an asynchronous operation. After the API returns, you can call GetIdentityProvider to query the status and track the progress.
888
+ * Disconnects the identity source integration of a workspace. For CustomSSO, this operation clears the shared user pool and related SAML and SCIM resources. To disable only logon or synchronization, use the corresponding switch API operations.
889
+ *
890
+ * @remarks
891
+ * ## Features and prerequisites
892
+ * This operation completely disconnects the integration, rather than simply disabling logon. Disconnecting CustomSSO clears the AC users imported from this identity source, the remote shared user pool and related resources, and the logon publishing configurations and bindings. Therefore, both SAML and SCIM are affected. However, this operation does not delete the enterprise applications created by users on external platforms such as Azure. Before disconnecting, the system checks for references between users and teams. If references exist, the disconnection is rejected.
893
+ * After the request is accepted, the status returned is DISCONNECTING. You can query the status by calling GetIdentityProvider. The cleanup is complete only when the binding no longer exists (IdentityProviderNotFound). The binding should also no longer appear in the list. DISCONNECT_FAILED indicates that partial cleanup may have occurred, and the state cannot be restored to a completely unconfigured state. You can retry based on the returned status. If the binding does not exist in the first place, the API operation returns a placeholder result indicating no binding without creating new resources. An ongoing disconnection task may return the current binding. Do not use this API operation as a substitute for setting loginEnabled=false, syncEnabled=false, or deleting a single token.
894
+ * ## Requests and examples
895
+ * DELETE /workspaces/{workspaceId}/identity-providers/{identityProviderType}
896
+ * Calling conventions: Call the API operation in the region of the target workspace, using an AK/STS identity that has the corresponding workspace identity source resource permissions. The ws-example, URLs, certificates, and tokens in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log secrets. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
897
+ * ```text
898
+ * DELETE /workspaces/ws-example/identity-providers/CustomSSO
899
+ * ```
900
+ * ## Response examples
901
+ * ```json
902
+ * {
903
+ * "data": {
904
+ * "workspaceId": "ws-example",
905
+ * "identityProviderType": "CustomSSO",
906
+ * "status": "DISCONNECTING"
907
+ * }
908
+ * }
909
+ * ```
910
+ * ## Errors and handling
911
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. Synchronous calls to upstream services that fail may return 503 IdentityProviderProvisioningUnavailable. Keep the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
912
+ * 409 IdentityProvider.Disconnect.Conflict: Users of this identity source still belong to a team. Remove the references first. 409 IdentityProviderOperationConflict: The current status does not allow disconnection. 404 IdentityProviderNotFound: An external binding exists but the type does not match. Asynchronous failures may result in partial cleanup. You cannot claim completion based solely on the first response.
913
+ * ## Calling relationships and usage boundaries
914
+ * If you only need to disable a specific capability: To disable SAML logon, use UpdateIdentityProvider and set loginEnabled=false. To disable SCIM, use UpdateIdentityProviderSCIM and set syncEnabled=false. To revoke a single token, use DeleteIdentityProviderSCIMCredential. Call this API operation only when you need to completely disconnect the integration.
685
915
  *
686
916
  * @param request - DeleteIdentityProviderRequest
687
917
  * @param headers - map
@@ -692,12 +922,62 @@ export default class Client extends OpenApi {
692
922
  [key: string]: string;
693
923
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteIdentityProviderResponse>;
694
924
  /**
695
- * Unbinds the external identity provider from a specified workspace and cleans up users synchronized by that identity provider. The unbinding is an asynchronous operation. After the API returns, you can call GetIdentityProvider to query the status and track the progress.
925
+ * Disconnects the identity source integration of a workspace. For CustomSSO, this operation clears the shared user pool and related SAML and SCIM resources. To disable only logon or synchronization, use the corresponding switch API operations.
926
+ *
927
+ * @remarks
928
+ * ## Features and prerequisites
929
+ * This operation completely disconnects the integration, rather than simply disabling logon. Disconnecting CustomSSO clears the AC users imported from this identity source, the remote shared user pool and related resources, and the logon publishing configurations and bindings. Therefore, both SAML and SCIM are affected. However, this operation does not delete the enterprise applications created by users on external platforms such as Azure. Before disconnecting, the system checks for references between users and teams. If references exist, the disconnection is rejected.
930
+ * After the request is accepted, the status returned is DISCONNECTING. You can query the status by calling GetIdentityProvider. The cleanup is complete only when the binding no longer exists (IdentityProviderNotFound). The binding should also no longer appear in the list. DISCONNECT_FAILED indicates that partial cleanup may have occurred, and the state cannot be restored to a completely unconfigured state. You can retry based on the returned status. If the binding does not exist in the first place, the API operation returns a placeholder result indicating no binding without creating new resources. An ongoing disconnection task may return the current binding. Do not use this API operation as a substitute for setting loginEnabled=false, syncEnabled=false, or deleting a single token.
931
+ * ## Requests and examples
932
+ * DELETE /workspaces/{workspaceId}/identity-providers/{identityProviderType}
933
+ * Calling conventions: Call the API operation in the region of the target workspace, using an AK/STS identity that has the corresponding workspace identity source resource permissions. The ws-example, URLs, certificates, and tokens in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log secrets. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
934
+ * ```text
935
+ * DELETE /workspaces/ws-example/identity-providers/CustomSSO
936
+ * ```
937
+ * ## Response examples
938
+ * ```json
939
+ * {
940
+ * "data": {
941
+ * "workspaceId": "ws-example",
942
+ * "identityProviderType": "CustomSSO",
943
+ * "status": "DISCONNECTING"
944
+ * }
945
+ * }
946
+ * ```
947
+ * ## Errors and handling
948
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. Synchronous calls to upstream services that fail may return 503 IdentityProviderProvisioningUnavailable. Keep the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
949
+ * 409 IdentityProvider.Disconnect.Conflict: Users of this identity source still belong to a team. Remove the references first. 409 IdentityProviderOperationConflict: The current status does not allow disconnection. 404 IdentityProviderNotFound: An external binding exists but the type does not match. Asynchronous failures may result in partial cleanup. You cannot claim completion based solely on the first response.
950
+ * ## Calling relationships and usage boundaries
951
+ * If you only need to disable a specific capability: To disable SAML logon, use UpdateIdentityProvider and set loginEnabled=false. To disable SCIM, use UpdateIdentityProviderSCIM and set syncEnabled=false. To revoke a single token, use DeleteIdentityProviderSCIMCredential. Call this API operation only when you need to completely disconnect the integration.
696
952
  *
697
953
  * @param request - DeleteIdentityProviderRequest
698
954
  * @returns DeleteIdentityProviderResponse
699
955
  */
700
956
  deleteIdentityProvider(workspaceId: string, identityProviderType: string, request: $_model.DeleteIdentityProviderRequest): Promise<$_model.DeleteIdentityProviderResponse>;
957
+ /**
958
+ * 删除 SCIM 凭据
959
+ *
960
+ * @remarks
961
+ * ## 功能与前提\n撤销指定凭据,credentialId 必填且非空,从凭据列表取得。要求共享池可用,但不要求 SAML 已配置或 SCIM 接收为 Enabled。删除后使用该 Token 的外部预配请求会失效;只影响选定凭据,不自动关闭接收、不自动关闭 AC syncEnabled,也不影响另一枚凭据或 SAML。\n即使删除最后一枚凭据,也不自动回写同步开关或重发新 Token;用户应按需要先停用外部预配或更换其使用的 Token。成功返回公共响应,无业务 data 内容;刷新列表确认。对未知或已删除 ID 的结果由上游决定,不承诺统一 404 或无条件幂等成功。\n\n## 请求与示例\nDELETE /workspaces/{workspaceId}/scim-provisioning/credentials/{credentialId}\n调用约定:按目标 Workspace 的地域调用,使用有相应 Workspace 身份源资源权限的 AK/STS 身份。下文示例中的 ws-example、URL、证书和 Token 均为占位值,需替换为真实值。请求体示例表示公开 API 的 body 参数内容,不是后端直连接口额外的 body 包装。返回示例只展示业务部分,外层还包括 requestId、success、code、message、httpStatusCode;排障请保留 requestId,不记录密钥。业务任务异步不意味着 HTTP 请求长连接等待完成。\n```text\nDELETE /workspaces/ws-example/scim-provisioning/credentials/credential-example\n```\n\n## 返回示例\n```json\n{\n "success": true,\n "httpStatusCode": 200\n}\n```\n\n## 错误与处理\n错误处理:400 InvalidParameter 表示参数或当前配置前提不满足;404 IdentityProviderNotFound 表示没有匹配类型的绑定。同步调用上游失败可能返回 503 IdentityProviderProvisioningUnavailable;保留请求 ID 排查,不把读取失败解释为未配置。实际鉴权和 Workspace 不存在错误沿用公共错误处理。\n400 InvalidParameter:credentialId 为空或共享池不可用。404 IdentityProviderNotFound 指绑定不存在,不代表所有未知凭据 ID 都返回该码。其他删除错误按上游结果处理,失败时刷新列表核对,不自动创建替代 Token。\n\n## 调用关系与使用边界\n使用 ListIdentityProviderSCIMCredentials 取得 credentialId 后删除指定凭据。若外部预配系统仍使用该 Token,后续预配可能鉴权失败,因此应先确认实际使用情况。删除后不会自动创建新凭据、关闭 AC 同步开关或关闭 SAML 登录。
962
+ *
963
+ * @param request - DeleteIdentityProviderSCIMCredentialRequest
964
+ * @param headers - map
965
+ * @param runtime - runtime options for this request RuntimeOptions
966
+ * @returns DeleteIdentityProviderSCIMCredentialResponse
967
+ */
968
+ deleteIdentityProviderSCIMCredentialWithOptions(workspaceId: string, credentialId: string, request: $_model.DeleteIdentityProviderSCIMCredentialRequest, headers: {
969
+ [key: string]: string;
970
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteIdentityProviderSCIMCredentialResponse>;
971
+ /**
972
+ * 删除 SCIM 凭据
973
+ *
974
+ * @remarks
975
+ * ## 功能与前提\n撤销指定凭据,credentialId 必填且非空,从凭据列表取得。要求共享池可用,但不要求 SAML 已配置或 SCIM 接收为 Enabled。删除后使用该 Token 的外部预配请求会失效;只影响选定凭据,不自动关闭接收、不自动关闭 AC syncEnabled,也不影响另一枚凭据或 SAML。\n即使删除最后一枚凭据,也不自动回写同步开关或重发新 Token;用户应按需要先停用外部预配或更换其使用的 Token。成功返回公共响应,无业务 data 内容;刷新列表确认。对未知或已删除 ID 的结果由上游决定,不承诺统一 404 或无条件幂等成功。\n\n## 请求与示例\nDELETE /workspaces/{workspaceId}/scim-provisioning/credentials/{credentialId}\n调用约定:按目标 Workspace 的地域调用,使用有相应 Workspace 身份源资源权限的 AK/STS 身份。下文示例中的 ws-example、URL、证书和 Token 均为占位值,需替换为真实值。请求体示例表示公开 API 的 body 参数内容,不是后端直连接口额外的 body 包装。返回示例只展示业务部分,外层还包括 requestId、success、code、message、httpStatusCode;排障请保留 requestId,不记录密钥。业务任务异步不意味着 HTTP 请求长连接等待完成。\n```text\nDELETE /workspaces/ws-example/scim-provisioning/credentials/credential-example\n```\n\n## 返回示例\n```json\n{\n "success": true,\n "httpStatusCode": 200\n}\n```\n\n## 错误与处理\n错误处理:400 InvalidParameter 表示参数或当前配置前提不满足;404 IdentityProviderNotFound 表示没有匹配类型的绑定。同步调用上游失败可能返回 503 IdentityProviderProvisioningUnavailable;保留请求 ID 排查,不把读取失败解释为未配置。实际鉴权和 Workspace 不存在错误沿用公共错误处理。\n400 InvalidParameter:credentialId 为空或共享池不可用。404 IdentityProviderNotFound 指绑定不存在,不代表所有未知凭据 ID 都返回该码。其他删除错误按上游结果处理,失败时刷新列表核对,不自动创建替代 Token。\n\n## 调用关系与使用边界\n使用 ListIdentityProviderSCIMCredentials 取得 credentialId 后删除指定凭据。若外部预配系统仍使用该 Token,后续预配可能鉴权失败,因此应先确认实际使用情况。删除后不会自动创建新凭据、关闭 AC 同步开关或关闭 SAML 登录。
976
+ *
977
+ * @param request - DeleteIdentityProviderSCIMCredentialRequest
978
+ * @returns DeleteIdentityProviderSCIMCredentialResponse
979
+ */
980
+ deleteIdentityProviderSCIMCredential(workspaceId: string, credentialId: string, request: $_model.DeleteIdentityProviderSCIMCredentialRequest): Promise<$_model.DeleteIdentityProviderSCIMCredentialResponse>;
701
981
  /**
702
982
  * Deletes an image cache.
703
983
  *
@@ -791,10 +1071,10 @@ export default class Client extends OpenApi {
791
1071
  */
792
1072
  deleteMemory(workspaceId: string, memoryStoreName: string, memoryId: string, request: $_model.DeleteMemoryRequest): Promise<$_model.DeleteMemoryResponse>;
793
1073
  /**
794
- * Asynchronously deletes a MemoryStore and all its long-term memory.
1074
+ * Asynchronously deletes a MemoryStore and all long-term memory within it.
795
1075
  *
796
1076
  * @remarks
797
- * Asynchronously deletes a MemoryStore and all its long-term memory.
1077
+ * Asynchronously deletes a MemoryStore and all long-term memory within it.
798
1078
  *
799
1079
  * @param request - DeleteMemoryStoreRequest
800
1080
  * @param headers - map
@@ -805,10 +1085,10 @@ export default class Client extends OpenApi {
805
1085
  [key: string]: string;
806
1086
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteMemoryStoreResponse>;
807
1087
  /**
808
- * Asynchronously deletes a MemoryStore and all its long-term memory.
1088
+ * Asynchronously deletes a MemoryStore and all long-term memory within it.
809
1089
  *
810
1090
  * @remarks
811
- * Asynchronously deletes a MemoryStore and all its long-term memory.
1091
+ * Asynchronously deletes a MemoryStore and all long-term memory within it.
812
1092
  *
813
1093
  * @param request - DeleteMemoryStoreRequest
814
1094
  * @returns DeleteMemoryStoreResponse
@@ -1088,6 +1368,82 @@ export default class Client extends OpenApi {
1088
1368
  * @returns ForcePublishSkillVersionResponse
1089
1369
  */
1090
1370
  forcePublishSkillVersion(workspaceId: string, skillName: string, skillVersion: string, request: $_model.ForcePublishSkillVersionRequest): Promise<$_model.ForcePublishSkillVersionResponse>;
1371
+ /**
1372
+ * Retrieves the download URL for the saved code package of an agent.
1373
+ *
1374
+ * @remarks
1375
+ * Generates a time-limited, read-only download URL for the code package referenced by the currently saved agent configuration. This applies to code packages uploaded locally or imported from Object Storage Service (OSS). The operation uses workspaceId and agentId for locating and does not accept arbitrary bucket, object key, or historical version parameters. The current configuration must reference an available, fixed code package, and does not require waiting for a running instance to be ready. An error is returned if the code package does not exist, has changed, or is unreadable. The link is valid for up to 10 minutes and does not exceed the underlying credential expiration time. Call the operation again after it expires. The resourceVersionId indicates the saved configuration version corresponding to this download. The sample download link is redacted. Use the downloadUrl in the response.
1376
+ *
1377
+ * @param request - GetAgentCodePackageDownloadUrlRequest
1378
+ * @param headers - map
1379
+ * @param runtime - runtime options for this request RuntimeOptions
1380
+ * @returns GetAgentCodePackageDownloadUrlResponse
1381
+ */
1382
+ getAgentCodePackageDownloadUrlWithOptions(workspaceId: string, agentId: string, request: $_model.GetAgentCodePackageDownloadUrlRequest, headers: {
1383
+ [key: string]: string;
1384
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentCodePackageDownloadUrlResponse>;
1385
+ /**
1386
+ * Retrieves the download URL for the saved code package of an agent.
1387
+ *
1388
+ * @remarks
1389
+ * Generates a time-limited, read-only download URL for the code package referenced by the currently saved agent configuration. This applies to code packages uploaded locally or imported from Object Storage Service (OSS). The operation uses workspaceId and agentId for locating and does not accept arbitrary bucket, object key, or historical version parameters. The current configuration must reference an available, fixed code package, and does not require waiting for a running instance to be ready. An error is returned if the code package does not exist, has changed, or is unreadable. The link is valid for up to 10 minutes and does not exceed the underlying credential expiration time. Call the operation again after it expires. The resourceVersionId indicates the saved configuration version corresponding to this download. The sample download link is redacted. Use the downloadUrl in the response.
1390
+ *
1391
+ * @param request - GetAgentCodePackageDownloadUrlRequest
1392
+ * @returns GetAgentCodePackageDownloadUrlResponse
1393
+ */
1394
+ getAgentCodePackageDownloadUrl(workspaceId: string, agentId: string, request: $_model.GetAgentCodePackageDownloadUrlRequest): Promise<$_model.GetAgentCodePackageDownloadUrlResponse>;
1395
+ /**
1396
+ * Retrieves the OSS RAM authorization URL for the agent code package.
1397
+ *
1398
+ * @remarks
1399
+ * Generates a RAM authorization URL for the resource role of the current workspace for a specified source bucket. The client cannot specify or override the role. After you open the authorizeUrl and confirm the authorization, call VerifyAgentCodePackageOssRamAuthorization to check the policy binding, and call ValidateAgentCodePackageFromOss to check specific objects.
1400
+ * This authorization reuses the OSSObjectRestoreCustom template, which includes permissions to read, write, and delete objects, and is not a read-only authorization. Retrieving the URL itself does not complete the authorization, transfer the code package, or modify the default OSS binding of the workspace. Existing authorizations for the same role and bucket can be reused. The example URL is provided to demonstrate the format. Use the actual authorization URL returned by the API operation.
1401
+ *
1402
+ * @param request - GetAgentCodePackageOssRamAuthorizeUrlRequest
1403
+ * @param headers - map
1404
+ * @param runtime - runtime options for this request RuntimeOptions
1405
+ * @returns GetAgentCodePackageOssRamAuthorizeUrlResponse
1406
+ */
1407
+ getAgentCodePackageOssRamAuthorizeUrlWithOptions(workspaceId: string, request: $_model.GetAgentCodePackageOssRamAuthorizeUrlRequest, headers: {
1408
+ [key: string]: string;
1409
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentCodePackageOssRamAuthorizeUrlResponse>;
1410
+ /**
1411
+ * Retrieves the OSS RAM authorization URL for the agent code package.
1412
+ *
1413
+ * @remarks
1414
+ * Generates a RAM authorization URL for the resource role of the current workspace for a specified source bucket. The client cannot specify or override the role. After you open the authorizeUrl and confirm the authorization, call VerifyAgentCodePackageOssRamAuthorization to check the policy binding, and call ValidateAgentCodePackageFromOss to check specific objects.
1415
+ * This authorization reuses the OSSObjectRestoreCustom template, which includes permissions to read, write, and delete objects, and is not a read-only authorization. Retrieving the URL itself does not complete the authorization, transfer the code package, or modify the default OSS binding of the workspace. Existing authorizations for the same role and bucket can be reused. The example URL is provided to demonstrate the format. Use the actual authorization URL returned by the API operation.
1416
+ *
1417
+ * @param request - GetAgentCodePackageOssRamAuthorizeUrlRequest
1418
+ * @returns GetAgentCodePackageOssRamAuthorizeUrlResponse
1419
+ */
1420
+ getAgentCodePackageOssRamAuthorizeUrl(workspaceId: string, request: $_model.GetAgentCodePackageOssRamAuthorizeUrlRequest): Promise<$_model.GetAgentCodePackageOssRamAuthorizeUrlResponse>;
1421
+ /**
1422
+ * Retrieves the upload URL for an agent code package.
1423
+ *
1424
+ * @remarks
1425
+ * Retrieves a time-limited upload URL for a code package without uploading the file content. The fileName must be a ZIP or TAR.GZ filename without directories. The format must match the file extension. The fileSize is in bytes, with valid values ranging from 1 to 500,000,000.
1426
+ * Use the uploadMethod, uploadUrl, and headers from the response to upload the file directly. After the upload is complete, pass the sourceUri to the artifact.code.sourceUri parameter of CreateCustomAgent or UpdateCustomAgent. The actual object and size are verified and a fixed copy is saved during creation or update. The upload URL is valid for up to 10 minutes and does not exceed the expiration time of the underlying temporary credentials. Retrieve a new URL after it expires. The example URL is desensitized and cannot be used for actual uploads. Use the original URL and request headers from this response.
1427
+ *
1428
+ * @param tmpReq - GetAgentCodePackageUploadUrlRequest
1429
+ * @param headers - map
1430
+ * @param runtime - runtime options for this request RuntimeOptions
1431
+ * @returns GetAgentCodePackageUploadUrlResponse
1432
+ */
1433
+ getAgentCodePackageUploadUrlWithOptions(workspaceId: string, tmpReq: $_model.GetAgentCodePackageUploadUrlRequest, headers: {
1434
+ [key: string]: string;
1435
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentCodePackageUploadUrlResponse>;
1436
+ /**
1437
+ * Retrieves the upload URL for an agent code package.
1438
+ *
1439
+ * @remarks
1440
+ * Retrieves a time-limited upload URL for a code package without uploading the file content. The fileName must be a ZIP or TAR.GZ filename without directories. The format must match the file extension. The fileSize is in bytes, with valid values ranging from 1 to 500,000,000.
1441
+ * Use the uploadMethod, uploadUrl, and headers from the response to upload the file directly. After the upload is complete, pass the sourceUri to the artifact.code.sourceUri parameter of CreateCustomAgent or UpdateCustomAgent. The actual object and size are verified and a fixed copy is saved during creation or update. The upload URL is valid for up to 10 minutes and does not exceed the expiration time of the underlying temporary credentials. Retrieve a new URL after it expires. The example URL is desensitized and cannot be used for actual uploads. Use the original URL and request headers from this response.
1442
+ *
1443
+ * @param request - GetAgentCodePackageUploadUrlRequest
1444
+ * @returns GetAgentCodePackageUploadUrlResponse
1445
+ */
1446
+ getAgentCodePackageUploadUrl(workspaceId: string, request: $_model.GetAgentCodePackageUploadUrlRequest): Promise<$_model.GetAgentCodePackageUploadUrlResponse>;
1091
1447
  /**
1092
1448
  * Queries the details of a specified agent IM channel.
1093
1449
  *
@@ -1244,8 +1600,8 @@ export default class Client extends OpenApi {
1244
1600
  * Queries the details of a custom agent in a specified workspace, including deployment configurations, the execute status of the latest configuration version, and the running instance status statistics.
1245
1601
  *
1246
1602
  * @remarks
1247
- * After you create or update a custom agent, you can poll this operation to query the execution result of the latest configuration version. `latestVersionStatus` corresponds to `latestSpecVersion`. `latestExecutionError` indicates the cause of the pending or failed status for this version. If `retryable` is true, you can query again later.
1248
- * The returned configuration is the most recently submitted configuration and may not have taken effect. Verify the deployment and running status by checking `latestVersionStatus`, the overall agent status `status`, and the running instance statistics `sandboxPhaseCounts`.
1603
+ * After creating or updating a custom agent, you can poll this operation to query the execution result of the latest configuration version. latestVersionStatus corresponds to latestSpecVersion. latestExecutionError indicates the cause of the pending or failed status for this version. If retryable is true, you can query again later.
1604
+ * The returned configuration is the latest submitted configuration and may not have taken effect. Verify the deployment and running status by checking latestVersionStatus, the overall agent status, and the running instance statistics sandboxPhaseCounts.
1249
1605
  * If the queried custom agent does not exist, has been deleted, or does not belong to the specified workspace, a resource not found error is returned.
1250
1606
  *
1251
1607
  * @param request - GetCustomAgentRequest
@@ -1260,8 +1616,8 @@ export default class Client extends OpenApi {
1260
1616
  * Queries the details of a custom agent in a specified workspace, including deployment configurations, the execute status of the latest configuration version, and the running instance status statistics.
1261
1617
  *
1262
1618
  * @remarks
1263
- * After you create or update a custom agent, you can poll this operation to query the execution result of the latest configuration version. `latestVersionStatus` corresponds to `latestSpecVersion`. `latestExecutionError` indicates the cause of the pending or failed status for this version. If `retryable` is true, you can query again later.
1264
- * The returned configuration is the most recently submitted configuration and may not have taken effect. Verify the deployment and running status by checking `latestVersionStatus`, the overall agent status `status`, and the running instance statistics `sandboxPhaseCounts`.
1619
+ * After creating or updating a custom agent, you can poll this operation to query the execution result of the latest configuration version. latestVersionStatus corresponds to latestSpecVersion. latestExecutionError indicates the cause of the pending or failed status for this version. If retryable is true, you can query again later.
1620
+ * The returned configuration is the latest submitted configuration and may not have taken effect. Verify the deployment and running status by checking latestVersionStatus, the overall agent status, and the running instance statistics sandboxPhaseCounts.
1265
1621
  * If the queried custom agent does not exist, has been deleted, or does not belong to the specified workspace, a resource not found error is returned.
1266
1622
  *
1267
1623
  * @param request - GetCustomAgentRequest
@@ -1317,7 +1673,35 @@ export default class Client extends OpenApi {
1317
1673
  */
1318
1674
  getExternalAgentBootstrapOptions(workspaceId: string, agentId: string, request: $_model.GetExternalAgentBootstrapOptionsRequest): Promise<$_model.GetExternalAgentBootstrapOptionsResponse>;
1319
1675
  /**
1320
- * Queries the binding details of the external identity provider for a specified workspace, including the binding status, application configurations, and callback URLs to be configured on the identity provider side. Application secret configurations are not returned.
1676
+ * Queries the binding and expected configuration of a specified identity provider. When CustomSSO is configured with SAML, this operation reads back the actual upstream SSO configuration. The SCIM status is queried through a separate API operation.
1677
+ *
1678
+ * @remarks
1679
+ * ## Features and prerequisites
1680
+ * Reads existing bindings by type. CustomSSO returns the saved protocol, standardized saml, expected loginEnabled, syncEnabled, and shared binding status. If SAML is not configured, the saml and configuration fields may not be returned. When saml is configured, the system additionally queries AgentIdentity, and configuration represents the actual SSO configuration. The saml field is the data source for the edit form. The status switch for configuration can be Enabled or Disabled. If the upstream query fails, an error is reported. Do not treat this as an unconfigured state.
1681
+ * Only this operation reads back the actual SAML configuration. List and write operations do not guarantee that configuration is returned. A user pool in the READY state does not indicate that SAML is configured. UPDATING and UPDATE_FAILED describe logon configuration tasks, not SCIM tasks. The vendor callback URL for CustomSSO is empty. Use GetIdentityProviderSCIM.operationStatus to query SCIM operation results.
1682
+ * ## Request and examples
1683
+ * GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}
1684
+ * Calling conventions: Call the API operation in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example shows the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business data. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log keys. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
1685
+ * ```text
1686
+ * GET /workspaces/ws-example/identity-providers/CustomSSO
1687
+ * ```
1688
+ * ## Response examples
1689
+ * ```json
1690
+ * {
1691
+ * "data": {
1692
+ * "workspaceId": "ws-example",
1693
+ * "identityProviderType": "CustomSSO",
1694
+ * "status": "READY",
1695
+ * "loginEnabled": false,
1696
+ * "syncEnabled": false
1697
+ * }
1698
+ * }
1699
+ * ```
1700
+ * ## Errors and handling
1701
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. A synchronous call to the upstream service may fail and return 503 IdentityProviderProvisioningUnavailable. Keep the request ID for troubleshooting and do not interpret a read failure as an unconfigured state. Actual authentication and workspace not found errors follow common error handling.
1702
+ * 404 IdentityProviderNotFound: No binding exists, or the input type is inconsistent with the current binding. If SAML is already configured, an upstream readback failure does not degrade to a successful empty configuration.
1703
+ * ## Call relationships and usage boundaries
1704
+ * SAML configuration completion and logon enabling are independent operations. protocol=SAML and the presence of saml indicate that the logon configuration has been submitted, and loginEnabled indicates the expected logon switch. Check the effective status based on the actual SSO status in configuration. SCIM uses an independent query API operation. Do not use status=READY of this API operation as the basis for successful SCIM synchronization. Currently, OIDC, JIT configuration, or JIT status fields are not provided.
1321
1705
  *
1322
1706
  * @param request - GetIdentityProviderRequest
1323
1707
  * @param headers - map
@@ -1328,12 +1712,290 @@ export default class Client extends OpenApi {
1328
1712
  [key: string]: string;
1329
1713
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetIdentityProviderResponse>;
1330
1714
  /**
1331
- * Queries the binding details of the external identity provider for a specified workspace, including the binding status, application configurations, and callback URLs to be configured on the identity provider side. Application secret configurations are not returned.
1715
+ * Queries the binding and expected configuration of a specified identity provider. When CustomSSO is configured with SAML, this operation reads back the actual upstream SSO configuration. The SCIM status is queried through a separate API operation.
1716
+ *
1717
+ * @remarks
1718
+ * ## Features and prerequisites
1719
+ * Reads existing bindings by type. CustomSSO returns the saved protocol, standardized saml, expected loginEnabled, syncEnabled, and shared binding status. If SAML is not configured, the saml and configuration fields may not be returned. When saml is configured, the system additionally queries AgentIdentity, and configuration represents the actual SSO configuration. The saml field is the data source for the edit form. The status switch for configuration can be Enabled or Disabled. If the upstream query fails, an error is reported. Do not treat this as an unconfigured state.
1720
+ * Only this operation reads back the actual SAML configuration. List and write operations do not guarantee that configuration is returned. A user pool in the READY state does not indicate that SAML is configured. UPDATING and UPDATE_FAILED describe logon configuration tasks, not SCIM tasks. The vendor callback URL for CustomSSO is empty. Use GetIdentityProviderSCIM.operationStatus to query SCIM operation results.
1721
+ * ## Request and examples
1722
+ * GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}
1723
+ * Calling conventions: Call the API operation in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example shows the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business data. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log keys. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
1724
+ * ```text
1725
+ * GET /workspaces/ws-example/identity-providers/CustomSSO
1726
+ * ```
1727
+ * ## Response examples
1728
+ * ```json
1729
+ * {
1730
+ * "data": {
1731
+ * "workspaceId": "ws-example",
1732
+ * "identityProviderType": "CustomSSO",
1733
+ * "status": "READY",
1734
+ * "loginEnabled": false,
1735
+ * "syncEnabled": false
1736
+ * }
1737
+ * }
1738
+ * ```
1739
+ * ## Errors and handling
1740
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. A synchronous call to the upstream service may fail and return 503 IdentityProviderProvisioningUnavailable. Keep the request ID for troubleshooting and do not interpret a read failure as an unconfigured state. Actual authentication and workspace not found errors follow common error handling.
1741
+ * 404 IdentityProviderNotFound: No binding exists, or the input type is inconsistent with the current binding. If SAML is already configured, an upstream readback failure does not degrade to a successful empty configuration.
1742
+ * ## Call relationships and usage boundaries
1743
+ * SAML configuration completion and logon enabling are independent operations. protocol=SAML and the presence of saml indicate that the logon configuration has been submitted, and loginEnabled indicates the expected logon switch. Check the effective status based on the actual SSO status in configuration. SCIM uses an independent query API operation. Do not use status=READY of this API operation as the basis for successful SCIM synchronization. Currently, OIDC, JIT configuration, or JIT status fields are not provided.
1332
1744
  *
1333
1745
  * @param request - GetIdentityProviderRequest
1334
1746
  * @returns GetIdentityProviderResponse
1335
1747
  */
1336
1748
  getIdentityProvider(workspaceId: string, identityProviderType: string, request: $_model.GetIdentityProviderRequest): Promise<$_model.GetIdentityProviderResponse>;
1749
+ /**
1750
+ * Queries the actual SCIM receiving configuration, the expected AC synchronization switch, and the status of the most recent independent SCIM task. Prior SAML configuration is not required.
1751
+ *
1752
+ * @remarks
1753
+ * ## Features and prerequisites
1754
+ * The shared CustomSSO user pool must be created and must not be in the overall dissociation process or have failed to be dissociated. Prior SAML configuration is not required. SAML updates in progress or failed SAML updates do not block the query. The configuration.status and baseUrl parameters are obtained from AgentIdentity. The syncEnabled parameter is the expected AC synchronization switch. The operationStatus parameter indicates the most recent independent SCIM switch and the first full import task when the switch is enabled. The presence of a URL does not mean that external provisioning is complete, nor does it mean that AC synchronization is enabled.
1755
+ * operationStatus: PENDING (waiting), RUNNING (in progress), PAUSED (paused), SUCCESS (succeeded), FAILED (failed), CANCELED (canceled). If there are no historical tasks, it returns null or is not returned. You can poll when the status is PENDING or RUNNING. Stop polling when a terminal state is reached. You can manually refresh when the status is PAUSED. This operation does not provide taskId or failure details, and does not indicate credential issuance, external provisioning connection tests, or the health of continuous incremental synchronization. After it is disabled, the URL, credentials, and historical task records may still be retained.
1756
+ * ## Requests and examples
1757
+ * GET /workspaces/{workspaceId}/scim-provisioning
1758
+ * Calling conventions: Call this operation in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
1759
+ * ```text
1760
+ * GET /workspaces/ws-example/scim-provisioning
1761
+ * ```
1762
+ * ## Response example
1763
+ * ```json
1764
+ * {
1765
+ * "data": {
1766
+ * "configuration": {
1767
+ * "status": "Enabled",
1768
+ * "baseUrl": "https://example.com/scim/v2"
1769
+ * },
1770
+ * "syncEnabled": true,
1771
+ * "operationStatus": "SUCCESS"
1772
+ * }
1773
+ * }
1774
+ * ```
1775
+ * ## Errors and handling
1776
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that there is no binding of the matching type. Synchronous calls to upstream services that fail may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow common error handling.
1777
+ * 400 InvalidParameter: The shared user pool is unavailable, being dissociated, or failed to be dissociated. If there is no binding, 404 IdentityProviderNotFound is returned. Upstream read failures must retain the error and cannot be mapped to Disabled, unconfigured, or synchronization success.
1778
+ * ## Call relationships and usage boundaries
1779
+ * SCIM configuration sequence: After preparing the shared pool, call PrepareIdentityProviderSCIM and configure the returned baseUrl and newly issued token to the provisioning system of the external IdP. After completing the external connection test, call UpdateIdentityProviderSCIM to enable synchronization, and then call this operation to query operationStatus. SUCCESS only indicates that the most recent SCIM task is completed, and does not represent the health of continuous incremental synchronization or the success of the external provisioning connection test.
1780
+ *
1781
+ * @param request - GetIdentityProviderSCIMRequest
1782
+ * @param headers - map
1783
+ * @param runtime - runtime options for this request RuntimeOptions
1784
+ * @returns GetIdentityProviderSCIMResponse
1785
+ */
1786
+ getIdentityProviderSCIMWithOptions(workspaceId: string, request: $_model.GetIdentityProviderSCIMRequest, headers: {
1787
+ [key: string]: string;
1788
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.GetIdentityProviderSCIMResponse>;
1789
+ /**
1790
+ * Queries the actual SCIM receiving configuration, the expected AC synchronization switch, and the status of the most recent independent SCIM task. Prior SAML configuration is not required.
1791
+ *
1792
+ * @remarks
1793
+ * ## Features and prerequisites
1794
+ * The shared CustomSSO user pool must be created and must not be in the overall dissociation process or have failed to be dissociated. Prior SAML configuration is not required. SAML updates in progress or failed SAML updates do not block the query. The configuration.status and baseUrl parameters are obtained from AgentIdentity. The syncEnabled parameter is the expected AC synchronization switch. The operationStatus parameter indicates the most recent independent SCIM switch and the first full import task when the switch is enabled. The presence of a URL does not mean that external provisioning is complete, nor does it mean that AC synchronization is enabled.
1795
+ * operationStatus: PENDING (waiting), RUNNING (in progress), PAUSED (paused), SUCCESS (succeeded), FAILED (failed), CANCELED (canceled). If there are no historical tasks, it returns null or is not returned. You can poll when the status is PENDING or RUNNING. Stop polling when a terminal state is reached. You can manually refresh when the status is PAUSED. This operation does not provide taskId or failure details, and does not indicate credential issuance, external provisioning connection tests, or the health of continuous incremental synchronization. After it is disabled, the URL, credentials, and historical task records may still be retained.
1796
+ * ## Requests and examples
1797
+ * GET /workspaces/{workspaceId}/scim-provisioning
1798
+ * Calling conventions: Call this operation in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
1799
+ * ```text
1800
+ * GET /workspaces/ws-example/scim-provisioning
1801
+ * ```
1802
+ * ## Response example
1803
+ * ```json
1804
+ * {
1805
+ * "data": {
1806
+ * "configuration": {
1807
+ * "status": "Enabled",
1808
+ * "baseUrl": "https://example.com/scim/v2"
1809
+ * },
1810
+ * "syncEnabled": true,
1811
+ * "operationStatus": "SUCCESS"
1812
+ * }
1813
+ * }
1814
+ * ```
1815
+ * ## Errors and handling
1816
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that there is no binding of the matching type. Synchronous calls to upstream services that fail may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow common error handling.
1817
+ * 400 InvalidParameter: The shared user pool is unavailable, being dissociated, or failed to be dissociated. If there is no binding, 404 IdentityProviderNotFound is returned. Upstream read failures must retain the error and cannot be mapped to Disabled, unconfigured, or synchronization success.
1818
+ * ## Call relationships and usage boundaries
1819
+ * SCIM configuration sequence: After preparing the shared pool, call PrepareIdentityProviderSCIM and configure the returned baseUrl and newly issued token to the provisioning system of the external IdP. After completing the external connection test, call UpdateIdentityProviderSCIM to enable synchronization, and then call this operation to query operationStatus. SUCCESS only indicates that the most recent SCIM task is completed, and does not represent the health of continuous incremental synchronization or the success of the external provisioning connection test.
1820
+ *
1821
+ * @param request - GetIdentityProviderSCIMRequest
1822
+ * @returns GetIdentityProviderSCIMResponse
1823
+ */
1824
+ getIdentityProviderSCIM(workspaceId: string, request: $_model.GetIdentityProviderSCIMRequest): Promise<$_model.GetIdentityProviderSCIMResponse>;
1825
+ /**
1826
+ * 查询 SAML 服务提供商信息
1827
+ *
1828
+ * @remarks
1829
+ * ## 功能与前提\n要求已有可用 CustomSSO 共享用户池,identityProviderType=CustomSSO,protocol 必填且仅支持精确值 SAML;不要求先上传 IdP Metadata。返回我方 SP 的 entityId、acsUrl、metadataXml,供用户配置外部 IdP。它们不是外部 IdP 的登录 URL 或 IdP Entity ID,不能将 SP XML 作为 IdP XML 提交 UpdateIdentityProvider。\n本接口只读取,不启用登录、不开启 SCIM、不创建凭据、不执行登录连接测试。共享池初始化中、解绑中或解绑失败时不可读取。\n\n## 请求与示例\nGET /workspaces/{workspaceId}/identity-providers/{identityProviderType}/service-provider\n调用约定:按目标 Workspace 的地域调用,使用有相应 Workspace 身份源资源权限的 AK/STS 身份。下文示例中的 ws-example、URL、证书和 Token 均为占位值,需替换为真实值。请求体示例表示公开 API 的 body 参数内容,不是后端直连接口额外的 body 包装。返回示例只展示业务部分,外层还包括 requestId、success、code、message、httpStatusCode;排障请保留 requestId,不记录密钥。业务任务异步不意味着 HTTP 请求长连接等待完成。\n```text\nGET /workspaces/ws-example/identity-providers/CustomSSO/service-provider?protocol=SAML\n```\n\n## 返回示例\n```json\n{\n "data": {\n "protocol": "SAML",\n "entityId": "<我方 SP Entity ID>",\n "acsUrl": "https://example.com/saml/acs",\n "metadataXml": "<我方 SP Metadata XML>"\n }\n}\n```\n\n## 错误与处理\n错误处理:400 InvalidParameter 表示参数或当前配置前提不满足;404 IdentityProviderNotFound 表示没有匹配类型的绑定。同步调用上游失败可能返回 503 IdentityProviderProvisioningUnavailable;保留请求 ID 排查,不把读取失败解释为未配置。实际鉴权和 Workspace 不存在错误沿用公共错误处理。\n400 InvalidParameter:identityProviderType 或 protocol 不支持。404 IdentityProviderNotFound:尚无 CustomSSO 绑定。409 IdentityProviderOperationConflict:用户池未准备好、解绑中或解绑失败。\n\n## 调用关系与使用边界\nSAML 配置顺序:CreateIdentityProvider 初始化 CustomSSO 共享池,等待 GetIdentityProvider 返回 READY;调用本接口取得 SP 信息并配置到外部 IdP;再将外部 IdP Metadata XML 或完整手填配置提交 UpdateIdentityProvider。保存后按需单独启用 loginEnabled。SP 信息查询不会完成外部 IdP 配置或验证登录。
1830
+ *
1831
+ * @param request - GetIdentityProviderServiceProviderRequest
1832
+ * @param headers - map
1833
+ * @param runtime - runtime options for this request RuntimeOptions
1834
+ * @returns GetIdentityProviderServiceProviderResponse
1835
+ */
1836
+ getIdentityProviderServiceProviderWithOptions(workspaceId: string, identityProviderType: string, request: $_model.GetIdentityProviderServiceProviderRequest, headers: {
1837
+ [key: string]: string;
1838
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.GetIdentityProviderServiceProviderResponse>;
1839
+ /**
1840
+ * 查询 SAML 服务提供商信息
1841
+ *
1842
+ * @remarks
1843
+ * ## 功能与前提\n要求已有可用 CustomSSO 共享用户池,identityProviderType=CustomSSO,protocol 必填且仅支持精确值 SAML;不要求先上传 IdP Metadata。返回我方 SP 的 entityId、acsUrl、metadataXml,供用户配置外部 IdP。它们不是外部 IdP 的登录 URL 或 IdP Entity ID,不能将 SP XML 作为 IdP XML 提交 UpdateIdentityProvider。\n本接口只读取,不启用登录、不开启 SCIM、不创建凭据、不执行登录连接测试。共享池初始化中、解绑中或解绑失败时不可读取。\n\n## 请求与示例\nGET /workspaces/{workspaceId}/identity-providers/{identityProviderType}/service-provider\n调用约定:按目标 Workspace 的地域调用,使用有相应 Workspace 身份源资源权限的 AK/STS 身份。下文示例中的 ws-example、URL、证书和 Token 均为占位值,需替换为真实值。请求体示例表示公开 API 的 body 参数内容,不是后端直连接口额外的 body 包装。返回示例只展示业务部分,外层还包括 requestId、success、code、message、httpStatusCode;排障请保留 requestId,不记录密钥。业务任务异步不意味着 HTTP 请求长连接等待完成。\n```text\nGET /workspaces/ws-example/identity-providers/CustomSSO/service-provider?protocol=SAML\n```\n\n## 返回示例\n```json\n{\n "data": {\n "protocol": "SAML",\n "entityId": "<我方 SP Entity ID>",\n "acsUrl": "https://example.com/saml/acs",\n "metadataXml": "<我方 SP Metadata XML>"\n }\n}\n```\n\n## 错误与处理\n错误处理:400 InvalidParameter 表示参数或当前配置前提不满足;404 IdentityProviderNotFound 表示没有匹配类型的绑定。同步调用上游失败可能返回 503 IdentityProviderProvisioningUnavailable;保留请求 ID 排查,不把读取失败解释为未配置。实际鉴权和 Workspace 不存在错误沿用公共错误处理。\n400 InvalidParameter:identityProviderType 或 protocol 不支持。404 IdentityProviderNotFound:尚无 CustomSSO 绑定。409 IdentityProviderOperationConflict:用户池未准备好、解绑中或解绑失败。\n\n## 调用关系与使用边界\nSAML 配置顺序:CreateIdentityProvider 初始化 CustomSSO 共享池,等待 GetIdentityProvider 返回 READY;调用本接口取得 SP 信息并配置到外部 IdP;再将外部 IdP Metadata XML 或完整手填配置提交 UpdateIdentityProvider。保存后按需单独启用 loginEnabled。SP 信息查询不会完成外部 IdP 配置或验证登录。
1844
+ *
1845
+ * @param request - GetIdentityProviderServiceProviderRequest
1846
+ * @returns GetIdentityProviderServiceProviderResponse
1847
+ */
1848
+ getIdentityProviderServiceProvider(workspaceId: string, identityProviderType: string, request: $_model.GetIdentityProviderServiceProviderRequest): Promise<$_model.GetIdentityProviderServiceProviderResponse>;
1849
+ /**
1850
+ * Queries an identity provider synchronization task.
1851
+ *
1852
+ * @remarks
1853
+ * Queries the status, current step, number of processed users, and failure cause of a manual synchronization task by using the local taskId of AgentCore. The taskId must be obtained from CreateIdentityProviderSyncJob in the same workspace and identity provider. It is not the synchronizationJobId of AgentIdentity. Poll the task until the status is SUCCESS, FAILED, or CANCELED. The PENDING, RUNNING, and PAUSED statuses do not indicate completion. The syncedUserCount includes updated existing users and does not equal the number of newly added users or the progress percentage.
1854
+ * Authorization information: The RAM operation is agentcore:GetIdentityProviderSyncJob, the access level is Read, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is a required authorization resource.
1855
+ * Idempotence and retry: This operation is read-only and can be repeatedly queried.
1856
+ * Calling this API operation is free of charge, and operation records support ActionTrail auditing.
1857
+ * Response example:
1858
+ * ```json
1859
+ * {
1860
+ * "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
1861
+ * "message": "success",
1862
+ * "httpStatusCode": 200,
1863
+ * "code": "SUCCESS",
1864
+ * "success": true,
1865
+ * "data": {
1866
+ * "taskId": "12345678-1234-4234-8234-123456789abc",
1867
+ * "status": "SUCCESS",
1868
+ * "currentStep": "SYNC",
1869
+ * "synchronizationJobId": "syncjob_0123456789abcdef0123456789abcdef",
1870
+ * "syncedUserCount": 12
1871
+ * }
1872
+ * }
1873
+ * ```
1874
+ *
1875
+ * @param request - GetIdentityProviderSyncJobRequest
1876
+ * @param headers - map
1877
+ * @param runtime - runtime options for this request RuntimeOptions
1878
+ * @returns GetIdentityProviderSyncJobResponse
1879
+ */
1880
+ getIdentityProviderSyncJobWithOptions(workspaceId: string, identityProviderType: string, taskId: string, request: $_model.GetIdentityProviderSyncJobRequest, headers: {
1881
+ [key: string]: string;
1882
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.GetIdentityProviderSyncJobResponse>;
1883
+ /**
1884
+ * Queries an identity provider synchronization task.
1885
+ *
1886
+ * @remarks
1887
+ * Queries the status, current step, number of processed users, and failure cause of a manual synchronization task by using the local taskId of AgentCore. The taskId must be obtained from CreateIdentityProviderSyncJob in the same workspace and identity provider. It is not the synchronizationJobId of AgentIdentity. Poll the task until the status is SUCCESS, FAILED, or CANCELED. The PENDING, RUNNING, and PAUSED statuses do not indicate completion. The syncedUserCount includes updated existing users and does not equal the number of newly added users or the progress percentage.
1888
+ * Authorization information: The RAM operation is agentcore:GetIdentityProviderSyncJob, the access level is Read, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is a required authorization resource.
1889
+ * Idempotence and retry: This operation is read-only and can be repeatedly queried.
1890
+ * Calling this API operation is free of charge, and operation records support ActionTrail auditing.
1891
+ * Response example:
1892
+ * ```json
1893
+ * {
1894
+ * "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
1895
+ * "message": "success",
1896
+ * "httpStatusCode": 200,
1897
+ * "code": "SUCCESS",
1898
+ * "success": true,
1899
+ * "data": {
1900
+ * "taskId": "12345678-1234-4234-8234-123456789abc",
1901
+ * "status": "SUCCESS",
1902
+ * "currentStep": "SYNC",
1903
+ * "synchronizationJobId": "syncjob_0123456789abcdef0123456789abcdef",
1904
+ * "syncedUserCount": 12
1905
+ * }
1906
+ * }
1907
+ * ```
1908
+ *
1909
+ * @param request - GetIdentityProviderSyncJobRequest
1910
+ * @returns GetIdentityProviderSyncJobResponse
1911
+ */
1912
+ getIdentityProviderSyncJob(workspaceId: string, identityProviderType: string, taskId: string, request: $_model.GetIdentityProviderSyncJobRequest): Promise<$_model.GetIdentityProviderSyncJobResponse>;
1913
+ /**
1914
+ * Queries the synchronization scope of an identity provider.
1915
+ *
1916
+ * @remarks
1917
+ * Queries the saved synchronization scope, the validity of selected departments, and the estimated user count downstream of the identity provider. This operation is not used for real-time estimation of unsaved selections. AllAuthorized indicates the address book scope authorized for the application, which is not equivalent to the entire enterprise organization. An empty selectedDepartments array does not prove that the organization has no sub-departments. The estimation can be used only when estimateStatus is Ready and a count is returned. A missing count does not indicate 0.
1918
+ * Authorization information: RAM operation agentcore:GetIdentityProviderSyncScope, access level Read, resource ARN: acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is a required authorization resource.
1919
+ * Idempotence and retry: This operation is read-only and can be queried repeatedly.
1920
+ * Calling this API operation is free of charge. Operation records support ActionTrail auditing.
1921
+ * Sample response:
1922
+ * ```json
1923
+ * {
1924
+ * "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
1925
+ * "message": "success",
1926
+ * "httpStatusCode": 200,
1927
+ * "code": "SUCCESS",
1928
+ * "success": true,
1929
+ * "data": {
1930
+ * "syncScope": {
1931
+ * "mode": "SelectedDepartments",
1932
+ * "departmentIds": [
1933
+ * "10001"
1934
+ * ]
1935
+ * },
1936
+ * "selectedDepartments": [
1937
+ * {
1938
+ * "id": "10001",
1939
+ * "name": "R&D Department",
1940
+ * "exists": true
1941
+ * }
1942
+ * ],
1943
+ * "estimateStatus": "Ready",
1944
+ * "expandedDepartmentCount": 2,
1945
+ * "estimatedUserCount": 12
1946
+ * }
1947
+ * }
1948
+ * ```
1949
+ *
1950
+ * @param request - GetIdentityProviderSyncScopeRequest
1951
+ * @param headers - map
1952
+ * @param runtime - runtime options for this request RuntimeOptions
1953
+ * @returns GetIdentityProviderSyncScopeResponse
1954
+ */
1955
+ getIdentityProviderSyncScopeWithOptions(workspaceId: string, identityProviderType: string, request: $_model.GetIdentityProviderSyncScopeRequest, headers: {
1956
+ [key: string]: string;
1957
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.GetIdentityProviderSyncScopeResponse>;
1958
+ /**
1959
+ * Queries the synchronization scope of an identity provider.
1960
+ *
1961
+ * @remarks
1962
+ * Queries the saved synchronization scope, the validity of selected departments, and the estimated user count downstream of the identity provider. This operation is not used for real-time estimation of unsaved selections. AllAuthorized indicates the address book scope authorized for the application, which is not equivalent to the entire enterprise organization. An empty selectedDepartments array does not prove that the organization has no sub-departments. The estimation can be used only when estimateStatus is Ready and a count is returned. A missing count does not indicate 0.
1963
+ * Authorization information: RAM operation agentcore:GetIdentityProviderSyncScope, access level Read, resource ARN: acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is a required authorization resource.
1964
+ * Idempotence and retry: This operation is read-only and can be queried repeatedly.
1965
+ * Calling this API operation is free of charge. Operation records support ActionTrail auditing.
1966
+ * Sample response:
1967
+ * ```json
1968
+ * {
1969
+ * "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
1970
+ * "message": "success",
1971
+ * "httpStatusCode": 200,
1972
+ * "code": "SUCCESS",
1973
+ * "success": true,
1974
+ * "data": {
1975
+ * "syncScope": {
1976
+ * "mode": "SelectedDepartments",
1977
+ * "departmentIds": [
1978
+ * "10001"
1979
+ * ]
1980
+ * },
1981
+ * "selectedDepartments": [
1982
+ * {
1983
+ * "id": "10001",
1984
+ * "name": "R&D Department",
1985
+ * "exists": true
1986
+ * }
1987
+ * ],
1988
+ * "estimateStatus": "Ready",
1989
+ * "expandedDepartmentCount": 2,
1990
+ * "estimatedUserCount": 12
1991
+ * }
1992
+ * }
1993
+ * ```
1994
+ *
1995
+ * @param request - GetIdentityProviderSyncScopeRequest
1996
+ * @returns GetIdentityProviderSyncScopeResponse
1997
+ */
1998
+ getIdentityProviderSyncScope(workspaceId: string, identityProviderType: string, request: $_model.GetIdentityProviderSyncScopeRequest): Promise<$_model.GetIdentityProviderSyncScopeResponse>;
1337
1999
  /**
1338
2000
  * Queries the details of an image cache.
1339
2001
  *
@@ -1840,6 +2502,32 @@ export default class Client extends OpenApi {
1840
2502
  * @returns InstallWorkspacePluginResponse
1841
2503
  */
1842
2504
  installWorkspacePlugin(workspaceId: string, pluginName: string, request: $_model.InstallWorkspacePluginRequest): Promise<$_model.InstallWorkspacePluginResponse>;
2505
+ /**
2506
+ * Queries the runtime environments supported for code deployment.
2507
+ *
2508
+ * @remarks
2509
+ * Queries the directories in the current workspace that can be used to create code package agents or switch runtime environments. Runtime environments are dynamically provided based on the current version configuration, and internal image addresses are not returned.
2510
+ * If maxResults is omitted or set to 0, the default value is 10. If the value is greater than 100, it is processed as 100. Omit nextToken in the first request. For subsequent requests, use the token returned in the previous response as is, and keep the workspace unchanged. If a directory change invalidates the token, query from the first page again. An empty nextToken indicates that there are no more pages. Existing agents continue to use the saved images for restarts, scaling, and regular updates.
2511
+ *
2512
+ * @param request - ListAgentCodeRuntimesRequest
2513
+ * @param headers - map
2514
+ * @param runtime - runtime options for this request RuntimeOptions
2515
+ * @returns ListAgentCodeRuntimesResponse
2516
+ */
2517
+ listAgentCodeRuntimesWithOptions(workspaceId: string, request: $_model.ListAgentCodeRuntimesRequest, headers: {
2518
+ [key: string]: string;
2519
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.ListAgentCodeRuntimesResponse>;
2520
+ /**
2521
+ * Queries the runtime environments supported for code deployment.
2522
+ *
2523
+ * @remarks
2524
+ * Queries the directories in the current workspace that can be used to create code package agents or switch runtime environments. Runtime environments are dynamically provided based on the current version configuration, and internal image addresses are not returned.
2525
+ * If maxResults is omitted or set to 0, the default value is 10. If the value is greater than 100, it is processed as 100. Omit nextToken in the first request. For subsequent requests, use the token returned in the previous response as is, and keep the workspace unchanged. If a directory change invalidates the token, query from the first page again. An empty nextToken indicates that there are no more pages. Existing agents continue to use the saved images for restarts, scaling, and regular updates.
2526
+ *
2527
+ * @param request - ListAgentCodeRuntimesRequest
2528
+ * @returns ListAgentCodeRuntimesResponse
2529
+ */
2530
+ listAgentCodeRuntimes(workspaceId: string, request: $_model.ListAgentCodeRuntimesRequest): Promise<$_model.ListAgentCodeRuntimesResponse>;
1843
2531
  /**
1844
2532
  * Queries the list of IM channels for a specified agent.
1845
2533
  *
@@ -1981,12 +2669,12 @@ export default class Client extends OpenApi {
1981
2669
  */
1982
2670
  listCredentials(workspaceId: string, request: $_model.ListCredentialsRequest): Promise<$_model.ListCredentialsResponse>;
1983
2671
  /**
1984
- * Queries the summaries of custom agents in a specified workspace by using paging. For the complete configuration and the execution results of the latest version, call GetCustomAgent.
2672
+ * Performs a paged query for paging through the custom agent summary in a specified workspace. For the complete configuration and the latest execute results, call GetCustomAgent.
1985
2673
  *
1986
2674
  * @remarks
1987
- * The default value of maxResults is 20, and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
1988
- * Omit nextToken in the first request. In subsequent requests, pass the nextToken value returned in the previous response as is, and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it. If the token in the response is empty, it indicates that no more pages are available.
1989
- * This operation returns the summaries of the current page and does not return the complete deployment configuration or the execution errors of the latest version. To obtain this information, call GetCustomAgent by using the agentId in items.
2675
+ * The default value of maxResults is 20 and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
2676
+ * Omit nextToken in the first request. For subsequent requests, pass the nextToken returned in the previous response as is and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it. An empty token in the response indicates that there are no more pages.
2677
+ * This operation returns the summaries of the current page and does not return the complete deployment configurations or the execution errors of the latest version. To obtain this information, call GetCustomAgent by using the agentId in items.
1990
2678
  *
1991
2679
  * @param request - ListCustomAgentsRequest
1992
2680
  * @param headers - map
@@ -1997,12 +2685,12 @@ export default class Client extends OpenApi {
1997
2685
  [key: string]: string;
1998
2686
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListCustomAgentsResponse>;
1999
2687
  /**
2000
- * Queries the summaries of custom agents in a specified workspace by using paging. For the complete configuration and the execution results of the latest version, call GetCustomAgent.
2688
+ * Performs a paged query for paging through the custom agent summary in a specified workspace. For the complete configuration and the latest execute results, call GetCustomAgent.
2001
2689
  *
2002
2690
  * @remarks
2003
- * The default value of maxResults is 20, and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
2004
- * Omit nextToken in the first request. In subsequent requests, pass the nextToken value returned in the previous response as is, and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it. If the token in the response is empty, it indicates that no more pages are available.
2005
- * This operation returns the summaries of the current page and does not return the complete deployment configuration or the execution errors of the latest version. To obtain this information, call GetCustomAgent by using the agentId in items.
2691
+ * The default value of maxResults is 20 and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
2692
+ * Omit nextToken in the first request. For subsequent requests, pass the nextToken returned in the previous response as is and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it. An empty token in the response indicates that there are no more pages.
2693
+ * This operation returns the summaries of the current page and does not return the complete deployment configurations or the execution errors of the latest version. To obtain this information, call GetCustomAgent by using the agentId in items.
2006
2694
  *
2007
2695
  * @param request - ListCustomAgentsRequest
2008
2696
  * @returns ListCustomAgentsResponse
@@ -2033,7 +2721,187 @@ export default class Client extends OpenApi {
2033
2721
  */
2034
2722
  listExternalAgents(workspaceId: string, request: $_model.ListExternalAgentsRequest): Promise<$_model.ListExternalAgentsResponse>;
2035
2723
  /**
2036
- * Queries the external identity providers bound to a specified workspace. Each workspace can be bound to at most one external identity provider, so the response returns at most one record. Application secret configurations are not returned.
2724
+ * Queries the departments of an identity provider by page.
2725
+ *
2726
+ * @remarks
2727
+ * Queries DingTalk or Lark departments by hierarchy and page. Prerequisites include an existing identity provider binding, a user pool, valid application credentials, and address book read authorization. If parentDepartmentId is not specified, the root hierarchy is queried. When expanding a node, use the ID of the node to query its direct child departments. The hasChildren field is used to determine expandability and does not indicate that child nodes have been returned. The nextToken field is only used to continue querying the next page under the current parent department. The query only reads the directory, does not save the synchronization scope, and does not import users. After a new department is added to a DingTalk or Lark organization, re-query the corresponding parent department because the old list does not represent the latest directory.
2728
+ * Authorization information: The RAM operation is agentcore:ListIdentityProviderDepartments, the access level is List, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource requires authorization.
2729
+ * Idempotence and retry: This operation is read-only and can be invoked repeatedly.
2730
+ * It is free of charge to invoke this API operation, and operation records support ActionTrail auditing.
2731
+ * Sample response:
2732
+ * ```json
2733
+ * {
2734
+ * "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
2735
+ * "message": "success",
2736
+ * "httpStatusCode": 200,
2737
+ * "code": "SUCCESS",
2738
+ * "success": true,
2739
+ * "maxResults": 50,
2740
+ * "nextToken": "",
2741
+ * "items": [
2742
+ * {
2743
+ * "id": "10001",
2744
+ * "name": "R&D Department",
2745
+ * "parentId": "1",
2746
+ * "memberCount": 12,
2747
+ * "hasChildren": true
2748
+ * }
2749
+ * ]
2750
+ * }
2751
+ * ```
2752
+ *
2753
+ * @param request - ListIdentityProviderDepartmentsRequest
2754
+ * @param headers - map
2755
+ * @param runtime - runtime options for this request RuntimeOptions
2756
+ * @returns ListIdentityProviderDepartmentsResponse
2757
+ */
2758
+ listIdentityProviderDepartmentsWithOptions(workspaceId: string, identityProviderType: string, request: $_model.ListIdentityProviderDepartmentsRequest, headers: {
2759
+ [key: string]: string;
2760
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.ListIdentityProviderDepartmentsResponse>;
2761
+ /**
2762
+ * Queries the departments of an identity provider by page.
2763
+ *
2764
+ * @remarks
2765
+ * Queries DingTalk or Lark departments by hierarchy and page. Prerequisites include an existing identity provider binding, a user pool, valid application credentials, and address book read authorization. If parentDepartmentId is not specified, the root hierarchy is queried. When expanding a node, use the ID of the node to query its direct child departments. The hasChildren field is used to determine expandability and does not indicate that child nodes have been returned. The nextToken field is only used to continue querying the next page under the current parent department. The query only reads the directory, does not save the synchronization scope, and does not import users. After a new department is added to a DingTalk or Lark organization, re-query the corresponding parent department because the old list does not represent the latest directory.
2766
+ * Authorization information: The RAM operation is agentcore:ListIdentityProviderDepartments, the access level is List, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource requires authorization.
2767
+ * Idempotence and retry: This operation is read-only and can be invoked repeatedly.
2768
+ * It is free of charge to invoke this API operation, and operation records support ActionTrail auditing.
2769
+ * Sample response:
2770
+ * ```json
2771
+ * {
2772
+ * "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
2773
+ * "message": "success",
2774
+ * "httpStatusCode": 200,
2775
+ * "code": "SUCCESS",
2776
+ * "success": true,
2777
+ * "maxResults": 50,
2778
+ * "nextToken": "",
2779
+ * "items": [
2780
+ * {
2781
+ * "id": "10001",
2782
+ * "name": "R&D Department",
2783
+ * "parentId": "1",
2784
+ * "memberCount": 12,
2785
+ * "hasChildren": true
2786
+ * }
2787
+ * ]
2788
+ * }
2789
+ * ```
2790
+ *
2791
+ * @param request - ListIdentityProviderDepartmentsRequest
2792
+ * @returns ListIdentityProviderDepartmentsResponse
2793
+ */
2794
+ listIdentityProviderDepartments(workspaceId: string, identityProviderType: string, request: $_model.ListIdentityProviderDepartmentsRequest): Promise<$_model.ListIdentityProviderDepartmentsResponse>;
2795
+ /**
2796
+ * Queries the complete summary list of up to two SCIM credentials in the shared user pool, without returning plaintext tokens or supporting pagination.
2797
+ *
2798
+ * @remarks
2799
+ * ## Features and prerequisites
2800
+ * Retrieves the current credential summary list from AgentIdentity and returns a data array. Each item contains credentialId, status, createTime, and expireTime. If no credentials exist, an empty array is returned. This operation does not support maxResults, nextToken, or pagination. Do not call this operation with fake pagination fields. The list never returns plaintext tokens, nor does it enable the receiving or issuing of new credentials.
2801
+ * Receiving is not required to be enabled, but the shared pool must be available. A credential is considered available if its status is Enabled and its expireTime is later than the current time. The maximum limit of two credentials is determined by AgentIdentity. Client-side counting is for reference only. The list may contain unavailable or expired credentials. Do not use this list to claim that available tokens exist.
2802
+ * ## Requests and examples
2803
+ * GET /workspaces/{workspaceId}/scim-provisioning/credentials
2804
+ * Call conventions: Call this operation in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity source resources of the workspace. The ws-example, URL, certificate, and token in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business data. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
2805
+ * ```text
2806
+ * GET /workspaces/ws-example/scim-provisioning/credentials
2807
+ * ```
2808
+ * ## Response examples
2809
+ * ```json
2810
+ * {
2811
+ * "data": [
2812
+ * {
2813
+ * "credentialId": "credential-example",
2814
+ * "status": "Enabled",
2815
+ * "createTime": "<Upstream creation time>",
2816
+ * "expireTime": "<Upstream expiration time>"
2817
+ * }
2818
+ * ]
2819
+ * }
2820
+ * ```
2821
+ * ## Errors and handling
2822
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. Synchronous calls to the upstream service that fail may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling process.
2823
+ * 400 InvalidParameter: The shared user pool is unavailable. 404 IdentityProviderNotFound: No corresponding binding exists. Upstream query failures cannot be replaced with an empty list, which may mislead users into repeatedly creating credentials.
2824
+ * ## Call relationships and usage boundaries
2825
+ * Used for configuration recovery and credential management: Existing plaintext tokens cannot be queried and retrieved again. The list provides only credential summaries. To obtain a new token, call CreateIdentityProviderSCIMCredential. To revoke a credential, submit the credentialId from the list to DeleteIdentityProviderSCIMCredential. A maximum of two credentials are allowed in the same pool. This operation returns the complete array and does not support or fabricate pagination parameters.
2826
+ *
2827
+ * @param request - ListIdentityProviderSCIMCredentialsRequest
2828
+ * @param headers - map
2829
+ * @param runtime - runtime options for this request RuntimeOptions
2830
+ * @returns ListIdentityProviderSCIMCredentialsResponse
2831
+ */
2832
+ listIdentityProviderSCIMCredentialsWithOptions(workspaceId: string, request: $_model.ListIdentityProviderSCIMCredentialsRequest, headers: {
2833
+ [key: string]: string;
2834
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.ListIdentityProviderSCIMCredentialsResponse>;
2835
+ /**
2836
+ * Queries the complete summary list of up to two SCIM credentials in the shared user pool, without returning plaintext tokens or supporting pagination.
2837
+ *
2838
+ * @remarks
2839
+ * ## Features and prerequisites
2840
+ * Retrieves the current credential summary list from AgentIdentity and returns a data array. Each item contains credentialId, status, createTime, and expireTime. If no credentials exist, an empty array is returned. This operation does not support maxResults, nextToken, or pagination. Do not call this operation with fake pagination fields. The list never returns plaintext tokens, nor does it enable the receiving or issuing of new credentials.
2841
+ * Receiving is not required to be enabled, but the shared pool must be available. A credential is considered available if its status is Enabled and its expireTime is later than the current time. The maximum limit of two credentials is determined by AgentIdentity. Client-side counting is for reference only. The list may contain unavailable or expired credentials. Do not use this list to claim that available tokens exist.
2842
+ * ## Requests and examples
2843
+ * GET /workspaces/{workspaceId}/scim-provisioning/credentials
2844
+ * Call conventions: Call this operation in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity source resources of the workspace. The ws-example, URL, certificate, and token in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business data. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
2845
+ * ```text
2846
+ * GET /workspaces/ws-example/scim-provisioning/credentials
2847
+ * ```
2848
+ * ## Response examples
2849
+ * ```json
2850
+ * {
2851
+ * "data": [
2852
+ * {
2853
+ * "credentialId": "credential-example",
2854
+ * "status": "Enabled",
2855
+ * "createTime": "<Upstream creation time>",
2856
+ * "expireTime": "<Upstream expiration time>"
2857
+ * }
2858
+ * ]
2859
+ * }
2860
+ * ```
2861
+ * ## Errors and handling
2862
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. Synchronous calls to the upstream service that fail may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling process.
2863
+ * 400 InvalidParameter: The shared user pool is unavailable. 404 IdentityProviderNotFound: No corresponding binding exists. Upstream query failures cannot be replaced with an empty list, which may mislead users into repeatedly creating credentials.
2864
+ * ## Call relationships and usage boundaries
2865
+ * Used for configuration recovery and credential management: Existing plaintext tokens cannot be queried and retrieved again. The list provides only credential summaries. To obtain a new token, call CreateIdentityProviderSCIMCredential. To revoke a credential, submit the credentialId from the list to DeleteIdentityProviderSCIMCredential. A maximum of two credentials are allowed in the same pool. This operation returns the complete array and does not support or fabricate pagination parameters.
2866
+ *
2867
+ * @param request - ListIdentityProviderSCIMCredentialsRequest
2868
+ * @returns ListIdentityProviderSCIMCredentialsResponse
2869
+ */
2870
+ listIdentityProviderSCIMCredentials(workspaceId: string, request: $_model.ListIdentityProviderSCIMCredentialsRequest): Promise<$_model.ListIdentityProviderSCIMCredentialsResponse>;
2871
+ /**
2872
+ * Queries the summary of existing identity provider bindings for a workspace, including CustomSSO. Returns local binding information without querying the actual upstream SAML or SCIM configurations.
2873
+ *
2874
+ * @remarks
2875
+ * ## Features and prerequisites
2876
+ * Returns the local binding summary without querying the actual SAML and SCIM configurations of AgentIdentity. If no bindings exist, items is an empty array. A workspace currently supports only one external binding. The default value of maxResults is 10, and the valid values are 1 to 100. Currently, nextToken must be omitted or left empty. A non-empty value returns InvalidParameter, and multi-page results cannot be fabricated.
2877
+ * The status of CustomSSO indicates the task status of shared resources and logon configurations. You must combine protocol and saml to determine whether SAML is configured. SCIM queries are independently performed by using GetIdentityProviderSCIM. The list does not issue tokens and does not return the vendor appSecret, encryptKey, or verificationToken.
2878
+ * ## Requests and examples
2879
+ * GET /workspaces/{workspaceId}/identity-providers
2880
+ * Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request example shows the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
2881
+ * ```text
2882
+ * GET /workspaces/ws-example/identity-providers?maxResults=10
2883
+ * ```
2884
+ * ## Response example
2885
+ * ```json
2886
+ * {
2887
+ * "items": [
2888
+ * {
2889
+ * "workspaceId": "ws-example",
2890
+ * "identityProviderType": "CustomSSO",
2891
+ * "status": "READY",
2892
+ * "loginEnabled": false,
2893
+ * "syncEnabled": false
2894
+ * }
2895
+ * ],
2896
+ * "maxResults": 10,
2897
+ * "totalCount": 1
2898
+ * }
2899
+ * ```
2900
+ * ## Errors and handling
2901
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. A synchronous call failure to the upstream may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
2902
+ * 400 InvalidParameter: maxResults is out of bounds or nextToken is non-empty, which is currently not supported. When a query fails, an error is displayed instead of being cleared as unconfigured.
2903
+ * ## Call relationships and usage boundaries
2904
+ * This API is used to discover current bindings. The specific SAML configuration of CustomSSO is queried by using GetIdentityProvider. The SP address is queried by using GetIdentityProviderServiceProvider. The actual SCIM configuration and independent operation results are queried by using GetIdentityProviderSCIM.
2037
2905
  *
2038
2906
  * @param request - ListIdentityProvidersRequest
2039
2907
  * @param headers - map
@@ -2044,7 +2912,39 @@ export default class Client extends OpenApi {
2044
2912
  [key: string]: string;
2045
2913
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListIdentityProvidersResponse>;
2046
2914
  /**
2047
- * Queries the external identity providers bound to a specified workspace. Each workspace can be bound to at most one external identity provider, so the response returns at most one record. Application secret configurations are not returned.
2915
+ * Queries the summary of existing identity provider bindings for a workspace, including CustomSSO. Returns local binding information without querying the actual upstream SAML or SCIM configurations.
2916
+ *
2917
+ * @remarks
2918
+ * ## Features and prerequisites
2919
+ * Returns the local binding summary without querying the actual SAML and SCIM configurations of AgentIdentity. If no bindings exist, items is an empty array. A workspace currently supports only one external binding. The default value of maxResults is 10, and the valid values are 1 to 100. Currently, nextToken must be omitted or left empty. A non-empty value returns InvalidParameter, and multi-page results cannot be fabricated.
2920
+ * The status of CustomSSO indicates the task status of shared resources and logon configurations. You must combine protocol and saml to determine whether SAML is configured. SCIM queries are independently performed by using GetIdentityProviderSCIM. The list does not issue tokens and does not return the vendor appSecret, encryptKey, or verificationToken.
2921
+ * ## Requests and examples
2922
+ * GET /workspaces/{workspaceId}/identity-providers
2923
+ * Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request example shows the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
2924
+ * ```text
2925
+ * GET /workspaces/ws-example/identity-providers?maxResults=10
2926
+ * ```
2927
+ * ## Response example
2928
+ * ```json
2929
+ * {
2930
+ * "items": [
2931
+ * {
2932
+ * "workspaceId": "ws-example",
2933
+ * "identityProviderType": "CustomSSO",
2934
+ * "status": "READY",
2935
+ * "loginEnabled": false,
2936
+ * "syncEnabled": false
2937
+ * }
2938
+ * ],
2939
+ * "maxResults": 10,
2940
+ * "totalCount": 1
2941
+ * }
2942
+ * ```
2943
+ * ## Errors and handling
2944
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. A synchronous call failure to the upstream may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
2945
+ * 400 InvalidParameter: maxResults is out of bounds or nextToken is non-empty, which is currently not supported. When a query fails, an error is displayed instead of being cleared as unconfigured.
2946
+ * ## Call relationships and usage boundaries
2947
+ * This API is used to discover current bindings. The specific SAML configuration of CustomSSO is queried by using GetIdentityProvider. The SP address is queried by using GetIdentityProviderServiceProvider. The actual SCIM configuration and independent operation results are queried by using GetIdentityProviderSCIM.
2048
2948
  *
2049
2949
  * @param request - ListIdentityProvidersRequest
2050
2950
  * @returns ListIdentityProvidersResponse
@@ -2175,10 +3075,10 @@ export default class Client extends OpenApi {
2175
3075
  */
2176
3076
  listMcps(workspaceId: string, request: $_model.ListMcpsRequest): Promise<$_model.ListMcpsResponse>;
2177
3077
  /**
2178
- * Performs a paged query on long-term memory. Paging is supported, and you can filter the results independently by user ID, agent ID, and session ID.
3078
+ * Performs a paged query on long-term memory records. The results can be filtered independently by user ID, agent ID, and session ID. Paging is supported.
2179
3079
  *
2180
3080
  * @remarks
2181
- * Performs a paged query on long-term memory. Paging is supported, and you can filter the results independently by user ID, agent ID, and session ID.
3081
+ * Performs a paged query on long-term memory records. The results can be filtered independently by user ID, agent ID, and session ID. Paging is supported.
2182
3082
  *
2183
3083
  * @param request - ListMemoriesRequest
2184
3084
  * @param headers - map
@@ -2189,20 +3089,20 @@ export default class Client extends OpenApi {
2189
3089
  [key: string]: string;
2190
3090
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListMemoriesResponse>;
2191
3091
  /**
2192
- * Performs a paged query on long-term memory. Paging is supported, and you can filter the results independently by user ID, agent ID, and session ID.
3092
+ * Performs a paged query on long-term memory records. The results can be filtered independently by user ID, agent ID, and session ID. Paging is supported.
2193
3093
  *
2194
3094
  * @remarks
2195
- * Performs a paged query on long-term memory. Paging is supported, and you can filter the results independently by user ID, agent ID, and session ID.
3095
+ * Performs a paged query on long-term memory records. The results can be filtered independently by user ID, agent ID, and session ID. Paging is supported.
2196
3096
  *
2197
3097
  * @param request - ListMemoriesRequest
2198
3098
  * @returns ListMemoriesResponse
2199
3099
  */
2200
3100
  listMemories(workspaceId: string, memoryStoreName: string, request: $_model.ListMemoriesRequest): Promise<$_model.ListMemoriesResponse>;
2201
3101
  /**
2202
- * Performs a paged query for raw messages by exact scope with paging. SessionId is required, and at least one of UserId and AgentId must be provided.
3102
+ * Performs a paging query for raw messages by exact scope. SessionId is required, and at least one of UserId and AgentId must be provided.
2203
3103
  *
2204
3104
  * @remarks
2205
- * Performs a paged query for raw messages by exact scope with paging. SessionId is required, and at least one of UserId and AgentId must be provided.
3105
+ * Performs a paging query for raw messages by exact scope. SessionId is required, and at least one of UserId and AgentId must be provided.
2206
3106
  *
2207
3107
  * @param request - ListMemorySessionMessagesRequest
2208
3108
  * @param headers - map
@@ -2213,20 +3113,20 @@ export default class Client extends OpenApi {
2213
3113
  [key: string]: string;
2214
3114
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListMemorySessionMessagesResponse>;
2215
3115
  /**
2216
- * Performs a paged query for raw messages by exact scope with paging. SessionId is required, and at least one of UserId and AgentId must be provided.
3116
+ * Performs a paging query for raw messages by exact scope. SessionId is required, and at least one of UserId and AgentId must be provided.
2217
3117
  *
2218
3118
  * @remarks
2219
- * Performs a paged query for raw messages by exact scope with paging. SessionId is required, and at least one of UserId and AgentId must be provided.
3119
+ * Performs a paging query for raw messages by exact scope. SessionId is required, and at least one of UserId and AgentId must be provided.
2220
3120
  *
2221
3121
  * @param request - ListMemorySessionMessagesRequest
2222
3122
  * @returns ListMemorySessionMessagesResponse
2223
3123
  */
2224
3124
  listMemorySessionMessages(workspaceId: string, memoryStoreName: string, request: $_model.ListMemorySessionMessagesRequest): Promise<$_model.ListMemorySessionMessagesResponse>;
2225
3125
  /**
2226
- * Performs a paging query for sessions in a MemoryStore, and allows independent filtering by user ID and agent ID.
3126
+ * Performs a paging query for sessions in a MemoryStore. You can filter the sessions independently by user ID and agent ID.
2227
3127
  *
2228
3128
  * @remarks
2229
- * Performs a paging query for sessions in a MemoryStore, and allows independent filtering by user ID and agent ID.
3129
+ * Performs a paging query for sessions in a MemoryStore. You can filter the sessions independently by user ID and agent ID.
2230
3130
  *
2231
3131
  * @param request - ListMemorySessionsRequest
2232
3132
  * @param headers - map
@@ -2237,20 +3137,20 @@ export default class Client extends OpenApi {
2237
3137
  [key: string]: string;
2238
3138
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListMemorySessionsResponse>;
2239
3139
  /**
2240
- * Performs a paging query for sessions in a MemoryStore, and allows independent filtering by user ID and agent ID.
3140
+ * Performs a paging query for sessions in a MemoryStore. You can filter the sessions independently by user ID and agent ID.
2241
3141
  *
2242
3142
  * @remarks
2243
- * Performs a paging query for sessions in a MemoryStore, and allows independent filtering by user ID and agent ID.
3143
+ * Performs a paging query for sessions in a MemoryStore. You can filter the sessions independently by user ID and agent ID.
2244
3144
  *
2245
3145
  * @param request - ListMemorySessionsRequest
2246
3146
  * @returns ListMemorySessionsResponse
2247
3147
  */
2248
3148
  listMemorySessions(workspaceId: string, memoryStoreName: string, request: $_model.ListMemorySessionsRequest): Promise<$_model.ListMemorySessionsResponse>;
2249
3149
  /**
2250
- * Queries MemoryStores in a specified workspace by using paging.
3150
+ * Performs a paged query for MemoryStores in a specified workspace with paging.
2251
3151
  *
2252
3152
  * @remarks
2253
- * Queries MemoryStores in a specified workspace by using paging.
3153
+ * Performs a paged query for MemoryStores in a specified workspace with paging.
2254
3154
  *
2255
3155
  * @param request - ListMemoryStoresRequest
2256
3156
  * @param headers - map
@@ -2261,10 +3161,10 @@ export default class Client extends OpenApi {
2261
3161
  [key: string]: string;
2262
3162
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListMemoryStoresResponse>;
2263
3163
  /**
2264
- * Queries MemoryStores in a specified workspace by using paging.
3164
+ * Performs a paged query for MemoryStores in a specified workspace with paging.
2265
3165
  *
2266
3166
  * @remarks
2267
- * Queries MemoryStores in a specified workspace by using paging.
3167
+ * Performs a paged query for MemoryStores in a specified workspace with paging.
2268
3168
  *
2269
3169
  * @param request - ListMemoryStoresRequest
2270
3170
  * @returns ListMemoryStoresResponse
@@ -2602,6 +3502,92 @@ export default class Client extends OpenApi {
2602
3502
  * @returns PrecheckSkillUploadViaOssResponse
2603
3503
  */
2604
3504
  precheckSkillUploadViaOss(workspaceId: string, request: $_model.PrecheckSkillUploadViaOssRequest): Promise<$_model.PrecheckSkillUploadViaOssResponse>;
3505
+ /**
3506
+ * Prepares the SCIM receiving configuration, and returns the provisioning URL and credential summary. Issues a token if no available credentials exist and returns the plaintext only in the current response. Does not automatically enable user synchronization.
3507
+ *
3508
+ * @remarks
3509
+ * ## Features and prerequisites
3510
+ * A CustomSSO shared user pool must be available. This operation does not depend on SAML metadata and is not blocked by SAML updating or update failure states. It synchronously calls AgentIdentity to enable SCIM receiving, and reads the configuration and credential list. If a credential in the Enabled state that has not expired already exists, its summary is returned and the token is set to null. If no available credentials exist, a new credential is created and the token is returned only in the current response. Existing invalid or expired credentials are not automatically deleted and may still trigger the upstream limit of up to two credentials.
3511
+ * The prepare operation has the side effects of enabling receiving and potentially issuing credentials, but it does not set the AC syncEnabled parameter, initiate the first import, or indicate that the external provisioning connection test has passed. After configuring the baseUrl and the current token in the external provisioning system, call UpdateIdentityProviderSCIM to confirm and enable synchronization. Existing tokens cannot be retrieved again. If the response is lost, query the credential list first. Tokens are not automatically reissued. Tokens must not be logged or persisted in frontend caches.
3512
+ * ## Requests and examples
3513
+ * POST /workspaces/{workspaceId}/scim-provisioning/prepare
3514
+ * Calling conventions: Call this operation in the region of the target workspace by using an AccessKey ID/STS identity that has permissions on the identity source resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not log secrets. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
3515
+ * ```text
3516
+ * POST /workspaces/ws-example/scim-provisioning/prepare
3517
+ * No business request body.
3518
+ * ```
3519
+ * ## Response examples
3520
+ * ```json
3521
+ * {
3522
+ * "data": {
3523
+ * "configuration": {
3524
+ * "status": "Enabled",
3525
+ * "baseUrl": "https://example.com/scim/v2"
3526
+ * },
3527
+ * "credential": {
3528
+ * "credentialId": "credential-example",
3529
+ * "status": "Enabled",
3530
+ * "expireTime": "<Expiration time returned by the upstream service>"
3531
+ * },
3532
+ * "token": "<Token issued only in the current response; null if an available credential already exists>"
3533
+ * }
3534
+ * }
3535
+ * ```
3536
+ * ## Errors and handling
3537
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. Synchronous calls to the upstream service that fail may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace not found errors follow the common error handling process.
3538
+ * 400 LimitExceeded.ScimCredential: The maximum limit of two credentials has been reached. You must explicitly delete one credential and try again. Credentials are not automatically deleted, rotated, or expanded. 400 InvalidParameter: The shared pool is unavailable. This call may have enabled upstream receiving and then reported an error due to issuance failure. The error does not mean that the operation has been automatically rolled back.
3539
+ * ## Call relationships and usage boundaries
3540
+ * The shared pool is created by using CreateIdentityProvider with identityProviderType set to CustomSSO. SAML configuration is not required. If an existing credential is reused and token is null, use the token that the user has already saved. Do not configure a null value in the external system. If the token is lost, call ListIdentityProviderSCIMCredentials to check first, and then explicitly call CreateIdentityProviderSCIMCredential to issue a new token. When the limit of two credentials is reached, the user must confirm and delete the unused credential.
3541
+ *
3542
+ * @param request - PrepareIdentityProviderSCIMRequest
3543
+ * @param headers - map
3544
+ * @param runtime - runtime options for this request RuntimeOptions
3545
+ * @returns PrepareIdentityProviderSCIMResponse
3546
+ */
3547
+ prepareIdentityProviderSCIMWithOptions(workspaceId: string, request: $_model.PrepareIdentityProviderSCIMRequest, headers: {
3548
+ [key: string]: string;
3549
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.PrepareIdentityProviderSCIMResponse>;
3550
+ /**
3551
+ * Prepares the SCIM receiving configuration, and returns the provisioning URL and credential summary. Issues a token if no available credentials exist and returns the plaintext only in the current response. Does not automatically enable user synchronization.
3552
+ *
3553
+ * @remarks
3554
+ * ## Features and prerequisites
3555
+ * A CustomSSO shared user pool must be available. This operation does not depend on SAML metadata and is not blocked by SAML updating or update failure states. It synchronously calls AgentIdentity to enable SCIM receiving, and reads the configuration and credential list. If a credential in the Enabled state that has not expired already exists, its summary is returned and the token is set to null. If no available credentials exist, a new credential is created and the token is returned only in the current response. Existing invalid or expired credentials are not automatically deleted and may still trigger the upstream limit of up to two credentials.
3556
+ * The prepare operation has the side effects of enabling receiving and potentially issuing credentials, but it does not set the AC syncEnabled parameter, initiate the first import, or indicate that the external provisioning connection test has passed. After configuring the baseUrl and the current token in the external provisioning system, call UpdateIdentityProviderSCIM to confirm and enable synchronization. Existing tokens cannot be retrieved again. If the response is lost, query the credential list first. Tokens are not automatically reissued. Tokens must not be logged or persisted in frontend caches.
3557
+ * ## Requests and examples
3558
+ * POST /workspaces/{workspaceId}/scim-provisioning/prepare
3559
+ * Calling conventions: Call this operation in the region of the target workspace by using an AccessKey ID/STS identity that has permissions on the identity source resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not log secrets. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
3560
+ * ```text
3561
+ * POST /workspaces/ws-example/scim-provisioning/prepare
3562
+ * No business request body.
3563
+ * ```
3564
+ * ## Response examples
3565
+ * ```json
3566
+ * {
3567
+ * "data": {
3568
+ * "configuration": {
3569
+ * "status": "Enabled",
3570
+ * "baseUrl": "https://example.com/scim/v2"
3571
+ * },
3572
+ * "credential": {
3573
+ * "credentialId": "credential-example",
3574
+ * "status": "Enabled",
3575
+ * "expireTime": "<Expiration time returned by the upstream service>"
3576
+ * },
3577
+ * "token": "<Token issued only in the current response; null if an available credential already exists>"
3578
+ * }
3579
+ * }
3580
+ * ```
3581
+ * ## Errors and handling
3582
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. Synchronous calls to the upstream service that fail may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace not found errors follow the common error handling process.
3583
+ * 400 LimitExceeded.ScimCredential: The maximum limit of two credentials has been reached. You must explicitly delete one credential and try again. Credentials are not automatically deleted, rotated, or expanded. 400 InvalidParameter: The shared pool is unavailable. This call may have enabled upstream receiving and then reported an error due to issuance failure. The error does not mean that the operation has been automatically rolled back.
3584
+ * ## Call relationships and usage boundaries
3585
+ * The shared pool is created by using CreateIdentityProvider with identityProviderType set to CustomSSO. SAML configuration is not required. If an existing credential is reused and token is null, use the token that the user has already saved. Do not configure a null value in the external system. If the token is lost, call ListIdentityProviderSCIMCredentials to check first, and then explicitly call CreateIdentityProviderSCIMCredential to issue a new token. When the limit of two credentials is reached, the user must confirm and delete the unused credential.
3586
+ *
3587
+ * @param request - PrepareIdentityProviderSCIMRequest
3588
+ * @returns PrepareIdentityProviderSCIMResponse
3589
+ */
3590
+ prepareIdentityProviderSCIM(workspaceId: string, request: $_model.PrepareIdentityProviderSCIMRequest): Promise<$_model.PrepareIdentityProviderSCIMResponse>;
2605
3591
  /**
2606
3592
  * Publishes a specified Skill version to transition it to the published state.
2607
3593
  *
@@ -2697,10 +3683,10 @@ export default class Client extends OpenApi {
2697
3683
  */
2698
3684
  retryImageCache(imageId: string, request: $_model.RetryImageCacheRequest): Promise<$_model.RetryImageCacheResponse>;
2699
3685
  /**
2700
- * Retrieves long-term memory from a MemoryStore based on semantics queries.
3686
+ * Retrieves long-term memory from a MemoryStore based on semantics.
2701
3687
  *
2702
3688
  * @remarks
2703
- * Retrieves long-term memory from a MemoryStore based on semantics queries.
3689
+ * Retrieves long-term memory from a MemoryStore based on semantics.
2704
3690
  *
2705
3691
  * @param tmpReq - SearchMemoriesRequest
2706
3692
  * @param headers - map
@@ -2711,10 +3697,10 @@ export default class Client extends OpenApi {
2711
3697
  [key: string]: string;
2712
3698
  }, runtime: $dara.RuntimeOptions): Promise<$_model.SearchMemoriesResponse>;
2713
3699
  /**
2714
- * Retrieves long-term memory from a MemoryStore based on semantics queries.
3700
+ * Retrieves long-term memory from a MemoryStore based on semantics.
2715
3701
  *
2716
3702
  * @remarks
2717
- * Retrieves long-term memory from a MemoryStore based on semantics queries.
3703
+ * Retrieves long-term memory from a MemoryStore based on semantics.
2718
3704
  *
2719
3705
  * @param request - SearchMemoriesRequest
2720
3706
  * @returns SearchMemoriesResponse
@@ -2898,10 +3884,12 @@ export default class Client extends OpenApi {
2898
3884
  * Updates the configuration of a specified custom agent in a workspace and executes the update asynchronously. Omitted top-level fields retain their original configurations. You can call the GetCustomAgent operation to query the update result.
2899
3885
  *
2900
3886
  * @remarks
2901
- * Specify at least one top-level field to update. Omitted top-level fields retain their original configurations. When providing a configuration object, specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced as a whole. Pass an empty array [] to clear a list. The agenticFsMounts field does not accept null. Pass null for the description field to clear the description, and pass null for the healthCheck field to remove the health check.
2902
- * When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field. Currently, only ACR container image deployment is supported. Omit the artifact.code field.
2903
- * When providing the runtime field, both compute and sessionPolicy must be present. If you omit hpa or any of its fields, unspecified elastic configurations use default values. To retain the original elastic configurations, provide them all. When providing the network field, omitted access items are treated as allowed, but actual access is still subject to the workspace network restrictions. To retain the original restrictions, provide both accessInternet and accessVpc. When providing healthCheck, you must specify the port field, and other unspecified items use default values. When providing logging.sls, you must specify both project and logstore.
2904
- * The update is an asynchronous process. A successful response indicates that the request is accepted. You can call the GetCustomAgent operation to query latestSpecVersion, latestVersionStatus, and latestExecutionError, and check the status field to confirm the update result.
3887
+ * Provide at least one top-level field to update. Omitted top-level fields retain their original configurations. When providing a configuration object, specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced as a whole. Pass an empty array [] to clear a list. The agenticFsMounts field does not accept null. Pass null for the description field to clear the description, and pass null for the healthCheck field to remove the health check.
3888
+ * When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field.
3889
+ * In code package pattern, specify artifact.port and the sourceUri, languageRuntime, and entrypoint fields of artifact.code. Do not specify the container field at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported, and the compressed package size cannot exceed 500,000,000 bytes. Query the runtime environment identity by calling the ListAgentCodeRuntimes operation. The sourceUri field supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, first call the GetAgentCodePackageUploadUrl operation to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
3890
+ * When submitting a new code package source, the backend rechecks read permissions, objects, and sizes. The configuration is saved only after the transfer succeeds. If the transfer fails, the current configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not indicate that the agent is ready to run.
3891
+ * When providing the runtime field, the compute and sessionPolicy fields must be provided at the same time. If the hpa field or its subfields are omitted, unspecified elastic configurations use default values. To retain the original elastic configurations, provide them together. When providing the network field, omitted access items are treated as allowed, but actual access is still restricted by the workspace network configurations. To retain the original restrictions, provide both accessInternet and accessVpc. When providing the healthCheck field, the port field is required, and other unspecified items use default values. When providing the logging.sls field, both project and logstore must be specified.
3892
+ * The update is an asynchronous process. A successful response indicates that the request is accepted. Call the GetCustomAgent operation to query latestSpecVersion, latestVersionStatus, and latestExecutionError, and check the status field to confirm the update result.
2905
3893
  * The clientToken field currently does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold field for health checks currently does not take effect. Omit this field.
2906
3894
  *
2907
3895
  * @param tmpReq - UpdateCustomAgentRequest
@@ -2916,10 +3904,12 @@ export default class Client extends OpenApi {
2916
3904
  * Updates the configuration of a specified custom agent in a workspace and executes the update asynchronously. Omitted top-level fields retain their original configurations. You can call the GetCustomAgent operation to query the update result.
2917
3905
  *
2918
3906
  * @remarks
2919
- * Specify at least one top-level field to update. Omitted top-level fields retain their original configurations. When providing a configuration object, specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced as a whole. Pass an empty array [] to clear a list. The agenticFsMounts field does not accept null. Pass null for the description field to clear the description, and pass null for the healthCheck field to remove the health check.
2920
- * When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field. Currently, only ACR container image deployment is supported. Omit the artifact.code field.
2921
- * When providing the runtime field, both compute and sessionPolicy must be present. If you omit hpa or any of its fields, unspecified elastic configurations use default values. To retain the original elastic configurations, provide them all. When providing the network field, omitted access items are treated as allowed, but actual access is still subject to the workspace network restrictions. To retain the original restrictions, provide both accessInternet and accessVpc. When providing healthCheck, you must specify the port field, and other unspecified items use default values. When providing logging.sls, you must specify both project and logstore.
2922
- * The update is an asynchronous process. A successful response indicates that the request is accepted. You can call the GetCustomAgent operation to query latestSpecVersion, latestVersionStatus, and latestExecutionError, and check the status field to confirm the update result.
3907
+ * Provide at least one top-level field to update. Omitted top-level fields retain their original configurations. When providing a configuration object, specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced as a whole. Pass an empty array [] to clear a list. The agenticFsMounts field does not accept null. Pass null for the description field to clear the description, and pass null for the healthCheck field to remove the health check.
3908
+ * When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field.
3909
+ * In code package pattern, specify artifact.port and the sourceUri, languageRuntime, and entrypoint fields of artifact.code. Do not specify the container field at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported, and the compressed package size cannot exceed 500,000,000 bytes. Query the runtime environment identity by calling the ListAgentCodeRuntimes operation. The sourceUri field supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, first call the GetAgentCodePackageUploadUrl operation to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
3910
+ * When submitting a new code package source, the backend rechecks read permissions, objects, and sizes. The configuration is saved only after the transfer succeeds. If the transfer fails, the current configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not indicate that the agent is ready to run.
3911
+ * When providing the runtime field, the compute and sessionPolicy fields must be provided at the same time. If the hpa field or its subfields are omitted, unspecified elastic configurations use default values. To retain the original elastic configurations, provide them together. When providing the network field, omitted access items are treated as allowed, but actual access is still restricted by the workspace network configurations. To retain the original restrictions, provide both accessInternet and accessVpc. When providing the healthCheck field, the port field is required, and other unspecified items use default values. When providing the logging.sls field, both project and logstore must be specified.
3912
+ * The update is an asynchronous process. A successful response indicates that the request is accepted. Call the GetCustomAgent operation to query latestSpecVersion, latestVersionStatus, and latestExecutionError, and check the status field to confirm the update result.
2923
3913
  * The clientToken field currently does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold field for health checks currently does not take effect. Omit this field.
2924
3914
  *
2925
3915
  * @param request - UpdateCustomAgentRequest
@@ -2951,7 +3941,21 @@ export default class Client extends OpenApi {
2951
3941
  */
2952
3942
  updateExternalAgent(workspaceId: string, agentId: string, request: $_model.UpdateExternalAgentRequest): Promise<$_model.UpdateExternalAgentResponse>;
2953
3943
  /**
2954
- * Updates the login toggle, member synchronization toggle, or application configuration of a specified external identity provider in a workspace. Unspecified properties remain unchanged. The update is an asynchronous operation. After the API returns, you can call GetIdentityProvider to query the status and track progress.
3944
+ * Modifies the logon configuration of a bound identity provider in a specified workspace. DingTalk and Lark support logon switches, incremental synchronization switches, application configurations, and synchronization scopes. CustomSSO supports SAML configurations and logon switches. Actual updates take effect asynchronously. Call GetIdentityProvider to query the status.
3945
+ *
3946
+ * @remarks
3947
+ * ### Prerequisites and update methods
3948
+ * The workspace must be bound to an identity provider of the corresponding type. For DingTalk and Lark, you must submit at least one of loginEnabled, syncEnabled, metadata, and syncScope. protocol and saml are not accepted. For CustomSSO, use protocol, saml, and loginEnabled. metadata, syncEnabled, and syncScope are not accepted. The SCIM synchronization switch is managed separately through UpdateIdentityProviderSCIM.
3949
+ * ### DingTalk and Lark
3950
+ * The metadata is merged by field. Submit only the fields that need to be updated. Omitted fields and existing keys remain unchanged. Explicitly submitting null, empty strings, or blank strings will be rejected. The server validates the complete configuration after merging. When incremental synchronization is enabled, the merged configuration must include encryptKey and verificationToken.
3951
+ * syncEnabled controls subsequent address book change events and does not control the initial synchronization or manual synchronization. syncScope applies only to DingTalk and Lark. If it is omitted or set to null, the current scope is retained. Saving the scope does not automatically trigger a full synchronization. To perform manual synchronization, call CreateIdentityProviderSyncJob after saving and waiting for the identity provider to be ready, and then call GetIdentityProviderSyncJob to query the task result.
3952
+ * ### Custom SAML identity provider
3953
+ * CustomSSO currently supports only SAML. The saml parameter supports two mutually exclusive methods: providing metadataXml, or providing the four manual configuration fields: entityId, loginUrl, bindingType, and x509Certificates.
3954
+ * metadataXml is a single IdP EntityDescriptor XML text of up to 1 MiB, not a URL or file path. DTDs and external entities are prohibited. For manual configuration, entityId must be non-empty and up to 2,048 characters, and cannot be changed after saving. loginUrl must be an absolute HTTPS URL without user credentials and fragments. bindingType must be HTTP-Redirect or HTTP-POST. Certificates must be valid X.509 signing certificates, with a maximum of 10 certificates.
3955
+ * jitProvisionEnabled controls the automatic creation of users during the initial logon, and jitUpdateEnabled controls whether user information is updated during logon. Omitting these switches during an update retains the existing values. Modifying only the JIT switches also requires an existing valid SAML configuration. Saving the SAML configuration does not automatically enable logon. A valid configuration must exist before enabling logon. Setting loginEnabled to false only triggers a shutdown of logon and does not delete the saved SAML or SCIM configurations.
3956
+ * ### Asynchronous results and retries
3957
+ * When actual changes exist, the expected configuration and the UPDATING status of the identity provider are returned. The CONFIGURED status may also be returned when resource configurations are restored. Call GetIdentityProvider to wait for the READY status. If the operation fails, check for statuses such as UPDATE_FAILED. If the configuration is identical and no restoration is required, the current binding may be returned directly without generating a new task. A successful HTTP request does not indicate that the background task or upstream configuration has taken effect.
3958
+ * Operation conflicts occur when in-flight operations exist. If a submission times out, query the configuration and status before deciding whether to retry. The status parameter describes the status of the identity provider resource and logon configuration. The SCIM operation results for CustomSSO must be queried through GetIdentityProviderSCIM and cannot be inferred from this operation.
2955
3959
  *
2956
3960
  * @param tmpReq - UpdateIdentityProviderRequest
2957
3961
  * @param headers - map
@@ -2962,12 +3966,106 @@ export default class Client extends OpenApi {
2962
3966
  [key: string]: string;
2963
3967
  }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateIdentityProviderResponse>;
2964
3968
  /**
2965
- * Updates the login toggle, member synchronization toggle, or application configuration of a specified external identity provider in a workspace. Unspecified properties remain unchanged. The update is an asynchronous operation. After the API returns, you can call GetIdentityProvider to query the status and track progress.
3969
+ * Modifies the logon configuration of a bound identity provider in a specified workspace. DingTalk and Lark support logon switches, incremental synchronization switches, application configurations, and synchronization scopes. CustomSSO supports SAML configurations and logon switches. Actual updates take effect asynchronously. Call GetIdentityProvider to query the status.
3970
+ *
3971
+ * @remarks
3972
+ * ### Prerequisites and update methods
3973
+ * The workspace must be bound to an identity provider of the corresponding type. For DingTalk and Lark, you must submit at least one of loginEnabled, syncEnabled, metadata, and syncScope. protocol and saml are not accepted. For CustomSSO, use protocol, saml, and loginEnabled. metadata, syncEnabled, and syncScope are not accepted. The SCIM synchronization switch is managed separately through UpdateIdentityProviderSCIM.
3974
+ * ### DingTalk and Lark
3975
+ * The metadata is merged by field. Submit only the fields that need to be updated. Omitted fields and existing keys remain unchanged. Explicitly submitting null, empty strings, or blank strings will be rejected. The server validates the complete configuration after merging. When incremental synchronization is enabled, the merged configuration must include encryptKey and verificationToken.
3976
+ * syncEnabled controls subsequent address book change events and does not control the initial synchronization or manual synchronization. syncScope applies only to DingTalk and Lark. If it is omitted or set to null, the current scope is retained. Saving the scope does not automatically trigger a full synchronization. To perform manual synchronization, call CreateIdentityProviderSyncJob after saving and waiting for the identity provider to be ready, and then call GetIdentityProviderSyncJob to query the task result.
3977
+ * ### Custom SAML identity provider
3978
+ * CustomSSO currently supports only SAML. The saml parameter supports two mutually exclusive methods: providing metadataXml, or providing the four manual configuration fields: entityId, loginUrl, bindingType, and x509Certificates.
3979
+ * metadataXml is a single IdP EntityDescriptor XML text of up to 1 MiB, not a URL or file path. DTDs and external entities are prohibited. For manual configuration, entityId must be non-empty and up to 2,048 characters, and cannot be changed after saving. loginUrl must be an absolute HTTPS URL without user credentials and fragments. bindingType must be HTTP-Redirect or HTTP-POST. Certificates must be valid X.509 signing certificates, with a maximum of 10 certificates.
3980
+ * jitProvisionEnabled controls the automatic creation of users during the initial logon, and jitUpdateEnabled controls whether user information is updated during logon. Omitting these switches during an update retains the existing values. Modifying only the JIT switches also requires an existing valid SAML configuration. Saving the SAML configuration does not automatically enable logon. A valid configuration must exist before enabling logon. Setting loginEnabled to false only triggers a shutdown of logon and does not delete the saved SAML or SCIM configurations.
3981
+ * ### Asynchronous results and retries
3982
+ * When actual changes exist, the expected configuration and the UPDATING status of the identity provider are returned. The CONFIGURED status may also be returned when resource configurations are restored. Call GetIdentityProvider to wait for the READY status. If the operation fails, check for statuses such as UPDATE_FAILED. If the configuration is identical and no restoration is required, the current binding may be returned directly without generating a new task. A successful HTTP request does not indicate that the background task or upstream configuration has taken effect.
3983
+ * Operation conflicts occur when in-flight operations exist. If a submission times out, query the configuration and status before deciding whether to retry. The status parameter describes the status of the identity provider resource and logon configuration. The SCIM operation results for CustomSSO must be queried through GetIdentityProviderSCIM and cannot be inferred from this operation.
2966
3984
  *
2967
3985
  * @param request - UpdateIdentityProviderRequest
2968
3986
  * @returns UpdateIdentityProviderResponse
2969
3987
  */
2970
3988
  updateIdentityProvider(workspaceId: string, identityProviderType: string, request: $_model.UpdateIdentityProviderRequest): Promise<$_model.UpdateIdentityProviderResponse>;
3989
+ /**
3990
+ * Enables or disables SCIM user synchronization independently. When enabled, the initial full import is executed asynchronously. You can query the result by calling GetIdentityProviderSCIM. The SAML logon configuration is retained.
3991
+ *
3992
+ * @remarks
3993
+ * ## Features and prerequisites
3994
+ * The syncEnabled parameter is required. If you set this parameter to true, a task is submitted to independently enable SCIM and perform the initial full user import. During execution, the AgentIdentity receiving status must be Enabled, and an enabled and unexpired credential must exist. Therefore, you must first call the prepare operation and complete the URL and token configuration in the external system. If you set this parameter to false, a task is submitted to disable synchronization and upstream receiving. Existing users, credentials, and SAML logon configurations are retained. If you re-enable synchronization later and receiving is disabled, you must call the prepare operation again.
3995
+ * Request acceptance only saves the expected switch status in AC and submits the task. The returned data is still the shared binding and does not contain the SCIM taskId. The status is not overwritten by this task and may be READY or UPDATE_FAILED from a previous logon task. Neither can be used to determine the success or failure of SCIM. Query GetIdentityProviderSCIM.operationStatus to wait for the result. Prerequisite checks for enabling are executed within the task. If the prerequisites are not met, you may receive a successful request response first, and then operationStatus=FAILED. A failure does not automatically roll back the expected switch status.
3996
+ * SCIM does not depend on SAML configuration and does not affect the SAML status or switch. A successful task and a successful full import of empty users do not prove that continuous incremental synchronization is healthy. Whether users exist depends on whether the external system has actually pre-provisioned them.
3997
+ * ## Requests and examples
3998
+ * PUT /workspaces/{workspaceId}/scim-provisioning
3999
+ * Call conventions: Call the API in the region of the target workspace by using an AK/STS identity that has permissions on the identity provider resources of the corresponding workspace. In the following examples, ws-example, URL, certificate, and Token are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API, not the additional body wrapper of the backend direct connection API. The response example only shows the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
4000
+ * ```text
4001
+ * PUT /workspaces/ws-example/scim-provisioning
4002
+ * {"syncEnabled": true}
4003
+ * To disable: {"syncEnabled": false}
4004
+ * ```
4005
+ * ## Response example
4006
+ * ```json
4007
+ * {
4008
+ * "data": {
4009
+ * "workspaceId": "ws-example",
4010
+ * "identityProviderType": "CustomSSO",
4011
+ * "status": "READY",
4012
+ * "loginEnabled": false,
4013
+ * "syncEnabled": true
4014
+ * }
4015
+ * }
4016
+ * ```
4017
+ * ## Errors and handling
4018
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. A synchronous call to the upstream system that fails may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
4019
+ * 400 InvalidParameter: syncEnabled is missing. 404 IdentityProviderNotFound: No CustomSSO binding exists. 409 IdentityProviderOperationConflict: The user pool is not ready, is being unbound, failed to unbind, or has a concurrent status conflict. Upstream not being enabled or having no valid credentials may manifest as an asynchronous FAILED after acceptance. You cannot only handle HTTP errors.
4020
+ * ## Call relationships and usage boundaries
4021
+ * The call example for enabling is body={"syncEnabled":true}, and for disabling is body={"syncEnabled":false}. This API returns a snapshot of the shared binding, and its status is not the status of this SCIM task. After acceptance, use GetIdentityProviderSCIM to query operationStatus. Pre-provisioning tests or user assignments for external IdPs must still be completed in the external system. AC does not configure external IdPs for users.
4022
+ *
4023
+ * @param tmpReq - UpdateIdentityProviderSCIMRequest
4024
+ * @param headers - map
4025
+ * @param runtime - runtime options for this request RuntimeOptions
4026
+ * @returns UpdateIdentityProviderSCIMResponse
4027
+ */
4028
+ updateIdentityProviderSCIMWithOptions(workspaceId: string, tmpReq: $_model.UpdateIdentityProviderSCIMRequest, headers: {
4029
+ [key: string]: string;
4030
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateIdentityProviderSCIMResponse>;
4031
+ /**
4032
+ * Enables or disables SCIM user synchronization independently. When enabled, the initial full import is executed asynchronously. You can query the result by calling GetIdentityProviderSCIM. The SAML logon configuration is retained.
4033
+ *
4034
+ * @remarks
4035
+ * ## Features and prerequisites
4036
+ * The syncEnabled parameter is required. If you set this parameter to true, a task is submitted to independently enable SCIM and perform the initial full user import. During execution, the AgentIdentity receiving status must be Enabled, and an enabled and unexpired credential must exist. Therefore, you must first call the prepare operation and complete the URL and token configuration in the external system. If you set this parameter to false, a task is submitted to disable synchronization and upstream receiving. Existing users, credentials, and SAML logon configurations are retained. If you re-enable synchronization later and receiving is disabled, you must call the prepare operation again.
4037
+ * Request acceptance only saves the expected switch status in AC and submits the task. The returned data is still the shared binding and does not contain the SCIM taskId. The status is not overwritten by this task and may be READY or UPDATE_FAILED from a previous logon task. Neither can be used to determine the success or failure of SCIM. Query GetIdentityProviderSCIM.operationStatus to wait for the result. Prerequisite checks for enabling are executed within the task. If the prerequisites are not met, you may receive a successful request response first, and then operationStatus=FAILED. A failure does not automatically roll back the expected switch status.
4038
+ * SCIM does not depend on SAML configuration and does not affect the SAML status or switch. A successful task and a successful full import of empty users do not prove that continuous incremental synchronization is healthy. Whether users exist depends on whether the external system has actually pre-provisioned them.
4039
+ * ## Requests and examples
4040
+ * PUT /workspaces/{workspaceId}/scim-provisioning
4041
+ * Call conventions: Call the API in the region of the target workspace by using an AK/STS identity that has permissions on the identity provider resources of the corresponding workspace. In the following examples, ws-example, URL, certificate, and Token are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API, not the additional body wrapper of the backend direct connection API. The response example only shows the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
4042
+ * ```text
4043
+ * PUT /workspaces/ws-example/scim-provisioning
4044
+ * {"syncEnabled": true}
4045
+ * To disable: {"syncEnabled": false}
4046
+ * ```
4047
+ * ## Response example
4048
+ * ```json
4049
+ * {
4050
+ * "data": {
4051
+ * "workspaceId": "ws-example",
4052
+ * "identityProviderType": "CustomSSO",
4053
+ * "status": "READY",
4054
+ * "loginEnabled": false,
4055
+ * "syncEnabled": true
4056
+ * }
4057
+ * }
4058
+ * ```
4059
+ * ## Errors and handling
4060
+ * Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. A synchronous call to the upstream system that fails may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
4061
+ * 400 InvalidParameter: syncEnabled is missing. 404 IdentityProviderNotFound: No CustomSSO binding exists. 409 IdentityProviderOperationConflict: The user pool is not ready, is being unbound, failed to unbind, or has a concurrent status conflict. Upstream not being enabled or having no valid credentials may manifest as an asynchronous FAILED after acceptance. You cannot only handle HTTP errors.
4062
+ * ## Call relationships and usage boundaries
4063
+ * The call example for enabling is body={"syncEnabled":true}, and for disabling is body={"syncEnabled":false}. This API returns a snapshot of the shared binding, and its status is not the status of this SCIM task. After acceptance, use GetIdentityProviderSCIM to query operationStatus. Pre-provisioning tests or user assignments for external IdPs must still be completed in the external system. AC does not configure external IdPs for users.
4064
+ *
4065
+ * @param request - UpdateIdentityProviderSCIMRequest
4066
+ * @returns UpdateIdentityProviderSCIMResponse
4067
+ */
4068
+ updateIdentityProviderSCIM(workspaceId: string, request: $_model.UpdateIdentityProviderSCIMRequest): Promise<$_model.UpdateIdentityProviderSCIMResponse>;
2971
4069
  /**
2972
4070
  * Updates the configuration of a specified managed agent.
2973
4071
  *
@@ -3037,10 +4135,10 @@ export default class Client extends OpenApi {
3037
4135
  */
3038
4136
  updateMcpTemplateConfig(workspaceId: string, mcpServerId: string, request: $_model.UpdateMcpTemplateConfigRequest): Promise<$_model.UpdateMcpTemplateConfigResponse>;
3039
4137
  /**
3040
- * Updates the long-term memory text or metadata based on the memory ID.
4138
+ * Updates the text or metadata of a long-term memory based on the memory ID.
3041
4139
  *
3042
4140
  * @remarks
3043
- * Updates the long-term memory text or metadata based on the memory ID.
4141
+ * Updates the text or metadata of a long-term memory based on the memory ID.
3044
4142
  *
3045
4143
  * @param tmpReq - UpdateMemoryRequest
3046
4144
  * @param headers - map
@@ -3051,10 +4149,10 @@ export default class Client extends OpenApi {
3051
4149
  [key: string]: string;
3052
4150
  }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateMemoryResponse>;
3053
4151
  /**
3054
- * Updates the long-term memory text or metadata based on the memory ID.
4152
+ * Updates the text or metadata of a long-term memory based on the memory ID.
3055
4153
  *
3056
4154
  * @remarks
3057
- * Updates the long-term memory text or metadata based on the memory ID.
4155
+ * Updates the text or metadata of a long-term memory based on the memory ID.
3058
4156
  *
3059
4157
  * @param request - UpdateMemoryRequest
3060
4158
  * @returns UpdateMemoryResponse
@@ -3320,6 +4418,58 @@ export default class Client extends OpenApi {
3320
4418
  * @returns UploadSkillViaOssResponse
3321
4419
  */
3322
4420
  uploadSkillViaOss(workspaceId: string, request: $_model.UploadSkillViaOssRequest): Promise<$_model.UploadSkillViaOssResponse>;
4421
+ /**
4422
+ * Validates the OSS code package source for an agent.
4423
+ *
4424
+ * @remarks
4425
+ * Uses the current workspace role to check whether the customer\\"s OSS object exists and is readable, and checks the file name extension and compressed size. Returns the sourceUri, file name, size, and format read in this request. The bucket and object key are passed separately, and HTTPS download URLs are not accepted.
4426
+ * The validation uses object metadata and read probing. It does not perform full downloads, transfers, or decompression, nor does it generate a SHA-256 hash. Passing the validation does not mean that the archive content is complete or can be started. When you submit a CreateCustomAgent or UpdateCustomAgent request, the system re-validates and transfers the package. You do not need to invoke this operation in advance as a prerequisite for submission.
4427
+ *
4428
+ * @param tmpReq - ValidateAgentCodePackageFromOssRequest
4429
+ * @param headers - map
4430
+ * @param runtime - runtime options for this request RuntimeOptions
4431
+ * @returns ValidateAgentCodePackageFromOssResponse
4432
+ */
4433
+ validateAgentCodePackageFromOssWithOptions(workspaceId: string, tmpReq: $_model.ValidateAgentCodePackageFromOssRequest, headers: {
4434
+ [key: string]: string;
4435
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.ValidateAgentCodePackageFromOssResponse>;
4436
+ /**
4437
+ * Validates the OSS code package source for an agent.
4438
+ *
4439
+ * @remarks
4440
+ * Uses the current workspace role to check whether the customer\\"s OSS object exists and is readable, and checks the file name extension and compressed size. Returns the sourceUri, file name, size, and format read in this request. The bucket and object key are passed separately, and HTTPS download URLs are not accepted.
4441
+ * The validation uses object metadata and read probing. It does not perform full downloads, transfers, or decompression, nor does it generate a SHA-256 hash. Passing the validation does not mean that the archive content is complete or can be started. When you submit a CreateCustomAgent or UpdateCustomAgent request, the system re-validates and transfers the package. You do not need to invoke this operation in advance as a prerequisite for submission.
4442
+ *
4443
+ * @param request - ValidateAgentCodePackageFromOssRequest
4444
+ * @returns ValidateAgentCodePackageFromOssResponse
4445
+ */
4446
+ validateAgentCodePackageFromOss(workspaceId: string, request: $_model.ValidateAgentCodePackageFromOssRequest): Promise<$_model.ValidateAgentCodePackageFromOssResponse>;
4447
+ /**
4448
+ * Checks the OSS RAM authorization status of the agent code package.
4449
+ *
4450
+ * @remarks
4451
+ * Queries the binding status of the authorization policy for a specified source bucket to the current workspace role. AUTHORIZED indicates that the policy is bound. UNAUTHORIZED indicates that the policy is not bound. A bound policy does not indicate that a specific code package object exists or is readable.
4452
+ * To check a specific object, call ValidateAgentCodePackageFromOss. This operation does not copy code packages or modify the default OSS binding of the workspace.
4453
+ *
4454
+ * @param request - VerifyAgentCodePackageOssRamAuthorizationRequest
4455
+ * @param headers - map
4456
+ * @param runtime - runtime options for this request RuntimeOptions
4457
+ * @returns VerifyAgentCodePackageOssRamAuthorizationResponse
4458
+ */
4459
+ verifyAgentCodePackageOssRamAuthorizationWithOptions(workspaceId: string, request: $_model.VerifyAgentCodePackageOssRamAuthorizationRequest, headers: {
4460
+ [key: string]: string;
4461
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.VerifyAgentCodePackageOssRamAuthorizationResponse>;
4462
+ /**
4463
+ * Checks the OSS RAM authorization status of the agent code package.
4464
+ *
4465
+ * @remarks
4466
+ * Queries the binding status of the authorization policy for a specified source bucket to the current workspace role. AUTHORIZED indicates that the policy is bound. UNAUTHORIZED indicates that the policy is not bound. A bound policy does not indicate that a specific code package object exists or is readable.
4467
+ * To check a specific object, call ValidateAgentCodePackageFromOss. This operation does not copy code packages or modify the default OSS binding of the workspace.
4468
+ *
4469
+ * @param request - VerifyAgentCodePackageOssRamAuthorizationRequest
4470
+ * @returns VerifyAgentCodePackageOssRamAuthorizationResponse
4471
+ */
4472
+ verifyAgentCodePackageOssRamAuthorization(workspaceId: string, request: $_model.VerifyAgentCodePackageOssRamAuthorizationRequest): Promise<$_model.VerifyAgentCodePackageOssRamAuthorizationResponse>;
3323
4473
  /**
3324
4474
  * Validates whether one or more Qoder Service Account Keys are available at a specified site. This operation does not save keys or modify the Connector status.
3325
4475
  *