@alicloud/agentcore20260804 2.5.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +1222 -72
- package/dist/client.js +1609 -72
- package/dist/client.js.map +1 -1
- package/dist/models/AddMemoriesRequest.d.ts +10 -10
- package/dist/models/AddMemoriesResponseBody.d.ts +4 -4
- package/dist/models/AddMemoriesShrinkRequest.d.ts +1 -1
- package/dist/models/CreateCustomAgentRequest.d.ts +43 -43
- package/dist/models/CreateCustomAgentResponseBody.d.ts +118 -61
- package/dist/models/CreateCustomAgentResponseBody.js +33 -1
- package/dist/models/CreateCustomAgentResponseBody.js.map +1 -1
- package/dist/models/CreateIdentityProviderRequest.d.ts +51 -10
- package/dist/models/CreateIdentityProviderRequest.js +32 -1
- package/dist/models/CreateIdentityProviderRequest.js.map +1 -1
- package/dist/models/CreateIdentityProviderResponseBody.d.ts +150 -8
- package/dist/models/CreateIdentityProviderResponseBody.js +95 -1
- 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/CreateIdentityProviderShrinkRequest.d.ts +1 -1
- package/dist/models/CreateIdentityProviderSyncJobRequest.d.ts +13 -0
- package/dist/models/CreateIdentityProviderSyncJobRequest.js +54 -0
- package/dist/models/CreateIdentityProviderSyncJobRequest.js.map +1 -0
- package/dist/models/CreateIdentityProviderSyncJobResponse.d.ts +19 -0
- package/dist/models/CreateIdentityProviderSyncJobResponse.js +69 -0
- package/dist/models/CreateIdentityProviderSyncJobResponse.js.map +1 -0
- package/dist/models/CreateIdentityProviderSyncJobResponseBody.d.ts +121 -0
- package/dist/models/CreateIdentityProviderSyncJobResponseBody.js +100 -0
- package/dist/models/CreateIdentityProviderSyncJobResponseBody.js.map +1 -0
- package/dist/models/CreateMemoryStoreRequest.d.ts +6 -6
- package/dist/models/CreateMemoryStoreResponseBody.d.ts +7 -7
- package/dist/models/CreateMemoryStoreShrinkRequest.d.ts +2 -2
- 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 +110 -17
- package/dist/models/DeleteIdentityProviderResponseBody.js +66 -1
- 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/DeleteMemoryStoreResponseBody.d.ts +3 -3
- package/dist/models/GetAgentCodePackageDownloadUrlRequest.d.ts +13 -0
- package/dist/models/GetAgentCodePackageDownloadUrlRequest.js +54 -0
- package/dist/models/GetAgentCodePackageDownloadUrlRequest.js.map +1 -0
- package/dist/models/GetAgentCodePackageDownloadUrlResponse.d.ts +19 -0
- package/dist/models/GetAgentCodePackageDownloadUrlResponse.js +69 -0
- package/dist/models/GetAgentCodePackageDownloadUrlResponse.js.map +1 -0
- package/dist/models/GetAgentCodePackageDownloadUrlResponseBody.d.ts +131 -0
- package/dist/models/GetAgentCodePackageDownloadUrlResponseBody.js +104 -0
- package/dist/models/GetAgentCodePackageDownloadUrlResponseBody.js.map +1 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlRequest.d.ts +23 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlRequest.js +58 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlRequest.js.map +1 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponse.d.ts +19 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponse.js +69 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponse.js.map +1 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponseBody.d.ts +99 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponseBody.js +96 -0
- package/dist/models/GetAgentCodePackageOssRamAuthorizeUrlResponseBody.js.map +1 -0
- package/dist/models/GetAgentCodePackageUploadUrlRequest.d.ts +62 -0
- package/dist/models/GetAgentCodePackageUploadUrlRequest.js +84 -0
- package/dist/models/GetAgentCodePackageUploadUrlRequest.js.map +1 -0
- package/dist/models/GetAgentCodePackageUploadUrlResponse.d.ts +19 -0
- package/dist/models/GetAgentCodePackageUploadUrlResponse.js +69 -0
- package/dist/models/GetAgentCodePackageUploadUrlResponse.js.map +1 -0
- package/dist/models/GetAgentCodePackageUploadUrlResponseBody.d.ts +114 -0
- package/dist/models/GetAgentCodePackageUploadUrlResponseBody.js +103 -0
- package/dist/models/GetAgentCodePackageUploadUrlResponseBody.js.map +1 -0
- package/dist/models/GetAgentCodePackageUploadUrlShrinkRequest.d.ts +20 -0
- package/dist/models/GetAgentCodePackageUploadUrlShrinkRequest.js +58 -0
- package/dist/models/GetAgentCodePackageUploadUrlShrinkRequest.js.map +1 -0
- package/dist/models/GetCustomAgentResponseBody.d.ts +105 -48
- package/dist/models/GetCustomAgentResponseBody.js +33 -1
- package/dist/models/GetCustomAgentResponseBody.js.map +1 -1
- package/dist/models/GetIdentityProviderResponseBody.d.ts +183 -9
- package/dist/models/GetIdentityProviderResponseBody.js +103 -1
- 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 +123 -0
- package/dist/models/GetIdentityProviderScimresponseBody.js +118 -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/GetIdentityProviderSyncJobRequest.d.ts +13 -0
- package/dist/models/GetIdentityProviderSyncJobRequest.js +54 -0
- package/dist/models/GetIdentityProviderSyncJobRequest.js.map +1 -0
- package/dist/models/GetIdentityProviderSyncJobResponse.d.ts +19 -0
- package/dist/models/GetIdentityProviderSyncJobResponse.js +69 -0
- package/dist/models/GetIdentityProviderSyncJobResponse.js.map +1 -0
- package/dist/models/GetIdentityProviderSyncJobResponseBody.d.ts +128 -0
- package/dist/models/GetIdentityProviderSyncJobResponseBody.js +100 -0
- package/dist/models/GetIdentityProviderSyncJobResponseBody.js.map +1 -0
- package/dist/models/GetIdentityProviderSyncScopeRequest.d.ts +13 -0
- package/dist/models/GetIdentityProviderSyncScopeRequest.js +54 -0
- package/dist/models/GetIdentityProviderSyncScopeRequest.js.map +1 -0
- package/dist/models/GetIdentityProviderSyncScopeResponse.d.ts +19 -0
- package/dist/models/GetIdentityProviderSyncScopeResponse.js +69 -0
- package/dist/models/GetIdentityProviderSyncScopeResponse.js.map +1 -0
- package/dist/models/GetIdentityProviderSyncScopeResponseBody.d.ts +177 -0
- package/dist/models/GetIdentityProviderSyncScopeResponseBody.js +151 -0
- package/dist/models/GetIdentityProviderSyncScopeResponseBody.js.map +1 -0
- package/dist/models/GetMemoryResponseBody.d.ts +4 -4
- package/dist/models/GetMemoryStoreResponseBody.d.ts +3 -3
- package/dist/models/ListAgentCodeRuntimesRequest.d.ts +29 -0
- package/dist/models/ListAgentCodeRuntimesRequest.js +60 -0
- package/dist/models/ListAgentCodeRuntimesRequest.js.map +1 -0
- package/dist/models/ListAgentCodeRuntimesResponse.d.ts +19 -0
- package/dist/models/ListAgentCodeRuntimesResponse.js +69 -0
- package/dist/models/ListAgentCodeRuntimesResponse.js.map +1 -0
- package/dist/models/ListAgentCodeRuntimesResponseBody.d.ts +115 -0
- package/dist/models/ListAgentCodeRuntimesResponseBody.js +100 -0
- package/dist/models/ListAgentCodeRuntimesResponseBody.js.map +1 -0
- package/dist/models/ListCustomAgentsRequest.d.ts +2 -2
- package/dist/models/ListCustomAgentsResponseBody.d.ts +221 -25
- package/dist/models/ListCustomAgentsResponseBody.js +119 -1
- package/dist/models/ListCustomAgentsResponseBody.js.map +1 -1
- package/dist/models/ListIdentityProviderDepartmentsRequest.d.ts +37 -0
- package/dist/models/ListIdentityProviderDepartmentsRequest.js +62 -0
- package/dist/models/ListIdentityProviderDepartmentsRequest.js.map +1 -0
- package/dist/models/ListIdentityProviderDepartmentsResponse.d.ts +19 -0
- package/dist/models/ListIdentityProviderDepartmentsResponse.js +69 -0
- package/dist/models/ListIdentityProviderDepartmentsResponse.js.map +1 -0
- package/dist/models/ListIdentityProviderDepartmentsResponseBody.d.ts +137 -0
- package/dist/models/ListIdentityProviderDepartmentsResponseBody.js +104 -0
- package/dist/models/ListIdentityProviderDepartmentsResponseBody.js.map +1 -0
- 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/ListIdentityProvidersResponseBody.d.ts +187 -25
- package/dist/models/ListIdentityProvidersResponseBody.js +103 -1
- package/dist/models/ListIdentityProvidersResponseBody.js.map +1 -1
- package/dist/models/ListMemoriesResponseBody.d.ts +1 -1
- package/dist/models/ListMemorySessionMessagesRequest.d.ts +3 -3
- package/dist/models/ListMemorySessionsRequest.d.ts +2 -2
- package/dist/models/ListMemorySessionsResponseBody.d.ts +1 -1
- package/dist/models/ListMemoryStoresResponseBody.d.ts +2 -2
- 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/SearchMemoriesRequest.d.ts +3 -3
- package/dist/models/SearchMemoriesResponseBody.d.ts +3 -3
- package/dist/models/UpdateCustomAgentRequest.d.ts +49 -49
- package/dist/models/UpdateCustomAgentResponseBody.d.ts +124 -77
- package/dist/models/UpdateCustomAgentResponseBody.js +33 -1
- package/dist/models/UpdateCustomAgentResponseBody.js.map +1 -1
- package/dist/models/UpdateCustomAgentShrinkRequest.d.ts +1 -1
- package/dist/models/UpdateIdentityProviderRequest.d.ts +111 -10
- package/dist/models/UpdateIdentityProviderRequest.js +67 -1
- package/dist/models/UpdateIdentityProviderRequest.js.map +1 -1
- package/dist/models/UpdateIdentityProviderResponseBody.d.ts +159 -19
- package/dist/models/UpdateIdentityProviderResponseBody.js +95 -1
- 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 +288 -0
- package/dist/models/UpdateIdentityProviderScimresponseBody.js +201 -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/UpdateMemoryRequest.d.ts +3 -3
- package/dist/models/UpdateMemoryShrinkRequest.d.ts +1 -1
- package/dist/models/UpdateMemoryStoreRequest.d.ts +2 -2
- package/dist/models/UpdateMemoryStoreResponseBody.d.ts +1 -1
- package/dist/models/ValidateAgentCodePackageFromOssRequest.d.ts +52 -0
- package/dist/models/ValidateAgentCodePackageFromOssRequest.js +82 -0
- package/dist/models/ValidateAgentCodePackageFromOssRequest.js.map +1 -0
- package/dist/models/ValidateAgentCodePackageFromOssResponse.d.ts +19 -0
- package/dist/models/ValidateAgentCodePackageFromOssResponse.js +69 -0
- package/dist/models/ValidateAgentCodePackageFromOssResponse.js.map +1 -0
- package/dist/models/ValidateAgentCodePackageFromOssResponseBody.d.ts +99 -0
- package/dist/models/ValidateAgentCodePackageFromOssResponseBody.js +96 -0
- package/dist/models/ValidateAgentCodePackageFromOssResponseBody.js.map +1 -0
- package/dist/models/ValidateAgentCodePackageFromOssShrinkRequest.d.ts +20 -0
- package/dist/models/ValidateAgentCodePackageFromOssShrinkRequest.js +58 -0
- package/dist/models/ValidateAgentCodePackageFromOssShrinkRequest.js.map +1 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationRequest.d.ts +23 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationRequest.js +58 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationRequest.js.map +1 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponse.d.ts +19 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponse.js +69 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponse.js.map +1 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.d.ts +99 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.js +96 -0
- package/dist/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.js.map +1 -0
- package/dist/models/model.d.ts +107 -0
- package/dist/models/model.js +328 -112
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +1666 -81
- package/src/models/AddMemoriesRequest.ts +10 -10
- package/src/models/AddMemoriesResponseBody.ts +4 -4
- package/src/models/AddMemoriesShrinkRequest.ts +1 -1
- package/src/models/CreateCustomAgentRequest.ts +43 -43
- package/src/models/CreateCustomAgentResponseBody.ts +141 -61
- package/src/models/CreateIdentityProviderRequest.ts +73 -10
- package/src/models/CreateIdentityProviderResponseBody.ts +217 -8
- package/src/models/CreateIdentityProviderScimcredentialRequest.ts +24 -0
- package/src/models/CreateIdentityProviderScimcredentialResponse.ts +40 -0
- package/src/models/CreateIdentityProviderScimcredentialResponseBody.ts +231 -0
- package/src/models/CreateIdentityProviderShrinkRequest.ts +1 -1
- package/src/models/CreateIdentityProviderSyncJobRequest.ts +24 -0
- package/src/models/CreateIdentityProviderSyncJobResponse.ts +40 -0
- package/src/models/CreateIdentityProviderSyncJobResponseBody.ts +167 -0
- package/src/models/CreateMemoryStoreRequest.ts +6 -6
- package/src/models/CreateMemoryStoreResponseBody.ts +7 -7
- package/src/models/CreateMemoryStoreShrinkRequest.ts +2 -2
- 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 +157 -17
- package/src/models/DeleteIdentityProviderScimcredentialRequest.ts +24 -0
- package/src/models/DeleteIdentityProviderScimcredentialResponse.ts +40 -0
- package/src/models/DeleteIdentityProviderScimcredentialResponseBody.ts +71 -0
- package/src/models/DeleteMemoryStoreResponseBody.ts +3 -3
- package/src/models/GetAgentCodePackageDownloadUrlRequest.ts +24 -0
- package/src/models/GetAgentCodePackageDownloadUrlResponse.ts +40 -0
- package/src/models/GetAgentCodePackageDownloadUrlResponseBody.ts +181 -0
- package/src/models/GetAgentCodePackageOssRamAuthorizeUrlRequest.ts +36 -0
- package/src/models/GetAgentCodePackageOssRamAuthorizeUrlResponse.ts +40 -0
- package/src/models/GetAgentCodePackageOssRamAuthorizeUrlResponseBody.ts +141 -0
- package/src/models/GetAgentCodePackageUploadUrlRequest.ts +92 -0
- package/src/models/GetAgentCodePackageUploadUrlResponse.ts +40 -0
- package/src/models/GetAgentCodePackageUploadUrlResponseBody.ts +161 -0
- package/src/models/GetAgentCodePackageUploadUrlShrinkRequest.ts +33 -0
- package/src/models/GetCustomAgentResponseBody.ts +128 -48
- package/src/models/GetIdentityProviderResponseBody.ts +258 -9
- package/src/models/GetIdentityProviderScimrequest.ts +24 -0
- package/src/models/GetIdentityProviderScimresponse.ts +40 -0
- package/src/models/GetIdentityProviderScimresponseBody.ts +178 -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/GetIdentityProviderSyncJobRequest.ts +24 -0
- package/src/models/GetIdentityProviderSyncJobResponse.ts +40 -0
- package/src/models/GetIdentityProviderSyncJobResponseBody.ts +174 -0
- package/src/models/GetIdentityProviderSyncScopeRequest.ts +24 -0
- package/src/models/GetIdentityProviderSyncScopeResponse.ts +40 -0
- package/src/models/GetIdentityProviderSyncScopeResponseBody.ts +256 -0
- package/src/models/GetMemoryResponseBody.ts +4 -4
- package/src/models/GetMemoryStoreResponseBody.ts +3 -3
- package/src/models/ListAgentCodeRuntimesRequest.ts +44 -0
- package/src/models/ListAgentCodeRuntimesResponse.ts +40 -0
- package/src/models/ListAgentCodeRuntimesResponseBody.ts +161 -0
- package/src/models/ListCustomAgentsRequest.ts +2 -2
- package/src/models/ListCustomAgentsResponseBody.ts +303 -25
- package/src/models/ListIdentityProviderDepartmentsRequest.ts +54 -0
- package/src/models/ListIdentityProviderDepartmentsResponse.ts +40 -0
- package/src/models/ListIdentityProviderDepartmentsResponseBody.ts +187 -0
- package/src/models/ListIdentityProviderScimcredentialsRequest.ts +24 -0
- package/src/models/ListIdentityProviderScimcredentialsResponse.ts +40 -0
- package/src/models/ListIdentityProviderScimcredentialsResponseBody.ts +141 -0
- package/src/models/ListIdentityProvidersResponseBody.ts +262 -25
- package/src/models/ListMemoriesResponseBody.ts +1 -1
- package/src/models/ListMemorySessionMessagesRequest.ts +3 -3
- package/src/models/ListMemorySessionsRequest.ts +2 -2
- package/src/models/ListMemorySessionsResponseBody.ts +1 -1
- package/src/models/ListMemoryStoresResponseBody.ts +2 -2
- package/src/models/PrepareIdentityProviderScimrequest.ts +24 -0
- package/src/models/PrepareIdentityProviderScimresponse.ts +40 -0
- package/src/models/PrepareIdentityProviderScimresponseBody.ts +231 -0
- package/src/models/SearchMemoriesRequest.ts +3 -3
- package/src/models/SearchMemoriesResponseBody.ts +3 -3
- package/src/models/UpdateCustomAgentRequest.ts +49 -49
- package/src/models/UpdateCustomAgentResponseBody.ts +147 -77
- package/src/models/UpdateCustomAgentShrinkRequest.ts +1 -1
- package/src/models/UpdateIdentityProviderRequest.ts +159 -10
- package/src/models/UpdateIdentityProviderResponseBody.ts +226 -19
- package/src/models/UpdateIdentityProviderScimrequest.ts +65 -0
- package/src/models/UpdateIdentityProviderScimresponse.ts +40 -0
- package/src/models/UpdateIdentityProviderScimresponseBody.ts +408 -0
- package/src/models/UpdateIdentityProviderScimshrinkRequest.ts +33 -0
- package/src/models/UpdateIdentityProviderShrinkRequest.ts +1 -1
- package/src/models/UpdateMemoryRequest.ts +3 -3
- package/src/models/UpdateMemoryShrinkRequest.ts +1 -1
- package/src/models/UpdateMemoryStoreRequest.ts +2 -2
- package/src/models/UpdateMemoryStoreResponseBody.ts +1 -1
- package/src/models/ValidateAgentCodePackageFromOssRequest.ts +80 -0
- package/src/models/ValidateAgentCodePackageFromOssResponse.ts +40 -0
- package/src/models/ValidateAgentCodePackageFromOssResponseBody.ts +141 -0
- package/src/models/ValidateAgentCodePackageFromOssShrinkRequest.ts +33 -0
- package/src/models/VerifyAgentCodePackageOssRamAuthorizationRequest.ts +36 -0
- package/src/models/VerifyAgentCodePackageOssRamAuthorizationResponse.ts +40 -0
- package/src/models/VerifyAgentCodePackageOssRamAuthorizationResponseBody.ts +141 -0
- package/src/models/model.ts +107 -0
package/dist/client.js
CHANGED
|
@@ -62,10 +62,10 @@ class Client extends openapi_core_1.default {
|
|
|
62
62
|
return openapi_core_2.OpenApiUtil.getEndpointRules(productId, regionId, endpointRule, network, suffix);
|
|
63
63
|
}
|
|
64
64
|
/**
|
|
65
|
-
* Writes messages or text to a memory store. By default, sync is set to true, which synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId
|
|
65
|
+
* Writes messages or text to a memory store. By default, sync is set to true, which means the operation synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId, which you can query by calling GetMemoryTask.
|
|
66
66
|
*
|
|
67
67
|
* @remarks
|
|
68
|
-
* Writes messages or text to a memory store. By default, sync is set to true, which synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId
|
|
68
|
+
* Writes messages or text to a memory store. By default, sync is set to true, which means the operation synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId, which you can query by calling GetMemoryTask.
|
|
69
69
|
*
|
|
70
70
|
* @param tmpReq - AddMemoriesRequest
|
|
71
71
|
* @param headers - map
|
|
@@ -101,10 +101,10 @@ class Client extends openapi_core_1.default {
|
|
|
101
101
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddMemoriesResponse({}));
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
* Writes messages or text to a memory store. By default, sync is set to true, which synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId
|
|
104
|
+
* Writes messages or text to a memory store. By default, sync is set to true, which means the operation synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId, which you can query by calling GetMemoryTask.
|
|
105
105
|
*
|
|
106
106
|
* @remarks
|
|
107
|
-
* Writes messages or text to a memory store. By default, sync is set to true, which synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId
|
|
107
|
+
* Writes messages or text to a memory store. By default, sync is set to true, which means the operation synchronously waits for extraction and returns only memories (an empty array is allowed). If sync is set to false, the operation returns only a taskId, which you can query by calling GetMemoryTask.
|
|
108
108
|
*
|
|
109
109
|
* @param request - AddMemoriesRequest
|
|
110
110
|
* @returns AddMemoriesResponse
|
|
@@ -496,13 +496,15 @@ class Client extends openapi_core_1.default {
|
|
|
496
496
|
return await this.createCredentialWithOptions(workspaceId, request, headers, runtime);
|
|
497
497
|
}
|
|
498
498
|
/**
|
|
499
|
-
* Creates a custom agent in a specified workspace and
|
|
499
|
+
* Creates a custom agent in a specified workspace. Container image and code package deployments are supported. The creation process is asynchronous. You can call GetCustomAgent to query the deployment result.
|
|
500
500
|
*
|
|
501
501
|
* @remarks
|
|
502
|
-
* Before you call this operation, prepare a writable workspace, a RAM role ARN,
|
|
503
|
-
*
|
|
504
|
-
*
|
|
505
|
-
* The
|
|
502
|
+
* Before you call this operation, prepare a writable workspace, a RAM role ARN, a container image or code package, and runtime configurations. You must specify name, artifact, roleArn, and runtime. The runtime parameter must include both compute and sessionPolicy.
|
|
503
|
+
* In container mode, use artifact.container and specify artifact.port. The image must have the required access permissions and be accessible over the network allowed by the workspace.
|
|
504
|
+
* In code package pattern, specify artifact.port, and the sourceUri, languageRuntime, and entrypoint of artifact.code. Do not specify container at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported. The compressed package size cannot exceed 500,000,000 bytes. You can call ListAgentCodeRuntimes to query the runtime environment identity. The sourceUri parameter supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, call GetAgentCodePackageUploadUrl to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
|
|
505
|
+
* When you submit a new code package source, the backend rechecks the read permissions, object, and size. The configuration is saved only after the transfer succeeds. If the transfer fails, the configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not mean that the agent is ready to run.
|
|
506
|
+
* The creation process is asynchronous. A successful response indicates that the request is accepted. You can use the returned agentId to call GetCustomAgent and check the latestVersionStatus, latestExecutionError, and status corresponding to latestSpecVersion to confirm the deployment result. After the deployment is ready, you can call CreateServiceEndpoint to configure the access endpoint.
|
|
507
|
+
* The clientToken parameter does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold parameter for health checks does not take effect. Omit this parameter.
|
|
506
508
|
*
|
|
507
509
|
* @param tmpReq - CreateCustomAgentRequest
|
|
508
510
|
* @param headers - map
|
|
@@ -543,13 +545,15 @@ class Client extends openapi_core_1.default {
|
|
|
543
545
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateCustomAgentResponse({}));
|
|
544
546
|
}
|
|
545
547
|
/**
|
|
546
|
-
* Creates a custom agent in a specified workspace and
|
|
548
|
+
* Creates a custom agent in a specified workspace. Container image and code package deployments are supported. The creation process is asynchronous. You can call GetCustomAgent to query the deployment result.
|
|
547
549
|
*
|
|
548
550
|
* @remarks
|
|
549
|
-
* Before you call this operation, prepare a writable workspace, a RAM role ARN,
|
|
550
|
-
*
|
|
551
|
-
*
|
|
552
|
-
* The
|
|
551
|
+
* Before you call this operation, prepare a writable workspace, a RAM role ARN, a container image or code package, and runtime configurations. You must specify name, artifact, roleArn, and runtime. The runtime parameter must include both compute and sessionPolicy.
|
|
552
|
+
* In container mode, use artifact.container and specify artifact.port. The image must have the required access permissions and be accessible over the network allowed by the workspace.
|
|
553
|
+
* In code package pattern, specify artifact.port, and the sourceUri, languageRuntime, and entrypoint of artifact.code. Do not specify container at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported. The compressed package size cannot exceed 500,000,000 bytes. You can call ListAgentCodeRuntimes to query the runtime environment identity. The sourceUri parameter supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, call GetAgentCodePackageUploadUrl to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
|
|
554
|
+
* When you submit a new code package source, the backend rechecks the read permissions, object, and size. The configuration is saved only after the transfer succeeds. If the transfer fails, the configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not mean that the agent is ready to run.
|
|
555
|
+
* The creation process is asynchronous. A successful response indicates that the request is accepted. You can use the returned agentId to call GetCustomAgent and check the latestVersionStatus, latestExecutionError, and status corresponding to latestSpecVersion to confirm the deployment result. After the deployment is ready, you can call CreateServiceEndpoint to configure the access endpoint.
|
|
556
|
+
* The clientToken parameter does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold parameter for health checks does not take effect. Omit this parameter.
|
|
553
557
|
*
|
|
554
558
|
* @param request - CreateCustomAgentRequest
|
|
555
559
|
* @returns CreateCustomAgentResponse
|
|
@@ -666,7 +670,34 @@ class Client extends openapi_core_1.default {
|
|
|
666
670
|
return await this.createExternalAgentBootstrapTokenWithOptions(workspaceId, agentId, request, headers, runtime);
|
|
667
671
|
}
|
|
668
672
|
/**
|
|
669
|
-
* Binds an external identity provider to a specified workspace
|
|
673
|
+
* 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.
|
|
674
|
+
*
|
|
675
|
+
* @remarks
|
|
676
|
+
* ## Features and prerequisites
|
|
677
|
+
* 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.
|
|
678
|
+
* 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.
|
|
679
|
+
* ## Requests and examples
|
|
680
|
+
* POST /workspaces/{workspaceId}/identity-providers
|
|
681
|
+
* 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.
|
|
682
|
+
* ```text
|
|
683
|
+
* POST /workspaces/ws-example/identity-providers
|
|
684
|
+
* {"identityProviderType": "CustomSSO"}
|
|
685
|
+
* ```
|
|
686
|
+
* ## Response example
|
|
687
|
+
* ```json
|
|
688
|
+
* {
|
|
689
|
+
* "data": {
|
|
690
|
+
* "workspaceId": "ws-example",
|
|
691
|
+
* "identityProviderType": "CustomSSO",
|
|
692
|
+
* "loginEnabled": false,
|
|
693
|
+
* "syncEnabled": false,
|
|
694
|
+
* "status": "CONFIGURED"
|
|
695
|
+
* }
|
|
696
|
+
* }
|
|
697
|
+
* ```
|
|
698
|
+
* ## Errors and handling
|
|
699
|
+
* 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.
|
|
700
|
+
* 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.
|
|
670
701
|
*
|
|
671
702
|
* @param tmpReq - CreateIdentityProviderRequest
|
|
672
703
|
* @param headers - map
|
|
@@ -702,7 +733,34 @@ class Client extends openapi_core_1.default {
|
|
|
702
733
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateIdentityProviderResponse({}));
|
|
703
734
|
}
|
|
704
735
|
/**
|
|
705
|
-
* Binds an external identity provider to a specified workspace
|
|
736
|
+
* 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.
|
|
737
|
+
*
|
|
738
|
+
* @remarks
|
|
739
|
+
* ## Features and prerequisites
|
|
740
|
+
* 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.
|
|
741
|
+
* 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.
|
|
742
|
+
* ## Requests and examples
|
|
743
|
+
* POST /workspaces/{workspaceId}/identity-providers
|
|
744
|
+
* 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.
|
|
745
|
+
* ```text
|
|
746
|
+
* POST /workspaces/ws-example/identity-providers
|
|
747
|
+
* {"identityProviderType": "CustomSSO"}
|
|
748
|
+
* ```
|
|
749
|
+
* ## Response example
|
|
750
|
+
* ```json
|
|
751
|
+
* {
|
|
752
|
+
* "data": {
|
|
753
|
+
* "workspaceId": "ws-example",
|
|
754
|
+
* "identityProviderType": "CustomSSO",
|
|
755
|
+
* "loginEnabled": false,
|
|
756
|
+
* "syncEnabled": false,
|
|
757
|
+
* "status": "CONFIGURED"
|
|
758
|
+
* }
|
|
759
|
+
* }
|
|
760
|
+
* ```
|
|
761
|
+
* ## Errors and handling
|
|
762
|
+
* 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.
|
|
763
|
+
* 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.
|
|
706
764
|
*
|
|
707
765
|
* @param request - CreateIdentityProviderRequest
|
|
708
766
|
* @returns CreateIdentityProviderResponse
|
|
@@ -712,6 +770,190 @@ class Client extends openapi_core_1.default {
|
|
|
712
770
|
let headers = {};
|
|
713
771
|
return await this.createIdentityProviderWithOptions(workspaceId, request, headers, runtime);
|
|
714
772
|
}
|
|
773
|
+
/**
|
|
774
|
+
* 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.
|
|
775
|
+
*
|
|
776
|
+
* @remarks
|
|
777
|
+
* ## Features and prerequisites
|
|
778
|
+
* 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.
|
|
779
|
+
* 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.
|
|
780
|
+
* ## Request and examples
|
|
781
|
+
* POST /workspaces/{workspaceId}/scim-provisioning/credentials
|
|
782
|
+
* 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.
|
|
783
|
+
* ```text
|
|
784
|
+
* POST /workspaces/ws-example/scim-provisioning/credentials
|
|
785
|
+
* No business request body.
|
|
786
|
+
* ```
|
|
787
|
+
* ## Response example
|
|
788
|
+
* ```json
|
|
789
|
+
* {
|
|
790
|
+
* "data": {
|
|
791
|
+
* "configuration": {
|
|
792
|
+
* "status": "Enabled",
|
|
793
|
+
* "baseUrl": "https://example.com/scim/v2"
|
|
794
|
+
* },
|
|
795
|
+
* "credential": {
|
|
796
|
+
* "credentialId": "credential-example",
|
|
797
|
+
* "status": "Enabled",
|
|
798
|
+
* "expireTime": "<Upstream expiration time>"
|
|
799
|
+
* },
|
|
800
|
+
* "token": "<Newly issued token for the current request>"
|
|
801
|
+
* }
|
|
802
|
+
* }
|
|
803
|
+
* ```
|
|
804
|
+
* ## Errors and handling
|
|
805
|
+
* 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.
|
|
806
|
+
* 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.
|
|
807
|
+
* ## Call relationships and usage boundaries
|
|
808
|
+
* 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.
|
|
809
|
+
*
|
|
810
|
+
* @param request - CreateIdentityProviderSCIMCredentialRequest
|
|
811
|
+
* @param headers - map
|
|
812
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
813
|
+
* @returns CreateIdentityProviderSCIMCredentialResponse
|
|
814
|
+
*/
|
|
815
|
+
async createIdentityProviderSCIMCredentialWithOptions(workspaceId, request, headers, runtime) {
|
|
816
|
+
request.validate();
|
|
817
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
818
|
+
headers: headers,
|
|
819
|
+
});
|
|
820
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
821
|
+
action: "CreateIdentityProviderSCIMCredential",
|
|
822
|
+
version: "2026-08-04",
|
|
823
|
+
protocol: "HTTPS",
|
|
824
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/scim-provisioning/credentials`,
|
|
825
|
+
method: "POST",
|
|
826
|
+
authType: "AK",
|
|
827
|
+
style: "ROA",
|
|
828
|
+
reqBodyType: "json",
|
|
829
|
+
bodyType: "json",
|
|
830
|
+
});
|
|
831
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateIdentityProviderSCIMCredentialResponse({}));
|
|
832
|
+
}
|
|
833
|
+
/**
|
|
834
|
+
* 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.
|
|
835
|
+
*
|
|
836
|
+
* @remarks
|
|
837
|
+
* ## Features and prerequisites
|
|
838
|
+
* 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.
|
|
839
|
+
* 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.
|
|
840
|
+
* ## Request and examples
|
|
841
|
+
* POST /workspaces/{workspaceId}/scim-provisioning/credentials
|
|
842
|
+
* 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.
|
|
843
|
+
* ```text
|
|
844
|
+
* POST /workspaces/ws-example/scim-provisioning/credentials
|
|
845
|
+
* No business request body.
|
|
846
|
+
* ```
|
|
847
|
+
* ## Response example
|
|
848
|
+
* ```json
|
|
849
|
+
* {
|
|
850
|
+
* "data": {
|
|
851
|
+
* "configuration": {
|
|
852
|
+
* "status": "Enabled",
|
|
853
|
+
* "baseUrl": "https://example.com/scim/v2"
|
|
854
|
+
* },
|
|
855
|
+
* "credential": {
|
|
856
|
+
* "credentialId": "credential-example",
|
|
857
|
+
* "status": "Enabled",
|
|
858
|
+
* "expireTime": "<Upstream expiration time>"
|
|
859
|
+
* },
|
|
860
|
+
* "token": "<Newly issued token for the current request>"
|
|
861
|
+
* }
|
|
862
|
+
* }
|
|
863
|
+
* ```
|
|
864
|
+
* ## Errors and handling
|
|
865
|
+
* 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.
|
|
866
|
+
* 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.
|
|
867
|
+
* ## Call relationships and usage boundaries
|
|
868
|
+
* 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.
|
|
869
|
+
*
|
|
870
|
+
* @param request - CreateIdentityProviderSCIMCredentialRequest
|
|
871
|
+
* @returns CreateIdentityProviderSCIMCredentialResponse
|
|
872
|
+
*/
|
|
873
|
+
async createIdentityProviderSCIMCredential(workspaceId, request) {
|
|
874
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
875
|
+
let headers = {};
|
|
876
|
+
return await this.createIdentityProviderSCIMCredentialWithOptions(workspaceId, request, headers, runtime);
|
|
877
|
+
}
|
|
878
|
+
/**
|
|
879
|
+
* Initiates a manual synchronization of an identity provider.
|
|
880
|
+
*
|
|
881
|
+
* @remarks
|
|
882
|
+
* Initiates a one-time user synchronization based on the saved scope without saving the configuration or requiring syncEnabled=true. Prerequisites: the identity provider is in the READY or SYNC_FAILED state, a user pool exists, and no other pending identity provider operations are in progress. The returned taskId only indicates that the request is accepted. Call GetIdentityProviderSyncJob to poll the status until it reaches SUCCESS, FAILED, or CANCELED. If the task fails, check the failureReason. The workspace user quota still applies, and previously synchronized users are not automatically deleted if the scope is reduced.
|
|
883
|
+
* Authorization information: RAM action agentcore:CreateIdentityProviderSyncJob, access level Write, resource ARN: acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is required for authorization.
|
|
884
|
+
* Idempotency and retry: This operation does not provide a ClientToken parameter for conditional idempotency. Repeated submissions do not guarantee the same task is returned. If an operation is already in progress, an operation conflict is returned. Submitting again after the task ends creates a new synchronization task. If a submission times out, query the identity provider status first to avoid blindly resubmitting the request.
|
|
885
|
+
* Calling this API is free of charge, and operation records support ActionTrail auditing.
|
|
886
|
+
* Initial selective synchronization process: CreateIdentityProvider (syncOnBind=false, it is recommended to keep syncEnabled=false initially) → GetIdentityProvider and wait for READY → ListIdentityProviderDepartments to select departments → UpdateIdentityProvider to save syncScope and wait for READY → CreateIdentityProviderSyncJob → GetIdentityProviderSyncJob to query the terminal state. If incremental synchronization is required, configure callbacks and event subscriptions, and then update syncEnabled=true.
|
|
887
|
+
* Response example:
|
|
888
|
+
* ```json
|
|
889
|
+
* {
|
|
890
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
891
|
+
* "message": "success",
|
|
892
|
+
* "httpStatusCode": 200,
|
|
893
|
+
* "code": "SUCCESS",
|
|
894
|
+
* "success": true,
|
|
895
|
+
* "data": {
|
|
896
|
+
* "taskId": "12345678-1234-4234-8234-123456789abc",
|
|
897
|
+
* "status": "PENDING"
|
|
898
|
+
* }
|
|
899
|
+
* }
|
|
900
|
+
* ```
|
|
901
|
+
*
|
|
902
|
+
* @param request - CreateIdentityProviderSyncJobRequest
|
|
903
|
+
* @param headers - map
|
|
904
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
905
|
+
* @returns CreateIdentityProviderSyncJobResponse
|
|
906
|
+
*/
|
|
907
|
+
async createIdentityProviderSyncJobWithOptions(workspaceId, identityProviderType, request, headers, runtime) {
|
|
908
|
+
request.validate();
|
|
909
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
910
|
+
headers: headers,
|
|
911
|
+
});
|
|
912
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
913
|
+
action: "CreateIdentityProviderSyncJob",
|
|
914
|
+
version: "2026-08-04",
|
|
915
|
+
protocol: "HTTPS",
|
|
916
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/identity-providers/${$dara.URL.percentEncode(identityProviderType)}/sync-jobs`,
|
|
917
|
+
method: "POST",
|
|
918
|
+
authType: "AK",
|
|
919
|
+
style: "ROA",
|
|
920
|
+
reqBodyType: "json",
|
|
921
|
+
bodyType: "json",
|
|
922
|
+
});
|
|
923
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateIdentityProviderSyncJobResponse({}));
|
|
924
|
+
}
|
|
925
|
+
/**
|
|
926
|
+
* Initiates a manual synchronization of an identity provider.
|
|
927
|
+
*
|
|
928
|
+
* @remarks
|
|
929
|
+
* Initiates a one-time user synchronization based on the saved scope without saving the configuration or requiring syncEnabled=true. Prerequisites: the identity provider is in the READY or SYNC_FAILED state, a user pool exists, and no other pending identity provider operations are in progress. The returned taskId only indicates that the request is accepted. Call GetIdentityProviderSyncJob to poll the status until it reaches SUCCESS, FAILED, or CANCELED. If the task fails, check the failureReason. The workspace user quota still applies, and previously synchronized users are not automatically deleted if the scope is reduced.
|
|
930
|
+
* Authorization information: RAM action agentcore:CreateIdentityProviderSyncJob, access level Write, resource ARN: acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is required for authorization.
|
|
931
|
+
* Idempotency and retry: This operation does not provide a ClientToken parameter for conditional idempotency. Repeated submissions do not guarantee the same task is returned. If an operation is already in progress, an operation conflict is returned. Submitting again after the task ends creates a new synchronization task. If a submission times out, query the identity provider status first to avoid blindly resubmitting the request.
|
|
932
|
+
* Calling this API is free of charge, and operation records support ActionTrail auditing.
|
|
933
|
+
* Initial selective synchronization process: CreateIdentityProvider (syncOnBind=false, it is recommended to keep syncEnabled=false initially) → GetIdentityProvider and wait for READY → ListIdentityProviderDepartments to select departments → UpdateIdentityProvider to save syncScope and wait for READY → CreateIdentityProviderSyncJob → GetIdentityProviderSyncJob to query the terminal state. If incremental synchronization is required, configure callbacks and event subscriptions, and then update syncEnabled=true.
|
|
934
|
+
* Response example:
|
|
935
|
+
* ```json
|
|
936
|
+
* {
|
|
937
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
938
|
+
* "message": "success",
|
|
939
|
+
* "httpStatusCode": 200,
|
|
940
|
+
* "code": "SUCCESS",
|
|
941
|
+
* "success": true,
|
|
942
|
+
* "data": {
|
|
943
|
+
* "taskId": "12345678-1234-4234-8234-123456789abc",
|
|
944
|
+
* "status": "PENDING"
|
|
945
|
+
* }
|
|
946
|
+
* }
|
|
947
|
+
* ```
|
|
948
|
+
*
|
|
949
|
+
* @param request - CreateIdentityProviderSyncJobRequest
|
|
950
|
+
* @returns CreateIdentityProviderSyncJobResponse
|
|
951
|
+
*/
|
|
952
|
+
async createIdentityProviderSyncJob(workspaceId, identityProviderType, request) {
|
|
953
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
954
|
+
let headers = {};
|
|
955
|
+
return await this.createIdentityProviderSyncJobWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
956
|
+
}
|
|
715
957
|
/**
|
|
716
958
|
* Creates an image cache.
|
|
717
959
|
*
|
|
@@ -1591,7 +1833,33 @@ class Client extends openapi_core_1.default {
|
|
|
1591
1833
|
return await this.deleteExternalAgentWithOptions(workspaceId, agentId, request, headers, runtime);
|
|
1592
1834
|
}
|
|
1593
1835
|
/**
|
|
1594
|
-
*
|
|
1836
|
+
* 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.
|
|
1837
|
+
*
|
|
1838
|
+
* @remarks
|
|
1839
|
+
* ## Features and prerequisites
|
|
1840
|
+
* 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.
|
|
1841
|
+
* 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.
|
|
1842
|
+
* ## Requests and examples
|
|
1843
|
+
* DELETE /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
1844
|
+
* 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.
|
|
1845
|
+
* ```text
|
|
1846
|
+
* DELETE /workspaces/ws-example/identity-providers/CustomSSO
|
|
1847
|
+
* ```
|
|
1848
|
+
* ## Response examples
|
|
1849
|
+
* ```json
|
|
1850
|
+
* {
|
|
1851
|
+
* "data": {
|
|
1852
|
+
* "workspaceId": "ws-example",
|
|
1853
|
+
* "identityProviderType": "CustomSSO",
|
|
1854
|
+
* "status": "DISCONNECTING"
|
|
1855
|
+
* }
|
|
1856
|
+
* }
|
|
1857
|
+
* ```
|
|
1858
|
+
* ## Errors and handling
|
|
1859
|
+
* 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.
|
|
1860
|
+
* 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.
|
|
1861
|
+
* ## Calling relationships and usage boundaries
|
|
1862
|
+
* 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.
|
|
1595
1863
|
*
|
|
1596
1864
|
* @param request - DeleteIdentityProviderRequest
|
|
1597
1865
|
* @param headers - map
|
|
@@ -1622,7 +1890,33 @@ class Client extends openapi_core_1.default {
|
|
|
1622
1890
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteIdentityProviderResponse({}));
|
|
1623
1891
|
}
|
|
1624
1892
|
/**
|
|
1625
|
-
*
|
|
1893
|
+
* 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.
|
|
1894
|
+
*
|
|
1895
|
+
* @remarks
|
|
1896
|
+
* ## Features and prerequisites
|
|
1897
|
+
* 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.
|
|
1898
|
+
* 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.
|
|
1899
|
+
* ## Requests and examples
|
|
1900
|
+
* DELETE /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
1901
|
+
* 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.
|
|
1902
|
+
* ```text
|
|
1903
|
+
* DELETE /workspaces/ws-example/identity-providers/CustomSSO
|
|
1904
|
+
* ```
|
|
1905
|
+
* ## Response examples
|
|
1906
|
+
* ```json
|
|
1907
|
+
* {
|
|
1908
|
+
* "data": {
|
|
1909
|
+
* "workspaceId": "ws-example",
|
|
1910
|
+
* "identityProviderType": "CustomSSO",
|
|
1911
|
+
* "status": "DISCONNECTING"
|
|
1912
|
+
* }
|
|
1913
|
+
* }
|
|
1914
|
+
* ```
|
|
1915
|
+
* ## Errors and handling
|
|
1916
|
+
* 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.
|
|
1917
|
+
* 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.
|
|
1918
|
+
* ## Calling relationships and usage boundaries
|
|
1919
|
+
* 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.
|
|
1626
1920
|
*
|
|
1627
1921
|
* @param request - DeleteIdentityProviderRequest
|
|
1628
1922
|
* @returns DeleteIdentityProviderResponse
|
|
@@ -1632,6 +1926,49 @@ class Client extends openapi_core_1.default {
|
|
|
1632
1926
|
let headers = {};
|
|
1633
1927
|
return await this.deleteIdentityProviderWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
1634
1928
|
}
|
|
1929
|
+
/**
|
|
1930
|
+
* 删除 SCIM 凭据
|
|
1931
|
+
*
|
|
1932
|
+
* @remarks
|
|
1933
|
+
* ## 功能与前提\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 登录。
|
|
1934
|
+
*
|
|
1935
|
+
* @param request - DeleteIdentityProviderSCIMCredentialRequest
|
|
1936
|
+
* @param headers - map
|
|
1937
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
1938
|
+
* @returns DeleteIdentityProviderSCIMCredentialResponse
|
|
1939
|
+
*/
|
|
1940
|
+
async deleteIdentityProviderSCIMCredentialWithOptions(workspaceId, credentialId, request, headers, runtime) {
|
|
1941
|
+
request.validate();
|
|
1942
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
1943
|
+
headers: headers,
|
|
1944
|
+
});
|
|
1945
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
1946
|
+
action: "DeleteIdentityProviderSCIMCredential",
|
|
1947
|
+
version: "2026-08-04",
|
|
1948
|
+
protocol: "HTTPS",
|
|
1949
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/scim-provisioning/credentials/${$dara.URL.percentEncode(credentialId)}`,
|
|
1950
|
+
method: "DELETE",
|
|
1951
|
+
authType: "AK",
|
|
1952
|
+
style: "ROA",
|
|
1953
|
+
reqBodyType: "json",
|
|
1954
|
+
bodyType: "json",
|
|
1955
|
+
});
|
|
1956
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteIdentityProviderSCIMCredentialResponse({}));
|
|
1957
|
+
}
|
|
1958
|
+
/**
|
|
1959
|
+
* 删除 SCIM 凭据
|
|
1960
|
+
*
|
|
1961
|
+
* @remarks
|
|
1962
|
+
* ## 功能与前提\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 登录。
|
|
1963
|
+
*
|
|
1964
|
+
* @param request - DeleteIdentityProviderSCIMCredentialRequest
|
|
1965
|
+
* @returns DeleteIdentityProviderSCIMCredentialResponse
|
|
1966
|
+
*/
|
|
1967
|
+
async deleteIdentityProviderSCIMCredential(workspaceId, credentialId, request) {
|
|
1968
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
1969
|
+
let headers = {};
|
|
1970
|
+
return await this.deleteIdentityProviderSCIMCredentialWithOptions(workspaceId, credentialId, request, headers, runtime);
|
|
1971
|
+
}
|
|
1635
1972
|
/**
|
|
1636
1973
|
* Deletes an image cache.
|
|
1637
1974
|
*
|
|
@@ -1809,10 +2146,10 @@ class Client extends openapi_core_1.default {
|
|
|
1809
2146
|
return await this.deleteMemoryWithOptions(workspaceId, memoryStoreName, memoryId, request, headers, runtime);
|
|
1810
2147
|
}
|
|
1811
2148
|
/**
|
|
1812
|
-
* Asynchronously deletes a MemoryStore and all
|
|
2149
|
+
* Asynchronously deletes a MemoryStore and all long-term memory within it.
|
|
1813
2150
|
*
|
|
1814
2151
|
* @remarks
|
|
1815
|
-
* Asynchronously deletes a MemoryStore and all
|
|
2152
|
+
* Asynchronously deletes a MemoryStore and all long-term memory within it.
|
|
1816
2153
|
*
|
|
1817
2154
|
* @param request - DeleteMemoryStoreRequest
|
|
1818
2155
|
* @param headers - map
|
|
@@ -1838,10 +2175,10 @@ class Client extends openapi_core_1.default {
|
|
|
1838
2175
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteMemoryStoreResponse({}));
|
|
1839
2176
|
}
|
|
1840
2177
|
/**
|
|
1841
|
-
* Asynchronously deletes a MemoryStore and all
|
|
2178
|
+
* Asynchronously deletes a MemoryStore and all long-term memory within it.
|
|
1842
2179
|
*
|
|
1843
2180
|
* @remarks
|
|
1844
|
-
* Asynchronously deletes a MemoryStore and all
|
|
2181
|
+
* Asynchronously deletes a MemoryStore and all long-term memory within it.
|
|
1845
2182
|
*
|
|
1846
2183
|
* @param request - DeleteMemoryStoreRequest
|
|
1847
2184
|
* @returns DeleteMemoryStoreResponse
|
|
@@ -2398,6 +2735,154 @@ class Client extends openapi_core_1.default {
|
|
|
2398
2735
|
let headers = {};
|
|
2399
2736
|
return await this.forcePublishSkillVersionWithOptions(workspaceId, skillName, skillVersion, request, headers, runtime);
|
|
2400
2737
|
}
|
|
2738
|
+
/**
|
|
2739
|
+
* Retrieves the download URL for the saved code package of an agent.
|
|
2740
|
+
*
|
|
2741
|
+
* @remarks
|
|
2742
|
+
* Generates a time-limited, read-only download URL for the code package referenced by the currently saved agent configuration. This applies to code packages uploaded locally or imported from Object Storage Service (OSS). The operation uses workspaceId and agentId for locating and does not accept arbitrary bucket, object key, or historical version parameters. The current configuration must reference an available, fixed code package, and does not require waiting for a running instance to be ready. An error is returned if the code package does not exist, has changed, or is unreadable. The link is valid for up to 10 minutes and does not exceed the underlying credential expiration time. Call the operation again after it expires. The resourceVersionId indicates the saved configuration version corresponding to this download. The sample download link is redacted. Use the downloadUrl in the response.
|
|
2743
|
+
*
|
|
2744
|
+
* @param request - GetAgentCodePackageDownloadUrlRequest
|
|
2745
|
+
* @param headers - map
|
|
2746
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2747
|
+
* @returns GetAgentCodePackageDownloadUrlResponse
|
|
2748
|
+
*/
|
|
2749
|
+
async getAgentCodePackageDownloadUrlWithOptions(workspaceId, agentId, request, headers, runtime) {
|
|
2750
|
+
request.validate();
|
|
2751
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
2752
|
+
headers: headers,
|
|
2753
|
+
});
|
|
2754
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
2755
|
+
action: "GetAgentCodePackageDownloadUrl",
|
|
2756
|
+
version: "2026-08-04",
|
|
2757
|
+
protocol: "HTTPS",
|
|
2758
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/custom-agents/${$dara.URL.percentEncode(agentId)}/code-package/download-url`,
|
|
2759
|
+
method: "GET",
|
|
2760
|
+
authType: "AK",
|
|
2761
|
+
style: "ROA",
|
|
2762
|
+
reqBodyType: "json",
|
|
2763
|
+
bodyType: "json",
|
|
2764
|
+
});
|
|
2765
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetAgentCodePackageDownloadUrlResponse({}));
|
|
2766
|
+
}
|
|
2767
|
+
/**
|
|
2768
|
+
* Retrieves the download URL for the saved code package of an agent.
|
|
2769
|
+
*
|
|
2770
|
+
* @remarks
|
|
2771
|
+
* Generates a time-limited, read-only download URL for the code package referenced by the currently saved agent configuration. This applies to code packages uploaded locally or imported from Object Storage Service (OSS). The operation uses workspaceId and agentId for locating and does not accept arbitrary bucket, object key, or historical version parameters. The current configuration must reference an available, fixed code package, and does not require waiting for a running instance to be ready. An error is returned if the code package does not exist, has changed, or is unreadable. The link is valid for up to 10 minutes and does not exceed the underlying credential expiration time. Call the operation again after it expires. The resourceVersionId indicates the saved configuration version corresponding to this download. The sample download link is redacted. Use the downloadUrl in the response.
|
|
2772
|
+
*
|
|
2773
|
+
* @param request - GetAgentCodePackageDownloadUrlRequest
|
|
2774
|
+
* @returns GetAgentCodePackageDownloadUrlResponse
|
|
2775
|
+
*/
|
|
2776
|
+
async getAgentCodePackageDownloadUrl(workspaceId, agentId, request) {
|
|
2777
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
2778
|
+
let headers = {};
|
|
2779
|
+
return await this.getAgentCodePackageDownloadUrlWithOptions(workspaceId, agentId, request, headers, runtime);
|
|
2780
|
+
}
|
|
2781
|
+
/**
|
|
2782
|
+
* Retrieves the OSS RAM authorization URL for the agent code package.
|
|
2783
|
+
*
|
|
2784
|
+
* @remarks
|
|
2785
|
+
* Generates a RAM authorization URL for the resource role of the current workspace for a specified source bucket. The client cannot specify or override the role. After you open the authorizeUrl and confirm the authorization, call VerifyAgentCodePackageOssRamAuthorization to check the policy binding, and call ValidateAgentCodePackageFromOss to check specific objects.
|
|
2786
|
+
* This authorization reuses the OSSObjectRestoreCustom template, which includes permissions to read, write, and delete objects, and is not a read-only authorization. Retrieving the URL itself does not complete the authorization, transfer the code package, or modify the default OSS binding of the workspace. Existing authorizations for the same role and bucket can be reused. The example URL is provided to demonstrate the format. Use the actual authorization URL returned by the API operation.
|
|
2787
|
+
*
|
|
2788
|
+
* @param request - GetAgentCodePackageOssRamAuthorizeUrlRequest
|
|
2789
|
+
* @param headers - map
|
|
2790
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2791
|
+
* @returns GetAgentCodePackageOssRamAuthorizeUrlResponse
|
|
2792
|
+
*/
|
|
2793
|
+
async getAgentCodePackageOssRamAuthorizeUrlWithOptions(workspaceId, request, headers, runtime) {
|
|
2794
|
+
request.validate();
|
|
2795
|
+
let query = {};
|
|
2796
|
+
if (!$dara.isNull(request.ossBucketName)) {
|
|
2797
|
+
query["ossBucketName"] = request.ossBucketName;
|
|
2798
|
+
}
|
|
2799
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
2800
|
+
headers: headers,
|
|
2801
|
+
query: openapi_core_2.OpenApiUtil.query(query),
|
|
2802
|
+
});
|
|
2803
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
2804
|
+
action: "GetAgentCodePackageOssRamAuthorizeUrl",
|
|
2805
|
+
version: "2026-08-04",
|
|
2806
|
+
protocol: "HTTPS",
|
|
2807
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/agent-code-packages/oss/authorize`,
|
|
2808
|
+
method: "GET",
|
|
2809
|
+
authType: "AK",
|
|
2810
|
+
style: "ROA",
|
|
2811
|
+
reqBodyType: "json",
|
|
2812
|
+
bodyType: "json",
|
|
2813
|
+
});
|
|
2814
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetAgentCodePackageOssRamAuthorizeUrlResponse({}));
|
|
2815
|
+
}
|
|
2816
|
+
/**
|
|
2817
|
+
* Retrieves the OSS RAM authorization URL for the agent code package.
|
|
2818
|
+
*
|
|
2819
|
+
* @remarks
|
|
2820
|
+
* Generates a RAM authorization URL for the resource role of the current workspace for a specified source bucket. The client cannot specify or override the role. After you open the authorizeUrl and confirm the authorization, call VerifyAgentCodePackageOssRamAuthorization to check the policy binding, and call ValidateAgentCodePackageFromOss to check specific objects.
|
|
2821
|
+
* This authorization reuses the OSSObjectRestoreCustom template, which includes permissions to read, write, and delete objects, and is not a read-only authorization. Retrieving the URL itself does not complete the authorization, transfer the code package, or modify the default OSS binding of the workspace. Existing authorizations for the same role and bucket can be reused. The example URL is provided to demonstrate the format. Use the actual authorization URL returned by the API operation.
|
|
2822
|
+
*
|
|
2823
|
+
* @param request - GetAgentCodePackageOssRamAuthorizeUrlRequest
|
|
2824
|
+
* @returns GetAgentCodePackageOssRamAuthorizeUrlResponse
|
|
2825
|
+
*/
|
|
2826
|
+
async getAgentCodePackageOssRamAuthorizeUrl(workspaceId, request) {
|
|
2827
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
2828
|
+
let headers = {};
|
|
2829
|
+
return await this.getAgentCodePackageOssRamAuthorizeUrlWithOptions(workspaceId, request, headers, runtime);
|
|
2830
|
+
}
|
|
2831
|
+
/**
|
|
2832
|
+
* Retrieves the upload URL for an agent code package.
|
|
2833
|
+
*
|
|
2834
|
+
* @remarks
|
|
2835
|
+
* Retrieves a time-limited upload URL for a code package without uploading the file content. The fileName must be a ZIP or TAR.GZ filename without directories. The format must match the file extension. The fileSize is in bytes, with valid values ranging from 1 to 500,000,000.
|
|
2836
|
+
* Use the uploadMethod, uploadUrl, and headers from the response to upload the file directly. After the upload is complete, pass the sourceUri to the artifact.code.sourceUri parameter of CreateCustomAgent or UpdateCustomAgent. The actual object and size are verified and a fixed copy is saved during creation or update. The upload URL is valid for up to 10 minutes and does not exceed the expiration time of the underlying temporary credentials. Retrieve a new URL after it expires. The example URL is desensitized and cannot be used for actual uploads. Use the original URL and request headers from this response.
|
|
2837
|
+
*
|
|
2838
|
+
* @param tmpReq - GetAgentCodePackageUploadUrlRequest
|
|
2839
|
+
* @param headers - map
|
|
2840
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2841
|
+
* @returns GetAgentCodePackageUploadUrlResponse
|
|
2842
|
+
*/
|
|
2843
|
+
async getAgentCodePackageUploadUrlWithOptions(workspaceId, tmpReq, headers, runtime) {
|
|
2844
|
+
tmpReq.validate();
|
|
2845
|
+
let request = new $_model.GetAgentCodePackageUploadUrlShrinkRequest({});
|
|
2846
|
+
openapi_core_2.OpenApiUtil.convert(tmpReq, request);
|
|
2847
|
+
if (!$dara.isNull(tmpReq.body)) {
|
|
2848
|
+
request.bodyShrink = openapi_core_2.OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.body, "body", "json");
|
|
2849
|
+
}
|
|
2850
|
+
let body = {};
|
|
2851
|
+
if (!$dara.isNull(request.bodyShrink)) {
|
|
2852
|
+
body["body"] = request.bodyShrink;
|
|
2853
|
+
}
|
|
2854
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
2855
|
+
headers: headers,
|
|
2856
|
+
body: openapi_core_2.OpenApiUtil.parseToMap(body),
|
|
2857
|
+
});
|
|
2858
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
2859
|
+
action: "GetAgentCodePackageUploadUrl",
|
|
2860
|
+
version: "2026-08-04",
|
|
2861
|
+
protocol: "HTTPS",
|
|
2862
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/agent-code-packages/upload-url`,
|
|
2863
|
+
method: "POST",
|
|
2864
|
+
authType: "AK",
|
|
2865
|
+
style: "ROA",
|
|
2866
|
+
reqBodyType: "formData",
|
|
2867
|
+
bodyType: "json",
|
|
2868
|
+
});
|
|
2869
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetAgentCodePackageUploadUrlResponse({}));
|
|
2870
|
+
}
|
|
2871
|
+
/**
|
|
2872
|
+
* Retrieves the upload URL for an agent code package.
|
|
2873
|
+
*
|
|
2874
|
+
* @remarks
|
|
2875
|
+
* Retrieves a time-limited upload URL for a code package without uploading the file content. The fileName must be a ZIP or TAR.GZ filename without directories. The format must match the file extension. The fileSize is in bytes, with valid values ranging from 1 to 500,000,000.
|
|
2876
|
+
* Use the uploadMethod, uploadUrl, and headers from the response to upload the file directly. After the upload is complete, pass the sourceUri to the artifact.code.sourceUri parameter of CreateCustomAgent or UpdateCustomAgent. The actual object and size are verified and a fixed copy is saved during creation or update. The upload URL is valid for up to 10 minutes and does not exceed the expiration time of the underlying temporary credentials. Retrieve a new URL after it expires. The example URL is desensitized and cannot be used for actual uploads. Use the original URL and request headers from this response.
|
|
2877
|
+
*
|
|
2878
|
+
* @param request - GetAgentCodePackageUploadUrlRequest
|
|
2879
|
+
* @returns GetAgentCodePackageUploadUrlResponse
|
|
2880
|
+
*/
|
|
2881
|
+
async getAgentCodePackageUploadUrl(workspaceId, request) {
|
|
2882
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
2883
|
+
let headers = {};
|
|
2884
|
+
return await this.getAgentCodePackageUploadUrlWithOptions(workspaceId, request, headers, runtime);
|
|
2885
|
+
}
|
|
2401
2886
|
/**
|
|
2402
2887
|
* Queries the details of a specified agent IM channel.
|
|
2403
2888
|
*
|
|
@@ -2673,8 +3158,8 @@ class Client extends openapi_core_1.default {
|
|
|
2673
3158
|
* Queries the details of a custom agent in a specified workspace, including deployment configurations, the execute status of the latest configuration version, and the running instance status statistics.
|
|
2674
3159
|
*
|
|
2675
3160
|
* @remarks
|
|
2676
|
-
* After
|
|
2677
|
-
* The returned configuration is the
|
|
3161
|
+
* After creating or updating a custom agent, you can poll this operation to query the execution result of the latest configuration version. latestVersionStatus corresponds to latestSpecVersion. latestExecutionError indicates the cause of the pending or failed status for this version. If retryable is true, you can query again later.
|
|
3162
|
+
* The returned configuration is the latest submitted configuration and may not have taken effect. Verify the deployment and running status by checking latestVersionStatus, the overall agent status, and the running instance statistics sandboxPhaseCounts.
|
|
2678
3163
|
* If the queried custom agent does not exist, has been deleted, or does not belong to the specified workspace, a resource not found error is returned.
|
|
2679
3164
|
*
|
|
2680
3165
|
* @param request - GetCustomAgentRequest
|
|
@@ -2704,8 +3189,8 @@ class Client extends openapi_core_1.default {
|
|
|
2704
3189
|
* Queries the details of a custom agent in a specified workspace, including deployment configurations, the execute status of the latest configuration version, and the running instance status statistics.
|
|
2705
3190
|
*
|
|
2706
3191
|
* @remarks
|
|
2707
|
-
* After
|
|
2708
|
-
* The returned configuration is the
|
|
3192
|
+
* After creating or updating a custom agent, you can poll this operation to query the execution result of the latest configuration version. latestVersionStatus corresponds to latestSpecVersion. latestExecutionError indicates the cause of the pending or failed status for this version. If retryable is true, you can query again later.
|
|
3193
|
+
* The returned configuration is the latest submitted configuration and may not have taken effect. Verify the deployment and running status by checking latestVersionStatus, the overall agent status, and the running instance statistics sandboxPhaseCounts.
|
|
2709
3194
|
* If the queried custom agent does not exist, has been deleted, or does not belong to the specified workspace, a resource not found error is returned.
|
|
2710
3195
|
*
|
|
2711
3196
|
* @param request - GetCustomAgentRequest
|
|
@@ -2803,7 +3288,35 @@ class Client extends openapi_core_1.default {
|
|
|
2803
3288
|
return await this.getExternalAgentBootstrapOptionsWithOptions(workspaceId, agentId, request, headers, runtime);
|
|
2804
3289
|
}
|
|
2805
3290
|
/**
|
|
2806
|
-
* Queries the binding
|
|
3291
|
+
* 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.
|
|
3292
|
+
*
|
|
3293
|
+
* @remarks
|
|
3294
|
+
* ## Features and prerequisites
|
|
3295
|
+
* 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.
|
|
3296
|
+
* 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.
|
|
3297
|
+
* ## Request and examples
|
|
3298
|
+
* GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
3299
|
+
* 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.
|
|
3300
|
+
* ```text
|
|
3301
|
+
* GET /workspaces/ws-example/identity-providers/CustomSSO
|
|
3302
|
+
* ```
|
|
3303
|
+
* ## Response examples
|
|
3304
|
+
* ```json
|
|
3305
|
+
* {
|
|
3306
|
+
* "data": {
|
|
3307
|
+
* "workspaceId": "ws-example",
|
|
3308
|
+
* "identityProviderType": "CustomSSO",
|
|
3309
|
+
* "status": "READY",
|
|
3310
|
+
* "loginEnabled": false,
|
|
3311
|
+
* "syncEnabled": false
|
|
3312
|
+
* }
|
|
3313
|
+
* }
|
|
3314
|
+
* ```
|
|
3315
|
+
* ## Errors and handling
|
|
3316
|
+
* 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.
|
|
3317
|
+
* 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.
|
|
3318
|
+
* ## Call relationships and usage boundaries
|
|
3319
|
+
* 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.
|
|
2807
3320
|
*
|
|
2808
3321
|
* @param request - GetIdentityProviderRequest
|
|
2809
3322
|
* @param headers - map
|
|
@@ -2829,7 +3342,35 @@ class Client extends openapi_core_1.default {
|
|
|
2829
3342
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetIdentityProviderResponse({}));
|
|
2830
3343
|
}
|
|
2831
3344
|
/**
|
|
2832
|
-
* Queries the binding
|
|
3345
|
+
* 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.
|
|
3346
|
+
*
|
|
3347
|
+
* @remarks
|
|
3348
|
+
* ## Features and prerequisites
|
|
3349
|
+
* 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.
|
|
3350
|
+
* 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.
|
|
3351
|
+
* ## Request and examples
|
|
3352
|
+
* GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}
|
|
3353
|
+
* 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.
|
|
3354
|
+
* ```text
|
|
3355
|
+
* GET /workspaces/ws-example/identity-providers/CustomSSO
|
|
3356
|
+
* ```
|
|
3357
|
+
* ## Response examples
|
|
3358
|
+
* ```json
|
|
3359
|
+
* {
|
|
3360
|
+
* "data": {
|
|
3361
|
+
* "workspaceId": "ws-example",
|
|
3362
|
+
* "identityProviderType": "CustomSSO",
|
|
3363
|
+
* "status": "READY",
|
|
3364
|
+
* "loginEnabled": false,
|
|
3365
|
+
* "syncEnabled": false
|
|
3366
|
+
* }
|
|
3367
|
+
* }
|
|
3368
|
+
* ```
|
|
3369
|
+
* ## Errors and handling
|
|
3370
|
+
* 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.
|
|
3371
|
+
* 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.
|
|
3372
|
+
* ## Call relationships and usage boundaries
|
|
3373
|
+
* 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.
|
|
2833
3374
|
*
|
|
2834
3375
|
* @param request - GetIdentityProviderRequest
|
|
2835
3376
|
* @returns GetIdentityProviderResponse
|
|
@@ -2839,6 +3380,337 @@ class Client extends openapi_core_1.default {
|
|
|
2839
3380
|
let headers = {};
|
|
2840
3381
|
return await this.getIdentityProviderWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
2841
3382
|
}
|
|
3383
|
+
/**
|
|
3384
|
+
* 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.
|
|
3385
|
+
*
|
|
3386
|
+
* @remarks
|
|
3387
|
+
* ## Features and prerequisites
|
|
3388
|
+
* 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.
|
|
3389
|
+
* 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.
|
|
3390
|
+
* ## Requests and examples
|
|
3391
|
+
* GET /workspaces/{workspaceId}/scim-provisioning
|
|
3392
|
+
* 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.
|
|
3393
|
+
* ```text
|
|
3394
|
+
* GET /workspaces/ws-example/scim-provisioning
|
|
3395
|
+
* ```
|
|
3396
|
+
* ## Response example
|
|
3397
|
+
* ```json
|
|
3398
|
+
* {
|
|
3399
|
+
* "data": {
|
|
3400
|
+
* "configuration": {
|
|
3401
|
+
* "status": "Enabled",
|
|
3402
|
+
* "baseUrl": "https://example.com/scim/v2"
|
|
3403
|
+
* },
|
|
3404
|
+
* "syncEnabled": true,
|
|
3405
|
+
* "operationStatus": "SUCCESS"
|
|
3406
|
+
* }
|
|
3407
|
+
* }
|
|
3408
|
+
* ```
|
|
3409
|
+
* ## Errors and handling
|
|
3410
|
+
* 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.
|
|
3411
|
+
* 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.
|
|
3412
|
+
* ## Call relationships and usage boundaries
|
|
3413
|
+
* 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.
|
|
3414
|
+
*
|
|
3415
|
+
* @param request - GetIdentityProviderSCIMRequest
|
|
3416
|
+
* @param headers - map
|
|
3417
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3418
|
+
* @returns GetIdentityProviderSCIMResponse
|
|
3419
|
+
*/
|
|
3420
|
+
async getIdentityProviderSCIMWithOptions(workspaceId, request, headers, runtime) {
|
|
3421
|
+
request.validate();
|
|
3422
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
3423
|
+
headers: headers,
|
|
3424
|
+
});
|
|
3425
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
3426
|
+
action: "GetIdentityProviderSCIM",
|
|
3427
|
+
version: "2026-08-04",
|
|
3428
|
+
protocol: "HTTPS",
|
|
3429
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/scim-provisioning`,
|
|
3430
|
+
method: "GET",
|
|
3431
|
+
authType: "AK",
|
|
3432
|
+
style: "ROA",
|
|
3433
|
+
reqBodyType: "json",
|
|
3434
|
+
bodyType: "json",
|
|
3435
|
+
});
|
|
3436
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetIdentityProviderSCIMResponse({}));
|
|
3437
|
+
}
|
|
3438
|
+
/**
|
|
3439
|
+
* 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.
|
|
3440
|
+
*
|
|
3441
|
+
* @remarks
|
|
3442
|
+
* ## Features and prerequisites
|
|
3443
|
+
* 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.
|
|
3444
|
+
* 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.
|
|
3445
|
+
* ## Requests and examples
|
|
3446
|
+
* GET /workspaces/{workspaceId}/scim-provisioning
|
|
3447
|
+
* 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.
|
|
3448
|
+
* ```text
|
|
3449
|
+
* GET /workspaces/ws-example/scim-provisioning
|
|
3450
|
+
* ```
|
|
3451
|
+
* ## Response example
|
|
3452
|
+
* ```json
|
|
3453
|
+
* {
|
|
3454
|
+
* "data": {
|
|
3455
|
+
* "configuration": {
|
|
3456
|
+
* "status": "Enabled",
|
|
3457
|
+
* "baseUrl": "https://example.com/scim/v2"
|
|
3458
|
+
* },
|
|
3459
|
+
* "syncEnabled": true,
|
|
3460
|
+
* "operationStatus": "SUCCESS"
|
|
3461
|
+
* }
|
|
3462
|
+
* }
|
|
3463
|
+
* ```
|
|
3464
|
+
* ## Errors and handling
|
|
3465
|
+
* 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.
|
|
3466
|
+
* 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.
|
|
3467
|
+
* ## Call relationships and usage boundaries
|
|
3468
|
+
* 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.
|
|
3469
|
+
*
|
|
3470
|
+
* @param request - GetIdentityProviderSCIMRequest
|
|
3471
|
+
* @returns GetIdentityProviderSCIMResponse
|
|
3472
|
+
*/
|
|
3473
|
+
async getIdentityProviderSCIM(workspaceId, request) {
|
|
3474
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
3475
|
+
let headers = {};
|
|
3476
|
+
return await this.getIdentityProviderSCIMWithOptions(workspaceId, request, headers, runtime);
|
|
3477
|
+
}
|
|
3478
|
+
/**
|
|
3479
|
+
* 查询 SAML 服务提供商信息
|
|
3480
|
+
*
|
|
3481
|
+
* @remarks
|
|
3482
|
+
* ## 功能与前提\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 配置或验证登录。
|
|
3483
|
+
*
|
|
3484
|
+
* @param request - GetIdentityProviderServiceProviderRequest
|
|
3485
|
+
* @param headers - map
|
|
3486
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3487
|
+
* @returns GetIdentityProviderServiceProviderResponse
|
|
3488
|
+
*/
|
|
3489
|
+
async getIdentityProviderServiceProviderWithOptions(workspaceId, identityProviderType, request, headers, runtime) {
|
|
3490
|
+
request.validate();
|
|
3491
|
+
let query = {};
|
|
3492
|
+
if (!$dara.isNull(request.protocol)) {
|
|
3493
|
+
query["protocol"] = request.protocol;
|
|
3494
|
+
}
|
|
3495
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
3496
|
+
headers: headers,
|
|
3497
|
+
query: openapi_core_2.OpenApiUtil.query(query),
|
|
3498
|
+
});
|
|
3499
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
3500
|
+
action: "GetIdentityProviderServiceProvider",
|
|
3501
|
+
version: "2026-08-04",
|
|
3502
|
+
protocol: "HTTPS",
|
|
3503
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/identity-providers/${$dara.URL.percentEncode(identityProviderType)}/service-provider`,
|
|
3504
|
+
method: "GET",
|
|
3505
|
+
authType: "AK",
|
|
3506
|
+
style: "ROA",
|
|
3507
|
+
reqBodyType: "json",
|
|
3508
|
+
bodyType: "json",
|
|
3509
|
+
});
|
|
3510
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetIdentityProviderServiceProviderResponse({}));
|
|
3511
|
+
}
|
|
3512
|
+
/**
|
|
3513
|
+
* 查询 SAML 服务提供商信息
|
|
3514
|
+
*
|
|
3515
|
+
* @remarks
|
|
3516
|
+
* ## 功能与前提\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 配置或验证登录。
|
|
3517
|
+
*
|
|
3518
|
+
* @param request - GetIdentityProviderServiceProviderRequest
|
|
3519
|
+
* @returns GetIdentityProviderServiceProviderResponse
|
|
3520
|
+
*/
|
|
3521
|
+
async getIdentityProviderServiceProvider(workspaceId, identityProviderType, request) {
|
|
3522
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
3523
|
+
let headers = {};
|
|
3524
|
+
return await this.getIdentityProviderServiceProviderWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
3525
|
+
}
|
|
3526
|
+
/**
|
|
3527
|
+
* Queries an identity provider synchronization task.
|
|
3528
|
+
*
|
|
3529
|
+
* @remarks
|
|
3530
|
+
* Queries the status, current step, number of processed users, and failure cause of a manual synchronization task by using the local taskId of AgentCore. The taskId must be obtained from CreateIdentityProviderSyncJob in the same workspace and identity provider. It is not the synchronizationJobId of AgentIdentity. Poll the task until the status is SUCCESS, FAILED, or CANCELED. The PENDING, RUNNING, and PAUSED statuses do not indicate completion. The syncedUserCount includes updated existing users and does not equal the number of newly added users or the progress percentage.
|
|
3531
|
+
* Authorization information: The RAM operation is agentcore:GetIdentityProviderSyncJob, the access level is Read, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is a required authorization resource.
|
|
3532
|
+
* Idempotence and retry: This operation is read-only and can be repeatedly queried.
|
|
3533
|
+
* Calling this API operation is free of charge, and operation records support ActionTrail auditing.
|
|
3534
|
+
* Response example:
|
|
3535
|
+
* ```json
|
|
3536
|
+
* {
|
|
3537
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
3538
|
+
* "message": "success",
|
|
3539
|
+
* "httpStatusCode": 200,
|
|
3540
|
+
* "code": "SUCCESS",
|
|
3541
|
+
* "success": true,
|
|
3542
|
+
* "data": {
|
|
3543
|
+
* "taskId": "12345678-1234-4234-8234-123456789abc",
|
|
3544
|
+
* "status": "SUCCESS",
|
|
3545
|
+
* "currentStep": "SYNC",
|
|
3546
|
+
* "synchronizationJobId": "syncjob_0123456789abcdef0123456789abcdef",
|
|
3547
|
+
* "syncedUserCount": 12
|
|
3548
|
+
* }
|
|
3549
|
+
* }
|
|
3550
|
+
* ```
|
|
3551
|
+
*
|
|
3552
|
+
* @param request - GetIdentityProviderSyncJobRequest
|
|
3553
|
+
* @param headers - map
|
|
3554
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3555
|
+
* @returns GetIdentityProviderSyncJobResponse
|
|
3556
|
+
*/
|
|
3557
|
+
async getIdentityProviderSyncJobWithOptions(workspaceId, identityProviderType, taskId, request, headers, runtime) {
|
|
3558
|
+
request.validate();
|
|
3559
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
3560
|
+
headers: headers,
|
|
3561
|
+
});
|
|
3562
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
3563
|
+
action: "GetIdentityProviderSyncJob",
|
|
3564
|
+
version: "2026-08-04",
|
|
3565
|
+
protocol: "HTTPS",
|
|
3566
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/identity-providers/${$dara.URL.percentEncode(identityProviderType)}/sync-jobs/${$dara.URL.percentEncode(taskId)}`,
|
|
3567
|
+
method: "GET",
|
|
3568
|
+
authType: "AK",
|
|
3569
|
+
style: "ROA",
|
|
3570
|
+
reqBodyType: "json",
|
|
3571
|
+
bodyType: "json",
|
|
3572
|
+
});
|
|
3573
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetIdentityProviderSyncJobResponse({}));
|
|
3574
|
+
}
|
|
3575
|
+
/**
|
|
3576
|
+
* Queries an identity provider synchronization task.
|
|
3577
|
+
*
|
|
3578
|
+
* @remarks
|
|
3579
|
+
* Queries the status, current step, number of processed users, and failure cause of a manual synchronization task by using the local taskId of AgentCore. The taskId must be obtained from CreateIdentityProviderSyncJob in the same workspace and identity provider. It is not the synchronizationJobId of AgentIdentity. Poll the task until the status is SUCCESS, FAILED, or CANCELED. The PENDING, RUNNING, and PAUSED statuses do not indicate completion. The syncedUserCount includes updated existing users and does not equal the number of newly added users or the progress percentage.
|
|
3580
|
+
* Authorization information: The RAM operation is agentcore:GetIdentityProviderSyncJob, the access level is Read, and the resource ARN is acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is a required authorization resource.
|
|
3581
|
+
* Idempotence and retry: This operation is read-only and can be repeatedly queried.
|
|
3582
|
+
* Calling this API operation is free of charge, and operation records support ActionTrail auditing.
|
|
3583
|
+
* Response example:
|
|
3584
|
+
* ```json
|
|
3585
|
+
* {
|
|
3586
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
3587
|
+
* "message": "success",
|
|
3588
|
+
* "httpStatusCode": 200,
|
|
3589
|
+
* "code": "SUCCESS",
|
|
3590
|
+
* "success": true,
|
|
3591
|
+
* "data": {
|
|
3592
|
+
* "taskId": "12345678-1234-4234-8234-123456789abc",
|
|
3593
|
+
* "status": "SUCCESS",
|
|
3594
|
+
* "currentStep": "SYNC",
|
|
3595
|
+
* "synchronizationJobId": "syncjob_0123456789abcdef0123456789abcdef",
|
|
3596
|
+
* "syncedUserCount": 12
|
|
3597
|
+
* }
|
|
3598
|
+
* }
|
|
3599
|
+
* ```
|
|
3600
|
+
*
|
|
3601
|
+
* @param request - GetIdentityProviderSyncJobRequest
|
|
3602
|
+
* @returns GetIdentityProviderSyncJobResponse
|
|
3603
|
+
*/
|
|
3604
|
+
async getIdentityProviderSyncJob(workspaceId, identityProviderType, taskId, request) {
|
|
3605
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
3606
|
+
let headers = {};
|
|
3607
|
+
return await this.getIdentityProviderSyncJobWithOptions(workspaceId, identityProviderType, taskId, request, headers, runtime);
|
|
3608
|
+
}
|
|
3609
|
+
/**
|
|
3610
|
+
* Queries the synchronization scope of an identity provider.
|
|
3611
|
+
*
|
|
3612
|
+
* @remarks
|
|
3613
|
+
* Queries the saved synchronization scope, the validity of selected departments, and the estimated user count downstream of the identity provider. This operation is not used for real-time estimation of unsaved selections. AllAuthorized indicates the address book scope authorized for the application, which is not equivalent to the entire enterprise organization. An empty selectedDepartments array does not prove that the organization has no sub-departments. The estimation can be used only when estimateStatus is Ready and a count is returned. A missing count does not indicate 0.
|
|
3614
|
+
* Authorization information: RAM operation agentcore:GetIdentityProviderSyncScope, access level Read, resource ARN: acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is a required authorization resource.
|
|
3615
|
+
* Idempotence and retry: This operation is read-only and can be queried repeatedly.
|
|
3616
|
+
* Calling this API operation is free of charge. Operation records support ActionTrail auditing.
|
|
3617
|
+
* Sample response:
|
|
3618
|
+
* ```json
|
|
3619
|
+
* {
|
|
3620
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
3621
|
+
* "message": "success",
|
|
3622
|
+
* "httpStatusCode": 200,
|
|
3623
|
+
* "code": "SUCCESS",
|
|
3624
|
+
* "success": true,
|
|
3625
|
+
* "data": {
|
|
3626
|
+
* "syncScope": {
|
|
3627
|
+
* "mode": "SelectedDepartments",
|
|
3628
|
+
* "departmentIds": [
|
|
3629
|
+
* "10001"
|
|
3630
|
+
* ]
|
|
3631
|
+
* },
|
|
3632
|
+
* "selectedDepartments": [
|
|
3633
|
+
* {
|
|
3634
|
+
* "id": "10001",
|
|
3635
|
+
* "name": "R&D Department",
|
|
3636
|
+
* "exists": true
|
|
3637
|
+
* }
|
|
3638
|
+
* ],
|
|
3639
|
+
* "estimateStatus": "Ready",
|
|
3640
|
+
* "expandedDepartmentCount": 2,
|
|
3641
|
+
* "estimatedUserCount": 12
|
|
3642
|
+
* }
|
|
3643
|
+
* }
|
|
3644
|
+
* ```
|
|
3645
|
+
*
|
|
3646
|
+
* @param request - GetIdentityProviderSyncScopeRequest
|
|
3647
|
+
* @param headers - map
|
|
3648
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3649
|
+
* @returns GetIdentityProviderSyncScopeResponse
|
|
3650
|
+
*/
|
|
3651
|
+
async getIdentityProviderSyncScopeWithOptions(workspaceId, identityProviderType, request, headers, runtime) {
|
|
3652
|
+
request.validate();
|
|
3653
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
3654
|
+
headers: headers,
|
|
3655
|
+
});
|
|
3656
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
3657
|
+
action: "GetIdentityProviderSyncScope",
|
|
3658
|
+
version: "2026-08-04",
|
|
3659
|
+
protocol: "HTTPS",
|
|
3660
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/identity-providers/${$dara.URL.percentEncode(identityProviderType)}/sync-scope`,
|
|
3661
|
+
method: "GET",
|
|
3662
|
+
authType: "AK",
|
|
3663
|
+
style: "ROA",
|
|
3664
|
+
reqBodyType: "json",
|
|
3665
|
+
bodyType: "json",
|
|
3666
|
+
});
|
|
3667
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetIdentityProviderSyncScopeResponse({}));
|
|
3668
|
+
}
|
|
3669
|
+
/**
|
|
3670
|
+
* Queries the synchronization scope of an identity provider.
|
|
3671
|
+
*
|
|
3672
|
+
* @remarks
|
|
3673
|
+
* Queries the saved synchronization scope, the validity of selected departments, and the estimated user count downstream of the identity provider. This operation is not used for real-time estimation of unsaved selections. AllAuthorized indicates the address book scope authorized for the application, which is not equivalent to the entire enterprise organization. An empty selectedDepartments array does not prove that the organization has no sub-departments. The estimation can be used only when estimateStatus is Ready and a count is returned. A missing count does not indicate 0.
|
|
3674
|
+
* Authorization information: RAM operation agentcore:GetIdentityProviderSyncScope, access level Read, resource ARN: acs:agentcore:{regionId}:{accountId}:workspace/{workspaceId}/identityProvider/{identityProviderType}. This resource is a required authorization resource.
|
|
3675
|
+
* Idempotence and retry: This operation is read-only and can be queried repeatedly.
|
|
3676
|
+
* Calling this API operation is free of charge. Operation records support ActionTrail auditing.
|
|
3677
|
+
* Sample response:
|
|
3678
|
+
* ```json
|
|
3679
|
+
* {
|
|
3680
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
3681
|
+
* "message": "success",
|
|
3682
|
+
* "httpStatusCode": 200,
|
|
3683
|
+
* "code": "SUCCESS",
|
|
3684
|
+
* "success": true,
|
|
3685
|
+
* "data": {
|
|
3686
|
+
* "syncScope": {
|
|
3687
|
+
* "mode": "SelectedDepartments",
|
|
3688
|
+
* "departmentIds": [
|
|
3689
|
+
* "10001"
|
|
3690
|
+
* ]
|
|
3691
|
+
* },
|
|
3692
|
+
* "selectedDepartments": [
|
|
3693
|
+
* {
|
|
3694
|
+
* "id": "10001",
|
|
3695
|
+
* "name": "R&D Department",
|
|
3696
|
+
* "exists": true
|
|
3697
|
+
* }
|
|
3698
|
+
* ],
|
|
3699
|
+
* "estimateStatus": "Ready",
|
|
3700
|
+
* "expandedDepartmentCount": 2,
|
|
3701
|
+
* "estimatedUserCount": 12
|
|
3702
|
+
* }
|
|
3703
|
+
* }
|
|
3704
|
+
* ```
|
|
3705
|
+
*
|
|
3706
|
+
* @param request - GetIdentityProviderSyncScopeRequest
|
|
3707
|
+
* @returns GetIdentityProviderSyncScopeResponse
|
|
3708
|
+
*/
|
|
3709
|
+
async getIdentityProviderSyncScope(workspaceId, identityProviderType, request) {
|
|
3710
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
3711
|
+
let headers = {};
|
|
3712
|
+
return await this.getIdentityProviderSyncScopeWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
3713
|
+
}
|
|
2842
3714
|
/**
|
|
2843
3715
|
* Queries the details of an image cache.
|
|
2844
3716
|
*
|
|
@@ -3831,6 +4703,59 @@ class Client extends openapi_core_1.default {
|
|
|
3831
4703
|
let headers = {};
|
|
3832
4704
|
return await this.installWorkspacePluginWithOptions(workspaceId, pluginName, request, headers, runtime);
|
|
3833
4705
|
}
|
|
4706
|
+
/**
|
|
4707
|
+
* Queries the runtime environments supported for code deployment.
|
|
4708
|
+
*
|
|
4709
|
+
* @remarks
|
|
4710
|
+
* Queries the directories in the current workspace that can be used to create code package agents or switch runtime environments. Runtime environments are dynamically provided based on the current version configuration, and internal image addresses are not returned.
|
|
4711
|
+
* If maxResults is omitted or set to 0, the default value is 10. If the value is greater than 100, it is processed as 100. Omit nextToken in the first request. For subsequent requests, use the token returned in the previous response as is, and keep the workspace unchanged. If a directory change invalidates the token, query from the first page again. An empty nextToken indicates that there are no more pages. Existing agents continue to use the saved images for restarts, scaling, and regular updates.
|
|
4712
|
+
*
|
|
4713
|
+
* @param request - ListAgentCodeRuntimesRequest
|
|
4714
|
+
* @param headers - map
|
|
4715
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
4716
|
+
* @returns ListAgentCodeRuntimesResponse
|
|
4717
|
+
*/
|
|
4718
|
+
async listAgentCodeRuntimesWithOptions(workspaceId, request, headers, runtime) {
|
|
4719
|
+
request.validate();
|
|
4720
|
+
let query = {};
|
|
4721
|
+
if (!$dara.isNull(request.maxResults)) {
|
|
4722
|
+
query["maxResults"] = request.maxResults;
|
|
4723
|
+
}
|
|
4724
|
+
if (!$dara.isNull(request.nextToken)) {
|
|
4725
|
+
query["nextToken"] = request.nextToken;
|
|
4726
|
+
}
|
|
4727
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
4728
|
+
headers: headers,
|
|
4729
|
+
query: openapi_core_2.OpenApiUtil.query(query),
|
|
4730
|
+
});
|
|
4731
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
4732
|
+
action: "ListAgentCodeRuntimes",
|
|
4733
|
+
version: "2026-08-04",
|
|
4734
|
+
protocol: "HTTPS",
|
|
4735
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/agent-code-runtimes`,
|
|
4736
|
+
method: "GET",
|
|
4737
|
+
authType: "AK",
|
|
4738
|
+
style: "ROA",
|
|
4739
|
+
reqBodyType: "json",
|
|
4740
|
+
bodyType: "json",
|
|
4741
|
+
});
|
|
4742
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListAgentCodeRuntimesResponse({}));
|
|
4743
|
+
}
|
|
4744
|
+
/**
|
|
4745
|
+
* Queries the runtime environments supported for code deployment.
|
|
4746
|
+
*
|
|
4747
|
+
* @remarks
|
|
4748
|
+
* Queries the directories in the current workspace that can be used to create code package agents or switch runtime environments. Runtime environments are dynamically provided based on the current version configuration, and internal image addresses are not returned.
|
|
4749
|
+
* If maxResults is omitted or set to 0, the default value is 10. If the value is greater than 100, it is processed as 100. Omit nextToken in the first request. For subsequent requests, use the token returned in the previous response as is, and keep the workspace unchanged. If a directory change invalidates the token, query from the first page again. An empty nextToken indicates that there are no more pages. Existing agents continue to use the saved images for restarts, scaling, and regular updates.
|
|
4750
|
+
*
|
|
4751
|
+
* @param request - ListAgentCodeRuntimesRequest
|
|
4752
|
+
* @returns ListAgentCodeRuntimesResponse
|
|
4753
|
+
*/
|
|
4754
|
+
async listAgentCodeRuntimes(workspaceId, request) {
|
|
4755
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
4756
|
+
let headers = {};
|
|
4757
|
+
return await this.listAgentCodeRuntimesWithOptions(workspaceId, request, headers, runtime);
|
|
4758
|
+
}
|
|
3834
4759
|
/**
|
|
3835
4760
|
* Queries the list of IM channels for a specified agent.
|
|
3836
4761
|
*
|
|
@@ -4175,12 +5100,12 @@ class Client extends openapi_core_1.default {
|
|
|
4175
5100
|
return await this.listCredentialsWithOptions(workspaceId, request, headers, runtime);
|
|
4176
5101
|
}
|
|
4177
5102
|
/**
|
|
4178
|
-
*
|
|
5103
|
+
* Performs a paged query for paging through the custom agent summary in a specified workspace. For the complete configuration and the latest execute results, call GetCustomAgent.
|
|
4179
5104
|
*
|
|
4180
5105
|
* @remarks
|
|
4181
|
-
* The default value of maxResults is 20
|
|
4182
|
-
* Omit nextToken in the first request.
|
|
4183
|
-
* This operation returns the summaries of the current page and does not return the complete deployment
|
|
5106
|
+
* The default value of maxResults is 20 and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
|
|
5107
|
+
* Omit nextToken in the first request. For subsequent requests, pass the nextToken returned in the previous response as is and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it. An empty token in the response indicates that there are no more pages.
|
|
5108
|
+
* This operation returns the summaries of the current page and does not return the complete deployment configurations or the execution errors of the latest version. To obtain this information, call GetCustomAgent by using the agentId in items.
|
|
4184
5109
|
*
|
|
4185
5110
|
* @param request - ListCustomAgentsRequest
|
|
4186
5111
|
* @param headers - map
|
|
@@ -4214,12 +5139,12 @@ class Client extends openapi_core_1.default {
|
|
|
4214
5139
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListCustomAgentsResponse({}));
|
|
4215
5140
|
}
|
|
4216
5141
|
/**
|
|
4217
|
-
*
|
|
5142
|
+
* Performs a paged query for paging through the custom agent summary in a specified workspace. For the complete configuration and the latest execute results, call GetCustomAgent.
|
|
4218
5143
|
*
|
|
4219
5144
|
* @remarks
|
|
4220
|
-
* The default value of maxResults is 20
|
|
4221
|
-
* Omit nextToken in the first request.
|
|
4222
|
-
* This operation returns the summaries of the current page and does not return the complete deployment
|
|
5145
|
+
* The default value of maxResults is 20 and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
|
|
5146
|
+
* Omit nextToken in the first request. For subsequent requests, pass the nextToken returned in the previous response as is and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it. An empty token in the response indicates that there are no more pages.
|
|
5147
|
+
* This operation returns the summaries of the current page and does not return the complete deployment configurations or the execution errors of the latest version. To obtain this information, call GetCustomAgent by using the agentId in items.
|
|
4223
5148
|
*
|
|
4224
5149
|
* @param request - ListCustomAgentsRequest
|
|
4225
5150
|
* @returns ListCustomAgentsResponse
|
|
@@ -4281,7 +5206,236 @@ class Client extends openapi_core_1.default {
|
|
|
4281
5206
|
return await this.listExternalAgentsWithOptions(workspaceId, request, headers, runtime);
|
|
4282
5207
|
}
|
|
4283
5208
|
/**
|
|
4284
|
-
* Queries the
|
|
5209
|
+
* Queries the departments of an identity provider by page.
|
|
5210
|
+
*
|
|
5211
|
+
* @remarks
|
|
5212
|
+
* 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.
|
|
5213
|
+
* 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.
|
|
5214
|
+
* Idempotence and retry: This operation is read-only and can be invoked repeatedly.
|
|
5215
|
+
* It is free of charge to invoke this API operation, and operation records support ActionTrail auditing.
|
|
5216
|
+
* Sample response:
|
|
5217
|
+
* ```json
|
|
5218
|
+
* {
|
|
5219
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
5220
|
+
* "message": "success",
|
|
5221
|
+
* "httpStatusCode": 200,
|
|
5222
|
+
* "code": "SUCCESS",
|
|
5223
|
+
* "success": true,
|
|
5224
|
+
* "maxResults": 50,
|
|
5225
|
+
* "nextToken": "",
|
|
5226
|
+
* "items": [
|
|
5227
|
+
* {
|
|
5228
|
+
* "id": "10001",
|
|
5229
|
+
* "name": "R&D Department",
|
|
5230
|
+
* "parentId": "1",
|
|
5231
|
+
* "memberCount": 12,
|
|
5232
|
+
* "hasChildren": true
|
|
5233
|
+
* }
|
|
5234
|
+
* ]
|
|
5235
|
+
* }
|
|
5236
|
+
* ```
|
|
5237
|
+
*
|
|
5238
|
+
* @param request - ListIdentityProviderDepartmentsRequest
|
|
5239
|
+
* @param headers - map
|
|
5240
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
5241
|
+
* @returns ListIdentityProviderDepartmentsResponse
|
|
5242
|
+
*/
|
|
5243
|
+
async listIdentityProviderDepartmentsWithOptions(workspaceId, identityProviderType, request, headers, runtime) {
|
|
5244
|
+
request.validate();
|
|
5245
|
+
let query = {};
|
|
5246
|
+
if (!$dara.isNull(request.maxResults)) {
|
|
5247
|
+
query["maxResults"] = request.maxResults;
|
|
5248
|
+
}
|
|
5249
|
+
if (!$dara.isNull(request.nextToken)) {
|
|
5250
|
+
query["nextToken"] = request.nextToken;
|
|
5251
|
+
}
|
|
5252
|
+
if (!$dara.isNull(request.parentDepartmentId)) {
|
|
5253
|
+
query["parentDepartmentId"] = request.parentDepartmentId;
|
|
5254
|
+
}
|
|
5255
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
5256
|
+
headers: headers,
|
|
5257
|
+
query: openapi_core_2.OpenApiUtil.query(query),
|
|
5258
|
+
});
|
|
5259
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
5260
|
+
action: "ListIdentityProviderDepartments",
|
|
5261
|
+
version: "2026-08-04",
|
|
5262
|
+
protocol: "HTTPS",
|
|
5263
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/identity-providers/${$dara.URL.percentEncode(identityProviderType)}/departments`,
|
|
5264
|
+
method: "GET",
|
|
5265
|
+
authType: "AK",
|
|
5266
|
+
style: "ROA",
|
|
5267
|
+
reqBodyType: "json",
|
|
5268
|
+
bodyType: "json",
|
|
5269
|
+
});
|
|
5270
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIdentityProviderDepartmentsResponse({}));
|
|
5271
|
+
}
|
|
5272
|
+
/**
|
|
5273
|
+
* Queries the departments of an identity provider by page.
|
|
5274
|
+
*
|
|
5275
|
+
* @remarks
|
|
5276
|
+
* 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.
|
|
5277
|
+
* 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.
|
|
5278
|
+
* Idempotence and retry: This operation is read-only and can be invoked repeatedly.
|
|
5279
|
+
* It is free of charge to invoke this API operation, and operation records support ActionTrail auditing.
|
|
5280
|
+
* Sample response:
|
|
5281
|
+
* ```json
|
|
5282
|
+
* {
|
|
5283
|
+
* "requestId": "01234567-89AB-CDEF-0123-456789ABCDEF",
|
|
5284
|
+
* "message": "success",
|
|
5285
|
+
* "httpStatusCode": 200,
|
|
5286
|
+
* "code": "SUCCESS",
|
|
5287
|
+
* "success": true,
|
|
5288
|
+
* "maxResults": 50,
|
|
5289
|
+
* "nextToken": "",
|
|
5290
|
+
* "items": [
|
|
5291
|
+
* {
|
|
5292
|
+
* "id": "10001",
|
|
5293
|
+
* "name": "R&D Department",
|
|
5294
|
+
* "parentId": "1",
|
|
5295
|
+
* "memberCount": 12,
|
|
5296
|
+
* "hasChildren": true
|
|
5297
|
+
* }
|
|
5298
|
+
* ]
|
|
5299
|
+
* }
|
|
5300
|
+
* ```
|
|
5301
|
+
*
|
|
5302
|
+
* @param request - ListIdentityProviderDepartmentsRequest
|
|
5303
|
+
* @returns ListIdentityProviderDepartmentsResponse
|
|
5304
|
+
*/
|
|
5305
|
+
async listIdentityProviderDepartments(workspaceId, identityProviderType, request) {
|
|
5306
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
5307
|
+
let headers = {};
|
|
5308
|
+
return await this.listIdentityProviderDepartmentsWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
5309
|
+
}
|
|
5310
|
+
/**
|
|
5311
|
+
* Queries the complete summary list of up to two SCIM credentials in the shared user pool, without returning plaintext tokens or supporting pagination.
|
|
5312
|
+
*
|
|
5313
|
+
* @remarks
|
|
5314
|
+
* ## Features and prerequisites
|
|
5315
|
+
* 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.
|
|
5316
|
+
* 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.
|
|
5317
|
+
* ## Requests and examples
|
|
5318
|
+
* GET /workspaces/{workspaceId}/scim-provisioning/credentials
|
|
5319
|
+
* 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.
|
|
5320
|
+
* ```text
|
|
5321
|
+
* GET /workspaces/ws-example/scim-provisioning/credentials
|
|
5322
|
+
* ```
|
|
5323
|
+
* ## Response examples
|
|
5324
|
+
* ```json
|
|
5325
|
+
* {
|
|
5326
|
+
* "data": [
|
|
5327
|
+
* {
|
|
5328
|
+
* "credentialId": "credential-example",
|
|
5329
|
+
* "status": "Enabled",
|
|
5330
|
+
* "createTime": "<Upstream creation time>",
|
|
5331
|
+
* "expireTime": "<Upstream expiration time>"
|
|
5332
|
+
* }
|
|
5333
|
+
* ]
|
|
5334
|
+
* }
|
|
5335
|
+
* ```
|
|
5336
|
+
* ## Errors and handling
|
|
5337
|
+
* 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.
|
|
5338
|
+
* 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.
|
|
5339
|
+
* ## Call relationships and usage boundaries
|
|
5340
|
+
* 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.
|
|
5341
|
+
*
|
|
5342
|
+
* @param request - ListIdentityProviderSCIMCredentialsRequest
|
|
5343
|
+
* @param headers - map
|
|
5344
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
5345
|
+
* @returns ListIdentityProviderSCIMCredentialsResponse
|
|
5346
|
+
*/
|
|
5347
|
+
async listIdentityProviderSCIMCredentialsWithOptions(workspaceId, request, headers, runtime) {
|
|
5348
|
+
request.validate();
|
|
5349
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
5350
|
+
headers: headers,
|
|
5351
|
+
});
|
|
5352
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
5353
|
+
action: "ListIdentityProviderSCIMCredentials",
|
|
5354
|
+
version: "2026-08-04",
|
|
5355
|
+
protocol: "HTTPS",
|
|
5356
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/scim-provisioning/credentials`,
|
|
5357
|
+
method: "GET",
|
|
5358
|
+
authType: "AK",
|
|
5359
|
+
style: "ROA",
|
|
5360
|
+
reqBodyType: "json",
|
|
5361
|
+
bodyType: "json",
|
|
5362
|
+
});
|
|
5363
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIdentityProviderSCIMCredentialsResponse({}));
|
|
5364
|
+
}
|
|
5365
|
+
/**
|
|
5366
|
+
* Queries the complete summary list of up to two SCIM credentials in the shared user pool, without returning plaintext tokens or supporting pagination.
|
|
5367
|
+
*
|
|
5368
|
+
* @remarks
|
|
5369
|
+
* ## Features and prerequisites
|
|
5370
|
+
* 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.
|
|
5371
|
+
* 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.
|
|
5372
|
+
* ## Requests and examples
|
|
5373
|
+
* GET /workspaces/{workspaceId}/scim-provisioning/credentials
|
|
5374
|
+
* 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.
|
|
5375
|
+
* ```text
|
|
5376
|
+
* GET /workspaces/ws-example/scim-provisioning/credentials
|
|
5377
|
+
* ```
|
|
5378
|
+
* ## Response examples
|
|
5379
|
+
* ```json
|
|
5380
|
+
* {
|
|
5381
|
+
* "data": [
|
|
5382
|
+
* {
|
|
5383
|
+
* "credentialId": "credential-example",
|
|
5384
|
+
* "status": "Enabled",
|
|
5385
|
+
* "createTime": "<Upstream creation time>",
|
|
5386
|
+
* "expireTime": "<Upstream expiration time>"
|
|
5387
|
+
* }
|
|
5388
|
+
* ]
|
|
5389
|
+
* }
|
|
5390
|
+
* ```
|
|
5391
|
+
* ## Errors and handling
|
|
5392
|
+
* 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.
|
|
5393
|
+
* 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.
|
|
5394
|
+
* ## Call relationships and usage boundaries
|
|
5395
|
+
* 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.
|
|
5396
|
+
*
|
|
5397
|
+
* @param request - ListIdentityProviderSCIMCredentialsRequest
|
|
5398
|
+
* @returns ListIdentityProviderSCIMCredentialsResponse
|
|
5399
|
+
*/
|
|
5400
|
+
async listIdentityProviderSCIMCredentials(workspaceId, request) {
|
|
5401
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
5402
|
+
let headers = {};
|
|
5403
|
+
return await this.listIdentityProviderSCIMCredentialsWithOptions(workspaceId, request, headers, runtime);
|
|
5404
|
+
}
|
|
5405
|
+
/**
|
|
5406
|
+
* 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.
|
|
5407
|
+
*
|
|
5408
|
+
* @remarks
|
|
5409
|
+
* ## Features and prerequisites
|
|
5410
|
+
* 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.
|
|
5411
|
+
* 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.
|
|
5412
|
+
* ## Requests and examples
|
|
5413
|
+
* GET /workspaces/{workspaceId}/identity-providers
|
|
5414
|
+
* 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.
|
|
5415
|
+
* ```text
|
|
5416
|
+
* GET /workspaces/ws-example/identity-providers?maxResults=10
|
|
5417
|
+
* ```
|
|
5418
|
+
* ## Response example
|
|
5419
|
+
* ```json
|
|
5420
|
+
* {
|
|
5421
|
+
* "items": [
|
|
5422
|
+
* {
|
|
5423
|
+
* "workspaceId": "ws-example",
|
|
5424
|
+
* "identityProviderType": "CustomSSO",
|
|
5425
|
+
* "status": "READY",
|
|
5426
|
+
* "loginEnabled": false,
|
|
5427
|
+
* "syncEnabled": false
|
|
5428
|
+
* }
|
|
5429
|
+
* ],
|
|
5430
|
+
* "maxResults": 10,
|
|
5431
|
+
* "totalCount": 1
|
|
5432
|
+
* }
|
|
5433
|
+
* ```
|
|
5434
|
+
* ## Errors and handling
|
|
5435
|
+
* 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.
|
|
5436
|
+
* 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.
|
|
5437
|
+
* ## Call relationships and usage boundaries
|
|
5438
|
+
* 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.
|
|
4285
5439
|
*
|
|
4286
5440
|
* @param request - ListIdentityProvidersRequest
|
|
4287
5441
|
* @param headers - map
|
|
@@ -4315,7 +5469,39 @@ class Client extends openapi_core_1.default {
|
|
|
4315
5469
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIdentityProvidersResponse({}));
|
|
4316
5470
|
}
|
|
4317
5471
|
/**
|
|
4318
|
-
* Queries the
|
|
5472
|
+
* 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.
|
|
5473
|
+
*
|
|
5474
|
+
* @remarks
|
|
5475
|
+
* ## Features and prerequisites
|
|
5476
|
+
* 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.
|
|
5477
|
+
* 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.
|
|
5478
|
+
* ## Requests and examples
|
|
5479
|
+
* GET /workspaces/{workspaceId}/identity-providers
|
|
5480
|
+
* 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.
|
|
5481
|
+
* ```text
|
|
5482
|
+
* GET /workspaces/ws-example/identity-providers?maxResults=10
|
|
5483
|
+
* ```
|
|
5484
|
+
* ## Response example
|
|
5485
|
+
* ```json
|
|
5486
|
+
* {
|
|
5487
|
+
* "items": [
|
|
5488
|
+
* {
|
|
5489
|
+
* "workspaceId": "ws-example",
|
|
5490
|
+
* "identityProviderType": "CustomSSO",
|
|
5491
|
+
* "status": "READY",
|
|
5492
|
+
* "loginEnabled": false,
|
|
5493
|
+
* "syncEnabled": false
|
|
5494
|
+
* }
|
|
5495
|
+
* ],
|
|
5496
|
+
* "maxResults": 10,
|
|
5497
|
+
* "totalCount": 1
|
|
5498
|
+
* }
|
|
5499
|
+
* ```
|
|
5500
|
+
* ## Errors and handling
|
|
5501
|
+
* 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.
|
|
5502
|
+
* 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.
|
|
5503
|
+
* ## Call relationships and usage boundaries
|
|
5504
|
+
* 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.
|
|
4319
5505
|
*
|
|
4320
5506
|
* @param request - ListIdentityProvidersRequest
|
|
4321
5507
|
* @returns ListIdentityProvidersResponse
|
|
@@ -4639,10 +5825,10 @@ class Client extends openapi_core_1.default {
|
|
|
4639
5825
|
return await this.listMcpsWithOptions(workspaceId, request, headers, runtime);
|
|
4640
5826
|
}
|
|
4641
5827
|
/**
|
|
4642
|
-
* Performs a paged query on long-term memory.
|
|
5828
|
+
* Performs a paged query on long-term memory records. The results can be filtered independently by user ID, agent ID, and session ID. Paging is supported.
|
|
4643
5829
|
*
|
|
4644
5830
|
* @remarks
|
|
4645
|
-
* Performs a paged query on long-term memory.
|
|
5831
|
+
* Performs a paged query on long-term memory records. The results can be filtered independently by user ID, agent ID, and session ID. Paging is supported.
|
|
4646
5832
|
*
|
|
4647
5833
|
* @param request - ListMemoriesRequest
|
|
4648
5834
|
* @param headers - map
|
|
@@ -4685,10 +5871,10 @@ class Client extends openapi_core_1.default {
|
|
|
4685
5871
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListMemoriesResponse({}));
|
|
4686
5872
|
}
|
|
4687
5873
|
/**
|
|
4688
|
-
* Performs a paged query on long-term memory.
|
|
5874
|
+
* Performs a paged query on long-term memory records. The results can be filtered independently by user ID, agent ID, and session ID. Paging is supported.
|
|
4689
5875
|
*
|
|
4690
5876
|
* @remarks
|
|
4691
|
-
* Performs a paged query on long-term memory.
|
|
5877
|
+
* Performs a paged query on long-term memory records. The results can be filtered independently by user ID, agent ID, and session ID. Paging is supported.
|
|
4692
5878
|
*
|
|
4693
5879
|
* @param request - ListMemoriesRequest
|
|
4694
5880
|
* @returns ListMemoriesResponse
|
|
@@ -4699,10 +5885,10 @@ class Client extends openapi_core_1.default {
|
|
|
4699
5885
|
return await this.listMemoriesWithOptions(workspaceId, memoryStoreName, request, headers, runtime);
|
|
4700
5886
|
}
|
|
4701
5887
|
/**
|
|
4702
|
-
* Performs a
|
|
5888
|
+
* Performs a paging query for raw messages by exact scope. SessionId is required, and at least one of UserId and AgentId must be provided.
|
|
4703
5889
|
*
|
|
4704
5890
|
* @remarks
|
|
4705
|
-
* Performs a
|
|
5891
|
+
* Performs a paging query for raw messages by exact scope. SessionId is required, and at least one of UserId and AgentId must be provided.
|
|
4706
5892
|
*
|
|
4707
5893
|
* @param request - ListMemorySessionMessagesRequest
|
|
4708
5894
|
* @param headers - map
|
|
@@ -4745,10 +5931,10 @@ class Client extends openapi_core_1.default {
|
|
|
4745
5931
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListMemorySessionMessagesResponse({}));
|
|
4746
5932
|
}
|
|
4747
5933
|
/**
|
|
4748
|
-
* Performs a
|
|
5934
|
+
* Performs a paging query for raw messages by exact scope. SessionId is required, and at least one of UserId and AgentId must be provided.
|
|
4749
5935
|
*
|
|
4750
5936
|
* @remarks
|
|
4751
|
-
* Performs a
|
|
5937
|
+
* Performs a paging query for raw messages by exact scope. SessionId is required, and at least one of UserId and AgentId must be provided.
|
|
4752
5938
|
*
|
|
4753
5939
|
* @param request - ListMemorySessionMessagesRequest
|
|
4754
5940
|
* @returns ListMemorySessionMessagesResponse
|
|
@@ -4759,10 +5945,10 @@ class Client extends openapi_core_1.default {
|
|
|
4759
5945
|
return await this.listMemorySessionMessagesWithOptions(workspaceId, memoryStoreName, request, headers, runtime);
|
|
4760
5946
|
}
|
|
4761
5947
|
/**
|
|
4762
|
-
* Performs a paging query for sessions in a MemoryStore
|
|
5948
|
+
* Performs a paging query for sessions in a MemoryStore. You can filter the sessions independently by user ID and agent ID.
|
|
4763
5949
|
*
|
|
4764
5950
|
* @remarks
|
|
4765
|
-
* Performs a paging query for sessions in a MemoryStore
|
|
5951
|
+
* Performs a paging query for sessions in a MemoryStore. You can filter the sessions independently by user ID and agent ID.
|
|
4766
5952
|
*
|
|
4767
5953
|
* @param request - ListMemorySessionsRequest
|
|
4768
5954
|
* @param headers - map
|
|
@@ -4802,10 +5988,10 @@ class Client extends openapi_core_1.default {
|
|
|
4802
5988
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListMemorySessionsResponse({}));
|
|
4803
5989
|
}
|
|
4804
5990
|
/**
|
|
4805
|
-
* Performs a paging query for sessions in a MemoryStore
|
|
5991
|
+
* Performs a paging query for sessions in a MemoryStore. You can filter the sessions independently by user ID and agent ID.
|
|
4806
5992
|
*
|
|
4807
5993
|
* @remarks
|
|
4808
|
-
* Performs a paging query for sessions in a MemoryStore
|
|
5994
|
+
* Performs a paging query for sessions in a MemoryStore. You can filter the sessions independently by user ID and agent ID.
|
|
4809
5995
|
*
|
|
4810
5996
|
* @param request - ListMemorySessionsRequest
|
|
4811
5997
|
* @returns ListMemorySessionsResponse
|
|
@@ -4816,10 +6002,10 @@ class Client extends openapi_core_1.default {
|
|
|
4816
6002
|
return await this.listMemorySessionsWithOptions(workspaceId, memoryStoreName, request, headers, runtime);
|
|
4817
6003
|
}
|
|
4818
6004
|
/**
|
|
4819
|
-
*
|
|
6005
|
+
* Performs a paged query for MemoryStores in a specified workspace with paging.
|
|
4820
6006
|
*
|
|
4821
6007
|
* @remarks
|
|
4822
|
-
*
|
|
6008
|
+
* Performs a paged query for MemoryStores in a specified workspace with paging.
|
|
4823
6009
|
*
|
|
4824
6010
|
* @param request - ListMemoryStoresRequest
|
|
4825
6011
|
* @param headers - map
|
|
@@ -4853,10 +6039,10 @@ class Client extends openapi_core_1.default {
|
|
|
4853
6039
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListMemoryStoresResponse({}));
|
|
4854
6040
|
}
|
|
4855
6041
|
/**
|
|
4856
|
-
*
|
|
6042
|
+
* Performs a paged query for MemoryStores in a specified workspace with paging.
|
|
4857
6043
|
*
|
|
4858
6044
|
* @remarks
|
|
4859
|
-
*
|
|
6045
|
+
* Performs a paged query for MemoryStores in a specified workspace with paging.
|
|
4860
6046
|
*
|
|
4861
6047
|
* @param request - ListMemoryStoresRequest
|
|
4862
6048
|
* @returns ListMemoryStoresResponse
|
|
@@ -5680,6 +6866,111 @@ class Client extends openapi_core_1.default {
|
|
|
5680
6866
|
let headers = {};
|
|
5681
6867
|
return await this.precheckSkillUploadViaOssWithOptions(workspaceId, request, headers, runtime);
|
|
5682
6868
|
}
|
|
6869
|
+
/**
|
|
6870
|
+
* 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.
|
|
6871
|
+
*
|
|
6872
|
+
* @remarks
|
|
6873
|
+
* ## Features and prerequisites
|
|
6874
|
+
* 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.
|
|
6875
|
+
* 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.
|
|
6876
|
+
* ## Requests and examples
|
|
6877
|
+
* POST /workspaces/{workspaceId}/scim-provisioning/prepare
|
|
6878
|
+
* 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.
|
|
6879
|
+
* ```text
|
|
6880
|
+
* POST /workspaces/ws-example/scim-provisioning/prepare
|
|
6881
|
+
* No business request body.
|
|
6882
|
+
* ```
|
|
6883
|
+
* ## Response examples
|
|
6884
|
+
* ```json
|
|
6885
|
+
* {
|
|
6886
|
+
* "data": {
|
|
6887
|
+
* "configuration": {
|
|
6888
|
+
* "status": "Enabled",
|
|
6889
|
+
* "baseUrl": "https://example.com/scim/v2"
|
|
6890
|
+
* },
|
|
6891
|
+
* "credential": {
|
|
6892
|
+
* "credentialId": "credential-example",
|
|
6893
|
+
* "status": "Enabled",
|
|
6894
|
+
* "expireTime": "<Expiration time returned by the upstream service>"
|
|
6895
|
+
* },
|
|
6896
|
+
* "token": "<Token issued only in the current response; null if an available credential already exists>"
|
|
6897
|
+
* }
|
|
6898
|
+
* }
|
|
6899
|
+
* ```
|
|
6900
|
+
* ## Errors and handling
|
|
6901
|
+
* 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.
|
|
6902
|
+
* 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.
|
|
6903
|
+
* ## Call relationships and usage boundaries
|
|
6904
|
+
* 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.
|
|
6905
|
+
*
|
|
6906
|
+
* @param request - PrepareIdentityProviderSCIMRequest
|
|
6907
|
+
* @param headers - map
|
|
6908
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
6909
|
+
* @returns PrepareIdentityProviderSCIMResponse
|
|
6910
|
+
*/
|
|
6911
|
+
async prepareIdentityProviderSCIMWithOptions(workspaceId, request, headers, runtime) {
|
|
6912
|
+
request.validate();
|
|
6913
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
6914
|
+
headers: headers,
|
|
6915
|
+
});
|
|
6916
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
6917
|
+
action: "PrepareIdentityProviderSCIM",
|
|
6918
|
+
version: "2026-08-04",
|
|
6919
|
+
protocol: "HTTPS",
|
|
6920
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/scim-provisioning/prepare`,
|
|
6921
|
+
method: "POST",
|
|
6922
|
+
authType: "AK",
|
|
6923
|
+
style: "ROA",
|
|
6924
|
+
reqBodyType: "json",
|
|
6925
|
+
bodyType: "json",
|
|
6926
|
+
});
|
|
6927
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.PrepareIdentityProviderSCIMResponse({}));
|
|
6928
|
+
}
|
|
6929
|
+
/**
|
|
6930
|
+
* 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.
|
|
6931
|
+
*
|
|
6932
|
+
* @remarks
|
|
6933
|
+
* ## Features and prerequisites
|
|
6934
|
+
* 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.
|
|
6935
|
+
* 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.
|
|
6936
|
+
* ## Requests and examples
|
|
6937
|
+
* POST /workspaces/{workspaceId}/scim-provisioning/prepare
|
|
6938
|
+
* 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.
|
|
6939
|
+
* ```text
|
|
6940
|
+
* POST /workspaces/ws-example/scim-provisioning/prepare
|
|
6941
|
+
* No business request body.
|
|
6942
|
+
* ```
|
|
6943
|
+
* ## Response examples
|
|
6944
|
+
* ```json
|
|
6945
|
+
* {
|
|
6946
|
+
* "data": {
|
|
6947
|
+
* "configuration": {
|
|
6948
|
+
* "status": "Enabled",
|
|
6949
|
+
* "baseUrl": "https://example.com/scim/v2"
|
|
6950
|
+
* },
|
|
6951
|
+
* "credential": {
|
|
6952
|
+
* "credentialId": "credential-example",
|
|
6953
|
+
* "status": "Enabled",
|
|
6954
|
+
* "expireTime": "<Expiration time returned by the upstream service>"
|
|
6955
|
+
* },
|
|
6956
|
+
* "token": "<Token issued only in the current response; null if an available credential already exists>"
|
|
6957
|
+
* }
|
|
6958
|
+
* }
|
|
6959
|
+
* ```
|
|
6960
|
+
* ## Errors and handling
|
|
6961
|
+
* 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.
|
|
6962
|
+
* 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.
|
|
6963
|
+
* ## Call relationships and usage boundaries
|
|
6964
|
+
* 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.
|
|
6965
|
+
*
|
|
6966
|
+
* @param request - PrepareIdentityProviderSCIMRequest
|
|
6967
|
+
* @returns PrepareIdentityProviderSCIMResponse
|
|
6968
|
+
*/
|
|
6969
|
+
async prepareIdentityProviderSCIM(workspaceId, request) {
|
|
6970
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
6971
|
+
let headers = {};
|
|
6972
|
+
return await this.prepareIdentityProviderSCIMWithOptions(workspaceId, request, headers, runtime);
|
|
6973
|
+
}
|
|
5683
6974
|
/**
|
|
5684
6975
|
* Publishes a specified Skill version to transition it to the published state.
|
|
5685
6976
|
*
|
|
@@ -5902,10 +7193,10 @@ class Client extends openapi_core_1.default {
|
|
|
5902
7193
|
return await this.retryImageCacheWithOptions(imageId, request, headers, runtime);
|
|
5903
7194
|
}
|
|
5904
7195
|
/**
|
|
5905
|
-
* Retrieves long-term memory from a MemoryStore based on semantics
|
|
7196
|
+
* Retrieves long-term memory from a MemoryStore based on semantics.
|
|
5906
7197
|
*
|
|
5907
7198
|
* @remarks
|
|
5908
|
-
* Retrieves long-term memory from a MemoryStore based on semantics
|
|
7199
|
+
* Retrieves long-term memory from a MemoryStore based on semantics.
|
|
5909
7200
|
*
|
|
5910
7201
|
* @param tmpReq - SearchMemoriesRequest
|
|
5911
7202
|
* @param headers - map
|
|
@@ -5941,10 +7232,10 @@ class Client extends openapi_core_1.default {
|
|
|
5941
7232
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.SearchMemoriesResponse({}));
|
|
5942
7233
|
}
|
|
5943
7234
|
/**
|
|
5944
|
-
* Retrieves long-term memory from a MemoryStore based on semantics
|
|
7235
|
+
* Retrieves long-term memory from a MemoryStore based on semantics.
|
|
5945
7236
|
*
|
|
5946
7237
|
* @remarks
|
|
5947
|
-
* Retrieves long-term memory from a MemoryStore based on semantics
|
|
7238
|
+
* Retrieves long-term memory from a MemoryStore based on semantics.
|
|
5948
7239
|
*
|
|
5949
7240
|
* @param request - SearchMemoriesRequest
|
|
5950
7241
|
* @returns SearchMemoriesResponse
|
|
@@ -6350,10 +7641,12 @@ class Client extends openapi_core_1.default {
|
|
|
6350
7641
|
* Updates the configuration of a specified custom agent in a workspace and executes the update asynchronously. Omitted top-level fields retain their original configurations. You can call the GetCustomAgent operation to query the update result.
|
|
6351
7642
|
*
|
|
6352
7643
|
* @remarks
|
|
6353
|
-
*
|
|
6354
|
-
* When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field.
|
|
6355
|
-
*
|
|
6356
|
-
* The
|
|
7644
|
+
* Provide at least one top-level field to update. Omitted top-level fields retain their original configurations. When providing a configuration object, specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced as a whole. Pass an empty array [] to clear a list. The agenticFsMounts field does not accept null. Pass null for the description field to clear the description, and pass null for the healthCheck field to remove the health check.
|
|
7645
|
+
* When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field.
|
|
7646
|
+
* In code package pattern, specify artifact.port and the sourceUri, languageRuntime, and entrypoint fields of artifact.code. Do not specify the container field at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported, and the compressed package size cannot exceed 500,000,000 bytes. Query the runtime environment identity by calling the ListAgentCodeRuntimes operation. The sourceUri field supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, first call the GetAgentCodePackageUploadUrl operation to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
|
|
7647
|
+
* When submitting a new code package source, the backend rechecks read permissions, objects, and sizes. The configuration is saved only after the transfer succeeds. If the transfer fails, the current configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not indicate that the agent is ready to run.
|
|
7648
|
+
* When providing the runtime field, the compute and sessionPolicy fields must be provided at the same time. If the hpa field or its subfields are omitted, unspecified elastic configurations use default values. To retain the original elastic configurations, provide them together. When providing the network field, omitted access items are treated as allowed, but actual access is still restricted by the workspace network configurations. To retain the original restrictions, provide both accessInternet and accessVpc. When providing the healthCheck field, the port field is required, and other unspecified items use default values. When providing the logging.sls field, both project and logstore must be specified.
|
|
7649
|
+
* The update is an asynchronous process. A successful response indicates that the request is accepted. Call the GetCustomAgent operation to query latestSpecVersion, latestVersionStatus, and latestExecutionError, and check the status field to confirm the update result.
|
|
6357
7650
|
* The clientToken field currently does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold field for health checks currently does not take effect. Omit this field.
|
|
6358
7651
|
*
|
|
6359
7652
|
* @param tmpReq - UpdateCustomAgentRequest
|
|
@@ -6398,10 +7691,12 @@ class Client extends openapi_core_1.default {
|
|
|
6398
7691
|
* Updates the configuration of a specified custom agent in a workspace and executes the update asynchronously. Omitted top-level fields retain their original configurations. You can call the GetCustomAgent operation to query the update result.
|
|
6399
7692
|
*
|
|
6400
7693
|
* @remarks
|
|
6401
|
-
*
|
|
6402
|
-
* When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field.
|
|
6403
|
-
*
|
|
6404
|
-
* The
|
|
7694
|
+
* Provide at least one top-level field to update. Omitted top-level fields retain their original configurations. When providing a configuration object, specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced as a whole. Pass an empty array [] to clear a list. The agenticFsMounts field does not accept null. Pass null for the description field to clear the description, and pass null for the healthCheck field to remove the health check.
|
|
7695
|
+
* When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field.
|
|
7696
|
+
* In code package pattern, specify artifact.port and the sourceUri, languageRuntime, and entrypoint fields of artifact.code. Do not specify the container field at the same time. Dependencies must be packaged by the user. ZIP and TAR.GZ formats are supported, and the compressed package size cannot exceed 500,000,000 bytes. Query the runtime environment identity by calling the ListAgentCodeRuntimes operation. The sourceUri field supports oss:// addresses or HTTPS object addresses of standard OSS public domain names, including signed URLs. For local files, first call the GetAgentCodePackageUploadUrl operation to obtain an upload URL, upload the file directly, and then commit the returned sourceUri.
|
|
7697
|
+
* When submitting a new code package source, the backend rechecks read permissions, objects, and sizes. The configuration is saved only after the transfer succeeds. If the transfer fails, the current configuration is not saved. Saved fixed packages can be reused. Set the client timeout to 210 seconds for code package requests. Archive integrity and secure decompression are checked at startup. A successful acceptance does not indicate that the agent is ready to run.
|
|
7698
|
+
* When providing the runtime field, the compute and sessionPolicy fields must be provided at the same time. If the hpa field or its subfields are omitted, unspecified elastic configurations use default values. To retain the original elastic configurations, provide them together. When providing the network field, omitted access items are treated as allowed, but actual access is still restricted by the workspace network configurations. To retain the original restrictions, provide both accessInternet and accessVpc. When providing the healthCheck field, the port field is required, and other unspecified items use default values. When providing the logging.sls field, both project and logstore must be specified.
|
|
7699
|
+
* The update is an asynchronous process. A successful response indicates that the request is accepted. Call the GetCustomAgent operation to query latestSpecVersion, latestVersionStatus, and latestExecutionError, and check the status field to confirm the update result.
|
|
6405
7700
|
* The clientToken field currently does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold field for health checks currently does not take effect. Omit this field.
|
|
6406
7701
|
*
|
|
6407
7702
|
* @param request - UpdateCustomAgentRequest
|
|
@@ -6471,7 +7766,21 @@ class Client extends openapi_core_1.default {
|
|
|
6471
7766
|
return await this.updateExternalAgentWithOptions(workspaceId, agentId, request, headers, runtime);
|
|
6472
7767
|
}
|
|
6473
7768
|
/**
|
|
6474
|
-
*
|
|
7769
|
+
* 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.
|
|
7770
|
+
*
|
|
7771
|
+
* @remarks
|
|
7772
|
+
* ### Prerequisites and update methods
|
|
7773
|
+
* 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.
|
|
7774
|
+
* ### DingTalk and Lark
|
|
7775
|
+
* 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.
|
|
7776
|
+
* 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.
|
|
7777
|
+
* ### Custom SAML identity provider
|
|
7778
|
+
* 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.
|
|
7779
|
+
* 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.
|
|
7780
|
+
* 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.
|
|
7781
|
+
* ### Asynchronous results and retries
|
|
7782
|
+
* 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.
|
|
7783
|
+
* 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.
|
|
6475
7784
|
*
|
|
6476
7785
|
* @param tmpReq - UpdateIdentityProviderRequest
|
|
6477
7786
|
* @param headers - map
|
|
@@ -6507,7 +7816,21 @@ class Client extends openapi_core_1.default {
|
|
|
6507
7816
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateIdentityProviderResponse({}));
|
|
6508
7817
|
}
|
|
6509
7818
|
/**
|
|
6510
|
-
*
|
|
7819
|
+
* 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.
|
|
7820
|
+
*
|
|
7821
|
+
* @remarks
|
|
7822
|
+
* ### Prerequisites and update methods
|
|
7823
|
+
* 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.
|
|
7824
|
+
* ### DingTalk and Lark
|
|
7825
|
+
* 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.
|
|
7826
|
+
* 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.
|
|
7827
|
+
* ### Custom SAML identity provider
|
|
7828
|
+
* 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.
|
|
7829
|
+
* 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.
|
|
7830
|
+
* 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.
|
|
7831
|
+
* ### Asynchronous results and retries
|
|
7832
|
+
* 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.
|
|
7833
|
+
* 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.
|
|
6511
7834
|
*
|
|
6512
7835
|
* @param request - UpdateIdentityProviderRequest
|
|
6513
7836
|
* @returns UpdateIdentityProviderResponse
|
|
@@ -6517,6 +7840,115 @@ class Client extends openapi_core_1.default {
|
|
|
6517
7840
|
let headers = {};
|
|
6518
7841
|
return await this.updateIdentityProviderWithOptions(workspaceId, identityProviderType, request, headers, runtime);
|
|
6519
7842
|
}
|
|
7843
|
+
/**
|
|
7844
|
+
* 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.
|
|
7845
|
+
*
|
|
7846
|
+
* @remarks
|
|
7847
|
+
* ## Features and prerequisites
|
|
7848
|
+
* 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.
|
|
7849
|
+
* 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.
|
|
7850
|
+
* 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.
|
|
7851
|
+
* ## Requests and examples
|
|
7852
|
+
* PUT /workspaces/{workspaceId}/scim-provisioning
|
|
7853
|
+
* 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.
|
|
7854
|
+
* ```text
|
|
7855
|
+
* PUT /workspaces/ws-example/scim-provisioning
|
|
7856
|
+
* {"syncEnabled": true}
|
|
7857
|
+
* To disable: {"syncEnabled": false}
|
|
7858
|
+
* ```
|
|
7859
|
+
* ## Response example
|
|
7860
|
+
* ```json
|
|
7861
|
+
* {
|
|
7862
|
+
* "data": {
|
|
7863
|
+
* "workspaceId": "ws-example",
|
|
7864
|
+
* "identityProviderType": "CustomSSO",
|
|
7865
|
+
* "status": "READY",
|
|
7866
|
+
* "loginEnabled": false,
|
|
7867
|
+
* "syncEnabled": true
|
|
7868
|
+
* }
|
|
7869
|
+
* }
|
|
7870
|
+
* ```
|
|
7871
|
+
* ## Errors and handling
|
|
7872
|
+
* 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.
|
|
7873
|
+
* 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.
|
|
7874
|
+
* ## Call relationships and usage boundaries
|
|
7875
|
+
* 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.
|
|
7876
|
+
*
|
|
7877
|
+
* @param tmpReq - UpdateIdentityProviderSCIMRequest
|
|
7878
|
+
* @param headers - map
|
|
7879
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
7880
|
+
* @returns UpdateIdentityProviderSCIMResponse
|
|
7881
|
+
*/
|
|
7882
|
+
async updateIdentityProviderSCIMWithOptions(workspaceId, tmpReq, headers, runtime) {
|
|
7883
|
+
tmpReq.validate();
|
|
7884
|
+
let request = new $_model.UpdateIdentityProviderSCIMShrinkRequest({});
|
|
7885
|
+
openapi_core_2.OpenApiUtil.convert(tmpReq, request);
|
|
7886
|
+
if (!$dara.isNull(tmpReq.body)) {
|
|
7887
|
+
request.bodyShrink = openapi_core_2.OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.body, "body", "json");
|
|
7888
|
+
}
|
|
7889
|
+
let body = {};
|
|
7890
|
+
if (!$dara.isNull(request.bodyShrink)) {
|
|
7891
|
+
body["body"] = request.bodyShrink;
|
|
7892
|
+
}
|
|
7893
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
7894
|
+
headers: headers,
|
|
7895
|
+
body: openapi_core_2.OpenApiUtil.parseToMap(body),
|
|
7896
|
+
});
|
|
7897
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
7898
|
+
action: "UpdateIdentityProviderSCIM",
|
|
7899
|
+
version: "2026-08-04",
|
|
7900
|
+
protocol: "HTTPS",
|
|
7901
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/scim-provisioning`,
|
|
7902
|
+
method: "PUT",
|
|
7903
|
+
authType: "AK",
|
|
7904
|
+
style: "ROA",
|
|
7905
|
+
reqBodyType: "formData",
|
|
7906
|
+
bodyType: "json",
|
|
7907
|
+
});
|
|
7908
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateIdentityProviderSCIMResponse({}));
|
|
7909
|
+
}
|
|
7910
|
+
/**
|
|
7911
|
+
* 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.
|
|
7912
|
+
*
|
|
7913
|
+
* @remarks
|
|
7914
|
+
* ## Features and prerequisites
|
|
7915
|
+
* 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.
|
|
7916
|
+
* 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.
|
|
7917
|
+
* 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.
|
|
7918
|
+
* ## Requests and examples
|
|
7919
|
+
* PUT /workspaces/{workspaceId}/scim-provisioning
|
|
7920
|
+
* 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.
|
|
7921
|
+
* ```text
|
|
7922
|
+
* PUT /workspaces/ws-example/scim-provisioning
|
|
7923
|
+
* {"syncEnabled": true}
|
|
7924
|
+
* To disable: {"syncEnabled": false}
|
|
7925
|
+
* ```
|
|
7926
|
+
* ## Response example
|
|
7927
|
+
* ```json
|
|
7928
|
+
* {
|
|
7929
|
+
* "data": {
|
|
7930
|
+
* "workspaceId": "ws-example",
|
|
7931
|
+
* "identityProviderType": "CustomSSO",
|
|
7932
|
+
* "status": "READY",
|
|
7933
|
+
* "loginEnabled": false,
|
|
7934
|
+
* "syncEnabled": true
|
|
7935
|
+
* }
|
|
7936
|
+
* }
|
|
7937
|
+
* ```
|
|
7938
|
+
* ## Errors and handling
|
|
7939
|
+
* 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.
|
|
7940
|
+
* 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.
|
|
7941
|
+
* ## Call relationships and usage boundaries
|
|
7942
|
+
* 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.
|
|
7943
|
+
*
|
|
7944
|
+
* @param request - UpdateIdentityProviderSCIMRequest
|
|
7945
|
+
* @returns UpdateIdentityProviderSCIMResponse
|
|
7946
|
+
*/
|
|
7947
|
+
async updateIdentityProviderSCIM(workspaceId, request) {
|
|
7948
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
7949
|
+
let headers = {};
|
|
7950
|
+
return await this.updateIdentityProviderSCIMWithOptions(workspaceId, request, headers, runtime);
|
|
7951
|
+
}
|
|
6520
7952
|
/**
|
|
6521
7953
|
* Updates the configuration of a specified managed agent.
|
|
6522
7954
|
*
|
|
@@ -6691,10 +8123,10 @@ class Client extends openapi_core_1.default {
|
|
|
6691
8123
|
return await this.updateMcpTemplateConfigWithOptions(workspaceId, mcpServerId, request, headers, runtime);
|
|
6692
8124
|
}
|
|
6693
8125
|
/**
|
|
6694
|
-
* Updates the long-term memory
|
|
8126
|
+
* Updates the text or metadata of a long-term memory based on the memory ID.
|
|
6695
8127
|
*
|
|
6696
8128
|
* @remarks
|
|
6697
|
-
* Updates the long-term memory
|
|
8129
|
+
* Updates the text or metadata of a long-term memory based on the memory ID.
|
|
6698
8130
|
*
|
|
6699
8131
|
* @param tmpReq - UpdateMemoryRequest
|
|
6700
8132
|
* @param headers - map
|
|
@@ -6730,10 +8162,10 @@ class Client extends openapi_core_1.default {
|
|
|
6730
8162
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateMemoryResponse({}));
|
|
6731
8163
|
}
|
|
6732
8164
|
/**
|
|
6733
|
-
* Updates the long-term memory
|
|
8165
|
+
* Updates the text or metadata of a long-term memory based on the memory ID.
|
|
6734
8166
|
*
|
|
6735
8167
|
* @remarks
|
|
6736
|
-
* Updates the long-term memory
|
|
8168
|
+
* Updates the text or metadata of a long-term memory based on the memory ID.
|
|
6737
8169
|
*
|
|
6738
8170
|
* @param request - UpdateMemoryRequest
|
|
6739
8171
|
* @returns UpdateMemoryResponse
|
|
@@ -7352,6 +8784,111 @@ class Client extends openapi_core_1.default {
|
|
|
7352
8784
|
let headers = {};
|
|
7353
8785
|
return await this.uploadSkillViaOssWithOptions(workspaceId, request, headers, runtime);
|
|
7354
8786
|
}
|
|
8787
|
+
/**
|
|
8788
|
+
* Validates the OSS code package source for an agent.
|
|
8789
|
+
*
|
|
8790
|
+
* @remarks
|
|
8791
|
+
* Uses the current workspace role to check whether the customer\\"s OSS object exists and is readable, and checks the file name extension and compressed size. Returns the sourceUri, file name, size, and format read in this request. The bucket and object key are passed separately, and HTTPS download URLs are not accepted.
|
|
8792
|
+
* The validation uses object metadata and read probing. It does not perform full downloads, transfers, or decompression, nor does it generate a SHA-256 hash. Passing the validation does not mean that the archive content is complete or can be started. When you submit a CreateCustomAgent or UpdateCustomAgent request, the system re-validates and transfers the package. You do not need to invoke this operation in advance as a prerequisite for submission.
|
|
8793
|
+
*
|
|
8794
|
+
* @param tmpReq - ValidateAgentCodePackageFromOssRequest
|
|
8795
|
+
* @param headers - map
|
|
8796
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
8797
|
+
* @returns ValidateAgentCodePackageFromOssResponse
|
|
8798
|
+
*/
|
|
8799
|
+
async validateAgentCodePackageFromOssWithOptions(workspaceId, tmpReq, headers, runtime) {
|
|
8800
|
+
tmpReq.validate();
|
|
8801
|
+
let request = new $_model.ValidateAgentCodePackageFromOssShrinkRequest({});
|
|
8802
|
+
openapi_core_2.OpenApiUtil.convert(tmpReq, request);
|
|
8803
|
+
if (!$dara.isNull(tmpReq.body)) {
|
|
8804
|
+
request.bodyShrink = openapi_core_2.OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.body, "body", "json");
|
|
8805
|
+
}
|
|
8806
|
+
let body = {};
|
|
8807
|
+
if (!$dara.isNull(request.bodyShrink)) {
|
|
8808
|
+
body["body"] = request.bodyShrink;
|
|
8809
|
+
}
|
|
8810
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
8811
|
+
headers: headers,
|
|
8812
|
+
body: openapi_core_2.OpenApiUtil.parseToMap(body),
|
|
8813
|
+
});
|
|
8814
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
8815
|
+
action: "ValidateAgentCodePackageFromOss",
|
|
8816
|
+
version: "2026-08-04",
|
|
8817
|
+
protocol: "HTTPS",
|
|
8818
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/agent-code-packages/validate-from-oss`,
|
|
8819
|
+
method: "POST",
|
|
8820
|
+
authType: "AK",
|
|
8821
|
+
style: "ROA",
|
|
8822
|
+
reqBodyType: "formData",
|
|
8823
|
+
bodyType: "json",
|
|
8824
|
+
});
|
|
8825
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ValidateAgentCodePackageFromOssResponse({}));
|
|
8826
|
+
}
|
|
8827
|
+
/**
|
|
8828
|
+
* Validates the OSS code package source for an agent.
|
|
8829
|
+
*
|
|
8830
|
+
* @remarks
|
|
8831
|
+
* Uses the current workspace role to check whether the customer\\"s OSS object exists and is readable, and checks the file name extension and compressed size. Returns the sourceUri, file name, size, and format read in this request. The bucket and object key are passed separately, and HTTPS download URLs are not accepted.
|
|
8832
|
+
* The validation uses object metadata and read probing. It does not perform full downloads, transfers, or decompression, nor does it generate a SHA-256 hash. Passing the validation does not mean that the archive content is complete or can be started. When you submit a CreateCustomAgent or UpdateCustomAgent request, the system re-validates and transfers the package. You do not need to invoke this operation in advance as a prerequisite for submission.
|
|
8833
|
+
*
|
|
8834
|
+
* @param request - ValidateAgentCodePackageFromOssRequest
|
|
8835
|
+
* @returns ValidateAgentCodePackageFromOssResponse
|
|
8836
|
+
*/
|
|
8837
|
+
async validateAgentCodePackageFromOss(workspaceId, request) {
|
|
8838
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
8839
|
+
let headers = {};
|
|
8840
|
+
return await this.validateAgentCodePackageFromOssWithOptions(workspaceId, request, headers, runtime);
|
|
8841
|
+
}
|
|
8842
|
+
/**
|
|
8843
|
+
* Checks the OSS RAM authorization status of the agent code package.
|
|
8844
|
+
*
|
|
8845
|
+
* @remarks
|
|
8846
|
+
* 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.
|
|
8847
|
+
* To check a specific object, call ValidateAgentCodePackageFromOss. This operation does not copy code packages or modify the default OSS binding of the workspace.
|
|
8848
|
+
*
|
|
8849
|
+
* @param request - VerifyAgentCodePackageOssRamAuthorizationRequest
|
|
8850
|
+
* @param headers - map
|
|
8851
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
8852
|
+
* @returns VerifyAgentCodePackageOssRamAuthorizationResponse
|
|
8853
|
+
*/
|
|
8854
|
+
async verifyAgentCodePackageOssRamAuthorizationWithOptions(workspaceId, request, headers, runtime) {
|
|
8855
|
+
request.validate();
|
|
8856
|
+
let query = {};
|
|
8857
|
+
if (!$dara.isNull(request.ossBucketName)) {
|
|
8858
|
+
query["ossBucketName"] = request.ossBucketName;
|
|
8859
|
+
}
|
|
8860
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
8861
|
+
headers: headers,
|
|
8862
|
+
query: openapi_core_2.OpenApiUtil.query(query),
|
|
8863
|
+
});
|
|
8864
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
8865
|
+
action: "VerifyAgentCodePackageOssRamAuthorization",
|
|
8866
|
+
version: "2026-08-04",
|
|
8867
|
+
protocol: "HTTPS",
|
|
8868
|
+
pathname: `/workspaces/${$dara.URL.percentEncode(workspaceId)}/agent-code-packages/oss/authorize/verify`,
|
|
8869
|
+
method: "POST",
|
|
8870
|
+
authType: "AK",
|
|
8871
|
+
style: "ROA",
|
|
8872
|
+
reqBodyType: "json",
|
|
8873
|
+
bodyType: "json",
|
|
8874
|
+
});
|
|
8875
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.VerifyAgentCodePackageOssRamAuthorizationResponse({}));
|
|
8876
|
+
}
|
|
8877
|
+
/**
|
|
8878
|
+
* Checks the OSS RAM authorization status of the agent code package.
|
|
8879
|
+
*
|
|
8880
|
+
* @remarks
|
|
8881
|
+
* 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.
|
|
8882
|
+
* To check a specific object, call ValidateAgentCodePackageFromOss. This operation does not copy code packages or modify the default OSS binding of the workspace.
|
|
8883
|
+
*
|
|
8884
|
+
* @param request - VerifyAgentCodePackageOssRamAuthorizationRequest
|
|
8885
|
+
* @returns VerifyAgentCodePackageOssRamAuthorizationResponse
|
|
8886
|
+
*/
|
|
8887
|
+
async verifyAgentCodePackageOssRamAuthorization(workspaceId, request) {
|
|
8888
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
8889
|
+
let headers = {};
|
|
8890
|
+
return await this.verifyAgentCodePackageOssRamAuthorizationWithOptions(workspaceId, request, headers, runtime);
|
|
8891
|
+
}
|
|
7355
8892
|
/**
|
|
7356
8893
|
* Validates whether one or more Qoder Service Account Keys are available at a specified site. This operation does not save keys or modify the Connector status.
|
|
7357
8894
|
*
|