@alicloud/ecd20201002 2.1.17 → 3.0.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 +40 -41
- package/dist/client.js +66 -71
- package/dist/client.js.map +1 -1
- package/dist/models/ChangePasswordRequest.d.ts +1 -1
- package/dist/models/DeleteFingerPrintTemplateRequest.d.ts +6 -6
- package/dist/models/DeleteFingerPrintTemplateResponseBody.d.ts +1 -1
- package/dist/models/DescribeFingerPrintTemplatesResponseBody.d.ts +1 -1
- package/dist/models/DescribeGlobalDesktopsRequest.d.ts +28 -56
- package/dist/models/DescribeGlobalDesktopsRequest.js.map +1 -1
- package/dist/models/DescribeGlobalDesktopsResponseBody.d.ts +77 -153
- package/dist/models/DescribeGlobalDesktopsResponseBody.js.map +1 -1
- package/dist/models/DescribeOfficeSitesRequest.d.ts +8 -0
- package/dist/models/DescribeOfficeSitesRequest.js.map +1 -1
- package/dist/models/DescribeOfficeSitesResponseBody.d.ts +23 -0
- package/dist/models/DescribeOfficeSitesResponseBody.js.map +1 -1
- package/dist/models/DescribeRegionsRequest.d.ts +1 -1
- package/dist/models/DescribeRegionsResponseBody.d.ts +2 -2
- package/dist/models/DescribeSnapshotsResponseBody.d.ts +1 -1
- package/dist/models/DescribeUserResourcesRequest.d.ts +26 -75
- package/dist/models/DescribeUserResourcesRequest.js.map +1 -1
- package/dist/models/DescribeUserResourcesResponseBody.d.ts +173 -195
- package/dist/models/DescribeUserResourcesResponseBody.js +69 -1
- package/dist/models/DescribeUserResourcesResponseBody.js.map +1 -1
- package/dist/models/GetCloudDriveServiceMountTokenRequest.d.ts +15 -0
- package/dist/models/GetCloudDriveServiceMountTokenRequest.js.map +1 -1
- package/dist/models/GetCloudDriveServiceMountTokenResponseBody.d.ts +15 -0
- package/dist/models/GetCloudDriveServiceMountTokenResponseBody.js.map +1 -1
- package/dist/models/GetConnectionTicketRequest.d.ts +30 -17
- package/dist/models/GetConnectionTicketRequest.js.map +1 -1
- package/dist/models/GetConnectionTicketResponseBody.d.ts +26 -2
- package/dist/models/GetConnectionTicketResponseBody.js.map +1 -1
- package/dist/models/GetLoginTokenRequest.d.ts +28 -44
- package/dist/models/GetLoginTokenRequest.js.map +1 -1
- package/dist/models/GetLoginTokenResponseBody.d.ts +34 -32
- package/dist/models/GetLoginTokenResponseBody.js +4 -0
- package/dist/models/GetLoginTokenResponseBody.js.map +1 -1
- package/dist/models/GetLoginTokenShrinkRequest.d.ts +28 -44
- package/dist/models/GetLoginTokenShrinkRequest.js.map +1 -1
- package/dist/models/RebootDesktopsRequest.d.ts +10 -10
- package/dist/models/RebootDesktopsResponseBody.d.ts +1 -1
- package/dist/models/RefreshLoginTokenRequest.d.ts +17 -0
- package/dist/models/RefreshLoginTokenRequest.js.map +1 -1
- package/dist/models/RefreshLoginTokenResponseBody.d.ts +6 -0
- package/dist/models/RefreshLoginTokenResponseBody.js.map +1 -1
- package/dist/models/ReportSessionStatusRequest.d.ts +13 -0
- package/dist/models/ReportSessionStatusRequest.js.map +1 -1
- package/dist/models/ReportSessionStatusResponseBody.d.ts +3 -0
- package/dist/models/ReportSessionStatusResponseBody.js.map +1 -1
- package/dist/models/ResetPasswordRequest.d.ts +2 -2
- package/dist/models/SetFingerPrintTemplateDescriptionRequest.d.ts +3 -3
- package/dist/models/SetFingerPrintTemplateRequest.d.ts +9 -9
- package/dist/models/SetFingerPrintTemplateResponseBody.d.ts +3 -3
- package/dist/models/StopDesktopsRequest.d.ts +8 -8
- package/dist/models/model.d.ts +2 -3
- package/dist/models/model.js +17 -19
- package/dist/models/model.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +66 -76
- package/src/models/ChangePasswordRequest.ts +1 -1
- package/src/models/DeleteFingerPrintTemplateRequest.ts +6 -6
- package/src/models/DeleteFingerPrintTemplateResponseBody.ts +1 -1
- package/src/models/DescribeFingerPrintTemplatesResponseBody.ts +1 -1
- package/src/models/DescribeGlobalDesktopsRequest.ts +28 -56
- package/src/models/DescribeGlobalDesktopsResponseBody.ts +77 -153
- package/src/models/DescribeOfficeSitesRequest.ts +8 -0
- package/src/models/DescribeOfficeSitesResponseBody.ts +23 -0
- package/src/models/DescribeRegionsRequest.ts +1 -1
- package/src/models/DescribeRegionsResponseBody.ts +2 -2
- package/src/models/DescribeSnapshotsResponseBody.ts +1 -1
- package/src/models/DescribeUserResourcesRequest.ts +26 -75
- package/src/models/DescribeUserResourcesResponseBody.ts +223 -195
- package/src/models/GetCloudDriveServiceMountTokenRequest.ts +15 -0
- package/src/models/GetCloudDriveServiceMountTokenResponseBody.ts +15 -0
- package/src/models/GetConnectionTicketRequest.ts +30 -17
- package/src/models/GetConnectionTicketResponseBody.ts +26 -2
- package/src/models/GetLoginTokenRequest.ts +28 -44
- package/src/models/GetLoginTokenResponseBody.ts +38 -32
- package/src/models/GetLoginTokenShrinkRequest.ts +28 -44
- package/src/models/RebootDesktopsRequest.ts +10 -10
- package/src/models/RebootDesktopsResponseBody.ts +1 -1
- package/src/models/RefreshLoginTokenRequest.ts +17 -0
- package/src/models/RefreshLoginTokenResponseBody.ts +6 -0
- package/src/models/ReportSessionStatusRequest.ts +13 -0
- package/src/models/ReportSessionStatusResponseBody.ts +3 -0
- package/src/models/ResetPasswordRequest.ts +2 -2
- package/src/models/SetFingerPrintTemplateDescriptionRequest.ts +3 -3
- package/src/models/SetFingerPrintTemplateRequest.ts +9 -9
- package/src/models/SetFingerPrintTemplateResponseBody.ts +3 -3
- package/src/models/StopDesktopsRequest.ts +8 -8
- package/src/models/model.ts +2 -3
- package/dist/models/IsKeepAliveRequest.d.ts +0 -39
- package/dist/models/IsKeepAliveRequest.js +0 -62
- package/dist/models/IsKeepAliveRequest.js.map +0 -1
- package/dist/models/IsKeepAliveResponse.d.ts +0 -19
- package/dist/models/IsKeepAliveResponse.js +0 -69
- package/dist/models/IsKeepAliveResponse.js.map +0 -1
- package/dist/models/IsKeepAliveResponseBody.d.ts +0 -45
- package/dist/models/IsKeepAliveResponseBody.js +0 -64
- package/dist/models/IsKeepAliveResponseBody.js.map +0 -1
- package/src/models/IsKeepAliveRequest.ts +0 -56
- package/src/models/IsKeepAliveResponse.ts +0 -40
- package/src/models/IsKeepAliveResponseBody.ts +0 -64
|
@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class GetLoginTokenResponseBodyPasswordStrategy extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* > This is
|
|
8
|
+
* > This is an internal field and is not available for public use.
|
|
9
9
|
*/
|
|
10
10
|
tenantAlternativeChars?: string[];
|
|
11
11
|
/**
|
|
12
12
|
* @remarks
|
|
13
|
-
* > This is
|
|
13
|
+
* > This is an internal field and is not available for public use.
|
|
14
14
|
*
|
|
15
15
|
* @example
|
|
16
16
|
* null
|
|
@@ -45,7 +45,7 @@ export class GetLoginTokenResponseBodyPasswordStrategy extends $dara.Model {
|
|
|
45
45
|
export class GetLoginTokenResponseBodyRiskVerifyInfo extends $dara.Model {
|
|
46
46
|
/**
|
|
47
47
|
* @remarks
|
|
48
|
-
* The email used for
|
|
48
|
+
* The email address used for identity verification when risk verification is triggered.
|
|
49
49
|
*
|
|
50
50
|
* @example
|
|
51
51
|
* user@example.com
|
|
@@ -53,7 +53,7 @@ export class GetLoginTokenResponseBodyRiskVerifyInfo extends $dara.Model {
|
|
|
53
53
|
email?: string;
|
|
54
54
|
/**
|
|
55
55
|
* @remarks
|
|
56
|
-
* The
|
|
56
|
+
* The account lockout duration.
|
|
57
57
|
*
|
|
58
58
|
* @example
|
|
59
59
|
* 1713749778
|
|
@@ -61,7 +61,7 @@ export class GetLoginTokenResponseBodyRiskVerifyInfo extends $dara.Model {
|
|
|
61
61
|
lastLockDuration?: number;
|
|
62
62
|
/**
|
|
63
63
|
* @remarks
|
|
64
|
-
*
|
|
64
|
+
* Indicates whether the account is locked.
|
|
65
65
|
*
|
|
66
66
|
* @example
|
|
67
67
|
* true
|
|
@@ -69,10 +69,10 @@ export class GetLoginTokenResponseBodyRiskVerifyInfo extends $dara.Model {
|
|
|
69
69
|
locked?: string;
|
|
70
70
|
/**
|
|
71
71
|
* @remarks
|
|
72
|
-
* The
|
|
72
|
+
* The phone number used for identity verification when risk verification is triggered.
|
|
73
73
|
*
|
|
74
74
|
* @example
|
|
75
|
-
*
|
|
75
|
+
* 1381111****
|
|
76
76
|
*/
|
|
77
77
|
phone?: string;
|
|
78
78
|
static names(): { [key: string]: string } {
|
|
@@ -105,10 +105,10 @@ export class GetLoginTokenResponseBodyRiskVerifyInfo extends $dara.Model {
|
|
|
105
105
|
export class GetLoginTokenResponseBody extends $dara.Model {
|
|
106
106
|
/**
|
|
107
107
|
* @remarks
|
|
108
|
-
* The email address of the user.
|
|
108
|
+
* The email address of the user. This value is returned with the LoginToken after logon.
|
|
109
109
|
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
110
|
+
* - For a convenience user, the email address specified when the convenience user was created is returned.
|
|
111
|
+
* - For an AD user, the value is returned in the format of `username@AD domain name`.
|
|
112
112
|
*
|
|
113
113
|
* @example
|
|
114
114
|
* alice
|
|
@@ -116,7 +116,7 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
116
116
|
email?: string;
|
|
117
117
|
/**
|
|
118
118
|
* @remarks
|
|
119
|
-
* The account
|
|
119
|
+
* The convenience account username or AD username.
|
|
120
120
|
*
|
|
121
121
|
* @example
|
|
122
122
|
* alice
|
|
@@ -124,7 +124,7 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
124
124
|
endUserId?: string;
|
|
125
125
|
/**
|
|
126
126
|
* @remarks
|
|
127
|
-
* > This is
|
|
127
|
+
* > This is an internal field and is not available for public use.
|
|
128
128
|
*
|
|
129
129
|
* @example
|
|
130
130
|
* edu
|
|
@@ -132,7 +132,7 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
132
132
|
industry?: string;
|
|
133
133
|
/**
|
|
134
134
|
* @remarks
|
|
135
|
-
* The token used to keep the
|
|
135
|
+
* The token used to keep the logon session alive. After a successful logon with the keep-alive option enabled, the operation returns a `KeepAliveToken`. If the keep-alive option is not enabled, an empty value is returned.
|
|
136
136
|
*
|
|
137
137
|
* @example
|
|
138
138
|
* 006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW
|
|
@@ -140,15 +140,15 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
140
140
|
keepAliveToken?: string;
|
|
141
141
|
/**
|
|
142
142
|
* @remarks
|
|
143
|
-
* The
|
|
143
|
+
* The property of the convenience user. If the user is an AD user, an empty value is returned.
|
|
144
144
|
*
|
|
145
145
|
* @example
|
|
146
|
-
* test:
|
|
146
|
+
* test:wuying
|
|
147
147
|
*/
|
|
148
148
|
label?: string;
|
|
149
149
|
/**
|
|
150
150
|
* @remarks
|
|
151
|
-
* The logon
|
|
151
|
+
* The logon credential.
|
|
152
152
|
*
|
|
153
153
|
* @example
|
|
154
154
|
* v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
|
|
@@ -156,23 +156,25 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
156
156
|
loginToken?: string;
|
|
157
157
|
/**
|
|
158
158
|
* @remarks
|
|
159
|
-
* The next stage
|
|
159
|
+
* The expected next stage. For example, if the administrator has enabled MFA authentication in the Elastic Desktop Service console, after the username and password authentication is passed (the `ADPassword` stage), this parameter returns `MFAVerify`, indicating that MFA authentication is required.
|
|
160
160
|
*
|
|
161
|
-
* >
|
|
161
|
+
* > For more information about each authentication stage, see the parameter description of the `CurrentStage` request parameter of this operation.
|
|
162
162
|
*
|
|
163
163
|
* @example
|
|
164
164
|
* MFAVerify
|
|
165
165
|
*/
|
|
166
166
|
nextStage?: string;
|
|
167
167
|
nickName?: string;
|
|
168
|
+
officeSiteId?: string;
|
|
169
|
+
officeSiteName?: string;
|
|
168
170
|
/**
|
|
169
171
|
* @remarks
|
|
170
|
-
* > This is
|
|
172
|
+
* > This is an internal field and is not available for public use.
|
|
171
173
|
*/
|
|
172
174
|
passwordStrategy?: GetLoginTokenResponseBodyPasswordStrategy;
|
|
173
175
|
/**
|
|
174
176
|
* @remarks
|
|
175
|
-
*
|
|
177
|
+
* The phone number of the convenience user. If the user is an AD user, an empty value is returned.
|
|
176
178
|
*
|
|
177
179
|
* @example
|
|
178
180
|
* 1381111****
|
|
@@ -180,14 +182,14 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
180
182
|
phone?: string;
|
|
181
183
|
/**
|
|
182
184
|
* @remarks
|
|
183
|
-
* > This is
|
|
185
|
+
* > This is an internal field and is not available for public use.
|
|
184
186
|
*/
|
|
185
187
|
props?: { [key: string]: string };
|
|
186
188
|
/**
|
|
187
189
|
* @remarks
|
|
188
|
-
* The QR code
|
|
190
|
+
* The QR code of the secret key used when attaching a virtual MFA device. The value uses Base64 encoding. This value can be empty and is used in the `MFABind` stage.
|
|
189
191
|
*
|
|
190
|
-
* > For more information about each authentication stage, see the parameter description of the request parameter
|
|
192
|
+
* > For more information about each authentication stage, see the parameter description of the `CurrentStage` request parameter of this operation.
|
|
191
193
|
*
|
|
192
194
|
* @example
|
|
193
195
|
* 5OCLLKKOJU5HPBX66H3QCTWY******
|
|
@@ -195,7 +197,7 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
195
197
|
qrCodePng?: string;
|
|
196
198
|
/**
|
|
197
199
|
* @remarks
|
|
198
|
-
* > This is
|
|
200
|
+
* > This is an internal field and is not available for public use.
|
|
199
201
|
*
|
|
200
202
|
* @example
|
|
201
203
|
* null
|
|
@@ -203,7 +205,7 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
203
205
|
reason?: string;
|
|
204
206
|
/**
|
|
205
207
|
* @remarks
|
|
206
|
-
* The ID
|
|
208
|
+
* The request ID.
|
|
207
209
|
*
|
|
208
210
|
* @example
|
|
209
211
|
* 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
|
|
@@ -211,14 +213,14 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
211
213
|
requestId?: string;
|
|
212
214
|
/**
|
|
213
215
|
* @remarks
|
|
214
|
-
*
|
|
216
|
+
* The logon risk identification information.
|
|
215
217
|
*/
|
|
216
218
|
riskVerifyInfo?: GetLoginTokenResponseBodyRiskVerifyInfo;
|
|
217
219
|
/**
|
|
218
220
|
* @remarks
|
|
219
|
-
* The key
|
|
221
|
+
* The secret key used when attaching a virtual MFA device. This value is used in the `MFABind` stage.
|
|
220
222
|
*
|
|
221
|
-
* > For more information about each authentication stage, see the parameter description of the request parameter
|
|
223
|
+
* > For more information about each authentication stage, see the parameter description of the `CurrentStage` request parameter of this operation.
|
|
222
224
|
*
|
|
223
225
|
* @example
|
|
224
226
|
* 5OCLLKKOJU5HPBX66H3QCTWYI7MH****
|
|
@@ -226,9 +228,9 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
226
228
|
secret?: string;
|
|
227
229
|
/**
|
|
228
230
|
* @remarks
|
|
229
|
-
* The ID
|
|
231
|
+
* The session ID. This value is returned only when `GetLoginToken` is invoked for the first time within the same session. For subsequent stages that require multiple authentications, pass in this parameter.
|
|
230
232
|
*
|
|
231
|
-
* > For more information about each authentication stage, see the parameter description of the request parameter
|
|
233
|
+
* > For more information about each authentication stage, see the parameter description of the `CurrentStage` request parameter of this operation.
|
|
232
234
|
*
|
|
233
235
|
* @example
|
|
234
236
|
* d6ec166d-ab93-4286-bf7f-a18bb929****
|
|
@@ -236,7 +238,7 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
236
238
|
sessionId?: string;
|
|
237
239
|
/**
|
|
238
240
|
* @remarks
|
|
239
|
-
* The
|
|
241
|
+
* The Alibaba Cloud account ID. This value is used for hardware terminal identification.
|
|
240
242
|
*
|
|
241
243
|
* @example
|
|
242
244
|
* 166353906220****
|
|
@@ -244,7 +246,7 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
244
246
|
tenantId?: number;
|
|
245
247
|
/**
|
|
246
248
|
* @remarks
|
|
247
|
-
* > This is
|
|
249
|
+
* > This is an internal field and is not available for public use.
|
|
248
250
|
*
|
|
249
251
|
* @example
|
|
250
252
|
* mode
|
|
@@ -261,6 +263,8 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
261
263
|
loginToken: 'LoginToken',
|
|
262
264
|
nextStage: 'NextStage',
|
|
263
265
|
nickName: 'NickName',
|
|
266
|
+
officeSiteId: 'OfficeSiteId',
|
|
267
|
+
officeSiteName: 'OfficeSiteName',
|
|
264
268
|
passwordStrategy: 'PasswordStrategy',
|
|
265
269
|
phone: 'Phone',
|
|
266
270
|
props: 'Props',
|
|
@@ -286,6 +290,8 @@ export class GetLoginTokenResponseBody extends $dara.Model {
|
|
|
286
290
|
loginToken: 'string',
|
|
287
291
|
nextStage: 'string',
|
|
288
292
|
nickName: 'string',
|
|
293
|
+
officeSiteId: 'string',
|
|
294
|
+
officeSiteName: 'string',
|
|
289
295
|
passwordStrategy: GetLoginTokenResponseBodyPasswordStrategy,
|
|
290
296
|
phone: 'string',
|
|
291
297
|
props: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The
|
|
8
|
+
* The security code generated by the virtual MFA device. This parameter is required when `CurrentStage` is set to `MFAVerify`.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* 47****
|
|
@@ -14,7 +14,7 @@ export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
|
14
14
|
availableFeaturesShrink?: string;
|
|
15
15
|
/**
|
|
16
16
|
* @remarks
|
|
17
|
-
* The
|
|
17
|
+
* The unique ID generated by the client.
|
|
18
18
|
*
|
|
19
19
|
* This parameter is required.
|
|
20
20
|
*
|
|
@@ -25,50 +25,38 @@ export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
|
25
25
|
clientName?: string;
|
|
26
26
|
/**
|
|
27
27
|
* @remarks
|
|
28
|
-
* The operating system
|
|
28
|
+
* The operating system of the device on which the client runs.
|
|
29
29
|
*
|
|
30
30
|
* @example
|
|
31
|
-
* Windows_NT 10.0.
|
|
31
|
+
* Windows_NT 10.0.18363 x64
|
|
32
32
|
*/
|
|
33
33
|
clientOS?: string;
|
|
34
34
|
/**
|
|
35
35
|
* @remarks
|
|
36
|
-
* The type of
|
|
37
|
-
*
|
|
38
|
-
* Valid values:
|
|
39
|
-
*
|
|
40
|
-
* * HTML5: web client.
|
|
41
|
-
*
|
|
42
|
-
* * WINDOWS: Windows client.
|
|
43
|
-
*
|
|
44
|
-
* * MACOS: macOS client.
|
|
45
|
-
*
|
|
46
|
-
* * IOS: iOS client.
|
|
47
|
-
*
|
|
48
|
-
* * ANDROID: Android client.
|
|
36
|
+
* The type of the Elastic Desktop Service software client.
|
|
49
37
|
*
|
|
50
38
|
* @example
|
|
51
|
-
*
|
|
39
|
+
* WINDOWS
|
|
52
40
|
*/
|
|
53
41
|
clientType?: string;
|
|
54
42
|
/**
|
|
55
43
|
* @remarks
|
|
56
|
-
* The version
|
|
44
|
+
* The client version. If you use the Elastic Desktop Service client, you can view this parameter in the **About** dialog box on the client logon page.
|
|
57
45
|
*
|
|
58
46
|
* @example
|
|
59
|
-
* 2.1.0-R-20210731.
|
|
47
|
+
* 2.1.0-R-20210731.151756
|
|
60
48
|
*/
|
|
61
49
|
clientVersion?: string;
|
|
62
50
|
/**
|
|
63
51
|
* @remarks
|
|
64
|
-
* The logon authentication stage.
|
|
52
|
+
* The current logon authentication stage. The stages are as follows:
|
|
65
53
|
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
54
|
+
* - `ADPassword`: verifies user information. Specify this value when authenticating with the credentials of a convenience account or an AD account.
|
|
55
|
+
* - `MFABind`: binds a virtual MFA device.
|
|
56
|
+
* - `MFAVerify`: verifies the security code generated by the virtual MFA device.
|
|
57
|
+
* - `TokenVerify`: performs client secondary authentication.
|
|
58
|
+
* - `ChangePassword`: changes the user password.
|
|
59
|
+
* - `KeepAliveVerify`: exchanges a valid KeepAliveToken for a LoginToken.
|
|
72
60
|
*
|
|
73
61
|
* @example
|
|
74
62
|
* ADPassword
|
|
@@ -76,7 +64,7 @@ export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
|
76
64
|
currentStage?: string;
|
|
77
65
|
/**
|
|
78
66
|
* @remarks
|
|
79
|
-
* The office network ID
|
|
67
|
+
* The office network ID, which has the same meaning as `OfficeSiteId`. We recommend that you stop using `DirectoryId` and use `OfficeSiteId` instead. You can specify only one of `DirectoryId` and `OfficeSiteId`, not both.
|
|
80
68
|
*
|
|
81
69
|
* @example
|
|
82
70
|
* cn-hangzhou+dir-885351****
|
|
@@ -84,7 +72,7 @@ export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
|
84
72
|
directoryId?: string;
|
|
85
73
|
/**
|
|
86
74
|
* @remarks
|
|
87
|
-
* The
|
|
75
|
+
* The username of the convenience user or AD user. This parameter is required when `CurrentStage` is set to `ADPassword`.
|
|
88
76
|
*
|
|
89
77
|
* @example
|
|
90
78
|
* alice
|
|
@@ -92,11 +80,7 @@ export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
|
92
80
|
endUserId?: string;
|
|
93
81
|
/**
|
|
94
82
|
* @remarks
|
|
95
|
-
* Specifies whether to keep the
|
|
96
|
-
* Valid values:
|
|
97
|
-
* * null: Default value. Do not keep the user logged on to the client.
|
|
98
|
-
* * true: Keep the user logged on to the client.
|
|
99
|
-
* * false: Do not keep the user logged on to the client.
|
|
83
|
+
* Specifies whether to keep the logon session alive.
|
|
100
84
|
*
|
|
101
85
|
* @example
|
|
102
86
|
* false
|
|
@@ -104,7 +88,7 @@ export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
|
104
88
|
keepAlive?: boolean;
|
|
105
89
|
/**
|
|
106
90
|
* @remarks
|
|
107
|
-
* The token to keep
|
|
91
|
+
* The token used to keep the logon session alive. After a successful logon with the keep-alive option enabled, the operation returns a `KeepAliveToken`. While the `KeepAliveToken` is valid, you can call the `GetLoginToken` operation with `CurrentStage` set to `KeepAliveVerify` to exchange it for a logon credential (LoginToken). This parameter is required when `CurrentStage` is set to `KeepAliveVerify`.
|
|
108
92
|
*
|
|
109
93
|
* @example
|
|
110
94
|
* hide
|
|
@@ -112,7 +96,7 @@ export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
|
112
96
|
keepAliveToken?: string;
|
|
113
97
|
/**
|
|
114
98
|
* @remarks
|
|
115
|
-
* The new password. This parameter is required
|
|
99
|
+
* The new password. This parameter is required when `CurrentStage` is set to `ChangePassword`.
|
|
116
100
|
*
|
|
117
101
|
* @example
|
|
118
102
|
* NewPassword
|
|
@@ -128,7 +112,7 @@ export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
|
128
112
|
officeSiteId?: string;
|
|
129
113
|
/**
|
|
130
114
|
* @remarks
|
|
131
|
-
* The
|
|
115
|
+
* The old password. This parameter is required when `CurrentStage` is set to `ChangePassword`.
|
|
132
116
|
*
|
|
133
117
|
* @example
|
|
134
118
|
* OldPassword
|
|
@@ -136,7 +120,7 @@ export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
|
136
120
|
oldPassword?: string;
|
|
137
121
|
/**
|
|
138
122
|
* @remarks
|
|
139
|
-
* The password of the convenience user or
|
|
123
|
+
* The password of the convenience user or AD user. This parameter is required when `CurrentStage` is set to `ADPassword`.
|
|
140
124
|
*
|
|
141
125
|
* @example
|
|
142
126
|
* Password1234
|
|
@@ -144,7 +128,7 @@ export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
|
144
128
|
password?: string;
|
|
145
129
|
/**
|
|
146
130
|
* @remarks
|
|
147
|
-
* The region ID. You can call
|
|
131
|
+
* The region ID. You can call [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) to query the regions supported by Elastic Desktop Service.
|
|
148
132
|
*
|
|
149
133
|
* This parameter is required.
|
|
150
134
|
*
|
|
@@ -154,10 +138,10 @@ export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
|
154
138
|
regionId?: string;
|
|
155
139
|
/**
|
|
156
140
|
* @remarks
|
|
157
|
-
* The ID
|
|
141
|
+
* The session ID for logon.
|
|
158
142
|
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
143
|
+
* - If no virtual MFA device is bound or client secondary authentication is not enabled, you do not need to specify `SessionId`.
|
|
144
|
+
* - If a virtual MFA device is bound or client secondary authentication is enabled, you must specify `SessionId` for the authentication stages after `ADPassword`. You can obtain `SessionId` from the response of the convenience account verification (when the `GetLoginToken` request is in the `ADPassword` stage).
|
|
161
145
|
*
|
|
162
146
|
* @example
|
|
163
147
|
* cd45e873-650d-4d70-acb9-f996187a****
|
|
@@ -165,7 +149,7 @@ export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
|
165
149
|
sessionId?: string;
|
|
166
150
|
/**
|
|
167
151
|
* @remarks
|
|
168
|
-
* If
|
|
152
|
+
* If client secondary authentication is enabled in the Elastic Desktop Service console and the current logon user is identified as risky, a secondary authentication verification code is sent to the end user\\"s email address. This parameter is required when `CurrentStage` is set to `TokenVerify`.
|
|
169
153
|
*
|
|
170
154
|
* @example
|
|
171
155
|
* 63****
|
|
@@ -173,7 +157,7 @@ export class GetLoginTokenShrinkRequest extends $dara.Model {
|
|
|
173
157
|
tokenCode?: string;
|
|
174
158
|
/**
|
|
175
159
|
* @remarks
|
|
176
|
-
* The unique identifier of the client.
|
|
160
|
+
* The unique identifier of the client. If you use the Elastic Desktop Service client, you can view this parameter in the **About** dialog box on the client logon page.
|
|
177
161
|
*
|
|
178
162
|
* @example
|
|
179
163
|
* C78CA9E99315687575DD2844C1F3****
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class RebootDesktopsRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
*
|
|
8
|
+
* A unique ID generated by the client.
|
|
9
9
|
*
|
|
10
10
|
* This parameter is required.
|
|
11
11
|
*
|
|
@@ -15,7 +15,7 @@ export class RebootDesktopsRequest extends $dara.Model {
|
|
|
15
15
|
clientId?: string;
|
|
16
16
|
/**
|
|
17
17
|
* @remarks
|
|
18
|
-
*
|
|
18
|
+
* Operating system of the device running the client.
|
|
19
19
|
*
|
|
20
20
|
* @example
|
|
21
21
|
* Windows_NT 10.0.18363 x64
|
|
@@ -23,7 +23,7 @@ export class RebootDesktopsRequest extends $dara.Model {
|
|
|
23
23
|
clientOS?: string;
|
|
24
24
|
/**
|
|
25
25
|
* @remarks
|
|
26
|
-
*
|
|
26
|
+
* Ensures idempotence. Generate a unique value on your client for each request. ClientToken supports only ASCII characters and must be no longer than 64 characters. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/25693.html).
|
|
27
27
|
*
|
|
28
28
|
* @example
|
|
29
29
|
* 40401e62-5caf-4508-8de7-bf98af12****
|
|
@@ -31,7 +31,7 @@ export class RebootDesktopsRequest extends $dara.Model {
|
|
|
31
31
|
clientToken?: string;
|
|
32
32
|
/**
|
|
33
33
|
* @remarks
|
|
34
|
-
*
|
|
34
|
+
* Client version. If you use the WUYING Workspace client, find this value in the **About** dialog box on the client login screen.
|
|
35
35
|
*
|
|
36
36
|
* @example
|
|
37
37
|
* 2.1.0-R-20210731.151756
|
|
@@ -39,7 +39,7 @@ export class RebootDesktopsRequest extends $dara.Model {
|
|
|
39
39
|
clientVersion?: string;
|
|
40
40
|
/**
|
|
41
41
|
* @remarks
|
|
42
|
-
*
|
|
42
|
+
* A list of 1 to 20 cloud computer IDs.
|
|
43
43
|
*
|
|
44
44
|
* This parameter is required.
|
|
45
45
|
*
|
|
@@ -49,7 +49,7 @@ export class RebootDesktopsRequest extends $dara.Model {
|
|
|
49
49
|
desktopId?: string[];
|
|
50
50
|
/**
|
|
51
51
|
* @remarks
|
|
52
|
-
*
|
|
52
|
+
* Login token.
|
|
53
53
|
*
|
|
54
54
|
* @example
|
|
55
55
|
* v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
|
|
@@ -58,7 +58,7 @@ export class RebootDesktopsRequest extends $dara.Model {
|
|
|
58
58
|
osUpdate?: boolean;
|
|
59
59
|
/**
|
|
60
60
|
* @remarks
|
|
61
|
-
*
|
|
61
|
+
* Region ID. Call [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) to list regions that support WUYING Workspace.
|
|
62
62
|
*
|
|
63
63
|
* This parameter is required.
|
|
64
64
|
*
|
|
@@ -68,7 +68,7 @@ export class RebootDesktopsRequest extends $dara.Model {
|
|
|
68
68
|
regionId?: string;
|
|
69
69
|
/**
|
|
70
70
|
* @remarks
|
|
71
|
-
*
|
|
71
|
+
* Session ID.
|
|
72
72
|
*
|
|
73
73
|
* @example
|
|
74
74
|
* cd45e873-650d-4d70-acb9-f996187a****
|
|
@@ -76,7 +76,7 @@ export class RebootDesktopsRequest extends $dara.Model {
|
|
|
76
76
|
sessionId?: string;
|
|
77
77
|
/**
|
|
78
78
|
* @remarks
|
|
79
|
-
*
|
|
79
|
+
* Specifies the logon credentials.
|
|
80
80
|
*
|
|
81
81
|
* @example
|
|
82
82
|
* 04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40
|
|
@@ -84,7 +84,7 @@ export class RebootDesktopsRequest extends $dara.Model {
|
|
|
84
84
|
sessionToken?: string;
|
|
85
85
|
/**
|
|
86
86
|
* @remarks
|
|
87
|
-
*
|
|
87
|
+
* Unique identifier of the client.
|
|
88
88
|
*
|
|
89
89
|
* @example
|
|
90
90
|
* 91761ED27169E2FC564F29388E2D****
|
|
@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class RefreshLoginTokenRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
+
* A unique ID generated by the client, such as a UUID. This parameter is non-sensitive and does not require encryption.
|
|
9
|
+
*
|
|
8
10
|
* This parameter is required.
|
|
9
11
|
*
|
|
10
12
|
* @example
|
|
@@ -12,12 +14,17 @@ export class RefreshLoginTokenRequest extends $dara.Model {
|
|
|
12
14
|
*/
|
|
13
15
|
clientId?: string;
|
|
14
16
|
/**
|
|
17
|
+
* @remarks
|
|
18
|
+
* > This parameter is not available for use.
|
|
19
|
+
*
|
|
15
20
|
* @example
|
|
16
21
|
* cn-hangzhou+dir-jedbpr4sl9l37****
|
|
17
22
|
*/
|
|
18
23
|
directoryId?: string;
|
|
19
24
|
/**
|
|
20
25
|
* @remarks
|
|
26
|
+
* The username.
|
|
27
|
+
*
|
|
21
28
|
* This parameter is required.
|
|
22
29
|
*
|
|
23
30
|
* @example
|
|
@@ -26,6 +33,8 @@ export class RefreshLoginTokenRequest extends $dara.Model {
|
|
|
26
33
|
endUserId?: string;
|
|
27
34
|
/**
|
|
28
35
|
* @remarks
|
|
36
|
+
* The logon credential.
|
|
37
|
+
*
|
|
29
38
|
* This parameter is required.
|
|
30
39
|
*
|
|
31
40
|
* @example
|
|
@@ -33,12 +42,17 @@ export class RefreshLoginTokenRequest extends $dara.Model {
|
|
|
33
42
|
*/
|
|
34
43
|
loginToken?: string;
|
|
35
44
|
/**
|
|
45
|
+
* @remarks
|
|
46
|
+
* The office network ID.
|
|
47
|
+
*
|
|
36
48
|
* @example
|
|
37
49
|
* cn-shanghai+dir-238191****
|
|
38
50
|
*/
|
|
39
51
|
officeSiteId?: string;
|
|
40
52
|
/**
|
|
41
53
|
* @remarks
|
|
54
|
+
* The Region ID. You can invoke [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) to obtain the list of Regions supported by WUYING Workspace.
|
|
55
|
+
*
|
|
42
56
|
* This parameter is required.
|
|
43
57
|
*
|
|
44
58
|
* @example
|
|
@@ -46,6 +60,9 @@ export class RefreshLoginTokenRequest extends $dara.Model {
|
|
|
46
60
|
*/
|
|
47
61
|
regionId?: string;
|
|
48
62
|
/**
|
|
63
|
+
* @remarks
|
|
64
|
+
* The session ID.
|
|
65
|
+
*
|
|
49
66
|
* @example
|
|
50
67
|
* cd45e873-650d-4d70-acb9-f996187a****
|
|
51
68
|
*/
|
|
@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
|
|
|
4
4
|
|
|
5
5
|
export class RefreshLoginTokenResponseBody extends $dara.Model {
|
|
6
6
|
/**
|
|
7
|
+
* @remarks
|
|
8
|
+
* The logon credential.
|
|
9
|
+
*
|
|
7
10
|
* @example
|
|
8
11
|
* v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****
|
|
9
12
|
*/
|
|
10
13
|
loginToken?: string;
|
|
11
14
|
/**
|
|
15
|
+
* @remarks
|
|
16
|
+
* The request ID.
|
|
17
|
+
*
|
|
12
18
|
* @example
|
|
13
19
|
* 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
|
|
14
20
|
*/
|
|
@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
|
|
|
4
4
|
|
|
5
5
|
export class ReportSessionStatusRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
|
+
* @remarks
|
|
8
|
+
* End user.
|
|
9
|
+
*
|
|
7
10
|
* @example
|
|
8
11
|
* liming
|
|
9
12
|
*/
|
|
10
13
|
endUserId?: string;
|
|
11
14
|
/**
|
|
12
15
|
* @remarks
|
|
16
|
+
* Instance ID.
|
|
17
|
+
*
|
|
13
18
|
* This parameter is required.
|
|
14
19
|
*
|
|
15
20
|
* @example
|
|
@@ -18,6 +23,8 @@ export class ReportSessionStatusRequest extends $dara.Model {
|
|
|
18
23
|
instanceId?: string;
|
|
19
24
|
/**
|
|
20
25
|
* @remarks
|
|
26
|
+
* Region ID.
|
|
27
|
+
*
|
|
21
28
|
* This parameter is required.
|
|
22
29
|
*
|
|
23
30
|
* @example
|
|
@@ -26,6 +33,8 @@ export class ReportSessionStatusRequest extends $dara.Model {
|
|
|
26
33
|
regionId?: string;
|
|
27
34
|
/**
|
|
28
35
|
* @remarks
|
|
36
|
+
* Duration of the session change.
|
|
37
|
+
*
|
|
29
38
|
* This parameter is required.
|
|
30
39
|
*
|
|
31
40
|
* @example
|
|
@@ -34,6 +43,8 @@ export class ReportSessionStatusRequest extends $dara.Model {
|
|
|
34
43
|
sessionChangeTime?: number;
|
|
35
44
|
/**
|
|
36
45
|
* @remarks
|
|
46
|
+
* Session ID.
|
|
47
|
+
*
|
|
37
48
|
* This parameter is required.
|
|
38
49
|
*
|
|
39
50
|
* @example
|
|
@@ -42,6 +53,8 @@ export class ReportSessionStatusRequest extends $dara.Model {
|
|
|
42
53
|
sessionId?: string;
|
|
43
54
|
/**
|
|
44
55
|
* @remarks
|
|
56
|
+
* Session status.
|
|
57
|
+
*
|
|
45
58
|
* This parameter is required.
|
|
46
59
|
*
|
|
47
60
|
* @example
|