@alicloud/ecd20201002 3.0.0 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/dist/client.d.ts +56 -40
  2. package/dist/client.js +62 -66
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/ApproveFotaUpdateRequest.d.ts +5 -7
  5. package/dist/models/ApproveFotaUpdateRequest.js.map +1 -1
  6. package/dist/models/ChangePasswordRequest.d.ts +3 -3
  7. package/dist/models/DeleteFingerPrintTemplateRequest.d.ts +6 -6
  8. package/dist/models/DeleteFingerPrintTemplateResponseBody.d.ts +1 -1
  9. package/dist/models/DescribeFingerPrintTemplatesRequest.d.ts +3 -3
  10. package/dist/models/DescribeFingerPrintTemplatesResponseBody.d.ts +5 -5
  11. package/dist/models/DescribeGlobalDesktopsRequest.d.ts +35 -28
  12. package/dist/models/DescribeGlobalDesktopsRequest.js.map +1 -1
  13. package/dist/models/DescribeGlobalDesktopsResponseBody.d.ts +89 -70
  14. package/dist/models/DescribeGlobalDesktopsResponseBody.js.map +1 -1
  15. package/dist/models/DescribeRegionsRequest.d.ts +1 -1
  16. package/dist/models/DescribeRegionsResponseBody.d.ts +1 -1
  17. package/dist/models/DescribeSnapshotsRequest.d.ts +5 -5
  18. package/dist/models/DescribeSnapshotsResponseBody.d.ts +11 -27
  19. package/dist/models/DescribeSnapshotsResponseBody.js.map +1 -1
  20. package/dist/models/DescribeUserResourcesRequest.d.ts +35 -21
  21. package/dist/models/DescribeUserResourcesRequest.js +2 -0
  22. package/dist/models/DescribeUserResourcesRequest.js.map +1 -1
  23. package/dist/models/DescribeUserResourcesResponseBody.d.ts +216 -68
  24. package/dist/models/DescribeUserResourcesResponseBody.js +42 -1
  25. package/dist/models/DescribeUserResourcesResponseBody.js.map +1 -1
  26. package/dist/models/EncryptPasswordRequest.d.ts +2 -2
  27. package/dist/models/GetConnectionTicketRequest.d.ts +23 -17
  28. package/dist/models/GetConnectionTicketRequest.js.map +1 -1
  29. package/dist/models/GetConnectionTicketResponseBody.d.ts +8 -4
  30. package/dist/models/GetConnectionTicketResponseBody.js.map +1 -1
  31. package/dist/models/GetLoginTokenRequest.d.ts +34 -23
  32. package/dist/models/GetLoginTokenRequest.js.map +1 -1
  33. package/dist/models/GetLoginTokenResponseBody.d.ts +50 -25
  34. package/dist/models/GetLoginTokenResponseBody.js.map +1 -1
  35. package/dist/models/GetLoginTokenShrinkRequest.d.ts +34 -23
  36. package/dist/models/GetLoginTokenShrinkRequest.js.map +1 -1
  37. package/dist/models/RefreshLoginTokenRequest.d.ts +2 -2
  38. package/dist/models/ReportSessionStatusRequest.d.ts +20 -6
  39. package/dist/models/ReportSessionStatusRequest.js.map +1 -1
  40. package/dist/models/ReportSessionStatusResponseBody.d.ts +1 -1
  41. package/dist/models/ResetPasswordRequest.d.ts +5 -5
  42. package/dist/models/ResetSnapshotRequest.d.ts +4 -4
  43. package/dist/models/SendTokenCodeRequest.d.ts +6 -6
  44. package/dist/models/SetFingerPrintTemplateDescriptionRequest.d.ts +2 -2
  45. package/dist/models/SetFingerPrintTemplateRequest.d.ts +8 -8
  46. package/dist/models/SetFingerPrintTemplateResponseBody.d.ts +3 -3
  47. package/dist/models/StopDesktopsRequest.d.ts +33 -8
  48. package/dist/models/StopDesktopsRequest.js +2 -0
  49. package/dist/models/StopDesktopsRequest.js.map +1 -1
  50. package/dist/models/UnbindUserDesktopRequest.d.ts +4 -9
  51. package/dist/models/UnbindUserDesktopRequest.js.map +1 -1
  52. package/dist/models/VerifyCredentialRequest.d.ts +7 -9
  53. package/dist/models/VerifyCredentialRequest.js.map +1 -1
  54. package/dist/models/model.d.ts +1 -0
  55. package/dist/models/model.js +12 -10
  56. package/dist/models/model.js.map +1 -1
  57. package/package.json +1 -1
  58. package/src/client.ts +64 -66
  59. package/src/models/ApproveFotaUpdateRequest.ts +5 -7
  60. package/src/models/ChangePasswordRequest.ts +3 -3
  61. package/src/models/DeleteFingerPrintTemplateRequest.ts +6 -6
  62. package/src/models/DeleteFingerPrintTemplateResponseBody.ts +1 -1
  63. package/src/models/DescribeFingerPrintTemplatesRequest.ts +3 -3
  64. package/src/models/DescribeFingerPrintTemplatesResponseBody.ts +5 -5
  65. package/src/models/DescribeGlobalDesktopsRequest.ts +35 -28
  66. package/src/models/DescribeGlobalDesktopsResponseBody.ts +89 -70
  67. package/src/models/DescribeRegionsRequest.ts +1 -1
  68. package/src/models/DescribeRegionsResponseBody.ts +1 -1
  69. package/src/models/DescribeSnapshotsRequest.ts +5 -5
  70. package/src/models/DescribeSnapshotsResponseBody.ts +11 -27
  71. package/src/models/DescribeUserResourcesRequest.ts +37 -21
  72. package/src/models/DescribeUserResourcesResponseBody.ts +248 -68
  73. package/src/models/EncryptPasswordRequest.ts +2 -2
  74. package/src/models/GetConnectionTicketRequest.ts +23 -17
  75. package/src/models/GetConnectionTicketResponseBody.ts +8 -4
  76. package/src/models/GetLoginTokenRequest.ts +34 -23
  77. package/src/models/GetLoginTokenResponseBody.ts +50 -25
  78. package/src/models/GetLoginTokenShrinkRequest.ts +34 -23
  79. package/src/models/RefreshLoginTokenRequest.ts +2 -2
  80. package/src/models/ReportSessionStatusRequest.ts +20 -6
  81. package/src/models/ReportSessionStatusResponseBody.ts +1 -1
  82. package/src/models/ResetPasswordRequest.ts +5 -5
  83. package/src/models/ResetSnapshotRequest.ts +4 -4
  84. package/src/models/SendTokenCodeRequest.ts +6 -6
  85. package/src/models/SetFingerPrintTemplateDescriptionRequest.ts +2 -2
  86. package/src/models/SetFingerPrintTemplateRequest.ts +8 -8
  87. package/src/models/SetFingerPrintTemplateResponseBody.ts +3 -3
  88. package/src/models/StopDesktopsRequest.ts +35 -8
  89. package/src/models/UnbindUserDesktopRequest.ts +4 -9
  90. package/src/models/VerifyCredentialRequest.ts +7 -9
  91. package/src/models/model.ts +1 -0
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class EncryptPasswordRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The ID of the client. The system generates a unique ID for each client.
8
+ * The unique ID generated by the client.
9
9
  *
