调用GetLoginToken完成用户认证并获取登录凭证-无影云应用-阿里云

通过企业标识符获取登录凭证。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-shanghai
ClientId	string	是	客户端生成的唯一 ID。	05967f80-6f51-46cb-a27c-****
DirectoryId	string	否	办公网络 ID，与`OfficeSiteId`含义相同。建议停止使用`DirectoryId`，改为使用`OfficeSiteId`。`DirectoryId`和`OfficeSiteId`只能填写一个，不可同时填写。	cn-beijing+dir-j9dd****
OfficeSiteId	string	否	办公网络 ID。	cn-beijing+dir-j9dd****
SessionId	string	否	登录的会话 ID。若未绑定虚拟 MFA 设备或者未开启客户端二次认证，则不需要填写 SessionId。若已绑定虚拟 MFA 设备或者已开启客户端二次认证，则 ADPassword 之后的登录认证阶段需要填写 SessionId。可从便捷账号验证（即 GetLoginToken 请求处于 ADPassword 阶段）的返回结果中获取 SessionId。	c6f3cd91-65fc-4c7b-b189-2a73da0****
CurrentStage	string	否	当前登录认证阶段，依次为： `ADPassword`：验证用户信息。当使用便捷账号或者 AD 账号的账密认证时填写此值。 `MFABind`：绑定虚拟 MFA 设备。 `MFAVerify`：验证虚拟 MFA 设备生成的安全码。 `TokenVerify`：客户端二次认证。 `ChangePassword`：修改用户密码。 `KeepAliveVerify`: KeepAliveToken 有效时，可用于换取 LoginToken。 `PhoneVerifyTenantSelect`: 手机号登录场景下，用于选择其中一个企业 ID 登录。 `VerifyForRisk`: 识别登录风险后的核身校验。	SsoTokenLogin
EndUserId	string	否	便捷账号或 AD 域账号的用户名。当`CurrentStage`为`ADPassword`时必填。	user01
Password	string	否	便捷账号或 AD 域账号的密码。当`CurrentStage`为`ADPassword`时必填。	Admin@1234****
EncryptedPassword	string	否	已加密密码。	04d7****8e90bb0484fc;gJ1GLca1vQRRqQbRvByU0A==;5kOWZE7AtbQhki+4LAo69A==
OldPassword	string	否	旧密码。当`CurrentStage`为`ChangePassword`时必填。	Admin@1234****
NewPassword	string	否	新密码。当`CurrentStage`为`ChangePassword`时必填。	Admin@1234****
AuthenticationCode	string	否	虚拟 MFA 设备生成的安全码。当`CurrentStage`为`MFAVerify`时必填。	182901
SsoSessionToken	string	否	SSO 场景下的登录令牌。	04d707a6-fb23-44a7-aae7-8e90****
ClientOS	string	否	客户端操作系统。	windows_\"Windows 10 Pro\" 10.0 (Build 22631)
ClientVersion	string	否	客户端版本。	7.3.0-20240619.143924
TokenCode	string	否	若已在无影云电脑企业版控制台开启客户端二次认证，且识别到当前登录用户有风险时，会发送该二次认证验证码到终端用户邮箱。当`CurrentStage`为`TokenVerify`时必填。	1234***
UmidToken	string	否	幂等校验参数。	04d707a6-fb23-44a7-aae7-8e90bb04****
FingerPrintData	string	否	指纹信息，目前暂时停止支持。	null
KeepAlive	boolean	否	是否保持登录。	true
KeepAliveToken	string	否	用于保持登录的凭证（Token），在登录成功且用户开启了保持登录选项后，接口会返回 KeepAliveToken，在 KeepAliveToken 有效期内可以调用 GetLoginToken 接口并将 CurrentStage 设为 KeepAliveVerify 来换取登录凭证（LoginToken）。当 CurrentStage 为 KeepAliveVerify 时，KeepAliveToken 必填。	00ugamMAoO1+u1MlhmgCeZJ75q094x3H/4kg7ZaTI3f/joVTVPIpJgfv9JFkPLNxnQjblrvsByNas08mc6FtVWvQPOE68fqmt6QMM4UbRtahm8luxEXvicF58qSPXW1hxOtV/Ev6d92VBz2Bck/N4CYyjD0iLocfN8jkBnt231****
Uuid	string	否	客户端唯一标识。若使用无影客户端，可在客户端登录界面的关于对话框中查看该参数。	C50973691A6D2BE23F2CDD73B85B****
ImageUrl	string	否	图片 URL。说明该参数已停用。	null
EncryptedFingerPrintData	string	否	指纹信息。说明该参数已停用。	null
EncryptedKey	string	否	加密的密钥 ID。	4d7****8e90bb0484fc
ClientType	string	否	客户端的类型。	windows
SsoExtendsCookies	string	否	SSO 登录的 Cookie，应用内免登使用。	null
LoginName	string	否	已停用。	null
LoginIdentifier	string	否	企业标识符。	Fe04****
IdpId	string	否	登录认证服务 ID，通过接口 FindIdpListByLoginIdentifier 获取。	idp-iwntrlbb98q7v****
NetworkType	string	否	客户端的网络连接类型。枚举值： INTERNET : 互联网 VPC : 企业专网	INTERNET
Phone	string	否	手机号码，手机号登录场景下使用。说明国际站账号不支持。	1822727****
PhoneVerifyCode	string	否	手机验证码，手机号登录场景下使用。说明国际站账号不支持。	321123
AvailableFeatures	object	否	客户端支持的特性。
	string	否	客户端支持的特性。枚举值： Business : 支持商业版	{\"Business\":\"1\"}
MfaType	string	否	MFA 校验的类型。枚举值： TOTP : 手机令牌 PHONE : 手机验证码 EMAIL : 邮箱	TOTP
ClientName	string	否	客户端名称。	HONOR-BRN-HXXB
ProfileRegion	string	否	租户所属站点。枚举值： ap_southeast_1 : 国际站 cn_hangzhou : 中国站	cn_hangzhou
Channel	string	否
AreaSite	string	否

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
Email	string	用户邮箱。在登录后随 LoginToken 返回。如果是便捷账号，返回创建便捷账号时设置的邮箱。如果是 AD 域账号，返回以下形式：用户名@AD 域名。	alice***@example.com
Secret	string	绑定虚拟 MFA 设备时的密钥。用于`MFABind`阶段。说明关于各认证阶段的详细信息，参见本接口请求参数`CurrentStage`的参数说明。	4JZNSDHDM3T6AZ4G2O5OWXBLLE4P****
RequestId	string	请求 ID。	EEA72491-B731-53D6-83ED-209769D6****
EndUserId	string	便捷账号用户名或 AD 用户名。	alice
LoginToken	string	登录凭证。	v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****
NextStage	string	预期的下一阶段。例如，若管理员在无影云电脑企业版控制台开启了 MFA 认证，则当用户名密码认证通过后（即`ADPassword`阶段后），该参数会返回`MFAVerify`，表示此时需要做 MFA 认证。说明关于各认证阶段的详细信息，参见本接口请求参数`CurrentStage`的参数说明。	MFABind
QrCodePng	string	绑定虚拟 MFA 设备时的密钥二维码。使用 Base64 编码。可以为空，用于`MFABind`阶段。说明关于各认证阶段的详细信息，参见本接口请求参数`CurrentStage`的参数说明。	5OCLLKKOJU5HPBX66H3QCTWY******
Label	string	便捷账号属性。如果是 AD 域账号，则返回空值。	test:wuying
SessionId	string	会话 ID。仅在同一会话第一次调用 GetLoginToken 时返回。需要多次认证时，后续的阶段需要传入该参数。	cc15c91c-821b-4edd-9af2-6df66cc****
Phone	string	便捷账号的手机号。如果是 AD 域账号，则返回空值。	1826717****
TenantId	integer	阿里云账号 ID。硬件终端识别使用。	13747924304****
KeepAliveToken	string	用于保持登录的凭证（Token），在登录成功且用户开启了保持登录选项后，接口会返回`KeepAliveToken`。若未开启保持登录选项，则返回空值。	006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIp***
Industry	string	说明该参数不对外开放使用。	edu
Props	object	说明该参数不对外开放使用。
	string	说明该参数不对外开放使用。	{'environment': 'online', 'sourceClientType': 'WINDOWS
WyId	string	用户全局唯一 ID。	0aba1403b337a***
VpcRegionId	string	VPC 地域 ID，用于专网登录。	cn-beijing
WindowDisplayMode	string	说明该参数不对外开放使用。	Windowed
AccountType	string	账号类型，便捷账号或者 AD 域账号。	ad
TenantInfos	array<object>	企业 ID 信息，在手机号登录场景下，一个手机号可能开通了多个企业 ID 的登录能力，此时需要传入 CurrentState:PhoneVerifyTenantSelect 选择其中一个企业 ID 进行登录。
	object	企业 ID 信息。
TenantAlias	string	企业 ID。	Up830***
AccessType	string	客户端的网络连接类型。枚举值： INTERNET : 互联网 VPC : 企业专网 ANY : 都允许	INTERNET
TenantAlias	string	登录的企业标识符名称。	Rq201***
AccessType	string	客户端的网络连接类型。	INTERNET
OfficeSites	array	AD 登录后，该 AD 对应的办公网络信息。
	string	AD 登录后，该 AD 对应的办公网络 ID。	['cn-beijing+dir-096920*', 'cn-shenzhen+dir-2546908*']
IdpId	string	用户所属身份源配置 ID。	idp-7ttvs4ove8bo5***
AdDomain	string	AD 办公网络地址。	easthp***.com
RiskVerifyInfo	object	登录风险识别相关信息，如检测到风险，需要通过返回的邮箱或者手机号进行核身。通过返回的手机号或邮箱，调用`SendVerifyCode`接口发送验证码，然后调用`GetLoginToken`接口指定`CurrentStage`参数为`VerifyForRisk`进行核身。
Email	string	用于身份验证的邮箱地址。	ppas***@aliyun.com
LastLockDuration	integer	锁定时间。单位：秒。	12000
Locked	boolean	用户是否被锁定。	true
Phone	string	用于核身的手机号。	138****1111
PasswordStrategy	object	密码策略。
TenantPasswordLength	integer	要求的密码长度。	12
TenantAlternativeChars	array	要求的密码内容。
	string	要求的密码内容。枚举值： NUMBER : 数字 SPECIAL_CHAR : 特殊字符 LOWER_LETTER : 小写字母 UPPER_LETTER : 大写字母	UPPER_LETTER
Reason	string	登录失败的原因。枚举值： ResetPassword : 密码已重置 PasswordExpired : 需要修改密码	PasswordExpired
MfaTypeList	array<object>	触发 MFA 校验时，可选的 MFA 校验类型。
	object
Name	string	MFA 校验类型。枚举值： TOTP : 手机令牌 PHONE : 手机验证码 EMAIL : 邮箱	PHONE
Stage	string	选定 MFA 类型后，对应 CurrentStage 参数的值。枚举值： MFAVerifyV1 : 执行 MFA 校验 MFABindV1 : 绑定 MFA 设备	MFABindV1
NickName	string

示例

正常返回示例

JSON格式

{
  "Email": "alice***@example.com",
  "Secret": "4JZNSDHDM3T6AZ4G2O5OWXBLLE4P****",
  "RequestId": "EEA72491-B731-53D6-83ED-209769D6****",
  "EndUserId": "alice",
  "LoginToken": "v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****",
  "NextStage": "MFABind",
  "QrCodePng": "5OCLLKKOJU5HPBX66H3QCTWY******\n",
  "Label": "test:wuying\n",
  "SessionId": "cc15c91c-821b-4edd-9af2-6df66cc****",
  "Phone": "1826717****",
  "TenantId": 0,
  "KeepAliveToken": "006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIp***",
  "Industry": "edu",
  "Props": {
    "key": "{'environment': 'online', 'sourceClientType': 'WINDOWS"
  },
  "WyId": "0aba1403b337a***",
  "VpcRegionId": "cn-beijing",
  "WindowDisplayMode": "Windowed",
  "AccountType": "ad",
  "TenantInfos": [
    {
      "TenantAlias": "Up830***",
      "AccessType": "INTERNET"
    }
  ],
  "TenantAlias": "Rq201***",
  "AccessType": "INTERNET",
  "OfficeSites": [
    "['cn-beijing+dir-096920***', 'cn-shenzhen+dir-2546908***']"
  ],
  "IdpId": "idp-7ttvs4ove8bo5***",
  "AdDomain": "easthp***.com",
  "RiskVerifyInfo": {
    "Email": "ppas***@aliyun.com",
    "LastLockDuration": 12000,
    "Locked": true,
    "Phone": "138****1111"
  },
  "PasswordStrategy": {
    "TenantPasswordLength": 12,
    "TenantAlternativeChars": [
      "UPPER_LETTER"
    ]
  },
  "Reason": "PasswordExpired",
  "MfaTypeList": [
    {
      "Name": "PHONE",
      "Stage": "MFABindV1"
    }
  ],
  "NickName": ""
}

错误码

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

变更历史

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