@alicloud/agentcore20260804 3.0.1 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +370 -188
- package/dist/client.js +413 -188
- package/dist/client.js.map +1 -1
- package/dist/models/CreateCustomAgentRequest.d.ts +155 -53
- package/dist/models/CreateCustomAgentRequest.js +61 -1
- package/dist/models/CreateCustomAgentRequest.js.map +1 -1
- package/dist/models/CreateCustomAgentResponseBody.d.ts +305 -58
- package/dist/models/CreateCustomAgentResponseBody.js +153 -1
- package/dist/models/CreateCustomAgentResponseBody.js.map +1 -1
- package/dist/models/CreateIdentityProviderRequest.d.ts +12 -15
- package/dist/models/CreateIdentityProviderRequest.js.map +1 -1
- package/dist/models/CreateIdentityProviderResponseBody.d.ts +19 -22
- package/dist/models/CreateIdentityProviderResponseBody.js.map +1 -1
- package/dist/models/CreateManagedAgentRequest.d.ts +80 -45
- package/dist/models/CreateManagedAgentRequest.js +29 -1
- package/dist/models/CreateManagedAgentRequest.js.map +1 -1
- package/dist/models/CreateManagedAgentResponseBody.d.ts +98 -65
- package/dist/models/CreateManagedAgentResponseBody.js +29 -1
- package/dist/models/CreateManagedAgentResponseBody.js.map +1 -1
- package/dist/models/CreateManagedAgentShrinkRequest.d.ts +1 -1
- package/dist/models/DeleteIdentityProviderResponseBody.d.ts +10 -10
- package/dist/models/DeleteIdentityProviderScimcredentialResponseBody.d.ts +5 -5
- package/dist/models/FindCustomAgentImagePreparationRequest.d.ts +23 -0
- package/dist/models/FindCustomAgentImagePreparationRequest.js +58 -0
- package/dist/models/FindCustomAgentImagePreparationRequest.js.map +1 -0
- package/dist/models/FindCustomAgentImagePreparationResponse.d.ts +19 -0
- package/dist/models/FindCustomAgentImagePreparationResponse.js +69 -0
- package/dist/models/FindCustomAgentImagePreparationResponse.js.map +1 -0
- package/dist/models/FindCustomAgentImagePreparationResponseBody.d.ts +135 -0
- package/dist/models/FindCustomAgentImagePreparationResponseBody.js +122 -0
- package/dist/models/FindCustomAgentImagePreparationResponseBody.js.map +1 -0
- package/dist/models/GetCustomAgentImagePreparationRequest.d.ts +13 -0
- package/dist/models/GetCustomAgentImagePreparationRequest.js +54 -0
- package/dist/models/GetCustomAgentImagePreparationRequest.js.map +1 -0
- package/dist/models/GetCustomAgentImagePreparationResponse.d.ts +19 -0
- package/dist/models/GetCustomAgentImagePreparationResponse.js +69 -0
- package/dist/models/GetCustomAgentImagePreparationResponse.js.map +1 -0
- package/dist/models/GetCustomAgentImagePreparationResponseBody.d.ts +135 -0
- package/dist/models/GetCustomAgentImagePreparationResponseBody.js +122 -0
- package/dist/models/GetCustomAgentImagePreparationResponseBody.js.map +1 -0
- package/dist/models/GetCustomAgentResponseBody.d.ts +304 -51
- package/dist/models/GetCustomAgentResponseBody.js +153 -1
- package/dist/models/GetCustomAgentResponseBody.js.map +1 -1
- package/dist/models/GetIdentityProviderResponseBody.d.ts +30 -30
- package/dist/models/GetIdentityProviderScimresponseBody.d.ts +22 -18
- package/dist/models/GetIdentityProviderScimresponseBody.js.map +1 -1
- package/dist/models/GetIdentityProviderServiceProviderRequest.d.ts +1 -1
- package/dist/models/GetIdentityProviderServiceProviderResponseBody.d.ts +10 -10
- package/dist/models/GetManagedAgentResponseBody.d.ts +106 -75
- package/dist/models/GetManagedAgentResponseBody.js +29 -1
- package/dist/models/GetManagedAgentResponseBody.js.map +1 -1
- package/dist/models/GetWorkspaceAcrRamAuthorizeUrlRequest.d.ts +2 -2
- package/dist/models/GetWorkspaceAcrRamAuthorizeUrlResponseBody.d.ts +1 -1
- package/dist/models/ListCustomAgentsRequest.d.ts +2 -2
- package/dist/models/ListCustomAgentsResponseBody.d.ts +24 -22
- package/dist/models/ListCustomAgentsResponseBody.js.map +1 -1
- package/dist/models/ListIdentityProvidersRequest.d.ts +1 -1
- package/dist/models/ListIdentityProvidersResponseBody.d.ts +30 -18
- package/dist/models/ListIdentityProvidersResponseBody.js.map +1 -1
- package/dist/models/PrepareIdentityProviderScimresponseBody.d.ts +10 -10
- package/dist/models/UpdateCustomAgentRequest.d.ts +154 -75
- package/dist/models/UpdateCustomAgentRequest.js +61 -1
- package/dist/models/UpdateCustomAgentRequest.js.map +1 -1
- package/dist/models/UpdateCustomAgentResponseBody.d.ts +310 -65
- package/dist/models/UpdateCustomAgentResponseBody.js +153 -1
- package/dist/models/UpdateCustomAgentResponseBody.js.map +1 -1
- package/dist/models/UpdateCustomAgentShrinkRequest.d.ts +1 -1
- package/dist/models/UpdateIdentityProviderRequest.d.ts +20 -20
- package/dist/models/UpdateIdentityProviderResponseBody.d.ts +19 -19
- package/dist/models/UpdateIdentityProviderScimrequest.d.ts +2 -2
- package/dist/models/UpdateIdentityProviderScimresponseBody.d.ts +28 -28
- package/dist/models/UpdateIdentityProviderScimshrinkRequest.d.ts +1 -1
- package/dist/models/UpdateIdentityProviderShrinkRequest.d.ts +1 -1
- package/dist/models/UpdateManagedAgentRequest.d.ts +83 -46
- package/dist/models/UpdateManagedAgentRequest.js +29 -1
- package/dist/models/UpdateManagedAgentRequest.js.map +1 -1
- package/dist/models/UpdateManagedAgentResponseBody.d.ts +98 -65
- package/dist/models/UpdateManagedAgentResponseBody.js +29 -1
- package/dist/models/UpdateManagedAgentResponseBody.js.map +1 -1
- package/dist/models/UpdateManagedAgentShrinkRequest.d.ts +1 -1
- package/dist/models/model.d.ts +34 -0
- package/dist/models/model.js +267 -198
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +418 -188
- package/src/models/CreateCustomAgentRequest.ts +197 -53
- package/src/models/CreateCustomAgentResponseBody.ts +412 -58
- package/src/models/CreateIdentityProviderRequest.ts +12 -15
- package/src/models/CreateIdentityProviderResponseBody.ts +19 -22
- package/src/models/CreateManagedAgentRequest.ts +99 -45
- package/src/models/CreateManagedAgentResponseBody.ts +117 -65
- package/src/models/CreateManagedAgentShrinkRequest.ts +1 -1
- package/src/models/DeleteIdentityProviderResponseBody.ts +10 -10
- package/src/models/DeleteIdentityProviderScimcredentialResponseBody.ts +5 -5
- package/src/models/FindCustomAgentImagePreparationRequest.ts +36 -0
- package/src/models/FindCustomAgentImagePreparationResponse.ts +40 -0
- package/src/models/FindCustomAgentImagePreparationResponseBody.ts +194 -0
- package/src/models/GetCustomAgentImagePreparationRequest.ts +24 -0
- package/src/models/GetCustomAgentImagePreparationResponse.ts +40 -0
- package/src/models/GetCustomAgentImagePreparationResponseBody.ts +194 -0
- package/src/models/GetCustomAgentResponseBody.ts +411 -51
- package/src/models/GetIdentityProviderResponseBody.ts +30 -30
- package/src/models/GetIdentityProviderScimresponseBody.ts +22 -18
- package/src/models/GetIdentityProviderServiceProviderRequest.ts +1 -1
- package/src/models/GetIdentityProviderServiceProviderResponseBody.ts +10 -10
- package/src/models/GetManagedAgentResponseBody.ts +125 -75
- package/src/models/GetWorkspaceAcrRamAuthorizeUrlRequest.ts +2 -2
- package/src/models/GetWorkspaceAcrRamAuthorizeUrlResponseBody.ts +1 -1
- package/src/models/ListCustomAgentsRequest.ts +2 -2
- package/src/models/ListCustomAgentsResponseBody.ts +24 -22
- package/src/models/ListIdentityProvidersRequest.ts +1 -1
- package/src/models/ListIdentityProvidersResponseBody.ts +30 -18
- package/src/models/PrepareIdentityProviderScimresponseBody.ts +10 -10
- package/src/models/UpdateCustomAgentRequest.ts +196 -75
- package/src/models/UpdateCustomAgentResponseBody.ts +417 -65
- package/src/models/UpdateCustomAgentShrinkRequest.ts +1 -1
- package/src/models/UpdateIdentityProviderRequest.ts +20 -20
- package/src/models/UpdateIdentityProviderResponseBody.ts +19 -19
- package/src/models/UpdateIdentityProviderScimrequest.ts +2 -2
- package/src/models/UpdateIdentityProviderScimresponseBody.ts +28 -28
- package/src/models/UpdateIdentityProviderScimshrinkRequest.ts +1 -1
- package/src/models/UpdateIdentityProviderShrinkRequest.ts +1 -1
- package/src/models/UpdateManagedAgentRequest.ts +102 -46
- package/src/models/UpdateManagedAgentResponseBody.ts +117 -65
- package/src/models/UpdateManagedAgentShrinkRequest.ts +1 -1
- package/src/models/model.ts +34 -0
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class UpdateCustomAgentShrinkRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The update configuration for the custom agent.
|
|
8
|
+
* The update configuration for the custom agent. Specify at least one top-level field. Omitted top-level fields retain their original values. When you provide a configuration object, you must specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced as a whole.
|
|
9
9
|
*/
|
|
10
10
|
bodyShrink?: string;
|
|
11
11
|
/**
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class UpdateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The App ID of the
|
|
8
|
+
* The App ID of the Feishu application. If this field is omitted during an update, the existing value is retained. If explicitly submitted, the value must be non-empty. The merged configuration for Feishu must include this field.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* cli_exampleappid01
|
|
@@ -13,7 +13,7 @@ export class UpdateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
|
13
13
|
appId?: string;
|
|
14
14
|
/**
|
|
15
15
|
* @remarks
|
|
16
|
-
* The AppKey of the DingTalk application. If this
|
|
16
|
+
* The AppKey of the DingTalk application. If this field is omitted during an update, the existing value is retained. If explicitly submitted, the value must be non-empty. The merged configuration for DingTalk must include this field.
|
|
17
17
|
*
|
|
18
18
|
* @example
|
|
19
19
|
* dingexampleappkey01
|
|
@@ -21,7 +21,7 @@ export class UpdateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
|
21
21
|
appKey?: string;
|
|
22
22
|
/**
|
|
23
23
|
* @remarks
|
|
24
|
-
* The AppSecret of the DingTalk or
|
|
24
|
+
* The AppSecret of the DingTalk or Feishu application. If this field is omitted during an update, the existing secret is retained and does not need to be retransmitted each time. If explicitly submitted, the value must be non-empty, and the merged configuration must include this field. This is a sensitive input and is not echoed in queries. The example is a fictitious value.
|
|
25
25
|
*
|
|
26
26
|
* @example
|
|
27
27
|
* example-app-secret
|
|
@@ -29,7 +29,7 @@ export class UpdateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
|
29
29
|
appSecret?: string;
|
|
30
30
|
/**
|
|
31
31
|
* @remarks
|
|
32
|
-
* The CorpId of the organization to which the DingTalk application belongs. If this
|
|
32
|
+
* The CorpId of the organization to which the DingTalk application belongs. If this field is omitted during an update, the existing value is retained. If explicitly submitted, the value must be non-empty and consistent with the organization to which the application belongs. The merged configuration for DingTalk must include this field.
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
35
|
* dingexamplecorpid01
|
|
@@ -37,7 +37,7 @@ export class UpdateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
|
37
37
|
corpId?: string;
|
|
38
38
|
/**
|
|
39
39
|
* @remarks
|
|
40
|
-
* The encryption key for vendor event callbacks, which must be consistent with the vendor application configuration. If this
|
|
40
|
+
* The encryption key for vendor event callbacks, which must be consistent with the vendor application configuration. If this field is omitted during an update, the existing value is retained. When incremental synchronization is enabled, the merged configuration must include this field. This is a sensitive input and is not echoed in queries.
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
43
|
* example-encrypt-key
|
|
@@ -45,7 +45,7 @@ export class UpdateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
|
45
45
|
encryptKey?: string;
|
|
46
46
|
/**
|
|
47
47
|
* @remarks
|
|
48
|
-
* The verification token for vendor event callbacks, which must be consistent with the vendor application configuration. If this
|
|
48
|
+
* The verification token for vendor event callbacks, which must be consistent with the vendor application configuration. If this field is omitted during an update, the existing value is retained. When incremental synchronization is enabled, the merged configuration must include this field. This is a sensitive input and is not echoed in queries.
|
|
49
49
|
*
|
|
50
50
|
* @example
|
|
51
51
|
* example-verification-token
|
|
@@ -85,7 +85,7 @@ export class UpdateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
|
85
85
|
export class UpdateIdentityProviderRequestBodySaml extends $dara.Model {
|
|
86
86
|
/**
|
|
87
87
|
* @remarks
|
|
88
|
-
* The binding type
|
|
88
|
+
* The binding type when manually entering the SAML configuration. Valid values: HTTP-Redirect and HTTP-POST. This field must be submitted together with entityId, loginUrl, and x509Certificates, and cannot be mixed with metadataXml.
|
|
89
89
|
*
|
|
90
90
|
* @example
|
|
91
91
|
* HTTP-Redirect
|
|
@@ -93,7 +93,7 @@ export class UpdateIdentityProviderRequestBodySaml extends $dara.Model {
|
|
|
93
93
|
bindingType?: string;
|
|
94
94
|
/**
|
|
95
95
|
* @remarks
|
|
96
|
-
* The entity
|
|
96
|
+
* The entity identifier of the enterprise IdP. This field is required when manually entering the configuration. The value must be non-empty and contain up to 2,048 characters, and cannot be changed after saving. This field must be submitted together with loginUrl, bindingType, and x509Certificates, and cannot be mixed with metadataXml.
|
|
97
97
|
*
|
|
98
98
|
* @example
|
|
99
99
|
* https://idp.example.com/entity
|
|
@@ -101,7 +101,7 @@ export class UpdateIdentityProviderRequestBodySaml extends $dara.Model {
|
|
|
101
101
|
entityId?: string;
|
|
102
102
|
/**
|
|
103
103
|
* @remarks
|
|
104
|
-
* The SSO logon URL of the enterprise IdP. This
|
|
104
|
+
* The SSO logon URL of the enterprise IdP. This field is required when manually entering the configuration. The value must be an absolute HTTPS URL without user credentials and fragments. This field must be submitted together with entityId, bindingType, and x509Certificates, and cannot be mixed with metadataXml.
|
|
105
105
|
*
|
|
106
106
|
* @example
|
|
107
107
|
* https://idp.example.com/sso
|
|
@@ -109,7 +109,7 @@ export class UpdateIdentityProviderRequestBodySaml extends $dara.Model {
|
|
|
109
109
|
loginUrl?: string;
|
|
110
110
|
/**
|
|
111
111
|
* @remarks
|
|
112
|
-
* The original SAML metadata XML text of the enterprise IdP, not a URL or file path. The maximum size is 1 MiB.
|
|
112
|
+
* The original SAML metadata XML text of the enterprise IdP, not a URL or file path. The maximum size is 1 MiB. The text must contain a single EntityDescriptor. DTD and external entities are prohibited. This field cannot be mixed with the four manually entered configuration fields. After saving, queries return the standardized configuration and do not echo the original XML text.
|
|
113
113
|
*
|
|
114
114
|
* @example
|
|
115
115
|
* <EntityDescriptor xmlns="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://idp.example.com/entity"><IDPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><KeyDescriptor use="signing"><KeyInfo xmlns="http://www.w3.org/2000/09/xmldsig#"><X509Data><X509Certificate>MIICwDCCAaigAwIBAgIULlsHLfcADyBax5ZtFlj+YGzZVo0wDQYJKoZIhvcNAQELBQAwGjEYMBYGA1UEAwwPaWRwLmV4YW1wbGUuY29tMB4XDTI2MDEwMTAwMDAwMFoXDTM2MDEwMTAwMDAwMFowGjEYMBYGA1UEAwwPaWRwLmV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAto0DN0W1CrPRzK9QZ9A1aApb4Lg8oGlp2c0PbN3LokXe/HzwxCMXx65IDnrenttxzTwp9BgUnUN/3LRzWaOL2UQ/vNYNW9LFLkI1T64UPyI7eyi28YlALhb41xkYhEp7rz+MjqifBzVZeTDUxBYtbK2hAhbYEL1+udwsXEx0KB7xuQ/rbI2OKeqAEAD1tfYg7T/SM2wrXNYhx+o1HtchM4/0I8Okkk27JQ4y3ofzC5sTySmFF1Y7XcpSd+5WSyazedhkAieo8AB01DkJV6nnKfH8sH0EBsnH3FP8FhqCLrIeEkjX9B9OcIRLGjiZqx4u/ryW1QhMldnv+pFfNjWy/wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQC1hSQG8AwtGOoX2gKBK4Hi5XBrBreij8WlLTUWld0FINQ0Rg84f/27CjDthywj6wgxCesCuOVFhpxQa1UacsP/Gcai1aKABtLWImcaWECRYK5gDkwhTMFKM9mXA26hH1l4v/UR2iTpEK9H78egC4W7bs2LDTpPryuaNKTqP2O0tMbNkAHB8yecz5LxHXnxadL9Egow25g2RClvpifWqDnuS9TSbKkIWLcPLjocJj2K9ILpBwhXiXi/BiSgyYTLiYvVvih9vX4s+hKGZNJc0j92YLiOHDF0XH1oxgdVjfTmRiedeb2VZJZElptD92z0AqFR7z2d5B+OqpPA2gjuMLV5</X509Certificate></X509Data></KeyInfo></KeyDescriptor><SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://idp.example.com/sso"/></IDPSSODescriptor></EntityDescriptor>
|
|
@@ -117,7 +117,7 @@ export class UpdateIdentityProviderRequestBodySaml extends $dara.Model {
|
|
|
117
117
|
metadataXml?: string;
|
|
118
118
|
/**
|
|
119
119
|
* @remarks
|
|
120
|
-
* The list of X.509 signing certificates
|
|
120
|
+
* The list of X.509 signing certificates of the enterprise IdP. When manually entering the configuration, you must provide a non-empty list of up to 10 certificates, and the certificates must be valid. This field must be submitted together with entityId, loginUrl, and bindingType, and cannot be mixed with metadataXml.
|
|
121
121
|
*
|
|
122
122
|
* @example
|
|
123
123
|
* ["-----BEGIN CERTIFICATE-----\\\\nMIICwDCCAaigAwIBAgIULlsHLfcADyBax5ZtFlj+YGzZVo0wDQYJKoZIhvcNAQEL\\\\nBQAwGjEYMBYGA1UEAwwPaWRwLmV4YW1wbGUuY29tMB4XDTI2MDEwMTAwMDAwMFoX\\\\nDTM2MDEwMTAwMDAwMFowGjEYMBYGA1UEAwwPaWRwLmV4YW1wbGUuY29tMIIBIjAN\\\\nBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAto0DN0W1CrPRzK9QZ9A1aApb4Lg8\\\\noGlp2c0PbN3LokXe/HzwxCMXx65IDnrenttxzTwp9BgUnUN/3LRzWaOL2UQ/vNYN\\\\nW9LFLkI1T64UPyI7eyi28YlALhb41xkYhEp7rz+MjqifBzVZeTDUxBYtbK2hAhbY\\\\nEL1+udwsXEx0KB7xuQ/rbI2OKeqAEAD1tfYg7T/SM2wrXNYhx+o1HtchM4/0I8Ok\\\\nkk27JQ4y3ofzC5sTySmFF1Y7XcpSd+5WSyazedhkAieo8AB01DkJV6nnKfH8sH0E\\\\nBsnH3FP8FhqCLrIeEkjX9B9OcIRLGjiZqx4u/ryW1QhMldnv+pFfNjWy/wIDAQAB\\\\nMA0GCSqGSIb3DQEBCwUAA4IBAQC1hSQG8AwtGOoX2gKBK4Hi5XBrBreij8WlLTUW\\\\nld0FINQ0Rg84f/27CjDthywj6wgxCesCuOVFhpxQa1UacsP/Gcai1aKABtLWImca\\\\nWECRYK5gDkwhTMFKM9mXA26hH1l4v/UR2iTpEK9H78egC4W7bs2LDTpPryuaNKTq\\\\nP2O0tMbNkAHB8yecz5LxHXnxadL9Egow25g2RClvpifWqDnuS9TSbKkIWLcPLjoc\\\\nJj2K9ILpBwhXiXi/BiSgyYTLiYvVvih9vX4s+hKGZNJc0j92YLiOHDF0XH1oxgdV\\\\njfTmRiedeb2VZJZElptD92z0AqFR7z2d5B+OqpPA2gjuMLV5\\\\n-----END CERTIFICATE-----"]
|
|
@@ -158,7 +158,7 @@ export class UpdateIdentityProviderRequestBodySaml extends $dara.Model {
|
|
|
158
158
|
export class UpdateIdentityProviderRequestBodySyncScope extends $dara.Model {
|
|
159
159
|
/**
|
|
160
160
|
* @remarks
|
|
161
|
-
* The list of department IDs in the synchronization scope, obtained from ListIdentityProviderDepartments. In SelectedDepartments mode, at least one non-empty department ID
|
|
161
|
+
* The list of department IDs in the synchronization scope, which are obtained from ListIdentityProviderDepartments. In SelectedDepartments mode, you must provide at least one non-empty department ID. In AllAuthorized mode, this field should be omitted or an empty array should be passed.
|
|
162
162
|
*
|
|
163
163
|
* @example
|
|
164
164
|
* ["10001"]
|
|
@@ -166,7 +166,7 @@ export class UpdateIdentityProviderRequestBodySyncScope extends $dara.Model {
|
|
|
166
166
|
departmentIds?: string[];
|
|
167
167
|
/**
|
|
168
168
|
* @remarks
|
|
169
|
-
* The synchronization scope mode.
|
|
169
|
+
* The synchronization scope mode. Valid values: AllAuthorized and SelectedDepartments. AllAuthorized indicates all members within the authorization scope of the application address book. SelectedDepartments indicates the selected departments and all their sub-departments. When explicitly submitting syncScope, you must provide a valid mode.
|
|
170
170
|
*
|
|
171
171
|
* @example
|
|
172
172
|
* SelectedDepartments
|
|
@@ -201,12 +201,12 @@ export class UpdateIdentityProviderRequestBodySyncScope extends $dara.Model {
|
|
|
201
201
|
export class UpdateIdentityProviderRequestBody extends $dara.Model {
|
|
202
202
|
/**
|
|
203
203
|
* @remarks
|
|
204
|
-
* Specifies whether to allow logon by using this identity provider. If this
|
|
204
|
+
* Specifies whether to allow logon by using this identity provider. If this field is omitted or set to null during an update, the original value is retained. For CustomSSO, a valid SAML configuration must exist before enabling logon. Disabling logon does not delete the saved SAML or SCIM configuration.
|
|
205
205
|
*/
|
|
206
206
|
loginEnabled?: boolean;
|
|
207
207
|
/**
|
|
208
208
|
* @remarks
|
|
209
|
-
* Applies only to DingTalk and
|
|
209
|
+
* Applies only to DingTalk and Feishu. The application configuration is merged by field. Omitted fields and existing keys retain their original values. Explicitly submitted fields must not be null, empty strings, or blank strings. The merged configuration must meet the complete configuration requirements of the vendor. This field is not accepted for CustomSSO.
|
|
210
210
|
*
|
|
211
211
|
* @example
|
|
212
212
|
* {"appSecret":"example-app-secret"}
|
|
@@ -214,7 +214,7 @@ export class UpdateIdentityProviderRequestBody extends $dara.Model {
|
|
|
214
214
|
metadata?: UpdateIdentityProviderRequestBodyMetadata;
|
|
215
215
|
/**
|
|
216
216
|
* @remarks
|
|
217
|
-
* The logon protocol, which applies only to CustomSSO. Currently, only SAML is supported.
|
|
217
|
+
* The logon protocol, which applies only to CustomSSO. Currently, only SAML is supported. This field is not accepted for DingTalk and Feishu. When submitted with a non-empty saml configuration, this field can be omitted and is processed as SAML by the server.
|
|
218
218
|
*
|
|
219
219
|
* @example
|
|
220
220
|
* SAML
|
|
@@ -222,17 +222,17 @@ export class UpdateIdentityProviderRequestBody extends $dara.Model {
|
|
|
222
222
|
protocol?: string;
|
|
223
223
|
/**
|
|
224
224
|
* @remarks
|
|
225
|
-
* Applies only to CustomSSO. You
|
|
225
|
+
* Applies only to CustomSSO. You must choose between providing metadataXml and providing the four complete manually entered configuration fields. The two methods cannot be mixed. If a valid configuration already exists, you can also modify only the JIT switches. Saving the configuration does not automatically enable logon.
|
|
226
226
|
*/
|
|
227
227
|
saml?: UpdateIdentityProviderRequestBodySaml;
|
|
228
228
|
/**
|
|
229
229
|
* @remarks
|
|
230
|
-
* Applies only to DingTalk and
|
|
230
|
+
* Applies only to DingTalk and Feishu. This field controls the incremental synchronization of subsequent address book change events. If this field is omitted or set to null during an update, the original value is retained. This field does not control the initial synchronization or manual synchronization. When enabled, the merged metadata must include the encryptKey and verificationToken fields. For CustomSSO, use UpdateIdentityProviderSCIM to manage the synchronization switch.
|
|
231
231
|
*/
|
|
232
232
|
syncEnabled?: boolean;
|
|
233
233
|
/**
|
|
234
234
|
* @remarks
|
|
235
|
-
* The address book synchronization scope, which applies only to DingTalk and
|
|
235
|
+
* The address book synchronization scope, which applies only to DingTalk and Feishu. If this field is omitted or set to null, the current scope is retained. Saving the scope does not automatically trigger a full synchronization. This field is not accepted for CustomSSO.
|
|
236
236
|
*/
|
|
237
237
|
syncScope?: UpdateIdentityProviderRequestBodySyncScope;
|
|
238
238
|
static names(): { [key: string]: string } {
|
|
@@ -278,7 +278,7 @@ export class UpdateIdentityProviderRequestBody extends $dara.Model {
|
|
|
278
278
|
export class UpdateIdentityProviderRequest extends $dara.Model {
|
|
279
279
|
/**
|
|
280
280
|
* @remarks
|
|
281
|
-
* The configuration fields to be modified. For DingTalk and
|
|
281
|
+
* The configuration fields to be modified. For DingTalk and Feishu, you must submit at least one of the following fields: loginEnabled, syncEnabled, metadata, and syncScope. For CustomSSO, use the protocol, saml, and loginEnabled fields. You cannot submit the vendor metadata, syncEnabled, or syncScope fields.
|
|
282
282
|
*/
|
|
283
283
|
body?: UpdateIdentityProviderRequestBody;
|
|
284
284
|
static names(): { [key: string]: string } {
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class UpdateIdentityProviderResponseBodyDataConfiguration extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The actual SAML binding type saved
|
|
8
|
+
* The actual SAML binding type saved upstream, which is HTTP-Redirect or HTTP-POST.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* HTTP-Redirect
|
|
@@ -13,7 +13,7 @@ export class UpdateIdentityProviderResponseBodyDataConfiguration extends $dara.M
|
|
|
13
13
|
bindingType?: string;
|
|
14
14
|
/**
|
|
15
15
|
* @remarks
|
|
16
|
-
* The actual enterprise IdP entity ID saved
|
|
16
|
+
* The actual enterprise IdP entity ID saved upstream.
|
|
17
17
|
*
|
|
18
18
|
* @example
|
|
19
19
|
* https://idp.example.com/entity
|
|
@@ -21,7 +21,7 @@ export class UpdateIdentityProviderResponseBodyDataConfiguration extends $dara.M
|
|
|
21
21
|
entityId?: string;
|
|
22
22
|
/**
|
|
23
23
|
* @remarks
|
|
24
|
-
* The actual enterprise IdP SSO logon URL saved
|
|
24
|
+
* The actual enterprise IdP SSO logon URL saved upstream.
|
|
25
25
|
*
|
|
26
26
|
* @example
|
|
27
27
|
* https://idp.example.com/sso
|
|
@@ -29,7 +29,7 @@ export class UpdateIdentityProviderResponseBodyDataConfiguration extends $dara.M
|
|
|
29
29
|
loginUrl?: string;
|
|
30
30
|
/**
|
|
31
31
|
* @remarks
|
|
32
|
-
* The actual SSO logon status
|
|
32
|
+
* The actual SSO logon status upstream. Enabled indicates that it is turned on, and Disabled indicates that it is turned off. This should be evaluated separately from the expected value of loginEnabled.
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
35
|
* Enabled
|
|
@@ -128,7 +128,7 @@ export class UpdateIdentityProviderResponseBodyDataSaml extends $dara.Model {
|
|
|
128
128
|
export class UpdateIdentityProviderResponseBodyDataSyncScope extends $dara.Model {
|
|
129
129
|
/**
|
|
130
130
|
* @remarks
|
|
131
|
-
* The list of department IDs in the synchronization scope, obtained from ListIdentityProviderDepartments. In SelectedDepartments mode, at least one non-empty department ID
|
|
131
|
+
* The list of department IDs in the synchronization scope, which are obtained from ListIdentityProviderDepartments. In SelectedDepartments mode, you must provide at least one non-empty department ID. In AllAuthorized mode, this field should be omitted or an empty array should be passed.
|
|
132
132
|
*
|
|
133
133
|
* @example
|
|
134
134
|
* ["10001"]
|
|
@@ -136,7 +136,7 @@ export class UpdateIdentityProviderResponseBodyDataSyncScope extends $dara.Model
|
|
|
136
136
|
departmentIds?: string[];
|
|
137
137
|
/**
|
|
138
138
|
* @remarks
|
|
139
|
-
* The synchronization scope mode.
|
|
139
|
+
* The synchronization scope mode. Valid values: AllAuthorized and SelectedDepartments. AllAuthorized indicates all members within the authorization scope of the application address book. SelectedDepartments indicates the selected departments and all their sub-departments. When explicitly submitting syncScope, you must provide a valid mode.
|
|
140
140
|
*
|
|
141
141
|
* @example
|
|
142
142
|
* SelectedDepartments
|
|
@@ -171,12 +171,12 @@ export class UpdateIdentityProviderResponseBodyDataSyncScope extends $dara.Model
|
|
|
171
171
|
export class UpdateIdentityProviderResponseBodyData extends $dara.Model {
|
|
172
172
|
/**
|
|
173
173
|
* @remarks
|
|
174
|
-
* The actual SAML configuration read back from the upstream. This update
|
|
174
|
+
* The actual SAML configuration read back from the upstream. This update API does not perform this read-back and usually does not return this field. Use GetIdentityProvider to obtain it.
|
|
175
175
|
*/
|
|
176
176
|
configuration?: UpdateIdentityProviderResponseBodyDataConfiguration;
|
|
177
177
|
/**
|
|
178
178
|
* @remarks
|
|
179
|
-
* The type of the identity provider. DingTalk
|
|
179
|
+
* The type of the identity provider. DingTalk indicates DingTalk. Feishu indicates Feishu. CustomSSO indicates a custom enterprise identity provider connected through SAML. The value must be the same as the type of the identity provider bound to the current workspace.
|
|
180
180
|
*
|
|
181
181
|
* @example
|
|
182
182
|
* DingTalk
|
|
@@ -184,12 +184,12 @@ export class UpdateIdentityProviderResponseBodyData extends $dara.Model {
|
|
|
184
184
|
identityProviderType?: string;
|
|
185
185
|
/**
|
|
186
186
|
* @remarks
|
|
187
|
-
* The currently saved expected value
|
|
187
|
+
* The currently saved expected value for the logon switch. This alone does not prove that the upstream logon configuration has taken effect.
|
|
188
188
|
*/
|
|
189
189
|
loginEnabled?: boolean;
|
|
190
190
|
/**
|
|
191
191
|
* @remarks
|
|
192
|
-
* The currently saved logon protocol for CustomSSO
|
|
192
|
+
* The currently saved logon protocol for CustomSSO. The value is SAML when configured. This field is not returned for DingTalk or Lark.
|
|
193
193
|
*
|
|
194
194
|
* @example
|
|
195
195
|
* SAML
|
|
@@ -206,13 +206,13 @@ export class UpdateIdentityProviderResponseBodyData extends $dara.Model {
|
|
|
206
206
|
* - CONFIGURED: The configuration is accepted.
|
|
207
207
|
* - UPDATING: The configuration is being updated.
|
|
208
208
|
* - SYNCING: Synchronization is in progress.
|
|
209
|
-
* - SYNCED: The synchronization phase is
|
|
209
|
+
* - SYNCED: The synchronization phase is complete.
|
|
210
210
|
* - READY: The resource is ready.
|
|
211
211
|
* - SYNC_FAILED: Synchronization failed.
|
|
212
212
|
* - UPDATE_FAILED: The update failed.
|
|
213
213
|
* - DISCONNECTING: Unbinding is in progress.
|
|
214
214
|
* - DISCONNECT_FAILED: Unbinding failed.
|
|
215
|
-
* READY
|
|
215
|
+
* A value of READY does not alone indicate that users are imported. Query the SCIM operation results for CustomSSO separately.
|
|
216
216
|
*
|
|
217
217
|
* @example
|
|
218
218
|
* READY
|
|
@@ -220,12 +220,12 @@ export class UpdateIdentityProviderResponseBodyData extends $dara.Model {
|
|
|
220
220
|
status?: string;
|
|
221
221
|
/**
|
|
222
222
|
* @remarks
|
|
223
|
-
* The currently saved expected value
|
|
223
|
+
* The currently saved expected value for the synchronization switch. For DingTalk and Lark, this is used for subsequent address book change events. For CustomSSO, the SCIM switch is managed by using UpdateIdentityProviderSCIM, and the operation results are queried by using GetIdentityProviderSCIM.
|
|
224
224
|
*/
|
|
225
225
|
syncEnabled?: boolean;
|
|
226
226
|
/**
|
|
227
227
|
* @remarks
|
|
228
|
-
* The saved synchronization scope for DingTalk and Lark. The default value for valid historical configurations is AllAuthorized
|
|
228
|
+
* The saved synchronization scope for DingTalk and Lark. The default value for valid historical configurations is AllAuthorized. This field may not be returned for corrupted historical configurations. This field is not returned for CustomSSO.
|
|
229
229
|
*/
|
|
230
230
|
syncScope?: UpdateIdentityProviderResponseBodyDataSyncScope;
|
|
231
231
|
/**
|
|
@@ -285,7 +285,7 @@ export class UpdateIdentityProviderResponseBodyData extends $dara.Model {
|
|
|
285
285
|
export class UpdateIdentityProviderResponseBody extends $dara.Model {
|
|
286
286
|
/**
|
|
287
287
|
* @remarks
|
|
288
|
-
* The business status code
|
|
288
|
+
* The business status code for this API request. A value of SUCCESS indicates that the request succeeded, but does not indicate that the asynchronous configuration or synchronization task is complete.
|
|
289
289
|
*
|
|
290
290
|
* @example
|
|
291
291
|
* SUCCESS
|
|
@@ -298,7 +298,7 @@ export class UpdateIdentityProviderResponseBody extends $dara.Model {
|
|
|
298
298
|
data?: UpdateIdentityProviderResponseBodyData;
|
|
299
299
|
/**
|
|
300
300
|
* @remarks
|
|
301
|
-
* The HTTP status code
|
|
301
|
+
* The HTTP status code for this API request. This does not indicate the execution result of the background task.
|
|
302
302
|
*
|
|
303
303
|
* @example
|
|
304
304
|
* 200
|
|
@@ -306,7 +306,7 @@ export class UpdateIdentityProviderResponseBody extends $dara.Model {
|
|
|
306
306
|
httpStatusCode?: number;
|
|
307
307
|
/**
|
|
308
308
|
* @remarks
|
|
309
|
-
* The response message
|
|
309
|
+
* The response message for this API request. An error description is returned if the request fails.
|
|
310
310
|
*
|
|
311
311
|
* @example
|
|
312
312
|
* success
|
|
@@ -314,7 +314,7 @@ export class UpdateIdentityProviderResponseBody extends $dara.Model {
|
|
|
314
314
|
message?: string;
|
|
315
315
|
/**
|
|
316
316
|
* @remarks
|
|
317
|
-
* The unique identifier
|
|
317
|
+
* The unique identifier for this request. Provide this value when you troubleshoot issues.
|
|
318
318
|
*
|
|
319
319
|
* @example
|
|
320
320
|
* request-123456
|
|
@@ -322,7 +322,7 @@ export class UpdateIdentityProviderResponseBody extends $dara.Model {
|
|
|
322
322
|
requestId?: string;
|
|
323
323
|
/**
|
|
324
324
|
* @remarks
|
|
325
|
-
* Indicates whether
|
|
325
|
+
* Indicates whether this API request succeeded. To check whether the background configuration has taken effect, you must query the identity provider status separately.
|
|
326
326
|
*/
|
|
327
327
|
success?: boolean;
|
|
328
328
|
static names(): { [key: string]: string } {
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class UpdateIdentityProviderSCIMRequestBody extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* Do not set this parameter to true during CustomSSO initialization. You can only update
|
|
8
|
+
* Specifies whether to enable synchronization. Do not set this parameter to true during CustomSSO initialization. You can only update this parameter by calling UpdateIdentityProviderSCIM later. Determine the result based on the operationStatus field.
|
|
9
9
|
*
|
|
10
10
|
* This parameter is required.
|
|
11
11
|
*/
|
|
@@ -34,7 +34,7 @@ export class UpdateIdentityProviderSCIMRequestBody extends $dara.Model {
|
|
|
34
34
|
export class UpdateIdentityProviderSCIMRequest extends $dara.Model {
|
|
35
35
|
/**
|
|
36
36
|
* @remarks
|
|
37
|
-
* Submits business parameters as described in this API. The body parameters of the public API are mapped to the backend wrapper by the gateway. Do not mix them with the backend direct connection body wrapper.
|
|
37
|
+
* Submits the business parameters as described in this API. The body parameters of the public API are mapped to the backend wrapper by the gateway. Do not mix them with the backend direct connection body wrapper.
|
|
38
38
|
*
|
|
39
39
|
* This parameter is required.
|
|
40
40
|
*/
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class UpdateIdentityProviderSCIMResponseBodyDataConfiguration extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The SAML binding type. Valid values: HTTP-Redirect and HTTP-POST. This parameter is required when you manually enter the configuration. The query returns the short name.
|
|
8
|
+
* The SAML binding type. Valid values: HTTP-Redirect and HTTP-POST. This parameter is required when you manually enter the configuration. The query operation returns the short name.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* HTTP-Redirect
|
|
@@ -13,7 +13,7 @@ export class UpdateIdentityProviderSCIMResponseBodyDataConfiguration extends $da
|
|
|
13
13
|
bindingType?: string;
|
|
14
14
|
/**
|
|
15
15
|
* @remarks
|
|
16
|
-
* The entity ID of the IdP. This parameter is required when you manually enter the configuration. It
|
|
16
|
+
* The entity ID of the IdP. This parameter is required when you manually enter the configuration. It must be non-empty and cannot exceed 2,048 characters. You cannot change the entity ID if it is already configured. This ID is different from the entity ID of the service provider (SP) returned by the query operation.
|
|
17
17
|
*
|
|
18
18
|
* @example
|
|
19
19
|
* https://idp.example.com/entity
|
|
@@ -29,7 +29,7 @@ export class UpdateIdentityProviderSCIMResponseBodyDataConfiguration extends $da
|
|
|
29
29
|
loginUrl?: string;
|
|
30
30
|
/**
|
|
31
31
|
* @remarks
|
|
32
|
-
* The actual SSO logon status of AgentIdentity.
|
|
32
|
+
* The actual SSO logon status of AgentIdentity. Valid values: Enabled and Disabled. This value is not equivalent to the expected value of loginEnabled saved in AC.
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
35
|
* Enabled
|
|
@@ -65,7 +65,7 @@ export class UpdateIdentityProviderSCIMResponseBodyDataConfiguration extends $da
|
|
|
65
65
|
export class UpdateIdentityProviderSCIMResponseBodyDataMetadata extends $dara.Model {
|
|
66
66
|
/**
|
|
67
67
|
* @remarks
|
|
68
|
-
* The
|
|
68
|
+
* The SAML binding URI in the historical metadata snapshot. To update CustomSSO, use the saml.bindingType field.
|
|
69
69
|
*
|
|
70
70
|
* @example
|
|
71
71
|
* urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect
|
|
@@ -73,7 +73,7 @@ export class UpdateIdentityProviderSCIMResponseBodyDataMetadata extends $dara.Mo
|
|
|
73
73
|
binding?: string;
|
|
74
74
|
/**
|
|
75
75
|
* @remarks
|
|
76
|
-
* The
|
|
76
|
+
* The certificate string in the historical metadata snapshot. To edit the configuration, use the saml.x509Certificates field and do not submit the old metadata.
|
|
77
77
|
*
|
|
78
78
|
* @example
|
|
79
79
|
* MIICwDCCAaigAwIBAgIULlsHLfcADyBax5ZtFlj+YGzZVo0wDQYJKoZIhvcNAQELBQAwGjEYMBYGA1UEAwwPaWRwLmV4YW1wbGUuY29tMB4XDTI2MDEwMTAwMDAwMFoXDTM2MDEwMTAwMDAwMFowGjEYMBYGA1UEAwwPaWRwLmV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAto0DN0W1CrPRzK9QZ9A1aApb4Lg8oGlp2c0PbN3LokXe/HzwxCMXx65IDnrenttxzTwp9BgUnUN/3LRzWaOL2UQ/vNYNW9LFLkI1T64UPyI7eyi28YlALhb41xkYhEp7rz+MjqifBzVZeTDUxBYtbK2hAhbYEL1+udwsXEx0KB7xuQ/rbI2OKeqAEAD1tfYg7T/SM2wrXNYhx+o1HtchM4/0I8Okkk27JQ4y3ofzC5sTySmFF1Y7XcpSd+5WSyazedhkAieo8AB01DkJV6nnKfH8sH0EBsnH3FP8FhqCLrIeEkjX9B9OcIRLGjiZqx4u/ryW1QhMldnv+pFfNjWy/wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQC1hSQG8AwtGOoX2gKBK4Hi5XBrBreij8WlLTUWld0FINQ0Rg84f/27CjDthywj6wgxCesCuOVFhpxQa1UacsP/Gcai1aKABtLWImcaWECRYK5gDkwhTMFKM9mXA26hH1l4v/UR2iTpEK9H78egC4W7bs2LDTpPryuaNKTqP2O0tMbNkAHB8yecz5LxHXnxadL9Egow25g2RClvpifWqDnuS9TSbKkIWLcPLjocJj2K9ILpBwhXiXi/BiSgyYTLiYvVvih9vX4s+hKGZNJc0j92YLiOHDF0XH1oxgdVjfTmRiedeb2VZJZElptD92z0AqFR7z2d5B+OqpPA2gjuMLV5
|
|
@@ -81,7 +81,7 @@ export class UpdateIdentityProviderSCIMResponseBodyDataMetadata extends $dara.Mo
|
|
|
81
81
|
certificates?: string;
|
|
82
82
|
/**
|
|
83
83
|
* @remarks
|
|
84
|
-
* The entity ID of the IdP. This parameter is required when you manually enter the configuration. It
|
|
84
|
+
* The entity ID of the IdP. This parameter is required when you manually enter the configuration. It must be non-empty and cannot exceed 2,048 characters. You cannot change the entity ID if it is already configured. This ID is different from the entity ID of the service provider (SP) returned by the query operation.
|
|
85
85
|
*
|
|
86
86
|
* @example
|
|
87
87
|
* https://idp.example.com/entity
|
|
@@ -125,7 +125,7 @@ export class UpdateIdentityProviderSCIMResponseBodyDataMetadata extends $dara.Mo
|
|
|
125
125
|
export class UpdateIdentityProviderSCIMResponseBodyDataSaml extends $dara.Model {
|
|
126
126
|
/**
|
|
127
127
|
* @remarks
|
|
128
|
-
* The SAML binding type. Valid values: HTTP-Redirect and HTTP-POST. This parameter is required when you manually enter the configuration. The query returns the short name.
|
|
128
|
+
* The SAML binding type. Valid values: HTTP-Redirect and HTTP-POST. This parameter is required when you manually enter the configuration. The query operation returns the short name.
|
|
129
129
|
*
|
|
130
130
|
* @example
|
|
131
131
|
* HTTP-Redirect
|
|
@@ -133,7 +133,7 @@ export class UpdateIdentityProviderSCIMResponseBodyDataSaml extends $dara.Model
|
|
|
133
133
|
bindingType?: string;
|
|
134
134
|
/**
|
|
135
135
|
* @remarks
|
|
136
|
-
* The entity ID of the IdP. This parameter is required when you manually enter the configuration. It
|
|
136
|
+
* The entity ID of the IdP. This parameter is required when you manually enter the configuration. It must be non-empty and cannot exceed 2,048 characters. You cannot change the entity ID if it is already configured. This ID is different from the entity ID of the service provider (SP) returned by the query operation.
|
|
137
137
|
*
|
|
138
138
|
* @example
|
|
139
139
|
* https://idp.example.com/entity
|
|
@@ -149,7 +149,7 @@ export class UpdateIdentityProviderSCIMResponseBodyDataSaml extends $dara.Model
|
|
|
149
149
|
loginUrl?: string;
|
|
150
150
|
/**
|
|
151
151
|
* @remarks
|
|
152
|
-
* The list of IdP signing certificates.
|
|
152
|
+
* The list of IdP signing certificates. This parameter is required when you manually enter the configuration. It must be a non-empty array and use PEM X.509 certificate text. The system verifies the current validity period. A maximum of two certificates are allowed after deduplication.
|
|
153
153
|
*
|
|
154
154
|
* @example
|
|
155
155
|
* ["-----BEGIN CERTIFICATE-----\\\\nMIICwDCCAaigAwIBAgIULlsHLfcADyBax5ZtFlj+YGzZVo0wDQYJKoZIhvcNAQEL\\\\nBQAwGjEYMBYGA1UEAwwPaWRwLmV4YW1wbGUuY29tMB4XDTI2MDEwMTAwMDAwMFoX\\\\nDTM2MDEwMTAwMDAwMFowGjEYMBYGA1UEAwwPaWRwLmV4YW1wbGUuY29tMIIBIjAN\\\\nBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAto0DN0W1CrPRzK9QZ9A1aApb4Lg8\\\\noGlp2c0PbN3LokXe/HzwxCMXx65IDnrenttxzTwp9BgUnUN/3LRzWaOL2UQ/vNYN\\\\nW9LFLkI1T64UPyI7eyi28YlALhb41xkYhEp7rz+MjqifBzVZeTDUxBYtbK2hAhbY\\\\nEL1+udwsXEx0KB7xuQ/rbI2OKeqAEAD1tfYg7T/SM2wrXNYhx+o1HtchM4/0I8Ok\\\\nkk27JQ4y3ofzC5sTySmFF1Y7XcpSd+5WSyazedhkAieo8AB01DkJV6nnKfH8sH0E\\\\nBsnH3FP8FhqCLrIeEkjX9B9OcIRLGjiZqx4u/ryW1QhMldnv+pFfNjWy/wIDAQAB\\\\nMA0GCSqGSIb3DQEBCwUAA4IBAQC1hSQG8AwtGOoX2gKBK4Hi5XBrBreij8WlLTUW\\\\nld0FINQ0Rg84f/27CjDthywj6wgxCesCuOVFhpxQa1UacsP/Gcai1aKABtLWImca\\\\nWECRYK5gDkwhTMFKM9mXA26hH1l4v/UR2iTpEK9H78egC4W7bs2LDTpPryuaNKTq\\\\nP2O0tMbNkAHB8yecz5LxHXnxadL9Egow25g2RClvpifWqDnuS9TSbKkIWLcPLjoc\\\\nJj2K9ILpBwhXiXi/BiSgyYTLiYvVvih9vX4s+hKGZNJc0j92YLiOHDF0XH1oxgdV\\\\njfTmRiedeb2VZJZElptD92z0AqFR7z2d5B+OqpPA2gjuMLV5\\\\n-----END CERTIFICATE-----"]
|
|
@@ -188,12 +188,12 @@ export class UpdateIdentityProviderSCIMResponseBodyDataSaml extends $dara.Model
|
|
|
188
188
|
export class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Model {
|
|
189
189
|
/**
|
|
190
190
|
* @remarks
|
|
191
|
-
* The actual upstream configuration. The actual SAML configuration is read back on demand only
|
|
191
|
+
* The actual upstream configuration. The actual SAML configuration is read back on demand only by calling GetIdentityProvider. The SCIM query and preparation operations return the actual receiving status and URL.
|
|
192
192
|
*/
|
|
193
193
|
configuration?: UpdateIdentityProviderSCIMResponseBodyDataConfiguration;
|
|
194
194
|
/**
|
|
195
195
|
* @remarks
|
|
196
|
-
* The
|
|
196
|
+
* The time when the record was created on the server.
|
|
197
197
|
*
|
|
198
198
|
* @example
|
|
199
199
|
* 2026-10-26T00:00:00Z
|
|
@@ -201,7 +201,7 @@ export class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Model {
|
|
|
201
201
|
createdAt?: string;
|
|
202
202
|
/**
|
|
203
203
|
* @remarks
|
|
204
|
-
* The event
|
|
204
|
+
* The event callback URL for SAML. CustomSSO returns an empty string. You can obtain the SCIM receiving address by calling the SCIM query or preparation API. The example shows an empty JSON string "". The actual value does not contain double quotes.
|
|
205
205
|
*
|
|
206
206
|
* @example
|
|
207
207
|
* ""
|
|
@@ -209,7 +209,7 @@ export class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Model {
|
|
|
209
209
|
eventSubscriptionCallbackUrl?: string;
|
|
210
210
|
/**
|
|
211
211
|
* @remarks
|
|
212
|
-
* The identity provider
|
|
212
|
+
* The type of the identity provider. Common CRUD operations support DingTalk, Feishu, and CustomSSO. The SP query operation supports only CustomSSO. The SCIM path uses the CustomSSO shared pool.
|
|
213
213
|
*
|
|
214
214
|
* @example
|
|
215
215
|
* CustomSSO
|
|
@@ -217,7 +217,7 @@ export class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Model {
|
|
|
217
217
|
identityProviderType?: string;
|
|
218
218
|
/**
|
|
219
219
|
* @remarks
|
|
220
|
-
* The
|
|
220
|
+
* The callback URL for SAML. CustomSSO returns an empty string. You can obtain the Assertion Consumer Service (ACS) URL of SAML by calling the SP query API. The example shows an empty JSON string "". The actual value does not contain double quotes.
|
|
221
221
|
*
|
|
222
222
|
* @example
|
|
223
223
|
* ""
|
|
@@ -225,17 +225,17 @@ export class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Model {
|
|
|
225
225
|
loginCallbackUrl?: string;
|
|
226
226
|
/**
|
|
227
227
|
* @remarks
|
|
228
|
-
*
|
|
228
|
+
* Specifies whether logon is enabled. Do not set this parameter to true during CustomSSO initialization. You must save a valid SAML configuration before enabling logon. Disabling logon does not delete the configuration. If an asynchronous failure occurs, this expected value does not indicate that the upstream configuration has taken effect.
|
|
229
229
|
*/
|
|
230
230
|
loginEnabled?: boolean;
|
|
231
231
|
/**
|
|
232
232
|
* @remarks
|
|
233
|
-
* The standard IdP metadata. Vendor parameters are used for DingTalk and Feishu. CustomSSO updates use protocol and saml
|
|
233
|
+
* The standard IdP metadata. Vendor parameters are used for DingTalk and Feishu. CustomSSO updates use the protocol and saml fields and do not accept this field. The returned value does not contain vendor keys.
|
|
234
234
|
*/
|
|
235
235
|
metadata?: UpdateIdentityProviderSCIMResponseBodyDataMetadata;
|
|
236
236
|
/**
|
|
237
237
|
* @remarks
|
|
238
|
-
* PENDING
|
|
238
|
+
* The status of the most recent SCIM operation. When the status is PENDING or RUNNING, poll the GetIdentityProviderSCIM API. This field retains the facts of failure, pause, and cancellation, and does not indicate the SAML status.
|
|
239
239
|
*
|
|
240
240
|
* @example
|
|
241
241
|
* PENDING
|
|
@@ -243,7 +243,7 @@ export class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Model {
|
|
|
243
243
|
operationStatus?: string;
|
|
244
244
|
/**
|
|
245
245
|
* @remarks
|
|
246
|
-
* The logon protocol.
|
|
246
|
+
* The logon protocol. Only SAML is supported. This field may not be returned if no valid configuration is saved. You cannot use OIDC as a placeholder for initialization.
|
|
247
247
|
*
|
|
248
248
|
* @example
|
|
249
249
|
* SAML
|
|
@@ -251,12 +251,12 @@ export class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Model {
|
|
|
251
251
|
protocol?: string;
|
|
252
252
|
/**
|
|
253
253
|
* @remarks
|
|
254
|
-
* The SAML logon configuration.
|
|
254
|
+
* The SAML logon configuration. You can enter an XML file or manually enter the complete configuration. The query operation returns the standardized configuration and does not echo the original XML. This field can be omitted if it is not configured.
|
|
255
255
|
*/
|
|
256
256
|
saml?: UpdateIdentityProviderSCIMResponseBodyDataSaml;
|
|
257
257
|
/**
|
|
258
258
|
* @remarks
|
|
259
|
-
*
|
|
259
|
+
* The independent SCIM configuration status. This field does not change the meaning of shared resources and logon configurations in the original status field. It corresponds to the data.status field in the query API.
|
|
260
260
|
*
|
|
261
261
|
* @example
|
|
262
262
|
* UPDATING
|
|
@@ -264,7 +264,7 @@ export class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Model {
|
|
|
264
264
|
scimStatus?: string;
|
|
265
265
|
/**
|
|
266
266
|
* @remarks
|
|
267
|
-
* The operation status of shared resources and logon configurations. It indicates the user pool lifecycle and logon configuration task status of CustomSSO, and does not
|
|
267
|
+
* The operation status of shared resources and logon configurations. It indicates the user pool lifecycle and logon configuration task status of CustomSSO, and does not indicate the SCIM operation result. You can query the SCIM switch result by using the operationStatus field returned by GetIdentityProviderSCIM. You cannot use this field to determine whether all protocols are configured.
|
|
268
268
|
*
|
|
269
269
|
* @example
|
|
270
270
|
* READY
|
|
@@ -272,12 +272,12 @@ export class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Model {
|
|
|
272
272
|
status?: string;
|
|
273
273
|
/**
|
|
274
274
|
* @remarks
|
|
275
|
-
* Do not set this parameter to true during CustomSSO initialization. You can only update
|
|
275
|
+
* Specifies whether to enable synchronization. Do not set this parameter to true during CustomSSO initialization. You can only update this parameter by calling UpdateIdentityProviderSCIM later. Determine the result based on the operationStatus field.
|
|
276
276
|
*/
|
|
277
277
|
syncEnabled?: boolean;
|
|
278
278
|
/**
|
|
279
279
|
* @remarks
|
|
280
|
-
* The
|
|
280
|
+
* The time when the record was last updated on the server.
|
|
281
281
|
*
|
|
282
282
|
* @example
|
|
283
283
|
* 2026-10-26T00:00:00Z
|
|
@@ -360,12 +360,12 @@ export class UpdateIdentityProviderSCIMResponseBody extends $dara.Model {
|
|
|
360
360
|
code?: string;
|
|
361
361
|
/**
|
|
362
362
|
* @remarks
|
|
363
|
-
* The
|
|
363
|
+
* The original binding details and new SCIM status. The original fields and the meaning of the status field are retained. The new scimStatus field corresponds to the data.status field in the query API. The operationStatus field retains the status of the most recent SCIM task.
|
|
364
364
|
*/
|
|
365
365
|
data?: UpdateIdentityProviderSCIMResponseBodyData;
|
|
366
366
|
/**
|
|
367
367
|
* @remarks
|
|
368
|
-
* The HTTP status code. It indicates the processing status of
|
|
368
|
+
* The HTTP status code of the current request. It indicates the processing status of the request and is not equivalent to the final result of the background task.
|
|
369
369
|
*
|
|
370
370
|
* @example
|
|
371
371
|
* 200
|
|
@@ -373,7 +373,7 @@ export class UpdateIdentityProviderSCIMResponseBody extends $dara.Model {
|
|
|
373
373
|
httpStatusCode?: number;
|
|
374
374
|
/**
|
|
375
375
|
* @remarks
|
|
376
|
-
* Task result message. It
|
|
376
|
+
* Task result message. It indicates the request acceptance or error message. You must check task result of an asynchronous task by calling the corresponding query API.
|
|
377
377
|
*
|
|
378
378
|
* @example
|
|
379
379
|
* success
|
|
@@ -381,7 +381,7 @@ export class UpdateIdentityProviderSCIMResponseBody extends $dara.Model {
|
|
|
381
381
|
message?: string;
|
|
382
382
|
/**
|
|
383
383
|
* @remarks
|
|
384
|
-
* The request ID. It is used to associate
|
|
384
|
+
* The request ID. It is used to associate the current call with troubleshooting. Retain this ID if the request fails.
|
|
385
385
|
*
|
|
386
386
|
* @example
|
|
387
387
|
* request-example
|
|
@@ -389,7 +389,7 @@ export class UpdateIdentityProviderSCIMResponseBody extends $dara.Model {
|
|
|
389
389
|
requestId?: string;
|
|
390
390
|
/**
|
|
391
391
|
* @remarks
|
|
392
|
-
* Indicates whether the request is successful. A value of true indicates that the request is processed successfully. For asynchronous
|
|
392
|
+
* Indicates whether the current request is successful. A value of true indicates that the request is processed successfully. For asynchronous write operations, you must continue to query the task result.
|
|
393
393
|
*/
|
|
394
394
|
success?: boolean;
|
|
395
395
|
static names(): { [key: string]: string } {
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class UpdateIdentityProviderSCIMShrinkRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* Submits business parameters as described in this API. The body parameters of the public API are mapped to the backend wrapper by the gateway. Do not mix them with the backend direct connection body wrapper.
|
|
8
|
+
* Submits the business parameters as described in this API. The body parameters of the public API are mapped to the backend wrapper by the gateway. Do not mix them with the backend direct connection body wrapper.
|
|
9
9
|
*
|
|
10
10
|
* This parameter is required.
|
|
11
11
|
*/
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class UpdateIdentityProviderShrinkRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The configuration fields to be modified. For DingTalk and
|
|
8
|
+
* The configuration fields to be modified. For DingTalk and Feishu, you must submit at least one of the following fields: loginEnabled, syncEnabled, metadata, and syncScope. For CustomSSO, use the protocol, saml, and loginEnabled fields. You cannot submit the vendor metadata, syncEnabled, or syncScope fields.
|
|
9
9
|
*/
|
|
10
10
|
bodyShrink?: string;
|
|
11
11
|
static names(): { [key: string]: string } {
|