@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 CreateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The app ID of the
|
|
8
|
+
* The app ID of the Lark application. This parameter is required when the binding type is Feishu.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* cli_exampleappid01
|
|
@@ -13,7 +13,7 @@ export class CreateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
|
13
13
|
appId?: string;
|
|
14
14
|
/**
|
|
15
15
|
* @remarks
|
|
16
|
-
* The
|
|
16
|
+
* The AppKey of the DingTalk application. This parameter is required when the binding type is DingTalk.
|
|
17
17
|
*
|
|
18
18
|
* @example
|
|
19
19
|
* dingexampleappkey01
|
|
@@ -21,7 +21,7 @@ export class CreateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
|
21
21
|
appKey?: string;
|
|
22
22
|
/**
|
|
23
23
|
* @remarks
|
|
24
|
-
* Required. The secret of the external identity provider application. This parameter is used only for writing and is not returned by
|
|
24
|
+
* Required. The secret of the external identity provider application. This parameter is used only for writing and is not returned by query API operations.
|
|
25
25
|
*
|
|
26
26
|
* @example
|
|
27
27
|
* example-app-secret
|
|
@@ -29,7 +29,7 @@ export class CreateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
|
29
29
|
appSecret?: string;
|
|
30
30
|
/**
|
|
31
31
|
* @remarks
|
|
32
|
-
* The
|
|
32
|
+
* The CorpId of the DingTalk enterprise. This parameter is required when the binding type is DingTalk.
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
35
|
* dingexamplecorpid01
|
|
@@ -37,7 +37,7 @@ export class CreateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
|
37
37
|
corpId?: string;
|
|
38
38
|
/**
|
|
39
39
|
* @remarks
|
|
40
|
-
* The data encryption key for event subscription. The value must be the same as the one configured in the external identity provider application. This parameter is used only for writing and is not returned by
|
|
40
|
+
* The data encryption key for event subscription. The value must be the same as the one configured in the external identity provider application. This parameter is used only for writing and is not returned by query API operations.
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
43
|
* example-encrypt-key
|
|
@@ -45,7 +45,7 @@ export class CreateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
|
45
45
|
encryptKey?: string;
|
|
46
46
|
/**
|
|
47
47
|
* @remarks
|
|
48
|
-
* The verification token for event subscription. The value must be the same as the one configured in the external identity provider application. This parameter is used only for writing and is not returned by
|
|
48
|
+
* The verification token for event subscription. The value must be the same as the one configured in the external identity provider application. This parameter is used only for writing and is not returned by query API operations.
|
|
49
49
|
*
|
|
50
50
|
* @example
|
|
51
51
|
* example-verification-token
|
|
@@ -85,7 +85,7 @@ export class CreateIdentityProviderRequestBodyMetadata extends $dara.Model {
|
|
|
85
85
|
export class CreateIdentityProviderRequestBodySyncScope extends $dara.Model {
|
|
86
86
|
/**
|
|
87
87
|
* @remarks
|
|
88
|
-
* When the mode is SelectedDepartments, at least one non-empty department ID
|
|
88
|
+
* When the mode is SelectedDepartments, the list must contain at least one non-empty department ID, which should be obtained from ListIdentityProviderDepartments. When the mode is AllAuthorized, pass an empty array or omit this parameter.
|
|
89
89
|
*
|
|
90
90
|
* @example
|
|
91
91
|
* ["10001"]
|
|
@@ -93,10 +93,7 @@ export class CreateIdentityProviderRequestBodySyncScope extends $dara.Model {
|
|
|
93
93
|
departmentIds?: string[];
|
|
94
94
|
/**
|
|
95
95
|
* @remarks
|
|
96
|
-
*
|
|
97
|
-
* - AllAuthorized: The full authorization scope, which is limited by the application address book authorization.
|
|
98
|
-
* - SelectedDepartments: The selected departments and all their sub-departments.
|
|
99
|
-
* When you explicitly submit syncScope, you must provide a valid mode, which is verified by the backend.
|
|
96
|
+
* AllAuthorized: the full authorization scope, which is limited by the application address book authorization. SelectedDepartments: the selected departments and all their sub-departments. When explicitly submitting syncScope, you must provide a valid mode, which is verified by the backend.
|
|
100
97
|
*
|
|
101
98
|
* @example
|
|
102
99
|
* SelectedDepartments
|
|
@@ -146,22 +143,22 @@ export class CreateIdentityProviderRequestBody extends $dara.Model {
|
|
|
146
143
|
loginEnabled?: boolean;
|
|
147
144
|
/**
|
|
148
145
|
* @remarks
|
|
149
|
-
* The application configuration of the external identity provider. When you bind DingTalk, you must provide appKey, appSecret, and corpId. When you bind
|
|
146
|
+
* The application configuration of the external identity provider. When you bind DingTalk, you must provide appKey, appSecret, and corpId. When you bind Lark, you must provide appId and appSecret.
|
|
150
147
|
*/
|
|
151
148
|
metadata?: CreateIdentityProviderRequestBodyMetadata;
|
|
152
149
|
/**
|
|
153
150
|
* @remarks
|
|
154
|
-
* Specifies whether to enable organization member synchronization.
|
|
151
|
+
* Specifies whether to enable organization member synchronization. If enabled, the external identity provider synchronizes organization members as workspace users.
|
|
155
152
|
*/
|
|
156
153
|
syncEnabled?: boolean;
|
|
157
154
|
/**
|
|
158
155
|
* @remarks
|
|
159
|
-
* Controls the first synchronization when DingTalk or
|
|
156
|
+
* Controls the first synchronization when DingTalk or Lark is bound. If omitted or set to null, the default value is true. If set to false, only the configuration is saved, and synchronization is explicitly triggered later. CustomSSO does not use the vendor pull link.
|
|
160
157
|
*/
|
|
161
158
|
syncOnBind?: boolean;
|
|
162
159
|
/**
|
|
163
160
|
* @remarks
|
|
164
|
-
* Retains the department-based synchronization scope definition. If
|
|
161
|
+
* Retains the department-based synchronization scope definition. If omitted during creation, the default value is AllAuthorized. 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 perform full synchronization.
|
|
165
162
|
*/
|
|
166
163
|
syncScope?: CreateIdentityProviderRequestBodySyncScope;
|
|
167
164
|
static names(): { [key: string]: string } {
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class CreateIdentityProviderResponseBodyDataConfiguration extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* HTTP-Redirect
|
|
8
|
+
* The SAML binding type. Valid values: HTTP-Redirect and HTTP-POST. This parameter is required for manual input. Queries return the short name.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* HTTP-Redirect
|
|
@@ -13,7 +13,7 @@ export class CreateIdentityProviderResponseBodyDataConfiguration extends $dara.M
|
|
|
13
13
|
bindingType?: string;
|
|
14
14
|
/**
|
|
15
15
|
* @remarks
|
|
16
|
-
* This parameter is required for manual
|
|
16
|
+
* The entity identifier of the identity provider (IdP). This parameter is required for manual input, must not be empty, and cannot exceed 2,048 characters. Existing configurations do not support replacement. 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 CreateIdentityProviderResponseBodyDataConfiguration extends $dara.M
|
|
|
21
21
|
entityId?: string;
|
|
22
22
|
/**
|
|
23
23
|
* @remarks
|
|
24
|
-
* This parameter is required for manual
|
|
24
|
+
* The logon URL of the IdP. This parameter is required for manual input and 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 CreateIdentityProviderResponseBodyDataConfiguration extends $dara.M
|
|
|
29
29
|
loginUrl?: string;
|
|
30
30
|
/**
|
|
31
31
|
* @remarks
|
|
32
|
-
* The actual
|
|
32
|
+
* The actual SSO logon status of AgentIdentity. Valid values: Enabled and Disabled. This value is not equivalent to the expected loginEnabled value saved in the access configuration (AC).
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
35
|
* Enabled
|
|
@@ -65,7 +65,7 @@ export class CreateIdentityProviderResponseBodyDataConfiguration extends $dara.M
|
|
|
65
65
|
export class CreateIdentityProviderResponseBodyDataSaml extends $dara.Model {
|
|
66
66
|
/**
|
|
67
67
|
* @remarks
|
|
68
|
-
* HTTP-Redirect
|
|
68
|
+
* The SAML binding type. Valid values: HTTP-Redirect and HTTP-POST. This parameter is required for manual input. Queries return the short name.
|
|
69
69
|
*
|
|
70
70
|
* @example
|
|
71
71
|
* HTTP-Redirect
|
|
@@ -73,7 +73,7 @@ export class CreateIdentityProviderResponseBodyDataSaml extends $dara.Model {
|
|
|
73
73
|
bindingType?: string;
|
|
74
74
|
/**
|
|
75
75
|
* @remarks
|
|
76
|
-
* This parameter is required for manual
|
|
76
|
+
* The entity identifier of the identity provider (IdP). This parameter is required for manual input, must not be empty, and cannot exceed 2,048 characters. Existing configurations do not support replacement. This is different from the entity ID of the service provider (SP) returned in queries.
|
|
77
77
|
*
|
|
78
78
|
* @example
|
|
79
79
|
* https://idp.example.com/entity
|
|
@@ -81,7 +81,7 @@ export class CreateIdentityProviderResponseBodyDataSaml extends $dara.Model {
|
|
|
81
81
|
entityId?: string;
|
|
82
82
|
/**
|
|
83
83
|
* @remarks
|
|
84
|
-
* This parameter is required for manual
|
|
84
|
+
* The logon URL of the IdP. This parameter is required for manual input and must be an absolute HTTPS URL without user credentials or fragments.
|
|
85
85
|
*
|
|
86
86
|
* @example
|
|
87
87
|
* https://idp.example.com/sso
|
|
@@ -89,7 +89,7 @@ export class CreateIdentityProviderResponseBodyDataSaml extends $dara.Model {
|
|
|
89
89
|
loginUrl?: string;
|
|
90
90
|
/**
|
|
91
91
|
* @remarks
|
|
92
|
-
*
|
|
92
|
+
* The list of IdP signing certificates. For manual input, a non-empty array is required, and PEM X.509 certificate text must be used. The current validity period is verified. A maximum of two certificates are allowed after deduplication.
|
|
93
93
|
*
|
|
94
94
|
* @example
|
|
95
95
|
* ["-----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-----"]
|
|
@@ -128,7 +128,7 @@ export class CreateIdentityProviderResponseBodyDataSaml extends $dara.Model {
|
|
|
128
128
|
export class CreateIdentityProviderResponseBodyDataSyncScope extends $dara.Model {
|
|
129
129
|
/**
|
|
130
130
|
* @remarks
|
|
131
|
-
* When the mode is SelectedDepartments, at least one non-empty department ID
|
|
131
|
+
* When the mode is SelectedDepartments, the list must contain at least one non-empty department ID, which should be obtained from ListIdentityProviderDepartments. When the mode is AllAuthorized, pass an empty array or omit this parameter.
|
|
132
132
|
*
|
|
133
133
|
* @example
|
|
134
134
|
* ["10001"]
|
|
@@ -136,10 +136,7 @@ export class CreateIdentityProviderResponseBodyDataSyncScope extends $dara.Model
|
|
|
136
136
|
departmentIds?: string[];
|
|
137
137
|
/**
|
|
138
138
|
* @remarks
|
|
139
|
-
*
|
|
140
|
-
* - AllAuthorized: The full authorization scope, which is limited by the application address book authorization.
|
|
141
|
-
* - SelectedDepartments: The selected departments and all their sub-departments.
|
|
142
|
-
* When you explicitly submit syncScope, you must provide a valid mode, which is verified by the backend.
|
|
139
|
+
* AllAuthorized: the full authorization scope, which is limited by the application address book authorization. SelectedDepartments: the selected departments and all their sub-departments. When explicitly submitting syncScope, you must provide a valid mode, which is verified by the backend.
|
|
143
140
|
*
|
|
144
141
|
* @example
|
|
145
142
|
* SelectedDepartments
|
|
@@ -174,7 +171,7 @@ export class CreateIdentityProviderResponseBodyDataSyncScope extends $dara.Model
|
|
|
174
171
|
export class CreateIdentityProviderResponseBodyData extends $dara.Model {
|
|
175
172
|
/**
|
|
176
173
|
* @remarks
|
|
177
|
-
* The actual SAML configuration is read back on demand only
|
|
174
|
+
* The actual SAML configuration is read back on demand only by the GetIdentityProvider operation. SCIM queries and preparations return the actual received status and URL.
|
|
178
175
|
*/
|
|
179
176
|
configuration?: CreateIdentityProviderResponseBodyDataConfiguration;
|
|
180
177
|
/**
|
|
@@ -192,7 +189,7 @@ export class CreateIdentityProviderResponseBodyData extends $dara.Model {
|
|
|
192
189
|
loginEnabled?: boolean;
|
|
193
190
|
/**
|
|
194
191
|
* @remarks
|
|
195
|
-
*
|
|
192
|
+
* The logon protocol. Currently, only SAML is supported. This parameter may not be returned if no valid configuration is saved. Placeholder initialization with OIDC is not supported.
|
|
196
193
|
*
|
|
197
194
|
* @example
|
|
198
195
|
* SAML
|
|
@@ -200,7 +197,7 @@ export class CreateIdentityProviderResponseBodyData extends $dara.Model {
|
|
|
200
197
|
protocol?: string;
|
|
201
198
|
/**
|
|
202
199
|
* @remarks
|
|
203
|
-
* The
|
|
200
|
+
* The SAML logon configuration. Input supports either XML or complete manual input. Queries return the standardized configuration and do not echo the original XML. This parameter can be omitted if not configured.
|
|
204
201
|
*/
|
|
205
202
|
saml?: CreateIdentityProviderResponseBodyDataSaml;
|
|
206
203
|
/**
|
|
@@ -208,13 +205,13 @@ export class CreateIdentityProviderResponseBodyData extends $dara.Model {
|
|
|
208
205
|
* The binding status. Valid values:
|
|
209
206
|
* - CONFIGURED: The configuration is accepted and waiting for the user pool to be activated.
|
|
210
207
|
* - SYNCING: Organization members are being synchronized.
|
|
211
|
-
* - SYNCED: Organization
|
|
208
|
+
* - SYNCED: Organization member synchronization is complete.
|
|
212
209
|
* - READY: The binding is in effect.
|
|
213
210
|
* - SYNC_FAILED: Organization member synchronization failed.
|
|
214
211
|
* - UPDATING: The configuration is being updated.
|
|
215
212
|
* - UPDATE_FAILED: Configuration update failed.
|
|
216
|
-
* - DISCONNECTING: The binding is being
|
|
217
|
-
* - DISCONNECT_FAILED:
|
|
213
|
+
* - DISCONNECTING: The binding is being disconnected.
|
|
214
|
+
* - DISCONNECT_FAILED: Disconnection failed.
|
|
218
215
|
*
|
|
219
216
|
* @example
|
|
220
217
|
* READY
|
|
@@ -222,12 +219,12 @@ export class CreateIdentityProviderResponseBodyData extends $dara.Model {
|
|
|
222
219
|
status?: string;
|
|
223
220
|
/**
|
|
224
221
|
* @remarks
|
|
225
|
-
* Specifies whether to enable organization member synchronization.
|
|
222
|
+
* Specifies whether to enable organization member synchronization. If enabled, the external identity provider synchronizes organization members as workspace users.
|
|
226
223
|
*/
|
|
227
224
|
syncEnabled?: boolean;
|
|
228
225
|
/**
|
|
229
226
|
* @remarks
|
|
230
|
-
* Retains the department-based synchronization scope definition. If
|
|
227
|
+
* Retains the department-based synchronization scope definition. If omitted during creation, the default value is AllAuthorized. 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 perform full synchronization.
|
|
231
228
|
*/
|
|
232
229
|
syncScope?: CreateIdentityProviderResponseBodyDataSyncScope;
|
|
233
230
|
/**
|
|
@@ -295,7 +292,7 @@ export class CreateIdentityProviderResponseBody extends $dara.Model {
|
|
|
295
292
|
code?: string;
|
|
296
293
|
/**
|
|
297
294
|
* @remarks
|
|
298
|
-
* The binding information
|
|
295
|
+
* The binding information for the external identity provider.
|
|
299
296
|
*/
|
|
300
297
|
data?: CreateIdentityProviderResponseBodyData;
|
|
301
298
|
/**
|