调用GetLoginToken获取登录凭证。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetLoginToken |
系统规定参数。取值:GetLoginToken。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。可以调用DescribeRegions获取无影云桌面支持的地域列表。 |
ClientId | String | 是 | f4a0dc8e-1702-4728-9a60-95b27a35**** |
客户端生成的唯一ID。 |
DirectoryId | String | 否 | cn-hangzhou+dir-885351**** |
工作区ID,与 |
OfficeSiteId | String | 是 | cn-hangzhou+dir-885351**** |
工作区ID。 |
SessionId | String | 否 | cd45e873-650d-4d70-acb9-f996187a**** |
登录的会话ID。
|
CurrentStage | String | 否 | ADPassword |
当前登录认证阶段,依次为:
|
EndUserId | String | 否 | alice |
便捷用户或AD用户的用户名。当 |
Password | String | 否 | Password1234 |
便捷用户或AD用户的密码。当 |
OldPassword | String | 否 | OldPassword |
旧密码。当 |
NewPassword | String | 否 | NewPassword |
新密码。当 |
AuthenticationCode | String | 否 | 47**** |
虚拟MFA设备生成的安全码。当 |
ClientOS | String | 否 | Windows_NT 10.0.18363 x64 |
客户端运行的操作系统。 |
ClientVersion | String | 否 | 2.1.0-R-20210731.151756 |
客户端版本。若使用无影客户端,可在客户端登录界面的关于对话框中查看该参数。 |
TokenCode | String | 否 | 63**** |
若已在无影云桌面控制台开启客户端二次认证,且识别到当前登录用户有风险时,会发送该二次认证验证码到终端用户邮箱。当 |
KeepAlive | Boolean | 否 | false |
是否保持登录。 |
KeepAliveToken | String | 否 | hide |
用于保持登录的凭证(Token),在登录成功且用户开启了保持登录选项后,接口会返回 |
Uuid | String | 否 | C78CA9E99315687575DD2844C1F3**** |
客户端唯一标识。若使用无影客户端,可在客户端登录界面的关于对话框中查看该参数。 |
ClientType | String | 否 | WINDOWS |
无影客户端类型。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
String | alice |
用户邮箱。在登录后随LoginToken返回。
|
|
Secret | String | 5OCLLKKOJU5HPBX66H3QCTWYI7MH**** |
绑定虚拟MFA设备时的密钥。用于 说明 关于各认证阶段的详细信息,参见本接口请求参数
CurrentStage 的参数说明。
|
RequestId | String | 1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
请求ID。 |
EndUserId | String | alice |
便捷账号用户名或AD用户名。 |
LoginToken | String | v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b**** |
登录凭证。 |
NextStage | String | MFAVerify |
预期的下一阶段。例如,若管理员在无影云桌面控制台开启了MFA认证,则当用户名密码认证通过后(即 说明 关于各认证阶段的详细信息,参见本接口请求参数
CurrentStage 的参数说明。
|
QrCodePng | String | 5OCLLKKOJU5HPBX66H3QCTWY****** |
绑定虚拟MFA设备时的密钥二维码。使用Base64编码。可以为空,用于 说明 关于各认证阶段的详细信息,参见本接口请求参数
CurrentStage 的参数说明。
|
Label | String | test:wuying |
便捷用户属性。如果是AD用户,则返回空值。 |
SessionId | String | d6ec166d-ab93-4286-bf7f-a18bb929**** |
会话ID。 仅在同一会话第一次调用 说明 关于各认证阶段的详细信息,参见本接口请求参数
CurrentStage 的参数说明。
|
Phone | String | 1381111**** |
便捷用户的手机号。如果是AD用户,则返回空值。 |
TenantId | Long | 166353906220**** |
阿里云账号ID。硬件终端识别使用。 |
KeepAliveToken | String | 006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW |
用于保持登录的凭证(Token),在登录成功且用户开启了保持登录选项后,接口会返回 |
Industry | String | edu |
说明 内部专用字段,不对外开放使用。
|
Props | Map |
说明 内部专用字段,不对外开放使用。
|
|
String | {'dingUserName': u'\u674e\u66fc', 'role': 'student'} |
说明 内部专用字段,不对外开放使用。
|
|
WindowDisplayMode | String | mode |
内部字段,不对外开放使用。 |
示例
请求示例
https://ecd.cn-hangzhou.aliyuncs.com/?Action=GetLoginToken
&RegionId=cn-hangzhou
&ClientId=f4a0dc8e-1702-4728-9a60-95b27a35****
&DirectoryId=cn-hangzhou+dir-885351****
&OfficeSiteId=cn-hangzhou+dir-885351****
&SessionId=cd45e873-650d-4d70-acb9-f996187a****
&CurrentStage=ADPassword
&EndUserId=alice
&Password=Password1234
&OldPassword=OldPassword
&NewPassword=NewPassword
&AuthenticationCode=47****
&ClientOS=Windows_NT 10.0.18363 x64
&ClientVersion=2.1.0-R-20210731.151756
&TokenCode=63****
&KeepAlive=false
&KeepAliveToken=hide
&Uuid=C78CA9E99315687575DD2844C1F3****
&ClientType=WINDOWS
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetLoginTokenResponse>
<Email>alice</Email>
<Secret>5OCLLKKOJU5HPBX66H3QCTWYI7MH****</Secret>
<RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5F****</RequestId>
<EndUserId>alice</EndUserId>
<LoginToken>v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****</LoginToken>
<NextStage>MFAVerify</NextStage>
<QrCodePng>5OCLLKKOJU5HPBX66H3QCTWY******</QrCodePng>
<Label>test:wuying</Label>
<SessionId>d6ec166d-ab93-4286-bf7f-a18bb929****</SessionId>
<Phone>1381111****</Phone>
<KeepAliveToken>006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW</KeepAliveToken>
<Industry>edu</Industry>
<Props>
<key>{'dingUserName': u'\u674e\u66fc', 'role': 'student'}</key>
</Props>
</GetLoginTokenResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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****",
"KeepAliveToken" : "006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW",
"Industry" : "edu",
"Props" : {
"key" : "{'dingUserName': u'\\u674e\\u66fc', 'role': 'student'}"
}
}