有关 EnOS 应用门户 API¶
EnOS 应用门户是基于 EnOS 的统一权限管理门户与应用访问门户。你可以借助应用门户服务提供的 OPEN API 获取到用户、资产、应用等相关信息用于应用开发或权限管理。
有关应用门户的详细信息，参见 有关 EnOS 应用门户。
有关 EnOS API 的详细信息，参见 有关 EnOS API。
有关如何调用 EnOS API，参见 EnOS API 快速入门。
API¶
身份认证¶
| 操作名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
|---|---|---|---|
| Confirm Password | 确认已登陆用户的密码 | √ | × |
| Get Token Information | 获取 Access Token 所对应的当前登录用户的相关信息 | √ | √ |
| Log In | 登录账号 | √ | √ |
| Log In Via Authorization Code | 通过单点登录（SSO）的授权码登录 | √ | × |
| Log Out | 登出账号 | √ | √ |
| Refresh Access Token | 使用 Refresh Token 请求一个新的 Access Token | √ | √ |
| Revoke Refresh Token | 撤销用户所有的 Refresh Token | √ | √ |
用户与组织¶
| 操作名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
|---|---|---|---|
| Choose Organization | 用户在登录后选择需要进入使用的组织 | √ | √ |
| Create and Join User | 不登录 EnOS 应用门户的状态下创建用户并为该用户分配组织 | √ | × |
| Create Organization Structure | 创建组织结构节点 | √ | × |
| Delete Organization Structure | 删除组织结构节点 | √ | × |
| Join Users | 不登录 EnOS 应用门户的状态下把一批用户添加进组织 | √ | × |
| Get Manageable User List | 获取当前账号权限下可管理的所有用户列表 | √ | √ |
| Get Organization List | 根据 Access Token 列出当前用户所在的组织列表 | √ | √ |
| Get Organization Language List | 获取指定组织下可使用语言的列表 | √ | √ |
| Get Organization User List | 不登录 EnOS 应用门户的状态下授权应用获取指定组织下所有用户列表 | √ | √ |
| Get Organization Roles | 获取组织内所有角色 | √ | √ |
| Get App User List | 根据应用的 accessKey 获得当前用户权限范围内对该应用可见的用户列表信息 |
√ | √ |
| Get Organization User Group List | 获取 OU 内所有用户组 | √ | × |
| Get Structure by App | 获取应用下挂载的组织结构根节点 | √ | × |
| Get Structure by Detail | 获取应用下挂载的完整组织结构节点 | √ | × |
| Get Structure by User | 获取用户有权查看的组织结构 | √ | × |
| Get Users by User Group | 获取用户组的用户列表 | √ | × |
| Get User Information | 获取当前用户的信息 | √ | √ |
| Get User Domain | 通过用户邮箱地址获取用户所在的域信息 | √ | √ |
| Get User Structures | 获取用户所分配的组织结构节点 | √ | √ |
| Get User Roles | 获取用户被分配的角色 | √ | √ |
| Get User Permissions | 获取用户在当前应用下授权的权限点 | √ | × |
| Get User Base Info | 根据用户邮箱、账号和域、或电话号码和电话区号获取用户的基本信息如用户 ID 等 | √ | × |
| Get Users Asset List | 不登录 EnOS 应用门户的状态下获取一批用户的资产权限 | √ | × |
| Get Users Role List | 不登录 EnOS 应用门户的状态下获取一批用户的角色 | √ | × |
| Get Users Structure List | 不登录 EnOS 应用门户的状态下获取一批用户的组织结构 | √ | × |
| Get Users UserGroup List | 不登录 EnOS 应用门户的状态下获取一批用户的用户组 | √ | × |
| Assign Organization Structures | 不登录 EnOS 应用门户的状态下给用户分配组织结构 | √ | × |
| Assign Assets to Organization Structure | 将资产挂载到组织结构节点 | √ | √ |
| Assign User Roles | 不登录 EnOS 应用门户的状态下给用户分配角色 | √ | × |
| Assign User Groups | 不登录 EnOS 应用门户的状态下给用户分配用户组 | √ | × |
| Query Audit Logs | 查询审计日志记录 | √ | × |
| Query Menu Access Logs | 查询用户的访问菜单操作 | √ | × |
| Remove Organization Structures | 不登录 EnOS 应用门户的状态下给用户移除组织结构 | √ | × |
| Remove User Roles | 不登录 EnOS 应用门户的状态下给用户移除角色 | √ | × |
| Remove User Groups | 不登录 EnOS 应用门户的状态下给用户移除用户组 | √ | × |
| Remove User | 不登录 EnOS 应用门户的状态下把一个用户移出一个组织 | √ | × |
| Update Organization Structure | 修改组织结构节点 | √ | × |
| Update User Information | 更新用户信息 | √ | × |
资产¶
| 操作名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
|---|---|---|---|
| Authorize Asset | 将在 EnOS 上新建的资产授权给创建人 | √ | √ |
| Check Asset Permission | 查看是否有资产的权限 | √ | √ |
| Get Assets by Application | 获取当前用户在某个应用下有权限的所有资产 | √ | √ |
| Get Assets by Organization | 获取指定用户在指定组织下有权限的所有资产 | √ | √ |
| Get Asset Structure | 获取资产所在的组织结构的上游组织结构 | √ | √ |
| Get Structure Asset | 获取用户在组织结构上的资产 | √ | √ |
| Sync Asset | 将在 EnOS 上标有指定标签的资产同步到 EnOS 应用门户 | √ | √ |
| Get Users with Asset Access | 获取对某一资产有权限的用户列表 | √ | √ |
应用¶
| 操作名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
|---|---|---|---|
| Create Message | 创建 EnOS 应用门户上的普通提示消息与告警消息 | √ | √ |
| Create Message Rules | 创建消息规则 | √ | × |
| Delete Message Rules | 删除消息规则 | √ | × |
| Get App Menu and Permission | 获取应用的权限点及菜单列表 | √ | √ |
| Get App Resources by User and Organization | 获取应用的权限点及菜单列表 | √ | × |
| Get Colors of the Message Icon | 获取消息图标可选择配置的颜色集合 | √ | √ |
| Get Message Ringtones | 获取消息可选择配置的提示声集合 | √ | √ |
| Get User’s Applications | 通过 Access Token 获取当前用户有权限的应用的列表 | √ | √ |
| Get Unresolved Messages | 获取未确认的应用消息列表 | √ | √ |
| Search Message Rules | 查询消息规则 | √ | × |
| Update Message Rules | 修改消息规则 | √ | × |
| Update Messages | 更新消息状态 | √ | √ |
通用错误码¶
| 代码 | 错误信息 | 描述 |
|---|---|---|
| 0 | 成功 | |
| 31400 | parameter.invalid.[参数名] | 参数不合法 |
| 31401 | unauthenticated | 用户未登录 |
| 31403 | permission.denied | 无权访问或无权操作 |
| 31404 | [主体名].not.exist | 用户不存在 |
| 31408 | [主体名].already.existed | 用户已存在 |
| 31409 | [主体名] | 账号在另一地点登录 |
| 31410 | [主体名].expired | [主体标识/值]失效 |
| 31415 | [].out.range | 参数值超出实际取值范围 |
| 31429 | [操作名.主体名].exhausted | 操作过于频繁，超过限制次数 |
| 31500 | system.internal.error | 系统错误 |
| 31504 | timeout | 服务超时 |
| 31512 | organization unselected | 用户未选择组织 |
| 31401 | Please login first | 请先登录 EnOS 应用门户 |
| 31403 | This API can be requested through EnOS APIM only | 此 API 只能通过 EnOS APIM 调用 |