@alicloud/agentcore20260804 2.6.0 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +577 -119
- package/dist/client.js +729 -123
- package/dist/client.js.map +1 -1
- package/dist/models/CreateIdentityProviderRequest.d.ts +6 -6
- package/dist/models/CreateIdentityProviderResponseBody.d.ts +20 -52
- package/dist/models/CreateIdentityProviderResponseBody.js +0 -8
- package/dist/models/CreateIdentityProviderResponseBody.js.map +1 -1
- package/dist/models/CreateIdentityProviderScimcredentialRequest.d.ts +13 -0
- package/dist/models/CreateIdentityProviderScimcredentialRequest.js +54 -0
- package/dist/models/CreateIdentityProviderScimcredentialRequest.js.map +1 -0
- package/dist/models/CreateIdentityProviderScimcredentialResponse.d.ts +19 -0
- package/dist/models/CreateIdentityProviderScimcredentialResponse.js +69 -0
- package/dist/models/CreateIdentityProviderScimcredentialResponse.js.map +1 -0
- package/dist/models/CreateIdentityProviderScimcredentialResponseBody.d.ts +157 -0
- package/dist/models/CreateIdentityProviderScimcredentialResponseBody.js +146 -0
- package/dist/models/CreateIdentityProviderScimcredentialResponseBody.js.map +1 -0
- package/dist/models/CreateWorkspaceRequest.d.ts +23 -7
- package/dist/models/CreateWorkspaceRequest.js +4 -0
- package/dist/models/CreateWorkspaceRequest.js.map +1 -1
- package/dist/models/CreateWorkspaceResponseBody.d.ts +11 -11
- package/dist/models/CreateWorkspaceShrinkRequest.d.ts +1 -1
- package/dist/models/DeleteIdentityProviderResponseBody.d.ts +15 -47
- package/dist/models/DeleteIdentityProviderResponseBody.js +0 -8
- package/dist/models/DeleteIdentityProviderResponseBody.js.map +1 -1
- package/dist/models/DeleteIdentityProviderScimcredentialRequest.d.ts +13 -0
- package/dist/models/DeleteIdentityProviderScimcredentialRequest.js +54 -0
- package/dist/models/DeleteIdentityProviderScimcredentialRequest.js.map +1 -0
- package/dist/models/DeleteIdentityProviderScimcredentialResponse.d.ts +19 -0
- package/dist/models/DeleteIdentityProviderScimcredentialResponse.js +69 -0
- package/dist/models/DeleteIdentityProviderScimcredentialResponse.js.map +1 -0
- package/dist/models/DeleteIdentityProviderScimcredentialResponseBody.d.ts +50 -0
- package/dist/models/DeleteIdentityProviderScimcredentialResponseBody.js +66 -0
- package/dist/models/DeleteIdentityProviderScimcredentialResponseBody.js.map +1 -0
- package/dist/models/GetIdentityProviderResponseBody.d.ts +23 -55
- package/dist/models/GetIdentityProviderResponseBody.js +0 -8
- package/dist/models/GetIdentityProviderResponseBody.js.map +1 -1
- package/dist/models/GetIdentityProviderScimrequest.d.ts +13 -0
- package/dist/models/GetIdentityProviderScimrequest.js +54 -0
- package/dist/models/GetIdentityProviderScimrequest.js.map +1 -0
- package/dist/models/GetIdentityProviderScimresponse.d.ts +19 -0
- package/dist/models/GetIdentityProviderScimresponse.js +69 -0
- package/dist/models/GetIdentityProviderScimresponse.js.map +1 -0
- package/dist/models/GetIdentityProviderScimresponseBody.d.ts +131 -0
- package/dist/models/GetIdentityProviderScimresponseBody.js +120 -0
- package/dist/models/GetIdentityProviderScimresponseBody.js.map +1 -0
- package/dist/models/GetIdentityProviderServiceProviderRequest.d.ts +23 -0
- package/dist/models/GetIdentityProviderServiceProviderRequest.js +58 -0
- package/dist/models/GetIdentityProviderServiceProviderRequest.js.map +1 -0
- package/dist/models/GetIdentityProviderServiceProviderResponse.d.ts +19 -0
- package/dist/models/GetIdentityProviderServiceProviderResponse.js +69 -0
- package/dist/models/GetIdentityProviderServiceProviderResponse.js.map +1 -0
- package/dist/models/GetIdentityProviderServiceProviderResponseBody.d.ts +99 -0
- package/dist/models/GetIdentityProviderServiceProviderResponseBody.js +96 -0
- package/dist/models/GetIdentityProviderServiceProviderResponseBody.js.map +1 -0
- package/dist/models/ListIdentityProviderDepartmentsRequest.d.ts +2 -2
- package/dist/models/ListIdentityProviderDepartmentsResponseBody.d.ts +9 -9
- package/dist/models/ListIdentityProviderScimcredentialsRequest.d.ts +13 -0
- package/dist/models/ListIdentityProviderScimcredentialsRequest.js +54 -0
- package/dist/models/ListIdentityProviderScimcredentialsRequest.js.map +1 -0
- package/dist/models/ListIdentityProviderScimcredentialsResponse.d.ts +19 -0
- package/dist/models/ListIdentityProviderScimcredentialsResponse.js +69 -0
- package/dist/models/ListIdentityProviderScimcredentialsResponse.js.map +1 -0
- package/dist/models/ListIdentityProviderScimcredentialsResponseBody.d.ts +99 -0
- package/dist/models/ListIdentityProviderScimcredentialsResponseBody.js +96 -0
- package/dist/models/ListIdentityProviderScimcredentialsResponseBody.js.map +1 -0
- package/dist/models/ListIdentityProvidersRequest.d.ts +2 -2
- package/dist/models/ListIdentityProvidersResponseBody.d.ts +25 -69
- package/dist/models/ListIdentityProvidersResponseBody.js +0 -8
- package/dist/models/ListIdentityProvidersResponseBody.js.map +1 -1
- package/dist/models/PrepareIdentityProviderScimrequest.d.ts +13 -0
- package/dist/models/PrepareIdentityProviderScimrequest.js +54 -0
- package/dist/models/PrepareIdentityProviderScimrequest.js.map +1 -0
- package/dist/models/PrepareIdentityProviderScimresponse.d.ts +19 -0
- package/dist/models/PrepareIdentityProviderScimresponse.js +69 -0
- package/dist/models/PrepareIdentityProviderScimresponse.js.map +1 -0
- package/dist/models/PrepareIdentityProviderScimresponseBody.d.ts +157 -0
- package/dist/models/PrepareIdentityProviderScimresponseBody.js +146 -0
- package/dist/models/PrepareIdentityProviderScimresponseBody.js.map +1 -0
- package/dist/models/UpdateIdentityProviderRequest.d.ts +20 -39
- package/dist/models/UpdateIdentityProviderRequest.js +0 -4
- package/dist/models/UpdateIdentityProviderRequest.js.map +1 -1
- package/dist/models/UpdateIdentityProviderResponseBody.d.ts +35 -60
- package/dist/models/UpdateIdentityProviderResponseBody.js +0 -8
- package/dist/models/UpdateIdentityProviderResponseBody.js.map +1 -1
- package/dist/models/UpdateIdentityProviderScimrequest.d.ts +39 -0
- package/dist/models/UpdateIdentityProviderScimrequest.js +80 -0
- package/dist/models/UpdateIdentityProviderScimrequest.js.map +1 -0
- package/dist/models/UpdateIdentityProviderScimresponse.d.ts +19 -0
- package/dist/models/UpdateIdentityProviderScimresponse.js +69 -0
- package/dist/models/UpdateIdentityProviderScimresponse.js.map +1 -0
- package/dist/models/UpdateIdentityProviderScimresponseBody.d.ts +304 -0
- package/dist/models/UpdateIdentityProviderScimresponseBody.js +205 -0
- package/dist/models/UpdateIdentityProviderScimresponseBody.js.map +1 -0
- package/dist/models/UpdateIdentityProviderScimshrinkRequest.d.ts +20 -0
- package/dist/models/UpdateIdentityProviderScimshrinkRequest.js +58 -0
- package/dist/models/UpdateIdentityProviderScimshrinkRequest.js.map +1 -0
- package/dist/models/UpdateIdentityProviderShrinkRequest.d.ts +1 -1
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationRequest.d.ts +1 -1
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.d.ts +28 -2
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.js.map +1 -1
- package/dist/models/model.d.ts +37 -0
- package/dist/models/model.js +100 -25
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +746 -123
- package/src/models/CreateIdentityProviderRequest.ts +6 -6
- package/src/models/CreateIdentityProviderResponseBody.ts +20 -60
- package/src/models/CreateIdentityProviderScimcredentialRequest.ts +24 -0
- package/src/models/CreateIdentityProviderScimcredentialResponse.ts +40 -0
- package/src/models/CreateIdentityProviderScimcredentialResponseBody.ts +231 -0
- package/src/models/CreateWorkspaceRequest.ts +27 -7
- package/src/models/CreateWorkspaceResponseBody.ts +11 -11
- package/src/models/CreateWorkspaceShrinkRequest.ts +1 -1
- package/src/models/DeleteIdentityProviderResponseBody.ts +15 -55
- package/src/models/DeleteIdentityProviderScimcredentialRequest.ts +24 -0
- package/src/models/DeleteIdentityProviderScimcredentialResponse.ts +40 -0
- package/src/models/DeleteIdentityProviderScimcredentialResponseBody.ts +71 -0
- package/src/models/GetIdentityProviderResponseBody.ts +23 -63
- package/src/models/GetIdentityProviderScimrequest.ts +24 -0
- package/src/models/GetIdentityProviderScimresponse.ts +40 -0
- package/src/models/GetIdentityProviderScimresponseBody.ts +188 -0
- package/src/models/GetIdentityProviderServiceProviderRequest.ts +36 -0
- package/src/models/GetIdentityProviderServiceProviderResponse.ts +40 -0
- package/src/models/GetIdentityProviderServiceProviderResponseBody.ts +141 -0
- package/src/models/ListIdentityProviderDepartmentsRequest.ts +2 -2
- package/src/models/ListIdentityProviderDepartmentsResponseBody.ts +9 -9
- package/src/models/ListIdentityProviderScimcredentialsRequest.ts +24 -0
- package/src/models/ListIdentityProviderScimcredentialsResponse.ts +40 -0
- package/src/models/ListIdentityProviderScimcredentialsResponseBody.ts +141 -0
- package/src/models/ListIdentityProvidersRequest.ts +2 -2
- package/src/models/ListIdentityProvidersResponseBody.ts +25 -77
- package/src/models/PrepareIdentityProviderScimrequest.ts +24 -0
- package/src/models/PrepareIdentityProviderScimresponse.ts +40 -0
- package/src/models/PrepareIdentityProviderScimresponseBody.ts +231 -0
- package/src/models/UpdateIdentityProviderRequest.ts +20 -43
- package/src/models/UpdateIdentityProviderResponseBody.ts +35 -68
- package/src/models/UpdateIdentityProviderScimrequest.ts +65 -0
- package/src/models/UpdateIdentityProviderScimresponse.ts +40 -0
- package/src/models/UpdateIdentityProviderScimresponseBody.ts +428 -0
- package/src/models/UpdateIdentityProviderScimshrinkRequest.ts +33 -0
- package/src/models/UpdateIdentityProviderShrinkRequest.ts +1 -1
- package/src/models/VerifyAgentCodePackageOssRamAuthorizationRequest.ts +1 -1
- package/src/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.ts +28 -2
- package/src/models/model.ts +37 -0
package/src/client.ts
CHANGED
|
@@ -685,15 +685,15 @@ export default class Client extends OpenApi {
|
|
|
685
685
|
}
|
|
686
686
|
|
|
687
687
|
/**
|
|
688
|
-
* Binds an external identity provider to a specified workspace for single sign-on and organization member synchronization of workspace users.
|
|
688
|
+
* Binds an external identity provider to a specified workspace for single sign-on and organization member synchronization of workspace users. A maximum of one external identity provider can be bound to each workspace. The binding is an asynchronous operation. After the API returns, you can query the status by calling GetIdentityProvider to track the progress.
|
|
689
689
|
*
|
|
690
690
|
* @remarks
|
|
691
691
|
* ## Features and prerequisites
|
|
692
|
-
* A workspace can be bound to only one external identity provider. The identityProviderType parameter supports DingTalk, Feishu, and CustomSSO. CustomSSO only initializes the shared user pool. Do not pass non-empty metadata, and do not pass true for loginEnabled or syncEnabled. By default, both switches are turned off. Protocols and SAML configurations are saved by calling UpdateIdentityProvider. SCIM is configured through a separate API.
|
|
693
|
-
* For DingTalk,
|
|
692
|
+
* A workspace can be bound to only one external identity provider. The identityProviderType parameter supports DingTalk, Feishu, and CustomSSO. CustomSSO only initializes the shared user pool. Do not pass non-empty metadata, and do not pass true for loginEnabled or syncEnabled. By default, both switches are turned off. Protocols and SAML configurations are saved by calling UpdateIdentityProvider. SCIM is configured through a separate API. Saving SAML first is not required. After the request is accepted and CONFIGURED is returned, call GetIdentityProvider and wait for the user pool initialization to complete. READY only indicates that the resource is ready, not that SAML is configured. If the same CustomSSO binding is in the CONFIGURED or READY state, the existing binding may be returned. Not all states can be treated as repeatedly creatable.
|
|
693
|
+
* For DingTalk, appKey, appSecret, and corpId are required in metadata. For Feishu, appId and appSecret are required. The vendor login switch is enabled by default. The synchronization switch is disabled by default. When synchronization is enabled, encryptKey and verificationToken are also required. The vendor syncOnBind and syncScope parameters retain the existing department-based synchronization definitions. Do not use these vendor pull parameters to replace SCIM configurations during CustomSSO initialization.
|
|
694
694
|
* ## Requests and examples
|
|
695
695
|
* POST /workspaces/{workspaceId}/identity-providers
|
|
696
|
-
* Call conventions: Call the API
|
|
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 provider resources of the workspace. The ws-example, URL, certificate, and token in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
697
697
|
* ```text
|
|
698
698
|
* POST /workspaces/ws-example/identity-providers
|
|
699
699
|
* {"identityProviderType": "CustomSSO"}
|
|
@@ -711,7 +711,7 @@ export default class Client extends OpenApi {
|
|
|
711
711
|
* }
|
|
712
712
|
* ```
|
|
713
713
|
* ## 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. A synchronous call to
|
|
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. A synchronous call failure to an upstream service may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
|
|
715
715
|
* 409 IdentityProviderAlreadyBound: An external binding already exists. Query and reuse the correct binding first. Do not automatically unbind the entire binding. Asynchronous initialization failure does not equal HTTP request failure. You must continue to query the status.
|
|
716
716
|
*
|
|
717
717
|
* @param tmpReq - CreateIdentityProviderRequest
|
|
@@ -751,15 +751,15 @@ export default class Client extends OpenApi {
|
|
|
751
751
|
}
|
|
752
752
|
|
|
753
753
|
/**
|
|
754
|
-
* Binds an external identity provider to a specified workspace for single sign-on and organization member synchronization of workspace users.
|
|
754
|
+
* Binds an external identity provider to a specified workspace for single sign-on and organization member synchronization of workspace users. A maximum of one external identity provider can be bound to each workspace. The binding is an asynchronous operation. After the API returns, you can query the status by calling GetIdentityProvider to track the progress.
|
|
755
755
|
*
|
|
756
756
|
* @remarks
|
|
757
757
|
* ## Features and prerequisites
|
|
758
|
-
* A workspace can be bound to only one external identity provider. The identityProviderType parameter supports DingTalk, Feishu, and CustomSSO. CustomSSO only initializes the shared user pool. Do not pass non-empty metadata, and do not pass true for loginEnabled or syncEnabled. By default, both switches are turned off. Protocols and SAML configurations are saved by calling UpdateIdentityProvider. SCIM is configured through a separate API.
|
|
759
|
-
* For DingTalk,
|
|
758
|
+
* A workspace can be bound to only one external identity provider. The identityProviderType parameter supports DingTalk, Feishu, and CustomSSO. CustomSSO only initializes the shared user pool. Do not pass non-empty metadata, and do not pass true for loginEnabled or syncEnabled. By default, both switches are turned off. Protocols and SAML configurations are saved by calling UpdateIdentityProvider. SCIM is configured through a separate API. Saving SAML first is not required. After the request is accepted and CONFIGURED is returned, call GetIdentityProvider and wait for the user pool initialization to complete. READY only indicates that the resource is ready, not that SAML is configured. If the same CustomSSO binding is in the CONFIGURED or READY state, the existing binding may be returned. Not all states can be treated as repeatedly creatable.
|
|
759
|
+
* For DingTalk, appKey, appSecret, and corpId are required in metadata. For Feishu, appId and appSecret are required. The vendor login switch is enabled by default. The synchronization switch is disabled by default. When synchronization is enabled, encryptKey and verificationToken are also required. The vendor syncOnBind and syncScope parameters retain the existing department-based synchronization definitions. Do not use these vendor pull parameters to replace SCIM configurations during CustomSSO initialization.
|
|
760
760
|
* ## Requests and examples
|
|
761
761
|
* POST /workspaces/{workspaceId}/identity-providers
|
|
762
|
-
* Call conventions: Call the API
|
|
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 provider resources of the workspace. The ws-example, URL, certificate, and token in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
763
763
|
* ```text
|
|
764
764
|
* POST /workspaces/ws-example/identity-providers
|
|
765
765
|
* {"identityProviderType": "CustomSSO"}
|
|
@@ -777,7 +777,7 @@ export default class Client extends OpenApi {
|
|
|
777
777
|
* }
|
|
778
778
|
* ```
|
|
779
779
|
* ## 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. A synchronous call to
|
|
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. A synchronous call failure to an upstream service may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
|
|
781
781
|
* 409 IdentityProviderAlreadyBound: An external binding already exists. Query and reuse the correct binding first. Do not automatically unbind the entire binding. Asynchronous initialization failure does not equal HTTP request failure. You must continue to query the status.
|
|
782
782
|
*
|
|
783
783
|
* @param request - CreateIdentityProviderRequest
|
|
@@ -789,6 +789,113 @@ export default class Client extends OpenApi {
|
|
|
789
789
|
return await this.createIdentityProviderWithOptions(workspaceId, request, headers, runtime);
|
|
790
790
|
}
|
|
791
791
|
|
|
792
|
+
/**
|
|
793
|
+
* Issues a SCIM credential explicitly and returns the plaintext token only for the current call. A maximum of two credentials are allowed in the same pool. This operation does not automatically revoke old credentials or enable AC user synchronization.
|
|
794
|
+
*
|
|
795
|
+
* @remarks
|
|
796
|
+
* ## Features and prerequisites
|
|
797
|
+
* Issues a new credential explicitly. This requires an available shared pool and the AgentIdentity SCIM reception to be Enabled. This operation does not automatically enable reception. If it is not enabled, call prepare first. Returns the configuration, credential summary, and the current token. The limit of a maximum of two credentials is enforced by AgentIdentity. An existing available token does not prevent users from explicitly creating a second one. Old credentials are not automatically revoked, and no extended rotation process is provided.
|
|
798
|
+
* The token is returned only once and cannot be retrieved again in subsequent list and query operations. Do not automatically retry the issuance. If the response is lost, check the list first to verify whether it has been created. Creating a credential does not enable AC syncEnabled, start a full user import, or switch SAML logon. Deleting an old token should be performed explicitly after the user confirms the actual usage of the external provisioning system.
|
|
799
|
+
* ## Request and examples
|
|
800
|
+
* POST /workspaces/{workspaceId}/scim-provisioning/credentials
|
|
801
|
+
* Call conventions: Call the operation in the region of the target workspace, using an AK/STS identity that has permissions for the identity source resources of the corresponding workspace. The ws-example, URL, certificate, and token in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameter content of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log the key. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
802
|
+
* ```text
|
|
803
|
+
* POST /workspaces/ws-example/scim-provisioning/credentials
|
|
804
|
+
* No business request body.
|
|
805
|
+
* ```
|
|
806
|
+
* ## Response example
|
|
807
|
+
* ```json
|
|
808
|
+
* {
|
|
809
|
+
* "data": {
|
|
810
|
+
* "configuration": {
|
|
811
|
+
* "status": "Enabled",
|
|
812
|
+
* "baseUrl": "https://example.com/scim/v2"
|
|
813
|
+
* },
|
|
814
|
+
* "credential": {
|
|
815
|
+
* "credentialId": "credential-example",
|
|
816
|
+
* "status": "Enabled",
|
|
817
|
+
* "expireTime": "<Upstream expiration time>"
|
|
818
|
+
* },
|
|
819
|
+
* "token": "<Newly issued token for the current request>"
|
|
820
|
+
* }
|
|
821
|
+
* }
|
|
822
|
+
* ```
|
|
823
|
+
* ## Errors and handling
|
|
824
|
+
* Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that there is no binding of the matching type. Synchronous calls to the upstream may fail and return 503 IdentityProviderProvisioningUnavailable. Keep the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
|
|
825
|
+
* 400 LimitExceeded.ScimCredential: A maximum of two credentials are allowed. Delete one before you can continue to create. 400 InvalidParameter: Reception is not enabled or the shared pool is unavailable. Do not retry quota errors as system failures.
|
|
826
|
+
* ## Call relationships and usage boundaries
|
|
827
|
+
* After creation, securely save the token that is returned only once and configure it in the external provisioning system. Existing tokens remain valid. Only DeleteIdentityProviderSCIMCredential revokes the specified credential. Do not automatically retry when the response is lost. Call ListIdentityProviderSCIMCredentials to check first. This operation does not provide automatic rotation or scaling.
|
|
828
|
+
*
|
|
829
|
+
* @param request - CreateIdentityProviderSCIMCredentialRequest
|
|
830
|
+
* @param headers - map
|
|
831
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
832
|
+
* @returns CreateIdentityProviderSCIMCredentialResponse
|
|
833
|
+
*/
|
|
834
|
+
async createIdentityProviderSCIMCredentialWithOptions(workspaceId: string, request: $_model.CreateIdentityProviderSCIMCredentialRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateIdentityProviderSCIMCredentialResponse> {
|
|
835
|
+
request.validate();
|
|
836
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
837
|
+
headers: headers,
|
|
838
|
+
});
|
|
839
|
+
let params = new $OpenApiUtil.Params({
|
|
840
|
+
action: "CreateIdentityProviderSCIMCredential",
|
|
841
|
+
version: "2026-08-04",
|
|
842
|
+
protocol: "HTTPS",
|
|
843
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/scim-provisioning/credentials`,
|
|
844
|
+
method: "POST",
|
|
845
|
+
authType: "AK",
|
|
846
|
+
style: "ROA",
|
|
847
|
+
reqBodyType: "json",
|
|
848
|
+
bodyType: "json",
|
|
849
|
+
});
|
|
850
|
+
return $dara.cast<$_model.CreateIdentityProviderSCIMCredentialResponse>(await this.callApi(params, req, runtime), new $_model.CreateIdentityProviderSCIMCredentialResponse({}));
|
|
851
|
+
}
|
|
852
|
+
|
|
853
|
+
/**
|
|
854
|
+
* Issues a SCIM credential explicitly and returns the plaintext token only for the current call. A maximum of two credentials are allowed in the same pool. This operation does not automatically revoke old credentials or enable AC user synchronization.
|
|
855
|
+
*
|
|
856
|
+
* @remarks
|
|
857
|
+
* ## Features and prerequisites
|
|
858
|
+
* Issues a new credential explicitly. This requires an available shared pool and the AgentIdentity SCIM reception to be Enabled. This operation does not automatically enable reception. If it is not enabled, call prepare first. Returns the configuration, credential summary, and the current token. The limit of a maximum of two credentials is enforced by AgentIdentity. An existing available token does not prevent users from explicitly creating a second one. Old credentials are not automatically revoked, and no extended rotation process is provided.
|
|
859
|
+
* The token is returned only once and cannot be retrieved again in subsequent list and query operations. Do not automatically retry the issuance. If the response is lost, check the list first to verify whether it has been created. Creating a credential does not enable AC syncEnabled, start a full user import, or switch SAML logon. Deleting an old token should be performed explicitly after the user confirms the actual usage of the external provisioning system.
|
|
860
|
+
* ## Request and examples
|
|
861
|
+
* POST /workspaces/{workspaceId}/scim-provisioning/credentials
|
|
862
|
+
* Call conventions: Call the operation in the region of the target workspace, using an AK/STS identity that has permissions for the identity source resources of the corresponding workspace. The ws-example, URL, certificate, and token in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameter content of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log the key. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
863
|
+
* ```text
|
|
864
|
+
* POST /workspaces/ws-example/scim-provisioning/credentials
|
|
865
|
+
* No business request body.
|
|
866
|
+
* ```
|
|
867
|
+
* ## Response example
|
|
868
|
+
* ```json
|
|
869
|
+
* {
|
|
870
|
+
* "data": {
|
|
871
|
+
* "configuration": {
|
|
872
|
+
* "status": "Enabled",
|
|
873
|
+
* "baseUrl": "https://example.com/scim/v2"
|
|
874
|
+
* },
|
|
875
|
+
* "credential": {
|
|
876
|
+
* "credentialId": "credential-example",
|
|
877
|
+
* "status": "Enabled",
|
|
878
|
+
* "expireTime": "<Upstream expiration time>"
|
|
879
|
+
* },
|
|
880
|
+
* "token": "<Newly issued token for the current request>"
|
|
881
|
+
* }
|
|
882
|
+
* }
|
|
883
|
+
* ```
|
|
884
|
+
* ## Errors and handling
|
|
885
|
+
* Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that there is no binding of the matching type. Synchronous calls to the upstream may fail and return 503 IdentityProviderProvisioningUnavailable. Keep the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
|
|
886
|
+
* 400 LimitExceeded.ScimCredential: A maximum of two credentials are allowed. Delete one before you can continue to create. 400 InvalidParameter: Reception is not enabled or the shared pool is unavailable. Do not retry quota errors as system failures.
|
|
887
|
+
* ## Call relationships and usage boundaries
|
|
888
|
+
* After creation, securely save the token that is returned only once and configure it in the external provisioning system. Existing tokens remain valid. Only DeleteIdentityProviderSCIMCredential revokes the specified credential. Do not automatically retry when the response is lost. Call ListIdentityProviderSCIMCredentials to check first. This operation does not provide automatic rotation or scaling.
|
|
889
|
+
*
|
|
890
|
+
* @param request - CreateIdentityProviderSCIMCredentialRequest
|
|
891
|
+
* @returns CreateIdentityProviderSCIMCredentialResponse
|
|
892
|
+
*/
|
|
893
|
+
async createIdentityProviderSCIMCredential(workspaceId: string, request: $_model.CreateIdentityProviderSCIMCredentialRequest): Promise<$_model.CreateIdentityProviderSCIMCredentialResponse> {
|
|
894
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
895
|
+
let headers : {[key: string ]: string} = { };
|
|
896
|
+
return await this.createIdentityProviderSCIMCredentialWithOptions(workspaceId, request, headers, runtime);
|
|
897
|
+
}
|
|
898
|
+
|
|
792
899
|
/**
|
|
793
900
|
* Initiates a manual synchronization of an identity provider.
|
|
794
901
|
*
|
|
@@ -1818,15 +1925,15 @@ export default class Client extends OpenApi {
|
|
|
1818
1925
|
}
|
|
1819
1926
|
|
|
1820
1927
|
/**
|
|
1821
|
-
* Disconnects the
|
|
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 switch API operations.
|
|
1822
1929
|
*
|
|
1823
1930
|
* @remarks
|
|
1824
1931
|
* ## Features and prerequisites
|
|
1825
|
-
* This
|
|
1826
|
-
* After the request is accepted, the
|
|
1932
|
+
* This operation completely disconnects the integration, rather than simply disabling logon. Disconnecting CustomSSO clears the AC users imported from this identity source, the remote shared user pool and related resources, and the logon publishing configurations and bindings. Therefore, both SAML and SCIM are affected. However, this operation does not delete the enterprise applications created by users on external platforms such as Azure. Before disconnecting, the system checks for references between users and teams. If references exist, the disconnection is rejected.
|
|
1933
|
+
* After the request is accepted, the status returned is DISCONNECTING. You can query the status by calling GetIdentityProvider. The cleanup is complete only when the binding no longer exists (IdentityProviderNotFound). The binding should also no longer appear in the list. DISCONNECT_FAILED indicates that partial cleanup may have occurred, and the state cannot be restored to a completely unconfigured state. You can retry based on the returned status. If the binding does not exist in the first place, the API operation returns a placeholder result indicating no binding without creating new resources. An ongoing disconnection task may return the current binding. Do not use this API operation as a substitute for setting loginEnabled=false, syncEnabled=false, or deleting a single token.
|
|
1827
1934
|
* ## Requests and examples
|
|
1828
1935
|
* DELETE /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
1829
|
-
*
|
|
1936
|
+
* Calling conventions: Call the API operation in the region of the target workspace, using an AK/STS identity that has the corresponding workspace identity source resource permissions. The ws-example, URLs, certificates, and tokens in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log secrets. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
1830
1937
|
* ```text
|
|
1831
1938
|
* DELETE /workspaces/ws-example/identity-providers/CustomSSO
|
|
1832
1939
|
* ```
|
|
@@ -1841,8 +1948,10 @@ export default class Client extends OpenApi {
|
|
|
1841
1948
|
* }
|
|
1842
1949
|
* ```
|
|
1843
1950
|
* ## Errors and handling
|
|
1844
|
-
* 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.
|
|
1845
|
-
* 409 IdentityProvider.Disconnect.Conflict: Users of this identity source still belong to a
|
|
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 services that fail may return 503 IdentityProviderProvisioningUnavailable. Keep the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
|
|
1952
|
+
* 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
|
+
* ## Calling relationships and usage boundaries
|
|
1954
|
+
* If you only need to disable a specific capability: To disable SAML logon, use UpdateIdentityProvider and set loginEnabled=false. To disable SCIM, use UpdateIdentityProviderSCIM and set syncEnabled=false. To revoke a single token, use DeleteIdentityProviderSCIMCredential. Call this API operation only when you need to completely disconnect the integration.
|
|
1846
1955
|
*
|
|
1847
1956
|
* @param request - DeleteIdentityProviderRequest
|
|
1848
1957
|
* @param headers - map
|
|
@@ -1875,15 +1984,15 @@ export default class Client extends OpenApi {
|
|
|
1875
1984
|
}
|
|
1876
1985
|
|
|
1877
1986
|
/**
|
|
1878
|
-
* Disconnects the
|
|
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 switch API operations.
|
|
1879
1988
|
*
|
|
1880
1989
|
* @remarks
|
|
1881
1990
|
* ## Features and prerequisites
|
|
1882
|
-
* This
|
|
1883
|
-
* After the request is accepted, the
|
|
1991
|
+
* This operation completely disconnects the integration, rather than simply disabling logon. Disconnecting CustomSSO clears the AC users imported from this identity source, the remote shared user pool and related resources, and the logon publishing configurations and bindings. Therefore, both SAML and SCIM are affected. However, this operation does not delete the enterprise applications created by users on external platforms such as Azure. Before disconnecting, the system checks for references between users and teams. If references exist, the disconnection is rejected.
|
|
1992
|
+
* After the request is accepted, the status returned is DISCONNECTING. You can query the status by calling GetIdentityProvider. The cleanup is complete only when the binding no longer exists (IdentityProviderNotFound). The binding should also no longer appear in the list. DISCONNECT_FAILED indicates that partial cleanup may have occurred, and the state cannot be restored to a completely unconfigured state. You can retry based on the returned status. If the binding does not exist in the first place, the API operation returns a placeholder result indicating no binding without creating new resources. An ongoing disconnection task may return the current binding. Do not use this API operation as a substitute for setting loginEnabled=false, syncEnabled=false, or deleting a single token.
|
|
1884
1993
|
* ## Requests and examples
|
|
1885
1994
|
* DELETE /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
1886
|
-
*
|
|
1995
|
+
* Calling conventions: Call the API operation in the region of the target workspace, using an AK/STS identity that has the corresponding workspace identity source resource permissions. The ws-example, URLs, certificates, and tokens in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log secrets. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
1887
1996
|
* ```text
|
|
1888
1997
|
* DELETE /workspaces/ws-example/identity-providers/CustomSSO
|
|
1889
1998
|
* ```
|
|
@@ -1898,8 +2007,10 @@ export default class Client extends OpenApi {
|
|
|
1898
2007
|
* }
|
|
1899
2008
|
* ```
|
|
1900
2009
|
* ## Errors and handling
|
|
1901
|
-
* 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.
|
|
1902
|
-
* 409 IdentityProvider.Disconnect.Conflict: Users of this identity source still belong to a
|
|
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 services that fail may return 503 IdentityProviderProvisioningUnavailable. Keep the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
|
|
2011
|
+
* 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
|
+
* ## Calling relationships and usage boundaries
|
|
2013
|
+
* If you only need to disable a specific capability: To disable SAML logon, use UpdateIdentityProvider and set loginEnabled=false. To disable SCIM, use UpdateIdentityProviderSCIM and set syncEnabled=false. To revoke a single token, use DeleteIdentityProviderSCIMCredential. Call this API operation only when you need to completely disconnect the integration.
|
|
1903
2014
|
*
|
|
1904
2015
|
* @param request - DeleteIdentityProviderRequest
|
|
1905
2016
|
* @returns DeleteIdentityProviderResponse
|
|
@@ -1910,6 +2021,51 @@ export default class Client extends OpenApi {
|
|
|
1910
2021
|
return await this.deleteIdentityProviderWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
1911
2022
|
}
|
|
1912
2023
|
|
|
2024
|
+
/**
|
|
2025
|
+
* 删除 SCIM 凭据
|
|
2026
|
+
*
|
|
2027
|
+
* @remarks
|
|
2028
|
+
* ## 功能与前提\n撤销指定凭据,credentialId 必填且非空,从凭据列表取得。要求共享池可用,但不要求 SAML 已配置或 SCIM 接收为 Enabled。删除后使用该 Token 的外部预配请求会失效;只影响选定凭据,不自动关闭接收、不自动关闭 AC syncEnabled,也不影响另一枚凭据或 SAML。\n即使删除最后一枚凭据,也不自动回写同步开关或重发新 Token;用户应按需要先停用外部预配或更换其使用的 Token。成功返回公共响应,无业务 data 内容;刷新列表确认。对未知或已删除 ID 的结果由上游决定,不承诺统一 404 或无条件幂等成功。\n\n## 请求与示例\nDELETE /workspaces/{workspaceId}/scim-provisioning/credentials/{credentialId}\n调用约定:按目标 Workspace 的地域调用,使用有相应 Workspace 身份源资源权限的 AK/STS 身份。下文示例中的 ws-example、URL、证书和 Token 均为占位值,需替换为真实值。请求体示例表示公开 API 的 body 参数内容,不是后端直连接口额外的 body 包装。返回示例只展示业务部分,外层还包括 requestId、success、code、message、httpStatusCode;排障请保留 requestId,不记录密钥。业务任务异步不意味着 HTTP 请求长连接等待完成。\n```text\nDELETE /workspaces/ws-example/scim-provisioning/credentials/credential-example\n```\n\n## 返回示例\n```json\n{\n "success": true,\n "httpStatusCode": 200\n}\n```\n\n## 错误与处理\n错误处理:400 InvalidParameter 表示参数或当前配置前提不满足;404 IdentityProviderNotFound 表示没有匹配类型的绑定。同步调用上游失败可能返回 503 IdentityProviderProvisioningUnavailable;保留请求 ID 排查,不把读取失败解释为未配置。实际鉴权和 Workspace 不存在错误沿用公共错误处理。\n400 InvalidParameter:credentialId 为空或共享池不可用。404 IdentityProviderNotFound 指绑定不存在,不代表所有未知凭据 ID 都返回该码。其他删除错误按上游结果处理,失败时刷新列表核对,不自动创建替代 Token。\n\n## 调用关系与使用边界\n使用 ListIdentityProviderSCIMCredentials 取得 credentialId 后删除指定凭据。若外部预配系统仍使用该 Token,后续预配可能鉴权失败,因此应先确认实际使用情况。删除后不会自动创建新凭据、关闭 AC 同步开关或关闭 SAML 登录。
|
|
2029
|
+
*
|
|
2030
|
+
* @param request - DeleteIdentityProviderSCIMCredentialRequest
|
|
2031
|
+
* @param headers - map
|
|
2032
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2033
|
+
* @returns DeleteIdentityProviderSCIMCredentialResponse
|
|
2034
|
+
*/
|
|
2035
|
+
async deleteIdentityProviderSCIMCredentialWithOptions(workspaceId: string, credentialId: string, request: $_model.DeleteIdentityProviderSCIMCredentialRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteIdentityProviderSCIMCredentialResponse> {
|
|
2036
|
+
request.validate();
|
|
2037
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
2038
|
+
headers: headers,
|
|
2039
|
+
});
|
|
2040
|
+
let params = new $OpenApiUtil.Params({
|
|
2041
|
+
action: "DeleteIdentityProviderSCIMCredential",
|
|
2042
|
+
version: "2026-08-04",
|
|
2043
|
+
protocol: "HTTPS",
|
|
2044
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/scim-provisioning/credentials/${$dara.URL.percentEncode(credentialId)}`,
|
|
2045
|
+
method: "DELETE",
|
|
2046
|
+
authType: "AK",
|
|
2047
|
+
style: "ROA",
|
|
2048
|
+
reqBodyType: "json",
|
|
2049
|
+
bodyType: "json",
|
|
2050
|
+
});
|
|
2051
|
+
return $dara.cast<$_model.DeleteIdentityProviderSCIMCredentialResponse>(await this.callApi(params, req, runtime), new $_model.DeleteIdentityProviderSCIMCredentialResponse({}));
|
|
2052
|
+
}
|
|
2053
|
+
|
|
2054
|
+
/**
|
|
2055
|
+
* 删除 SCIM 凭据
|
|
2056
|
+
*
|
|
2057
|
+
* @remarks
|
|
2058
|
+
* ## 功能与前提\n撤销指定凭据,credentialId 必填且非空,从凭据列表取得。要求共享池可用,但不要求 SAML 已配置或 SCIM 接收为 Enabled。删除后使用该 Token 的外部预配请求会失效;只影响选定凭据,不自动关闭接收、不自动关闭 AC syncEnabled,也不影响另一枚凭据或 SAML。\n即使删除最后一枚凭据,也不自动回写同步开关或重发新 Token;用户应按需要先停用外部预配或更换其使用的 Token。成功返回公共响应,无业务 data 内容;刷新列表确认。对未知或已删除 ID 的结果由上游决定,不承诺统一 404 或无条件幂等成功。\n\n## 请求与示例\nDELETE /workspaces/{workspaceId}/scim-provisioning/credentials/{credentialId}\n调用约定:按目标 Workspace 的地域调用,使用有相应 Workspace 身份源资源权限的 AK/STS 身份。下文示例中的 ws-example、URL、证书和 Token 均为占位值,需替换为真实值。请求体示例表示公开 API 的 body 参数内容,不是后端直连接口额外的 body 包装。返回示例只展示业务部分,外层还包括 requestId、success、code、message、httpStatusCode;排障请保留 requestId,不记录密钥。业务任务异步不意味着 HTTP 请求长连接等待完成。\n```text\nDELETE /workspaces/ws-example/scim-provisioning/credentials/credential-example\n```\n\n## 返回示例\n```json\n{\n "success": true,\n "httpStatusCode": 200\n}\n```\n\n## 错误与处理\n错误处理:400 InvalidParameter 表示参数或当前配置前提不满足;404 IdentityProviderNotFound 表示没有匹配类型的绑定。同步调用上游失败可能返回 503 IdentityProviderProvisioningUnavailable;保留请求 ID 排查,不把读取失败解释为未配置。实际鉴权和 Workspace 不存在错误沿用公共错误处理。\n400 InvalidParameter:credentialId 为空或共享池不可用。404 IdentityProviderNotFound 指绑定不存在,不代表所有未知凭据 ID 都返回该码。其他删除错误按上游结果处理,失败时刷新列表核对,不自动创建替代 Token。\n\n## 调用关系与使用边界\n使用 ListIdentityProviderSCIMCredentials 取得 credentialId 后删除指定凭据。若外部预配系统仍使用该 Token,后续预配可能鉴权失败,因此应先确认实际使用情况。删除后不会自动创建新凭据、关闭 AC 同步开关或关闭 SAML 登录。
|
|
2059
|
+
*
|
|
2060
|
+
* @param request - DeleteIdentityProviderSCIMCredentialRequest
|
|
2061
|
+
* @returns DeleteIdentityProviderSCIMCredentialResponse
|
|
2062
|
+
*/
|
|
2063
|
+
async deleteIdentityProviderSCIMCredential(workspaceId: string, credentialId: string, request: $_model.DeleteIdentityProviderSCIMCredentialRequest): Promise<$_model.DeleteIdentityProviderSCIMCredentialResponse> {
|
|
2064
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
2065
|
+
let headers : {[key: string ]: string} = { };
|
|
2066
|
+
return await this.deleteIdentityProviderSCIMCredentialWithOptions(workspaceId, credentialId, request, headers, runtime);
|
|
2067
|
+
}
|
|
2068
|
+
|
|
1913
2069
|
/**
|
|
1914
2070
|
* Deletes an image cache.
|
|
1915
2071
|
*
|
|
@@ -3302,19 +3458,19 @@ export default class Client extends OpenApi {
|
|
|
3302
3458
|
}
|
|
3303
3459
|
|
|
3304
3460
|
/**
|
|
3305
|
-
* Queries the binding
|
|
3461
|
+
* Queries the binding and expected configuration of a specified identity provider. When CustomSSO is configured with SAML, this operation reads back the actual upstream SSO configuration. The SCIM status is queried through a separate API operation.
|
|
3306
3462
|
*
|
|
3307
3463
|
* @remarks
|
|
3308
3464
|
* ## Features and prerequisites
|
|
3309
|
-
* Reads existing bindings by type.
|
|
3310
|
-
* Only this
|
|
3311
|
-
* ##
|
|
3465
|
+
* Reads existing bindings by type. CustomSSO returns the saved protocol, standardized saml, expected loginEnabled, syncEnabled, and shared binding status. If SAML is not configured, the saml and configuration fields may not be returned. When saml is configured, the system additionally queries AgentIdentity, and configuration represents the actual SSO configuration. The saml field is the data source for the edit form. The status switch for configuration can be Enabled or Disabled. If the upstream query fails, an error is reported. Do not treat this as an unconfigured state.
|
|
3466
|
+
* Only this operation reads back the actual SAML configuration. List and write operations do not guarantee that configuration is returned. A user pool in the READY state does not indicate that SAML is configured. UPDATING and UPDATE_FAILED describe logon configuration tasks, not SCIM tasks. The vendor callback URL for CustomSSO is empty. Use GetIdentityProviderSCIM.operationStatus to query SCIM operation results.
|
|
3467
|
+
* ## Request and examples
|
|
3312
3468
|
* GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
3313
|
-
* Calling
|
|
3469
|
+
* Calling conventions: Call the API operation in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example shows the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business data. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log keys. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
|
|
3314
3470
|
* ```text
|
|
3315
3471
|
* GET /workspaces/ws-example/identity-providers/CustomSSO
|
|
3316
3472
|
* ```
|
|
3317
|
-
* ## Response
|
|
3473
|
+
* ## Response examples
|
|
3318
3474
|
* ```json
|
|
3319
3475
|
* {
|
|
3320
3476
|
* "data": {
|
|
@@ -3327,8 +3483,10 @@ export default class Client extends OpenApi {
|
|
|
3327
3483
|
* }
|
|
3328
3484
|
* ```
|
|
3329
3485
|
* ## Errors and handling
|
|
3330
|
-
* Error handling:
|
|
3331
|
-
* 404 IdentityProviderNotFound: No binding exists, or the
|
|
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 not found errors follow common error handling.
|
|
3487
|
+
* 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
|
+
* ## 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 API operation. Do not use status=READY of this API operation as the basis for successful SCIM synchronization. Currently, OIDC, JIT configuration, or JIT status fields are not provided.
|
|
3332
3490
|
*
|
|
3333
3491
|
* @param request - GetIdentityProviderRequest
|
|
3334
3492
|
* @param headers - map
|
|
@@ -3355,19 +3513,19 @@ export default class Client extends OpenApi {
|
|
|
3355
3513
|
}
|
|
3356
3514
|
|
|
3357
3515
|
/**
|
|
3358
|
-
* Queries the binding
|
|
3516
|
+
* Queries the binding and expected configuration of a specified identity provider. When CustomSSO is configured with SAML, this operation reads back the actual upstream SSO configuration. The SCIM status is queried through a separate API operation.
|
|
3359
3517
|
*
|
|
3360
3518
|
* @remarks
|
|
3361
3519
|
* ## Features and prerequisites
|
|
3362
|
-
* Reads existing bindings by type.
|
|
3363
|
-
* Only this
|
|
3364
|
-
* ##
|
|
3520
|
+
* Reads existing bindings by type. CustomSSO returns the saved protocol, standardized saml, expected loginEnabled, syncEnabled, and shared binding status. If SAML is not configured, the saml and configuration fields may not be returned. When saml is configured, the system additionally queries AgentIdentity, and configuration represents the actual SSO configuration. The saml field is the data source for the edit form. The status switch for configuration can be Enabled or Disabled. If the upstream query fails, an error is reported. Do not treat this as an unconfigured state.
|
|
3521
|
+
* Only this operation reads back the actual SAML configuration. List and write operations do not guarantee that configuration is returned. A user pool in the READY state does not indicate that SAML is configured. UPDATING and UPDATE_FAILED describe logon configuration tasks, not SCIM tasks. The vendor callback URL for CustomSSO is empty. Use GetIdentityProviderSCIM.operationStatus to query SCIM operation results.
|
|
3522
|
+
* ## Request and examples
|
|
3365
3523
|
* GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
3366
|
-
* Calling
|
|
3524
|
+
* Calling conventions: Call the API operation in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example shows the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business data. The outer layer also includes requestId, success, code, message, and httpStatusCode. Keep the requestId for troubleshooting and do not log keys. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
|
|
3367
3525
|
* ```text
|
|
3368
3526
|
* GET /workspaces/ws-example/identity-providers/CustomSSO
|
|
3369
3527
|
* ```
|
|
3370
|
-
* ## Response
|
|
3528
|
+
* ## Response examples
|
|
3371
3529
|
* ```json
|
|
3372
3530
|
* {
|
|
3373
3531
|
* "data": {
|
|
@@ -3380,8 +3538,10 @@ export default class Client extends OpenApi {
|
|
|
3380
3538
|
* }
|
|
3381
3539
|
* ```
|
|
3382
3540
|
* ## Errors and handling
|
|
3383
|
-
* Error handling:
|
|
3384
|
-
* 404 IdentityProviderNotFound: No binding exists, or the
|
|
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 not found errors follow common error handling.
|
|
3542
|
+
* 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
|
+
* ## 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 API operation. Do not use status=READY of this API operation as the basis for successful SCIM synchronization. Currently, OIDC, JIT configuration, or JIT status fields are not provided.
|
|
3385
3545
|
*
|
|
3386
3546
|
* @param request - GetIdentityProviderRequest
|
|
3387
3547
|
* @returns GetIdentityProviderResponse
|
|
@@ -3392,6 +3552,154 @@ export default class Client extends OpenApi {
|
|
|
3392
3552
|
return await this.getIdentityProviderWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
3393
3553
|
}
|
|
3394
3554
|
|
|
3555
|
+
/**
|
|
3556
|
+
* Queries the actual SCIM receiving configuration, the expected AC synchronization switch, and the status of the most recent independent SCIM task. Prior SAML configuration is not required.
|
|
3557
|
+
*
|
|
3558
|
+
* @remarks
|
|
3559
|
+
* ## Features and prerequisites
|
|
3560
|
+
* The shared CustomSSO user pool must be created and must not be in the overall dissociation process or have failed to be dissociated. Prior SAML configuration is not required. SAML updates in progress or failed SAML updates do not block the query. The configuration.status and baseUrl parameters are obtained from AgentIdentity. The syncEnabled parameter is the expected AC synchronization switch. The operationStatus parameter indicates the most recent independent SCIM switch and the first full import task when the switch is enabled. The presence of a URL does not mean that external provisioning is complete, nor does it mean that AC synchronization is enabled.
|
|
3561
|
+
* operationStatus: PENDING (waiting), RUNNING (in progress), PAUSED (paused), SUCCESS (succeeded), FAILED (failed), CANCELED (canceled). If there are no historical tasks, it returns null or is not returned. You can poll when the status is PENDING or RUNNING. Stop polling when a terminal state is reached. You can manually refresh when the status is PAUSED. This operation does not provide taskId or failure details, and does not indicate credential issuance, external provisioning connection tests, or the health of continuous incremental synchronization. After it is disabled, the URL, credentials, and historical task records may still be retained.
|
|
3562
|
+
* ## Requests and examples
|
|
3563
|
+
* GET /workspaces/{workspaceId}/scim-provisioning
|
|
3564
|
+
* Calling conventions: Call this operation in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
3565
|
+
* ```text
|
|
3566
|
+
* GET /workspaces/ws-example/scim-provisioning
|
|
3567
|
+
* ```
|
|
3568
|
+
* ## Response example
|
|
3569
|
+
* ```json
|
|
3570
|
+
* {
|
|
3571
|
+
* "data": {
|
|
3572
|
+
* "configuration": {
|
|
3573
|
+
* "status": "Enabled",
|
|
3574
|
+
* "baseUrl": "https://example.com/scim/v2"
|
|
3575
|
+
* },
|
|
3576
|
+
* "syncEnabled": true,
|
|
3577
|
+
* "operationStatus": "SUCCESS"
|
|
3578
|
+
* }
|
|
3579
|
+
* }
|
|
3580
|
+
* ```
|
|
3581
|
+
* ## Errors and handling
|
|
3582
|
+
* Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that 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 dissociated, or failed to be dissociated. If there is no binding, 404 IdentityProviderNotFound is returned. Upstream read failures must retain the error and cannot be mapped to Disabled, unconfigured, or synchronization success.
|
|
3584
|
+
* ## 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 completed, and does not represent the health of continuous incremental synchronization or the success of the external provisioning connection test.
|
|
3586
|
+
*
|
|
3587
|
+
* @param request - GetIdentityProviderSCIMRequest
|
|
3588
|
+
* @param headers - map
|
|
3589
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3590
|
+
* @returns GetIdentityProviderSCIMResponse
|
|
3591
|
+
*/
|
|
3592
|
+
async getIdentityProviderSCIMWithOptions(workspaceId: string, request: $_model.GetIdentityProviderSCIMRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.GetIdentityProviderSCIMResponse> {
|
|
3593
|
+
request.validate();
|
|
3594
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
3595
|
+
headers: headers,
|
|
3596
|
+
});
|
|
3597
|
+
let params = new $OpenApiUtil.Params({
|
|
3598
|
+
action: "GetIdentityProviderSCIM",
|
|
3599
|
+
version: "2026-08-04",
|
|
3600
|
+
protocol: "HTTPS",
|
|
3601
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/scim-provisioning`,
|
|
3602
|
+
method: "GET",
|
|
3603
|
+
authType: "AK",
|
|
3604
|
+
style: "ROA",
|
|
3605
|
+
reqBodyType: "json",
|
|
3606
|
+
bodyType: "json",
|
|
3607
|
+
});
|
|
3608
|
+
return $dara.cast<$_model.GetIdentityProviderSCIMResponse>(await this.callApi(params, req, runtime), new $_model.GetIdentityProviderSCIMResponse({}));
|
|
3609
|
+
}
|
|
3610
|
+
|
|
3611
|
+
/**
|
|
3612
|
+
* Queries the actual SCIM receiving configuration, the expected AC synchronization switch, and the status of the most recent independent SCIM task. Prior SAML configuration is not required.
|
|
3613
|
+
*
|
|
3614
|
+
* @remarks
|
|
3615
|
+
* ## Features and prerequisites
|
|
3616
|
+
* The shared CustomSSO user pool must be created and must not be in the overall dissociation process or have failed to be dissociated. Prior SAML configuration is not required. SAML updates in progress or failed SAML updates do not block the query. The configuration.status and baseUrl parameters are obtained from AgentIdentity. The syncEnabled parameter is the expected AC synchronization switch. The operationStatus parameter indicates the most recent independent SCIM switch and the first full import task when the switch is enabled. The presence of a URL does not mean that external provisioning is complete, nor does it mean that AC synchronization is enabled.
|
|
3617
|
+
* operationStatus: PENDING (waiting), RUNNING (in progress), PAUSED (paused), SUCCESS (succeeded), FAILED (failed), CANCELED (canceled). If there are no historical tasks, it returns null or is not returned. You can poll when the status is PENDING or RUNNING. Stop polling when a terminal state is reached. You can manually refresh when the status is PAUSED. This operation does not provide taskId or failure details, and does not indicate credential issuance, external provisioning connection tests, or the health of continuous incremental synchronization. After it is disabled, the URL, credentials, and historical task records may still be retained.
|
|
3618
|
+
* ## Requests and examples
|
|
3619
|
+
* GET /workspaces/{workspaceId}/scim-provisioning
|
|
3620
|
+
* Calling conventions: Call this operation in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity provider resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
3621
|
+
* ```text
|
|
3622
|
+
* GET /workspaces/ws-example/scim-provisioning
|
|
3623
|
+
* ```
|
|
3624
|
+
* ## Response example
|
|
3625
|
+
* ```json
|
|
3626
|
+
* {
|
|
3627
|
+
* "data": {
|
|
3628
|
+
* "configuration": {
|
|
3629
|
+
* "status": "Enabled",
|
|
3630
|
+
* "baseUrl": "https://example.com/scim/v2"
|
|
3631
|
+
* },
|
|
3632
|
+
* "syncEnabled": true,
|
|
3633
|
+
* "operationStatus": "SUCCESS"
|
|
3634
|
+
* }
|
|
3635
|
+
* }
|
|
3636
|
+
* ```
|
|
3637
|
+
* ## 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 dissociated, or failed to be dissociated. If there is no binding, 404 IdentityProviderNotFound is returned. Upstream read failures must retain the error and cannot be mapped to Disabled, unconfigured, or synchronization success.
|
|
3640
|
+
* ## 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 completed, and does not represent the health of continuous incremental synchronization or the success of the external provisioning connection test.
|
|
3642
|
+
*
|
|
3643
|
+
* @param request - GetIdentityProviderSCIMRequest
|
|
3644
|
+
* @returns GetIdentityProviderSCIMResponse
|
|
3645
|
+
*/
|
|
3646
|
+
async getIdentityProviderSCIM(workspaceId: string, request: $_model.GetIdentityProviderSCIMRequest): Promise<$_model.GetIdentityProviderSCIMResponse> {
|
|
3647
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
3648
|
+
let headers : {[key: string ]: string} = { };
|
|
3649
|
+
return await this.getIdentityProviderSCIMWithOptions(workspaceId, request, headers, runtime);
|
|
3650
|
+
}
|
|
3651
|
+
|
|
3652
|
+
/**
|
|
3653
|
+
* 查询 SAML 服务提供商信息
|
|
3654
|
+
*
|
|
3655
|
+
* @remarks
|
|
3656
|
+
* ## 功能与前提\n要求已有可用 CustomSSO 共享用户池,identityProviderType=CustomSSO,protocol 必填且仅支持精确值 SAML;不要求先上传 IdP Metadata。返回我方 SP 的 entityId、acsUrl、metadataXml,供用户配置外部 IdP。它们不是外部 IdP 的登录 URL 或 IdP Entity ID,不能将 SP XML 作为 IdP XML 提交 UpdateIdentityProvider。\n本接口只读取,不启用登录、不开启 SCIM、不创建凭据、不执行登录连接测试。共享池初始化中、解绑中或解绑失败时不可读取。\n\n## 请求与示例\nGET /workspaces/{workspaceId}/identity-providers/{identityProviderType}/service-provider\n调用约定:按目标 Workspace 的地域调用,使用有相应 Workspace 身份源资源权限的 AK/STS 身份。下文示例中的 ws-example、URL、证书和 Token 均为占位值,需替换为真实值。请求体示例表示公开 API 的 body 参数内容,不是后端直连接口额外的 body 包装。返回示例只展示业务部分,外层还包括 requestId、success、code、message、httpStatusCode;排障请保留 requestId,不记录密钥。业务任务异步不意味着 HTTP 请求长连接等待完成。\n```text\nGET /workspaces/ws-example/identity-providers/CustomSSO/service-provider?protocol=SAML\n```\n\n## 返回示例\n```json\n{\n "data": {\n "protocol": "SAML",\n "entityId": "<我方 SP Entity ID>",\n "acsUrl": "https://example.com/saml/acs",\n "metadataXml": "<我方 SP Metadata XML>"\n }\n}\n```\n\n## 错误与处理\n错误处理:400 InvalidParameter 表示参数或当前配置前提不满足;404 IdentityProviderNotFound 表示没有匹配类型的绑定。同步调用上游失败可能返回 503 IdentityProviderProvisioningUnavailable;保留请求 ID 排查,不把读取失败解释为未配置。实际鉴权和 Workspace 不存在错误沿用公共错误处理。\n400 InvalidParameter:identityProviderType 或 protocol 不支持。404 IdentityProviderNotFound:尚无 CustomSSO 绑定。409 IdentityProviderOperationConflict:用户池未准备好、解绑中或解绑失败。\n\n## 调用关系与使用边界\nSAML 配置顺序:CreateIdentityProvider 初始化 CustomSSO 共享池,等待 GetIdentityProvider 返回 READY;调用本接口取得 SP 信息并配置到外部 IdP;再将外部 IdP Metadata XML 或完整手填配置提交 UpdateIdentityProvider。保存后按需单独启用 loginEnabled。SP 信息查询不会完成外部 IdP 配置或验证登录。
|
|
3657
|
+
*
|
|
3658
|
+
* @param request - GetIdentityProviderServiceProviderRequest
|
|
3659
|
+
* @param headers - map
|
|
3660
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3661
|
+
* @returns GetIdentityProviderServiceProviderResponse
|
|
3662
|
+
*/
|
|
3663
|
+
async getIdentityProviderServiceProviderWithOptions(workspaceId: string, identityProviderType: string, request: $_model.GetIdentityProviderServiceProviderRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.GetIdentityProviderServiceProviderResponse> {
|
|
3664
|
+
request.validate();
|
|
3665
|
+
let query : {[key: string ]: any} = { };
|
|
3666
|
+
if (!$dara.isNull(request.protocol)) {
|
|
3667
|
+
query["protocol"] = request.protocol;
|
|
3668
|
+
}
|
|
3669
|
+
|
|
3670
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
3671
|
+
headers: headers,
|
|
3672
|
+
query: OpenApiUtil.query(query),
|
|
3673
|
+
});
|
|
3674
|
+
let params = new $OpenApiUtil.Params({
|
|
3675
|
+
action: "GetIdentityProviderServiceProvider",
|
|
3676
|
+
version: "2026-08-04",
|
|
3677
|
+
protocol: "HTTPS",
|
|
3678
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/identity-providers/${$dara.URL.percentEncode(identityProviderType)}/service-provider`,
|
|
3679
|
+
method: "GET",
|
|
3680
|
+
authType: "AK",
|
|
3681
|
+
style: "ROA",
|
|
3682
|
+
reqBodyType: "json",
|
|
3683
|
+
bodyType: "json",
|
|
3684
|
+
});
|
|
3685
|
+
return $dara.cast<$_model.GetIdentityProviderServiceProviderResponse>(await this.callApi(params, req, runtime), new $_model.GetIdentityProviderServiceProviderResponse({}));
|
|
3686
|
+
}
|
|
3687
|
+
|
|
3688
|
+
/**
|
|
3689
|
+
* 查询 SAML 服务提供商信息
|
|
3690
|
+
*
|
|
3691
|
+
* @remarks
|
|
3692
|
+
* ## 功能与前提\n要求已有可用 CustomSSO 共享用户池,identityProviderType=CustomSSO,protocol 必填且仅支持精确值 SAML;不要求先上传 IdP Metadata。返回我方 SP 的 entityId、acsUrl、metadataXml,供用户配置外部 IdP。它们不是外部 IdP 的登录 URL 或 IdP Entity ID,不能将 SP XML 作为 IdP XML 提交 UpdateIdentityProvider。\n本接口只读取,不启用登录、不开启 SCIM、不创建凭据、不执行登录连接测试。共享池初始化中、解绑中或解绑失败时不可读取。\n\n## 请求与示例\nGET /workspaces/{workspaceId}/identity-providers/{identityProviderType}/service-provider\n调用约定:按目标 Workspace 的地域调用,使用有相应 Workspace 身份源资源权限的 AK/STS 身份。下文示例中的 ws-example、URL、证书和 Token 均为占位值,需替换为真实值。请求体示例表示公开 API 的 body 参数内容,不是后端直连接口额外的 body 包装。返回示例只展示业务部分,外层还包括 requestId、success、code、message、httpStatusCode;排障请保留 requestId,不记录密钥。业务任务异步不意味着 HTTP 请求长连接等待完成。\n```text\nGET /workspaces/ws-example/identity-providers/CustomSSO/service-provider?protocol=SAML\n```\n\n## 返回示例\n```json\n{\n "data": {\n "protocol": "SAML",\n "entityId": "<我方 SP Entity ID>",\n "acsUrl": "https://example.com/saml/acs",\n "metadataXml": "<我方 SP Metadata XML>"\n }\n}\n```\n\n## 错误与处理\n错误处理:400 InvalidParameter 表示参数或当前配置前提不满足;404 IdentityProviderNotFound 表示没有匹配类型的绑定。同步调用上游失败可能返回 503 IdentityProviderProvisioningUnavailable;保留请求 ID 排查,不把读取失败解释为未配置。实际鉴权和 Workspace 不存在错误沿用公共错误处理。\n400 InvalidParameter:identityProviderType 或 protocol 不支持。404 IdentityProviderNotFound:尚无 CustomSSO 绑定。409 IdentityProviderOperationConflict:用户池未准备好、解绑中或解绑失败。\n\n## 调用关系与使用边界\nSAML 配置顺序:CreateIdentityProvider 初始化 CustomSSO 共享池,等待 GetIdentityProvider 返回 READY;调用本接口取得 SP 信息并配置到外部 IdP;再将外部 IdP Metadata XML 或完整手填配置提交 UpdateIdentityProvider。保存后按需单独启用 loginEnabled。SP 信息查询不会完成外部 IdP 配置或验证登录。
|
|
3693
|
+
*
|
|
3694
|
+
* @param request - GetIdentityProviderServiceProviderRequest
|
|
3695
|
+
* @returns GetIdentityProviderServiceProviderResponse
|
|
3696
|
+
*/
|
|
3697
|
+
async getIdentityProviderServiceProvider(workspaceId: string, identityProviderType: string, request: $_model.GetIdentityProviderServiceProviderRequest): Promise<$_model.GetIdentityProviderServiceProviderResponse> {
|
|
3698
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
3699
|
+
let headers : {[key: string ]: string} = { };
|
|
3700
|
+
return await this.getIdentityProviderServiceProviderWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
3701
|
+
}
|
|
3702
|
+
|
|
3395
3703
|
/**
|
|
3396
3704
|
* Queries an identity provider synchronization task.
|
|
3397
3705
|
*
|
|
@@ -5191,7 +5499,31 @@ export default class Client extends OpenApi {
|
|
|
5191
5499
|
* Queries the departments of an identity provider by page.
|
|
5192
5500
|
*
|
|
5193
5501
|
* @remarks
|
|
5194
|
-
* Queries DingTalk or
|
|
5502
|
+
* Queries DingTalk or Lark departments by hierarchy and page. Prerequisites include an existing identity provider binding, a user pool, valid application credentials, and address book read authorization. If parentDepartmentId is not specified, the root hierarchy is queried. When expanding a node, use the ID of the node to query its direct child departments. The hasChildren field is used to determine expandability and does not indicate that child nodes have been returned. The nextToken field is only used to continue querying the next page under the current parent department. The query only reads the directory, does not save the synchronization scope, and does not import users. After a new department is added to a DingTalk or Lark organization, re-query the corresponding parent department because the old list does not represent the latest directory.
|
|
5503
|
+
* Authorization information: The RAM operation is agentcore:ListIdentityProviderDepartments, the access level is List, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource requires authorization.
|
|
5504
|
+
* Idempotence and retry: This operation is read-only and can be invoked repeatedly.
|
|
5505
|
+
* It is free of charge to invoke this API operation, and operation records support ActionTrail auditing.
|
|
5506
|
+
* Sample response:
|
|
5507
|
+
* ```json
|
|
5508
|
+
* {
|
|
5509
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
5510
|
+
* "message": "success",
|
|
5511
|
+
* "httpStatusCode": 200,
|
|
5512
|
+
* "code": "SUCCESS",
|
|
5513
|
+
* "success": true,
|
|
5514
|
+
* "maxResults": 50,
|
|
5515
|
+
* "nextToken": "",
|
|
5516
|
+
* "items": [
|
|
5517
|
+
* {
|
|
5518
|
+
* "id": "10001",
|
|
5519
|
+
* "name": "R&D Department",
|
|
5520
|
+
* "parentId": "1",
|
|
5521
|
+
* "memberCount": 12,
|
|
5522
|
+
* "hasChildren": true
|
|
5523
|
+
* }
|
|
5524
|
+
* ]
|
|
5525
|
+
* }
|
|
5526
|
+
* ```
|
|
5195
5527
|
*
|
|
5196
5528
|
* @param request - ListIdentityProviderDepartmentsRequest
|
|
5197
5529
|
* @param headers - map
|
|
@@ -5235,7 +5567,31 @@ export default class Client extends OpenApi {
|
|
|
5235
5567
|
* Queries the departments of an identity provider by page.
|
|
5236
5568
|
*
|
|
5237
5569
|
* @remarks
|
|
5238
|
-
* Queries DingTalk or
|
|
5570
|
+
* Queries DingTalk or Lark departments by hierarchy and page. Prerequisites include an existing identity provider binding, a user pool, valid application credentials, and address book read authorization. If parentDepartmentId is not specified, the root hierarchy is queried. When expanding a node, use the ID of the node to query its direct child departments. The hasChildren field is used to determine expandability and does not indicate that child nodes have been returned. The nextToken field is only used to continue querying the next page under the current parent department. The query only reads the directory, does not save the synchronization scope, and does not import users. After a new department is added to a DingTalk or Lark organization, re-query the corresponding parent department because the old list does not represent the latest directory.
|
|
5571
|
+
* Authorization information: The RAM operation is agentcore:ListIdentityProviderDepartments, the access level is List, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource requires authorization.
|
|
5572
|
+
* Idempotence and retry: This operation is read-only and can be invoked repeatedly.
|
|
5573
|
+
* It is free of charge to invoke this API operation, and operation records support ActionTrail auditing.
|
|
5574
|
+
* Sample response:
|
|
5575
|
+
* ```json
|
|
5576
|
+
* {
|
|
5577
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
5578
|
+
* "message": "success",
|
|
5579
|
+
* "httpStatusCode": 200,
|
|
5580
|
+
* "code": "SUCCESS",
|
|
5581
|
+
* "success": true,
|
|
5582
|
+
* "maxResults": 50,
|
|
5583
|
+
* "nextToken": "",
|
|
5584
|
+
* "items": [
|
|
5585
|
+
* {
|
|
5586
|
+
* "id": "10001",
|
|
5587
|
+
* "name": "R&D Department",
|
|
5588
|
+
* "parentId": "1",
|
|
5589
|
+
* "memberCount": 12,
|
|
5590
|
+
* "hasChildren": true
|
|
5591
|
+
* }
|
|
5592
|
+
* ]
|
|
5593
|
+
* }
|
|
5594
|
+
* ```
|
|
5239
5595
|
*
|
|
5240
5596
|
* @param request - ListIdentityProviderDepartmentsRequest
|
|
5241
5597
|
* @returns ListIdentityProviderDepartmentsResponse
|
|
@@ -5247,19 +5603,116 @@ export default class Client extends OpenApi {
|
|
|
5247
5603
|
}
|
|
5248
5604
|
|
|
5249
5605
|
/**
|
|
5250
|
-
* Queries the
|
|
5606
|
+
* Queries the complete summary list of up to two SCIM credentials in the shared user pool, without returning plaintext tokens or supporting pagination.
|
|
5607
|
+
*
|
|
5608
|
+
* @remarks
|
|
5609
|
+
* ## Features and prerequisites
|
|
5610
|
+
* Retrieves the current credential summary list from AgentIdentity and returns a data array. Each item contains credentialId, status, createTime, and expireTime. If no credentials exist, an empty array is returned. This operation does not support maxResults, nextToken, or pagination. Do not call this operation with fake pagination fields. The list never returns plaintext tokens, nor does it enable the receiving or issuing of new credentials.
|
|
5611
|
+
* Receiving is not required to be enabled, but the shared pool must be available. A credential is considered available if its status is Enabled and its expireTime is later than the current time. The maximum limit of two credentials is determined by AgentIdentity. Client-side counting is for reference only. The list may contain unavailable or expired credentials. Do not use this list to claim that available tokens exist.
|
|
5612
|
+
* ## Requests and examples
|
|
5613
|
+
* GET /workspaces/{workspaceId}/scim-provisioning/credentials
|
|
5614
|
+
* Call conventions: Call this operation in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity source resources of the workspace. The ws-example, URL, certificate, and token in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business data. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
|
|
5615
|
+
* ```text
|
|
5616
|
+
* GET /workspaces/ws-example/scim-provisioning/credentials
|
|
5617
|
+
* ```
|
|
5618
|
+
* ## Response examples
|
|
5619
|
+
* ```json
|
|
5620
|
+
* {
|
|
5621
|
+
* "data": [
|
|
5622
|
+
* {
|
|
5623
|
+
* "credentialId": "credential-example",
|
|
5624
|
+
* "status": "Enabled",
|
|
5625
|
+
* "createTime": "<Upstream creation time>",
|
|
5626
|
+
* "expireTime": "<Upstream expiration time>"
|
|
5627
|
+
* }
|
|
5628
|
+
* ]
|
|
5629
|
+
* }
|
|
5630
|
+
* ```
|
|
5631
|
+
* ## Errors and handling
|
|
5632
|
+
* Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. Synchronous calls to the upstream service that fail may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling process.
|
|
5633
|
+
* 400 InvalidParameter: The shared user pool is unavailable. 404 IdentityProviderNotFound: No corresponding binding exists. Upstream query failures cannot be replaced with an empty list, which may mislead users into repeatedly creating credentials.
|
|
5634
|
+
* ## Call relationships and usage boundaries
|
|
5635
|
+
* Used for configuration recovery and credential management: Existing plaintext tokens cannot be queried and retrieved again. The list provides only credential summaries. To obtain a new token, call CreateIdentityProviderSCIMCredential. To revoke a credential, submit the credentialId from the list to DeleteIdentityProviderSCIMCredential. A maximum of two credentials are allowed in the same pool. This operation returns the complete array and does not support or fabricate pagination parameters.
|
|
5636
|
+
*
|
|
5637
|
+
* @param request - ListIdentityProviderSCIMCredentialsRequest
|
|
5638
|
+
* @param headers - map
|
|
5639
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
5640
|
+
* @returns ListIdentityProviderSCIMCredentialsResponse
|
|
5641
|
+
*/
|
|
5642
|
+
async listIdentityProviderSCIMCredentialsWithOptions(workspaceId: string, request: $_model.ListIdentityProviderSCIMCredentialsRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.ListIdentityProviderSCIMCredentialsResponse> {
|
|
5643
|
+
request.validate();
|
|
5644
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
5645
|
+
headers: headers,
|
|
5646
|
+
});
|
|
5647
|
+
let params = new $OpenApiUtil.Params({
|
|
5648
|
+
action: "ListIdentityProviderSCIMCredentials",
|
|
5649
|
+
version: "2026-08-04",
|
|
5650
|
+
protocol: "HTTPS",
|
|
5651
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/scim-provisioning/credentials`,
|
|
5652
|
+
method: "GET",
|
|
5653
|
+
authType: "AK",
|
|
5654
|
+
style: "ROA",
|
|
5655
|
+
reqBodyType: "json",
|
|
5656
|
+
bodyType: "json",
|
|
5657
|
+
});
|
|
5658
|
+
return $dara.cast<$_model.ListIdentityProviderSCIMCredentialsResponse>(await this.callApi(params, req, runtime), new $_model.ListIdentityProviderSCIMCredentialsResponse({}));
|
|
5659
|
+
}
|
|
5660
|
+
|
|
5661
|
+
/**
|
|
5662
|
+
* Queries the complete summary list of up to two SCIM credentials in the shared user pool, without returning plaintext tokens or supporting pagination.
|
|
5663
|
+
*
|
|
5664
|
+
* @remarks
|
|
5665
|
+
* ## Features and prerequisites
|
|
5666
|
+
* Retrieves the current credential summary list from AgentIdentity and returns a data array. Each item contains credentialId, status, createTime, and expireTime. If no credentials exist, an empty array is returned. This operation does not support maxResults, nextToken, or pagination. Do not call this operation with fake pagination fields. The list never returns plaintext tokens, nor does it enable the receiving or issuing of new credentials.
|
|
5667
|
+
* Receiving is not required to be enabled, but the shared pool must be available. A credential is considered available if its status is Enabled and its expireTime is later than the current time. The maximum limit of two credentials is determined by AgentIdentity. Client-side counting is for reference only. The list may contain unavailable or expired credentials. Do not use this list to claim that available tokens exist.
|
|
5668
|
+
* ## Requests and examples
|
|
5669
|
+
* GET /workspaces/{workspaceId}/scim-provisioning/credentials
|
|
5670
|
+
* Call conventions: Call this operation in the region of the target workspace by using an AccessKey pair or STS token that has permissions on the identity source resources of the workspace. The ws-example, URL, certificate, and token in the following examples are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business data. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
|
|
5671
|
+
* ```text
|
|
5672
|
+
* GET /workspaces/ws-example/scim-provisioning/credentials
|
|
5673
|
+
* ```
|
|
5674
|
+
* ## Response examples
|
|
5675
|
+
* ```json
|
|
5676
|
+
* {
|
|
5677
|
+
* "data": [
|
|
5678
|
+
* {
|
|
5679
|
+
* "credentialId": "credential-example",
|
|
5680
|
+
* "status": "Enabled",
|
|
5681
|
+
* "createTime": "<Upstream creation time>",
|
|
5682
|
+
* "expireTime": "<Upstream expiration time>"
|
|
5683
|
+
* }
|
|
5684
|
+
* ]
|
|
5685
|
+
* }
|
|
5686
|
+
* ```
|
|
5687
|
+
* ## Errors and handling
|
|
5688
|
+
* Error handling: 400 InvalidParameter indicates that the parameters or current configuration prerequisites are not met. 404 IdentityProviderNotFound indicates that no binding of the matching type exists. Synchronous calls to the upstream service that fail may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling process.
|
|
5689
|
+
* 400 InvalidParameter: The shared user pool is unavailable. 404 IdentityProviderNotFound: No corresponding binding exists. Upstream query failures cannot be replaced with an empty list, which may mislead users into repeatedly creating credentials.
|
|
5690
|
+
* ## Call relationships and usage boundaries
|
|
5691
|
+
* Used for configuration recovery and credential management: Existing plaintext tokens cannot be queried and retrieved again. The list provides only credential summaries. To obtain a new token, call CreateIdentityProviderSCIMCredential. To revoke a credential, submit the credentialId from the list to DeleteIdentityProviderSCIMCredential. A maximum of two credentials are allowed in the same pool. This operation returns the complete array and does not support or fabricate pagination parameters.
|
|
5692
|
+
*
|
|
5693
|
+
* @param request - ListIdentityProviderSCIMCredentialsRequest
|
|
5694
|
+
* @returns ListIdentityProviderSCIMCredentialsResponse
|
|
5695
|
+
*/
|
|
5696
|
+
async listIdentityProviderSCIMCredentials(workspaceId: string, request: $_model.ListIdentityProviderSCIMCredentialsRequest): Promise<$_model.ListIdentityProviderSCIMCredentialsResponse> {
|
|
5697
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
5698
|
+
let headers : {[key: string ]: string} = { };
|
|
5699
|
+
return await this.listIdentityProviderSCIMCredentialsWithOptions(workspaceId, request, headers, runtime);
|
|
5700
|
+
}
|
|
5701
|
+
|
|
5702
|
+
/**
|
|
5703
|
+
* Queries the summary of existing identity provider bindings for a workspace, including CustomSSO. Returns local binding information without querying the actual upstream SAML or SCIM configurations.
|
|
5251
5704
|
*
|
|
5252
5705
|
* @remarks
|
|
5253
5706
|
* ## Features and prerequisites
|
|
5254
|
-
* Returns the local binding summary without querying the actual SAML
|
|
5255
|
-
* The status of CustomSSO indicates the task status of shared resources and logon configurations. You must
|
|
5707
|
+
* Returns the local binding summary without querying the actual SAML and SCIM configurations of AgentIdentity. If no bindings exist, items is an empty array. A workspace currently supports only one external binding. The default value of maxResults is 10, and the valid values are 1 to 100. Currently, nextToken must be omitted or left empty. A non-empty value returns InvalidParameter, and multi-page results cannot be fabricated.
|
|
5708
|
+
* The status of CustomSSO indicates the task status of shared resources and logon configurations. You must combine protocol and saml to determine whether SAML is configured. SCIM queries are independently performed by using GetIdentityProviderSCIM. The list does not issue tokens and does not return the vendor appSecret, encryptKey, or verificationToken.
|
|
5256
5709
|
* ## Requests and examples
|
|
5257
5710
|
* GET /workspaces/{workspaceId}/identity-providers
|
|
5258
|
-
* Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or
|
|
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. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request example shows the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
5259
5712
|
* ```text
|
|
5260
5713
|
* GET /workspaces/ws-example/identity-providers?maxResults=10
|
|
5261
5714
|
* ```
|
|
5262
|
-
* ## Response
|
|
5715
|
+
* ## Response example
|
|
5263
5716
|
* ```json
|
|
5264
5717
|
* {
|
|
5265
5718
|
* "items": [
|
|
@@ -5276,8 +5729,10 @@ export default class Client extends OpenApi {
|
|
|
5276
5729
|
* }
|
|
5277
5730
|
* ```
|
|
5278
5731
|
* ## Errors and handling
|
|
5279
|
-
* 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.
|
|
5280
|
-
* 400 InvalidParameter: maxResults is out of bounds
|
|
5732
|
+
* 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 instead of being cleared as unconfigured.
|
|
5734
|
+
* ## Call relationships and usage boundaries
|
|
5735
|
+
* This API is used to discover current bindings. The specific SAML configuration of CustomSSO is queried by using GetIdentityProvider. The SP address is queried by using GetIdentityProviderServiceProvider. The actual SCIM configuration and independent operation results are queried by using GetIdentityProviderSCIM.
|
|
5281
5736
|
*
|
|
5282
5737
|
* @param request - ListIdentityProvidersRequest
|
|
5283
5738
|
* @param headers - map
|
|
@@ -5314,19 +5769,19 @@ export default class Client extends OpenApi {
|
|
|
5314
5769
|
}
|
|
5315
5770
|
|
|
5316
5771
|
/**
|
|
5317
|
-
* Queries the
|
|
5772
|
+
* Queries the summary of existing identity provider bindings for a workspace, including CustomSSO. Returns local binding information without querying the actual upstream SAML or SCIM configurations.
|
|
5318
5773
|
*
|
|
5319
5774
|
* @remarks
|
|
5320
5775
|
* ## Features and prerequisites
|
|
5321
|
-
* Returns the local binding summary without querying the actual SAML
|
|
5322
|
-
* The status of CustomSSO indicates the task status of shared resources and logon configurations. You must
|
|
5776
|
+
* Returns the local binding summary without querying the actual SAML and SCIM configurations of AgentIdentity. If no bindings exist, items is an empty array. A workspace currently supports only one external binding. The default value of maxResults is 10, and the valid values are 1 to 100. Currently, nextToken must be omitted or left empty. A non-empty value returns InvalidParameter, and multi-page results cannot be fabricated.
|
|
5777
|
+
* The status of CustomSSO indicates the task status of shared resources and logon configurations. You must combine protocol and saml to determine whether SAML is configured. SCIM queries are independently performed by using GetIdentityProviderSCIM. The list does not issue tokens and does not return the vendor appSecret, encryptKey, or verificationToken.
|
|
5323
5778
|
* ## Requests and examples
|
|
5324
5779
|
* GET /workspaces/{workspaceId}/identity-providers
|
|
5325
|
-
* Call conventions: Call the API in the region of the target workspace by using an AccessKey pair or
|
|
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. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request example shows the body parameters of the public API, not the extra body wrapper of the backend direct connection API. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
5326
5781
|
* ```text
|
|
5327
5782
|
* GET /workspaces/ws-example/identity-providers?maxResults=10
|
|
5328
5783
|
* ```
|
|
5329
|
-
* ## Response
|
|
5784
|
+
* ## Response example
|
|
5330
5785
|
* ```json
|
|
5331
5786
|
* {
|
|
5332
5787
|
* "items": [
|
|
@@ -5343,8 +5798,10 @@ export default class Client extends OpenApi {
|
|
|
5343
5798
|
* }
|
|
5344
5799
|
* ```
|
|
5345
5800
|
* ## Errors and handling
|
|
5346
|
-
* 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.
|
|
5347
|
-
* 400 InvalidParameter: maxResults is out of bounds
|
|
5801
|
+
* 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 instead of being cleared as unconfigured.
|
|
5803
|
+
* ## Call relationships and usage boundaries
|
|
5804
|
+
* This API is used to discover current bindings. The specific SAML configuration of CustomSSO is queried by using GetIdentityProvider. The SP address is queried by using GetIdentityProviderServiceProvider. The actual SCIM configuration and independent operation results are queried by using GetIdentityProviderSCIM.
|
|
5348
5805
|
*
|
|
5349
5806
|
* @param request - ListIdentityProvidersRequest
|
|
5350
5807
|
* @returns ListIdentityProvidersResponse
|
|
@@ -6857,6 +7314,113 @@ export default class Client extends OpenApi {
|
|
|
6857
7314
|
return await this.precheckSkillUploadViaOssWithOptions(workspaceId, request, headers, runtime);
|
|
6858
7315
|
}
|
|
6859
7316
|
|
|
7317
|
+
/**
|
|
7318
|
+
* Prepares the SCIM receiving configuration, and returns the provisioning URL and credential summary. Issues a token if no available credentials exist and returns the plaintext only in the current response. Does not automatically enable user synchronization.
|
|
7319
|
+
*
|
|
7320
|
+
* @remarks
|
|
7321
|
+
* ## Features and prerequisites
|
|
7322
|
+
* A CustomSSO shared user pool must be available. This operation does not depend on SAML metadata and is not blocked by SAML updating or update failure states. It synchronously calls AgentIdentity to enable SCIM receiving, and reads the configuration and credential list. If a credential in the Enabled state that has not expired already exists, its summary is returned and the token is set to null. If no available credentials exist, a new credential is created and the token is returned only in the current response. Existing invalid or expired credentials are not automatically deleted and may still trigger the upstream limit of up to two credentials.
|
|
7323
|
+
* The prepare operation has the side effects of enabling receiving and potentially issuing credentials, but it does not set the AC syncEnabled parameter, initiate the first import, or indicate that the external provisioning connection test has passed. After configuring the baseUrl and the current token in the external provisioning system, call UpdateIdentityProviderSCIM to confirm and enable synchronization. Existing tokens cannot be retrieved again. If the response is lost, query the credential list first. Tokens are not automatically reissued. Tokens must not be logged or persisted in frontend caches.
|
|
7324
|
+
* ## Requests and examples
|
|
7325
|
+
* POST /workspaces/{workspaceId}/scim-provisioning/prepare
|
|
7326
|
+
* Calling conventions: Call this operation in the region of the target workspace by using an AccessKey ID/STS identity that has permissions on the identity source resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not log secrets. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
|
|
7327
|
+
* ```text
|
|
7328
|
+
* POST /workspaces/ws-example/scim-provisioning/prepare
|
|
7329
|
+
* No business request body.
|
|
7330
|
+
* ```
|
|
7331
|
+
* ## Response examples
|
|
7332
|
+
* ```json
|
|
7333
|
+
* {
|
|
7334
|
+
* "data": {
|
|
7335
|
+
* "configuration": {
|
|
7336
|
+
* "status": "Enabled",
|
|
7337
|
+
* "baseUrl": "https://example.com/scim/v2"
|
|
7338
|
+
* },
|
|
7339
|
+
* "credential": {
|
|
7340
|
+
* "credentialId": "credential-example",
|
|
7341
|
+
* "status": "Enabled",
|
|
7342
|
+
* "expireTime": "<Expiration time returned by the upstream service>"
|
|
7343
|
+
* },
|
|
7344
|
+
* "token": "<Token issued only in the current response; null if an available credential already exists>"
|
|
7345
|
+
* }
|
|
7346
|
+
* }
|
|
7347
|
+
* ```
|
|
7348
|
+
* ## 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 service that fail may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace not found errors follow the common error handling process.
|
|
7350
|
+
* 400 LimitExceeded.ScimCredential: The maximum limit of two credentials has been reached. You must explicitly delete one credential and try again. Credentials are not automatically deleted, rotated, or expanded. 400 InvalidParameter: The shared pool is unavailable. This call may have enabled upstream receiving and then reported an error due to issuance failure. The error does not mean that the operation has been automatically rolled back.
|
|
7351
|
+
* ## 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 that the user has already saved. Do not configure a null value in the external system. If the token is lost, call ListIdentityProviderSCIMCredentials to check first, and then explicitly call CreateIdentityProviderSCIMCredential to issue a new token. When the limit of two credentials is reached, the user must confirm and delete the unused credential.
|
|
7353
|
+
*
|
|
7354
|
+
* @param request - PrepareIdentityProviderSCIMRequest
|
|
7355
|
+
* @param headers - map
|
|
7356
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
7357
|
+
* @returns PrepareIdentityProviderSCIMResponse
|
|
7358
|
+
*/
|
|
7359
|
+
async prepareIdentityProviderSCIMWithOptions(workspaceId: string, request: $_model.PrepareIdentityProviderSCIMRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.PrepareIdentityProviderSCIMResponse> {
|
|
7360
|
+
request.validate();
|
|
7361
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
7362
|
+
headers: headers,
|
|
7363
|
+
});
|
|
7364
|
+
let params = new $OpenApiUtil.Params({
|
|
7365
|
+
action: "PrepareIdentityProviderSCIM",
|
|
7366
|
+
version: "2026-08-04",
|
|
7367
|
+
protocol: "HTTPS",
|
|
7368
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/scim-provisioning/prepare`,
|
|
7369
|
+
method: "POST",
|
|
7370
|
+
authType: "AK",
|
|
7371
|
+
style: "ROA",
|
|
7372
|
+
reqBodyType: "json",
|
|
7373
|
+
bodyType: "json",
|
|
7374
|
+
});
|
|
7375
|
+
return $dara.cast<$_model.PrepareIdentityProviderSCIMResponse>(await this.callApi(params, req, runtime), new $_model.PrepareIdentityProviderSCIMResponse({}));
|
|
7376
|
+
}
|
|
7377
|
+
|
|
7378
|
+
/**
|
|
7379
|
+
* Prepares the SCIM receiving configuration, and returns the provisioning URL and credential summary. Issues a token if no available credentials exist and returns the plaintext only in the current response. Does not automatically enable user synchronization.
|
|
7380
|
+
*
|
|
7381
|
+
* @remarks
|
|
7382
|
+
* ## Features and prerequisites
|
|
7383
|
+
* A CustomSSO shared user pool must be available. This operation does not depend on SAML metadata and is not blocked by SAML updating or update failure states. It synchronously calls AgentIdentity to enable SCIM receiving, and reads the configuration and credential list. If a credential in the Enabled state that has not expired already exists, its summary is returned and the token is set to null. If no available credentials exist, a new credential is created and the token is returned only in the current response. Existing invalid or expired credentials are not automatically deleted and may still trigger the upstream limit of up to two credentials.
|
|
7384
|
+
* The prepare operation has the side effects of enabling receiving and potentially issuing credentials, but it does not set the AC syncEnabled parameter, initiate the first import, or indicate that the external provisioning connection test has passed. After configuring the baseUrl and the current token in the external provisioning system, call UpdateIdentityProviderSCIM to confirm and enable synchronization. Existing tokens cannot be retrieved again. If the response is lost, query the credential list first. Tokens are not automatically reissued. Tokens must not be logged or persisted in frontend caches.
|
|
7385
|
+
* ## Requests and examples
|
|
7386
|
+
* POST /workspaces/{workspaceId}/scim-provisioning/prepare
|
|
7387
|
+
* Calling conventions: Call this operation in the region of the target workspace by using an AccessKey ID/STS identity that has permissions on the identity source resources of the workspace. In the following examples, ws-example, URLs, certificates, and tokens are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API operation, not the extra body wrapper of the backend direct connection API operation. The response example shows only the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not log secrets. Asynchronous business tasks do not mean that the HTTP request uses a persistent connection to wait for completion.
|
|
7388
|
+
* ```text
|
|
7389
|
+
* POST /workspaces/ws-example/scim-provisioning/prepare
|
|
7390
|
+
* No business request body.
|
|
7391
|
+
* ```
|
|
7392
|
+
* ## Response examples
|
|
7393
|
+
* ```json
|
|
7394
|
+
* {
|
|
7395
|
+
* "data": {
|
|
7396
|
+
* "configuration": {
|
|
7397
|
+
* "status": "Enabled",
|
|
7398
|
+
* "baseUrl": "https://example.com/scim/v2"
|
|
7399
|
+
* },
|
|
7400
|
+
* "credential": {
|
|
7401
|
+
* "credentialId": "credential-example",
|
|
7402
|
+
* "status": "Enabled",
|
|
7403
|
+
* "expireTime": "<Expiration time returned by the upstream service>"
|
|
7404
|
+
* },
|
|
7405
|
+
* "token": "<Token issued only in the current response; null if an available credential already exists>"
|
|
7406
|
+
* }
|
|
7407
|
+
* }
|
|
7408
|
+
* ```
|
|
7409
|
+
* ## 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 service that fail may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret read failures as unconfigured. Actual authentication and workspace not found errors follow the common error handling process.
|
|
7411
|
+
* 400 LimitExceeded.ScimCredential: The maximum limit of two credentials has been reached. You must explicitly delete one credential and try again. Credentials are not automatically deleted, rotated, or expanded. 400 InvalidParameter: The shared pool is unavailable. This call may have enabled upstream receiving and then reported an error due to issuance failure. The error does not mean that the operation has been automatically rolled back.
|
|
7412
|
+
* ## 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 that the user has already saved. Do not configure a null value in the external system. If the token is lost, call ListIdentityProviderSCIMCredentials to check first, and then explicitly call CreateIdentityProviderSCIMCredential to issue a new token. When the limit of two credentials is reached, the user must confirm and delete the unused credential.
|
|
7414
|
+
*
|
|
7415
|
+
* @param request - PrepareIdentityProviderSCIMRequest
|
|
7416
|
+
* @returns PrepareIdentityProviderSCIMResponse
|
|
7417
|
+
*/
|
|
7418
|
+
async prepareIdentityProviderSCIM(workspaceId: string, request: $_model.PrepareIdentityProviderSCIMRequest): Promise<$_model.PrepareIdentityProviderSCIMResponse> {
|
|
7419
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
7420
|
+
let headers : {[key: string ]: string} = { };
|
|
7421
|
+
return await this.prepareIdentityProviderSCIMWithOptions(workspaceId, request, headers, runtime);
|
|
7422
|
+
}
|
|
7423
|
+
|
|
6860
7424
|
/**
|
|
6861
7425
|
* Publishes a specified Skill version to transition it to the published state.
|
|
6862
7426
|
*
|
|
@@ -7716,32 +8280,99 @@ export default class Client extends OpenApi {
|
|
|
7716
8280
|
}
|
|
7717
8281
|
|
|
7718
8282
|
/**
|
|
7719
|
-
*
|
|
8283
|
+
* Modifies the logon configuration of a bound identity provider in a specified workspace. DingTalk and Lark support logon switches, incremental synchronization switches, application configurations, and synchronization scopes. CustomSSO supports SAML configurations and logon switches. Actual updates take effect asynchronously. Call GetIdentityProvider to query the status.
|
|
8284
|
+
*
|
|
8285
|
+
* @remarks
|
|
8286
|
+
* ### Prerequisites and update methods
|
|
8287
|
+
* The workspace must be bound to an identity provider of the corresponding type. For DingTalk and Lark, you must submit at least one of loginEnabled, syncEnabled, metadata, and syncScope. protocol and saml are not accepted. For CustomSSO, use protocol, saml, and loginEnabled. metadata, syncEnabled, and syncScope are not accepted. The SCIM synchronization switch is managed separately through UpdateIdentityProviderSCIM.
|
|
8288
|
+
* ### DingTalk and Lark
|
|
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 will be rejected. The server validates the complete configuration after merging. When incremental synchronization is enabled, the merged configuration must include encryptKey and verificationToken.
|
|
8290
|
+
* syncEnabled controls subsequent address book change events and does not control the initial synchronization or manual synchronization. syncScope applies only to DingTalk and Lark. If it is omitted or set to null, the current scope is retained. Saving the scope does not automatically trigger a full synchronization. To perform manual synchronization, call CreateIdentityProviderSyncJob after saving and waiting for the identity provider to be ready, and then call GetIdentityProviderSyncJob to query the task result.
|
|
8291
|
+
* ### Custom SAML identity provider
|
|
8292
|
+
* CustomSSO currently supports only SAML. The saml parameter supports two mutually exclusive methods: providing metadataXml, or providing the four manual configuration fields: entityId, loginUrl, bindingType, and x509Certificates.
|
|
8293
|
+
* metadataXml is a single IdP EntityDescriptor XML text of up to 1 MiB, not a URL or file path. DTDs and external entities are prohibited. For manual configuration, entityId must be non-empty and up to 2,048 characters, and cannot be changed after saving. loginUrl must be an absolute HTTPS URL without user credentials and fragments. bindingType must be HTTP-Redirect or HTTP-POST. Certificates must be valid X.509 signing certificates, with a maximum of 10 certificates.
|
|
8294
|
+
* jitProvisionEnabled controls the automatic creation of users during the initial logon, and jitUpdateEnabled controls whether user information is updated during logon. Omitting these switches during an update retains the existing values. Modifying only the JIT switches also requires an existing valid SAML configuration. Saving the SAML configuration does not automatically enable logon. A valid configuration must exist before enabling logon. Setting loginEnabled to false only triggers a shutdown of logon and does not delete the saved SAML or SCIM configurations.
|
|
8295
|
+
* ### 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 configurations are restored. Call GetIdentityProvider to wait for the READY status. If the operation fails, check for statuses such as UPDATE_FAILED. If the configuration is identical and no restoration is required, the current binding may be returned directly without generating a new task. A successful HTTP request does not indicate that the background task or upstream configuration has taken effect.
|
|
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 parameter describes the status of the identity provider resource and logon configuration. The SCIM operation results for CustomSSO must be queried through GetIdentityProviderSCIM and cannot be inferred from this operation.
|
|
8298
|
+
*
|
|
8299
|
+
* @param tmpReq - UpdateIdentityProviderRequest
|
|
8300
|
+
* @param headers - map
|
|
8301
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
8302
|
+
* @returns UpdateIdentityProviderResponse
|
|
8303
|
+
*/
|
|
8304
|
+
async updateIdentityProviderWithOptions(workspaceId: string, identityProviderType: string, tmpReq: $_model.UpdateIdentityProviderRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateIdentityProviderResponse> {
|
|
8305
|
+
tmpReq.validate();
|
|
8306
|
+
let request = new $_model.UpdateIdentityProviderShrinkRequest({ });
|
|
8307
|
+
OpenApiUtil.convert(tmpReq, request);
|
|
8308
|
+
if (!$dara.isNull(tmpReq.body)) {
|
|
8309
|
+
request.bodyShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.body, "body", "json");
|
|
8310
|
+
}
|
|
8311
|
+
|
|
8312
|
+
let body : {[key: string ]: any} = { };
|
|
8313
|
+
if (!$dara.isNull(request.bodyShrink)) {
|
|
8314
|
+
body["body"] = request.bodyShrink;
|
|
8315
|
+
}
|
|
8316
|
+
|
|
8317
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
8318
|
+
headers: headers,
|
|
8319
|
+
body: OpenApiUtil.parseToMap(body),
|
|
8320
|
+
});
|
|
8321
|
+
let params = new $OpenApiUtil.Params({
|
|
8322
|
+
action: "UpdateIdentityProvider",
|
|
8323
|
+
version: "2026-08-04",
|
|
8324
|
+
protocol: "HTTPS",
|
|
8325
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/identity-providers/${$dara.URL.percentEncode(identityProviderType)}`,
|
|
8326
|
+
method: "PUT",
|
|
8327
|
+
authType: "AK",
|
|
8328
|
+
style: "ROA",
|
|
8329
|
+
reqBodyType: "formData",
|
|
8330
|
+
bodyType: "json",
|
|
8331
|
+
});
|
|
8332
|
+
return $dara.cast<$_model.UpdateIdentityProviderResponse>(await this.callApi(params, req, runtime), new $_model.UpdateIdentityProviderResponse({}));
|
|
8333
|
+
}
|
|
8334
|
+
|
|
8335
|
+
/**
|
|
8336
|
+
* Modifies the logon configuration of a bound identity provider in a specified workspace. DingTalk and Lark support logon switches, incremental synchronization switches, application configurations, and synchronization scopes. CustomSSO supports SAML configurations and logon switches. Actual updates take effect asynchronously. Call GetIdentityProvider to query the status.
|
|
8337
|
+
*
|
|
8338
|
+
* @remarks
|
|
8339
|
+
* ### Prerequisites and update methods
|
|
8340
|
+
* The workspace must be bound to an identity provider of the corresponding type. For DingTalk and Lark, you must submit at least one of loginEnabled, syncEnabled, metadata, and syncScope. protocol and saml are not accepted. For CustomSSO, use protocol, saml, and loginEnabled. metadata, syncEnabled, and syncScope are not accepted. The SCIM synchronization switch is managed separately through UpdateIdentityProviderSCIM.
|
|
8341
|
+
* ### DingTalk and Lark
|
|
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 will be rejected. The server validates the complete configuration after merging. When incremental synchronization is enabled, the merged configuration must include encryptKey and verificationToken.
|
|
8343
|
+
* syncEnabled controls subsequent address book change events and does not control the initial synchronization or manual synchronization. syncScope applies only to DingTalk and Lark. If it is omitted or set to null, the current scope is retained. Saving the scope does not automatically trigger a full synchronization. To perform manual synchronization, call CreateIdentityProviderSyncJob after saving and waiting for the identity provider to be ready, and then call GetIdentityProviderSyncJob to query the task result.
|
|
8344
|
+
* ### Custom SAML identity provider
|
|
8345
|
+
* CustomSSO currently supports only SAML. The saml parameter supports two mutually exclusive methods: providing metadataXml, or providing the four manual configuration fields: entityId, loginUrl, bindingType, and x509Certificates.
|
|
8346
|
+
* metadataXml is a single IdP EntityDescriptor XML text of up to 1 MiB, not a URL or file path. DTDs and external entities are prohibited. For manual configuration, entityId must be non-empty and up to 2,048 characters, and cannot be changed after saving. loginUrl must be an absolute HTTPS URL without user credentials and fragments. bindingType must be HTTP-Redirect or HTTP-POST. Certificates must be valid X.509 signing certificates, with a maximum of 10 certificates.
|
|
8347
|
+
* jitProvisionEnabled controls the automatic creation of users during the initial logon, and jitUpdateEnabled controls whether user information is updated during logon. Omitting these switches during an update retains the existing values. Modifying only the JIT switches also requires an existing valid SAML configuration. Saving the SAML configuration does not automatically enable logon. A valid configuration must exist before enabling logon. Setting loginEnabled to false only triggers a shutdown of logon and does not delete the saved SAML or SCIM configurations.
|
|
8348
|
+
* ### 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 configurations are restored. Call GetIdentityProvider to wait for the READY status. If the operation fails, check for statuses such as UPDATE_FAILED. If the configuration is identical and no restoration is required, the current binding may be returned directly without generating a new task. A successful HTTP request does not indicate that the background task or upstream configuration has taken effect.
|
|
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 parameter describes the status of the identity provider resource and logon configuration. The SCIM operation results for CustomSSO must be queried through GetIdentityProviderSCIM and cannot be inferred from this operation.
|
|
8351
|
+
*
|
|
8352
|
+
* @param request - UpdateIdentityProviderRequest
|
|
8353
|
+
* @returns UpdateIdentityProviderResponse
|
|
8354
|
+
*/
|
|
8355
|
+
async updateIdentityProvider(workspaceId: string, identityProviderType: string, request: $_model.UpdateIdentityProviderRequest): Promise<$_model.UpdateIdentityProviderResponse> {
|
|
8356
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
8357
|
+
let headers : {[key: string ]: string} = { };
|
|
8358
|
+
return await this.updateIdentityProviderWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
8359
|
+
}
|
|
8360
|
+
|
|
8361
|
+
/**
|
|
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.
|
|
7720
8363
|
*
|
|
7721
8364
|
* @remarks
|
|
7722
8365
|
* ## Features and prerequisites
|
|
7723
|
-
*
|
|
7724
|
-
*
|
|
7725
|
-
*
|
|
7726
|
-
* ##
|
|
7727
|
-
* PUT /workspaces/{workspaceId}/
|
|
7728
|
-
* Call conventions: Call the API in the region of the target workspace by using an
|
|
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 enabled and unexpired credential must exist. Therefore, you must first call the prepare operation and complete the URL and token configuration in the external system. If you set this parameter to false, a task is submitted to disable synchronization and upstream receiving. Existing users, credentials, and SAML logon configurations are retained. If you re-enable synchronization later and receiving is disabled, you must call the prepare operation again.
|
|
8367
|
+
* Request acceptance only saves the expected switch status in AC and submits the task. The returned data is still the shared binding and does not contain the SCIM taskId. The status is not overwritten by this task and may be READY or UPDATE_FAILED from a previous logon task. Neither can be used to determine the success or failure of SCIM. Query GetIdentityProviderSCIM.operationStatus to wait for the result. Prerequisite checks for enabling are executed within the task. If the prerequisites are not met, you may receive a successful request response first, and then operationStatus=FAILED. A failure does not automatically roll back the expected switch status.
|
|
8368
|
+
* SCIM does not depend on SAML configuration and does not affect the SAML status or switch. A successful task and a successful full import of empty users do not prove that continuous incremental synchronization is healthy. Whether users exist depends on whether the external system has actually pre-provisioned them.
|
|
8369
|
+
* ## Requests and examples
|
|
8370
|
+
* PUT /workspaces/{workspaceId}/scim-provisioning
|
|
8371
|
+
* Call conventions: Call the API in the region of the target workspace by using an AK/STS identity that has permissions on the identity provider resources of the corresponding workspace. In the following examples, ws-example, URL, certificate, and Token are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API, not the additional body wrapper of the backend direct connection API. The response example only shows the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
7729
8372
|
* ```text
|
|
7730
|
-
* PUT /workspaces/ws-example/
|
|
7731
|
-
* {
|
|
7732
|
-
*
|
|
7733
|
-
* "saml": {
|
|
7734
|
-
* "entityId": "https://idp.example.com/entity",
|
|
7735
|
-
* "loginUrl": "https://idp.example.com/sso",
|
|
7736
|
-
* "bindingType": "HTTP-Redirect",
|
|
7737
|
-
* "x509Certificates": [
|
|
7738
|
-
* "<Valid PEM X.509 certificate text>"
|
|
7739
|
-
* ],
|
|
7740
|
-
* "jitProvisionEnabled": false,
|
|
7741
|
-
* "jitUpdateEnabled": false
|
|
7742
|
-
* }
|
|
7743
|
-
* }
|
|
7744
|
-
* Toggle logon only: {"loginEnabled": true}
|
|
8373
|
+
* PUT /workspaces/ws-example/scim-provisioning
|
|
8374
|
+
* {"syncEnabled": true}
|
|
8375
|
+
* To disable: {"syncEnabled": false}
|
|
7745
8376
|
* ```
|
|
7746
8377
|
* ## Response example
|
|
7747
8378
|
* ```json
|
|
@@ -7749,25 +8380,26 @@ export default class Client extends OpenApi {
|
|
|
7749
8380
|
* "data": {
|
|
7750
8381
|
* "workspaceId": "ws-example",
|
|
7751
8382
|
* "identityProviderType": "CustomSSO",
|
|
7752
|
-
* "
|
|
8383
|
+
* "status": "READY",
|
|
7753
8384
|
* "loginEnabled": false,
|
|
7754
|
-
* "syncEnabled":
|
|
7755
|
-
* "status": "UPDATING"
|
|
8385
|
+
* "syncEnabled": true
|
|
7756
8386
|
* }
|
|
7757
8387
|
* }
|
|
7758
8388
|
* ```
|
|
7759
8389
|
* ## Errors and handling
|
|
7760
|
-
* 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.
|
|
7761
|
-
* 400 InvalidParameter:
|
|
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 that fails may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
|
|
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. Upstream not being enabled or having no valid credentials may manifest as an asynchronous FAILED after acceptance. You cannot only handle HTTP errors.
|
|
8392
|
+
* ## Call relationships and usage boundaries
|
|
8393
|
+
* The call example for enabling is body={"syncEnabled":true}, and for disabling is body={"syncEnabled":false}. This API returns a snapshot of the shared binding, and its status is not the status of this SCIM task. After acceptance, use GetIdentityProviderSCIM to query operationStatus. Pre-provisioning tests or user assignments for external IdPs must still be completed in the external system. AC does not configure external IdPs for users.
|
|
7762
8394
|
*
|
|
7763
|
-
* @param tmpReq -
|
|
8395
|
+
* @param tmpReq - UpdateIdentityProviderSCIMRequest
|
|
7764
8396
|
* @param headers - map
|
|
7765
8397
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
7766
|
-
* @returns
|
|
8398
|
+
* @returns UpdateIdentityProviderSCIMResponse
|
|
7767
8399
|
*/
|
|
7768
|
-
async
|
|
8400
|
+
async updateIdentityProviderSCIMWithOptions(workspaceId: string, tmpReq: $_model.UpdateIdentityProviderSCIMRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateIdentityProviderSCIMResponse> {
|
|
7769
8401
|
tmpReq.validate();
|
|
7770
|
-
let request = new $_model.
|
|
8402
|
+
let request = new $_model.UpdateIdentityProviderSCIMShrinkRequest({ });
|
|
7771
8403
|
OpenApiUtil.convert(tmpReq, request);
|
|
7772
8404
|
if (!$dara.isNull(tmpReq.body)) {
|
|
7773
8405
|
request.bodyShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.body, "body", "json");
|
|
@@ -7783,46 +8415,34 @@ export default class Client extends OpenApi {
|
|
|
7783
8415
|
body: OpenApiUtil.parseToMap(body),
|
|
7784
8416
|
});
|
|
7785
8417
|
let params = new $OpenApiUtil.Params({
|
|
7786
|
-
action: "
|
|
8418
|
+
action: "UpdateIdentityProviderSCIM",
|
|
7787
8419
|
version: "2026-08-04",
|
|
7788
8420
|
protocol: "HTTPS",
|
|
7789
|
-
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/
|
|
8421
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/scim-provisioning`,
|
|
7790
8422
|
method: "PUT",
|
|
7791
8423
|
authType: "AK",
|
|
7792
8424
|
style: "ROA",
|
|
7793
8425
|
reqBodyType: "formData",
|
|
7794
8426
|
bodyType: "json",
|
|
7795
8427
|
});
|
|
7796
|
-
return $dara.cast<$_model.
|
|
8428
|
+
return $dara.cast<$_model.UpdateIdentityProviderSCIMResponse>(await this.callApi(params, req, runtime), new $_model.UpdateIdentityProviderSCIMResponse({}));
|
|
7797
8429
|
}
|
|
7798
8430
|
|
|
7799
8431
|
/**
|
|
7800
|
-
*
|
|
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.
|
|
7801
8433
|
*
|
|
7802
8434
|
* @remarks
|
|
7803
8435
|
* ## Features and prerequisites
|
|
7804
|
-
*
|
|
7805
|
-
*
|
|
7806
|
-
*
|
|
7807
|
-
* ##
|
|
7808
|
-
* PUT /workspaces/{workspaceId}/
|
|
7809
|
-
* Call conventions: Call the API in the region of the target workspace by using an
|
|
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 enabled and unexpired credential must exist. Therefore, you must first call the prepare operation and complete the URL and token configuration in the external system. If you set this parameter to false, a task is submitted to disable synchronization and upstream receiving. Existing users, credentials, and SAML logon configurations are retained. If you re-enable synchronization later and receiving is disabled, you must call the prepare operation again.
|
|
8437
|
+
* Request acceptance only saves the expected switch status in AC and submits the task. The returned data is still the shared binding and does not contain the SCIM taskId. The status is not overwritten by this task and may be READY or UPDATE_FAILED from a previous logon task. Neither can be used to determine the success or failure of SCIM. Query GetIdentityProviderSCIM.operationStatus to wait for the result. Prerequisite checks for enabling are executed within the task. If the prerequisites are not met, you may receive a successful request response first, and then operationStatus=FAILED. A failure does not automatically roll back the expected switch status.
|
|
8438
|
+
* SCIM does not depend on SAML configuration and does not affect the SAML status or switch. A successful task and a successful full import of empty users do not prove that continuous incremental synchronization is healthy. Whether users exist depends on whether the external system has actually pre-provisioned them.
|
|
8439
|
+
* ## Requests and examples
|
|
8440
|
+
* PUT /workspaces/{workspaceId}/scim-provisioning
|
|
8441
|
+
* Call conventions: Call the API in the region of the target workspace by using an AK/STS identity that has permissions on the identity provider resources of the corresponding workspace. In the following examples, ws-example, URL, certificate, and Token are placeholder values and must be replaced with actual values. The request body example represents the body parameters of the public API, not the additional body wrapper of the backend direct connection API. The response example only shows the business part. The outer layer also includes requestId, success, code, message, and httpStatusCode. Retain the requestId for troubleshooting and do not record keys. Asynchronous business tasks do not mean that the HTTP request uses a long connection to wait for completion.
|
|
7810
8442
|
* ```text
|
|
7811
|
-
* PUT /workspaces/ws-example/
|
|
7812
|
-
* {
|
|
7813
|
-
*
|
|
7814
|
-
* "saml": {
|
|
7815
|
-
* "entityId": "https://idp.example.com/entity",
|
|
7816
|
-
* "loginUrl": "https://idp.example.com/sso",
|
|
7817
|
-
* "bindingType": "HTTP-Redirect",
|
|
7818
|
-
* "x509Certificates": [
|
|
7819
|
-
* "<Valid PEM X.509 certificate text>"
|
|
7820
|
-
* ],
|
|
7821
|
-
* "jitProvisionEnabled": false,
|
|
7822
|
-
* "jitUpdateEnabled": false
|
|
7823
|
-
* }
|
|
7824
|
-
* }
|
|
7825
|
-
* Toggle logon only: {"loginEnabled": true}
|
|
8443
|
+
* PUT /workspaces/ws-example/scim-provisioning
|
|
8444
|
+
* {"syncEnabled": true}
|
|
8445
|
+
* To disable: {"syncEnabled": false}
|
|
7826
8446
|
* ```
|
|
7827
8447
|
* ## Response example
|
|
7828
8448
|
* ```json
|
|
@@ -7830,24 +8450,25 @@ export default class Client extends OpenApi {
|
|
|
7830
8450
|
* "data": {
|
|
7831
8451
|
* "workspaceId": "ws-example",
|
|
7832
8452
|
* "identityProviderType": "CustomSSO",
|
|
7833
|
-
* "
|
|
8453
|
+
* "status": "READY",
|
|
7834
8454
|
* "loginEnabled": false,
|
|
7835
|
-
* "syncEnabled":
|
|
7836
|
-
* "status": "UPDATING"
|
|
8455
|
+
* "syncEnabled": true
|
|
7837
8456
|
* }
|
|
7838
8457
|
* }
|
|
7839
8458
|
* ```
|
|
7840
8459
|
* ## Errors and handling
|
|
7841
|
-
* 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.
|
|
7842
|
-
* 400 InvalidParameter:
|
|
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 that fails may return 503 IdentityProviderProvisioningUnavailable. Retain the request ID for troubleshooting and do not interpret a read failure as unconfigured. Actual authentication and workspace non-existence errors follow the common error handling.
|
|
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. Upstream not being enabled or having no valid credentials may manifest as an asynchronous FAILED after acceptance. You cannot only handle HTTP errors.
|
|
8462
|
+
* ## Call relationships and usage boundaries
|
|
8463
|
+
* The call example for enabling is body={"syncEnabled":true}, and for disabling is body={"syncEnabled":false}. This API returns a snapshot of the shared binding, and its status is not the status of this SCIM task. After acceptance, use GetIdentityProviderSCIM to query operationStatus. Pre-provisioning tests or user assignments for external IdPs must still be completed in the external system. AC does not configure external IdPs for users.
|
|
7843
8464
|
*
|
|
7844
|
-
* @param request -
|
|
7845
|
-
* @returns
|
|
8465
|
+
* @param request - UpdateIdentityProviderSCIMRequest
|
|
8466
|
+
* @returns UpdateIdentityProviderSCIMResponse
|
|
7846
8467
|
*/
|
|
7847
|
-
async
|
|
8468
|
+
async updateIdentityProviderSCIM(workspaceId: string, request: $_model.UpdateIdentityProviderSCIMRequest): Promise<$_model.UpdateIdentityProviderSCIMResponse> {
|
|
7848
8469
|
let runtime = new $dara.RuntimeOptions({ });
|
|
7849
8470
|
let headers : {[key: string ]: string} = { };
|
|
7850
|
-
return await this.
|
|
8471
|
+
return await this.updateIdentityProviderSCIMWithOptions(workspaceId, request, headers, runtime);
|
|
7851
8472
|
}
|
|
7852
8473
|
|
|
7853
8474
|
/**
|
|
@@ -8815,10 +9436,11 @@ export default class Client extends OpenApi {
|
|
|
8815
9436
|
}
|
|
8816
9437
|
|
|
8817
9438
|
/**
|
|
8818
|
-
*
|
|
9439
|
+
* Checks the OSS RAM authorization status of the agent code package.
|
|
8819
9440
|
*
|
|
8820
9441
|
* @remarks
|
|
8821
|
-
*
|
|
9442
|
+
* Queries the binding status of the authorization policy for a specified source bucket to the current workspace role. AUTHORIZED indicates that the policy is bound. UNAUTHORIZED indicates that the policy is not bound. A bound policy does not indicate that a specific code package object exists or is readable.
|
|
9443
|
+
* To check a specific object, call ValidateAgentCodePackageFromOss. This operation does not copy code packages or modify the default OSS binding of the workspace.
|
|
8822
9444
|
*
|
|
8823
9445
|
* @param request - VerifyAgentCodePackageOssRamAuthorizationRequest
|
|
8824
9446
|
* @param headers - map
|
|
@@ -8851,10 +9473,11 @@ export default class Client extends OpenApi {
|
|
|
8851
9473
|
}
|
|
8852
9474
|
|
|
8853
9475
|
/**
|
|
8854
|
-
*
|
|
9476
|
+
* Checks the OSS RAM authorization status of the agent code package.
|
|
8855
9477
|
*
|
|
8856
9478
|
* @remarks
|
|
8857
|
-
*
|
|
9479
|
+
* Queries the binding status of the authorization policy for a specified source bucket to the current workspace role. AUTHORIZED indicates that the policy is bound. UNAUTHORIZED indicates that the policy is not bound. A bound policy does not indicate that a specific code package object exists or is readable.
|
|
9480
|
+
* To check a specific object, call ValidateAgentCodePackageFromOss. This operation does not copy code packages or modify the default OSS binding of the workspace.
|
|
8858
9481
|
*
|
|
8859
9482
|
* @param request - VerifyAgentCodePackageOssRamAuthorizationRequest
|
|
8860
9483
|
* @returns VerifyAgentCodePackageOssRamAuthorizationResponse
|