API概览

更新时间:
复制为 MD 格式

API标准及多语言预置SDK

本产品(无影便捷账号管理/2021-03-08)的 OpenAPI 采用 RPC 签名机制,具体签名方式请参见签名机制说明我们已为开发者封装了主流编程语言的 SDK,您可通过 下载 SDK 快速调用 API,无需关注签名等底层实现细节,显著降低开发门槛与集成复杂度。

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

登录

API标题API概述
InitTenantAlias初始化组织ID初始化组织ID。

用户

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概述
CreateOrg创建组织创建组织。
DescribeOrgs查询组织列表查询组织列表。
DescribeOrgByLayer指定父组织查找下级组织查找下级组织。
RemoveOrg移除组织移除组织。
MoveOrg移动组织移动组织。
ModifyOrg修改组织修改组织。
MoveUserOrg移动用户到目标组织架构移动用户到目标组织架构。

用户组

API标题API概述
CreateGroup创建用户组创建用户组。
DescribeGroups查询用户组查询用户组。
UserBatchQuitGroup用户组批量移除用户批量移除用户组中的用户。
UserBatchJoinGroup用户组批量添加用户为用户组批量添加用户。
RemoveGroup删除用户组删除用户组。支持批量操作。
ModifyGroup修改用户组修改用户组的名称和描述。
DescribeGroupUser查询用户组成员查询用户组成员。

MFA设备

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

资源组

API标题API概述
CreateResourceGroup创建无影资源组创建资源组。
DeleteResourceGroup删除无影资源组删除资源组。
DescribeResourceGroups查看资源组信息查看资源组。