@alicloud/agentcore20260804 3.0.1 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +370 -188
- package/dist/client.js +413 -188
- package/dist/client.js.map +1 -1
- package/dist/models/CreateCustomAgentRequest.d.ts +155 -53
- package/dist/models/CreateCustomAgentRequest.js +61 -1
- package/dist/models/CreateCustomAgentRequest.js.map +1 -1
- package/dist/models/CreateCustomAgentResponseBody.d.ts +305 -58
- package/dist/models/CreateCustomAgentResponseBody.js +153 -1
- package/dist/models/CreateCustomAgentResponseBody.js.map +1 -1
- package/dist/models/CreateIdentityProviderRequest.d.ts +12 -15
- package/dist/models/CreateIdentityProviderRequest.js.map +1 -1
- package/dist/models/CreateIdentityProviderResponseBody.d.ts +19 -22
- package/dist/models/CreateIdentityProviderResponseBody.js.map +1 -1
- package/dist/models/CreateManagedAgentRequest.d.ts +80 -45
- package/dist/models/CreateManagedAgentRequest.js +29 -1
- package/dist/models/CreateManagedAgentRequest.js.map +1 -1
- package/dist/models/CreateManagedAgentResponseBody.d.ts +98 -65
- package/dist/models/CreateManagedAgentResponseBody.js +29 -1
- package/dist/models/CreateManagedAgentResponseBody.js.map +1 -1
- package/dist/models/CreateManagedAgentShrinkRequest.d.ts +1 -1
- package/dist/models/DeleteIdentityProviderResponseBody.d.ts +10 -10
- package/dist/models/DeleteIdentityProviderScimcredentialResponseBody.d.ts +5 -5
- package/dist/models/FindCustomAgentImagePreparationRequest.d.ts +23 -0
- package/dist/models/FindCustomAgentImagePreparationRequest.js +58 -0
- package/dist/models/FindCustomAgentImagePreparationRequest.js.map +1 -0
- package/dist/models/FindCustomAgentImagePreparationResponse.d.ts +19 -0
- package/dist/models/FindCustomAgentImagePreparationResponse.js +69 -0
- package/dist/models/FindCustomAgentImagePreparationResponse.js.map +1 -0
- package/dist/models/FindCustomAgentImagePreparationResponseBody.d.ts +135 -0
- package/dist/models/FindCustomAgentImagePreparationResponseBody.js +122 -0
- package/dist/models/FindCustomAgentImagePreparationResponseBody.js.map +1 -0
- package/dist/models/GetCustomAgentImagePreparationRequest.d.ts +13 -0
- package/dist/models/GetCustomAgentImagePreparationRequest.js +54 -0
- package/dist/models/GetCustomAgentImagePreparationRequest.js.map +1 -0
- package/dist/models/GetCustomAgentImagePreparationResponse.d.ts +19 -0
- package/dist/models/GetCustomAgentImagePreparationResponse.js +69 -0
- package/dist/models/GetCustomAgentImagePreparationResponse.js.map +1 -0
- package/dist/models/GetCustomAgentImagePreparationResponseBody.d.ts +135 -0
- package/dist/models/GetCustomAgentImagePreparationResponseBody.js +122 -0
- package/dist/models/GetCustomAgentImagePreparationResponseBody.js.map +1 -0
- package/dist/models/GetCustomAgentResponseBody.d.ts +304 -51
- package/dist/models/GetCustomAgentResponseBody.js +153 -1
- package/dist/models/GetCustomAgentResponseBody.js.map +1 -1
- package/dist/models/GetIdentityProviderResponseBody.d.ts +30 -30
- package/dist/models/GetIdentityProviderScimresponseBody.d.ts +22 -18
- package/dist/models/GetIdentityProviderScimresponseBody.js.map +1 -1
- package/dist/models/GetIdentityProviderServiceProviderRequest.d.ts +1 -1
- package/dist/models/GetIdentityProviderServiceProviderResponseBody.d.ts +10 -10
- package/dist/models/GetManagedAgentResponseBody.d.ts +106 -75
- package/dist/models/GetManagedAgentResponseBody.js +29 -1
- package/dist/models/GetManagedAgentResponseBody.js.map +1 -1
- package/dist/models/GetWorkspaceAcrRamAuthorizeUrlRequest.d.ts +2 -2
- package/dist/models/GetWorkspaceAcrRamAuthorizeUrlResponseBody.d.ts +1 -1
- package/dist/models/ListCustomAgentsRequest.d.ts +2 -2
- package/dist/models/ListCustomAgentsResponseBody.d.ts +24 -22
- package/dist/models/ListCustomAgentsResponseBody.js.map +1 -1
- package/dist/models/ListIdentityProvidersRequest.d.ts +1 -1
- package/dist/models/ListIdentityProvidersResponseBody.d.ts +30 -18
- package/dist/models/ListIdentityProvidersResponseBody.js.map +1 -1
- package/dist/models/PrepareIdentityProviderScimresponseBody.d.ts +10 -10
- package/dist/models/UpdateCustomAgentRequest.d.ts +154 -75
- package/dist/models/UpdateCustomAgentRequest.js +61 -1
- package/dist/models/UpdateCustomAgentRequest.js.map +1 -1
- package/dist/models/UpdateCustomAgentResponseBody.d.ts +310 -65
- package/dist/models/UpdateCustomAgentResponseBody.js +153 -1
- package/dist/models/UpdateCustomAgentResponseBody.js.map +1 -1
- package/dist/models/UpdateCustomAgentShrinkRequest.d.ts +1 -1
- package/dist/models/UpdateIdentityProviderRequest.d.ts +20 -20
- package/dist/models/UpdateIdentityProviderResponseBody.d.ts +19 -19
- package/dist/models/UpdateIdentityProviderScimrequest.d.ts +2 -2
- package/dist/models/UpdateIdentityProviderScimresponseBody.d.ts +28 -28
- package/dist/models/UpdateIdentityProviderScimshrinkRequest.d.ts +1 -1
- package/dist/models/UpdateIdentityProviderShrinkRequest.d.ts +1 -1
- package/dist/models/UpdateManagedAgentRequest.d.ts +83 -46
- package/dist/models/UpdateManagedAgentRequest.js +29 -1
- package/dist/models/UpdateManagedAgentRequest.js.map +1 -1
- package/dist/models/UpdateManagedAgentResponseBody.d.ts +98 -65
- package/dist/models/UpdateManagedAgentResponseBody.js +29 -1
- package/dist/models/UpdateManagedAgentResponseBody.js.map +1 -1
- package/dist/models/UpdateManagedAgentShrinkRequest.d.ts +1 -1
- package/dist/models/model.d.ts +34 -0
- package/dist/models/model.js +267 -198
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +418 -188
- package/src/models/CreateCustomAgentRequest.ts +197 -53
- package/src/models/CreateCustomAgentResponseBody.ts +412 -58
- package/src/models/CreateIdentityProviderRequest.ts +12 -15
- package/src/models/CreateIdentityProviderResponseBody.ts +19 -22
- package/src/models/CreateManagedAgentRequest.ts +99 -45
- package/src/models/CreateManagedAgentResponseBody.ts +117 -65
- package/src/models/CreateManagedAgentShrinkRequest.ts +1 -1
- package/src/models/DeleteIdentityProviderResponseBody.ts +10 -10
- package/src/models/DeleteIdentityProviderScimcredentialResponseBody.ts +5 -5
- package/src/models/FindCustomAgentImagePreparationRequest.ts +36 -0
- package/src/models/FindCustomAgentImagePreparationResponse.ts +40 -0
- package/src/models/FindCustomAgentImagePreparationResponseBody.ts +194 -0
- package/src/models/GetCustomAgentImagePreparationRequest.ts +24 -0
- package/src/models/GetCustomAgentImagePreparationResponse.ts +40 -0
- package/src/models/GetCustomAgentImagePreparationResponseBody.ts +194 -0
- package/src/models/GetCustomAgentResponseBody.ts +411 -51
- package/src/models/GetIdentityProviderResponseBody.ts +30 -30
- package/src/models/GetIdentityProviderScimresponseBody.ts +22 -18
- package/src/models/GetIdentityProviderServiceProviderRequest.ts +1 -1
- package/src/models/GetIdentityProviderServiceProviderResponseBody.ts +10 -10
- package/src/models/GetManagedAgentResponseBody.ts +125 -75
- package/src/models/GetWorkspaceAcrRamAuthorizeUrlRequest.ts +2 -2
- package/src/models/GetWorkspaceAcrRamAuthorizeUrlResponseBody.ts +1 -1
- package/src/models/ListCustomAgentsRequest.ts +2 -2
- package/src/models/ListCustomAgentsResponseBody.ts +24 -22
- package/src/models/ListIdentityProvidersRequest.ts +1 -1
- package/src/models/ListIdentityProvidersResponseBody.ts +30 -18
- package/src/models/PrepareIdentityProviderScimresponseBody.ts +10 -10
- package/src/models/UpdateCustomAgentRequest.ts +196 -75
- package/src/models/UpdateCustomAgentResponseBody.ts +417 -65
- package/src/models/UpdateCustomAgentShrinkRequest.ts +1 -1
- package/src/models/UpdateIdentityProviderRequest.ts +20 -20
- package/src/models/UpdateIdentityProviderResponseBody.ts +19 -19
- package/src/models/UpdateIdentityProviderScimrequest.ts +2 -2
- package/src/models/UpdateIdentityProviderScimresponseBody.ts +28 -28
- package/src/models/UpdateIdentityProviderScimshrinkRequest.ts +1 -1
- package/src/models/UpdateIdentityProviderShrinkRequest.ts +1 -1
- package/src/models/UpdateManagedAgentRequest.ts +102 -46
- package/src/models/UpdateManagedAgentResponseBody.ts +117 -65
- package/src/models/UpdateManagedAgentShrinkRequest.ts +1 -1
- package/src/models/model.ts +34 -0
package/src/client.ts
CHANGED
|
@@ -498,15 +498,15 @@ export default class Client extends OpenApi {
|
|
|
498
498
|
}
|
|
499
499
|
|
|
500
500
|
/**
|
|
501
|
-
* Creates a custom agent in a specified workspace
|
|
501
|
+
* Creates a custom agent in a specified workspace by using a container image or a code package. The creation process is asynchronous. You can call GetCustomAgent to query the deployment result.
|
|
502
502
|
*
|
|
503
503
|
* @remarks
|
|
504
504
|
* Before you call this operation, prepare a writable workspace, a RAM role ARN, a container image or code package, and runtime configurations. You must specify name, artifact, roleArn, and runtime. The runtime parameter must include both compute and sessionPolicy.
|
|
505
|
-
*
|
|
506
|
-
*
|
|
507
|
-
* When you submit a new code package source, the backend rechecks the read permissions, object, and size. The configuration is saved only after the transfer succeeds. If the transfer fails, the configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not
|
|
508
|
-
* The creation process is asynchronous. A successful response indicates that the request is accepted.
|
|
509
|
-
* The clientToken parameter does not provide
|
|
505
|
+
* To use the container mode, configure artifact.container and specify artifact.port. The image must have the required access permissions and be accessible over the network allowed by the workspace.
|
|
506
|
+
* To use the code package pattern, specify artifact.port, and configure sourceUri, languageRuntime, and entrypoint in artifact.code. Do not configure container at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported. The compressed package size cannot exceed 500,000,000 bytes. You can call ListAgentCodeRuntimes to query the runtime environment identity. The sourceUri parameter supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. To upload a local file, call GetAgentCodePackageUploadUrl to obtain the upload URL, upload the file directly, and then commit the returned sourceUri.
|
|
507
|
+
* When you submit a new code package source, the backend rechecks the read permissions, object, and size. The configuration is saved only after the transfer succeeds. If the transfer fails, the current configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not indicate that the agent is ready to run.
|
|
508
|
+
* The creation process is asynchronous. A successful response indicates that the request is accepted. Use the returned agentId to call GetCustomAgent and check latestVersionStatus, latestExecutionError, and status corresponding to latestSpecVersion to confirm the deployment result. After the deployment is ready, you can call CreateServiceEndpoint to configure the access endpoint.
|
|
509
|
+
* The clientToken parameter does not provide idempotence guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold parameter for health checks does not take effect. Omit this parameter.
|
|
510
510
|
*
|
|
511
511
|
* @param tmpReq - CreateCustomAgentRequest
|
|
512
512
|
* @param headers - map
|
|
@@ -551,15 +551,15 @@ export default class Client extends OpenApi {
|
|
|
551
551
|
}
|
|
552
552
|
|
|
553
553
|
/**
|
|
554
|
-
* Creates a custom agent in a specified workspace
|
|
554
|
+
* Creates a custom agent in a specified workspace by using a container image or a code package. The creation process is asynchronous. You can call GetCustomAgent to query the deployment result.
|
|
555
555
|
*
|
|
556
556
|
* @remarks
|
|
557
557
|
* Before you call this operation, prepare a writable workspace, a RAM role ARN, a container image or code package, and runtime configurations. You must specify name, artifact, roleArn, and runtime. The runtime parameter must include both compute and sessionPolicy.
|
|
558
|
-
*
|
|
559
|
-
*
|
|
560
|
-
* When you submit a new code package source, the backend rechecks the read permissions, object, and size. The configuration is saved only after the transfer succeeds. If the transfer fails, the configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not
|
|
561
|
-
* The creation process is asynchronous. A successful response indicates that the request is accepted.
|
|
562
|
-
* The clientToken parameter does not provide
|
|
558
|
+
* To use the container mode, configure artifact.container and specify artifact.port. The image must have the required access permissions and be accessible over the network allowed by the workspace.
|
|
559
|
+
* To use the code package pattern, specify artifact.port, and configure sourceUri, languageRuntime, and entrypoint in artifact.code. Do not configure container at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported. The compressed package size cannot exceed 500,000,000 bytes. You can call ListAgentCodeRuntimes to query the runtime environment identity. The sourceUri parameter supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. To upload a local file, call GetAgentCodePackageUploadUrl to obtain the upload URL, upload the file directly, and then commit the returned sourceUri.
|
|
560
|
+
* When you submit a new code package source, the backend rechecks the read permissions, object, and size. The configuration is saved only after the transfer succeeds. If the transfer fails, the current configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not indicate that the agent is ready to run.
|
|
561
|
+
* The creation process is asynchronous. A successful response indicates that the request is accepted. Use the returned agentId to call GetCustomAgent and check latestVersionStatus, latestExecutionError, and status corresponding to latestSpecVersion to confirm the deployment result. After the deployment is ready, you can call CreateServiceEndpoint to configure the access endpoint.
|
|
562
|
+
* The clientToken parameter does not provide idempotence guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold parameter for health checks does not take effect. Omit this parameter.
|
|
563
563
|
*
|
|
564
564
|
* @param request - CreateCustomAgentRequest
|
|
565
565
|
* @returns CreateCustomAgentResponse
|
|
@@ -685,20 +685,21 @@ export default class Client extends OpenApi {
|
|
|
685
685
|
}
|
|
686
686
|
|
|
687
687
|
/**
|
|
688
|
-
* Binds
|
|
688
|
+
* Binds a DingTalk, Lark, or CustomSSO identity source to a workspace. CustomSSO only asynchronously initializes the shared user pool. SAML logon and SCIM synchronization are configured separately later.
|
|
689
689
|
*
|
|
690
690
|
* @remarks
|
|
691
691
|
* ## Features and prerequisites
|
|
692
|
-
*
|
|
693
|
-
*
|
|
692
|
+
* The WAITING_CONFIGURATION status also occupies the single external identity source quota for a workspace. CustomSSO (SAML/OIDC and SCIM) is mutually exclusive with DingTalk and Lark. SCIM reuses the CustomSSO binding and does not create a second identity source. Creating another type returns a 409 IdentityProviderAlreadyBound error. You can change the identity source only after the existing binding is unbound and removed.
|
|
693
|
+
* A workspace can have only one external identity source binding. The identityProviderType parameter supports DingTalk, Lark, and CustomSSO. CustomSSO only initializes the shared user pool. Do not pass non-empty metadata, and do not pass true for loginEnabled or syncEnabled. Both switches are disabled by default. Protocols and SAML configurations are saved by using UpdateIdentityProvider. SCIM is configured by using a separate API operation. You do not need to save SAML configurations first. If initialization is complete but SAML metadata is not saved, the system returns WAITING_CONFIGURATION. CONFIGURED and SYNCING indicate that the resource is still being initialized. You can call GetIdentityProvider to query the status. After you save the metadata, the system returns UPDATING. After the configuration is complete and the internal OIDC is published, the system returns READY. READY does not mean that the logon switch is enabled. For the same CustomSSO binding, the system may return the existing binding after the initialization request is accepted or completed. You cannot treat all statuses as repeatable creations.
|
|
694
|
+
* For DingTalk, the metadata must include appKey, appSecret, and corpId. For Lark, the metadata must include appId and appSecret. The vendor logon switch is enabled by default, and the synchronization switch is disabled by default. If 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.
|
|
694
695
|
* ## Requests and examples
|
|
695
696
|
* POST /workspaces/{workspaceId}/identity-providers
|
|
696
|
-
* 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
|
|
697
|
+
* Call 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 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 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.
|
|
697
698
|
* ```text
|
|
698
699
|
* POST /workspaces/ws-example/identity-providers
|
|
699
700
|
* {"identityProviderType": "CustomSSO"}
|
|
700
701
|
* ```
|
|
701
|
-
* ## Response
|
|
702
|
+
* ## Response examples
|
|
702
703
|
* ```json
|
|
703
704
|
* {
|
|
704
705
|
* "data": {
|
|
@@ -706,13 +707,15 @@ export default class Client extends OpenApi {
|
|
|
706
707
|
* "identityProviderType": "CustomSSO",
|
|
707
708
|
* "loginEnabled": false,
|
|
708
709
|
* "syncEnabled": false,
|
|
709
|
-
* "status": "
|
|
710
|
+
* "status": "WAITING_CONFIGURATION"
|
|
710
711
|
* }
|
|
711
712
|
* }
|
|
712
713
|
* ```
|
|
713
714
|
* ## Errors and handling
|
|
714
|
-
* 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.
|
|
715
|
-
* 409 IdentityProviderAlreadyBound: An external binding already exists. Query and reuse the correct binding first. Do not automatically unbind the entire binding.
|
|
715
|
+
* 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 matching type exists. If a synchronous call to the upstream service fails, a 503 IdentityProviderProvisioningUnavailable error may be returned. 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 process.
|
|
716
|
+
* 409 IdentityProviderAlreadyBound: An external binding already exists. Query and reuse the correct binding first. Do not automatically unbind the entire binding. If the initialization request fails, retain the request ID for troubleshooting. If a binding already exists, query the current status first to avoid repeated creation.
|
|
717
|
+
* ## Call relationships and usage boundaries
|
|
718
|
+
* CustomSSO call sequence: Create the binding first. After initialization is complete, the system returns WAITING_CONFIGURATION. If the system returns CONFIGURED or SYNCING, you can call GetIdentityProvider to query the status. Then, you can configure SAML and SCIM separately. You do not need to complete them in a fixed sequence. For SAML, use GetIdentityProviderServiceProvider to obtain the SP information of your side, and use UpdateIdentityProvider to save the external IdP configuration. For SCIM, use PrepareIdentityProviderSCIM to obtain the pre-provisioning address and credentials, and then use UpdateIdentityProviderSCIM to confirm synchronization.
|
|
716
719
|
*
|
|
717
720
|
* @param tmpReq - CreateIdentityProviderRequest
|
|
718
721
|
* @param headers - map
|
|
@@ -751,20 +754,21 @@ export default class Client extends OpenApi {
|
|
|
751
754
|
}
|
|
752
755
|
|
|
753
756
|
/**
|
|
754
|
-
* Binds
|
|
757
|
+
* Binds a DingTalk, Lark, or CustomSSO identity source to a workspace. CustomSSO only asynchronously initializes the shared user pool. SAML logon and SCIM synchronization are configured separately later.
|
|
755
758
|
*
|
|
756
759
|
* @remarks
|
|
757
760
|
* ## Features and prerequisites
|
|
758
|
-
*
|
|
759
|
-
*
|
|
761
|
+
* The WAITING_CONFIGURATION status also occupies the single external identity source quota for a workspace. CustomSSO (SAML/OIDC and SCIM) is mutually exclusive with DingTalk and Lark. SCIM reuses the CustomSSO binding and does not create a second identity source. Creating another type returns a 409 IdentityProviderAlreadyBound error. You can change the identity source only after the existing binding is unbound and removed.
|
|
762
|
+
* A workspace can have only one external identity source binding. The identityProviderType parameter supports DingTalk, Lark, and CustomSSO. CustomSSO only initializes the shared user pool. Do not pass non-empty metadata, and do not pass true for loginEnabled or syncEnabled. Both switches are disabled by default. Protocols and SAML configurations are saved by using UpdateIdentityProvider. SCIM is configured by using a separate API operation. You do not need to save SAML configurations first. If initialization is complete but SAML metadata is not saved, the system returns WAITING_CONFIGURATION. CONFIGURED and SYNCING indicate that the resource is still being initialized. You can call GetIdentityProvider to query the status. After you save the metadata, the system returns UPDATING. After the configuration is complete and the internal OIDC is published, the system returns READY. READY does not mean that the logon switch is enabled. For the same CustomSSO binding, the system may return the existing binding after the initialization request is accepted or completed. You cannot treat all statuses as repeatable creations.
|
|
763
|
+
* For DingTalk, the metadata must include appKey, appSecret, and corpId. For Lark, the metadata must include appId and appSecret. The vendor logon switch is enabled by default, and the synchronization switch is disabled by default. If 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.
|
|
760
764
|
* ## Requests and examples
|
|
761
765
|
* POST /workspaces/{workspaceId}/identity-providers
|
|
762
|
-
* 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
|
|
766
|
+
* Call 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 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 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.
|
|
763
767
|
* ```text
|
|
764
768
|
* POST /workspaces/ws-example/identity-providers
|
|
765
769
|
* {"identityProviderType": "CustomSSO"}
|
|
766
770
|
* ```
|
|
767
|
-
* ## Response
|
|
771
|
+
* ## Response examples
|
|
768
772
|
* ```json
|
|
769
773
|
* {
|
|
770
774
|
* "data": {
|
|
@@ -772,13 +776,15 @@ export default class Client extends OpenApi {
|
|
|
772
776
|
* "identityProviderType": "CustomSSO",
|
|
773
777
|
* "loginEnabled": false,
|
|
774
778
|
* "syncEnabled": false,
|
|
775
|
-
* "status": "
|
|
779
|
+
* "status": "WAITING_CONFIGURATION"
|
|
776
780
|
* }
|
|
777
781
|
* }
|
|
778
782
|
* ```
|
|
779
783
|
* ## Errors and handling
|
|
780
|
-
* 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.
|
|
781
|
-
* 409 IdentityProviderAlreadyBound: An external binding already exists. Query and reuse the correct binding first. Do not automatically unbind the entire binding.
|
|
784
|
+
* 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 matching type exists. If a synchronous call to the upstream service fails, a 503 IdentityProviderProvisioningUnavailable error may be returned. 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 process.
|
|
785
|
+
* 409 IdentityProviderAlreadyBound: An external binding already exists. Query and reuse the correct binding first. Do not automatically unbind the entire binding. If the initialization request fails, retain the request ID for troubleshooting. If a binding already exists, query the current status first to avoid repeated creation.
|
|
786
|
+
* ## Call relationships and usage boundaries
|
|
787
|
+
* CustomSSO call sequence: Create the binding first. After initialization is complete, the system returns WAITING_CONFIGURATION. If the system returns CONFIGURED or SYNCING, you can call GetIdentityProvider to query the status. Then, you can configure SAML and SCIM separately. You do not need to complete them in a fixed sequence. For SAML, use GetIdentityProviderServiceProvider to obtain the SP information of your side, and use UpdateIdentityProvider to save the external IdP configuration. For SCIM, use PrepareIdentityProviderSCIM to obtain the pre-provisioning address and credentials, and then use UpdateIdentityProviderSCIM to confirm synchronization.
|
|
782
788
|
*
|
|
783
789
|
* @param request - CreateIdentityProviderRequest
|
|
784
790
|
* @returns CreateIdentityProviderResponse
|
|
@@ -1925,15 +1931,15 @@ export default class Client extends OpenApi {
|
|
|
1925
1931
|
}
|
|
1926
1932
|
|
|
1927
1933
|
/**
|
|
1928
|
-
* 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
|
|
1934
|
+
* 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 toggle operations.
|
|
1929
1935
|
*
|
|
1930
1936
|
* @remarks
|
|
1931
1937
|
* ## Features and prerequisites
|
|
1932
|
-
* This operation
|
|
1933
|
-
* After the request is accepted, the
|
|
1938
|
+
* This operation disconnects the integration as a whole, rather than disabling logon individually. Disconnecting CustomSSO clears the 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. This operation does not delete the enterprise applications created by users on external platforms such as Azure. The system checks the references between users and teams before disconnecting. If references exist, the disconnection is rejected.
|
|
1939
|
+
* 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 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 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 operation as a substitute for setting loginEnabled=false, syncEnabled=false, or deleting a single token.
|
|
1934
1940
|
* ## Requests and examples
|
|
1935
1941
|
* DELETE /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
1936
|
-
* Calling conventions: Call
|
|
1942
|
+
* 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 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 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.
|
|
1937
1943
|
* ```text
|
|
1938
1944
|
* DELETE /workspaces/ws-example/identity-providers/CustomSSO
|
|
1939
1945
|
* ```
|
|
@@ -1948,10 +1954,10 @@ export default class Client extends OpenApi {
|
|
|
1948
1954
|
* }
|
|
1949
1955
|
* ```
|
|
1950
1956
|
* ## Errors and handling
|
|
1951
|
-
* 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
|
|
1957
|
+
* 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 fail and 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.
|
|
1952
1958
|
* 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.
|
|
1953
|
-
* ##
|
|
1954
|
-
* If you only need to disable a specific capability: To disable SAML logon,
|
|
1959
|
+
* ## Call relationships and usage boundaries
|
|
1960
|
+
* If you only need to disable a specific capability: To disable SAML logon, set loginEnabled=false in UpdateIdentityProvider. To disable SCIM, set syncEnabled=false in UpdateIdentityProviderSCIM. To revoke a single token, use DeleteIdentityProviderSCIMCredential. Call this operation only when you need to disconnect the integration as a whole.
|
|
1955
1961
|
*
|
|
1956
1962
|
* @param request - DeleteIdentityProviderRequest
|
|
1957
1963
|
* @param headers - map
|
|
@@ -1984,15 +1990,15 @@ export default class Client extends OpenApi {
|
|
|
1984
1990
|
}
|
|
1985
1991
|
|
|
1986
1992
|
/**
|
|
1987
|
-
* 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
|
|
1993
|
+
* 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 toggle operations.
|
|
1988
1994
|
*
|
|
1989
1995
|
* @remarks
|
|
1990
1996
|
* ## Features and prerequisites
|
|
1991
|
-
* This operation
|
|
1992
|
-
* After the request is accepted, the
|
|
1997
|
+
* This operation disconnects the integration as a whole, rather than disabling logon individually. Disconnecting CustomSSO clears the 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. This operation does not delete the enterprise applications created by users on external platforms such as Azure. The system checks the references between users and teams before disconnecting. If references exist, the disconnection is rejected.
|
|
1998
|
+
* 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 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 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 operation as a substitute for setting loginEnabled=false, syncEnabled=false, or deleting a single token.
|
|
1993
1999
|
* ## Requests and examples
|
|
1994
2000
|
* DELETE /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
1995
|
-
* Calling conventions: Call
|
|
2001
|
+
* 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 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 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.
|
|
1996
2002
|
* ```text
|
|
1997
2003
|
* DELETE /workspaces/ws-example/identity-providers/CustomSSO
|
|
1998
2004
|
* ```
|
|
@@ -2007,10 +2013,10 @@ export default class Client extends OpenApi {
|
|
|
2007
2013
|
* }
|
|
2008
2014
|
* ```
|
|
2009
2015
|
* ## Errors and handling
|
|
2010
|
-
* 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
|
|
2016
|
+
* 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 fail and 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.
|
|
2011
2017
|
* 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.
|
|
2012
|
-
* ##
|
|
2013
|
-
* If you only need to disable a specific capability: To disable SAML logon,
|
|
2018
|
+
* ## Call relationships and usage boundaries
|
|
2019
|
+
* If you only need to disable a specific capability: To disable SAML logon, set loginEnabled=false in UpdateIdentityProvider. To disable SCIM, set syncEnabled=false in UpdateIdentityProviderSCIM. To revoke a single token, use DeleteIdentityProviderSCIMCredential. Call this operation only when you need to disconnect the integration as a whole.
|
|
2014
2020
|
*
|
|
2015
2021
|
* @param request - DeleteIdentityProviderRequest
|
|
2016
2022
|
* @returns DeleteIdentityProviderResponse
|
|
@@ -2022,10 +2028,30 @@ export default class Client extends OpenApi {
|
|
|
2022
2028
|
}
|
|
2023
2029
|
|
|
2024
2030
|
/**
|
|
2025
|
-
*
|
|
2031
|
+
* Revokes a specified SCIM credential. This operation does not automatically create a new token, modify the AC synchronization switch, or disable SAML logon.
|
|
2026
2032
|
*
|
|
2027
2033
|
* @remarks
|
|
2028
|
-
* ##
|
|
2034
|
+
* ## Features and prerequisites
|
|
2035
|
+
* Revokes a specified credential. The credentialId parameter is required and cannot be empty. You can obtain it from the credential list. The shared pool must be available, but SAML configuration or SCIM accept being Enabled is not required. After deletion, external provisioning requests that use this token become invalid. This operation only affects the selected credential. It does not automatically disable the accept feature, does not automatically disable AC syncEnabled, and does not affect other credentials or SAML.
|
|
2036
|
+
* Even if you delete the last credential, the synchronization switch is not automatically written back and a new token is not reissued. Disable external provisioning or replace the token in use as needed. A successful response returns a common response without business data. Refresh the list to confirm the deletion. The result for unknown or deleted IDs is determined by the upstream service. A unified 404 or unconditional idempotent success is not guaranteed.
|
|
2037
|
+
* ## Request and examples
|
|
2038
|
+
* DELETE /workspaces/{workspaceId}/scim-provisioning/credentials/{credentialId}
|
|
2039
|
+
* Call conventions: Call the API in the region of the target workspace by using an AccessKey (AK) or Security Token Service (STS) identity 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-connect 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 record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
2040
|
+
* ```text
|
|
2041
|
+
* DELETE /workspaces/ws-example/scim-provisioning/credentials/credential-example
|
|
2042
|
+
* ```
|
|
2043
|
+
* ## Response example
|
|
2044
|
+
* ```json
|
|
2045
|
+
* {
|
|
2046
|
+
* "success": true,
|
|
2047
|
+
* "httpStatusCode": 200
|
|
2048
|
+
* }
|
|
2049
|
+
* ```
|
|
2050
|
+
* ## Errors and handling
|
|
2051
|
+
* 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. If a synchronous call to the upstream service fails, a 503 IdentityProviderProvisioningUnavailable error may be returned. Keep the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow common error handling.
|
|
2052
|
+
* 400 InvalidParameter: The credentialId parameter is empty or the shared pool is not available. 404 IdentityProviderNotFound indicates that the binding does not exist, which does not mean that all unknown credential IDs return this code. Handle other deletion errors based on upstream results. If the operation fails, refresh the list to check. No automatic creation of a replacement token is performed.
|
|
2053
|
+
* ## Call relationships and usage boundaries
|
|
2054
|
+
* Call ListIdentityProviderSCIMCredentials to obtain the credentialId and then delete the specified credential. If the external provisioning system still uses this token, subsequent provisioning may result in authentication failures. Therefore, confirm the actual usage first. After deletion, no automatic creation of a new credential is performed, and the AC synchronization switch or SAML logon is not disabled.
|
|
2029
2055
|
*
|
|
2030
2056
|
* @param request - DeleteIdentityProviderSCIMCredentialRequest
|
|
2031
2057
|
* @param headers - map
|
|
@@ -2052,10 +2078,30 @@ export default class Client extends OpenApi {
|
|
|
2052
2078
|
}
|
|
2053
2079
|
|
|
2054
2080
|
/**
|
|
2055
|
-
*
|
|
2081
|
+
* Revokes a specified SCIM credential. This operation does not automatically create a new token, modify the AC synchronization switch, or disable SAML logon.
|
|
2056
2082
|
*
|
|
2057
2083
|
* @remarks
|
|
2058
|
-
* ##
|
|
2084
|
+
* ## Features and prerequisites
|
|
2085
|
+
* Revokes a specified credential. The credentialId parameter is required and cannot be empty. You can obtain it from the credential list. The shared pool must be available, but SAML configuration or SCIM accept being Enabled is not required. After deletion, external provisioning requests that use this token become invalid. This operation only affects the selected credential. It does not automatically disable the accept feature, does not automatically disable AC syncEnabled, and does not affect other credentials or SAML.
|
|
2086
|
+
* Even if you delete the last credential, the synchronization switch is not automatically written back and a new token is not reissued. Disable external provisioning or replace the token in use as needed. A successful response returns a common response without business data. Refresh the list to confirm the deletion. The result for unknown or deleted IDs is determined by the upstream service. A unified 404 or unconditional idempotent success is not guaranteed.
|
|
2087
|
+
* ## Request and examples
|
|
2088
|
+
* DELETE /workspaces/{workspaceId}/scim-provisioning/credentials/{credentialId}
|
|
2089
|
+
* Call conventions: Call the API in the region of the target workspace by using an AccessKey (AK) or Security Token Service (STS) identity 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-connect 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 record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
2090
|
+
* ```text
|
|
2091
|
+
* DELETE /workspaces/ws-example/scim-provisioning/credentials/credential-example
|
|
2092
|
+
* ```
|
|
2093
|
+
* ## Response example
|
|
2094
|
+
* ```json
|
|
2095
|
+
* {
|
|
2096
|
+
* "success": true,
|
|
2097
|
+
* "httpStatusCode": 200
|
|
2098
|
+
* }
|
|
2099
|
+
* ```
|
|
2100
|
+
* ## Errors and handling
|
|
2101
|
+
* 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. If a synchronous call to the upstream service fails, a 503 IdentityProviderProvisioningUnavailable error may be returned. Keep the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow common error handling.
|
|
2102
|
+
* 400 InvalidParameter: The credentialId parameter is empty or the shared pool is not available. 404 IdentityProviderNotFound indicates that the binding does not exist, which does not mean that all unknown credential IDs return this code. Handle other deletion errors based on upstream results. If the operation fails, refresh the list to check. No automatic creation of a replacement token is performed.
|
|
2103
|
+
* ## Call relationships and usage boundaries
|
|
2104
|
+
* Call ListIdentityProviderSCIMCredentials to obtain the credentialId and then delete the specified credential. If the external provisioning system still uses this token, subsequent provisioning may result in authentication failures. Therefore, confirm the actual usage first. After deletion, no automatic creation of a new credential is performed, and the AC synchronization switch or SAML logon is not disabled.
|
|
2059
2105
|
*
|
|
2060
2106
|
* @param request - DeleteIdentityProviderSCIMCredentialRequest
|
|
2061
2107
|
* @returns DeleteIdentityProviderSCIMCredentialResponse
|
|
@@ -2818,6 +2864,57 @@ export default class Client extends OpenApi {
|
|
|
2818
2864
|
return await this.enableConnectorWithOptions(workspaceId, connectorName, request, headers, runtime);
|
|
2819
2865
|
}
|
|
2820
2866
|
|
|
2867
|
+
/**
|
|
2868
|
+
* Retrieves the image preparation task by using the client token submitted when creating or explicitly updating an image. This operation only queries the task and does not create a dump. If the returned phase is SUCCEEDED, the target version is deployed successfully.
|
|
2869
|
+
*
|
|
2870
|
+
* @remarks
|
|
2871
|
+
* Retrieves the task by using the original client token for creation or update when the response is lost. The backend parses the target agent and verifies permissions. A 404 error does not necessarily mean that the original submission was not accepted.
|
|
2872
|
+
*
|
|
2873
|
+
* @param request - FindCustomAgentImagePreparationRequest
|
|
2874
|
+
* @param headers - map
|
|
2875
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2876
|
+
* @returns FindCustomAgentImagePreparationResponse
|
|
2877
|
+
*/
|
|
2878
|
+
async findCustomAgentImagePreparationWithOptions(workspaceId: string, request: $_model.FindCustomAgentImagePreparationRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.FindCustomAgentImagePreparationResponse> {
|
|
2879
|
+
request.validate();
|
|
2880
|
+
let query : {[key: string ]: any} = { };
|
|
2881
|
+
if (!$dara.isNull(request.clientToken)) {
|
|
2882
|
+
query["clientToken"] = request.clientToken;
|
|
2883
|
+
}
|
|
2884
|
+
|
|
2885
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
2886
|
+
headers: headers,
|
|
2887
|
+
query: OpenApiUtil.query(query),
|
|
2888
|
+
});
|
|
2889
|
+
let params = new $OpenApiUtil.Params({
|
|
2890
|
+
action: "FindCustomAgentImagePreparation",
|
|
2891
|
+
version: "2026-08-04",
|
|
2892
|
+
protocol: "HTTPS",
|
|
2893
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/custom-image-preparations`,
|
|
2894
|
+
method: "GET",
|
|
2895
|
+
authType: "AK",
|
|
2896
|
+
style: "ROA",
|
|
2897
|
+
reqBodyType: "json",
|
|
2898
|
+
bodyType: "json",
|
|
2899
|
+
});
|
|
2900
|
+
return $dara.cast<$_model.FindCustomAgentImagePreparationResponse>(await this.callApi(params, req, runtime), new $_model.FindCustomAgentImagePreparationResponse({}));
|
|
2901
|
+
}
|
|
2902
|
+
|
|
2903
|
+
/**
|
|
2904
|
+
* Retrieves the image preparation task by using the client token submitted when creating or explicitly updating an image. This operation only queries the task and does not create a dump. If the returned phase is SUCCEEDED, the target version is deployed successfully.
|
|
2905
|
+
*
|
|
2906
|
+
* @remarks
|
|
2907
|
+
* Retrieves the task by using the original client token for creation or update when the response is lost. The backend parses the target agent and verifies permissions. A 404 error does not necessarily mean that the original submission was not accepted.
|
|
2908
|
+
*
|
|
2909
|
+
* @param request - FindCustomAgentImagePreparationRequest
|
|
2910
|
+
* @returns FindCustomAgentImagePreparationResponse
|
|
2911
|
+
*/
|
|
2912
|
+
async findCustomAgentImagePreparation(workspaceId: string, request: $_model.FindCustomAgentImagePreparationRequest): Promise<$_model.FindCustomAgentImagePreparationResponse> {
|
|
2913
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
2914
|
+
let headers : {[key: string ]: string} = { };
|
|
2915
|
+
return await this.findCustomAgentImagePreparationWithOptions(workspaceId, request, headers, runtime);
|
|
2916
|
+
}
|
|
2917
|
+
|
|
2821
2918
|
/**
|
|
2822
2919
|
* Skips the regular review process and forcibly publishes a specified Skill version.
|
|
2823
2920
|
*
|
|
@@ -3319,11 +3416,11 @@ export default class Client extends OpenApi {
|
|
|
3319
3416
|
}
|
|
3320
3417
|
|
|
3321
3418
|
/**
|
|
3322
|
-
* Queries the details of a custom agent in a specified workspace, including deployment
|
|
3419
|
+
* Queries the details of a custom agent in a specified workspace, including the deployment configuration, the execute status of the latest configuration version, and the instance status statistics of running instances.
|
|
3323
3420
|
*
|
|
3324
3421
|
* @remarks
|
|
3325
|
-
* After creating or updating a custom agent, you can poll this operation to query the execution result of the latest configuration version. latestVersionStatus corresponds to latestSpecVersion. latestExecutionError indicates the cause of the pending or failed
|
|
3326
|
-
* The returned configuration is the
|
|
3422
|
+
* After creating or updating a custom agent, you can poll this operation to query the execution result of the latest configuration version. latestVersionStatus corresponds to latestSpecVersion. latestExecutionError indicates the cause of the pending or failed state for the version. If retryable is true, you can query again later.
|
|
3423
|
+
* The returned configuration is the most recently submitted one and may not have taken effect yet. Verify the deployment and running status by combining latestVersionStatus, the overall agent status, and the sandboxPhaseCounts running instance statistics.
|
|
3327
3424
|
* If the queried custom agent does not exist, has been deleted, or does not belong to the specified workspace, a resource not found error is returned.
|
|
3328
3425
|
*
|
|
3329
3426
|
* @param request - GetCustomAgentRequest
|
|
@@ -3351,11 +3448,11 @@ export default class Client extends OpenApi {
|
|
|
3351
3448
|
}
|
|
3352
3449
|
|
|
3353
3450
|
/**
|
|
3354
|
-
* Queries the details of a custom agent in a specified workspace, including deployment
|
|
3451
|
+
* Queries the details of a custom agent in a specified workspace, including the deployment configuration, the execute status of the latest configuration version, and the instance status statistics of running instances.
|
|
3355
3452
|
*
|
|
3356
3453
|
* @remarks
|
|
3357
|
-
* After creating or updating a custom agent, you can poll this operation to query the execution result of the latest configuration version. latestVersionStatus corresponds to latestSpecVersion. latestExecutionError indicates the cause of the pending or failed
|
|
3358
|
-
* The returned configuration is the
|
|
3454
|
+
* After creating or updating a custom agent, you can poll this operation to query the execution result of the latest configuration version. latestVersionStatus corresponds to latestSpecVersion. latestExecutionError indicates the cause of the pending or failed state for the version. If retryable is true, you can query again later.
|
|
3455
|
+
* The returned configuration is the most recently submitted one and may not have taken effect yet. Verify the deployment and running status by combining latestVersionStatus, the overall agent status, and the sandboxPhaseCounts running instance statistics.
|
|
3359
3456
|
* If the queried custom agent does not exist, has been deleted, or does not belong to the specified workspace, a resource not found error is returned.
|
|
3360
3457
|
*
|
|
3361
3458
|
* @param request - GetCustomAgentRequest
|
|
@@ -3367,6 +3464,51 @@ export default class Client extends OpenApi {
|
|
|
3367
3464
|
return await this.getCustomAgentWithOptions(workspaceId, agentId, request, headers, runtime);
|
|
3368
3465
|
}
|
|
3369
3466
|
|
|
3467
|
+
/**
|
|
3468
|
+
* Queries the image preparation and deployment phases by using the preparation ID. Regular polling does not create a dump task. Only phase=SUCCEEDED indicates that the deployment of the target version is successful. The health of the previous instance does not indicate the success of the current deployment.
|
|
3469
|
+
*
|
|
3470
|
+
* @remarks
|
|
3471
|
+
* Queries the preparation and deployment phases of the current submission. The health of the previous instance does not indicate the success of the current deployment. Only phase=SUCCEEDED indicates completion. Regular polling does not create a dump task. A network interruption does not indicate task failure.
|
|
3472
|
+
*
|
|
3473
|
+
* @param request - GetCustomAgentImagePreparationRequest
|
|
3474
|
+
* @param headers - map
|
|
3475
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3476
|
+
* @returns GetCustomAgentImagePreparationResponse
|
|
3477
|
+
*/
|
|
3478
|
+
async getCustomAgentImagePreparationWithOptions(workspaceId: string, preparationId: string, request: $_model.GetCustomAgentImagePreparationRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.GetCustomAgentImagePreparationResponse> {
|
|
3479
|
+
request.validate();
|
|
3480
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
3481
|
+
headers: headers,
|
|
3482
|
+
});
|
|
3483
|
+
let params = new $OpenApiUtil.Params({
|
|
3484
|
+
action: "GetCustomAgentImagePreparation",
|
|
3485
|
+
version: "2026-08-04",
|
|
3486
|
+
protocol: "HTTPS",
|
|
3487
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/custom-image-preparations/${$dara.URL.percentEncode(preparationId)}`,
|
|
3488
|
+
method: "GET",
|
|
3489
|
+
authType: "AK",
|
|
3490
|
+
style: "ROA",
|
|
3491
|
+
reqBodyType: "json",
|
|
3492
|
+
bodyType: "json",
|
|
3493
|
+
});
|
|
3494
|
+
return $dara.cast<$_model.GetCustomAgentImagePreparationResponse>(await this.callApi(params, req, runtime), new $_model.GetCustomAgentImagePreparationResponse({}));
|
|
3495
|
+
}
|
|
3496
|
+
|
|
3497
|
+
/**
|
|
3498
|
+
* Queries the image preparation and deployment phases by using the preparation ID. Regular polling does not create a dump task. Only phase=SUCCEEDED indicates that the deployment of the target version is successful. The health of the previous instance does not indicate the success of the current deployment.
|
|
3499
|
+
*
|
|
3500
|
+
* @remarks
|
|
3501
|
+
* Queries the preparation and deployment phases of the current submission. The health of the previous instance does not indicate the success of the current deployment. Only phase=SUCCEEDED indicates completion. Regular polling does not create a dump task. A network interruption does not indicate task failure.
|
|
3502
|
+
*
|
|
3503
|
+
* @param request - GetCustomAgentImagePreparationRequest
|
|
3504
|
+
* @returns GetCustomAgentImagePreparationResponse
|
|
3505
|
+
*/
|
|
3506
|
+
async getCustomAgentImagePreparation(workspaceId: string, preparationId: string, request: $_model.GetCustomAgentImagePreparationRequest): Promise<$_model.GetCustomAgentImagePreparationResponse> {
|
|
3507
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
3508
|
+
let headers : {[key: string ]: string} = { };
|
|
3509
|
+
return await this.getCustomAgentImagePreparationWithOptions(workspaceId, preparationId, request, headers, runtime);
|
|
3510
|
+
}
|
|
3511
|
+
|
|
3370
3512
|
/**
|
|
3371
3513
|
* Queries the details of a specified external agent.
|
|
3372
3514
|
*
|
|
@@ -3458,15 +3600,15 @@ export default class Client extends OpenApi {
|
|
|
3458
3600
|
}
|
|
3459
3601
|
|
|
3460
3602
|
/**
|
|
3461
|
-
* Queries the binding and expected configuration of a specified identity provider.
|
|
3603
|
+
* Queries the binding and expected configuration of a specified identity provider. If CustomSSO is configured with SAML, this operation reads back the actual upstream SSO configuration. The SCIM status is queried through a separate API operation.
|
|
3462
3604
|
*
|
|
3463
3605
|
* @remarks
|
|
3464
3606
|
* ## Features and prerequisites
|
|
3465
|
-
* Reads existing bindings by type. CustomSSO returns the saved protocol,
|
|
3466
|
-
* Only this operation reads back the actual SAML configuration. List and write operations do not guarantee that configuration is returned.
|
|
3467
|
-
* ##
|
|
3607
|
+
* Reads existing bindings by type. CustomSSO returns the saved protocol, normalized saml, expected loginEnabled, syncEnabled, and shared binding status. If SAML is not configured, saml and configuration may not be returned. If 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 is Enabled or Disabled. If the upstream query fails, an error is returned. The failure cannot be treated as an unconfigured state.
|
|
3608
|
+
* Only this operation reads back the actual SAML configuration. List and write operations do not guarantee that configuration is returned. WAITING_CONFIGURATION indicates that user pool initialization is complete but the SAML metadata has not been saved. In this case, you can read the service provider (SP) information, fill in the configuration, or disconnect the integration. Do not lock the form and wait for the READY state. 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.
|
|
3609
|
+
* ## Requests and examples
|
|
3468
3610
|
* GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
3469
|
-
*
|
|
3611
|
+
* Call conventions: Call the operation in the region of the target workspace by using an AccessKey pair or STS credential 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 data. 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 persistent connection to wait for completion.
|
|
3470
3612
|
* ```text
|
|
3471
3613
|
* GET /workspaces/ws-example/identity-providers/CustomSSO
|
|
3472
3614
|
* ```
|
|
@@ -3476,17 +3618,17 @@ export default class Client extends OpenApi {
|
|
|
3476
3618
|
* "data": {
|
|
3477
3619
|
* "workspaceId": "ws-example",
|
|
3478
3620
|
* "identityProviderType": "CustomSSO",
|
|
3479
|
-
* "status": "
|
|
3621
|
+
* "status": "WAITING_CONFIGURATION",
|
|
3480
3622
|
* "loginEnabled": false,
|
|
3481
3623
|
* "syncEnabled": false
|
|
3482
3624
|
* }
|
|
3483
3625
|
* }
|
|
3484
3626
|
* ```
|
|
3485
3627
|
* ## Errors and handling
|
|
3486
|
-
* 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
|
|
3628
|
+
* 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 non-existence errors follow common error handling procedures.
|
|
3487
3629
|
* 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.
|
|
3488
3630
|
* ## Call relationships and usage boundaries
|
|
3489
|
-
* 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
|
|
3631
|
+
* SAML configuration completion and logon enabling are independent operations. protocol=SAML and the presence of the saml field 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 operation. Do not use status=READY of this operation as the basis for successful SCIM synchronization. Currently, OIDC and JIT configurations or JIT status fields are not provided.
|
|
3490
3632
|
*
|
|
3491
3633
|
* @param request - GetIdentityProviderRequest
|
|
3492
3634
|
* @param headers - map
|
|
@@ -3513,15 +3655,15 @@ export default class Client extends OpenApi {
|
|
|
3513
3655
|
}
|
|
3514
3656
|
|
|
3515
3657
|
/**
|
|
3516
|
-
* Queries the binding and expected configuration of a specified identity provider.
|
|
3658
|
+
* Queries the binding and expected configuration of a specified identity provider. If CustomSSO is configured with SAML, this operation reads back the actual upstream SSO configuration. The SCIM status is queried through a separate API operation.
|
|
3517
3659
|
*
|
|
3518
3660
|
* @remarks
|
|
3519
3661
|
* ## Features and prerequisites
|
|
3520
|
-
* Reads existing bindings by type. CustomSSO returns the saved protocol,
|
|
3521
|
-
* Only this operation reads back the actual SAML configuration. List and write operations do not guarantee that configuration is returned.
|
|
3522
|
-
* ##
|
|
3662
|
+
* Reads existing bindings by type. CustomSSO returns the saved protocol, normalized saml, expected loginEnabled, syncEnabled, and shared binding status. If SAML is not configured, saml and configuration may not be returned. If 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 is Enabled or Disabled. If the upstream query fails, an error is returned. The failure cannot be treated as an unconfigured state.
|
|
3663
|
+
* Only this operation reads back the actual SAML configuration. List and write operations do not guarantee that configuration is returned. WAITING_CONFIGURATION indicates that user pool initialization is complete but the SAML metadata has not been saved. In this case, you can read the service provider (SP) information, fill in the configuration, or disconnect the integration. Do not lock the form and wait for the READY state. 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.
|
|
3664
|
+
* ## Requests and examples
|
|
3523
3665
|
* GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
3524
|
-
*
|
|
3666
|
+
* Call conventions: Call the operation in the region of the target workspace by using an AccessKey pair or STS credential 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 data. 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 persistent connection to wait for completion.
|
|
3525
3667
|
* ```text
|
|
3526
3668
|
* GET /workspaces/ws-example/identity-providers/CustomSSO
|
|
3527
3669
|
* ```
|
|
@@ -3531,17 +3673,17 @@ export default class Client extends OpenApi {
|
|
|
3531
3673
|
* "data": {
|
|
3532
3674
|
* "workspaceId": "ws-example",
|
|
3533
3675
|
* "identityProviderType": "CustomSSO",
|
|
3534
|
-
* "status": "
|
|
3676
|
+
* "status": "WAITING_CONFIGURATION",
|
|
3535
3677
|
* "loginEnabled": false,
|
|
3536
3678
|
* "syncEnabled": false
|
|
3537
3679
|
* }
|
|
3538
3680
|
* }
|
|
3539
3681
|
* ```
|
|
3540
3682
|
* ## Errors and handling
|
|
3541
|
-
* 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
|
|
3683
|
+
* 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 non-existence errors follow common error handling procedures.
|
|
3542
3684
|
* 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.
|
|
3543
3685
|
* ## Call relationships and usage boundaries
|
|
3544
|
-
* 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
|
|
3686
|
+
* SAML configuration completion and logon enabling are independent operations. protocol=SAML and the presence of the saml field 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 operation. Do not use status=READY of this operation as the basis for successful SCIM synchronization. Currently, OIDC and JIT configurations or JIT status fields are not provided.
|
|
3545
3687
|
*
|
|
3546
3688
|
* @param request - GetIdentityProviderRequest
|
|
3547
3689
|
* @returns GetIdentityProviderResponse
|
|
@@ -3557,18 +3699,34 @@ export default class Client extends OpenApi {
|
|
|
3557
3699
|
*
|
|
3558
3700
|
* @remarks
|
|
3559
3701
|
* ## Features and prerequisites
|
|
3560
|
-
* The shared CustomSSO user pool must be created and
|
|
3561
|
-
* operationStatus
|
|
3702
|
+
* The shared CustomSSO user pool must be created and not in the process of overall unbinding or unbinding failure. Prior SAML configuration is not required. SAML updates or update failures do not block the query. configuration.status and baseUrl are retrieved from AgentIdentity. syncEnabled is the expected synchronization switch for AC. operationStatus represents the most recent independent SCIM switch and the initial full import task when enabled. The presence of a URL does not indicate that external provisioning is complete or that AC synchronization is enabled.
|
|
3703
|
+
* operationStatus valid values:
|
|
3704
|
+
* - PENDING: Waiting.
|
|
3705
|
+
* - RUNNING: Executing.
|
|
3706
|
+
* - PAUSED: Paused.
|
|
3707
|
+
* - SUCCESS: Succeeded.
|
|
3708
|
+
* - FAILED: Failed.
|
|
3709
|
+
* - CANCELED: Canceled.
|
|
3710
|
+
* 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 the taskId or failure details, and does not indicate credential issuance, external provisioning connection tests, or continuous incremental synchronization health. The URL, credentials, and historical task records may be retained after the feature is disabled.
|
|
3711
|
+
* status represents the independent SCIM configuration status:
|
|
3712
|
+
* - UNCONFIGURED: Preparation is not complete.
|
|
3713
|
+
* - WAITING_CONFIGURATION: The receiving end is enabled, the HTTPS URL is valid, and a valid token exists, waiting for external configuration and enablement confirmation.
|
|
3714
|
+
* - UPDATING: The enablement or disablement task is executing.
|
|
3715
|
+
* - READY: Synchronization is enabled and the current enablement task succeeded, and the receiving end, URL, and credentials are still available.
|
|
3716
|
+
* - DISABLED: Disabled and configuration is retained.
|
|
3717
|
+
* - UPDATE_FAILED: The operation failed, was paused, was canceled, or the configuration and credentials are unavailable after enablement.
|
|
3718
|
+
* The original facts of configuration, syncEnabled, and operationStatus are retained. The SAML or OIDC binding status is not used to determine the SCIM status. READY does not prove that Matrix execution is complete, the external connection test passed, or continuous incremental synchronization is healthy.
|
|
3562
3719
|
* ## Requests and examples
|
|
3563
3720
|
* GET /workspaces/{workspaceId}/scim-provisioning
|
|
3564
|
-
*
|
|
3721
|
+
* Call conventions: Call this operation in the region of the target workspace by using an AccessKey pair or STS token that has the 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, 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. 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.
|
|
3565
3722
|
* ```text
|
|
3566
3723
|
* GET /workspaces/ws-example/scim-provisioning
|
|
3567
3724
|
* ```
|
|
3568
|
-
* ## Response
|
|
3725
|
+
* ## Response examples
|
|
3569
3726
|
* ```json
|
|
3570
3727
|
* {
|
|
3571
3728
|
* "data": {
|
|
3729
|
+
* "status": "READY",
|
|
3572
3730
|
* "configuration": {
|
|
3573
3731
|
* "status": "Enabled",
|
|
3574
3732
|
* "baseUrl": "https://example.com/scim/v2"
|
|
@@ -3579,10 +3737,10 @@ export default class Client extends OpenApi {
|
|
|
3579
3737
|
* }
|
|
3580
3738
|
* ```
|
|
3581
3739
|
* ## Errors and handling
|
|
3582
|
-
* 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.
|
|
3583
|
-
* 400 InvalidParameter: The shared user pool is unavailable, being
|
|
3740
|
+
* 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 the common error handling process.
|
|
3741
|
+
* 400 InvalidParameter: The shared user pool is unavailable, being unbound, or failed to unbind. 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 succeeded.
|
|
3584
3742
|
* ## Call relationships and usage boundaries
|
|
3585
|
-
* 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
|
|
3743
|
+
* 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 complete, and does not represent continuous incremental synchronization health or the success of the external provisioning connection test.
|
|
3586
3744
|
*
|
|
3587
3745
|
* @param request - GetIdentityProviderSCIMRequest
|
|
3588
3746
|
* @param headers - map
|
|
@@ -3613,18 +3771,34 @@ export default class Client extends OpenApi {
|
|
|
3613
3771
|
*
|
|
3614
3772
|
* @remarks
|
|
3615
3773
|
* ## Features and prerequisites
|
|
3616
|
-
* The shared CustomSSO user pool must be created and
|
|
3617
|
-
* operationStatus
|
|
3774
|
+
* The shared CustomSSO user pool must be created and not in the process of overall unbinding or unbinding failure. Prior SAML configuration is not required. SAML updates or update failures do not block the query. configuration.status and baseUrl are retrieved from AgentIdentity. syncEnabled is the expected synchronization switch for AC. operationStatus represents the most recent independent SCIM switch and the initial full import task when enabled. The presence of a URL does not indicate that external provisioning is complete or that AC synchronization is enabled.
|
|
3775
|
+
* operationStatus valid values:
|
|
3776
|
+
* - PENDING: Waiting.
|
|
3777
|
+
* - RUNNING: Executing.
|
|
3778
|
+
* - PAUSED: Paused.
|
|
3779
|
+
* - SUCCESS: Succeeded.
|
|
3780
|
+
* - FAILED: Failed.
|
|
3781
|
+
* - CANCELED: Canceled.
|
|
3782
|
+
* 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 the taskId or failure details, and does not indicate credential issuance, external provisioning connection tests, or continuous incremental synchronization health. The URL, credentials, and historical task records may be retained after the feature is disabled.
|
|
3783
|
+
* status represents the independent SCIM configuration status:
|
|
3784
|
+
* - UNCONFIGURED: Preparation is not complete.
|
|
3785
|
+
* - WAITING_CONFIGURATION: The receiving end is enabled, the HTTPS URL is valid, and a valid token exists, waiting for external configuration and enablement confirmation.
|
|
3786
|
+
* - UPDATING: The enablement or disablement task is executing.
|
|
3787
|
+
* - READY: Synchronization is enabled and the current enablement task succeeded, and the receiving end, URL, and credentials are still available.
|
|
3788
|
+
* - DISABLED: Disabled and configuration is retained.
|
|
3789
|
+
* - UPDATE_FAILED: The operation failed, was paused, was canceled, or the configuration and credentials are unavailable after enablement.
|
|
3790
|
+
* The original facts of configuration, syncEnabled, and operationStatus are retained. The SAML or OIDC binding status is not used to determine the SCIM status. READY does not prove that Matrix execution is complete, the external connection test passed, or continuous incremental synchronization is healthy.
|
|
3618
3791
|
* ## Requests and examples
|
|
3619
3792
|
* GET /workspaces/{workspaceId}/scim-provisioning
|
|
3620
|
-
*
|
|
3793
|
+
* Call conventions: Call this operation in the region of the target workspace by using an AccessKey pair or STS token that has the 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, 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. 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.
|
|
3621
3794
|
* ```text
|
|
3622
3795
|
* GET /workspaces/ws-example/scim-provisioning
|
|
3623
3796
|
* ```
|
|
3624
|
-
* ## Response
|
|
3797
|
+
* ## Response examples
|
|
3625
3798
|
* ```json
|
|
3626
3799
|
* {
|
|
3627
3800
|
* "data": {
|
|
3801
|
+
* "status": "READY",
|
|
3628
3802
|
* "configuration": {
|
|
3629
3803
|
* "status": "Enabled",
|
|
3630
3804
|
* "baseUrl": "https://example.com/scim/v2"
|
|
@@ -3635,10 +3809,10 @@ export default class Client extends OpenApi {
|
|
|
3635
3809
|
* }
|
|
3636
3810
|
* ```
|
|
3637
3811
|
* ## Errors and handling
|
|
3638
|
-
* 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.
|
|
3639
|
-
* 400 InvalidParameter: The shared user pool is unavailable, being
|
|
3812
|
+
* 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 the common error handling process.
|
|
3813
|
+
* 400 InvalidParameter: The shared user pool is unavailable, being unbound, or failed to unbind. 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 succeeded.
|
|
3640
3814
|
* ## Call relationships and usage boundaries
|
|
3641
|
-
* 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
|
|
3815
|
+
* 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 complete, and does not represent continuous incremental synchronization health or the success of the external provisioning connection test.
|
|
3642
3816
|
*
|
|
3643
3817
|
* @param request - GetIdentityProviderSCIMRequest
|
|
3644
3818
|
* @returns GetIdentityProviderSCIMResponse
|
|
@@ -3650,10 +3824,34 @@ export default class Client extends OpenApi {
|
|
|
3650
3824
|
}
|
|
3651
3825
|
|
|
3652
3826
|
/**
|
|
3653
|
-
*
|
|
3827
|
+
* Queries the SAML service provider (SP) information for CustomSSO, including the entity ID, ACS URL, and SP metadata XML, for configuring an external IdP.
|
|
3654
3828
|
*
|
|
3655
3829
|
* @remarks
|
|
3656
|
-
* ##
|
|
3830
|
+
* ## Features and prerequisites
|
|
3831
|
+
* An available CustomSSO shared user pool is required. The identityProviderType must be CustomSSO. The protocol parameter is required and only supports the exact value SAML. Uploading the IdP metadata in advance is not required. This operation returns the entityId, acsUrl, and metadataXml of the SP for configuring an external IdP. These values are not the logon URL or IdP entity ID of the external IdP. You cannot submit the SP XML as the IdP XML to UpdateIdentityProvider.
|
|
3832
|
+
* This operation is read-only. It does not enable logon, enable SCIM, create credentials, or perform logon connection tests. You cannot read the information when the shared pool is being initialized, being unbound, or has failed to unbind.
|
|
3833
|
+
* ## Requests and examples
|
|
3834
|
+
* GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}/service-provider
|
|
3835
|
+
* 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, 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, 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 record keys. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
|
|
3836
|
+
* ```text
|
|
3837
|
+
* GET /workspaces/ws-example/identity-providers/CustomSSO/service-provider?protocol=SAML
|
|
3838
|
+
* ```
|
|
3839
|
+
* ## Response examples
|
|
3840
|
+
* ```json
|
|
3841
|
+
* {
|
|
3842
|
+
* "data": {
|
|
3843
|
+
* "protocol": "SAML",
|
|
3844
|
+
* "entityId": "<SP entity ID>",
|
|
3845
|
+
* "acsUrl": "https://example.com/saml/acs",
|
|
3846
|
+
* "metadataXml": "<SP metadata XML>"
|
|
3847
|
+
* }
|
|
3848
|
+
* }
|
|
3849
|
+
* ```
|
|
3850
|
+
* ## Errors and handling
|
|
3851
|
+
* 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 a read failure as unconfigured. Actual authentication and workspace non-existence errors follow common error handling.
|
|
3852
|
+
* 400 InvalidParameter: identityProviderType or protocol is not supported. 404 IdentityProviderNotFound: No CustomSSO binding exists. 409 IdentityProviderOperationConflict: The user pool is not ready, is being unbound, or has failed to unbind.
|
|
3853
|
+
* ## Call relationships and usage boundaries
|
|
3854
|
+
* SAML configuration sequence: Call CreateIdentityProvider to initialize the CustomSSO shared pool and wait for GetIdentityProvider to return READY. Call this operation to obtain the SP information and configure it in the external IdP. Then, submit the external IdP metadata XML or complete manual configuration to UpdateIdentityProvider. After saving, enable loginEnabled separately as needed. Querying the SP information does not complete the external IdP configuration or verify logon.
|
|
3657
3855
|
*
|
|
3658
3856
|
* @param request - GetIdentityProviderServiceProviderRequest
|
|
3659
3857
|
* @param headers - map
|
|
@@ -3686,10 +3884,34 @@ export default class Client extends OpenApi {
|
|
|
3686
3884
|
}
|
|
3687
3885
|
|
|
3688
3886
|
/**
|
|
3689
|
-
*
|
|
3887
|
+
* Queries the SAML service provider (SP) information for CustomSSO, including the entity ID, ACS URL, and SP metadata XML, for configuring an external IdP.
|
|
3690
3888
|
*
|
|
3691
3889
|
* @remarks
|
|
3692
|
-
* ##
|
|
3890
|
+
* ## Features and prerequisites
|
|
3891
|
+
* An available CustomSSO shared user pool is required. The identityProviderType must be CustomSSO. The protocol parameter is required and only supports the exact value SAML. Uploading the IdP metadata in advance is not required. This operation returns the entityId, acsUrl, and metadataXml of the SP for configuring an external IdP. These values are not the logon URL or IdP entity ID of the external IdP. You cannot submit the SP XML as the IdP XML to UpdateIdentityProvider.
|
|
3892
|
+
* This operation is read-only. It does not enable logon, enable SCIM, create credentials, or perform logon connection tests. You cannot read the information when the shared pool is being initialized, being unbound, or has failed to unbind.
|
|
3893
|
+
* ## Requests and examples
|
|
3894
|
+
* GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}/service-provider
|
|
3895
|
+
* 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, 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, 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 record keys. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
|
|
3896
|
+
* ```text
|
|
3897
|
+
* GET /workspaces/ws-example/identity-providers/CustomSSO/service-provider?protocol=SAML
|
|
3898
|
+
* ```
|
|
3899
|
+
* ## Response examples
|
|
3900
|
+
* ```json
|
|
3901
|
+
* {
|
|
3902
|
+
* "data": {
|
|
3903
|
+
* "protocol": "SAML",
|
|
3904
|
+
* "entityId": "<SP entity ID>",
|
|
3905
|
+
* "acsUrl": "https://example.com/saml/acs",
|
|
3906
|
+
* "metadataXml": "<SP metadata XML>"
|
|
3907
|
+
* }
|
|
3908
|
+
* }
|
|
3909
|
+
* ```
|
|
3910
|
+
* ## Errors and handling
|
|
3911
|
+
* 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 a read failure as unconfigured. Actual authentication and workspace non-existence errors follow common error handling.
|
|
3912
|
+
* 400 InvalidParameter: identityProviderType or protocol is not supported. 404 IdentityProviderNotFound: No CustomSSO binding exists. 409 IdentityProviderOperationConflict: The user pool is not ready, is being unbound, or has failed to unbind.
|
|
3913
|
+
* ## Call relationships and usage boundaries
|
|
3914
|
+
* SAML configuration sequence: Call CreateIdentityProvider to initialize the CustomSSO shared pool and wait for GetIdentityProvider to return READY. Call this operation to obtain the SP information and configure it in the external IdP. Then, submit the external IdP metadata XML or complete manual configuration to UpdateIdentityProvider. After saving, enable loginEnabled separately as needed. Querying the SP information does not complete the external IdP configuration or verify logon.
|
|
3693
3915
|
*
|
|
3694
3916
|
* @param request - GetIdentityProviderServiceProviderRequest
|
|
3695
3917
|
* @returns GetIdentityProviderServiceProviderResponse
|
|
@@ -4652,10 +4874,10 @@ export default class Client extends OpenApi {
|
|
|
4652
4874
|
}
|
|
4653
4875
|
|
|
4654
4876
|
/**
|
|
4655
|
-
* Queries the
|
|
4877
|
+
* Queries the RAM authorization URL for ACR in a workspace.
|
|
4656
4878
|
*
|
|
4657
4879
|
* @remarks
|
|
4658
|
-
* ACR and user OSS mounts share the workspace role. If no existing role is found, AliyunAgentCoreWorkspace-{workspaceId} is used. If a valid legacy OSS mount role exists, it is
|
|
4880
|
+
* ACR and user OSS mounts share the workspace role. If no existing role is found, AliyunAgentCoreWorkspace-{workspaceId} is used. If a valid legacy OSS mount role exists, it is retained and only new permissions are appended without overwriting existing OSS policies. Fixed historical shared roles continue to be reused and are not recreated or renamed due to new naming templates. The acrInstanceId, namespace, and repository parameters are required. The region and account are derived from the workspace context. Returns the role resolved by the backend and the authorization URL for the target repository. It does not create ACR or agent execution versions, nor does it deliver runtime configurations. After authorization is complete, you can verify it and then create or update the agent without calling a separate Ensure operation.
|
|
4659
4881
|
*
|
|
4660
4882
|
* @param request - GetWorkspaceAcrRamAuthorizeUrlRequest
|
|
4661
4883
|
* @param headers - map
|
|
@@ -4696,10 +4918,10 @@ export default class Client extends OpenApi {
|
|
|
4696
4918
|
}
|
|
4697
4919
|
|
|
4698
4920
|
/**
|
|
4699
|
-
* Queries the
|
|
4921
|
+
* Queries the RAM authorization URL for ACR in a workspace.
|
|
4700
4922
|
*
|
|
4701
4923
|
* @remarks
|
|
4702
|
-
* ACR and user OSS mounts share the workspace role. If no existing role is found, AliyunAgentCoreWorkspace-{workspaceId} is used. If a valid legacy OSS mount role exists, it is
|
|
4924
|
+
* ACR and user OSS mounts share the workspace role. If no existing role is found, AliyunAgentCoreWorkspace-{workspaceId} is used. If a valid legacy OSS mount role exists, it is retained and only new permissions are appended without overwriting existing OSS policies. Fixed historical shared roles continue to be reused and are not recreated or renamed due to new naming templates. The acrInstanceId, namespace, and repository parameters are required. The region and account are derived from the workspace context. Returns the role resolved by the backend and the authorization URL for the target repository. It does not create ACR or agent execution versions, nor does it deliver runtime configurations. After authorization is complete, you can verify it and then create or update the agent without calling a separate Ensure operation.
|
|
4703
4925
|
*
|
|
4704
4926
|
* @param request - GetWorkspaceAcrRamAuthorizeUrlRequest
|
|
4705
4927
|
* @returns GetWorkspaceAcrRamAuthorizeUrlResponse
|
|
@@ -5382,12 +5604,12 @@ export default class Client extends OpenApi {
|
|
|
5382
5604
|
}
|
|
5383
5605
|
|
|
5384
5606
|
/**
|
|
5385
|
-
* Performs a paged query
|
|
5607
|
+
* Performs a paged query to retrieve the custom agent summary in a specified workspace. Use paging to navigate through the results. To obtain the complete configuration and execute the latest version to get the results, call GetCustomAgent.
|
|
5386
5608
|
*
|
|
5387
5609
|
* @remarks
|
|
5388
|
-
* The default value of maxResults is 20 and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
|
|
5389
|
-
* Omit nextToken in the first request. For subsequent requests, pass the nextToken returned in the previous response as is and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it. An empty token in the response indicates that there are no more pages.
|
|
5390
|
-
* This operation returns the summaries
|
|
5610
|
+
* The default value of maxResults is 20, and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
|
|
5611
|
+
* Omit nextToken in the first request. For subsequent requests, pass the nextToken returned in the previous response as is, and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it. An empty token in the response indicates that there are no more pages.
|
|
5612
|
+
* This operation returns the summaries for the current page and does not return the complete deployment configurations or the execution errors of the latest version. To obtain this information, call GetCustomAgent by using the agentId from items.
|
|
5391
5613
|
*
|
|
5392
5614
|
* @param request - ListCustomAgentsRequest
|
|
5393
5615
|
* @param headers - map
|
|
@@ -5424,12 +5646,12 @@ export default class Client extends OpenApi {
|
|
|
5424
5646
|
}
|
|
5425
5647
|
|
|
5426
5648
|
/**
|
|
5427
|
-
* Performs a paged query
|
|
5649
|
+
* Performs a paged query to retrieve the custom agent summary in a specified workspace. Use paging to navigate through the results. To obtain the complete configuration and execute the latest version to get the results, call GetCustomAgent.
|
|
5428
5650
|
*
|
|
5429
5651
|
* @remarks
|
|
5430
|
-
* The default value of maxResults is 20 and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
|
|
5431
|
-
* Omit nextToken in the first request. For subsequent requests, pass the nextToken returned in the previous response as is and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it. An empty token in the response indicates that there are no more pages.
|
|
5432
|
-
* This operation returns the summaries
|
|
5652
|
+
* The default value of maxResults is 20, and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
|
|
5653
|
+
* Omit nextToken in the first request. For subsequent requests, pass the nextToken returned in the previous response as is, and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it. An empty token in the response indicates that there are no more pages.
|
|
5654
|
+
* This operation returns the summaries for the current page and does not return the complete deployment configurations or the execution errors of the latest version. To obtain this information, call GetCustomAgent by using the agentId from items.
|
|
5433
5655
|
*
|
|
5434
5656
|
* @param request - ListCustomAgentsRequest
|
|
5435
5657
|
* @returns ListCustomAgentsResponse
|
|
@@ -5704,22 +5926,23 @@ export default class Client extends OpenApi {
|
|
|
5704
5926
|
*
|
|
5705
5927
|
* @remarks
|
|
5706
5928
|
* ## Features and prerequisites
|
|
5707
|
-
*
|
|
5708
|
-
*
|
|
5929
|
+
* WAITING_CONFIGURATION also occupies the unique external identity provider quota for the workspace. CustomSSO (SAML/OIDC and SCIM) is mutually exclusive with DingTalk and Lark. SCIM reuses the CustomSSO binding and does not create a second identity provider. Creating other types returns 409 IdentityProviderAlreadyBound. You can change the binding only after unbinding and removing the existing binding.
|
|
5930
|
+
* Returns the local binding summary without querying the actual SAML and SCIM configurations of AgentIdentity. If no binding exists, items is an empty array. Currently, a workspace supports only one external binding. The default value of maxResults is 10, and the valid values are 1 to 100. Currently, nextToken can only be omitted or left empty. A non-empty value returns InvalidParameter, and multi-page results cannot be fabricated.
|
|
5931
|
+
* When CustomSSO initialization is complete but SAML metadata is not saved, the status is WAITING_CONFIGURATION. You can upload the configuration, which does not indicate that a background task is still running. After the configuration is saved, the status changes to UPDATING, and changes to READY after the task succeeds. To query SCIM independently, use GetIdentityProviderSCIM. The list does not issue tokens and does not return the vendor appSecret, encryptKey, or verificationToken.
|
|
5709
5932
|
* ## Requests and examples
|
|
5710
5933
|
* GET /workspaces/{workspaceId}/identity-providers
|
|
5711
|
-
* 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.
|
|
5934
|
+
* 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, URLs, certificates, and tokens in the following examples 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.
|
|
5712
5935
|
* ```text
|
|
5713
5936
|
* GET /workspaces/ws-example/identity-providers?maxResults=10
|
|
5714
5937
|
* ```
|
|
5715
|
-
* ## Response
|
|
5938
|
+
* ## Response examples
|
|
5716
5939
|
* ```json
|
|
5717
5940
|
* {
|
|
5718
5941
|
* "items": [
|
|
5719
5942
|
* {
|
|
5720
5943
|
* "workspaceId": "ws-example",
|
|
5721
5944
|
* "identityProviderType": "CustomSSO",
|
|
5722
|
-
* "status": "
|
|
5945
|
+
* "status": "WAITING_CONFIGURATION",
|
|
5723
5946
|
* "loginEnabled": false,
|
|
5724
5947
|
* "syncEnabled": false
|
|
5725
5948
|
* }
|
|
@@ -5730,9 +5953,9 @@ export default class Client extends OpenApi {
|
|
|
5730
5953
|
* ```
|
|
5731
5954
|
* ## Errors and handling
|
|
5732
5955
|
* 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.
|
|
5733
|
-
* 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
|
|
5956
|
+
* 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, and the status is not cleared to unconfigured.
|
|
5734
5957
|
* ## Call relationships and usage boundaries
|
|
5735
|
-
* This API is used to discover current
|
|
5958
|
+
* This API is used to discover the current binding. To query the specific SAML configuration of CustomSSO, use GetIdentityProvider. To query the SP address, use GetIdentityProviderServiceProvider. To query the actual SCIM configuration and independent operation results, use GetIdentityProviderSCIM.
|
|
5736
5959
|
*
|
|
5737
5960
|
* @param request - ListIdentityProvidersRequest
|
|
5738
5961
|
* @param headers - map
|
|
@@ -5773,22 +5996,23 @@ export default class Client extends OpenApi {
|
|
|
5773
5996
|
*
|
|
5774
5997
|
* @remarks
|
|
5775
5998
|
* ## Features and prerequisites
|
|
5776
|
-
*
|
|
5777
|
-
*
|
|
5999
|
+
* WAITING_CONFIGURATION also occupies the unique external identity provider quota for the workspace. CustomSSO (SAML/OIDC and SCIM) is mutually exclusive with DingTalk and Lark. SCIM reuses the CustomSSO binding and does not create a second identity provider. Creating other types returns 409 IdentityProviderAlreadyBound. You can change the binding only after unbinding and removing the existing binding.
|
|
6000
|
+
* Returns the local binding summary without querying the actual SAML and SCIM configurations of AgentIdentity. If no binding exists, items is an empty array. Currently, a workspace supports only one external binding. The default value of maxResults is 10, and the valid values are 1 to 100. Currently, nextToken can only be omitted or left empty. A non-empty value returns InvalidParameter, and multi-page results cannot be fabricated.
|
|
6001
|
+
* When CustomSSO initialization is complete but SAML metadata is not saved, the status is WAITING_CONFIGURATION. You can upload the configuration, which does not indicate that a background task is still running. After the configuration is saved, the status changes to UPDATING, and changes to READY after the task succeeds. To query SCIM independently, use GetIdentityProviderSCIM. The list does not issue tokens and does not return the vendor appSecret, encryptKey, or verificationToken.
|
|
5778
6002
|
* ## Requests and examples
|
|
5779
6003
|
* GET /workspaces/{workspaceId}/identity-providers
|
|
5780
|
-
* 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.
|
|
6004
|
+
* 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, URLs, certificates, and tokens in the following examples 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.
|
|
5781
6005
|
* ```text
|
|
5782
6006
|
* GET /workspaces/ws-example/identity-providers?maxResults=10
|
|
5783
6007
|
* ```
|
|
5784
|
-
* ## Response
|
|
6008
|
+
* ## Response examples
|
|
5785
6009
|
* ```json
|
|
5786
6010
|
* {
|
|
5787
6011
|
* "items": [
|
|
5788
6012
|
* {
|
|
5789
6013
|
* "workspaceId": "ws-example",
|
|
5790
6014
|
* "identityProviderType": "CustomSSO",
|
|
5791
|
-
* "status": "
|
|
6015
|
+
* "status": "WAITING_CONFIGURATION",
|
|
5792
6016
|
* "loginEnabled": false,
|
|
5793
6017
|
* "syncEnabled": false
|
|
5794
6018
|
* }
|
|
@@ -5799,9 +6023,9 @@ export default class Client extends OpenApi {
|
|
|
5799
6023
|
* ```
|
|
5800
6024
|
* ## Errors and handling
|
|
5801
6025
|
* 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.
|
|
5802
|
-
* 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
|
|
6026
|
+
* 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, and the status is not cleared to unconfigured.
|
|
5803
6027
|
* ## Call relationships and usage boundaries
|
|
5804
|
-
* This API is used to discover current
|
|
6028
|
+
* This API is used to discover the current binding. To query the specific SAML configuration of CustomSSO, use GetIdentityProvider. To query the SP address, use GetIdentityProviderServiceProvider. To query the actual SCIM configuration and independent operation results, use GetIdentityProviderSCIM.
|
|
5805
6029
|
*
|
|
5806
6030
|
* @param request - ListIdentityProvidersRequest
|
|
5807
6031
|
* @returns ListIdentityProvidersResponse
|
|
@@ -7315,20 +7539,20 @@ export default class Client extends OpenApi {
|
|
|
7315
7539
|
}
|
|
7316
7540
|
|
|
7317
7541
|
/**
|
|
7318
|
-
* Prepares the SCIM receiving configuration
|
|
7542
|
+
* 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 for the current request. This operation does not automatically enable user synchronization.
|
|
7319
7543
|
*
|
|
7320
7544
|
* @remarks
|
|
7321
7545
|
* ## Features and prerequisites
|
|
7322
|
-
*
|
|
7323
|
-
* The prepare operation
|
|
7546
|
+
* Requires an available CustomSSO shared user pool. Does not depend on SAML metadata and is not blocked by SAML updates or update failures. Synchronously calls AgentIdentity to enable SCIM receiving and reads the configuration and credential list. Reuses the existing configuration if receiving is already enabled. Repeated initialization does not create duplicate valid credentials or automatically enable user synchronization. If an enabled and unexpired credential exists, returns its summary and sets the token to null. If no available credentials exist, creates one and returns the token only for the current request. Existing invalid or expired credentials are not automatically deleted and may still count towards the upstream limit of two credentials.
|
|
7547
|
+
* The prepare operation enables receiving and may issue credentials, but 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. If the response is lost, query the credential list first instead of automatically reissuing a token. Do not log tokens or persist them in frontend caches.
|
|
7324
7548
|
* ## Requests and examples
|
|
7325
7549
|
* POST /workspaces/{workspaceId}/scim-provisioning/prepare
|
|
7326
|
-
*
|
|
7550
|
+
* 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 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, not 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 the keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
7327
7551
|
* ```text
|
|
7328
7552
|
* POST /workspaces/ws-example/scim-provisioning/prepare
|
|
7329
7553
|
* No business request body.
|
|
7330
7554
|
* ```
|
|
7331
|
-
* ## Response
|
|
7555
|
+
* ## Response example
|
|
7332
7556
|
* ```json
|
|
7333
7557
|
* {
|
|
7334
7558
|
* "data": {
|
|
@@ -7339,17 +7563,17 @@ export default class Client extends OpenApi {
|
|
|
7339
7563
|
* "credential": {
|
|
7340
7564
|
* "credentialId": "credential-example",
|
|
7341
7565
|
* "status": "Enabled",
|
|
7342
|
-
* "expireTime": "<Expiration time returned by the upstream
|
|
7566
|
+
* "expireTime": "<Expiration time returned by the upstream>"
|
|
7343
7567
|
* },
|
|
7344
|
-
* "token": "<Token issued only
|
|
7568
|
+
* "token": "<Token newly issued only for this request; null if an available credential already exists>"
|
|
7345
7569
|
* }
|
|
7346
7570
|
* }
|
|
7347
7571
|
* ```
|
|
7348
7572
|
* ## Errors and handling
|
|
7349
|
-
* 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
|
|
7350
|
-
* 400 LimitExceeded.ScimCredential: The maximum
|
|
7573
|
+
* 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. 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.
|
|
7574
|
+
* 400 LimitExceeded.ScimCredential: The maximum 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.
|
|
7351
7575
|
* ## Call relationships and usage boundaries
|
|
7352
|
-
* 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
|
|
7576
|
+
* 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 the token is null, use the token already saved by the user. 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 one. When the limit of two credentials is reached, the user must confirm and delete the unused one.
|
|
7353
7577
|
*
|
|
7354
7578
|
* @param request - PrepareIdentityProviderSCIMRequest
|
|
7355
7579
|
* @param headers - map
|
|
@@ -7376,20 +7600,20 @@ export default class Client extends OpenApi {
|
|
|
7376
7600
|
}
|
|
7377
7601
|
|
|
7378
7602
|
/**
|
|
7379
|
-
* Prepares the SCIM receiving configuration
|
|
7603
|
+
* 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 for the current request. This operation does not automatically enable user synchronization.
|
|
7380
7604
|
*
|
|
7381
7605
|
* @remarks
|
|
7382
7606
|
* ## Features and prerequisites
|
|
7383
|
-
*
|
|
7384
|
-
* The prepare operation
|
|
7607
|
+
* Requires an available CustomSSO shared user pool. Does not depend on SAML metadata and is not blocked by SAML updates or update failures. Synchronously calls AgentIdentity to enable SCIM receiving and reads the configuration and credential list. Reuses the existing configuration if receiving is already enabled. Repeated initialization does not create duplicate valid credentials or automatically enable user synchronization. If an enabled and unexpired credential exists, returns its summary and sets the token to null. If no available credentials exist, creates one and returns the token only for the current request. Existing invalid or expired credentials are not automatically deleted and may still count towards the upstream limit of two credentials.
|
|
7608
|
+
* The prepare operation enables receiving and may issue credentials, but 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. If the response is lost, query the credential list first instead of automatically reissuing a token. Do not log tokens or persist them in frontend caches.
|
|
7385
7609
|
* ## Requests and examples
|
|
7386
7610
|
* POST /workspaces/{workspaceId}/scim-provisioning/prepare
|
|
7387
|
-
*
|
|
7611
|
+
* 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 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, not 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 the keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
7388
7612
|
* ```text
|
|
7389
7613
|
* POST /workspaces/ws-example/scim-provisioning/prepare
|
|
7390
7614
|
* No business request body.
|
|
7391
7615
|
* ```
|
|
7392
|
-
* ## Response
|
|
7616
|
+
* ## Response example
|
|
7393
7617
|
* ```json
|
|
7394
7618
|
* {
|
|
7395
7619
|
* "data": {
|
|
@@ -7400,17 +7624,17 @@ export default class Client extends OpenApi {
|
|
|
7400
7624
|
* "credential": {
|
|
7401
7625
|
* "credentialId": "credential-example",
|
|
7402
7626
|
* "status": "Enabled",
|
|
7403
|
-
* "expireTime": "<Expiration time returned by the upstream
|
|
7627
|
+
* "expireTime": "<Expiration time returned by the upstream>"
|
|
7404
7628
|
* },
|
|
7405
|
-
* "token": "<Token issued only
|
|
7629
|
+
* "token": "<Token newly issued only for this request; null if an available credential already exists>"
|
|
7406
7630
|
* }
|
|
7407
7631
|
* }
|
|
7408
7632
|
* ```
|
|
7409
7633
|
* ## Errors and handling
|
|
7410
|
-
* 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
|
|
7411
|
-
* 400 LimitExceeded.ScimCredential: The maximum
|
|
7634
|
+
* 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. 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.
|
|
7635
|
+
* 400 LimitExceeded.ScimCredential: The maximum 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.
|
|
7412
7636
|
* ## Call relationships and usage boundaries
|
|
7413
|
-
* 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
|
|
7637
|
+
* 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 the token is null, use the token already saved by the user. 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 one. When the limit of two credentials is reached, the user must confirm and delete the unused one.
|
|
7414
7638
|
*
|
|
7415
7639
|
* @param request - PrepareIdentityProviderSCIMRequest
|
|
7416
7640
|
* @returns PrepareIdentityProviderSCIMResponse
|
|
@@ -8142,16 +8366,16 @@ export default class Client extends OpenApi {
|
|
|
8142
8366
|
}
|
|
8143
8367
|
|
|
8144
8368
|
/**
|
|
8145
|
-
* Updates the configuration of a
|
|
8369
|
+
* Updates the configuration of a custom agent in a specified workspace and executes the update asynchronously. Omitted top-level fields retain their original configurations. You can call GetCustomAgent to query the update result.
|
|
8146
8370
|
*
|
|
8147
8371
|
* @remarks
|
|
8148
|
-
*
|
|
8149
|
-
* When
|
|
8150
|
-
* In code package pattern, specify artifact.port and the sourceUri, languageRuntime, and entrypoint fields of artifact.code. Do not specify the container field at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported
|
|
8151
|
-
* When
|
|
8152
|
-
* When
|
|
8153
|
-
* The update is an asynchronous process. A successful response indicates that the request is accepted.
|
|
8154
|
-
* The clientToken field
|
|
8372
|
+
* Specify at least one top-level field to update. Omitted top-level fields retain their original configurations. When you provide a configuration object, you must also specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced as a whole. Pass an empty array [] to clear a list. The agenticFsMounts field does not accept null. Pass null for the description field to clear the description, and pass null for the healthCheck field to remove the health check.
|
|
8373
|
+
* When you update an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, you must also provide the entrypoint field.
|
|
8374
|
+
* In code package pattern, specify artifact.port and the sourceUri, languageRuntime, and entrypoint fields of artifact.code. Do not specify the container field at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported. The compressed package size cannot exceed 500,000,000 bytes. You can call ListAgentCodeRuntimes to query the runtime environment identity. The sourceUri field supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, call GetAgentCodePackageUploadUrl to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
|
|
8375
|
+
* When you submit a new code package source, the backend rechecks the read permissions, object, and size. The configuration is saved only after the transfer succeeds. If the transfer fails, the current configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not indicate that the agent is ready to run.
|
|
8376
|
+
* When you provide the runtime field, the compute and sessionPolicy fields must also be provided. If you omit the hpa field or its subfields, unspecified elastic configurations use default values. To retain the original elastic configurations, you must provide them together. When you provide the network field, omitted access items are treated as allowed, but actual access is still restricted by the workspace network. To retain the original restrictions, provide both accessInternet and accessVpc. When you provide the healthCheck field, you must specify the port field. Other unspecified items use default values. When you provide the logging.sls field, you must specify both the project and logstore fields.
|
|
8377
|
+
* The update is an asynchronous process. A successful response indicates that the request is accepted. You can call GetCustomAgent to query latestSpecVersion, latestVersionStatus, and latestExecutionError, and check the status field to confirm the update result.
|
|
8378
|
+
* The clientToken field does not currently provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold field for health checks does not currently take effect. Omit this field.
|
|
8155
8379
|
*
|
|
8156
8380
|
* @param tmpReq - UpdateCustomAgentRequest
|
|
8157
8381
|
* @param headers - map
|
|
@@ -8196,16 +8420,16 @@ export default class Client extends OpenApi {
|
|
|
8196
8420
|
}
|
|
8197
8421
|
|
|
8198
8422
|
/**
|
|
8199
|
-
* Updates the configuration of a
|
|
8423
|
+
* Updates the configuration of a custom agent in a specified workspace and executes the update asynchronously. Omitted top-level fields retain their original configurations. You can call GetCustomAgent to query the update result.
|
|
8200
8424
|
*
|
|
8201
8425
|
* @remarks
|
|
8202
|
-
*
|
|
8203
|
-
* When
|
|
8204
|
-
* In code package pattern, specify artifact.port and the sourceUri, languageRuntime, and entrypoint fields of artifact.code. Do not specify the container field at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported
|
|
8205
|
-
* When
|
|
8206
|
-
* When
|
|
8207
|
-
* The update is an asynchronous process. A successful response indicates that the request is accepted.
|
|
8208
|
-
* The clientToken field
|
|
8426
|
+
* Specify at least one top-level field to update. Omitted top-level fields retain their original configurations. When you provide a configuration object, you must also specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced as a whole. Pass an empty array [] to clear a list. The agenticFsMounts field does not accept null. Pass null for the description field to clear the description, and pass null for the healthCheck field to remove the health check.
|
|
8427
|
+
* When you update an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, you must also provide the entrypoint field.
|
|
8428
|
+
* In code package pattern, specify artifact.port and the sourceUri, languageRuntime, and entrypoint fields of artifact.code. Do not specify the container field at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported. The compressed package size cannot exceed 500,000,000 bytes. You can call ListAgentCodeRuntimes to query the runtime environment identity. The sourceUri field supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, call GetAgentCodePackageUploadUrl to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
|
|
8429
|
+
* When you submit a new code package source, the backend rechecks the read permissions, object, and size. The configuration is saved only after the transfer succeeds. If the transfer fails, the current configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not indicate that the agent is ready to run.
|
|
8430
|
+
* When you provide the runtime field, the compute and sessionPolicy fields must also be provided. If you omit the hpa field or its subfields, unspecified elastic configurations use default values. To retain the original elastic configurations, you must provide them together. When you provide the network field, omitted access items are treated as allowed, but actual access is still restricted by the workspace network. To retain the original restrictions, provide both accessInternet and accessVpc. When you provide the healthCheck field, you must specify the port field. Other unspecified items use default values. When you provide the logging.sls field, you must specify both the project and logstore fields.
|
|
8431
|
+
* The update is an asynchronous process. A successful response indicates that the request is accepted. You can call GetCustomAgent to query latestSpecVersion, latestVersionStatus, and latestExecutionError, and check the status field to confirm the update result.
|
|
8432
|
+
* The clientToken field does not currently provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold field for health checks does not currently take effect. Omit this field.
|
|
8209
8433
|
*
|
|
8210
8434
|
* @param request - UpdateCustomAgentRequest
|
|
8211
8435
|
* @returns UpdateCustomAgentResponse
|
|
@@ -8280,21 +8504,21 @@ export default class Client extends OpenApi {
|
|
|
8280
8504
|
}
|
|
8281
8505
|
|
|
8282
8506
|
/**
|
|
8283
|
-
* Modifies the logon configuration of a bound identity provider in a specified workspace. DingTalk and
|
|
8507
|
+
* Modifies the logon configuration of a bound identity provider in a specified workspace. DingTalk and Feishu support the logon switch, incremental synchronization switch, application configuration, and synchronization scope. CustomSSO supports SAML configuration and the logon switch. Actual updates take effect asynchronously. Call GetIdentityProvider to query the status.
|
|
8284
8508
|
*
|
|
8285
8509
|
* @remarks
|
|
8286
8510
|
* ### Prerequisites and update methods
|
|
8287
|
-
* The workspace must be bound to an identity provider of the corresponding type. For DingTalk and
|
|
8288
|
-
* ### DingTalk and
|
|
8289
|
-
* 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
|
|
8290
|
-
* syncEnabled controls subsequent address book change events and does not control the initial synchronization or manual synchronization. syncScope applies only to DingTalk and
|
|
8511
|
+
* The workspace must be bound to an identity provider of the corresponding type. For DingTalk and Feishu, you must submit at least one of the following fields: loginEnabled, syncEnabled, metadata, and syncScope. The protocol and saml fields are not accepted. For CustomSSO, use the protocol, saml, and loginEnabled fields. The metadata, syncEnabled, and syncScope fields are not accepted. The SCIM synchronization switch is managed separately by using UpdateIdentityProviderSCIM.
|
|
8512
|
+
* ### DingTalk and Feishu
|
|
8513
|
+
* The metadata field 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 is rejected. The server validates the complete configuration after merging. When incremental synchronization is enabled, the merged configuration must include the encryptKey and verificationToken fields.
|
|
8514
|
+
* The syncEnabled field controls subsequent address book change events and does not control the initial synchronization or manual synchronization. The syncScope field applies only to DingTalk and Feishu. If this field is omitted or set to null, the current scope is retained. Saving the scope does not automatically trigger a full synchronization. To perform a manual synchronization, call CreateIdentityProviderSyncJob after the save operation is complete and the identity provider is ready, and then call GetIdentityProviderSyncJob to query the task result.
|
|
8291
8515
|
* ### Custom SAML identity provider
|
|
8292
|
-
* CustomSSO currently supports only SAML. The saml
|
|
8293
|
-
* metadataXml is a single IdP EntityDescriptor XML text of up to 1 MiB, not a URL or file path.
|
|
8294
|
-
* jitProvisionEnabled controls the automatic creation of users during the initial logon
|
|
8516
|
+
* CustomSSO currently supports only SAML. The saml field supports two mutually exclusive methods: providing metadataXml, or providing the four manually entered configuration fields: entityId, loginUrl, bindingType, and x509Certificates.
|
|
8517
|
+
* The metadataXml field is a single IdP EntityDescriptor XML text of up to 1 MiB, not a URL or file path. DTD and external entities are prohibited. When manually entering the configuration, the entityId field must be non-empty and contain up to 2,048 characters, and cannot be changed after saving. The loginUrl field must be an absolute HTTPS URL without user credentials and fragments. The bindingType field must be HTTP-Redirect or HTTP-POST. The certificates must be valid X.509 signing certificates, with a maximum of 10 certificates.
|
|
8518
|
+
* The jitProvisionEnabled field controls the automatic creation of users during the initial logon. The jitUpdateEnabled field 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 configuration.
|
|
8295
8519
|
* ### Asynchronous results and retries
|
|
8296
|
-
* 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
|
|
8297
|
-
* 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
|
|
8520
|
+
* 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 configuration is 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.
|
|
8521
|
+
* 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 field describes the status of the identity provider resource and logon configuration. The SCIM operation results for CustomSSO must be queried by using GetIdentityProviderSCIM and cannot be inferred from this status.
|
|
8298
8522
|
*
|
|
8299
8523
|
* @param tmpReq - UpdateIdentityProviderRequest
|
|
8300
8524
|
* @param headers - map
|
|
@@ -8333,21 +8557,21 @@ export default class Client extends OpenApi {
|
|
|
8333
8557
|
}
|
|
8334
8558
|
|
|
8335
8559
|
/**
|
|
8336
|
-
* Modifies the logon configuration of a bound identity provider in a specified workspace. DingTalk and
|
|
8560
|
+
* Modifies the logon configuration of a bound identity provider in a specified workspace. DingTalk and Feishu support the logon switch, incremental synchronization switch, application configuration, and synchronization scope. CustomSSO supports SAML configuration and the logon switch. Actual updates take effect asynchronously. Call GetIdentityProvider to query the status.
|
|
8337
8561
|
*
|
|
8338
8562
|
* @remarks
|
|
8339
8563
|
* ### Prerequisites and update methods
|
|
8340
|
-
* The workspace must be bound to an identity provider of the corresponding type. For DingTalk and
|
|
8341
|
-
* ### DingTalk and
|
|
8342
|
-
* 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
|
|
8343
|
-
* syncEnabled controls subsequent address book change events and does not control the initial synchronization or manual synchronization. syncScope applies only to DingTalk and
|
|
8564
|
+
* The workspace must be bound to an identity provider of the corresponding type. For DingTalk and Feishu, you must submit at least one of the following fields: loginEnabled, syncEnabled, metadata, and syncScope. The protocol and saml fields are not accepted. For CustomSSO, use the protocol, saml, and loginEnabled fields. The metadata, syncEnabled, and syncScope fields are not accepted. The SCIM synchronization switch is managed separately by using UpdateIdentityProviderSCIM.
|
|
8565
|
+
* ### DingTalk and Feishu
|
|
8566
|
+
* The metadata field 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 is rejected. The server validates the complete configuration after merging. When incremental synchronization is enabled, the merged configuration must include the encryptKey and verificationToken fields.
|
|
8567
|
+
* The syncEnabled field controls subsequent address book change events and does not control the initial synchronization or manual synchronization. The syncScope field applies only to DingTalk and Feishu. If this field is omitted or set to null, the current scope is retained. Saving the scope does not automatically trigger a full synchronization. To perform a manual synchronization, call CreateIdentityProviderSyncJob after the save operation is complete and the identity provider is ready, and then call GetIdentityProviderSyncJob to query the task result.
|
|
8344
8568
|
* ### Custom SAML identity provider
|
|
8345
|
-
* CustomSSO currently supports only SAML. The saml
|
|
8346
|
-
* metadataXml is a single IdP EntityDescriptor XML text of up to 1 MiB, not a URL or file path.
|
|
8347
|
-
* jitProvisionEnabled controls the automatic creation of users during the initial logon
|
|
8569
|
+
* CustomSSO currently supports only SAML. The saml field supports two mutually exclusive methods: providing metadataXml, or providing the four manually entered configuration fields: entityId, loginUrl, bindingType, and x509Certificates.
|
|
8570
|
+
* The metadataXml field is a single IdP EntityDescriptor XML text of up to 1 MiB, not a URL or file path. DTD and external entities are prohibited. When manually entering the configuration, the entityId field must be non-empty and contain up to 2,048 characters, and cannot be changed after saving. The loginUrl field must be an absolute HTTPS URL without user credentials and fragments. The bindingType field must be HTTP-Redirect or HTTP-POST. The certificates must be valid X.509 signing certificates, with a maximum of 10 certificates.
|
|
8571
|
+
* The jitProvisionEnabled field controls the automatic creation of users during the initial logon. The jitUpdateEnabled field 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 configuration.
|
|
8348
8572
|
* ### Asynchronous results and retries
|
|
8349
|
-
* 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
|
|
8350
|
-
* 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
|
|
8573
|
+
* 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 configuration is 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.
|
|
8574
|
+
* 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 field describes the status of the identity provider resource and logon configuration. The SCIM operation results for CustomSSO must be queried by using GetIdentityProviderSCIM and cannot be inferred from this status.
|
|
8351
8575
|
*
|
|
8352
8576
|
* @param request - UpdateIdentityProviderRequest
|
|
8353
8577
|
* @returns UpdateIdentityProviderResponse
|
|
@@ -8359,20 +8583,21 @@ export default class Client extends OpenApi {
|
|
|
8359
8583
|
}
|
|
8360
8584
|
|
|
8361
8585
|
/**
|
|
8362
|
-
* 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.
|
|
8586
|
+
* Enables or disables SCIM-based 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.
|
|
8363
8587
|
*
|
|
8364
8588
|
* @remarks
|
|
8365
8589
|
* ## Features and prerequisites
|
|
8366
|
-
* 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
|
|
8367
|
-
*
|
|
8368
|
-
* SCIM does not depend on SAML
|
|
8590
|
+
* 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 the feature later and receiving is disabled, you must call the prepare operation again.
|
|
8591
|
+
* After the request is accepted, the expected switch status in AC is saved and an independent SCIM task is submitted. The original shared binding fields are returned, and the status field still indicates the status of shared resources and logon configurations. The new scimStatus field indicates the independent SCIM status, and the operationStatus field indicates task result of the original SCIM task. The SCIM taskId is not returned. You can call GetIdentityProviderSCIM to query task result. The prerequisite checks for enabling the feature are executed within the task. If the prerequisites are not met, you may receive a successful request response first, and then the operationStatus becomes FAILED. A failure does not automatically roll back the expected switch status.
|
|
8592
|
+
* SCIM does not depend on SAML configurations and does not affect the SAML status or switch. A successful task or a successful full import of empty users does not prove that continuous incremental synchronization is healthy. Whether users exist depends on whether the external system actually pre-provisions them.
|
|
8593
|
+
* The scimStatus field indicates the independent SCIM configuration status. UNCONFIGURED: The preparation is not completed. WAITING_CONFIGURATION: The receiving end is enabled, the HTTPS URL is valid, and a valid token exists. The system is waiting for external configuration and enablement confirmation. UPDATING: The enablement or disablement is being executed. READY: Synchronization is enabled and the current enablement task is successful. The receiving end, URL, and credentials are still available. DISABLED: The feature is disabled and the configuration is retained. UPDATE_FAILED: The operation failed, was paused, was canceled, or the configuration and credentials became unavailable after enablement. The original facts of configuration, syncEnabled, and operationStatus are retained. The SAML or OIDC binding status is not used to determine the SCIM status. The READY status does not prove that Matrix execution is completed, the external connection test is passed, or continuous incremental synchronization is healthy.
|
|
8369
8594
|
* ## Requests and examples
|
|
8370
8595
|
* PUT /workspaces/{workspaceId}/scim-provisioning
|
|
8371
|
-
* Call conventions: Call the API in the region of the target workspace by using an
|
|
8596
|
+
* 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 provider 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 parameters of the public API, not the additional 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.
|
|
8372
8597
|
* ```text
|
|
8373
8598
|
* PUT /workspaces/ws-example/scim-provisioning
|
|
8374
8599
|
* {"syncEnabled": true}
|
|
8375
|
-
* To disable: {"syncEnabled": false}
|
|
8600
|
+
* To disable the feature: {"syncEnabled": false}
|
|
8376
8601
|
* ```
|
|
8377
8602
|
* ## Response example
|
|
8378
8603
|
* ```json
|
|
@@ -8382,15 +8607,17 @@ export default class Client extends OpenApi {
|
|
|
8382
8607
|
* "identityProviderType": "CustomSSO",
|
|
8383
8608
|
* "status": "READY",
|
|
8384
8609
|
* "loginEnabled": false,
|
|
8385
|
-
* "
|
|
8610
|
+
* "scimStatus": "UPDATING",
|
|
8611
|
+
* "syncEnabled": true,
|
|
8612
|
+
* "operationStatus": "PENDING"
|
|
8386
8613
|
* }
|
|
8387
8614
|
* }
|
|
8388
8615
|
* ```
|
|
8389
8616
|
* ## Errors and handling
|
|
8390
|
-
* 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
|
|
8391
|
-
* 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.
|
|
8617
|
+
* 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 system 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 process.
|
|
8618
|
+
* 400 InvalidParameter: The syncEnabled parameter 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. If the upstream system is not enabled or has no valid credentials, it may manifest as an asynchronous FAILED status after acceptance. You cannot only handle HTTP errors.
|
|
8392
8619
|
* ## Call relationships and usage boundaries
|
|
8393
|
-
* The call example for enabling is body={"syncEnabled":true}, and for disabling is body={"syncEnabled":false}. This API
|
|
8620
|
+
* The call example for enabling the feature is body={"syncEnabled":true}, and for disabling the feature is body={"syncEnabled":false}. This API retains the original binding details and the meaning of the status field, and adds the scimStatus and operationStatus fields. After acceptance, call GetIdentityProviderSCIM to query the independent status and 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.
|
|
8394
8621
|
*
|
|
8395
8622
|
* @param tmpReq - UpdateIdentityProviderSCIMRequest
|
|
8396
8623
|
* @param headers - map
|
|
@@ -8429,20 +8656,21 @@ export default class Client extends OpenApi {
|
|
|
8429
8656
|
}
|
|
8430
8657
|
|
|
8431
8658
|
/**
|
|
8432
|
-
* 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.
|
|
8659
|
+
* Enables or disables SCIM-based 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.
|
|
8433
8660
|
*
|
|
8434
8661
|
* @remarks
|
|
8435
8662
|
* ## Features and prerequisites
|
|
8436
|
-
* 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
|
|
8437
|
-
*
|
|
8438
|
-
* SCIM does not depend on SAML
|
|
8663
|
+
* 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 the feature later and receiving is disabled, you must call the prepare operation again.
|
|
8664
|
+
* After the request is accepted, the expected switch status in AC is saved and an independent SCIM task is submitted. The original shared binding fields are returned, and the status field still indicates the status of shared resources and logon configurations. The new scimStatus field indicates the independent SCIM status, and the operationStatus field indicates task result of the original SCIM task. The SCIM taskId is not returned. You can call GetIdentityProviderSCIM to query task result. The prerequisite checks for enabling the feature are executed within the task. If the prerequisites are not met, you may receive a successful request response first, and then the operationStatus becomes FAILED. A failure does not automatically roll back the expected switch status.
|
|
8665
|
+
* SCIM does not depend on SAML configurations and does not affect the SAML status or switch. A successful task or a successful full import of empty users does not prove that continuous incremental synchronization is healthy. Whether users exist depends on whether the external system actually pre-provisions them.
|
|
8666
|
+
* The scimStatus field indicates the independent SCIM configuration status. UNCONFIGURED: The preparation is not completed. WAITING_CONFIGURATION: The receiving end is enabled, the HTTPS URL is valid, and a valid token exists. The system is waiting for external configuration and enablement confirmation. UPDATING: The enablement or disablement is being executed. READY: Synchronization is enabled and the current enablement task is successful. The receiving end, URL, and credentials are still available. DISABLED: The feature is disabled and the configuration is retained. UPDATE_FAILED: The operation failed, was paused, was canceled, or the configuration and credentials became unavailable after enablement. The original facts of configuration, syncEnabled, and operationStatus are retained. The SAML or OIDC binding status is not used to determine the SCIM status. The READY status does not prove that Matrix execution is completed, the external connection test is passed, or continuous incremental synchronization is healthy.
|
|
8439
8667
|
* ## Requests and examples
|
|
8440
8668
|
* PUT /workspaces/{workspaceId}/scim-provisioning
|
|
8441
|
-
* Call conventions: Call the API in the region of the target workspace by using an
|
|
8669
|
+
* 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 provider 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 parameters of the public API, not the additional 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.
|
|
8442
8670
|
* ```text
|
|
8443
8671
|
* PUT /workspaces/ws-example/scim-provisioning
|
|
8444
8672
|
* {"syncEnabled": true}
|
|
8445
|
-
* To disable: {"syncEnabled": false}
|
|
8673
|
+
* To disable the feature: {"syncEnabled": false}
|
|
8446
8674
|
* ```
|
|
8447
8675
|
* ## Response example
|
|
8448
8676
|
* ```json
|
|
@@ -8452,15 +8680,17 @@ export default class Client extends OpenApi {
|
|
|
8452
8680
|
* "identityProviderType": "CustomSSO",
|
|
8453
8681
|
* "status": "READY",
|
|
8454
8682
|
* "loginEnabled": false,
|
|
8455
|
-
* "
|
|
8683
|
+
* "scimStatus": "UPDATING",
|
|
8684
|
+
* "syncEnabled": true,
|
|
8685
|
+
* "operationStatus": "PENDING"
|
|
8456
8686
|
* }
|
|
8457
8687
|
* }
|
|
8458
8688
|
* ```
|
|
8459
8689
|
* ## Errors and handling
|
|
8460
|
-
* 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
|
|
8461
|
-
* 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.
|
|
8690
|
+
* 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 system 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 process.
|
|
8691
|
+
* 400 InvalidParameter: The syncEnabled parameter 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. If the upstream system is not enabled or has no valid credentials, it may manifest as an asynchronous FAILED status after acceptance. You cannot only handle HTTP errors.
|
|
8462
8692
|
* ## Call relationships and usage boundaries
|
|
8463
|
-
* The call example for enabling is body={"syncEnabled":true}, and for disabling is body={"syncEnabled":false}. This API
|
|
8693
|
+
* The call example for enabling the feature is body={"syncEnabled":true}, and for disabling the feature is body={"syncEnabled":false}. This API retains the original binding details and the meaning of the status field, and adds the scimStatus and operationStatus fields. After acceptance, call GetIdentityProviderSCIM to query the independent status and 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.
|
|
8464
8694
|
*
|
|
8465
8695
|
* @param request - UpdateIdentityProviderSCIMRequest
|
|
8466
8696
|
* @returns UpdateIdentityProviderSCIMResponse
|