alibabacloud-ecd20201002 1.2.9__py3-none-any.whl → 1.2.11__py3-none-any.whl

alibabacloud_ecd20201002/models/_get_login_token_response_body.py

@@ -0,0 +1,314 @@
+# -*- coding: utf-8 -*-
+# This file is auto-generated, don't edit it. Thanks.
+from __future__ import annotations
+
+from typing import Dict, List
+
+from alibabacloud_ecd20201002 import models as main_models
+from darabonba.model import DaraModel
+
+class GetLoginTokenResponseBody(DaraModel):
+    def __init__(
+        self,
+        email: str = None,
+        end_user_id: str = None,
+        industry: str = None,
+        keep_alive_token: str = None,
+        label: str = None,
+        login_token: str = None,
+        next_stage: str = None,
+        nick_name: str = None,
+        password_strategy: main_models.GetLoginTokenResponseBodyPasswordStrategy = None,
+        phone: str = None,
+        props: Dict[str, str] = None,
+        qr_code_png: str = None,
+        reason: str = None,
+        request_id: str = None,
+        risk_verify_info: main_models.GetLoginTokenResponseBodyRiskVerifyInfo = None,
+        secret: str = None,
+        session_id: str = None,
+        tenant_id: int = None,
+        window_display_mode: str = None,
+        wy_id: str = None,
+    ):
+        # The email address of the user. The system returns the email address in the return value of the LoginToken parameter after the user logs on to the client.
+        # 
+        # *   For a convenience user, the return value is the email address specified when the administrator creates the convenience user.
+        # *   For an AD user, the return value is in the following format: `Username@Name of the AD domain`.
+        self.email = email
+        # The account of the convenience user or the AD user.
+        self.end_user_id = end_user_id
+        # > This is a parameter only for internal use.
+        self.industry = industry
+        # The token used to keep the user logged on. After the user logs on to the client and select the Keep Logon option, `KeepAliveToken` is returned when you call the operation. If the user does not select the Keep Logon option, null is returned.
+        self.keep_alive_token = keep_alive_token
+        # The attribute of the convenience user. For an AD user, null is returned.
+        self.label = label
+        # The logon token.
+        self.login_token = login_token
+        # The next stage that is expected to enter. For example, an administrator enables MFA in the EDS console. When an end user enters the password, that is, the end user completes the `ADPassword` stage, this parameter returns `MFAVerify`. This indicates that MFA is required.
+        # 
+        # >  For more information about the authentication stages, see the `CurrentStage` parameter.
+        self.next_stage = next_stage
+        self.nick_name = nick_name
+        # > This is a parameter only for internal use.
+        self.password_strategy = password_strategy
+        # Enter the mobile number of the convenience user. For an AD user, null is returned.
+        self.phone = phone
+        # > This is a parameter only for internal use.
+        self.props = props
+        # The QR code that is generated when the virtual MFA device is bound. The value is encoded in Base64. This parameter can be empty. This parameter is required only when the CurrentStage parameter is set to `MFABind`.
+        # 
+        # > For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.
+        self.qr_code_png = qr_code_png
+        # > This is a parameter only for internal use.
+        self.reason = reason
+        # The ID of the request.
+        self.request_id = request_id
+        # Risk identification information regarding the signin process.
+        self.risk_verify_info = risk_verify_info
+        # The key that is generated when you bind the virtual MFA device. This parameter is required when the CurrentStage parameter is set to `MFABind`.
+        # 
+        # > For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.
+        self.secret = secret
+        # The ID of the session. The ID is returned the first time you call the `GetLoginToken` operation in the session. If MFA is required, you must specify this parameter in subsequent stages.
+        # 
+        # > For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.
+        self.session_id = session_id
+        # The ID of the Alibaba Cloud account. The ID is used for hardware client authentication.
+        self.tenant_id = tenant_id
+        # > This is a parameter only for internal use.
+        self.window_display_mode = window_display_mode
+        self.wy_id = wy_id
+
+    def validate(self):
+        if self.password_strategy:
+            self.password_strategy.validate()
+        if self.risk_verify_info:
+            self.risk_verify_info.validate()
+
+    def to_map(self):
+        result = dict()
+        _map = super().to_map()
+        if _map is not None:
+            result = _map
+        if self.email is not None:
+            result['Email'] = self.email
+
+        if self.end_user_id is not None:
+            result['EndUserId'] = self.end_user_id
+
+        if self.industry is not None:
+            result['Industry'] = self.industry
+
+        if self.keep_alive_token is not None:
+            result['KeepAliveToken'] = self.keep_alive_token
+
+        if self.label is not None:
+            result['Label'] = self.label
+
+        if self.login_token is not None:
+            result['LoginToken'] = self.login_token
+
+        if self.next_stage is not None:
+            result['NextStage'] = self.next_stage
+
+        if self.nick_name is not None:
+            result['NickName'] = self.nick_name
+
+        if self.password_strategy is not None:
+            result['PasswordStrategy'] = self.password_strategy.to_map()
+
+        if self.phone is not None:
+            result['Phone'] = self.phone
+
+        if self.props is not None:
+            result['Props'] = self.props
+
+        if self.qr_code_png is not None:
+            result['QrCodePng'] = self.qr_code_png
+
+        if self.reason is not None:
+            result['Reason'] = self.reason
+
+        if self.request_id is not None:
+            result['RequestId'] = self.request_id
+
+        if self.risk_verify_info is not None:
+            result['RiskVerifyInfo'] = self.risk_verify_info.to_map()
+
+        if self.secret is not None:
+            result['Secret'] = self.secret
+
+        if self.session_id is not None:
+            result['SessionId'] = self.session_id
+
+        if self.tenant_id is not None:
+            result['TenantId'] = self.tenant_id
+
+        if self.window_display_mode is not None:
+            result['WindowDisplayMode'] = self.window_display_mode
+
+        if self.wy_id is not None:
+            result['WyId'] = self.wy_id
+
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        if m.get('Email') is not None:
+            self.email = m.get('Email')
+
+        if m.get('EndUserId') is not None:
+            self.end_user_id = m.get('EndUserId')
+
+        if m.get('Industry') is not None:
+            self.industry = m.get('Industry')
+
+        if m.get('KeepAliveToken') is not None:
+            self.keep_alive_token = m.get('KeepAliveToken')
+
+        if m.get('Label') is not None:
+            self.label = m.get('Label')
+
+        if m.get('LoginToken') is not None:
+            self.login_token = m.get('LoginToken')
+
+        if m.get('NextStage') is not None:
+            self.next_stage = m.get('NextStage')
+
+        if m.get('NickName') is not None:
+            self.nick_name = m.get('NickName')
+
+        if m.get('PasswordStrategy') is not None:
+            temp_model = main_models.GetLoginTokenResponseBodyPasswordStrategy()
+            self.password_strategy = temp_model.from_map(m.get('PasswordStrategy'))
+
+        if m.get('Phone') is not None:
+            self.phone = m.get('Phone')
+
+        if m.get('Props') is not None:
+            self.props = m.get('Props')
+
+        if m.get('QrCodePng') is not None:
+            self.qr_code_png = m.get('QrCodePng')
+
+        if m.get('Reason') is not None:
+            self.reason = m.get('Reason')
+
+        if m.get('RequestId') is not None:
+            self.request_id = m.get('RequestId')
+
+        if m.get('RiskVerifyInfo') is not None:
+            temp_model = main_models.GetLoginTokenResponseBodyRiskVerifyInfo()
+            self.risk_verify_info = temp_model.from_map(m.get('RiskVerifyInfo'))
+
+        if m.get('Secret') is not None:
+            self.secret = m.get('Secret')
+
+        if m.get('SessionId') is not None:
+            self.session_id = m.get('SessionId')
+
+        if m.get('TenantId') is not None:
+            self.tenant_id = m.get('TenantId')
+
+        if m.get('WindowDisplayMode') is not None:
+            self.window_display_mode = m.get('WindowDisplayMode')
+
+        if m.get('WyId') is not None:
+            self.wy_id = m.get('WyId')
+
+        return self
+
+class GetLoginTokenResponseBodyRiskVerifyInfo(DaraModel):
+    def __init__(
+        self,
+        email: str = None,
+        last_lock_duration: int = None,
+        locked: str = None,
+        phone: str = None,
+    ):
+        # The email used for authentication.
+        self.email = email
+        # The duration of the lock.
+        self.last_lock_duration = last_lock_duration
+        # Whether the account is locked or not.
+        self.locked = locked
+        # The mobile number used for authentication.
+        self.phone = phone
+
+    def validate(self):
+        pass
+
+    def to_map(self):
+        result = dict()
+        _map = super().to_map()
+        if _map is not None:
+            result = _map
+        if self.email is not None:
+            result['Email'] = self.email
+
+        if self.last_lock_duration is not None:
+            result['LastLockDuration'] = self.last_lock_duration
+
+        if self.locked is not None:
+            result['Locked'] = self.locked
+
+        if self.phone is not None:
+            result['Phone'] = self.phone
+
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        if m.get('Email') is not None:
+            self.email = m.get('Email')
+
+        if m.get('LastLockDuration') is not None:
+            self.last_lock_duration = m.get('LastLockDuration')
+
+        if m.get('Locked') is not None:
+            self.locked = m.get('Locked')
+
+        if m.get('Phone') is not None:
+            self.phone = m.get('Phone')
+
+        return self
+
+class GetLoginTokenResponseBodyPasswordStrategy(DaraModel):
+    def __init__(
+        self,
+        tenant_alternative_chars: List[str] = None,
+        tenant_password_length: str = None,
+    ):
+        # > This is a parameter only for internal use.
+        self.tenant_alternative_chars = tenant_alternative_chars
+        # > This is a parameter only for internal use.
+        self.tenant_password_length = tenant_password_length
+
+    def validate(self):
+        pass
+
+    def to_map(self):
+        result = dict()
+        _map = super().to_map()
+        if _map is not None:
+            result = _map
+        if self.tenant_alternative_chars is not None:
+            result['TenantAlternativeChars'] = self.tenant_alternative_chars
+
+        if self.tenant_password_length is not None:
+            result['TenantPasswordLength'] = self.tenant_password_length
+
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        if m.get('TenantAlternativeChars') is not None:
+            self.tenant_alternative_chars = m.get('TenantAlternativeChars')
+
+        if m.get('TenantPasswordLength') is not None:
+            self.tenant_password_length = m.get('TenantPasswordLength')
+
+        return self
+

