@alicloud/ecd20201002 2.2.0 → 3.0.0

package/src/models/GetConnectionTicketResponseBody.ts

@@ -0,0 +1,102 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetConnectionTicketResponseBody extends $dara.Model {
+  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, decode its content from Base64, save it as an .ica file, and then open the file. The following code provides a Python 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 computer connection task.
+   * 
+   * @example
+   * 2afbad19-778a-4fc5-9674-1f19c63862da
+   */
+  taskId?: string;
+  /**
+   * @remarks
+   * The ID of the cloud computer connection task.
+   * 
+   * @example
+   * 2afbad19-778a-4fc5-9674-1f19c638****
+   */
+  taskMessage?: string;
+  /**
+   * @remarks
+   * The task status.
+   * 
+   * @example
+   * FINISHED
+   */
+  taskStatus?: string;
+  /**
+   * @remarks
+   * The connection ticket for the cloud computer.
+   * 
+   * @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,227 @@
+// 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;
+  availableFeatures?: { [key: string]: string };
+  /**
+   * @remarks
+   * The unique ID generated by the client.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * f4a0dc8e-1702-4728-9a60-95b27a35****
+   */
+  clientId?: string;
+  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 Elastic Desktop Service software client.
+   * 
+   * @example
+   * WINDOWS
+   */
+  clientType?: string;
+  /**
+   * @remarks
+   * 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.
+   * 
+   * @example
+   * 2.1.0-R-20210731.151756
+   */
+  clientVersion?: string;
+  /**
+   * @remarks
+   * The current logon authentication stage. The stages are as follows:
+   * 
+   * - `ADPassword`: verifies user information. Specify this value when authenticating with the credentials of a convenience account or an AD account.
+   * - `MFABind`: binds a virtual MFA device.
+   * - `MFAVerify`: verifies the security code generated by the virtual MFA device.
+   * - `TokenVerify`: performs client secondary authentication.
+   * - `ChangePassword`: changes the user password.
+   * - `KeepAliveVerify`: exchanges a valid KeepAliveToken for a LoginToken.
+   * 
+   * @example
+   * ADPassword
+   */
+  currentStage?: string;
+  /**
+   * @remarks
+   * 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.
+   * 
+   * @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 logon session alive.
+   * 
+   * @example
+   * false
+   */
+  keepAlive?: boolean;
+  /**
+   * @remarks
+   * 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`.
+   * 
+   * @example
+   * hide
+   */
+  keepAliveToken?: string;
+  /**
+   * @remarks
+   * The new password. This parameter is required when `CurrentStage` is set to `ChangePassword`.
+   * 
+   * @example
+   * NewPassword
+   */
+  newPassword?: string;
+  /**
+   * @remarks
+   * The office network ID.
+   * 
+   * @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 [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) 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 secondary authentication is not enabled, you do not need to specify `SessionId`.
+   * - 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).
+   * 
+   * @example
+   * cd45e873-650d-4d70-acb9-f996187a****
+   */
+  sessionId?: string;
+  /**
+   * @remarks
+   * 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`.
+   * 
+   * @example
+   * 63****
+   */
+  tokenCode?: string;
+  /**
+   * @remarks
+   * 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.
+   * 
+   * @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);
+  }
+}
+

package/src/models/GetLoginTokenResponseBody.ts

@@ -0,0 +1,327 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetLoginTokenResponseBodyPasswordStrategy extends $dara.Model {
+  /**
+   * @remarks
+   * > This is an internal field and is not available for public use.
+   */
+  tenantAlternativeChars?: string[];
+  /**
+   * @remarks
+   * > This is an internal field and is not available for public use.
+   * 
+   * @example
+   * null
+   */
+  tenantPasswordLength?: string;
+  static names(): { [key: string]: string } {
+    return {
+      tenantAlternativeChars: 'TenantAlternativeChars',
+      tenantPasswordLength: 'TenantPasswordLength',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      tenantAlternativeChars: { 'type': 'array', 'itemType': 'string' },
+      tenantPasswordLength: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.tenantAlternativeChars)) {
+      $dara.Model.validateArray(this.tenantAlternativeChars);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetLoginTokenResponseBodyRiskVerifyInfo extends $dara.Model {
+  /**
+   * @remarks
+   * The email address used for identity verification when risk verification is triggered.
+   * 
+   * @example
+   * user@example.com
+   */
+  email?: string;
+  /**
+   * @remarks
+   * The account lockout duration.
+   * 
+   * @example
+   * 1713749778
+   */
+  lastLockDuration?: number;
+  /**
+   * @remarks
+   * Indicates whether the account is locked.
+   * 
+   * @example
+   * true
+   */
+  locked?: string;
+  /**
+   * @remarks
+   * The phone number used for identity verification when risk verification is triggered.
+   * 
+   * @example
+   * 1381111****
+   */
+  phone?: string;
+  static names(): { [key: string]: string } {
+    return {
+      email: 'Email',
+      lastLockDuration: 'LastLockDuration',
+      locked: 'Locked',
+      phone: 'Phone',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      email: 'string',
+      lastLockDuration: 'number',
+      locked: 'string',
+      phone: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetLoginTokenResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The email address of the user. This value is returned with the LoginToken after logon.    
+   * 
+   * - For a convenience user, the email address specified when the convenience user was created is returned.
+   * - For an AD user, the value is returned in the format of `username@AD domain name`.
+   * 
+   * @example
+   * alice
+   */
+  email?: string;
+  /**
+   * @remarks
+   * The convenience account username or AD username.
+   * 
+   * @example
+   * alice
+   */
+  endUserId?: string;
+  /**
+   * @remarks
+   * > This is an internal field and is not available for public use.
+   * 
+   * @example
+   * edu
+   */
+  industry?: string;
+  /**
+   * @remarks
+   * 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.
+   * 
+   * @example
+   * 006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW
+   */
+  keepAliveToken?: string;
+  /**
+   * @remarks
+   * The property of the convenience user. If the user is an AD user, an empty value is returned.
+   * 
+   * @example
+   * test:wuying
+   */
+  label?: string;
+  /**
+   * @remarks
+   * The logon credential.
+   * 
+   * @example
+   * v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
+   */
+  loginToken?: string;
+  /**
+   * @remarks
+   * 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.
+   * 
+   * > For more information about each authentication stage, see the parameter description of the `CurrentStage` request parameter of this operation.
+   * 
+   * @example
+   * MFAVerify
+   */
+  nextStage?: string;
+  nickName?: string;
+  officeSiteId?: string;
+  officeSiteName?: string;
+  /**
+   * @remarks
+   * > This is an internal field and is not available for public use.
+   */
+  passwordStrategy?: GetLoginTokenResponseBodyPasswordStrategy;
+  /**
+   * @remarks
+   * The phone number of the convenience user. If the user is an AD user, an empty value is returned.
+   * 
+   * @example
+   * 1381111****
+   */
+  phone?: string;
+  /**
+   * @remarks
+   * > This is an internal field and is not available for public use.
+   */
+  props?: { [key: string]: string };
+  /**
+   * @remarks
+   * 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.
+   * 
+   * > For more information about each authentication stage, see the parameter description of the `CurrentStage` request parameter of this operation.
+   * 
+   * @example
+   * 5OCLLKKOJU5HPBX66H3QCTWY******
+   */
+  qrCodePng?: string;
+  /**
+   * @remarks
+   * > This is an internal field and is not available for public use.
+   * 
+   * @example
+   * null
+   */
+  reason?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The logon risk identification information.
+   */
+  riskVerifyInfo?: GetLoginTokenResponseBodyRiskVerifyInfo;
+  /**
+   * @remarks
+   * The secret key used when attaching a virtual MFA device. This value is used in the `MFABind` stage.
+   * 
+   * > For more information about each authentication stage, see the parameter description of the `CurrentStage` request parameter of this operation.
+   * 
+   * @example
+   * 5OCLLKKOJU5HPBX66H3QCTWYI7MH****
+   */
+  secret?: string;
+  /**
+   * @remarks
+   * 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.
+   * 
+   * > For more information about each authentication stage, see the parameter description of the `CurrentStage` request parameter of this operation.
+   * 
+   * @example
+   * d6ec166d-ab93-4286-bf7f-a18bb929****
+   */
+  sessionId?: string;
+  /**
+   * @remarks
+   * The Alibaba Cloud account ID. This value is used for hardware terminal identification.
+   * 
+   * @example
+   * 166353906220****
+   */
+  tenantId?: number;
+  /**
+   * @remarks
+   * > This is an internal field and is not available for public use.
+   * 
+   * @example
+   * mode
+   */
+  windowDisplayMode?: string;
+  wyId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      email: 'Email',
+      endUserId: 'EndUserId',
+      industry: 'Industry',
+      keepAliveToken: 'KeepAliveToken',
+      label: 'Label',
+      loginToken: 'LoginToken',
+      nextStage: 'NextStage',
+      nickName: 'NickName',
+      officeSiteId: 'OfficeSiteId',
+      officeSiteName: 'OfficeSiteName',
+      passwordStrategy: 'PasswordStrategy',
+      phone: 'Phone',
+      props: 'Props',
+      qrCodePng: 'QrCodePng',
+      reason: 'Reason',
+      requestId: 'RequestId',
+      riskVerifyInfo: 'RiskVerifyInfo',
+      secret: 'Secret',
+      sessionId: 'SessionId',
+      tenantId: 'TenantId',
+      windowDisplayMode: 'WindowDisplayMode',
+      wyId: 'WyId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      email: 'string',
+      endUserId: 'string',
+      industry: 'string',
+      keepAliveToken: 'string',
+      label: 'string',
+      loginToken: 'string',
+      nextStage: 'string',
+      nickName: 'string',
+      officeSiteId: 'string',
+      officeSiteName: 'string',
+      passwordStrategy: GetLoginTokenResponseBodyPasswordStrategy,
+      phone: 'string',
+      props: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      qrCodePng: 'string',
+      reason: 'string',
+      requestId: 'string',
+      riskVerifyInfo: GetLoginTokenResponseBodyRiskVerifyInfo,
+      secret: 'string',
+      sessionId: 'string',
+      tenantId: 'number',
+      windowDisplayMode: 'string',
+      wyId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.passwordStrategy && typeof (this.passwordStrategy as any).validate === 'function') {
+      (this.passwordStrategy as any).validate();
+    }
+    if(this.props) {
+      $dara.Model.validateMap(this.props);
+    }
+    if(this.riskVerifyInfo && typeof (this.riskVerifyInfo as any).validate === 'function') {
+      (this.riskVerifyInfo as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+