@alicloud/agentcore20260804 3.0.0 → 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 +29 -17
- package/dist/models/GetIdentityProviderScimresponseBody.js +2 -0
- 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 +42 -26
- package/dist/models/UpdateIdentityProviderScimresponseBody.js +4 -0
- package/dist/models/UpdateIdentityProviderScimresponseBody.js.map +1 -1
- 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 +31 -17
- 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 +46 -26
- 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 GetIdentityProviderResponseBodyDataConfiguration extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* HTTP-Redirect or HTTP-POST.
|
|
8
|
+
* The SAML binding type, which is HTTP-Redirect or HTTP-POST. Required for manual entry. Queries return the short name.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* HTTP-Redirect
|
|
@@ -13,7 +13,7 @@ export class GetIdentityProviderResponseBodyDataConfiguration extends $dara.Mode
|
|
|
13
13
|
bindingType?: string;
|
|
14
14
|
/**
|
|
15
15
|
* @remarks
|
|
16
|
-
*
|
|
16
|
+
* The IdP entity ID. Required for manual entry. Must be non-empty and no more than 2,048 characters in length. Existing configurations cannot be changed. This is different from the entity ID of the service provider (SP) returned in queries.
|
|
17
17
|
*
|
|
18
18
|
* @example
|
|
19
19
|
* https://idp.example.com/entity
|
|
@@ -21,7 +21,7 @@ export class GetIdentityProviderResponseBodyDataConfiguration extends $dara.Mode
|
|
|
21
21
|
entityId?: string;
|
|
22
22
|
/**
|
|
23
23
|
* @remarks
|
|
24
|
-
*
|
|
24
|
+
* The IdP logon URL. Required for manual entry. Must be an absolute HTTPS URL without user credentials or fragments.
|
|
25
25
|
*
|
|
26
26
|
* @example
|
|
27
27
|
* https://idp.example.com/sso
|
|
@@ -29,7 +29,7 @@ export class GetIdentityProviderResponseBodyDataConfiguration extends $dara.Mode
|
|
|
29
29
|
loginUrl?: string;
|
|
30
30
|
/**
|
|
31
31
|
* @remarks
|
|
32
|
-
* The actual switch value is Enabled or Disabled. This is not equivalent to the expected loginEnabled value saved
|
|
32
|
+
* The actual switch value, which is Enabled or Disabled. This is not equivalent to the expected loginEnabled value saved in AC.
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
35
|
* Enabled
|
|
@@ -65,7 +65,7 @@ export class GetIdentityProviderResponseBodyDataConfiguration extends $dara.Mode
|
|
|
65
65
|
export class GetIdentityProviderResponseBodyDataMetadata extends $dara.Model {
|
|
66
66
|
/**
|
|
67
67
|
* @remarks
|
|
68
|
-
* The App ID of the Lark application.
|
|
68
|
+
* The App ID of the Lark application. Required when the binding type is Feishu.
|
|
69
69
|
*
|
|
70
70
|
* @example
|
|
71
71
|
* cli_exampleappid01
|
|
@@ -73,7 +73,7 @@ export class GetIdentityProviderResponseBodyDataMetadata extends $dara.Model {
|
|
|
73
73
|
appId?: string;
|
|
74
74
|
/**
|
|
75
75
|
* @remarks
|
|
76
|
-
* The AppKey of the DingTalk application.
|
|
76
|
+
* The AppKey of the DingTalk application. Required when the binding type is DingTalk.
|
|
77
77
|
*
|
|
78
78
|
* @example
|
|
79
79
|
* dingexampleappkey01
|
|
@@ -81,7 +81,7 @@ export class GetIdentityProviderResponseBodyDataMetadata extends $dara.Model {
|
|
|
81
81
|
appKey?: string;
|
|
82
82
|
/**
|
|
83
83
|
* @remarks
|
|
84
|
-
* The SAML
|
|
84
|
+
* The SAML binding URI in the historical metadata snapshot. To update CustomSSO, use saml.bindingType.
|
|
85
85
|
*
|
|
86
86
|
* @example
|
|
87
87
|
* urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect
|
|
@@ -97,7 +97,7 @@ export class GetIdentityProviderResponseBodyDataMetadata extends $dara.Model {
|
|
|
97
97
|
certificates?: string;
|
|
98
98
|
/**
|
|
99
99
|
* @remarks
|
|
100
|
-
* The CorpId of the DingTalk enterprise.
|
|
100
|
+
* The CorpId of the DingTalk enterprise. Required when the binding type is DingTalk.
|
|
101
101
|
*
|
|
102
102
|
* @example
|
|
103
103
|
* dingexamplecorpid01
|
|
@@ -105,7 +105,7 @@ export class GetIdentityProviderResponseBodyDataMetadata extends $dara.Model {
|
|
|
105
105
|
corpId?: string;
|
|
106
106
|
/**
|
|
107
107
|
* @remarks
|
|
108
|
-
*
|
|
108
|
+
* The IdP entity ID. Required for manual entry. Must be non-empty and no more than 2,048 characters in length. Existing configurations cannot be changed. This is different from the entity ID of the service provider (SP) returned in queries.
|
|
109
109
|
*
|
|
110
110
|
* @example
|
|
111
111
|
* https://idp.example.com/entity
|
|
@@ -113,7 +113,7 @@ export class GetIdentityProviderResponseBodyDataMetadata extends $dara.Model {
|
|
|
113
113
|
entityId?: string;
|
|
114
114
|
/**
|
|
115
115
|
* @remarks
|
|
116
|
-
*
|
|
116
|
+
* The IdP logon URL. Required for manual entry. Must be an absolute HTTPS URL without user credentials or fragments.
|
|
117
117
|
*
|
|
118
118
|
* @example
|
|
119
119
|
* https://idp.example.com/sso
|
|
@@ -155,7 +155,7 @@ export class GetIdentityProviderResponseBodyDataMetadata extends $dara.Model {
|
|
|
155
155
|
export class GetIdentityProviderResponseBodyDataSaml extends $dara.Model {
|
|
156
156
|
/**
|
|
157
157
|
* @remarks
|
|
158
|
-
* HTTP-Redirect or HTTP-POST.
|
|
158
|
+
* The SAML binding type, which is HTTP-Redirect or HTTP-POST. Required for manual entry. Queries return the short name.
|
|
159
159
|
*
|
|
160
160
|
* @example
|
|
161
161
|
* HTTP-Redirect
|
|
@@ -163,7 +163,7 @@ export class GetIdentityProviderResponseBodyDataSaml extends $dara.Model {
|
|
|
163
163
|
bindingType?: string;
|
|
164
164
|
/**
|
|
165
165
|
* @remarks
|
|
166
|
-
*
|
|
166
|
+
* The IdP entity ID. Required for manual entry. Must be non-empty and no more than 2,048 characters in length. Existing configurations cannot be changed. This is different from the entity ID of the service provider (SP) returned in queries.
|
|
167
167
|
*
|
|
168
168
|
* @example
|
|
169
169
|
* https://idp.example.com/entity
|
|
@@ -171,7 +171,7 @@ export class GetIdentityProviderResponseBodyDataSaml extends $dara.Model {
|
|
|
171
171
|
entityId?: string;
|
|
172
172
|
/**
|
|
173
173
|
* @remarks
|
|
174
|
-
*
|
|
174
|
+
* The IdP logon URL. Required for manual entry. 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 GetIdentityProviderResponseBodyDataSaml extends $dara.Model {
|
|
|
179
179
|
loginUrl?: string;
|
|
180
180
|
/**
|
|
181
181
|
* @remarks
|
|
182
|
-
*
|
|
182
|
+
* The list of IdP signing certificates. Required for manual entry. Must be a non-empty array using 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 GetIdentityProviderResponseBodyDataSaml extends $dara.Model {
|
|
|
218
218
|
export class GetIdentityProviderResponseBodyDataSyncScope extends $dara.Model {
|
|
219
219
|
/**
|
|
220
220
|
* @remarks
|
|
221
|
-
* When the mode is SelectedDepartments,
|
|
221
|
+
* The list of department IDs. When the mode is SelectedDepartments, at least one non-empty department ID must be included, which should be 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,8 +226,8 @@ export class GetIdentityProviderResponseBodyDataSyncScope extends $dara.Model {
|
|
|
226
226
|
departmentIds?: string[];
|
|
227
227
|
/**
|
|
228
228
|
* @remarks
|
|
229
|
-
* Valid values:
|
|
230
|
-
* - AllAuthorized:
|
|
229
|
+
* The scope mode. Valid values:
|
|
230
|
+
* - AllAuthorized: All authorized scopes, subject to the application address book authorization limits.
|
|
231
231
|
* - SelectedDepartments: The selected departments and all their sub-departments.
|
|
232
232
|
* When explicitly submitting syncScope, you must provide a valid mode, which is verified by the backend.
|
|
233
233
|
*
|
|
@@ -264,7 +264,7 @@ export class GetIdentityProviderResponseBodyDataSyncScope extends $dara.Model {
|
|
|
264
264
|
export class GetIdentityProviderResponseBodyData extends $dara.Model {
|
|
265
265
|
/**
|
|
266
266
|
* @remarks
|
|
267
|
-
* The actual SAML configuration is read back on demand only
|
|
267
|
+
* The actual SAML configuration is read back on demand only in GetIdentityProvider. SCIM queries and preparations return the actual receiving status and URL.
|
|
268
268
|
*/
|
|
269
269
|
configuration?: GetIdentityProviderResponseBodyDataConfiguration;
|
|
270
270
|
/**
|
|
@@ -285,7 +285,7 @@ export class GetIdentityProviderResponseBodyData extends $dara.Model {
|
|
|
285
285
|
eventSubscriptionCallbackUrl?: string;
|
|
286
286
|
/**
|
|
287
287
|
* @remarks
|
|
288
|
-
* The
|
|
288
|
+
* The external identity provider type. Valid values: DingTalk and Feishu.
|
|
289
289
|
*
|
|
290
290
|
* @example
|
|
291
291
|
* DingTalk
|
|
@@ -301,7 +301,7 @@ export class GetIdentityProviderResponseBodyData extends $dara.Model {
|
|
|
301
301
|
loginCallbackUrl?: string;
|
|
302
302
|
/**
|
|
303
303
|
* @remarks
|
|
304
|
-
* Specifies whether workspace users are allowed to log on through
|
|
304
|
+
* Specifies whether workspace users are allowed to log on through the external identity provider.
|
|
305
305
|
*/
|
|
306
306
|
loginEnabled?: boolean;
|
|
307
307
|
/**
|
|
@@ -311,7 +311,7 @@ export class GetIdentityProviderResponseBodyData extends $dara.Model {
|
|
|
311
311
|
metadata?: GetIdentityProviderResponseBodyDataMetadata;
|
|
312
312
|
/**
|
|
313
313
|
* @remarks
|
|
314
|
-
* Only SAML is currently supported. This
|
|
314
|
+
* The logon protocol. Only SAML is currently supported. This field may not be returned if no valid configuration is saved. OIDC placeholder initialization is not supported.
|
|
315
315
|
*
|
|
316
316
|
* @example
|
|
317
317
|
* SAML
|
|
@@ -319,21 +319,21 @@ export class GetIdentityProviderResponseBodyData extends $dara.Model {
|
|
|
319
319
|
protocol?: string;
|
|
320
320
|
/**
|
|
321
321
|
* @remarks
|
|
322
|
-
* The input supports either XML or complete manual entry. Queries return the standardized configuration and do not echo the original XML. This
|
|
322
|
+
* The SAML logon configuration. 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.
|
|
323
323
|
*/
|
|
324
324
|
saml?: GetIdentityProviderResponseBodyDataSaml;
|
|
325
325
|
/**
|
|
326
326
|
* @remarks
|
|
327
327
|
* The status. Valid values:
|
|
328
|
-
* - CONFIGURED: The configuration is accepted and waiting for the user pool to be activated.
|
|
328
|
+
* - CONFIGURED: The configuration is accepted and the system is waiting for the user pool to be activated.
|
|
329
329
|
* - SYNCING: Organization members are being synchronized.
|
|
330
|
-
* - SYNCED:
|
|
330
|
+
* - SYNCED: Organization members are synchronized.
|
|
331
331
|
* - READY: The binding is in effect.
|
|
332
|
-
* - SYNC_FAILED:
|
|
332
|
+
* - SYNC_FAILED: Organization member synchronization failed.
|
|
333
333
|
* - UPDATING: The configuration is being updated.
|
|
334
|
-
* - UPDATE_FAILED:
|
|
335
|
-
* - DISCONNECTING: The
|
|
336
|
-
* - DISCONNECT_FAILED:
|
|
334
|
+
* - UPDATE_FAILED: Configuration update failed.
|
|
335
|
+
* - DISCONNECTING: The binding is being removed.
|
|
336
|
+
* - DISCONNECT_FAILED: Binding removal failed.
|
|
337
337
|
*
|
|
338
338
|
* @example
|
|
339
339
|
* READY
|
|
@@ -341,12 +341,12 @@ export class GetIdentityProviderResponseBodyData extends $dara.Model {
|
|
|
341
341
|
status?: string;
|
|
342
342
|
/**
|
|
343
343
|
* @remarks
|
|
344
|
-
* Specifies whether
|
|
344
|
+
* Specifies whether organization member synchronization is enabled. After it is enabled, organization members are synchronized as workspace users by the external identity provider.
|
|
345
345
|
*/
|
|
346
346
|
syncEnabled?: boolean;
|
|
347
347
|
/**
|
|
348
348
|
* @remarks
|
|
349
|
-
* The synchronization scope definition by department
|
|
349
|
+
* The configured synchronization scope, which follows the synchronization scope definition by department. If omitted during creation, the default value is AllAuthorized, and the first vendor synchronization is determined by syncOnBind. If omitted or set to null during an update, the original value is retained. Updating and saving the scope does not automatically trigger full synchronization.
|
|
350
350
|
*/
|
|
351
351
|
syncScope?: GetIdentityProviderResponseBodyDataSyncScope;
|
|
352
352
|
/**
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class GetIdentityProviderSCIMResponseBodyDataConfiguration extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The URL configured for the external provisioning system. The presence of a URL does not
|
|
8
|
+
* The URL configured for the external provisioning system. The presence of a URL does not indicate that external configuration is complete or that AC synchronization is enabled.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* https://example.com/scim/v2
|
|
@@ -13,10 +13,7 @@ export class GetIdentityProviderSCIMResponseBodyDataConfiguration extends $dara.
|
|
|
13
13
|
baseUrl?: string;
|
|
14
14
|
/**
|
|
15
15
|
* @remarks
|
|
16
|
-
* The receiving status
|
|
17
|
-
* - Enabled: SCIM receiving is enabled.
|
|
18
|
-
* - Disabled: SCIM receiving is disabled.
|
|
19
|
-
* This is not equivalent to the expected value of syncEnabled for AC.
|
|
16
|
+
* The AgentIdentity receiving status. Enabled indicates that SCIM receiving is enabled. Disabled indicates that it is disabled. This is not equivalent to the expected value of syncEnabled for AC.
|
|
20
17
|
*
|
|
21
18
|
* @example
|
|
22
19
|
* Enabled
|
|
@@ -48,19 +45,19 @@ export class GetIdentityProviderSCIMResponseBodyDataConfiguration extends $dara.
|
|
|
48
45
|
export class GetIdentityProviderSCIMResponseBodyData extends $dara.Model {
|
|
49
46
|
/**
|
|
50
47
|
* @remarks
|
|
51
|
-
* The actual SAML configuration is read back on demand only in GetIdentityProvider. SCIM queries and preparations return the actual receiving status and URL.
|
|
48
|
+
* The actual receiving status and URL. The actual SAML configuration is read back on demand only in GetIdentityProvider. SCIM queries and preparations return the actual receiving status and URL.
|
|
52
49
|
*/
|
|
53
50
|
configuration?: GetIdentityProviderSCIMResponseBodyDataConfiguration;
|
|
54
51
|
/**
|
|
55
52
|
* @remarks
|
|
56
|
-
*
|
|
57
|
-
* - PENDING: Waiting
|
|
58
|
-
* - RUNNING:
|
|
53
|
+
* The status of the most recent SCIM operation task. This status is independent of the SAML logon binding status. Valid values:
|
|
54
|
+
* - PENDING: Waiting for execution.
|
|
55
|
+
* - RUNNING: Executing.
|
|
59
56
|
* - PAUSED: Paused.
|
|
60
57
|
* - SUCCESS: Succeeded.
|
|
61
58
|
* - FAILED: Failed.
|
|
62
59
|
* - CANCELED: Canceled.
|
|
63
|
-
* If there are no tasks,
|
|
60
|
+
* If there are no tasks, it returns null or is not returned. This status only represents the most recent SCIM switch and the initial full import task when enabled. It does not indicate credential issuance, external provisioning connection tests, or continuous incremental synchronization health. Clients poll this operation when the status is PENDING or RUNNING.
|
|
64
61
|
*
|
|
65
62
|
* @example
|
|
66
63
|
* SUCCESS
|
|
@@ -68,13 +65,29 @@ export class GetIdentityProviderSCIMResponseBodyData extends $dara.Model {
|
|
|
68
65
|
operationStatus?: string;
|
|
69
66
|
/**
|
|
70
67
|
* @remarks
|
|
71
|
-
*
|
|
68
|
+
* The independent SCIM configuration status. Valid values:
|
|
69
|
+
* - UNCONFIGURED: Preparation is not complete.
|
|
70
|
+
* - WAITING_CONFIGURATION: Receiving is enabled, a valid HTTPS URL and at least one valid token are available, waiting for external configuration and enablement confirmation.
|
|
71
|
+
* - UPDATING: The enablement or disablement task is PENDING or RUNNING.
|
|
72
|
+
* - READY: Synchronization is enabled and the current enablement task succeeded, and the receiving end, URL, and token are still available.
|
|
73
|
+
* - DISABLED: The disablement task succeeded, and the configuration, credentials, and users are retained.
|
|
74
|
+
* - UPDATE_FAILED: The operation failed, was paused, was canceled, or the configuration and credentials are unavailable when enablement is expected.
|
|
75
|
+
* This status is independent of the SAML or OIDC status. READY does not prove that Matrix execution or the continuous incremental link has been accepted.
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* READY
|
|
79
|
+
*/
|
|
80
|
+
status?: string;
|
|
81
|
+
/**
|
|
82
|
+
* @remarks
|
|
83
|
+
* Specifies whether local synchronization is expected. You must determine whether it takes effect based on the actual configuration and task records. Do not set this parameter to true during CustomSSO initialization. You can only update it later by calling UpdateIdentityProviderSCIM, and determine the result based on operationStatus.
|
|
72
84
|
*/
|
|
73
85
|
syncEnabled?: boolean;
|
|
74
86
|
static names(): { [key: string]: string } {
|
|
75
87
|
return {
|
|
76
88
|
configuration: 'configuration',
|
|
77
89
|
operationStatus: 'operationStatus',
|
|
90
|
+
status: 'status',
|
|
78
91
|
syncEnabled: 'syncEnabled',
|
|
79
92
|
};
|
|
80
93
|
}
|
|
@@ -83,6 +96,7 @@ export class GetIdentityProviderSCIMResponseBodyData extends $dara.Model {
|
|
|
83
96
|
return {
|
|
84
97
|
configuration: GetIdentityProviderSCIMResponseBodyDataConfiguration,
|
|
85
98
|
operationStatus: 'string',
|
|
99
|
+
status: 'string',
|
|
86
100
|
syncEnabled: 'boolean',
|
|
87
101
|
};
|
|
88
102
|
}
|
|
@@ -102,7 +116,7 @@ export class GetIdentityProviderSCIMResponseBodyData extends $dara.Model {
|
|
|
102
116
|
export class GetIdentityProviderSCIMResponseBody extends $dara.Model {
|
|
103
117
|
/**
|
|
104
118
|
* @remarks
|
|
105
|
-
*
|
|
119
|
+
* The business result code. Use this code along with the HTTP status code and message for error handling.
|
|
106
120
|
*
|
|
107
121
|
* @example
|
|
108
122
|
* SUCCESS
|
|
@@ -110,12 +124,12 @@ export class GetIdentityProviderSCIMResponseBody extends $dara.Model {
|
|
|
110
124
|
code?: string;
|
|
111
125
|
/**
|
|
112
126
|
* @remarks
|
|
113
|
-
* The
|
|
127
|
+
* The SCIM actual configuration, expected synchronization switch, and independent operation status. For the result structure, see the response fields of this operation. The response of an asynchronous write operation indicates that the request is accepted, but does not guarantee that the background task is complete.
|
|
114
128
|
*/
|
|
115
129
|
data?: GetIdentityProviderSCIMResponseBodyData;
|
|
116
130
|
/**
|
|
117
131
|
* @remarks
|
|
118
|
-
* The
|
|
132
|
+
* 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.
|
|
119
133
|
*
|
|
120
134
|
* @example
|
|
121
135
|
* 200
|
|
@@ -123,7 +137,7 @@ export class GetIdentityProviderSCIMResponseBody extends $dara.Model {
|
|
|
123
137
|
httpStatusCode?: number;
|
|
124
138
|
/**
|
|
125
139
|
* @remarks
|
|
126
|
-
*
|
|
140
|
+
* Task result message. It indicates that the request is accepted or provides an error message. For asynchronous tasks, you must check task results by calling the corresponding query operation.
|
|
127
141
|
*
|
|
128
142
|
* @example
|
|
129
143
|
* success
|
|
@@ -131,7 +145,7 @@ export class GetIdentityProviderSCIMResponseBody extends $dara.Model {
|
|
|
131
145
|
message?: string;
|
|
132
146
|
/**
|
|
133
147
|
* @remarks
|
|
134
|
-
*
|
|
148
|
+
* The request ID. It is used to associate the current call with troubleshooting. Retain this ID when a failure occurs.
|
|
135
149
|
*
|
|
136
150
|
* @example
|
|
137
151
|
* request-example
|
|
@@ -139,7 +153,7 @@ export class GetIdentityProviderSCIMResponseBody extends $dara.Model {
|
|
|
139
153
|
requestId?: string;
|
|
140
154
|
/**
|
|
141
155
|
* @remarks
|
|
142
|
-
* Indicates whether the current request is successful. A value of true indicates that the
|
|
156
|
+
* 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 results.
|
|
143
157
|
*/
|
|
144
158
|
success?: boolean;
|
|
145
159
|
static names(): { [key: string]: string } {
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class GetIdentityProviderServiceProviderRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
*
|
|
8
|
+
* The query parameter is required and only supports the exact value SAML. The response returns SAML.
|
|
9
9
|
*
|
|
10
10
|
* This parameter is required.
|
|
11
11
|
*
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class GetIdentityProviderServiceProviderResponseBodyData extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
*
|
|
8
|
+
* The SAML assertion consumer service (ACS) URL of the SP. Configure this URL in the external IdP.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* https://sp.example.com/saml/acs
|
|
@@ -13,7 +13,7 @@ export class GetIdentityProviderServiceProviderResponseBodyData extends $dara.Mo
|
|
|
13
13
|
acsUrl?: string;
|
|
14
14
|
/**
|
|
15
15
|
* @remarks
|
|
16
|
-
*
|
|
16
|
+
* The entity ID of the SP. Configure this ID in the external IdP. This is not the entity ID of the external IdP.
|
|
17
17
|
*
|
|
18
18
|
* @example
|
|
19
19
|
* https://sp.example.com/entity
|
|
@@ -21,7 +21,7 @@ export class GetIdentityProviderServiceProviderResponseBodyData extends $dara.Mo
|
|
|
21
21
|
entityId?: string;
|
|
22
22
|
/**
|
|
23
23
|
* @remarks
|
|
24
|
-
*
|
|
24
|
+
* The SP metadata XML for the external IdP to import. You cannot submit this XML as the IdP XML for SAML configuration.
|
|
25
25
|
*
|
|
26
26
|
* @example
|
|
27
27
|
* <EntityDescriptor xmlns="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://sp.example.com/entity"><SPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://sp.example.com/saml/acs" index="0"/></SPSSODescriptor></EntityDescriptor>
|
|
@@ -29,7 +29,7 @@ export class GetIdentityProviderServiceProviderResponseBodyData extends $dara.Mo
|
|
|
29
29
|
metadataXml?: string;
|
|
30
30
|
/**
|
|
31
31
|
* @remarks
|
|
32
|
-
*
|
|
32
|
+
* The query parameter is required and only supports the exact value SAML. The response returns SAML.
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
35
|
* SAML
|
|
@@ -65,7 +65,7 @@ export class GetIdentityProviderServiceProviderResponseBodyData extends $dara.Mo
|
|
|
65
65
|
export class GetIdentityProviderServiceProviderResponseBody extends $dara.Model {
|
|
66
66
|
/**
|
|
67
67
|
* @remarks
|
|
68
|
-
*
|
|
68
|
+
* If the request fails, handle the error based on the HTTP status code and the message.
|
|
69
69
|
*
|
|
70
70
|
* @example
|
|
71
71
|
* SUCCESS
|
|
@@ -73,12 +73,12 @@ export class GetIdentityProviderServiceProviderResponseBody extends $dara.Model
|
|
|
73
73
|
code?: string;
|
|
74
74
|
/**
|
|
75
75
|
* @remarks
|
|
76
|
-
*
|
|
76
|
+
* For the result structure, see the response fields of this operation. The response of an asynchronous write operation indicates that the request is accepted, but does not guarantee that the background task is completed.
|
|
77
77
|
*/
|
|
78
78
|
data?: GetIdentityProviderServiceProviderResponseBodyData;
|
|
79
79
|
/**
|
|
80
80
|
* @remarks
|
|
81
|
-
*
|
|
81
|
+
* The processing status of the current request. This is not equivalent to the final result of the background task.
|
|
82
82
|
*
|
|
83
83
|
* @example
|
|
84
84
|
* 200
|
|
@@ -86,7 +86,7 @@ export class GetIdentityProviderServiceProviderResponseBody extends $dara.Model
|
|
|
86
86
|
httpStatusCode?: number;
|
|
87
87
|
/**
|
|
88
88
|
* @remarks
|
|
89
|
-
*
|
|
89
|
+
* The request acceptance or error message. For the result of an asynchronous task, check the corresponding query operation.
|
|
90
90
|
*
|
|
91
91
|
* @example
|
|
92
92
|
* success
|
|
@@ -94,7 +94,7 @@ export class GetIdentityProviderServiceProviderResponseBody extends $dara.Model
|
|
|
94
94
|
message?: string;
|
|
95
95
|
/**
|
|
96
96
|
* @remarks
|
|
97
|
-
*
|
|
97
|
+
* The ID used to associate the current call with troubleshooting. Keep this ID if the request fails.
|
|
98
98
|
*
|
|
99
99
|
* @example
|
|
100
100
|
* request-example
|
|
@@ -102,7 +102,7 @@ export class GetIdentityProviderServiceProviderResponseBody extends $dara.Model
|
|
|
102
102
|
requestId?: string;
|
|
103
103
|
/**
|
|
104
104
|
* @remarks
|
|
105
|
-
* true
|
|
105
|
+
* A value of true indicates that the current request is processed successfully. For asynchronous writes, you must continue to query the task result.
|
|
106
106
|
*/
|
|
107
107
|
success?: boolean;
|
|
108
108
|
static names(): { [key: string]: string } {
|