alibabacloud_ecd20201002/models/_get_login_token_shrink_request.py

@@ -0,0 +1,233 @@
+# -*- coding: utf-8 -*-
+# This file is auto-generated, don't edit it. Thanks.
+from __future__ import annotations
+
+from darabonba.model import DaraModel
+
+class GetLoginTokenShrinkRequest(DaraModel):
+    def __init__(
+        self,
+        authentication_code: str = None,
+        available_features_shrink: str = None,
+        client_id: str = None,
+        client_name: str = None,
+        client_os: str = None,
+        client_type: str = None,
+        client_version: str = None,
+        current_stage: str = None,
+        directory_id: str = None,
+        end_user_id: str = None,
+        keep_alive: bool = None,
+        keep_alive_token: str = None,
+        new_password: str = None,
+        office_site_id: str = None,
+        old_password: str = None,
+        password: str = None,
+        region_id: str = None,
+        session_id: str = None,
+        token_code: str = None,
+        uuid: str = None,
+    ):
+        # The verification code that is generated by the virtual MFA device. This parameter is required if you set `CurrentStage` to `MFAVerify`.
+        self.authentication_code = authentication_code
+        self.available_features_shrink = available_features_shrink
+        # The ID of the Alibaba Cloud Workspace client. The system generates a unique ID for each client.
+        # 
+        # This parameter is required.
+        self.client_id = client_id
+        self.client_name = client_name
+        # The operating system (OS) of the device that runs an Alibaba Cloud Workspace client.
+        self.client_os = client_os
+        # The type of Alibaba Cloud Workspace clients.
+        # 
+        # Valid values:
+        # 
+        # *   HTML5: web client.
+        # 
+        # *   WINDOWS: Windows client.
+        # 
+        # *   MACOS: macOS client.
+        # 
+        # *   IOS: iOS client.
+        # 
+        # *   ANDROID: Android client.
+        self.client_type = client_type
+        # The version of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the **About** dialog box on the client logon page.
+        self.client_version = client_version
+        # The logon authentication stage. Valid values:
+        # 
+        # *   `ADPassword`: the stage to verify the identity of the Active Directory (AD) user. You must specify the value when the system verifies the identity of a convenience account or an AD account.
+        # *   `MFABind: the stage to bind a virtual multi-factor authentication (MFA) device.`
+        # *   `MFAVerify: the stage to verify the verification code that is generated by the virtual MFA device.`
+        # *   `TokenVerify`: the stage to perform two-factor authentication on an Alibaba Cloud Workspace client (hereinafter referred to as the client).
+        # *   `ChangePassword`: the stage to change the password of the user.
+        # *   `KeepAliveVerify`: the stage to obtain LoginToken if KeepAliveToken is valid.
+        self.current_stage = current_stage
+        # The office network ID. This parameter has the same meaning as `OfficeSiteId`. We recommend that you replace `DirectoryId` with `OfficeSiteId`. You can specify a value for `DirectoryId` or `OfficeSiteId`.
+        self.directory_id = directory_id
+        # The name of the convenience user or the AD user. This parameter is required if you set `CurrentStage` to `ADPassword`.
+        self.end_user_id = end_user_id
+        # Specifies whether to keep the user logged on to the client. 
+        # Valid values:
+        # * null: Default value. Do not keep the user logged on to the client.
+        # * true: Keep the user logged on to the client.
+        # * false:  Do not keep the user logged on to the client.
+        self.keep_alive = keep_alive
+        # The token to keep logging on to an Alibaba Cloud Workspace client. When an end user logs on to the Alibaba Cloud Workspace client and select Auto Sign-in, `KeepAliveToken` is returned after you call this operation. Within the valid period of the returned token``, you can call the `GetLoginToken` operation and set `CurrentStage` to `KeepAliveVerify`. Then, you can obtain LoginToken. If you set `CurrentStage` to `KeepAliveVerify`, `KeepAliveToken` is required.
+        self.keep_alive_token = keep_alive_token
+        # The new password. This parameter is required if you set `CurrentStage` to `ChangePassword`.
+        self.new_password = new_password
+        # The office network ID.
+        self.office_site_id = office_site_id
+        # The current password. This parameter is required if you set `CurrentStage` to `ChangePassword`.
+        self.old_password = old_password
+        # The password of the convenience user or the AD user. This parameter is required if you set `CurrentStage` to `ADPassword`.
+        self.password = password
+        # The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) operation to query the regions supported by EDS.
+        # 
+        # This parameter is required.
+        self.region_id = region_id
+        # The ID of the session.
+        # 
+        # *   If the virtual multi-factor authentication (MFA) device is not bound or two-factor authentication is not enabled for the client, you do not need to specify a value for `SessionId`.
+        # *   If the virtual MFA device is not bound or two-factor authentication is enabled for the client, you must specify a value for `SessionId` to verify the user identity after you specify a value for `ADPassword`. The value of the `SessionId` parameter is returned only if the CurrentStage parameter is set to `ADPassword` when you call the `GetLoginToken` operation.
+        self.session_id = session_id
+        # If two-factor authentication is enabled for Alibaba Cloud Workspace terminals in the EDS console and the system detects that the current logon user is exposed to risks, the system sends a verification code to the email address of the user. This parameter is required if you set `CurrentStage` to `TokenVerify`.
+        self.token_code = token_code
+        # The unique identifier of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the **About** dialog box on the client logon page.
+        self.uuid = uuid
+
+    def validate(self):
+        pass
+
+    def to_map(self):
+        result = dict()
+        _map = super().to_map()
+        if _map is not None:
+            result = _map
+        if self.authentication_code is not None:
+            result['AuthenticationCode'] = self.authentication_code
+
+        if self.available_features_shrink is not None:
+            result['AvailableFeatures'] = self.available_features_shrink
+
+        if self.client_id is not None:
+            result['ClientId'] = self.client_id
+
+        if self.client_name is not None:
+            result['ClientName'] = self.client_name
+
+        if self.client_os is not None:
+            result['ClientOS'] = self.client_os
+
+        if self.client_type is not None:
+            result['ClientType'] = self.client_type
+
+        if self.client_version is not None:
+            result['ClientVersion'] = self.client_version
+
+        if self.current_stage is not None:
+            result['CurrentStage'] = self.current_stage
+
+        if self.directory_id is not None:
+            result['DirectoryId'] = self.directory_id
+
+        if self.end_user_id is not None:
+            result['EndUserId'] = self.end_user_id
+
+        if self.keep_alive is not None:
+            result['KeepAlive'] = self.keep_alive
+
+        if self.keep_alive_token is not None:
+            result['KeepAliveToken'] = self.keep_alive_token
+
+        if self.new_password is not None:
+            result['NewPassword'] = self.new_password
+
+        if self.office_site_id is not None:
+            result['OfficeSiteId'] = self.office_site_id
+
+        if self.old_password is not None:
+            result['OldPassword'] = self.old_password
+
+        if self.password is not None:
+            result['Password'] = self.password
+
+        if self.region_id is not None:
+            result['RegionId'] = self.region_id
+
+        if self.session_id is not None:
+            result['SessionId'] = self.session_id
+
+        if self.token_code is not None:
+            result['TokenCode'] = self.token_code
+
+        if self.uuid is not None:
+            result['Uuid'] = self.uuid
+
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        if m.get('AuthenticationCode') is not None:
+            self.authentication_code = m.get('AuthenticationCode')
+
+        if m.get('AvailableFeatures') is not None:
+            self.available_features_shrink = m.get('AvailableFeatures')
+
+        if m.get('ClientId') is not None:
+            self.client_id = m.get('ClientId')
+
+        if m.get('ClientName') is not None:
+            self.client_name = m.get('ClientName')
+
+        if m.get('ClientOS') is not None:
+            self.client_os = m.get('ClientOS')
+
+        if m.get('ClientType') is not None:
+            self.client_type = m.get('ClientType')
+
+        if m.get('ClientVersion') is not None:
+            self.client_version = m.get('ClientVersion')
+
+        if m.get('CurrentStage') is not None:
+            self.current_stage = m.get('CurrentStage')
+
+        if m.get('DirectoryId') is not None:
+            self.directory_id = m.get('DirectoryId')
+
+        if m.get('EndUserId') is not None:
+            self.end_user_id = m.get('EndUserId')
+
+        if m.get('KeepAlive') is not None:
+            self.keep_alive = m.get('KeepAlive')
+
+        if m.get('KeepAliveToken') is not None:
+            self.keep_alive_token = m.get('KeepAliveToken')
+
+        if m.get('NewPassword') is not None:
+            self.new_password = m.get('NewPassword')
+
+        if m.get('OfficeSiteId') is not None:
+            self.office_site_id = m.get('OfficeSiteId')
+
+        if m.get('OldPassword') is not None:
+            self.old_password = m.get('OldPassword')
+
+        if m.get('Password') is not None:
+            self.password = m.get('Password')
+
+        if m.get('RegionId') is not None:
+            self.region_id = m.get('RegionId')
+
+        if m.get('SessionId') is not None:
+            self.session_id = m.get('SessionId')
+
+        if m.get('TokenCode') is not None:
+            self.token_code = m.get('TokenCode')
+
+        if m.get('Uuid') is not None:
+            self.uuid = m.get('Uuid')
+
+        return self
+

