本产品（
无影云桌面便捷账号用户管理/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获取当前登录的管理员信息。 |
用户属性
| 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设备。 |