文档

API概览

更新时间:
本产品(无影云桌面便捷账号用户管理/2021-03-08)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

用户

API标题API概述
CreateUsers创建便捷账号为终端用户创建便捷账号。
RemoveUsers删除便捷账号删除一个或者多个便捷账号。
ModifyUser修改便捷账号的联系方式修改便捷账号的联系方式。
ResetUserPassword重置便捷账号的密码重置便捷账号的密码,包括生成重置密码Token,并发送重置密码邮件到便捷账号的邮箱。
LockUsers锁定便捷账号锁定一个或者多个便捷账号。锁定后的便捷账号无法登录无影终端。
UnlockUsers解锁便捷账号解锁一个或者多个便捷账号。解锁后的便捷账号可以登录无影终端。
DescribeUsers查询便捷账号信息查询便捷账号信息,例如用户名、邮箱地址、备注名称等。
FilterUsers筛选查询便捷账号信息按用户属性筛选查询便捷账号信息。
GetManagerInfoByAuthCode根据authcode获取当前登录的管理员信息根据authcode获取当前登录的管理员信息。
BatchSetDesktopManager为用户添加或去除本地管理员权限为便捷用户账号添加或者去除云电脑的本地管理员权限。

用户属性

API标题API概述
CreateProperty创建用户自定义属性创建一个用户属性。
RemoveProperty删除用户自定义属性删除一组用户属性。
DeleteUserPropertyValue为用户移除自定义属性解除一个用户与某个用户属性的绑定关系。
UpdateProperty修改自定义属性修改用户属性。
SetUserPropertyValue为用户设置自定义属性为某个用户关联一个用户属性。
ListProperty查询属性查询当前账号下已有的用户属性列表。
ListPropertyValue查询用户自定义属性值查询某一用户属性包含的属性值列表。
CheckUsedProperty查询关联指定属性的用户数查询关联了指定自定义属性的便捷账号的数量。
CheckUsedPropertyValue查询关联指定属性值的用户数查询关联了指定自定义属性值的便捷账号的数量。

组织

API标题API概述
DescribeOrgs查询组织列表查询组织列表。

MFA设备

API标题API概述
RemoveMfaDevice删除便捷账号绑定的虚拟MFA设备删除便捷账号绑定的虚拟MFA设备。
LockMfaDevice锁定虚拟MFA设备锁定便捷账号绑定的虚拟MFA设备。
UnlockMfaDevice解锁虚拟MFA设备解锁便捷账号绑定的虚拟MFA设备。
DescribeMfaDevices查询便捷账号绑定的虚拟MFA设备查询便捷账号绑定的虚拟MFA设备。