alibabacloud_ecd20201002/models/_is_keep_alive_request.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+# This file is auto-generated, don't edit it. Thanks.
+from __future__ import annotations
+
+from darabonba.model import DaraModel
+
+class IsKeepAliveRequest(DaraModel):
+    def __init__(
+        self,
+        client_id: str = None,
+        office_site_id: str = None,
+        region_id: str = None,
+    ):
+        # The client ID. The system generates a unique ID for each client.
+        # 
+        # This parameter is required.
+        self.client_id = client_id
+        # The office network ID.
+        self.office_site_id = office_site_id
+        # The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.
+        self.region_id = region_id
+
+    def validate(self):
+        pass
+
+    def to_map(self):
+        result = dict()
+        _map = super().to_map()
+        if _map is not None:
+            result = _map
+        if self.client_id is not None:
+            result['ClientId'] = self.client_id
+
+        if self.office_site_id is not None:
+            result['OfficeSiteId'] = self.office_site_id
+
+        if self.region_id is not None:
+            result['RegionId'] = self.region_id
+
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        if m.get('ClientId') is not None:
+            self.client_id = m.get('ClientId')
+
+        if m.get('OfficeSiteId') is not None:
+            self.office_site_id = m.get('OfficeSiteId')
+
+        if m.get('RegionId') is not None:
+            self.region_id = m.get('RegionId')
+
+        return self
+

