@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.
Files changed (126) hide show
  1. package/dist/client.d.ts +370 -188
  2. package/dist/client.js +413 -188
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateCustomAgentRequest.d.ts +155 -53
  5. package/dist/models/CreateCustomAgentRequest.js +61 -1
  6. package/dist/models/CreateCustomAgentRequest.js.map +1 -1
  7. package/dist/models/CreateCustomAgentResponseBody.d.ts +305 -58
  8. package/dist/models/CreateCustomAgentResponseBody.js +153 -1
  9. package/dist/models/CreateCustomAgentResponseBody.js.map +1 -1
  10. package/dist/models/CreateIdentityProviderRequest.d.ts +12 -15
  11. package/dist/models/CreateIdentityProviderRequest.js.map +1 -1
  12. package/dist/models/CreateIdentityProviderResponseBody.d.ts +19 -22
  13. package/dist/models/CreateIdentityProviderResponseBody.js.map +1 -1
  14. package/dist/models/CreateManagedAgentRequest.d.ts +80 -45
  15. package/dist/models/CreateManagedAgentRequest.js +29 -1
  16. package/dist/models/CreateManagedAgentRequest.js.map +1 -1
  17. package/dist/models/CreateManagedAgentResponseBody.d.ts +98 -65
  18. package/dist/models/CreateManagedAgentResponseBody.js +29 -1
  19. package/dist/models/CreateManagedAgentResponseBody.js.map +1 -1
  20. package/dist/models/CreateManagedAgentShrinkRequest.d.ts +1 -1
  21. package/dist/models/DeleteIdentityProviderResponseBody.d.ts +10 -10
  22. package/dist/models/DeleteIdentityProviderScimcredentialResponseBody.d.ts +5 -5
  23. package/dist/models/FindCustomAgentImagePreparationRequest.d.ts +23 -0
  24. package/dist/models/FindCustomAgentImagePreparationRequest.js +58 -0
  25. package/dist/models/FindCustomAgentImagePreparationRequest.js.map +1 -0
  26. package/dist/models/FindCustomAgentImagePreparationResponse.d.ts +19 -0
  27. package/dist/models/FindCustomAgentImagePreparationResponse.js +69 -0
  28. package/dist/models/FindCustomAgentImagePreparationResponse.js.map +1 -0
  29. package/dist/models/FindCustomAgentImagePreparationResponseBody.d.ts +135 -0
  30. package/dist/models/FindCustomAgentImagePreparationResponseBody.js +122 -0
  31. package/dist/models/FindCustomAgentImagePreparationResponseBody.js.map +1 -0
  32. package/dist/models/GetCustomAgentImagePreparationRequest.d.ts +13 -0
  33. package/dist/models/GetCustomAgentImagePreparationRequest.js +54 -0
  34. package/dist/models/GetCustomAgentImagePreparationRequest.js.map +1 -0
  35. package/dist/models/GetCustomAgentImagePreparationResponse.d.ts +19 -0
  36. package/dist/models/GetCustomAgentImagePreparationResponse.js +69 -0
  37. package/dist/models/GetCustomAgentImagePreparationResponse.js.map +1 -0
  38. package/dist/models/GetCustomAgentImagePreparationResponseBody.d.ts +135 -0
  39. package/dist/models/GetCustomAgentImagePreparationResponseBody.js +122 -0
  40. package/dist/models/GetCustomAgentImagePreparationResponseBody.js.map +1 -0
  41. package/dist/models/GetCustomAgentResponseBody.d.ts +304 -51
  42. package/dist/models/GetCustomAgentResponseBody.js +153 -1
  43. package/dist/models/GetCustomAgentResponseBody.js.map +1 -1
  44. package/dist/models/GetIdentityProviderResponseBody.d.ts +30 -30
  45. package/dist/models/GetIdentityProviderScimresponseBody.d.ts +22 -18
  46. package/dist/models/GetIdentityProviderScimresponseBody.js.map +1 -1
  47. package/dist/models/GetIdentityProviderServiceProviderRequest.d.ts +1 -1
  48. package/dist/models/GetIdentityProviderServiceProviderResponseBody.d.ts +10 -10
  49. package/dist/models/GetManagedAgentResponseBody.d.ts +106 -75
  50. package/dist/models/GetManagedAgentResponseBody.js +29 -1
  51. package/dist/models/GetManagedAgentResponseBody.js.map +1 -1
  52. package/dist/models/GetWorkspaceAcrRamAuthorizeUrlRequest.d.ts +2 -2
  53. package/dist/models/GetWorkspaceAcrRamAuthorizeUrlResponseBody.d.ts +1 -1
  54. package/dist/models/ListCustomAgentsRequest.d.ts +2 -2
  55. package/dist/models/ListCustomAgentsResponseBody.d.ts +24 -22
  56. package/dist/models/ListCustomAgentsResponseBody.js.map +1 -1
  57. package/dist/models/ListIdentityProvidersRequest.d.ts +1 -1
  58. package/dist/models/ListIdentityProvidersResponseBody.d.ts +30 -18
  59. package/dist/models/ListIdentityProvidersResponseBody.js.map +1 -1
  60. package/dist/models/PrepareIdentityProviderScimresponseBody.d.ts +10 -10
  61. package/dist/models/UpdateCustomAgentRequest.d.ts +154 -75
  62. package/dist/models/UpdateCustomAgentRequest.js +61 -1
  63. package/dist/models/UpdateCustomAgentRequest.js.map +1 -1
  64. package/dist/models/UpdateCustomAgentResponseBody.d.ts +310 -65
  65. package/dist/models/UpdateCustomAgentResponseBody.js +153 -1
  66. package/dist/models/UpdateCustomAgentResponseBody.js.map +1 -1
  67. package/dist/models/UpdateCustomAgentShrinkRequest.d.ts +1 -1
  68. package/dist/models/UpdateIdentityProviderRequest.d.ts +20 -20
  69. package/dist/models/UpdateIdentityProviderResponseBody.d.ts +19 -19
  70. package/dist/models/UpdateIdentityProviderScimrequest.d.ts +2 -2
  71. package/dist/models/UpdateIdentityProviderScimresponseBody.d.ts +28 -28
  72. package/dist/models/UpdateIdentityProviderScimshrinkRequest.d.ts +1 -1
  73. package/dist/models/UpdateIdentityProviderShrinkRequest.d.ts +1 -1
  74. package/dist/models/UpdateManagedAgentRequest.d.ts +83 -46
  75. package/dist/models/UpdateManagedAgentRequest.js +29 -1
  76. package/dist/models/UpdateManagedAgentRequest.js.map +1 -1
  77. package/dist/models/UpdateManagedAgentResponseBody.d.ts +98 -65
  78. package/dist/models/UpdateManagedAgentResponseBody.js +29 -1
  79. package/dist/models/UpdateManagedAgentResponseBody.js.map +1 -1
  80. package/dist/models/UpdateManagedAgentShrinkRequest.d.ts +1 -1
  81. package/dist/models/model.d.ts +34 -0
  82. package/dist/models/model.js +267 -198
  83. package/dist/models/model.js.map +1 -1
  84. package/package.json +1 -1
  85. package/src/client.ts +418 -188
  86. package/src/models/CreateCustomAgentRequest.ts +197 -53
  87. package/src/models/CreateCustomAgentResponseBody.ts +412 -58
  88. package/src/models/CreateIdentityProviderRequest.ts +12 -15
  89. package/src/models/CreateIdentityProviderResponseBody.ts +19 -22
  90. package/src/models/CreateManagedAgentRequest.ts +99 -45
  91. package/src/models/CreateManagedAgentResponseBody.ts +117 -65
  92. package/src/models/CreateManagedAgentShrinkRequest.ts +1 -1
  93. package/src/models/DeleteIdentityProviderResponseBody.ts +10 -10
  94. package/src/models/DeleteIdentityProviderScimcredentialResponseBody.ts +5 -5
  95. package/src/models/FindCustomAgentImagePreparationRequest.ts +36 -0
  96. package/src/models/FindCustomAgentImagePreparationResponse.ts +40 -0
  97. package/src/models/FindCustomAgentImagePreparationResponseBody.ts +194 -0
  98. package/src/models/GetCustomAgentImagePreparationRequest.ts +24 -0
  99. package/src/models/GetCustomAgentImagePreparationResponse.ts +40 -0
  100. package/src/models/GetCustomAgentImagePreparationResponseBody.ts +194 -0
  101. package/src/models/GetCustomAgentResponseBody.ts +411 -51
  102. package/src/models/GetIdentityProviderResponseBody.ts +30 -30
  103. package/src/models/GetIdentityProviderScimresponseBody.ts +22 -18
  104. package/src/models/GetIdentityProviderServiceProviderRequest.ts +1 -1
  105. package/src/models/GetIdentityProviderServiceProviderResponseBody.ts +10 -10
  106. package/src/models/GetManagedAgentResponseBody.ts +125 -75
  107. package/src/models/GetWorkspaceAcrRamAuthorizeUrlRequest.ts +2 -2
  108. package/src/models/GetWorkspaceAcrRamAuthorizeUrlResponseBody.ts +1 -1
  109. package/src/models/ListCustomAgentsRequest.ts +2 -2
  110. package/src/models/ListCustomAgentsResponseBody.ts +24 -22
  111. package/src/models/ListIdentityProvidersRequest.ts +1 -1
  112. package/src/models/ListIdentityProvidersResponseBody.ts +30 -18
  113. package/src/models/PrepareIdentityProviderScimresponseBody.ts +10 -10
  114. package/src/models/UpdateCustomAgentRequest.ts +196 -75
  115. package/src/models/UpdateCustomAgentResponseBody.ts +417 -65
  116. package/src/models/UpdateCustomAgentShrinkRequest.ts +1 -1
  117. package/src/models/UpdateIdentityProviderRequest.ts +20 -20
  118. package/src/models/UpdateIdentityProviderResponseBody.ts +19 -19
  119. package/src/models/UpdateIdentityProviderScimrequest.ts +2 -2
  120. package/src/models/UpdateIdentityProviderScimresponseBody.ts +28 -28
  121. package/src/models/UpdateIdentityProviderScimshrinkRequest.ts +1 -1
  122. package/src/models/UpdateIdentityProviderShrinkRequest.ts +1 -1
  123. package/src/models/UpdateManagedAgentRequest.ts +102 -46
  124. package/src/models/UpdateManagedAgentResponseBody.ts +117 -65
  125. package/src/models/UpdateManagedAgentShrinkRequest.ts +1 -1
  126. package/src/models/model.ts +34 -0
