@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
@@ -15,7 +15,7 @@ export class ListCustomAgentsResponseBodyItemsArtifactCode extends $dara.Model {
15
15
  entrypoint?: string;
16
16
  /**
17
17
  * @remarks
18
- * The identifier of the code runtime environment in the currently saved configuration. The runtime image uses a saved snapshot. Adding a new version to the directory does not automatically change the existing configuration.
18
+ * The identifier of the code runtime environment in the currently saved configuration. The runtime image uses the saved snapshot. Adding a new version to the directory does not automatically change the existing configuration.
19
19
  *
20
20
  * This parameter is required.
21
21
  *
@@ -69,9 +69,7 @@ export class ListCustomAgentsResponseBodyItemsArtifactContainer extends $dara.Mo
69
69
  entrypoint?: string;
70
70
  /**
71
71
  * @remarks
72
- * The ID of the Container Registry Enterprise instance.
73
- *
74
- * This parameter is required.
72
+ * The ID of the ACR Enterprise instance.
75
73
  *
76
74
  * @example
77
75
  * cri-example
@@ -79,9 +77,7 @@ export class ListCustomAgentsResponseBodyItemsArtifactContainer extends $dara.Mo
79
77
  instanceId?: string;
80
78
  /**
81
79
  * @remarks
82
- * The namespace of the Container Registry instance.
83
- *
84
- * This parameter is required.
80
+ * The ACR namespace.
85
81
  *
86
82
  * @example
87
83
  * team
@@ -89,9 +85,7 @@ export class ListCustomAgentsResponseBodyItemsArtifactContainer extends $dara.Mo
89
85
  namespace?: string;
90
86
  /**
91
87
  * @remarks
92
- * The name of the Container Registry image repository.
93
- *
94
- * This parameter is required.
88
+ * The name of the ACR image repository.
95
89
  *
96
90
  * @example
97
91
  * app
@@ -99,9 +93,7 @@ export class ListCustomAgentsResponseBodyItemsArtifactContainer extends $dara.Mo
99
93
  repo?: string;
100
94
  /**
101
95
  * @remarks
102
- * The tag of the image.
103
- *
104
- * This parameter is required.
96
+ * The image tag.
105
97
  *
106
98
  * @example
107
99
  * v1
@@ -315,7 +307,7 @@ export class ListCustomAgentsResponseBodyItemsProtocolPaths extends $dara.Model
315
307
  export class ListCustomAgentsResponseBodyItemsProtocol extends $dara.Model {
316
308
  /**
317
309
  * @remarks
318
- * The request header configuration for the current protocol. The key is the header name and the value is a string.
310
+ * The request header configuration of the current protocol. The key is the header name and the value is a string.
319
311
  */
320
312
  headers?: { [key: string]: string };
321
313
  /**
@@ -325,7 +317,10 @@ export class ListCustomAgentsResponseBodyItemsProtocol extends $dara.Model {
325
317
  paths?: ListCustomAgentsResponseBodyItemsProtocolPaths[];
326
318
  /**
327
319
  * @remarks
328
- * The invoke Protocol Type. Valid values: agui (AG-UI protocol), openai-chat-completion (OpenAI Chat Completions compatible protocol), and custom (custom protocol).
320
+ * The invoke Protocol Type. Valid values:
321
+ * - agui: AG-UI protocol.
322
+ * - openai-chat-completion: OpenAI Chat Completions compatible protocol.
323
+ * - custom: Custom protocol.
329
324
  *
330
325
  * This parameter is required.
331
326
  *
@@ -446,7 +441,14 @@ export class ListCustomAgentsResponseBodyItems extends $dara.Model {
446
441
  runtime?: string;
447
442
  /**
448
443
  * @remarks
449
- * The overall status of the agent. Valid values: Creating, Running, Failed, Updating, Deleting, and Deleted. To query the execution progress of the latest configuration, call the GetCustomAgent operation.
444
+ * The overall status of the agent. Valid values:
445
+ * - Creating: The agent is being created.
446
+ * - Running: The agent is running.
447
+ * - Failed: The agent failed.
448
+ * - Updating: The agent is being updated.
449
+ * - Deleting: The agent is being deleted.
450
+ * - Deleted: The agent is deleted.
451
+ * To query the execution progress of the latest configuration, call the GetCustomAgent operation.
450
452
  *
451
453
  * @example
452
454
  * Running
@@ -527,7 +529,7 @@ export class ListCustomAgentsResponseBodyItems extends $dara.Model {
527
529
  export class ListCustomAgentsResponseBody extends $dara.Model {
528
530
  /**
529
531
  * @remarks
530
- * The request result code. The value is SUCCESS when the request is successful.
532
+ * The request result code. The value is SUCCESS if the request is successful.
531
533
  *
532
534
  * @example
533
535
  * SUCCESS
@@ -535,7 +537,7 @@ export class ListCustomAgentsResponseBody extends $dara.Model {
535
537
  code?: string;
536
538
  /**
537
539
  * @remarks
538
- * The HTTP status code of the current request. The value is 200 when the request is successful.
540
+ * The HTTP status code of the request. The value is 200 if the request is successful.
539
541
  *
540
542
  * @example
541
543
  * 200
@@ -556,7 +558,7 @@ export class ListCustomAgentsResponseBody extends $dara.Model {
556
558
  maxResults?: number;
557
559
  /**
558
560
  * @remarks
559
- * The message that describes the processing result of the request. The value is success if the request succeeds.
561
+ * The message that describes the result of the request. The value is success if the request is successful.
560
562
  *
561
563
  * @example
562
564
  * success
@@ -564,7 +566,7 @@ export class ListCustomAgentsResponseBody extends $dara.Model {
564
566
  message?: string;
565
567
  /**
566
568
  * @remarks
567
- * The opaque token used to query the next page. An empty value indicates that no more pages exist. Pass this token as is in subsequent requests.
569
+ * The opaque token used to query the next page. An empty value indicates that no more pages are available. Pass this token as-is in subsequent requests.
568
570
  *
569
571
  * @example
570
572
  * djE6YWdlbnRjb3JlLmFnZW50Lmxpc3QuY3VzdG9tOjIw
@@ -572,7 +574,7 @@ export class ListCustomAgentsResponseBody extends $dara.Model {
572
574
  nextToken?: string;
573
575
  /**
574
576
  * @remarks
575
- * The unique identifier of the request, used to locate and troubleshoot issues.
577
+ * The unique identifier of the request. You can use this ID to locate and troubleshoot issues.
576
578
  *
577
579
  * @example
578
580
  * 550E8400-E29B-41D4-A716-446655440000
@@ -580,7 +582,7 @@ export class ListCustomAgentsResponseBody extends $dara.Model {
580
582
  requestId?: string;
581
583
  /**
582
584
  * @remarks
583
- * Indicates whether the request was processed successfully. A value of true indicates success. A successful creation, update, or deletion does not mean that the background operation is complete.
585
+ * Indicates whether the request was processed successfully. A value of true indicates that the request was successful. A successful creation, update, or deletion response does not mean that the background operation is complete.
584
586
  */
585
587
  success?: boolean;
586
588
  /**
@@ -13,7 +13,7 @@ export class ListIdentityProvidersRequest extends $dara.Model {
13
13
  maxResults?: number;
14
14
  /**
15
15
  * @remarks
16
- * The cursor for querying the next page. Do not specify this parameter for the first call. For subsequent calls, specify the nextToken value returned from the previous call.
16
+ * The cursor for querying the next page. Do not specify this parameter in the first call. Specify the nextToken returned in the previous call for subsequent calls.
17
17
  *
18
18
  * @example
19
19
  * aWRlbnRpdHktcHJvdmlkZXItb2Zmc2V0OjEw
@@ -13,7 +13,7 @@ export class ListIdentityProvidersResponseBodyItemsConfiguration extends $dara.M
13
13
  bindingType?: string;
14
14
  /**
15
15
  * @remarks
16
- * Required for manual entry. Must be non-empty and up to 2048 characters. Existing configurations cannot be changed. This is different from the local entity ID returned by SP queries.
16
+ * Required for manual entry. It must be non-empty and contain a maximum of 2,048 characters. Existing configurations cannot be changed. This is different from the local entity ID returned in SP queries.
17
17
  *
18
18
  * @example
19
19
  * https://idp.example.com/entity
@@ -21,7 +21,7 @@ export class ListIdentityProvidersResponseBodyItemsConfiguration extends $dara.M
21
21
  entityId?: string;
22
22
  /**
23
23
  * @remarks
24
- * Required for manual entry. Must be an absolute HTTPS URL without user credentials or fragments.
24
+ * Required for manual entry. It must be an absolute HTTPS URL without user credentials or fragments.
25
25
  *
26
26
  * @example
27
27
  * https://idp.example.com/sso
@@ -105,7 +105,7 @@ export class ListIdentityProvidersResponseBodyItemsMetadata extends $dara.Model
105
105
  corpId?: string;
106
106
  /**
107
107
  * @remarks
108
- * Required for manual entry. Must be non-empty and up to 2048 characters. Existing configurations cannot be changed. This is different from the local entity ID returned by SP queries.
108
+ * Required for manual entry. It must be non-empty and contain a maximum of 2,048 characters. Existing configurations cannot be changed. This is different from the local entity ID returned in SP queries.
109
109
  *
110
110
  * @example
111
111
  * https://idp.example.com/entity
@@ -113,7 +113,7 @@ export class ListIdentityProvidersResponseBodyItemsMetadata extends $dara.Model
113
113
  entityId?: string;
114
114
  /**
115
115
  * @remarks
116
- * Required for manual entry. Must be an absolute HTTPS URL without user credentials or fragments.
116
+ * Required for manual entry. It must be an absolute HTTPS URL without user credentials or fragments.
117
117
  *
118
118
  * @example
119
119
  * https://idp.example.com/sso
@@ -163,7 +163,7 @@ export class ListIdentityProvidersResponseBodyItemsSaml extends $dara.Model {
163
163
  bindingType?: string;
164
164
  /**
165
165
  * @remarks
166
- * Required for manual entry. Must be non-empty and up to 2048 characters. Existing configurations cannot be changed. This is different from the local entity ID returned by SP queries.
166
+ * Required for manual entry. It must be non-empty and contain a maximum of 2,048 characters. Existing configurations cannot be changed. This is different from the local entity ID returned in SP queries.
167
167
  *
168
168
  * @example
169
169
  * https://idp.example.com/entity
@@ -171,7 +171,7 @@ export class ListIdentityProvidersResponseBodyItemsSaml extends $dara.Model {
171
171
  entityId?: string;
172
172
  /**
173
173
  * @remarks
174
- * Required for manual entry. Must be an absolute HTTPS URL without user credentials or fragments.
174
+ * Required for manual entry. It must be an absolute HTTPS URL without user credentials or fragments.
175
175
  *
176
176
  * @example
177
177
  * https://idp.example.com/sso
@@ -179,7 +179,7 @@ export class ListIdentityProvidersResponseBodyItemsSaml extends $dara.Model {
179
179
  loginUrl?: string;
180
180
  /**
181
181
  * @remarks
182
- * Required as a non-empty array for manual entry. Uses PEM X.509 certificate text. Validates the current validity period. A maximum of two certificates are allowed after deduplication.
182
+ * A non-empty array is required for manual entry. Use PEM X.509 certificate text. The current validity period is verified. A maximum of two certificates are allowed after deduplication.
183
183
  *
184
184
  * @example
185
185
  * ["-----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-----"]
@@ -218,7 +218,7 @@ export class ListIdentityProvidersResponseBodyItemsSaml extends $dara.Model {
218
218
  export class ListIdentityProvidersResponseBodyItemsSyncScope extends $dara.Model {
219
219
  /**
220
220
  * @remarks
221
- * Must contain at least one non-empty department ID when set to SelectedDepartments. The IDs should be obtained from ListIdentityProviderDepartments. Pass an empty array or omit this parameter when set to AllAuthorized.
221
+ * When the mode is SelectedDepartments, it must contain at least one non-empty department ID obtained from ListIdentityProviderDepartments. When the mode is AllAuthorized, pass an empty array or omit this field.
222
222
  *
223
223
  * @example
224
224
  * ["10001"]
@@ -226,7 +226,10 @@ export class ListIdentityProvidersResponseBodyItemsSyncScope extends $dara.Model
226
226
  departmentIds?: string[];
227
227
  /**
228
228
  * @remarks
229
- * AllAuthorized: the full authorization scope, limited by the application address book authorization. SelectedDepartments: the selected departments and all their sub-departments. A valid mode must be provided and verified by the backend when syncScope is explicitly submitted.
229
+ * Valid values:
230
+ * - AllAuthorized: The full authorization scope, limited by the application address book authorization.
231
+ * - SelectedDepartments: The selected departments and all their sub-departments.
232
+ * You must provide a valid mode when explicitly submitting syncScope. The backend verifies the mode.
230
233
  *
231
234
  * @example
232
235
  * SelectedDepartments
@@ -261,7 +264,7 @@ export class ListIdentityProvidersResponseBodyItemsSyncScope extends $dara.Model
261
264
  export class ListIdentityProvidersResponseBodyItems extends $dara.Model {
262
265
  /**
263
266
  * @remarks
264
- * The actual SAML configuration is retrieved on demand only through GetIdentityProvider. SCIM queries and provisioning return the actual receiving status and URL.
267
+ * The actual SAML configuration is read on demand only by GetIdentityProvider. SCIM queries and preparations return the actual received status and URLs.
265
268
  */
266
269
  configuration?: ListIdentityProvidersResponseBodyItemsConfiguration;
267
270
  /**
@@ -274,7 +277,7 @@ export class ListIdentityProvidersResponseBodyItems extends $dara.Model {
274
277
  createdAt?: string;
275
278
  /**
276
279
  * @remarks
277
- * The event subscription callback URL. Configure this URL in the external identity provider application to receive organization change events. Returns an empty string if the user pool is not activated.
280
+ * The event subscription callback URL. You must configure this URL in the external identity provider application to receive organization change events. An empty string is returned if the user pool is not activated.
278
281
  *
279
282
  * @example
280
283
  * http://auth.cn-hangzhou.agentteams.aliyuncs.com/roa/dingtalk/event/up-123456
@@ -290,7 +293,7 @@ export class ListIdentityProvidersResponseBodyItems extends $dara.Model {
290
293
  identityProviderType?: string;
291
294
  /**
292
295
  * @remarks
293
- * The logon callback URL. Configure this URL in the external identity provider application. Returns an empty string if the user pool is not activated.
296
+ * The logon callback URL. You must configure this URL in the external identity provider application. An empty string is returned if the user pool is not activated.
294
297
  *
295
298
  * @example
296
299
  * https://signin-cn-hangzhou.aliyunagentid.com/up-123456/dingtalk/callback
@@ -308,7 +311,7 @@ export class ListIdentityProvidersResponseBodyItems extends $dara.Model {
308
311
  metadata?: ListIdentityProvidersResponseBodyItemsMetadata;
309
312
  /**
310
313
  * @remarks
311
- * Only SAML is currently supported. May not be returned if no valid configuration is saved. OIDC placeholder initialization is not supported.
314
+ * Only SAML is currently supported. This field may not be returned if no valid configuration is saved. OIDC placeholder initialization is not supported.
312
315
  *
313
316
  * @example
314
317
  * SAML
@@ -316,12 +319,21 @@ export class ListIdentityProvidersResponseBodyItems extends $dara.Model {
316
319
  protocol?: string;
317
320
  /**
318
321
  * @remarks
319
- * Input supports either XML or full manual entry. Queries return the standardized configuration and do not echo the original XML. Can be omitted if not configured.
322
+ * The input supports either XML or complete manual entry. Queries return the standardized configuration and do not echo the original XML. This field can be omitted if it is not configured.
320
323
  */
321
324
  saml?: ListIdentityProvidersResponseBodyItemsSaml;
322
325
  /**
323
326
  * @remarks
324
- * The binding status. Valid values: CONFIGURED (the configuration is accepted and waiting for user pool activation), SYNCING (synchronizing organization members), SYNCED (organization member synchronization is completed), READY (the binding is effective), SYNC_FAILED (organization member synchronization failed), UPDATING (updating the configuration), UPDATE_FAILED (configuration update failed), DISCONNECTING (disconnecting), DISCONNECT_FAILED (disconnection failed).
327
+ * The binding status. Valid values:
328
+ * - CONFIGURED: The configuration is accepted and waiting for user pool activation.
329
+ * - SYNCING: Organization members are being synchronized.
330
+ * - SYNCED: Organization member synchronization is complete.
331
+ * - READY: The binding is in effect.
332
+ * - SYNC_FAILED: Organization member synchronization failed.
333
+ * - UPDATING: The configuration is being updated.
334
+ * - UPDATE_FAILED: Configuration update failed.
335
+ * - DISCONNECTING: The binding is being disconnected.
336
+ * - DISCONNECT_FAILED: Disconnection failed.
325
337
  *
326
338
  * @example
327
339
  * READY
@@ -329,12 +341,12 @@ export class ListIdentityProvidersResponseBodyItems extends $dara.Model {
329
341
  status?: string;
330
342
  /**
331
343
  * @remarks
332
- * Specifies whether to enable organization member synchronization. If enabled, the external identity provider synchronizes organization members as workspace users.
344
+ * Specifies whether to enable organization member synchronization. If enabled, organization members are synchronized as workspace users by this external identity provider.
333
345
  */
334
346
  syncEnabled?: boolean;
335
347
  /**
336
348
  * @remarks
337
- * Follows the department-based synchronization scope definition. If omitted during creation, the default is AllAuthorized. The first vendor synchronization is determined by syncOnBind. If omitted or null during an update, the original value is retained. Updating the saved scope does not automatically trigger full synchronization.
349
+ * Follows the department-based synchronization scope definition. If omitted during creation, the default value is AllAuthorized, and the first provider synchronization is determined by syncOnBind. If omitted or set to null during an update, the original value is retained. Updating the saved scope does not automatically trigger full synchronization.
338
350
  */
339
351
  syncScope?: ListIdentityProvidersResponseBodyItemsSyncScope;
340
352
  /**
@@ -444,7 +456,7 @@ export class ListIdentityProvidersResponseBody extends $dara.Model {
444
456
  maxResults?: number;
445
457
  /**
446
458
  * @remarks
447
- * The response message. Returns an error description if the request fails.
459
+ * The response message. An error description is returned if the request fails.
448
460
  *
449
461
  * @example
450
462
  * success
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class PrepareIdentityProviderSCIMResponseBodyDataConfiguration extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The URL configured for the external provisioning system. The presence of a URL does not indicate that the external configuration is completed or that AC synchronization is enabled.
8
+ * The URL configured for the external provisioning system. The presence of a URL does not indicate that the external configuration is completed or that access control synchronization is enabled.
9
9
  *
10
10
  * @example
11
11
  * https://example.com/scim/v2
@@ -13,7 +13,7 @@ export class PrepareIdentityProviderSCIMResponseBodyDataConfiguration extends $d
13
13
  baseUrl?: string;
14
14
  /**
15
15
  * @remarks
16
- * The AgentIdentity receiving status. Enabled indicates that SCIM receiving is enabled, and Disabled indicates that it is disabled. This status is not equivalent to the expected value of syncEnabled in AC.
16
+ * The receiving status of AgentIdentity. Enabled indicates that SCIM receiving is enabled, and Disabled indicates that it is disabled. This status is not equivalent to the expected value of syncEnabled for access control.
17
17
  *
18
18
  * @example
19
19
  * Enabled
@@ -69,7 +69,7 @@ export class PrepareIdentityProviderSCIMResponseBodyDataCredential extends $dara
69
69
  expireTime?: string;
70
70
  /**
71
71
  * @remarks
72
- * The AgentIdentity credential status. Only credentials that are in the Enabled state and have not expired are considered available. This field is not the operationStatus of a SCIM task.
72
+ * The credential status of AgentIdentity. Only credentials that are in the Enabled state and have not expired are considered available. This field is not the operationStatus of a SCIM task.
73
73
  *
74
74
  * @example
75
75
  * Enabled
@@ -105,17 +105,17 @@ export class PrepareIdentityProviderSCIMResponseBodyDataCredential extends $dara
105
105
  export class PrepareIdentityProviderSCIMResponseBodyData extends $dara.Model {
106
106
  /**
107
107
  * @remarks
108
- * The AgentIdentity receiving configuration. The actual SAML configuration is read on demand only by calling GetIdentityProvider. SCIM query and prepare operations return the actual receiving status and URL.
108
+ * The actual SAML configuration is read on demand only by using GetIdentityProvider. SCIM query and prepare operations return the actual receiving status and URL.
109
109
  */
110
110
  configuration?: PrepareIdentityProviderSCIMResponseBodyDataConfiguration;
111
111
  /**
112
112
  * @remarks
113
- * The current credential summary, including credentialId, status, createTime, and expireTime. It does not include the repeatedly retrievable token.
113
+ * The current credential summary, which includes the credentialId, status, createTime, and expireTime fields. This summary does not include the token.
114
114
  */
115
115
  credential?: PrepareIdentityProviderSCIMResponseBodyDataCredential;
116
116
  /**
117
117
  * @remarks
118
- * The plaintext token returned only when a new credential is created. If the prepare operation reuses a valid credential, this value is null. The token cannot be retrieved again from the list. If the response is lost, query the list first. The token is not automatically reissued. Do not write the token to logs or persistent frontend caches.
118
+ * The plaintext token is returned only when a new credential is created. If the prepare operation reuses a valid credential, this field is null. The token cannot be retrieved again from the list. If the response is lost, query the list first instead of automatically reissuing the token. Do not write the token to logs or persist it in frontend caches.
119
119
  *
120
120
  * @example
121
121
  * example-scim-token
@@ -163,12 +163,12 @@ export class PrepareIdentityProviderSCIMResponseBody extends $dara.Model {
163
163
  code?: string;
164
164
  /**
165
165
  * @remarks
166
- * The operation result. For the result structure, see the response fields of this API operation. For asynchronous write API operations, the response indicates that the request is accepted and does not guarantee that the background task is completed.
166
+ * The operation result. For the result structure, see the response fields of this API. For asynchronous write APIs, the response indicates that the request is accepted, but does not guarantee that the background task is completed.
167
167
  */
168
168
  data?: PrepareIdentityProviderSCIMResponseBodyData;
169
169
  /**
170
170
  * @remarks
171
- * The HTTP status code of the current request. This code indicates the processing status of the request and is not equivalent to the final result of the background task.
171
+ * The processing status of the current request. This status is not equivalent to the final result of the background task.
172
172
  *
173
173
  * @example
174
174
  * 200
@@ -176,7 +176,7 @@ export class PrepareIdentityProviderSCIMResponseBody extends $dara.Model {
176
176
  httpStatusCode?: number;
177
177
  /**
178
178
  * @remarks
179
- * The result message, which indicates that the request is accepted or contains an error message. For asynchronous tasks, check the task result by calling the corresponding query API operation.
179
+ * The request acceptance or error message. For asynchronous tasks, you must check the task result by using the corresponding query API.
180
180
  *
181
181
  * @example
182
182
  * success
@@ -192,7 +192,7 @@ export class PrepareIdentityProviderSCIMResponseBody extends $dara.Model {
192
192
  requestId?: string;
193
193
  /**
194
194
  * @remarks
195
- * 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.
195
+ * Indicates whether the current request is processed successfully. A value of true indicates success. For asynchronous write operations, you must continue to query the task result.
196
196
  */
197
197
  success?: boolean;
198
198
  static names(): { [key: string]: string } {