@alicloud/ecd20201002 2.2.0 → 3.0.1

package/src/models/GetConnectionTicketResponseBody.ts

@@ -0,0 +1,106 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetConnectionTicketResponseBody extends $dara.Model {
+  /**
+   * @example
+   * ecd-1234567890abcdefg
+   */
+  desktopId?: string;
+  p2PToken?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * 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:
+   * 
+   * ```
+   * import base64
+   * response = {
+   *     "Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",
+   *     "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
+   * }
+   * f = open (\\"xxx.ica\\", \\"w\\")
+   * out = base64.b64decode(response[\\"Ticket\\"])
+   * f.write(out)
+   * f.close()
+   * ```
+   * 
+   * @example
+   * W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********
+   */
+  taskCode?: string;
+  /**
+   * @remarks
+   * The ID of the cloud desktop connection task.
+   * 
+   * @example
+   * 2afbad19-778a-4fc5-9674-1f19c63862da
+   */
+  taskId?: string;
+  /**
+   * @remarks
+   * The ID of the cloud desktop connection task.
+   * 
+   * @example
+   * 2afbad19-778a-4fc5-9674-1f19c638****
+   */
+  taskMessage?: string;
+  /**
+   * @remarks
+   * The task status.
+   * 
+   * @example
+   * FINISHED
+   */
+  taskStatus?: string;
+  /**
+   * @remarks
+   * The connection credentials for the cloud desktop.
+   * 
+   * @example
+   * W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********
+   */
+  ticket?: string;
+  static names(): { [key: string]: string } {
+    return {
+      desktopId: 'DesktopId',
+      p2PToken: 'P2PToken',
+      requestId: 'RequestId',
+      taskCode: 'TaskCode',
+      taskId: 'TaskId',
+      taskMessage: 'TaskMessage',
+      taskStatus: 'TaskStatus',
+      ticket: 'Ticket',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      desktopId: 'string',
+      p2PToken: 'string',
+      requestId: 'string',
+      taskCode: 'string',
+      taskId: 'string',
+      taskMessage: 'string',
+      taskStatus: 'string',
+      ticket: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetLoginTokenRequest.ts

@@ -0,0 +1,238 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetLoginTokenRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The security code generated by the virtual MFA device. This parameter is required when CurrentStage is set to MFAVerify.
+   * 
+   * @example
+   * 47****
+   */
+  authenticationCode?: string;
+  /**
+   * @remarks
+   * The features supported by the client.
+   */
+  availableFeatures?: { [key: string]: string };
+  /**
+   * @remarks
+   * The unique ID generated by the client.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * f4a0dc8e-1702-4728-9a60-95b27a35****
+   */
+  clientId?: string;
+  /**
+   * @remarks
+   * The name of the client.
+   * 
+   * @example
+   * demo-client
+   */
+  clientName?: string;
+  /**
+   * @remarks
+   * The operating system of the device on which the client runs.
+   * 
+   * @example
+   * Windows_NT 10.0.18363 x64
+   */
+  clientOS?: string;
+  /**
+   * @remarks
+   * The type of the Wuying software client.
+   * 
+   * @example
+   * WINDOWS
+   */
+  clientType?: string;
+  /**
+   * @remarks
+   * The client version. If you use the Wuying client, you can view this parameter in the **About** dialog box on the client logon page.
+   * 
+   * @example
+   * 2.1.0-R-20210731.151756
+   */
+  clientVersion?: string;
+  /**
+   * @remarks
+   * The current logon authentication stage. Valid values:
+   * 
+   * - ADPassword: verifies user information. Specify this value when password-based authentication is used for a convenience account or an Active Directory (AD) account.
+   * - MFABind: binds a virtual MFA device.
+   * - MFAVerify: verifies the security code generated by the virtual MFA device.
+   * - TokenVerify: performs client-side secondary authentication.
+   * - ChangePassword: changes the user password.
+   * - KeepAliveVerify: exchanges a valid KeepAliveToken for a LoginToken.
+   * 
+   * @example
+   * ADPassword
+   */
+  currentStage?: string;
+  /**
+   * @remarks
+   * 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.
+   * 
+   * @example
+   * cn-hangzhou+dir-885351****
+   */
+  directoryId?: string;
+  /**
+   * @remarks
+   * The username of the convenience user or AD user. This parameter is required when CurrentStage is set to ADPassword.
+   * 
+   * @example
+   * alice
+   */
+  endUserId?: string;
+  /**
+   * @remarks
+   * Specifies whether to keep the user logged on.
+   * 
+   * @example
+   * false
+   */
+  keepAlive?: boolean;
+  /**
+   * @remarks
+   * 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.
+   * 
+   * @example
+   * hide
+   */
+  keepAliveToken?: string;
+  /**
+   * @remarks
+   * The new password. This parameter is required when CurrentStage is set to ChangePassword.
+   * 
+   * @example
+   * NewPassword
+   */
+  newPassword?: string;
+  /**
+   * @remarks
+   * The ID of the workspace.
+   * 
+   * @example
+   * cn-hangzhou+dir-885351****
+   */
+  officeSiteId?: string;
+  /**
+   * @remarks
+   * The old password. This parameter is required when CurrentStage is set to ChangePassword.
+   * 
+   * @example
+   * OldPassword
+   */
+  oldPassword?: string;
+  /**
+   * @remarks
+   * The password of the convenience user or AD user. This parameter is required when CurrentStage is set to ADPassword.
+   * 
+   * @example
+   * Password1234
+   */
+  password?: string;
+  /**
+   * @remarks
+   * 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.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The session ID for logon.
+   * 
+   * - If no virtual MFA device is bound or client-side secondary authentication is not enabled, you do not need to specify SessionId.
+   * - 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).
+   * 
+   * @example
+   * cd45e873-650d-4d70-acb9-f996187a****
+   */
+  sessionId?: string;
+  /**
+   * @remarks
+   * 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.
+   * 
+   * @example
+   * 63****
+   */
+  tokenCode?: string;
+  /**
+   * @remarks
+   * 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.
+   * 
+   * @example
+   * C78CA9E99315687575DD2844C1F3****
+   */
+  uuid?: string;
+  static names(): { [key: string]: string } {
+    return {
+      authenticationCode: 'AuthenticationCode',
+      availableFeatures: 'AvailableFeatures',
+      clientId: 'ClientId',
+      clientName: 'ClientName',
+      clientOS: 'ClientOS',
+      clientType: 'ClientType',
+      clientVersion: 'ClientVersion',
+      currentStage: 'CurrentStage',
+      directoryId: 'DirectoryId',
+      endUserId: 'EndUserId',
+      keepAlive: 'KeepAlive',
+      keepAliveToken: 'KeepAliveToken',
+      newPassword: 'NewPassword',
+      officeSiteId: 'OfficeSiteId',
+      oldPassword: 'OldPassword',
+      password: 'Password',
+      regionId: 'RegionId',
+      sessionId: 'SessionId',
+      tokenCode: 'TokenCode',
+      uuid: 'Uuid',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      authenticationCode: 'string',
+      availableFeatures: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      clientId: 'string',
+      clientName: 'string',
+      clientOS: 'string',
+      clientType: 'string',
+      clientVersion: 'string',
+      currentStage: 'string',
+      directoryId: 'string',
+      endUserId: 'string',
+      keepAlive: 'boolean',
+      keepAliveToken: 'string',
+      newPassword: 'string',
+      officeSiteId: 'string',
+      oldPassword: 'string',
+      password: 'string',
+      regionId: 'string',
+      sessionId: 'string',
+      tokenCode: 'string',
+      uuid: 'string',
+    };
+  }
+
+  validate() {
+    if(this.availableFeatures) {
+      $dara.Model.validateMap(this.availableFeatures);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetLoginTokenResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { GetLoginTokenResponseBody } from "./GetLoginTokenResponseBody";
+
+
+export class GetLoginTokenResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: GetLoginTokenResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: GetLoginTokenResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+