10
10
  * This parameter is required.
11
11
  *
@@ -41,7 +41,7 @@ export class EncryptPasswordRequest extends $dara.Model {
41
41
  officeSiteId?: string;
42
42
  /**
43
43
  * @remarks
44
- * The password that you want to encrypt.
44
+ * The password.
45
45
  *
46
46
  * This parameter is required.
47
47
  *
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class GetConnectionTicketRequestTag extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The tag key. If you specify `Tag`, `Key` is required. The key cannot exceed 128 characters in length. It cannot start with `aliyun` or `acs:`, contain `http://` or `https://`, or consist of only spaces.
8
+ * The tag key. If you specify `Tag`, `Key` is required. The tag key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, contain `http://` or `https://`, or contain only spaces.
9
9
  *
10
10
  * @example
11
11
  * TestKey
@@ -13,7 +13,7 @@ export class GetConnectionTicketRequestTag extends $dara.Model {
13
13
  key?: string;
14
14
  /**
15
15
  * @remarks
16
- * The tag value. The value can be an empty string. It can be up to 128 characters in length. It cannot start with `acs:` or contain `http://` or `https://`.
16
+ * The tag value. The tag value can be an empty string. It can be up to 128 characters in length. It cannot start with `acs:` or contain `http://` or `https://`.
17
17
  *
18
18
  * @example
19
19
  * TestValue
@@ -43,10 +43,17 @@ export class GetConnectionTicketRequestTag extends $dara.Model {
43
43
  }
44
44
 
45
45
  export class GetConnectionTicketRequest extends $dara.Model {
46
+ /**
47
+ * @remarks
48
+ * The access method of the connection ticket.
49
+ *
50
+ * @example
51
+ * INTERNET
52
+ */
46
53
  accessType?: string;
47
54
  /**
48
55
  * @remarks
49
- * A unique ID generated by the client.
56
+ * The unique ID generated by the client.
50
57
  *
51
58
  * This parameter is required.
52
59
  *
@@ -56,7 +63,7 @@ export class GetConnectionTicketRequest extends $dara.Model {
56
63
  clientId?: string;
57
64
  /**
58
65
  * @remarks
59
- * The client operating system.
66
+ * The operating system of the client.
60
67
  *
61
68
  * @example
62
69
  * Windows_NT 10.0.18363 x64
@@ -64,7 +71,7 @@ export class GetConnectionTicketRequest extends $dara.Model {
64
71
  clientOS?: string;
65
72
  /**
66
73
  * @remarks
67
- * The client type.
74
+ * The type of the client.
68
75
  *
69
76
  * @example
70
77
  * windows
@@ -72,7 +79,7 @@ export class GetConnectionTicketRequest extends $dara.Model {
72
79
  clientType?: string;
73
80
  /**
74
81
  * @remarks
75
- * The client version.
82
+ * The version of the client.
76
83
  *
77
84
  * @example
78
85
  * 2.1.0-R-20210731.151756
@@ -80,11 +87,10 @@ export class GetConnectionTicketRequest extends $dara.Model {
80
87
  clientVersion?: string;
81
88
  /**
82
89
  * @remarks
83
- * This parameter lets you configure a custom user-mode application. After a ticket is obtained, the application is automatically run.
84
- *
85
- * - appPath: A string that specifies the path of the application startup file. For example, `"C:\\Program Files (x86)\\000\\000.exe"`. Note: Use double backslashes (\\) as separators.
90
+ * This parameter allows you to configure a custom user-mode application. After the credentials are successfully obtained, the application is automatically executed.
86
91
  *
87
- * - appParameter: A string that specifies the startup parameters of the application. For example, `"meetingid 000 meetingname aaa"`. Note: Use spaces to separate parameters.
92
+ * - appPath: String. The path to the application executable file. Example: `"C:\\Program Files (x86)\\000\\000.exe"`. Note that you must use double backslashes (\\) as path separators.
93
+ * - appParameter: String. The startup parameters for the application. Example: `"meetingid 000 meetingname aaa"`. Note that parameters are separated by spaces.
88
94
  *
89
95
  * @example
90
96
  * {
@@ -106,7 +112,7 @@ export class GetConnectionTicketRequest extends $dara.Model {
106
112
  commandContent?: string;
107
113
  /**
108
114
  * @remarks
109
- * The cloud computer ID.
115
+ * The ID of the cloud desktop.
110
116
  *
111
117
  * @example
112
118
  * ecd-gx2x1dhsmucyy****
@@ -114,7 +120,7 @@ export class GetConnectionTicketRequest extends $dara.Model {
114
120
  desktopId?: string;
115
121
  /**
116
122
  * @remarks
117
- * The logon credential. Call GetLoginToken to obtain this credential.
123
+ * The logon token. You can call the GetLoginToken operation to obtain the logon token.
118
124
  *
119
125
  * This parameter is required.
120
126
  *
@@ -125,7 +131,7 @@ export class GetConnectionTicketRequest extends $dara.Model {
125
131
  ownerId?: number;
126
132
  /**
127
133
  * @remarks
128
- * The region ID. Call [](t2223508.xdita#)to get a list of regions that Elastic Desktop Service (EDS) supports.
134
+ * The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) operation to query the list of regions supported by Elastic Desktop Service.
129
135
  *
130
136
  * This parameter is required.
131
137
  *
@@ -137,7 +143,7 @@ export class GetConnectionTicketRequest extends $dara.Model {
137
143
  resourceOwnerId?: number;
138
144
  /**
139
145
  * @remarks
140
- * The session ID. Call GetLoginToken to obtain this ID.
146
+ * The session ID. You can call the GetLoginToken operation to obtain the session ID.
141
147
  *
142
148
  * @example
143
149
  * cd45e873-650d-4d70-acb9-f996187a****
@@ -145,12 +151,12 @@ export class GetConnectionTicketRequest extends $dara.Model {
145
151
  sessionId?: string;
146
152
  /**
147
153
  * @remarks
148
- * A list of tags. You can include 1 to 20 tags.
154
+ * The list of tags. You can specify 1 to 20 tags.
149
155
  */
150
156
  tag?: GetConnectionTicketRequestTag[];
151
157
  /**
152
158
  * @remarks
153
- * The ID of the cloud computer connection task.<br>Do not specify this parameter in your first call. For subsequent calls, set this parameter to the `TaskId` returned from the previous call.<br>
159
+ * The ID of the cloud desktop connection task. You do not need to specify this parameter when you call this operation for the first time. For subsequent calls, set this parameter to the `TaskId` returned by the previous call.
154
160
  *
155
161
  * @example
156
162
  * 2afbad19-778a-4fc5-9674-1f19c638****
@@ -159,7 +165,7 @@ export class GetConnectionTicketRequest extends $dara.Model {
159
165
  ticketBlackList?: string[];
160
166
  /**
161
167
  * @remarks
162
- * The unique identifier of the client. If you use a Alibaba Cloud Workspace client, find this parameter in the **About** dialog box on the logon screen.
168
+ * The unique identifier of the client. If you use the Wuying client, you can view this parameter in the **About** dialog box on the client logon page.
163
169
  *
164
170
  * @example
165
171
  * 28c80e90-f71e-4c23-93d6-1225329cf949
@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
3
3
 
4
4
 
5
5
  export class GetConnectionTicketResponseBody extends $dara.Model {
6
+ /**
7
+ * @example
8
+ * ecd-1234567890abcdefg
9
+ */
6
10
  desktopId?: string;
7
11
  p2PToken?: string;
8
12
  /**
@@ -15,7 +19,7 @@ export class GetConnectionTicketResponseBody extends $dara.Model {
15
19
  requestId?: string;
16
20
  /**
17
21
  * @remarks
18
- * The ticket used to connect to the user instance. Before you use the ticket, decode its content from Base64, save it as an .ica file, and then open the file. The following code provides a Python example:
22
+ * The ticket used to connect to the user instance. Before you use the ticket, you must decode its content by using Base64, save the decoded content as an .ica file (for example, xxx.ica), and then open the file. Python code example:
19
23
  *
20
24
  * ```
21
25
  * import base64
@@ -35,7 +39,7 @@ export class GetConnectionTicketResponseBody extends $dara.Model {
35
39
  taskCode?: string;
36
40
  /**
37
41
  * @remarks
38
- * The ID of the cloud computer connection task.
42
+ * The ID of the cloud desktop connection task.
39
43
  *
40
44
  * @example
41
45
  * 2afbad19-778a-4fc5-9674-1f19c63862da
@@ -43,7 +47,7 @@ export class GetConnectionTicketResponseBody extends $dara.Model {
43
47
  taskId?: string;
44
48
  /**
45
49
  * @remarks
46
- * The ID of the cloud computer connection task.
50
+ * The ID of the cloud desktop connection task.
47
51
  *
48
52
  * @example
49
53
  * 2afbad19-778a-4fc5-9674-1f19c638****
@@ -59,7 +63,7 @@ export class GetConnectionTicketResponseBody extends $dara.Model {
59
63
  taskStatus?: string;
60
64
  /**
61
65
  * @remarks
62
- * The connection ticket for the cloud computer.
66
+ * The connection credentials for the cloud desktop.
63
67
  *
64
68
  * @example
65
69
  * W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********
@@ -5,12 +5,16 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class GetLoginTokenRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The security code generated by the virtual MFA device. This parameter is required when `CurrentStage` is set to `MFAVerify`.
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****
12
12
  */
13
13
  authenticationCode?: string;
14
+ /**
15
+ * @remarks
16
+ * The features supported by the client.
17
+ */
14
18
  availableFeatures?: { [key: string]: string };
15
19
  /**
16
20
  * @remarks
@@ -22,6 +26,13 @@ export class GetLoginTokenRequest extends $dara.Model {
22
26
  * f4a0dc8e-1702-4728-9a60-95b27a35****
23
27
  */
24
28
  clientId?: string;
29
+ /**
30
+ * @remarks
31
+ * The name of the client.
32
+ *
33
+ * @example
34
+ * demo-client
35
+ */
25
36
  clientName?: string;
26
37
  /**
27
38
  * @remarks
@@ -33,7 +44,7 @@ export class GetLoginTokenRequest extends $dara.Model {
33
44
  clientOS?: string;
34
45
  /**
35
46
  * @remarks
36
- * The type of the Elastic Desktop Service software client.
47
+ * The type of the Wuying software client.
37
48
  *
38
49
  * @example
39
50
  * WINDOWS
@@ -41,7 +52,7 @@ export class GetLoginTokenRequest extends $dara.Model {
41
52
  clientType?: string;
42
53
  /**
43
54
  * @remarks
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.
55
+ * The client version. If you use the Wuying client, you can view this parameter in the **About** dialog box on the client logon page.
45
56
  *
46
57
  * @example
47
58
  * 2.1.0-R-20210731.151756
@@ -49,14 +60,14 @@ export class GetLoginTokenRequest extends $dara.Model {
49
60
  clientVersion?: string;
50
61
  /**
51
62
  * @remarks
52
- * The current logon authentication stage. The stages are as follows:
63
+ * The current logon authentication stage. Valid values:
53
64
  *
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.
65
+ * - ADPassword: verifies user information. Specify this value when password-based authentication is used for a convenience account or an Active Directory (AD) account.
66
+ * - MFABind: binds a virtual MFA device.
67
+ * - MFAVerify: verifies the security code generated by the virtual MFA device.
68
+ * - TokenVerify: performs client-side secondary authentication.
69
+ * - ChangePassword: changes the user password.
70
+ * - KeepAliveVerify: exchanges a valid KeepAliveToken for a LoginToken.
60
71
  *
61
72
  * @example
62
73
  * ADPassword
@@ -64,7 +75,7 @@ export class GetLoginTokenRequest extends $dara.Model {
64
75
  currentStage?: string;
65
76
  /**
66
77
  * @remarks
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.
78
+ * The ID of the workspace. This parameter has the same meaning as OfficeSiteId. We recommend that you use OfficeSiteId instead of DirectoryId. You can specify only one of DirectoryId and OfficeSiteId.
68
79
  *
69
80
  * @example
70
81
  * cn-hangzhou+dir-885351****
@@ -72,7 +83,7 @@ export class GetLoginTokenRequest extends $dara.Model {
72
83
  directoryId?: string;
73
84
  /**
74
85
  * @remarks
75
- * The username of the convenience user or AD user. This parameter is required when `CurrentStage` is set to `ADPassword`.
86
+ * The username of the convenience user or AD user. This parameter is required when CurrentStage is set to ADPassword.
76
87
  *
77
88
  * @example
78
89
  * alice
@@ -80,7 +91,7 @@ export class GetLoginTokenRequest extends $dara.Model {
80
91
  endUserId?: string;
81
92
  /**
82
93
  * @remarks
83
- * Specifies whether to keep the logon session alive.
94
+ * Specifies whether to keep the user logged on.
84
95
  *
85
96
  * @example
86
97
  * false
@@ -88,7 +99,7 @@ export class GetLoginTokenRequest extends $dara.Model {
88
99
  keepAlive?: boolean;
89
100
  /**
90
101
  * @remarks
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`.
102
+ * The token used to keep the user logged on. After a successful logon and if the user enables the keep-logged-on option, the API returns KeepAliveToken. Within the validity period of KeepAliveToken, you can call the GetLoginToken operation and set CurrentStage to KeepAliveVerify to exchange it for a logon token (LoginToken). This parameter is required when CurrentStage is set to KeepAliveVerify.
92
103
  *
93
104
  * @example
94
105
  * hide
@@ -96,7 +107,7 @@ export class GetLoginTokenRequest extends $dara.Model {
96
107
  keepAliveToken?: string;
97
108
  /**
98
109
  * @remarks
99
- * The new password. This parameter is required when `CurrentStage` is set to `ChangePassword`.
110
+ * The new password. This parameter is required when CurrentStage is set to ChangePassword.
100
111
  *
101
112
  * @example
102
113
  * NewPassword
@@ -104,7 +115,7 @@ export class GetLoginTokenRequest extends $dara.Model {
104
115
  newPassword?: string;
105
116
  /**
106
117
  * @remarks
107
- * The office network ID.
118
+ * The ID of the workspace.
108
119
  *
109
120
  * @example
110
121
  * cn-hangzhou+dir-885351****
@@ -112,7 +123,7 @@ export class GetLoginTokenRequest extends $dara.Model {
112
123
  officeSiteId?: string;
113
124
  /**
114
125
  * @remarks
115
- * The old password. This parameter is required when `CurrentStage` is set to `ChangePassword`.
126
+ * The old password. This parameter is required when CurrentStage is set to ChangePassword.
116
127
  *
117
128
  * @example
118
129
  * OldPassword
@@ -120,7 +131,7 @@ export class GetLoginTokenRequest extends $dara.Model {
120
131
  oldPassword?: string;
121
132
  /**
122
133
  * @remarks
123
- * The password of the convenience user or AD user. This parameter is required when `CurrentStage` is set to `ADPassword`.
134
+ * The password of the convenience user or AD user. This parameter is required when CurrentStage is set to ADPassword.
124
135
  *
125
136
  * @example
126
137
  * Password1234
@@ -128,7 +139,7 @@ export class GetLoginTokenRequest extends $dara.Model {
128
139
  password?: string;
129
140
  /**
130
141
  * @remarks
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.
142
+ * The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) operation to query the regions supported by Elastic Desktop Service.
132
143
  *
133
144
  * This parameter is required.
134
145
  *
@@ -140,8 +151,8 @@ export class GetLoginTokenRequest extends $dara.Model {
140
151
  * @remarks
141
152
  * The session ID for logon.
142
153
  *
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).
154
+ * - If no virtual MFA device is bound or client-side secondary authentication is not enabled, you do not need to specify SessionId.
155
+ * - If a virtual MFA device is bound or client-side secondary authentication is enabled, you must specify SessionId in the logon 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).
145
156
  *
146
157
  * @example
147
158
  * cd45e873-650d-4d70-acb9-f996187a****
@@ -149,7 +160,7 @@ export class GetLoginTokenRequest extends $dara.Model {
149
160
  sessionId?: string;
150
161
  /**
151
162
  * @remarks
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`.
163
+ * The verification code for secondary authentication. If client-side secondary authentication is enabled in the Elastic Desktop Service console and the current logon user is identified as risky, the verification code is sent to the email address of the end user. This parameter is required when CurrentStage is set to TokenVerify.
153
164
  *
154
165
  * @example
155
166
  * 63****
@@ -157,7 +168,7 @@ export class GetLoginTokenRequest extends $dara.Model {
157
168
  tokenCode?: string;
158
169
  /**
159
170
  * @remarks
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.
171
+ * The unique identifier of the client. If you use the Wuying client, you can view this parameter in the **About** dialog box on the client logon page.
161
172
  *
162
173
  * @example
163
174
  * C78CA9E99315687575DD2844C1F3****
@@ -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 an internal field and is not available for public use.
8
+ * > Internal private field. Not available for external use.
9
9
  */
10
10
  tenantAlternativeChars?: string[];
11
11
  /**
12
12
  * @remarks
13
- * > This is an internal field and is not available for public use.
13
+ * > Internal private field. Not available for external 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 address used for identity verification when risk verification is triggered.
48
+ * The email address used for verification when identity verification is triggered.
49
49
  *
50
50
  * @example
51
51
  * user@example.com
@@ -69,7 +69,7 @@ export class GetLoginTokenResponseBodyRiskVerifyInfo extends $dara.Model {
69
69
  locked?: string;
70
70
  /**
71
71
  * @remarks
72
- * The phone number used for identity verification when risk verification is triggered.
72
+ * The mobile phone number used for verification when identity verification is triggered.
73
73
  *
74
74
  * @example
75
75
  * 1381111****
@@ -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. This value is returned with the LoginToken after logon.
108
+ * The email address of the user. This parameter is returned along with LoginToken after logon.
109
109
  *
110
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`.
111
+ * - For an AD user, the email address is returned in the following format: 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 convenience account username or AD username.
119
+ * The username of the convenience account or AD user.
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 an internal field and is not available for public use.
127
+ * > Internal private field. Not available for external 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 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.
135
+ * The token used to keep the user logged on. After a successful logon and if the user enables the keep-logged-on option, the API returns KeepAliveToken. If the keep-logged-on 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,7 +140,7 @@ export class GetLoginTokenResponseBody extends $dara.Model {
140
140
  keepAliveToken?: string;
141
141
  /**
142
142
  * @remarks
143
- * The property of the convenience user. If the user is an AD user, an empty value is returned.
143
+ * The properties of the convenience user. If the user is an AD user, an empty value is returned.
144
144
  *
145
145
  * @example
146
146
  * test:wuying
@@ -148,7 +148,7 @@ export class GetLoginTokenResponseBody extends $dara.Model {
148
148
  label?: string;
149
149
  /**
150
150
  * @remarks
151
- * The logon credential.
151
+ * The logon token.
152
152
  *
153
153
  * @example
154
154
  * v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
@@ -156,25 +156,46 @@ export class GetLoginTokenResponseBody extends $dara.Model {
156
156
  loginToken?: string;
157
157
  /**
158
158
  * @remarks
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.
159
+ * The expected next stage. For example, if the administrator enables MFA authentication in the Elastic Desktop Service console, this parameter returns `MFAVerify` after the username and password authentication succeeds (that is, after the `ADPassword` stage). This indicates that MFA authentication is required.
160
160
  *
161
- * > For more information about each authentication stage, see the parameter description of the `CurrentStage` request parameter of this operation.
161
+ * > For more information about each authentication stage, see the metric description of the `CurrentStage` request parameter.
162
162
  *
163
163
  * @example
164
164
  * MFAVerify
165
165
  */
166
166
  nextStage?: string;
167
+ /**
168
+ * @remarks
169
+ * The nickname of the user.
170
+ *
171
+ * @example
172
+ * user-001
173
+ */
167
174
  nickName?: string;
175
+ /**
176
+ * @remarks
177
+ * The ID of the workspace.
178
+ *
179
+ * @example
180
+ * cn-hangzhou+dir-885351****
181
+ */
168
182
  officeSiteId?: string;
183
+ /**
184
+ * @remarks
185
+ * The name of the workspace.
186
+ *
187
+ * @example
188
+ * test
189
+ */
169
190
  officeSiteName?: string;
170
191
  /**
171
192
  * @remarks
172
- * > This is an internal field and is not available for public use.
193
+ * > Internal private field. Not available for external use.
173
194
  */
174
195
  passwordStrategy?: GetLoginTokenResponseBodyPasswordStrategy;
175
196
  /**
176
197
  * @remarks
177
- * The phone number of the convenience user. If the user is an AD user, an empty value is returned.
198
+ * The mobile phone number of the convenience user. If the user is an AD user, an empty value is returned.
178
199
  *
179
200
  * @example
180
201
  * 1381111****
@@ -182,14 +203,14 @@ export class GetLoginTokenResponseBody extends $dara.Model {
182
203
  phone?: string;
183
204
  /**
184
205
  * @remarks
185
- * > This is an internal field and is not available for public use.
206
+ * > Internal private field. Not available for external use.
186
207
  */
187
208
  props?: { [key: string]: string };
188
209
  /**
189
210
  * @remarks
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.
211
+ * The QR code of the secret key used to attach a virtual MFA device. Uses Base64 encoding. This parameter can be empty and is used in the `MFABind` stage.
191
212
  *
192
- * > For more information about each authentication stage, see the parameter description of the `CurrentStage` request parameter of this operation.
213
+ * > For more information about each authentication stage, see the metric description of the `CurrentStage` request parameter.
193
214
  *
194
215
  * @example
195
216
  * 5OCLLKKOJU5HPBX66H3QCTWY******
@@ -197,7 +218,7 @@ export class GetLoginTokenResponseBody extends $dara.Model {
197
218
  qrCodePng?: string;
198
219
  /**
199
220
  * @remarks
200
- * > This is an internal field and is not available for public use.
221
+ * > Internal private field. Not available for external use.
201
222
  *
202
223
  * @example
203
224
  * null
@@ -218,9 +239,9 @@ export class GetLoginTokenResponseBody extends $dara.Model {
218
239
  riskVerifyInfo?: GetLoginTokenResponseBodyRiskVerifyInfo;
219
240
  /**
220
241
  * @remarks
221
- * The secret key used when attaching a virtual MFA device. This value is used in the `MFABind` stage.
242
+ * The secret key used to attach a virtual MFA device. Used in the `MFABind` stage.
222
243
  *
223
- * > For more information about each authentication stage, see the parameter description of the `CurrentStage` request parameter of this operation.
244
+ * > For more information about each authentication stage, see the metric description of the `CurrentStage` request parameter.
224
245
  *
225
246
  * @example
226
247
  * 5OCLLKKOJU5HPBX66H3QCTWYI7MH****
@@ -228,9 +249,9 @@ export class GetLoginTokenResponseBody extends $dara.Model {
228
249
  secret?: string;
229
250
  /**
230
251
  * @remarks
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.
252
+ * The session ID. This parameter is returned only when `GetLoginToken` is invoked for the first time in the same session. If multiple authentication steps are required, you must pass this parameter in subsequent stages.
232
253
  *
233
- * > For more information about each authentication stage, see the parameter description of the `CurrentStage` request parameter of this operation.
254
+ * > For more information about each authentication stage, see the metric description of the `CurrentStage` request parameter.
234
255
  *
235
256
  * @example
236
257
  * d6ec166d-ab93-4286-bf7f-a18bb929****
@@ -238,7 +259,7 @@ export class GetLoginTokenResponseBody extends $dara.Model {
238
259
  sessionId?: string;
239
260
  /**
240
261
  * @remarks
241
- * The Alibaba Cloud account ID. This value is used for hardware terminal identification.
262
+ * The Alibaba Cloud account ID. This parameter is used for hardware terminal identification.
242
263
  *
243
264
  * @example
244
265
  * 166353906220****
@@ -246,12 +267,16 @@ export class GetLoginTokenResponseBody extends $dara.Model {
246
267
  tenantId?: number;
247
268
  /**
248
269
  * @remarks
249
- * > This is an internal field and is not available for public use.
270
+ * > Internal private field. Not available for external use.
250
271
  *
251
272
  * @example
252
273
  * mode
253
274
  */
254
275
  windowDisplayMode?: string;
276
+ /**
277
+ * @example
278
+ * 0123456789abcdef
279
+ */
255
280
  wyId?: string;
256
281
  static names(): { [key: string]: string } {
257
282
  return {