@alicloud/agentcore20260804 2.6.0 → 3.0.1

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 (144) hide show
  1. package/dist/client.d.ts +577 -119
  2. package/dist/client.js +729 -123
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateIdentityProviderRequest.d.ts +6 -6
  5. package/dist/models/CreateIdentityProviderResponseBody.d.ts +20 -52
  6. package/dist/models/CreateIdentityProviderResponseBody.js +0 -8
  7. package/dist/models/CreateIdentityProviderResponseBody.js.map +1 -1
  8. package/dist/models/CreateIdentityProviderScimcredentialRequest.d.ts +13 -0
  9. package/dist/models/CreateIdentityProviderScimcredentialRequest.js +54 -0
  10. package/dist/models/CreateIdentityProviderScimcredentialRequest.js.map +1 -0
  11. package/dist/models/CreateIdentityProviderScimcredentialResponse.d.ts +19 -0
  12. package/dist/models/CreateIdentityProviderScimcredentialResponse.js +69 -0
  13. package/dist/models/CreateIdentityProviderScimcredentialResponse.js.map +1 -0
  14. package/dist/models/CreateIdentityProviderScimcredentialResponseBody.d.ts +157 -0
  15. package/dist/models/CreateIdentityProviderScimcredentialResponseBody.js +146 -0
  16. package/dist/models/CreateIdentityProviderScimcredentialResponseBody.js.map +1 -0
  17. package/dist/models/CreateWorkspaceRequest.d.ts +23 -7
  18. package/dist/models/CreateWorkspaceRequest.js +4 -0
  19. package/dist/models/CreateWorkspaceRequest.js.map +1 -1
  20. package/dist/models/CreateWorkspaceResponseBody.d.ts +11 -11
  21. package/dist/models/CreateWorkspaceShrinkRequest.d.ts +1 -1
  22. package/dist/models/DeleteIdentityProviderResponseBody.d.ts +15 -47
  23. package/dist/models/DeleteIdentityProviderResponseBody.js +0 -8
  24. package/dist/models/DeleteIdentityProviderResponseBody.js.map +1 -1
  25. package/dist/models/DeleteIdentityProviderScimcredentialRequest.d.ts +13 -0
  26. package/dist/models/DeleteIdentityProviderScimcredentialRequest.js +54 -0
  27. package/dist/models/DeleteIdentityProviderScimcredentialRequest.js.map +1 -0
  28. package/dist/models/DeleteIdentityProviderScimcredentialResponse.d.ts +19 -0
  29. package/dist/models/DeleteIdentityProviderScimcredentialResponse.js +69 -0
  30. package/dist/models/DeleteIdentityProviderScimcredentialResponse.js.map +1 -0
  31. package/dist/models/DeleteIdentityProviderScimcredentialResponseBody.d.ts +50 -0
  32. package/dist/models/DeleteIdentityProviderScimcredentialResponseBody.js +66 -0
  33. package/dist/models/DeleteIdentityProviderScimcredentialResponseBody.js.map +1 -0
  34. package/dist/models/GetIdentityProviderResponseBody.d.ts +23 -55
  35. package/dist/models/GetIdentityProviderResponseBody.js +0 -8
  36. package/dist/models/GetIdentityProviderResponseBody.js.map +1 -1
  37. package/dist/models/GetIdentityProviderScimrequest.d.ts +13 -0
  38. package/dist/models/GetIdentityProviderScimrequest.js +54 -0
  39. package/dist/models/GetIdentityProviderScimrequest.js.map +1 -0
  40. package/dist/models/GetIdentityProviderScimresponse.d.ts +19 -0
  41. package/dist/models/GetIdentityProviderScimresponse.js +69 -0
  42. package/dist/models/GetIdentityProviderScimresponse.js.map +1 -0
  43. package/dist/models/GetIdentityProviderScimresponseBody.d.ts +131 -0
  44. package/dist/models/GetIdentityProviderScimresponseBody.js +120 -0
  45. package/dist/models/GetIdentityProviderScimresponseBody.js.map +1 -0
  46. package/dist/models/GetIdentityProviderServiceProviderRequest.d.ts +23 -0
  47. package/dist/models/GetIdentityProviderServiceProviderRequest.js +58 -0
  48. package/dist/models/GetIdentityProviderServiceProviderRequest.js.map +1 -0
  49. package/dist/models/GetIdentityProviderServiceProviderResponse.d.ts +19 -0
  50. package/dist/models/GetIdentityProviderServiceProviderResponse.js +69 -0
  51. package/dist/models/GetIdentityProviderServiceProviderResponse.js.map +1 -0
  52. package/dist/models/GetIdentityProviderServiceProviderResponseBody.d.ts +99 -0
  53. package/dist/models/GetIdentityProviderServiceProviderResponseBody.js +96 -0
  54. package/dist/models/GetIdentityProviderServiceProviderResponseBody.js.map +1 -0
  55. package/dist/models/ListIdentityProviderDepartmentsRequest.d.ts +2 -2
  56. package/dist/models/ListIdentityProviderDepartmentsResponseBody.d.ts +9 -9
  57. package/dist/models/ListIdentityProviderScimcredentialsRequest.d.ts +13 -0
  58. package/dist/models/ListIdentityProviderScimcredentialsRequest.js +54 -0
  59. package/dist/models/ListIdentityProviderScimcredentialsRequest.js.map +1 -0
  60. package/dist/models/ListIdentityProviderScimcredentialsResponse.d.ts +19 -0
  61. package/dist/models/ListIdentityProviderScimcredentialsResponse.js +69 -0
  62. package/dist/models/ListIdentityProviderScimcredentialsResponse.js.map +1 -0
  63. package/dist/models/ListIdentityProviderScimcredentialsResponseBody.d.ts +99 -0
  64. package/dist/models/ListIdentityProviderScimcredentialsResponseBody.js +96 -0
  65. package/dist/models/ListIdentityProviderScimcredentialsResponseBody.js.map +1 -0
  66. package/dist/models/ListIdentityProvidersRequest.d.ts +2 -2
  67. package/dist/models/ListIdentityProvidersResponseBody.d.ts +25 -69
  68. package/dist/models/ListIdentityProvidersResponseBody.js +0 -8
  69. package/dist/models/ListIdentityProvidersResponseBody.js.map +1 -1
  70. package/dist/models/PrepareIdentityProviderScimrequest.d.ts +13 -0
  71. package/dist/models/PrepareIdentityProviderScimrequest.js +54 -0
  72. package/dist/models/PrepareIdentityProviderScimrequest.js.map +1 -0
  73. package/dist/models/PrepareIdentityProviderScimresponse.d.ts +19 -0
  74. package/dist/models/PrepareIdentityProviderScimresponse.js +69 -0
  75. package/dist/models/PrepareIdentityProviderScimresponse.js.map +1 -0
  76. package/dist/models/PrepareIdentityProviderScimresponseBody.d.ts +157 -0
  77. package/dist/models/PrepareIdentityProviderScimresponseBody.js +146 -0
  78. package/dist/models/PrepareIdentityProviderScimresponseBody.js.map +1 -0
  79. package/dist/models/UpdateIdentityProviderRequest.d.ts +20 -39
  80. package/dist/models/UpdateIdentityProviderRequest.js +0 -4
  81. package/dist/models/UpdateIdentityProviderRequest.js.map +1 -1
  82. package/dist/models/UpdateIdentityProviderResponseBody.d.ts +35 -60
  83. package/dist/models/UpdateIdentityProviderResponseBody.js +0 -8
  84. package/dist/models/UpdateIdentityProviderResponseBody.js.map +1 -1
  85. package/dist/models/UpdateIdentityProviderScimrequest.d.ts +39 -0
  86. package/dist/models/UpdateIdentityProviderScimrequest.js +80 -0
  87. package/dist/models/UpdateIdentityProviderScimrequest.js.map +1 -0
  88. package/dist/models/UpdateIdentityProviderScimresponse.d.ts +19 -0
  89. package/dist/models/UpdateIdentityProviderScimresponse.js +69 -0
  90. package/dist/models/UpdateIdentityProviderScimresponse.js.map +1 -0
  91. package/dist/models/UpdateIdentityProviderScimresponseBody.d.ts +304 -0
  92. package/dist/models/UpdateIdentityProviderScimresponseBody.js +205 -0
  93. package/dist/models/UpdateIdentityProviderScimresponseBody.js.map +1 -0
  94. package/dist/models/UpdateIdentityProviderScimshrinkRequest.d.ts +20 -0
  95. package/dist/models/UpdateIdentityProviderScimshrinkRequest.js +58 -0
  96. package/dist/models/UpdateIdentityProviderScimshrinkRequest.js.map +1 -0
  97. package/dist/models/UpdateIdentityProviderShrinkRequest.d.ts +1 -1
  98. package/dist/models/VerifyAgentCodePackageOssRamAuthorizationRequest.d.ts +1 -1
  99. package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.d.ts +28 -2
  100. package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.js.map +1 -1
  101. package/dist/models/model.d.ts +37 -0
  102. package/dist/models/model.js +100 -25
  103. package/dist/models/model.js.map +1 -1
  104. package/package.json +1 -1
  105. package/src/client.ts +746 -123
  106. package/src/models/CreateIdentityProviderRequest.ts +6 -6
  107. package/src/models/CreateIdentityProviderResponseBody.ts +20 -60
  108. package/src/models/CreateIdentityProviderScimcredentialRequest.ts +24 -0
  109. package/src/models/CreateIdentityProviderScimcredentialResponse.ts +40 -0
  110. package/src/models/CreateIdentityProviderScimcredentialResponseBody.ts +231 -0
  111. package/src/models/CreateWorkspaceRequest.ts +27 -7
  112. package/src/models/CreateWorkspaceResponseBody.ts +11 -11
  113. package/src/models/CreateWorkspaceShrinkRequest.ts +1 -1
  114. package/src/models/DeleteIdentityProviderResponseBody.ts +15 -55
  115. package/src/models/DeleteIdentityProviderScimcredentialRequest.ts +24 -0
  116. package/src/models/DeleteIdentityProviderScimcredentialResponse.ts +40 -0
  117. package/src/models/DeleteIdentityProviderScimcredentialResponseBody.ts +71 -0
  118. package/src/models/GetIdentityProviderResponseBody.ts +23 -63
  119. package/src/models/GetIdentityProviderScimrequest.ts +24 -0
  120. package/src/models/GetIdentityProviderScimresponse.ts +40 -0
  121. package/src/models/GetIdentityProviderScimresponseBody.ts +188 -0
  122. package/src/models/GetIdentityProviderServiceProviderRequest.ts +36 -0
  123. package/src/models/GetIdentityProviderServiceProviderResponse.ts +40 -0
  124. package/src/models/GetIdentityProviderServiceProviderResponseBody.ts +141 -0
  125. package/src/models/ListIdentityProviderDepartmentsRequest.ts +2 -2
  126. package/src/models/ListIdentityProviderDepartmentsResponseBody.ts +9 -9
  127. package/src/models/ListIdentityProviderScimcredentialsRequest.ts +24 -0
  128. package/src/models/ListIdentityProviderScimcredentialsResponse.ts +40 -0
  129. package/src/models/ListIdentityProviderScimcredentialsResponseBody.ts +141 -0
  130. package/src/models/ListIdentityProvidersRequest.ts +2 -2
  131. package/src/models/ListIdentityProvidersResponseBody.ts +25 -77
  132. package/src/models/PrepareIdentityProviderScimrequest.ts +24 -0
  133. package/src/models/PrepareIdentityProviderScimresponse.ts +40 -0
  134. package/src/models/PrepareIdentityProviderScimresponseBody.ts +231 -0
  135. package/src/models/UpdateIdentityProviderRequest.ts +20 -43
  136. package/src/models/UpdateIdentityProviderResponseBody.ts +35 -68
  137. package/src/models/UpdateIdentityProviderScimrequest.ts +65 -0
  138. package/src/models/UpdateIdentityProviderScimresponse.ts +40 -0
  139. package/src/models/UpdateIdentityProviderScimresponseBody.ts +428 -0
  140. package/src/models/UpdateIdentityProviderScimshrinkRequest.ts +33 -0
  141. package/src/models/UpdateIdentityProviderShrinkRequest.ts +1 -1
  142. package/src/models/VerifyAgentCodePackageOssRamAuthorizationRequest.ts +1 -1
  143. package/src/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.ts +28 -2
  144. package/src/models/model.ts +37 -0
