AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页 无影云电脑企业版 开发参考 API参考（客户端） API目录 用户登录 GetLoginToken - 获取登录凭证

GetLoginToken - 获取登录凭证

更新时间：
复制为 MD 格式
产品详情
我的收藏

获取登录凭证。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
ClientId

string

是

客户端生成的唯一 ID。

f4a0dc8e-1702-4728-9a60-95b27a35****
DirectoryId

string

否

办公网络 ID，与OfficeSiteId含义相同。建议停止使用DirectoryId，改为使用OfficeSiteId。DirectoryId和OfficeSiteId只能填写一个，不可同时填写。

cn-hangzhou+dir-885351****
OfficeSiteId

string

否

办公网络 ID。

cn-hangzhou+dir-885351****
SessionId

string

否

登录的会话 ID。

  • 若未绑定虚拟 MFA 设备或者未开启客户端二次认证，则不需要填写SessionId。

  • 若已绑定虚拟 MFA 设备或者已开启客户端二次认证，则ADPassword之后的登录认证阶段需要填写SessionId。可从便捷账号验证（即GetLoginToken请求处于ADPassword阶段）的返回结果中获取SessionId。

cd45e873-650d-4d70-acb9-f996187a****
CurrentStage

string

否

当前登录认证阶段，依次为：

  • ADPassword：验证用户信息。当使用便捷账号或者 AD 账号的账密认证时填写此值。

  • MFABind：绑定虚拟 MFA 设备。

  • MFAVerify：验证虚拟 MFA 设备生成的安全码。

  • TokenVerify：客户端二次认证。

  • ChangePassword：修改用户密码。

  • KeepAliveVerify: KeepAliveToken 有效时，可用于换取 LoginToken。

ADPassword
EndUserId

string

否

便捷用户或 AD 用户的用户名。当CurrentStage为ADPassword时必填。

alice
Password

string

否

便捷用户或 AD 用户的密码。当CurrentStage为ADPassword时必填。

Password1234
OldPassword

string

否

旧密码。当CurrentStage为ChangePassword时必填。

OldPassword
NewPassword

string

否

新密码。当CurrentStage为ChangePassword时必填。

NewPassword
AuthenticationCode

string

否

虚拟 MFA 设备生成的安全码。当CurrentStage为MFAVerify时必填。

47****
ClientOS

string

否

运行客户端的设备的操作系统。

Windows_NT 10.0.18363 x64
ClientVersion

string

否

客户端版本。若使用无影客户端，可在客户端登录界面的关于对话框中查看该参数。

2.1.0-R-20210731.151756
TokenCode

string

否

若已在无影云电脑控制台开启客户端二次认证，且识别到当前登录用户有风险时，会发送该二次认证验证码到终端用户邮箱。当CurrentStage为TokenVerify时必填。

63****
KeepAlive

boolean

否

是否保持登录。

枚举值：

  • null :

    不保持登录 [默认值]

  • true :

    保持登录

  • false :

    不保持登录

false
KeepAliveToken

string

否

用于保持登录的凭证（Token），在登录成功且用户开启了保持登录选项后，接口会返回KeepAliveToken，在KeepAliveToken有效期内可以调用GetLoginToken接口并将CurrentStage设为KeepAliveVerify来换取登录凭证（LoginToken）。当CurrentStage为KeepAliveVerify时，KeepAliveToken必填。

hide
Uuid

string

否

客户端唯一标识。若使用无影客户端，可在客户端登录界面的关于对话框中查看该参数。

C78CA9E99315687575DD2844C1F3****
ClientType

string

否

无影软件客户端类型。

枚举值：

  • HTML5 :

    Web 客户端

  • WINDOWS :

    Windows 客户端

  • MACOS :

    macOS 客户端

  • IOS :

    iOS 客户端

  • ANDROID :

    Android 客户端

WINDOWS
AvailableFeatures

object

否

string

否

ClientName

string

否

返回参数

名称

类型

描述

示例值

object

返回信息集合。

Email

string

用户邮箱。在登录后随 LoginToken 返回。

  • 如果是便捷用户，返回创建便捷用户时设置的邮箱。

  • 如果是 AD 用户，返回以下形式：用户名@AD 域名。

alice
Secret

