获取登录凭证。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
ClientId | string | 是 | 客户端生成的唯一 ID。 | f4a0dc8e-1702-4728-9a60-95b27a35**** |
DirectoryId | string | 否 | 办公网络 ID,与 | cn-hangzhou+dir-885351**** |
OfficeSiteId | string | 是 | 办公网络 ID。 | cn-hangzhou+dir-885351**** |
SessionId | string | 否 | 登录的会话 ID。
| cd45e873-650d-4d70-acb9-f996187a**** |
CurrentStage | string | 否 | 当前登录认证阶段,依次为:
| ADPassword |
EndUserId | string | 否 | 便捷用户或 AD 用户的用户名。当 | alice |
Password | string | 否 | 便捷用户或 AD 用户的密码。当 | Password1234 |
OldPassword | string | 否 | 旧密码。当 | OldPassword |
NewPassword | string | 否 | 新密码。当 | NewPassword |
AuthenticationCode | string | 否 | 虚拟 MFA 设备生成的安全码。当 | 47**** |
ClientOS | string | 否 | 运行客户端的设备的操作系统。 | Windows_NT 10.0.18363 x64 |
ClientVersion | string | 否 | 客户端版本。若使用无影客户端,可在客户端登录界面的关于对话框中查看该参数。 | 2.1.0-R-20210731.151756 |
TokenCode | string | 否 | 若已在无影云电脑控制台开启客户端二次认证,且识别到当前登录用户有风险时,会发送该二次认证验证码到终端用户邮箱。当 | 63**** |
KeepAlive | boolean | 否 | 是否保持登录。 枚举值:
| false |
KeepAliveToken | string | 否 | 用于保持登录的凭证(Token),在登录成功且用户开启了保持登录选项后,接口会返回 | hide |
Uuid | string | 否 | 客户端唯一标识。若使用无影客户端,可在客户端登录界面的关于对话框中查看该参数。 | C78CA9E99315687575DD2844C1F3**** |
ClientType | string | 否 | 无影软件客户端类型。 枚举值:
| WINDOWS |
返回参数
示例
正常返回示例
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"
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2024-06-04 | OpenAPI 返回结构发生变更 | 看变更集 | ||||||
| ||||||||
2024-04-23 | OpenAPI 入参发生变更 | 看变更集 | ||||||
| ||||||||
2024-04-10 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||
|