API概览

更新时间:
复制为 MD 格式

API标准及多语言预置SDK

本产品(eds-user/2021-03-08)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 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概述

CreateOrg 创建组织 创建组织。
DescribeOrgs 查询组织列表 查询组织列表。
DescribeOrgByLayer 指定父组织查找下级组织 查找下级组织。
RemoveOrg 移除组织 移除组织。
MoveOrg 移动组织 移动组织。
ModifyOrg 修改组织 修改组织。
MoveUserOrg 移动用户到目标组织架构 移动用户到目标组织架构。

用户组

API

标题

API概述

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

资源组

API

标题

API概述

CreateResourceGroup 创建无影资源组 创建资源组。
DeleteResourceGroup 删除无影资源组 删除资源组。
DescribeResourceGroups 查看资源组信息 查看资源组。