string

绑定虚拟 MFA 设备时的密钥。用于MFABind阶段。

说明

关于各认证阶段的详细信息，参见本接口请求参数CurrentStage的参数说明。

5OCLLKKOJU5HPBX66H3QCTWYI7MH****
RequestId

string

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
EndUserId

string

便捷账号用户名或 AD 用户名。

alice
LoginToken

string

登录凭证。

v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
NextStage

string

预期的下一阶段。例如，若管理员在无影云电脑控制台开启了 MFA 认证，则当用户名密码认证通过后（即ADPassword阶段后），该参数会返回MFAVerify，表示此时需要做 MFA 认证。

说明

关于各认证阶段的详细信息，参见本接口请求参数CurrentStage的参数说明。

MFAVerify
QrCodePng

string

绑定虚拟 MFA 设备时的密钥二维码。使用 Base64 编码。可以为空，用于MFABind阶段。

说明

关于各认证阶段的详细信息，参见本接口请求参数CurrentStage的参数说明。

5OCLLKKOJU5HPBX66H3QCTWY******
Label

string

便捷用户属性。如果是 AD 用户，则返回空值。

test:wuying
SessionId

string

会话 ID。 仅在同一会话第一次调用GetLoginToken时返回。需要多次认证时，后续的阶段需要传入该参数。

说明

关于各认证阶段的详细信息，参见本接口请求参数CurrentStage的参数说明。

d6ec166d-ab93-4286-bf7f-a18bb929****
Phone

string

便捷用户的手机号。如果是 AD 用户，则返回空值。

1381111****
TenantId

integer

阿里云账号 ID。硬件终端识别使用。

166353906220****
KeepAliveToken

string

用于保持登录的凭证（Token），在登录成功且用户开启了保持登录选项后，接口会返回KeepAliveToken。若未开启保持登录选项，则返回空值。

006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW
Industry

string
说明

内部专用字段，不对外开放使用。

edu
Props

object
说明

内部专用字段，不对外开放使用。

string
说明

内部专用字段，不对外开放使用。

{'dingUserName': u'\u674e\u66fc', 'role': 'student'}
WindowDisplayMode

string
说明

内部专用字段，不对外开放使用。

mode
RiskVerifyInfo

object

登录风险识别相关信息。

Email

string

触发核身时，通过该邮箱进行验证。

user@example.com
LastLockDuration

integer

账号锁定时间。

1713749778
Locked

string

账号是否已锁定。

枚举值：

  • true :

    是

  • false :

    否

true
Phone

string

触发核身时，通过该手机号进行验证。

1381111****
Reason

string
说明

内部专用字段，不对外开放使用。

null
PasswordStrategy

object
说明

内部专用字段，不对外开放使用。

TenantPasswordLength

string
说明

内部专用字段，不对外开放使用。

null
TenantAlternativeChars

array
说明

内部专用字段，不对外开放使用。

string
说明

内部专用字段，不对外开放使用。

null
NickName

string

WyId

string

示例

正常返回示例

JSON格式

{
  "Email": "alice",
  "Secret": "5OCLLKKOJU5HPBX66H3QCTWYI7MH****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "EndUserId": "alice",
  "LoginToken": "v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****",
  "NextStage": "MFAVerify",
  "QrCodePng": "5OCLLKKOJU5HPBX66H3QCTWY******",
  "Label": "test:wuying",
  "SessionId": "d6ec166d-ab93-4286-bf7f-a18bb929****",
  "Phone": "1381111****",
  "TenantId": 0,
  "KeepAliveToken": "006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW",
  "Industry": "edu",
  "Props": {
    "key": "{'dingUserName': u'\\u674e\\u66fc', 'role': 'student'}"
  },
  "WindowDisplayMode": "mode",
  "RiskVerifyInfo": {
    "Email": "user@example.com",
    "LastLockDuration": 1713749778,
    "Locked": "true",
    "Phone": "1381111****"
  },
  "Reason": "null",
  "PasswordStrategy": {
    "TenantPasswordLength": "null",
    "TenantAlternativeChars": [
      "null"
    ]
  },
  "NickName": "",
  "WyId": ""
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：用户登录下一篇：RefreshLoginToken - 刷新登录凭证