观远数据开放平台
返回最新版
返回最新版
当前版本V7.1.0
  1. 用户管理
  • 开发指南
    • Token 鉴权
    • 常见概念
    • 常见问题
  • 数据集
    • 使用parquet文件更新数据集
      GET
    • 获取数据集列表
      POST
    • 修改数据集路径
      POST
    • 数据集删除
      POST
    • 搜索数据集列表
      POST
    • 查询特定数据集的数据结构
      POST
    • 批量修改数据集更新方式
      POST
    • 获取指定数据集有使用权限的用户列表
      POST
    • 上传数据集
      POST
    • 获取数据集下载授权Token
      GET
    • 下载数据集数据
      POST
    • 获取数据集数据
      POST
    • 创建数据集
      POST
    • 更新数据集字段注释
      POST
    • 触发数据集读取数据文件并更新
      GET
    • 通过 TaskID 查询数据集更新结果
      GET
    • 修改数据集schema
      POST
    • 更新数据集
      POST
    • 修改数据集字段别名
      POST
    • 修改数据集名称
      POST
    • 数据集预览接口
      POST
    • 提供修改SQL模型结构接口
      POST
    • 获取数据集目录列表的接口,支持指定目录搜索
      POST
    • 批量查询数据集基本信息
      POST
    • 批量查询数据集权限信息
      POST
  • 仪表板
    • 获取页面列表
    • 根据页面名称关键词搜索页面
    • 获取指定页面有读权限的用户列表
    • 以树状结构获取页面列表
    • 以PDF或者图片模式导出仪表板
    • 获取仪表板导出文件
    • 获取页面基本信息
    • 获取页面信息
  • 订阅预警
    • 下载自定义渠道推送文件
    • 启用/关闭订阅
    • 启用/关闭预警
  • 卡片
    • 获取卡片数据
    • 基于数据集创建卡片接口,提供生成随机ID的接口
  • 权限
    • 获取指定用户能访问的页面列表
    • 获取指定用户能访问的数据集列表
    • 修改指定用户与各个页面的访问及归属关系
    • 修改指定用户与各个数据集的访问及归属关系
    • 获取指定用户组能访问的页面列表
    • 获取指定用户组能访问的数据集列表
    • 修改指定用户组与各个页面的访问及归属关系
    • 修改指定用户组与各个数据集的访问及归属关系
    • 通用资源权限授权与解除
  • 资源操作
    • 将指定用户下辖有所有者权限的资源迁移至其他用户组或用户
    • 将指定用户组下有所有者权限的资源迁移至其他用户组或用户
    • 通用资源列表清单
  • 卡片导出
    • 卡片导出接口使用说明
    • public api 卡片导出
    • public api 任务状态轮询
    • public-api 卡片导出文件下载
  • session
    • session创建or更新
    • 查询数据集的session配置
  • 文件夹
    • 创建文件夹目录
    • 修改文件夹目录
    • 删除文件夹接口
    • 文件夹新增授权接口
    • 文件夹删除权限接口
    • 批量查询文件夹权限信息
  • 数据账户
    • 创建数据账户
  • 身份认证
    • 用户登录
    • 通过用户的loginId登录
    • 用户登出
  • 用户管理
    • 用户管理概述
    • 用户
      • 批量创建用户
      • 批量删除用户
      • 批量修改用户属性
      • 批量获取用户是否存在
      • 通过属性值获取用户列表
      • 获取用户列表
      • 通过loginId获取用户信息
      • 修改用户状态
    • 用户组
      • 批量创建用户组
      • 批量修改用户组
      • 删除指定用户组
      • 获取用户组列表
      • 添加单个用户组
    • 用户组成员
      • 将用户添加至用户组
      • 将用户从用户组删除
      • 获取指定用户组下直接挂载的用户列表
      • 获取指定用户直接所属的用户组列表
    • 角色
      • 查询某一用户的角色信息
      • 为某一用户增添自定义角色
      • 为某一用户解绑自定义角色
    • 用户关联账号
      • 关联账号配置介绍
      • 配置用户外部关联账号
      • 删除用户的关联账号
      • 查询用户的外部关联账号
  1. 用户管理

用户管理概述

简介#

用户管理包含用户、用户组、角色、用户组成员、用户关联账号等几个子模块。通过用户管理public api可实现:
查询系统中的用户、用户组信息
创建、修改、删除用户与用户组
维护用户与用户组的关联关系
查询以及修改用户的自定义角色
维护用户的外部关联账号

对应功能#

对应于BI管理中心里的用户管理,详细可参考帮助中心文档
image.png

名词解释#

用户#

系统的使用者,用户属性包括但不限于:
账号:用户在BI中的登录账号,通常使用loginId作为接口参数。
账号类型:每个用户只有一种账号类型。枚举值包括admin、editor、participant,分别表示管理员、普通用户、只读账号。
所属用户组:一个用户可以有多个用户组
自定义角色:每个用户可以有多个自定义角色。用户通过自定义角色可以有不同的RBAC权限。
image.png

用户组#

用户组是对用户进行的分类和归属,使企业管理员能够更直接方便的管理用户的各类权限。用户组属性包括但不限于:
用户组id:用户组在BI中的唯一标识。通常使用ugId作为接口参数。
外部id:在使用public api或者账户同步创建用户组时,每个用户组都会有一个对应的外部id。其代表的是用户组在第三方系统中的唯一标识。通常使用externalGroupId作为接口参数。
父用户组:一个用户组可以有一个父用户组、多个子用户组,呈树状结构。根用户组的父用户组id为空。
角色:用户可以通过用户组继承自定义角色
image.png

角色#

角色是管理员为每个账号赋予的特定权限分组,每个角色背后都有其对应的功能权限信息。
账号类型:只读用户、普通用户和管理员。
系统角色,主要是指组管理员,当系统开启了组管理员功能时,用户管理这里便可以看到组管理员的成员清单,以及每个组管理员可以管理的用户组。
自定义角色:支持建立自定义角色,按需分配对应的功能权限。
image.png

用户关联账号#

在SSO中,可以通过关联BI账号与认证系统中的账号,来实现通过SSO登录关联的BI账号。每个用户,每种SSO Provider,都可以配置一个外部账号。详见 关联账号配置介绍。
修改于 2025-02-17 06:22:06
上一页
用户登出
下一页
批量创建用户