alibabacloud_ecd20201002/models/_is_keep_alive_response.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+# This file is auto-generated, don't edit it. Thanks.
+from __future__ import annotations
+
+from typing import Dict
+
+from alibabacloud_ecd20201002 import models as main_models
+from darabonba.model import DaraModel
+
+class IsKeepAliveResponse(DaraModel):
+    def __init__(
+        self,
+        headers: Dict[str, str] = None,
+        status_code: int = None,
+        body: main_models.IsKeepAliveResponseBody = None,
+    ):
+        self.headers = headers
+        self.status_code = status_code
+        self.body = body
+
+    def validate(self):
+        if self.body:
+            self.body.validate()
+
+    def to_map(self):
+        result = dict()
+        _map = super().to_map()
+        if _map is not None:
+            result = _map
+        if self.headers is not None:
+            result['headers'] = self.headers
+
+        if self.status_code is not None:
+            result['statusCode'] = self.status_code
+
+        if self.body is not None:
+            result['body'] = self.body.to_map()
+
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        if m.get('headers') is not None:
+            self.headers = m.get('headers')
+
+        if m.get('statusCode') is not None:
+            self.status_code = m.get('statusCode')
+
+        if m.get('body') is not None:
+            temp_model = main_models.IsKeepAliveResponseBody()
+            self.body = temp_model.from_map(m.get('body'))
+
+        return self
+