package/dist/client.d.ts CHANGED
@@ -283,15 +283,15 @@ export default class Client extends OpenApi {
283
283
  */
284
284
  createExternalAgentBootstrapToken(workspaceId: string, agentId: string, request: $_model.CreateExternalAgentBootstrapTokenRequest): Promise<$_model.CreateExternalAgentBootstrapTokenResponse>;
285
285
  /**
286
- * Binds an external identity provider to a specified workspace for single sign-on and organization member synchronization of workspace users. You can bind up to one external identity provider to each workspace. The binding is an asynchronous operation. After the API 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
287
  *
288
288
  * @remarks
289
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. You do not need to save SAML first. 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 can be returned. You cannot treat all states as repeatable creations.
291
- * For DingTalk, the metadata parameter requires appKey, appSecret, and corpId. For Feishu, appId and appSecret are required. The vendor logon switch is enabled by default, and 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.
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
292
  * ## Requests and examples
293
293
  * POST /workspaces/{workspaceId}/identity-providers
294
- * Call conventions: Call the API based on the region of the target workspace. Use an AccessKey pair or STS token that has permissions on the identity provider resources of the corresponding workspace. 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, not the extra 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. Keep 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.
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
295
  * ```text
296
296
  * POST /workspaces/ws-example/identity-providers
297
297
  * {"identityProviderType": "CustomSSO"}
@@ -309,7 +309,7 @@ export default class Client extends OpenApi {
309
309
  * }
310
310
  * ```
311
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 to the upstream service may return 503 IdentityProviderProvisioningUnavailable if it fails. Keep 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.
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
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.
314
314
  *
315
315
  * @param tmpReq - CreateIdentityProviderRequest
@@ -321,15 +321,15 @@ export default class Client extends OpenApi {
321
321
  [key: string]: string;
322
322
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateIdentityProviderResponse>;
323
323
  /**
324
- * Binds an external identity provider to a specified workspace for single sign-on and organization member synchronization of workspace users. You can bind up to one external identity provider to each workspace. The binding is an asynchronous operation. After the API 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
325
  *
326
326
  * @remarks
327
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. You do not need to save SAML first. 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 can be returned. You cannot treat all states as repeatable creations.
329
- * For DingTalk, the metadata parameter requires appKey, appSecret, and corpId. For Feishu, appId and appSecret are required. The vendor logon switch is enabled by default, and 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.
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
330
  * ## Requests and examples
331
331
  * POST /workspaces/{workspaceId}/identity-providers
332
- * Call conventions: Call the API based on the region of the target workspace. Use an AccessKey pair or STS token that has permissions on the identity provider resources of the corresponding workspace. 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, not the extra 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. Keep 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.
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
333
  * ```text
334
334
  * POST /workspaces/ws-example/identity-providers
335
335
  * {"identityProviderType": "CustomSSO"}
@@ -347,13 +347,99 @@ export default class Client extends OpenApi {
347
347
  * }
348
348
  * ```
349
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 to the upstream service may return 503 IdentityProviderProvisioningUnavailable if it fails. Keep 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.
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
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.
352
352
  *
353
353
  * @param request - CreateIdentityProviderRequest
354
354
  * @returns CreateIdentityProviderResponse
355
355
  */
356
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>;
357
443
  /**
358
444
  * Initiates a manual synchronization of an identity provider.
359
445
  *
@@ -799,15 +885,15 @@ export default class Client extends OpenApi {
799
885
  */
800
886
  deleteExternalAgent(workspaceId: string, agentId: string, request: $_model.DeleteExternalAgentRequest): Promise<$_model.DeleteExternalAgentResponse>;
801
887
  /**
802
- * Disconnects the external identity provider from a specified workspace and cleans up the users synchronized by the identity provider. The disconnection is an asynchronous operation. After the API returns a response, 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.
803
889
  *
804
890
  * @remarks
805
891
  * ## Features and prerequisites
806
- * This is a complete disconnection, not just disabling logon. Disconnecting CustomSSO cleans up the AC users imported from this identity source, remote shared user pools and related resources, logon publishing configurations, and bindings. Therefore, both SAML and SCIM are affected. It does not delete the enterprise applications created by users on external platforms such as Azure. The system first checks the references between users and Teams. If references exist, the disconnection is rejected.
807
- * After the request is accepted, the system returns DISCONNECTING. You can call GetIdentityProvider to query the status. The cleanup is complete only when the binding does not exist (IdentityProviderNotFound). The binding should also no longer appear in the list. DISCONNECT_FAILED indicates that a partial cleanup may have occurred and the state cannot be restored to a brand new unconfigured state. You can retry based on the returned status. If the binding does not exist in the first place, the API 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 as a substitute for setting loginEnabled=false, syncEnabled=false, or deleting a single token.
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.
808
894
  * ## Requests and examples
809
895
  * DELETE /workspaces/{workspaceId}/identity-providers/{identityProviderType}
810
- * Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or STS credential that has permissions on the identity source resources of the workspace. 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 parameter content of the public API, not the extra 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. Keep 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.
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.
811
897
  * ```text
812
898
  * DELETE /workspaces/ws-example/identity-providers/CustomSSO
813
899
  * ```
@@ -822,8 +908,10 @@ export default class Client extends OpenApi {
822
908
  * }
823
909
  * ```
824
910
  * ## Errors and handling
825
- * 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. Keep 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.
826
- * 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. An asynchronous failure may result in a partial cleanup. You cannot claim completion based solely on the first response.
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.
827
915
  *
828
916
  * @param request - DeleteIdentityProviderRequest
829
917
  * @param headers - map
@@ -834,15 +922,15 @@ export default class Client extends OpenApi {
834
922
  [key: string]: string;
835
923
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteIdentityProviderResponse>;
836
924
  /**
837
- * Disconnects the external identity provider from a specified workspace and cleans up the users synchronized by the identity provider. The disconnection is an asynchronous operation. After the API returns a response, 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.
838
926
  *
839
927
  * @remarks
840
928
  * ## Features and prerequisites
841
- * This is a complete disconnection, not just disabling logon. Disconnecting CustomSSO cleans up the AC users imported from this identity source, remote shared user pools and related resources, logon publishing configurations, and bindings. Therefore, both SAML and SCIM are affected. It does not delete the enterprise applications created by users on external platforms such as Azure. The system first checks the references between users and Teams. If references exist, the disconnection is rejected.
842
- * After the request is accepted, the system returns DISCONNECTING. You can call GetIdentityProvider to query the status. The cleanup is complete only when the binding does not exist (IdentityProviderNotFound). The binding should also no longer appear in the list. DISCONNECT_FAILED indicates that a partial cleanup may have occurred and the state cannot be restored to a brand new unconfigured state. You can retry based on the returned status. If the binding does not exist in the first place, the API 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 as a substitute for setting loginEnabled=false, syncEnabled=false, or deleting a single token.
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.
843
931
  * ## Requests and examples
844
932
  * DELETE /workspaces/{workspaceId}/identity-providers/{identityProviderType}
845
- * Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or STS credential that has permissions on the identity source resources of the workspace. 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 parameter content of the public API, not the extra 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. Keep 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.
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.
846
934
  * ```text
847
935
  * DELETE /workspaces/ws-example/identity-providers/CustomSSO
848
936
  * ```
@@ -857,13 +945,39 @@ export default class Client extends OpenApi {
857
945
  * }
858
946
  * ```
859
947
  * ## Errors and handling
860
- * 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. Keep 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.
861
- * 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. An asynchronous failure may result in a partial cleanup. You cannot claim completion based solely on the first response.
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.
862
952
  *
863
953
  * @param request - DeleteIdentityProviderRequest
864
954
  * @returns DeleteIdentityProviderResponse
865
955
  */
866
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>;
867
981
  /**
868
982
  * Deletes an image cache.
869
983
  *
@@ -1559,19 +1673,19 @@ export default class Client extends OpenApi {
1559
1673
  */
1560
1674
  getExternalAgentBootstrapOptions(workspaceId: string, agentId: string, request: $_model.GetExternalAgentBootstrapOptionsRequest): Promise<$_model.GetExternalAgentBootstrapOptionsResponse>;
1561
1675
  /**
1562
- * Queries the binding details of an external identity provider for a specified workspace, including the binding status, application configurations, and the callback URL 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.
1563
1677
  *
1564
1678
  * @remarks
1565
1679
  * ## Features and prerequisites
1566
- * Reads existing bindings by type. For CustomSSO, the API 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. If SAML is configured, the API additionally queries AgentIdentity, and the configuration field represents the actual SSO/JIT configuration. The saml field serves as the data source for the edit form. The status switches in the configuration field are Enabled and Disabled. If the upstream query fails, an error is returned. This failure must not be treated as an unconfigured state.
1567
- * Only this API reads back the actual SAML configuration. The list and write APIs do not guarantee that the configuration field is returned. A READY user pool does not indicate that SAML is configured. The UPDATING and UPDATE_FAILED statuses describe logon configuration tasks, not SCIM tasks. The vendor callback URL for CustomSSO is empty. Use GetIdentityProviderSCIM.operationStatus to query SCIM operation results.
1568
- * ## Requests and examples
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
1569
1683
  * GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}
1570
- * Calling convention: Call this API 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, URLs, certificates, and tokens in the following examples are placeholder values and must be replaced with actual values. The request body example shows the body parameters of the public API, rather than the extra body wrapper of the backend direct-connection API. 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 log secrets. Asynchronous business tasks do not imply that the HTTP request uses a persistent connection to wait for completion.
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.
1571
1685
  * ```text
1572
1686
  * GET /workspaces/ws-example/identity-providers/CustomSSO
1573
1687
  * ```
1574
- * ## Response example
1688
+ * ## Response examples
1575
1689
  * ```json
1576
1690
  * {
1577
1691
  * "data": {
@@ -1584,8 +1698,10 @@ export default class Client extends OpenApi {
1584
1698
  * }
1585
1699
  * ```
1586
1700
  * ## Errors and handling
1587
- * Error handling: A 400 InvalidParameter error indicates that the parameters or current configuration prerequisites are not met. A 404 IdentityProviderNotFound error indicates that no binding of the specified type exists. Synchronous calls to the upstream service may return a 503 IdentityProviderProvisioningUnavailable error if they fail. Retain the request ID for troubleshooting and do not interpret read failures as an unconfigured state. Authentication errors and workspace-not-found errors follow common error handling procedures.
1588
- * 404 IdentityProviderNotFound: No binding exists, or the specified type is inconsistent with the current binding. If SAML is already configured, an upstream read failure does not degrade to a successful empty configuration.
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.
1589
1705
  *
1590
1706
  * @param request - GetIdentityProviderRequest
1591
1707
  * @param headers - map
@@ -1596,19 +1712,19 @@ export default class Client extends OpenApi {
1596
1712
  [key: string]: string;
1597
1713
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetIdentityProviderResponse>;
1598
1714
  /**
1599
- * Queries the binding details of an external identity provider for a specified workspace, including the binding status, application configurations, and the callback URL 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.
1600
1716
  *
1601
1717
  * @remarks
1602
1718
  * ## Features and prerequisites
1603
- * Reads existing bindings by type. For CustomSSO, the API 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. If SAML is configured, the API additionally queries AgentIdentity, and the configuration field represents the actual SSO/JIT configuration. The saml field serves as the data source for the edit form. The status switches in the configuration field are Enabled and Disabled. If the upstream query fails, an error is returned. This failure must not be treated as an unconfigured state.
1604
- * Only this API reads back the actual SAML configuration. The list and write APIs do not guarantee that the configuration field is returned. A READY user pool does not indicate that SAML is configured. The UPDATING and UPDATE_FAILED statuses describe logon configuration tasks, not SCIM tasks. The vendor callback URL for CustomSSO is empty. Use GetIdentityProviderSCIM.operationStatus to query SCIM operation results.
1605
- * ## Requests and examples
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
1606
1722
  * GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}
1607
- * Calling convention: Call this API 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, URLs, certificates, and tokens in the following examples are placeholder values and must be replaced with actual values. The request body example shows the body parameters of the public API, rather than the extra body wrapper of the backend direct-connection API. 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 log secrets. Asynchronous business tasks do not imply that the HTTP request uses a persistent connection to wait for completion.
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.
1608
1724
  * ```text
1609
1725
  * GET /workspaces/ws-example/identity-providers/CustomSSO
1610
1726
  * ```
1611
- * ## Response example
1727
+ * ## Response examples
1612
1728
  * ```json
1613
1729
  * {
1614
1730
  * "data": {
@@ -1621,13 +1737,115 @@ export default class Client extends OpenApi {
1621
1737
  * }
1622
1738
  * ```
1623
1739
  * ## Errors and handling
1624
- * Error handling: A 400 InvalidParameter error indicates that the parameters or current configuration prerequisites are not met. A 404 IdentityProviderNotFound error indicates that no binding of the specified type exists. Synchronous calls to the upstream service may return a 503 IdentityProviderProvisioningUnavailable error if they fail. Retain the request ID for troubleshooting and do not interpret read failures as an unconfigured state. Authentication errors and workspace-not-found errors follow common error handling procedures.
1625
- * 404 IdentityProviderNotFound: No binding exists, or the specified type is inconsistent with the current binding. If SAML is already configured, an upstream read failure does not degrade to a successful empty configuration.
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.
1626
1744
  *
1627
1745
  * @param request - GetIdentityProviderRequest
1628
1746
  * @returns GetIdentityProviderResponse
1629
1747
  */
1630
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>;
1631
1849
  /**
1632
1850
  * Queries an identity provider synchronization task.
1633
1851
  *
@@ -2506,7 +2724,31 @@ export default class Client extends OpenApi {
2506
2724
  * Queries the departments of an identity provider by page.
2507
2725
  *
2508
2726
  * @remarks
2509
- * Queries DingTalk or Feishu departments by hierarchy and page. Prerequisites include a bound identity provider, a user pool, valid application credentials, and address book read authorization. If you do not specify parentDepartmentId, the root hierarchy is queried. When expanding a node, specify the ID of the node to query its direct child departments. The hasChildren field indicates whether the node can be expanded and does not mean that child nodes are returned. The nextToken field is used only to query the next page of child departments under the current parent department. This query only reads the directory. It does not save the synchronization scope or import users. If a new department is added to a DingTalk or Feishu organization, re-query the corresponding parent department because the previous list does not reflect the latest directory.\\n\\nAuthorization information: The RAM action is agentcore:ListIdentityProviderDepartments, the access level is List, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is required for authorization.\\n\\nIdempotency and retry: This operation is read-only and can be called repeatedly.\\n\\nCalling this API is free of charge. Operation records support ActionTrail auditing.\\n\\nResponse example:\\n```json\\n{\\n "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",\\n "message": "success",\\n "httpStatusCode": 200,\\n "code": "SUCCESS",\\n "success": true,\\n "maxResults": 50,\\n "nextToken": "",\\n "items": [\\n {\\n "id": "10001",\\n "name": "R&D Department",\\n "parentId": "1",\\n "memberCount": 12,\\n "hasChildren": true\\n }\\n ]\\n}\\n```
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
+ * ```
2510
2752
  *
2511
2753
  * @param request - ListIdentityProviderDepartmentsRequest
2512
2754
  * @param headers - map
@@ -2520,26 +2762,126 @@ export default class Client extends OpenApi {
2520
2762
  * Queries the departments of an identity provider by page.
2521
2763
  *
2522
2764
  * @remarks
2523
- * Queries DingTalk or Feishu departments by hierarchy and page. Prerequisites include a bound identity provider, a user pool, valid application credentials, and address book read authorization. If you do not specify parentDepartmentId, the root hierarchy is queried. When expanding a node, specify the ID of the node to query its direct child departments. The hasChildren field indicates whether the node can be expanded and does not mean that child nodes are returned. The nextToken field is used only to query the next page of child departments under the current parent department. This query only reads the directory. It does not save the synchronization scope or import users. If a new department is added to a DingTalk or Feishu organization, re-query the corresponding parent department because the previous list does not reflect the latest directory.\\n\\nAuthorization information: The RAM action is agentcore:ListIdentityProviderDepartments, the access level is List, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is required for authorization.\\n\\nIdempotency and retry: This operation is read-only and can be called repeatedly.\\n\\nCalling this API is free of charge. Operation records support ActionTrail auditing.\\n\\nResponse example:\\n```json\\n{\\n "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",\\n "message": "success",\\n "httpStatusCode": 200,\\n "code": "SUCCESS",\\n "success": true,\\n "maxResults": 50,\\n "nextToken": "",\\n "items": [\\n {\\n "id": "10001",\\n "name": "R&D Department",\\n "parentId": "1",\\n "memberCount": 12,\\n "hasChildren": true\\n }\\n ]\\n}\\n```
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
+ * ```
2524
2790
  *
2525
2791
  * @param request - ListIdentityProviderDepartmentsRequest
2526
2792
  * @returns ListIdentityProviderDepartmentsResponse
2527
2793
  */
2528
2794
  listIdentityProviderDepartments(workspaceId: string, identityProviderType: string, request: $_model.ListIdentityProviderDepartmentsRequest): Promise<$_model.ListIdentityProviderDepartmentsResponse>;
2529
2795
  /**
2530
- * 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.
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.
2531
2873
  *
2532
2874
  * @remarks
2533
2875
  * ## Features and prerequisites
2534
- * Returns the local binding summary without querying the actual SAML or SCIM configurations of AgentIdentity. If no binding exists, items is an empty array. A workspace currently supports only one external binding. The default value of maxResults is 10, and the valid range is 1 to 100. Currently, nextToken must be omitted or left empty. A non-empty value returns InvalidParameter, and fictitious multi-page results are not supported.
2535
- * The status of CustomSSO indicates the task status of shared resources and logon configurations. You must check protocol and saml to determine whether SAML is configured. To query SCIM configurations, independently call GetIdentityProviderSCIM. The list operation does not issue tokens and does not return the vendor appSecret, encryptKey, or verificationToken.
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.
2536
2878
  * ## Requests and examples
2537
2879
  * GET /workspaces/{workspaceId}/identity-providers
2538
- * Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or Security Token Service (STS) token that has the required 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 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 secrets. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
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.
2539
2881
  * ```text
2540
2882
  * GET /workspaces/ws-example/identity-providers?maxResults=10
2541
2883
  * ```
2542
- * ## Response examples
2884
+ * ## Response example
2543
2885
  * ```json
2544
2886
  * {
2545
2887
  * "items": [
@@ -2556,8 +2898,10 @@ export default class Client extends OpenApi {
2556
2898
  * }
2557
2899
  * ```
2558
2900
  * ## Errors and handling
2559
- * 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. 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.
2560
- * 400 InvalidParameter: maxResults is out of bounds, or nextToken is not empty, which is currently not supported. If a query fails, an error is displayed instead of resetting the status to unconfigured.
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.
2561
2905
  *
2562
2906
  * @param request - ListIdentityProvidersRequest
2563
2907
  * @param headers - map
@@ -2568,19 +2912,19 @@ export default class Client extends OpenApi {
2568
2912
  [key: string]: string;
2569
2913
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListIdentityProvidersResponse>;
2570
2914
  /**
2571
- * 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.
2572
2916
  *
2573
2917
  * @remarks
2574
2918
  * ## Features and prerequisites
2575
- * Returns the local binding summary without querying the actual SAML or SCIM configurations of AgentIdentity. If no binding exists, items is an empty array. A workspace currently supports only one external binding. The default value of maxResults is 10, and the valid range is 1 to 100. Currently, nextToken must be omitted or left empty. A non-empty value returns InvalidParameter, and fictitious multi-page results are not supported.
2576
- * The status of CustomSSO indicates the task status of shared resources and logon configurations. You must check protocol and saml to determine whether SAML is configured. To query SCIM configurations, independently call GetIdentityProviderSCIM. The list operation does not issue tokens and does not return the vendor appSecret, encryptKey, or verificationToken.
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.
2577
2921
  * ## Requests and examples
2578
2922
  * GET /workspaces/{workspaceId}/identity-providers
2579
- * Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or Security Token Service (STS) token that has the required 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 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 secrets. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
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.
2580
2924
  * ```text
2581
2925
  * GET /workspaces/ws-example/identity-providers?maxResults=10
2582
2926
  * ```
2583
- * ## Response examples
2927
+ * ## Response example
2584
2928
  * ```json
2585
2929
  * {
2586
2930
  * "items": [
@@ -2597,8 +2941,10 @@ export default class Client extends OpenApi {
2597
2941
  * }
2598
2942
  * ```
2599
2943
  * ## Errors and handling
2600
- * 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. 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.
2601
- * 400 InvalidParameter: maxResults is out of bounds, or nextToken is not empty, which is currently not supported. If a query fails, an error is displayed instead of resetting the status to unconfigured.
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.
2602
2948
  *
2603
2949
  * @param request - ListIdentityProvidersRequest
2604
2950
  * @returns ListIdentityProvidersResponse
@@ -3156,6 +3502,92 @@ export default class Client extends OpenApi {
3156
3502
  * @returns PrecheckSkillUploadViaOssResponse
3157
3503
  */
3158
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>;
3159
3591
  /**
3160
3592
  * Publishes a specified Skill version to transition it to the published state.
3161
3593
  *
@@ -3509,32 +3941,66 @@ export default class Client extends OpenApi {
3509
3941
  */
3510
3942
  updateExternalAgent(workspaceId: string, agentId: string, request: $_model.UpdateExternalAgentRequest): Promise<$_model.UpdateExternalAgentResponse>;
3511
3943
  /**
3512
- * Updates the logon switch, member synchronization switch, or application configuration of a specified external identity provider for 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 the 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.
3959
+ *
3960
+ * @param tmpReq - UpdateIdentityProviderRequest
3961
+ * @param headers - map
3962
+ * @param runtime - runtime options for this request RuntimeOptions
3963
+ * @returns UpdateIdentityProviderResponse
3964
+ */
3965
+ updateIdentityProviderWithOptions(workspaceId: string, identityProviderType: string, tmpReq: $_model.UpdateIdentityProviderRequest, headers: {
3966
+ [key: string]: string;
3967
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateIdentityProviderResponse>;
3968
+ /**
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.
3984
+ *
3985
+ * @param request - UpdateIdentityProviderRequest
3986
+ * @returns UpdateIdentityProviderResponse
3987
+ */
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.
3513
3991
  *
3514
3992
  * @remarks
3515
3993
  * ## Features and prerequisites
3516
- * CustomSSO uses protocol=SAML and saml to save logon configurations. It does not accept legacy metadata or syncEnabled. To toggle the SCIM switch, you must call UpdateIdentityProviderSCIM. OIDC is not supported. You can either import XML or manually enter fields. If you import XML, metadataXml must be a single IdP EntityDescriptor XML text of up to 1 MiB. URLs or file paths are not accepted, and DTDs or external entities are prohibited. If you manually enter fields, you must provide entityId, loginUrl, bindingType, and a non-empty x509Certificates array at the same time. The entityId must be non-empty and up to 2,048 characters in length, and cannot be replaced after configuration. The loginUrl must be an absolute HTTPS URL without user credentials or fragments. The bindingType must be HTTP-Redirect or HTTP-POST. Signing certificates must be valid X.509 certificates, and up to 10 certificates are supported.
3517
- * Saving the configuration does not automatically enable logon. A valid SAML configuration must exist before you enable logon. Setting loginEnabled=false only disables logon and does not clear SAML or SCIM configurations. You can independently pass Boolean values for jitProvisionEnabled and jitUpdateEnabled. If omitted, the existing values are retained. If omitted for the first time, the default value is false. Updating only the JIT switches also requires a valid SAML configuration. If the request is unchanged, the current binding may be returned directly without generating a new task. A successful update returns UPDATING. You can call GetIdentityProvider and wait for READY or UPDATE_FAILED. If the update fails, you can resubmit the request. An HTTP success response does not indicate that the upstream configuration has taken effect.
3518
- * DingTalk and Feishu continue to use vendor metadata and logon or synchronization switches. They do not accept protocol or saml. Updating vendor metadata supports partial updates. You only need to submit the fields to be modified. Unsubmitted fields and saved credentials remain unchanged. The server merges the new and old values and then validates the complete configuration. Explicitly submitted fields cannot be null, empty strings, or blank strings. For example, you can submit only appSecret to update the secret. The existing vendor semantics of syncScope are retained. Saving the scope does not automatically trigger full synchronization.
3519
- * ## Request and examples
3520
- * PUT /workspaces/{workspaceId}/identity-providers/{identityProviderType}
3521
- * 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 body 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. 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.
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.
3522
4000
  * ```text
3523
- * PUT /workspaces/ws-example/identity-providers/CustomSSO
3524
- * {
3525
- * "protocol": "SAML",
3526
- * "saml": {
3527
- * "entityId": "https://idp.example.com/entity",
3528
- * "loginUrl": "https://idp.example.com/sso",
3529
- * "bindingType": "HTTP-Redirect",
3530
- * "x509Certificates": [
3531
- * "<Valid PEM X.509 certificate text>"
3532
- * ],
3533
- * "jitProvisionEnabled": false,
3534
- * "jitUpdateEnabled": false
3535
- * }
3536
- * }
3537
- * Toggle logon only: {"loginEnabled": true}
4001
+ * PUT /workspaces/ws-example/scim-provisioning
4002
+ * {"syncEnabled": true}
4003
+ * To disable: {"syncEnabled": false}
3538
4004
  * ```
3539
4005
  * ## Response example
3540
4006
  * ```json
@@ -3542,52 +4008,41 @@ export default class Client extends OpenApi {
3542
4008
  * "data": {
3543
4009
  * "workspaceId": "ws-example",
3544
4010
  * "identityProviderType": "CustomSSO",
3545
- * "protocol": "SAML",
4011
+ * "status": "READY",
3546
4012
  * "loginEnabled": false,
3547
- * "syncEnabled": false,
3548
- * "status": "UPDATING"
4013
+ * "syncEnabled": true
3549
4014
  * }
3550
4015
  * }
3551
4016
  * ```
3552
4017
  * ## Errors and handling
3553
- * 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 may return 503 IdentityProviderProvisioningUnavailable if they fail. Keep the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow common error handling.
3554
- * 400 InvalidParameter: XML and manual entry are mixed, manual entry items are missing, certificates are invalid, the protocol is not supported, entityId is changed, logon is enabled without configuration, or CustomSSO submits metadata or syncEnabled. 409 IdentityProviderOperationConflict: The current binding does not allow updates. CustomSSO supports resubmitting configurations from UPDATE_FAILED.
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.
3555
4022
  *
3556
- * @param tmpReq - UpdateIdentityProviderRequest
4023
+ * @param tmpReq - UpdateIdentityProviderSCIMRequest
3557
4024
  * @param headers - map
3558
4025
  * @param runtime - runtime options for this request RuntimeOptions
3559
- * @returns UpdateIdentityProviderResponse
4026
+ * @returns UpdateIdentityProviderSCIMResponse
3560
4027
  */
3561
- updateIdentityProviderWithOptions(workspaceId: string, identityProviderType: string, tmpReq: $_model.UpdateIdentityProviderRequest, headers: {
4028
+ updateIdentityProviderSCIMWithOptions(workspaceId: string, tmpReq: $_model.UpdateIdentityProviderSCIMRequest, headers: {
3562
4029
  [key: string]: string;
3563
- }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateIdentityProviderResponse>;
4030
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateIdentityProviderSCIMResponse>;
3564
4031
  /**
3565
- * Updates the logon switch, member synchronization switch, or application configuration of a specified external identity provider for 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 the progress.
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.
3566
4033
  *
3567
4034
  * @remarks
3568
4035
  * ## Features and prerequisites
3569
- * CustomSSO uses protocol=SAML and saml to save logon configurations. It does not accept legacy metadata or syncEnabled. To toggle the SCIM switch, you must call UpdateIdentityProviderSCIM. OIDC is not supported. You can either import XML or manually enter fields. If you import XML, metadataXml must be a single IdP EntityDescriptor XML text of up to 1 MiB. URLs or file paths are not accepted, and DTDs or external entities are prohibited. If you manually enter fields, you must provide entityId, loginUrl, bindingType, and a non-empty x509Certificates array at the same time. The entityId must be non-empty and up to 2,048 characters in length, and cannot be replaced after configuration. The loginUrl must be an absolute HTTPS URL without user credentials or fragments. The bindingType must be HTTP-Redirect or HTTP-POST. Signing certificates must be valid X.509 certificates, and up to 10 certificates are supported.
3570
- * Saving the configuration does not automatically enable logon. A valid SAML configuration must exist before you enable logon. Setting loginEnabled=false only disables logon and does not clear SAML or SCIM configurations. You can independently pass Boolean values for jitProvisionEnabled and jitUpdateEnabled. If omitted, the existing values are retained. If omitted for the first time, the default value is false. Updating only the JIT switches also requires a valid SAML configuration. If the request is unchanged, the current binding may be returned directly without generating a new task. A successful update returns UPDATING. You can call GetIdentityProvider and wait for READY or UPDATE_FAILED. If the update fails, you can resubmit the request. An HTTP success response does not indicate that the upstream configuration has taken effect.
3571
- * DingTalk and Feishu continue to use vendor metadata and logon or synchronization switches. They do not accept protocol or saml. Updating vendor metadata supports partial updates. You only need to submit the fields to be modified. Unsubmitted fields and saved credentials remain unchanged. The server merges the new and old values and then validates the complete configuration. Explicitly submitted fields cannot be null, empty strings, or blank strings. For example, you can submit only appSecret to update the secret. The existing vendor semantics of syncScope are retained. Saving the scope does not automatically trigger full synchronization.
3572
- * ## Request and examples
3573
- * PUT /workspaces/{workspaceId}/identity-providers/{identityProviderType}
3574
- * 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 body 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. 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.
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.
3575
4042
  * ```text
3576
- * PUT /workspaces/ws-example/identity-providers/CustomSSO
3577
- * {
3578
- * "protocol": "SAML",
3579
- * "saml": {
3580
- * "entityId": "https://idp.example.com/entity",
3581
- * "loginUrl": "https://idp.example.com/sso",
3582
- * "bindingType": "HTTP-Redirect",
3583
- * "x509Certificates": [
3584
- * "<Valid PEM X.509 certificate text>"
3585
- * ],
3586
- * "jitProvisionEnabled": false,
3587
- * "jitUpdateEnabled": false
3588
- * }
3589
- * }
3590
- * Toggle logon only: {"loginEnabled": true}
4043
+ * PUT /workspaces/ws-example/scim-provisioning
4044
+ * {"syncEnabled": true}
4045
+ * To disable: {"syncEnabled": false}
3591
4046
  * ```
3592
4047
  * ## Response example
3593
4048
  * ```json
@@ -3595,21 +4050,22 @@ export default class Client extends OpenApi {
3595
4050
  * "data": {
3596
4051
  * "workspaceId": "ws-example",
3597
4052
  * "identityProviderType": "CustomSSO",
3598
- * "protocol": "SAML",
4053
+ * "status": "READY",
3599
4054
  * "loginEnabled": false,
3600
- * "syncEnabled": false,
3601
- * "status": "UPDATING"
4055
+ * "syncEnabled": true
3602
4056
  * }
3603
4057
  * }
3604
4058
  * ```
3605
4059
  * ## Errors and handling
3606
- * 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 may return 503 IdentityProviderProvisioningUnavailable if they fail. Keep the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow common error handling.
3607
- * 400 InvalidParameter: XML and manual entry are mixed, manual entry items are missing, certificates are invalid, the protocol is not supported, entityId is changed, logon is enabled without configuration, or CustomSSO submits metadata or syncEnabled. 409 IdentityProviderOperationConflict: The current binding does not allow updates. CustomSSO supports resubmitting configurations from UPDATE_FAILED.
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.
3608
4064
  *
3609
- * @param request - UpdateIdentityProviderRequest
3610
- * @returns UpdateIdentityProviderResponse
4065
+ * @param request - UpdateIdentityProviderSCIMRequest
4066
+ * @returns UpdateIdentityProviderSCIMResponse
3611
4067
  */
3612
- updateIdentityProvider(workspaceId: string, identityProviderType: string, request: $_model.UpdateIdentityProviderRequest): Promise<$_model.UpdateIdentityProviderResponse>;
4068
+ updateIdentityProviderSCIM(workspaceId: string, request: $_model.UpdateIdentityProviderSCIMRequest): Promise<$_model.UpdateIdentityProviderSCIMResponse>;
3613
4069
  /**
3614
4070
  * Updates the configuration of a specified managed agent.
3615
4071
  *
@@ -3989,10 +4445,11 @@ export default class Client extends OpenApi {
3989
4445
  */
3990
4446
  validateAgentCodePackageFromOss(workspaceId: string, request: $_model.ValidateAgentCodePackageFromOssRequest): Promise<$_model.ValidateAgentCodePackageFromOssResponse>;
3991
4447
  /**
3992
- * 检查智能体代码包 OSS RAM 授权状态
4448
+ * Checks the OSS RAM authorization status of the agent code package.
3993
4449
  *
3994
4450
  * @remarks
3995
- * 检查当前 Workspace 角色是否绑定所选源 Bucket 对应的自定义 RAM 策略,复用已有挂载授权。仅返回策略绑定状态,不验证代码包存在或可读、不修改默认桶。授权状态不能替代 ValidateAgentCodePackageFromOss 的实际对象读取校验。
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.
3996
4453
  *
3997
4454
  * @param request - VerifyAgentCodePackageOssRamAuthorizationRequest
3998
4455
  * @param headers - map
@@ -4003,10 +4460,11 @@ export default class Client extends OpenApi {
4003
4460
  [key: string]: string;
4004
4461
  }, runtime: $dara.RuntimeOptions): Promise<$_model.VerifyAgentCodePackageOssRamAuthorizationResponse>;
4005
4462
  /**
4006
- * 检查智能体代码包 OSS RAM 授权状态
4463
+ * Checks the OSS RAM authorization status of the agent code package.
4007
4464
  *
4008
4465
  * @remarks
4009
- * 检查当前 Workspace 角色是否绑定所选源 Bucket 对应的自定义 RAM 策略,复用已有挂载授权。仅返回策略绑定状态,不验证代码包存在或可读、不修改默认桶。授权状态不能替代 ValidateAgentCodePackageFromOss 的实际对象读取校验。
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.
4010
4468
  *
4011
4469
  * @param request - VerifyAgentCodePackageOssRamAuthorizationRequest
4012
4470
  * @returns VerifyAgentCodePackageOssRamAuthorizationResponse