@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
2
2
  export declare class UpdateIdentityProviderResponseBodyDataConfiguration extends $dara.Model {
3
3
  /**
4
4
  * @remarks
5
- * The actual SAML binding type saved in the upstream, which is HTTP-Redirect or HTTP-POST.
5
+ * The actual SAML binding type saved upstream, which is HTTP-Redirect or HTTP-POST.
6
6
  *
7
7
  * @example
8
8
  * HTTP-Redirect
@@ -10,7 +10,7 @@ export declare class UpdateIdentityProviderResponseBodyDataConfiguration extends
10
10
  bindingType?: string;
11
11
  /**
12
12
  * @remarks
13
- * The actual enterprise IdP entity ID saved in the upstream.
13
+ * The actual enterprise IdP entity ID saved upstream.
14
14
  *
15
15
  * @example
16
16
  * https://idp.example.com/entity
@@ -18,7 +18,7 @@ export declare class UpdateIdentityProviderResponseBodyDataConfiguration extends
18
18
  entityId?: string;
19
19
  /**
20
20
  * @remarks
21
- * The actual enterprise IdP SSO logon URL saved in the upstream.
21
+ * The actual enterprise IdP SSO logon URL saved upstream.
22
22
  *
23
23
  * @example
24
24
  * https://idp.example.com/sso
@@ -26,7 +26,7 @@ export declare class UpdateIdentityProviderResponseBodyDataConfiguration extends
26
26
  loginUrl?: string;
27
27
  /**
28
28
  * @remarks
29
- * The actual SSO logon status in the 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.
29
+ * 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.
30
30
  *
31
31
  * @example
32
32
  * Enabled
@@ -90,7 +90,7 @@ export declare class UpdateIdentityProviderResponseBodyDataSaml extends $dara.Mo
90
90
  export declare class UpdateIdentityProviderResponseBodyDataSyncScope extends $dara.Model {
91
91
  /**
92
92
  * @remarks
93
- * The list of department IDs in the synchronization scope, obtained from ListIdentityProviderDepartments. In SelectedDepartments mode, at least one non-empty department ID must be provided. In AllAuthorized mode, this parameter should be omitted or an empty array should be passed.
93
+ * 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.
94
94
  *
95
95
  * @example
96
96
  * ["10001"]
@@ -98,7 +98,7 @@ export declare class UpdateIdentityProviderResponseBodyDataSyncScope extends $da
98
98
  departmentIds?: string[];
99
99
  /**
100
100
  * @remarks
101
- * The synchronization scope mode. AllAuthorized: all members within the authorization scope of the application address book. SelectedDepartments: the selected departments and all their sub-departments. A valid mode must be provided when syncScope is explicitly submitted.
101
+ * 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.
102
102
  *
103
103
  * @example
104
104
  * SelectedDepartments
@@ -118,12 +118,12 @@ export declare class UpdateIdentityProviderResponseBodyDataSyncScope extends $da
118
118
  export declare class UpdateIdentityProviderResponseBodyData extends $dara.Model {
119
119
  /**
120
120
  * @remarks
121
- * The actual SAML configuration read back from the upstream. This update operation does not perform the read-back and usually does not return this field. Use GetIdentityProvider to obtain it.
121
+ * 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.
122
122
  */
123
123
  configuration?: UpdateIdentityProviderResponseBodyDataConfiguration;
124
124
  /**
125
125
  * @remarks
126
- * The type of the identity provider. DingTalk: DingTalk. Feishu: Lark. CustomSSO: 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.
126
+ * 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.
127
127
  *
128
128
  * @example
129
129
  * DingTalk
@@ -131,12 +131,12 @@ export declare class UpdateIdentityProviderResponseBodyData extends $dara.Model
131
131
  identityProviderType?: string;
132
132
  /**
133
133
  * @remarks
134
- * The currently saved expected value of the logon switch, which alone does not prove that the upstream logon configuration has taken effect.
134
+ * The currently saved expected value for the logon switch. This alone does not prove that the upstream logon configuration has taken effect.
135
135
  */
136
136
  loginEnabled?: boolean;
137
137
  /**
138
138
  * @remarks
139
- * The currently saved logon protocol for CustomSSO, which is SAML when configured. This field is not returned for DingTalk or Lark.
139
+ * The currently saved logon protocol for CustomSSO. The value is SAML when configured. This field is not returned for DingTalk or Lark.
140
140
  *
141
141
  * @example
142
142
  * SAML
@@ -153,13 +153,13 @@ export declare class UpdateIdentityProviderResponseBodyData extends $dara.Model
153
153
  * - CONFIGURED: The configuration is accepted.
154
154
  * - UPDATING: The configuration is being updated.
155
155
  * - SYNCING: Synchronization is in progress.
156
- * - SYNCED: The synchronization phase is completed.
156
+ * - SYNCED: The synchronization phase is complete.
157
157
  * - READY: The resource is ready.
158
158
  * - SYNC_FAILED: Synchronization failed.
159
159
  * - UPDATE_FAILED: The update failed.
160
160
  * - DISCONNECTING: Unbinding is in progress.
161
161
  * - DISCONNECT_FAILED: Unbinding failed.
162
- * READY alone does not indicate that users have been imported. Query the SCIM operation results for CustomSSO separately.
162
+ * A value of READY does not alone indicate that users are imported. Query the SCIM operation results for CustomSSO separately.
163
163
  *
164
164
  * @example
165
165
  * READY
@@ -167,12 +167,12 @@ export declare class UpdateIdentityProviderResponseBodyData extends $dara.Model
167
167
  status?: string;
168
168
  /**
169
169
  * @remarks
170
- * The currently saved expected value of the synchronization switch. For DingTalk and Lark, it is used for subsequent address book change events. The SCIM switch for CustomSSO is managed through UpdateIdentityProviderSCIM, and the operation results are queried through GetIdentityProviderSCIM.
170
+ * 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.
171
171
  */
172
172
  syncEnabled?: boolean;
173
173
  /**
174
174
  * @remarks
175
- * The saved synchronization scope for DingTalk and Lark. The default value for valid historical configurations is AllAuthorized, and this field may not be returned for corrupted historical configurations. This field is not returned for CustomSSO.
175
+ * 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.
176
176
  */
177
177
  syncScope?: UpdateIdentityProviderResponseBodyDataSyncScope;
178
178
  /**
@@ -197,7 +197,7 @@ export declare class UpdateIdentityProviderResponseBodyData extends $dara.Model
197
197
  export declare class UpdateIdentityProviderResponseBody extends $dara.Model {
198
198
  /**
199
199
  * @remarks
200
- * The business status code of the API request. SUCCESS indicates that the request is successful, but does not mean that the asynchronous configuration or synchronization task is completed.
200
+ * 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.
201
201
  *
202
202
  * @example
203
203
  * SUCCESS
@@ -210,7 +210,7 @@ export declare class UpdateIdentityProviderResponseBody extends $dara.Model {
210
210
  data?: UpdateIdentityProviderResponseBodyData;
211
211
  /**
212
212
  * @remarks
213
- * The HTTP status code of the API request, which does not represent the execution result of the background task.
213
+ * The HTTP status code for this API request. This does not indicate the execution result of the background task.
214
214
  *
215
215
  * @example
216
216
  * 200
@@ -218,7 +218,7 @@ export declare class UpdateIdentityProviderResponseBody extends $dara.Model {
218
218
  httpStatusCode?: number;
219
219
  /**
220
220
  * @remarks
221
- * The response message of the API request. An error description is returned if the request fails.
221
+ * The response message for this API request. An error description is returned if the request fails.
222
222
  *
223
223
  * @example
224
224
  * success
@@ -226,7 +226,7 @@ export declare class UpdateIdentityProviderResponseBody extends $dara.Model {
226
226
  message?: string;
227
227
  /**
228
228
  * @remarks
229
- * The unique identifier of the request. Provide this value when you troubleshoot issues.
229
+ * The unique identifier for this request. Provide this value when you troubleshoot issues.
230
230
  *
231
231
  * @example
232
232
  * request-123456
@@ -234,7 +234,7 @@ export declare class UpdateIdentityProviderResponseBody extends $dara.Model {
234
234
  requestId?: string;
235
235
  /**
236
236
  * @remarks
237
- * Indicates whether the API request is successful. To check whether the background configuration has taken effect, query the identity provider status separately.
237
+ * Indicates whether this API request succeeded. To check whether the background configuration has taken effect, you must query the identity provider status separately.
238
238
  */
239
239
  success?: boolean;
240
240
  static names(): {
@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
2
2
  export declare class UpdateIdentityProviderSCIMRequestBody extends $dara.Model {
3
3
  /**
4
4
  * @remarks
5
- * Do not set this parameter to true during CustomSSO initialization. You can only update it later by calling UpdateIdentityProviderSCIM. Determine the result based on operationStatus.
5
+ * 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.
6
6
  *
7
7
  * This parameter is required.
8
8
  */
@@ -21,7 +21,7 @@ export declare class UpdateIdentityProviderSCIMRequestBody extends $dara.Model {
21
21
  export declare class UpdateIdentityProviderSCIMRequest extends $dara.Model {
22
22
  /**
23
23
  * @remarks
24
- * 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.
24
+ * 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.
25
25
  *
26
26
  * This parameter is required.
27
27
  */
@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
2
2
  export declare class UpdateIdentityProviderSCIMResponseBodyDataConfiguration extends $dara.Model {
3
3
  /**
4
4
  * @remarks
5
- * 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.
5
+ * 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.
6
6
  *
7
7
  * @example
8
8
  * HTTP-Redirect
@@ -10,7 +10,7 @@ export declare class UpdateIdentityProviderSCIMResponseBodyDataConfiguration ext
10
10
  bindingType?: string;
11
11
  /**
12
12
  * @remarks
13
- * The entity ID of the IdP. This parameter is required when you manually enter the configuration. It cannot be empty and cannot exceed 2,048 characters. Existing configurations cannot be replaced. This is different from the entity ID of the SP returned by the SP query.
13
+ * 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.
14
14
  *
15
15
  * @example
16
16
  * https://idp.example.com/entity
@@ -26,7 +26,7 @@ export declare class UpdateIdentityProviderSCIMResponseBodyDataConfiguration ext
26
26
  loginUrl?: string;
27
27
  /**
28
28
  * @remarks
29
- * The actual SSO logon status of AgentIdentity. The actual switch value is Enabled or Disabled, which is not equivalent to the expected loginEnabled value saved in AC.
29
+ * 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.
30
30
  *
31
31
  * @example
32
32
  * Enabled
@@ -46,7 +46,7 @@ export declare class UpdateIdentityProviderSCIMResponseBodyDataConfiguration ext
46
46
  export declare class UpdateIdentityProviderSCIMResponseBodyDataMetadata extends $dara.Model {
47
47
  /**
48
48
  * @remarks
49
- * The canonical SAML binding identifier. It is the SAML binding URI in the historical metadata snapshot. For CustomSSO updates, use saml.bindingType.
49
+ * The SAML binding URI in the historical metadata snapshot. To update CustomSSO, use the saml.bindingType field.
50
50
  *
51
51
  * @example
52
52
  * urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect
@@ -54,7 +54,7 @@ export declare class UpdateIdentityProviderSCIMResponseBodyDataMetadata extends
54
54
  binding?: string;
55
55
  /**
56
56
  * @remarks
57
- * The canonical SAML certificate content. It is the certificate string in the historical metadata snapshot. To edit the configuration, use saml.x509Certificates and do not submit the old metadata.
57
+ * The certificate string in the historical metadata snapshot. To edit the configuration, use the saml.x509Certificates field and do not submit the old metadata.
58
58
  *
59
59
  * @example
60
60
  * MIICwDCCAaigAwIBAgIULlsHLfcADyBax5ZtFlj+YGzZVo0wDQYJKoZIhvcNAQELBQAwGjEYMBYGA1UEAwwPaWRwLmV4YW1wbGUuY29tMB4XDTI2MDEwMTAwMDAwMFoXDTM2MDEwMTAwMDAwMFowGjEYMBYGA1UEAwwPaWRwLmV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAto0DN0W1CrPRzK9QZ9A1aApb4Lg8oGlp2c0PbN3LokXe/HzwxCMXx65IDnrenttxzTwp9BgUnUN/3LRzWaOL2UQ/vNYNW9LFLkI1T64UPyI7eyi28YlALhb41xkYhEp7rz+MjqifBzVZeTDUxBYtbK2hAhbYEL1+udwsXEx0KB7xuQ/rbI2OKeqAEAD1tfYg7T/SM2wrXNYhx+o1HtchM4/0I8Okkk27JQ4y3ofzC5sTySmFF1Y7XcpSd+5WSyazedhkAieo8AB01DkJV6nnKfH8sH0EBsnH3FP8FhqCLrIeEkjX9B9OcIRLGjiZqx4u/ryW1QhMldnv+pFfNjWy/wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQC1hSQG8AwtGOoX2gKBK4Hi5XBrBreij8WlLTUWld0FINQ0Rg84f/27CjDthywj6wgxCesCuOVFhpxQa1UacsP/Gcai1aKABtLWImcaWECRYK5gDkwhTMFKM9mXA26hH1l4v/UR2iTpEK9H78egC4W7bs2LDTpPryuaNKTqP2O0tMbNkAHB8yecz5LxHXnxadL9Egow25g2RClvpifWqDnuS9TSbKkIWLcPLjocJj2K9ILpBwhXiXi/BiSgyYTLiYvVvih9vX4s+hKGZNJc0j92YLiOHDF0XH1oxgdVjfTmRiedeb2VZJZElptD92z0AqFR7z2d5B+OqpPA2gjuMLV5
@@ -62,7 +62,7 @@ export declare class UpdateIdentityProviderSCIMResponseBodyDataMetadata extends
62
62
  certificates?: string;
63
63
  /**
64
64
  * @remarks
65
- * The entity ID of the IdP. This parameter is required when you manually enter the configuration. It cannot be empty and cannot exceed 2,048 characters. Existing configurations cannot be replaced. This is different from the entity ID of the SP returned by the SP query.
65
+ * 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.
66
66
  *
67
67
  * @example
68
68
  * https://idp.example.com/entity
@@ -90,7 +90,7 @@ export declare class UpdateIdentityProviderSCIMResponseBodyDataMetadata extends
90
90
  export declare class UpdateIdentityProviderSCIMResponseBodyDataSaml extends $dara.Model {
91
91
  /**
92
92
  * @remarks
93
- * 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.
93
+ * 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.
94
94
  *
95
95
  * @example
96
96
  * HTTP-Redirect
@@ -98,7 +98,7 @@ export declare class UpdateIdentityProviderSCIMResponseBodyDataSaml extends $dar
98
98
  bindingType?: string;
99
99
  /**
100
100
  * @remarks
101
- * The entity ID of the IdP. This parameter is required when you manually enter the configuration. It cannot be empty and cannot exceed 2,048 characters. Existing configurations cannot be replaced. This is different from the entity ID of the SP returned by the SP query.
101
+ * 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.
102
102
  *
103
103
  * @example
104
104
  * https://idp.example.com/entity
@@ -114,7 +114,7 @@ export declare class UpdateIdentityProviderSCIMResponseBodyDataSaml extends $dar
114
114
  loginUrl?: string;
115
115
  /**
116
116
  * @remarks
117
- * The list of IdP signing certificates. When you manually enter the configuration, this parameter is required and must be a non-empty array. Use PEM X.509 certificate text. The current validity period is verified. A maximum of two certificates are allowed after deduplication.
117
+ * 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.
118
118
  *
119
119
  * @example
120
120
  * ["-----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-----"]
@@ -134,12 +134,12 @@ export declare class UpdateIdentityProviderSCIMResponseBodyDataSaml extends $dar
134
134
  export declare class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Model {
135
135
  /**
136
136
  * @remarks
137
- * The actual upstream configuration. The actual SAML configuration is read back on demand only in GetIdentityProvider. SCIM query and prepare operations return the actual receiving status and URL.
137
+ * 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.
138
138
  */
139
139
  configuration?: UpdateIdentityProviderSCIMResponseBodyDataConfiguration;
140
140
  /**
141
141
  * @remarks
142
- * The creation time recorded by the server.
142
+ * The time when the record was created on the server.
143
143
  *
144
144
  * @example
145
145
  * 2026-10-26T00:00:00Z
@@ -147,7 +147,7 @@ export declare class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Mo
147
147
  createdAt?: string;
148
148
  /**
149
149
  * @remarks
150
- * The event subscription callback URL. CustomSSO returns an empty string. You can obtain the SCIM receiving address through the SCIM query or prepare API. The example shows a JSON empty string "". The actual value does not contain double quotes.
150
+ * 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.
151
151
  *
152
152
  * @example
153
153
  * ""
@@ -155,7 +155,7 @@ export declare class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Mo
155
155
  eventSubscriptionCallbackUrl?: string;
156
156
  /**
157
157
  * @remarks
158
- * The identity provider type. General CRUD operations support DingTalk, Feishu, and CustomSSO. SP queries only support CustomSSO. The SCIM path fixedly uses the CustomSSO shared pool.
158
+ * 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.
159
159
  *
160
160
  * @example
161
161
  * CustomSSO
@@ -163,7 +163,7 @@ export declare class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Mo
163
163
  identityProviderType?: string;
164
164
  /**
165
165
  * @remarks
166
- * The logon callback URL. CustomSSO returns an empty string. You should obtain the ACS URL for SAML through the SP query API. The example shows a JSON empty string "". The actual value does not contain double quotes.
166
+ * 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.
167
167
  *
168
168
  * @example
169
169
  * ""
@@ -171,17 +171,17 @@ export declare class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Mo
171
171
  loginCallbackUrl?: string;
172
172
  /**
173
173
  * @remarks
174
- * The logon switch. Do not set this parameter to true during CustomSSO initialization. You must save a valid SAML configuration before enabling it. Disabling it does not delete the configuration. When an asynchronous failure occurs, this expected value does not mean that it has taken effect on the upstream.
174
+ * 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.
175
175
  */
176
176
  loginEnabled?: boolean;
177
177
  /**
178
178
  * @remarks
179
- * The standard IdP metadata. Vendor parameters are used for DingTalk and Feishu. CustomSSO updates use protocol and saml, and do not accept this field. The return value does not contain vendor keys.
179
+ * 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.
180
180
  */
181
181
  metadata?: UpdateIdentityProviderSCIMResponseBodyDataMetadata;
182
182
  /**
183
183
  * @remarks
184
- * PENDING/RUNNING 时轮询 GetIdentityProviderSCIM;保留失败、暂停和取消事实,不表示 SAML 状态。
184
+ * 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.
185
185
  *
186
186
  * @example
187
187
  * PENDING
@@ -189,7 +189,7 @@ export declare class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Mo
189
189
  operationStatus?: string;
190
190
  /**
191
191
  * @remarks
192
- * The logon protocol. Currently, only SAML is supported. This field may not be returned if no valid configuration is saved. OIDC placeholder initialization is not supported.
192
+ * 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.
193
193
  *
194
194
  * @example
195
195
  * SAML
@@ -197,12 +197,12 @@ export declare class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Mo
197
197
  protocol?: string;
198
198
  /**
199
199
  * @remarks
200
- * The SAML logon configuration. The input supports either XML or complete manual entry. The query returns the standardized configuration and does not echo the original XML. This field can be omitted if it is not configured.
200
+ * 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.
201
201
  */
202
202
  saml?: UpdateIdentityProviderSCIMResponseBodyDataSaml;
203
203
  /**
204
204
  * @remarks
205
- * 独立 SCIM 状态;不改变原 status 的共享资源及登录配置含义。与查询接口的 data.status 对应。
205
+ * 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.
206
206
  *
207
207
  * @example
208
208
  * UPDATING
@@ -210,7 +210,7 @@ export declare class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Mo
210
210
  scimStatus?: string;
211
211
  /**
212
212
  * @remarks
213
- * 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 represent the SCIM operation result. Query GetIdentityProviderSCIM.operationStatus for the SCIM switch result. You cannot use this field to determine whether all protocols are configured.
213
+ * 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.
214
214
  *
215
215
  * @example
216
216
  * READY
@@ -218,12 +218,12 @@ export declare class UpdateIdentityProviderSCIMResponseBodyData extends $dara.Mo
218
218
  status?: string;
219
219
  /**
220
220
  * @remarks
221
- * Do not set this parameter to true during CustomSSO initialization. You can only update it later by calling UpdateIdentityProviderSCIM. Determine the result based on operationStatus.
221
+ * 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.
222
222
  */
223
223
  syncEnabled?: boolean;
224
224
  /**
225
225
  * @remarks
226
- * The last update time recorded by the server.
226
+ * The time when the record was last updated on the server.
227
227
  *
228
228
  * @example
229
229
  * 2026-10-26T00:00:00Z
@@ -259,12 +259,12 @@ export declare class UpdateIdentityProviderSCIMResponseBody extends $dara.Model
259
259
  code?: string;
260
260
  /**
261
261
  * @remarks
262
- * The shared binding after the request is accepted. The status indicates the status of shared resources and logon configurations, not the status of this SCIM task. Query GetIdentityProviderSCIM.operationStatus for the execution result.
262
+ * 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.
263
263
  */
264
264
  data?: UpdateIdentityProviderSCIMResponseBodyData;
265
265
  /**
266
266
  * @remarks
267
- * The HTTP status code. It indicates the processing status of this request and is not equivalent to the final result of the background task.
267
+ * 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.
268
268
  *
269
269
  * @example
270
270
  * 200
@@ -272,7 +272,7 @@ export declare class UpdateIdentityProviderSCIMResponseBody extends $dara.Model
272
272
  httpStatusCode?: number;
273
273
  /**
274
274
  * @remarks
275
- * Task result message. It is the request acceptance or error message. For asynchronous tasks, you must check task result by calling the corresponding query API.
275
+ * 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.
276
276
  *
277
277
  * @example
278
278
  * success
@@ -280,7 +280,7 @@ export declare class UpdateIdentityProviderSCIMResponseBody extends $dara.Model
280
280
  message?: string;
281
281
  /**
282
282
  * @remarks
283
- * The request ID. It is used to associate this call with troubleshooting. Retain it when a failure occurs.
283
+ * The request ID. It is used to associate the current call with troubleshooting. Retain this ID if the request fails.
284
284
  *
285
285
  * @example
286
286
  * request-example
@@ -288,7 +288,7 @@ export declare class UpdateIdentityProviderSCIMResponseBody extends $dara.Model
288
288
  requestId?: string;
289
289
  /**
290
290
  * @remarks
291
- * Indicates whether the request is successful. A value of true indicates that the request is processed successfully. For asynchronous writes, you must continue to query the task result.
291
+ * 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.
292
292
  */
293
293
  success?: boolean;
294
294
  static names(): {
@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
2
2
  export declare class UpdateIdentityProviderSCIMShrinkRequest extends $dara.Model {
3
3
  /**
4
4
  * @remarks
5
- * 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.
5
+ * 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.
6
6
  *
7
7
  * This parameter is required.
8
8
  */
@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
2
2
  export declare class UpdateIdentityProviderShrinkRequest extends $dara.Model {
3
3
  /**
4
4
  * @remarks
5
- * The configuration fields to be modified. For DingTalk and Lark, you must submit at least one of loginEnabled, syncEnabled, metadata, and syncScope. For CustomSSO, use protocol, saml, and loginEnabled. You cannot submit vendor metadata, syncEnabled, or syncScope.
5
+ * 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.
6
6
  */
7
7
  bodyShrink?: string;
8
8
  static names(): {