创建用户组

创建新的用户组，仅项目管理员可执行，支持设置公开属性、管理员列表及描述信息

查询项目下的用户组列表

获取指定项目下的所有用户组信息，返回包括组 ID、名称、描述、公开状态等字段

查询用户组成员

获取用户组内的成员列表，支持分页和关键词搜索，可区分成员类型（用户 / 子组）

删除用户组成员

从用户组中移除指定成员，支持通过用户 ID、用户组 ID 或用户名列表操作

添加用户组成员

向用户组中添加成员，支持批量添加用户、子组或通过用户名匹配

从项目中删除用户

将用户从项目中移除，支持批量删除多个用户

添加用户到项目中

向项目中添加用户并分配权限，重复添加会覆盖原有高级权限

关联系统级别用户组到项目中

获取项目列表

获取项目用户列表

获取项目内的用户列表，支持关键词过滤和分页查询

授权接口

对资源（数据集、仪表盘等）进行权限授予，支持批量授权多人多权限

获取资源授权明细

查询资源的授权详情，包括用户 / 组直接权限及通过角色继承的权限

更改用户属性接口

修改用户的自定义属性值，需指定属性 ID 和新值

删除用户属性接口

删除用户的指定自定义属性

获取数据权限成员接口

查询数据权限规则的关联成员列表，支持分页和排序

添加数据权限成员接口

为数据权限规则添加关联成员，支持用户或用户组

删除数据权限成员接口

从数据权限规则中移除关联成员

获取数据集上的行列权限规则列表

查询数据集的行权限和列权限规则，支持指定用户的权限过滤

数据集上新建行列权限

创建数据集的行权限或列权限规则，支持固定值和动态值配置

数据集上删除行列权限

删除指定的数据集行列权限规则

数据集上修改行列权限

更新数据集行列权限规则的配置内容

在数据集上指定用户授权指定数据权限规则

将已有权限规则应用到指定用户 / 组

在数据集上指定用户移除指定数据权限规则权限

取消用户 / 组对指定权限规则的关联

获取图表上所有设置过行列权限的字段

查询图表关联数据集中设置了权限控制的字段列表

appId

int

是

1

项目ID，获取方式见资源 ID 获取方式

name

string

是

“zhangsan”

用户组名称

description

string

是

"description_info",

用户组描述

isPublic

int

是

1

1: 公开用户组，0: 非公开用户组

ownerList

string 数组

是

["admin1","admin2"]

管理员列表，元素为字符串类型

code

string

"aeolus/ok"

状态码，标识请求处理结果

data

object

{用户组信息}

用户组信息

msg

string

“成功”

状态信息，对请求结果的文本描述

appId

int

是

1

项目ID，获取方式见资源 ID 获取方式

data.groups

array

见下方说明

用户组列表数组

data.groups.description

string

"description"

用户组描述信息

data.groups.id

int

1

用户组 ID

data.groups.isPublic

int

0

是否为公开用户组，1: 公开用户组，0: 非公开用户组

data.groups.name

string

"name"

用户组名称

data.groups.originId

string

""

原始 ID（可能为空）

data.groups.ownerList

array

["demo-creator@2100******"]

管理员列表

data.groups.source

int

4

用户组类型（0:部门组;1:全局用户组;2:项目用户组;3:飞书群）

appId

int

是

1

项目ID，获取方式见资源 ID 获取方式

subjectId

number

是

1

用户组ID，获取方式见查询项目下的用户组列表

kw

string

否

"keywords"

搜索关键词参数，默认为空表示查询全部

perPage

int

否

20

分页参数，指定每页个数，默认20

page

int

否

1

分页参数，指定第几页，默认1

data.members

array

成员列表

data.members.description

string

“description”

成员描述

data.members.id

int

1

成员 ID

data.members.name

string

"组名称"/"姓名"

成员名称

data.members.originId

string

"组 id"/"用户名"

成员原始 ID

data.members.source

int

0

来源标识（type 为 1 时，0 表示部门，1 表示系统级组，2 表示项目级组；type 为 0 时该字段无用）

data.members.type

int

1

成员类型（1 表示组，0 表示用户）

data.members.avatar

string

"头像链接"

用户头像链接（仅 type 为 0 时存在）

data.members.departmentName

string

"部门名称"

部门名称（仅 type 为 0 时存在）

data.members.emailPrefix

string

"用户名"

用户邮箱前缀（仅 type 为 0 时存在）

data.total

int

2

成员总数

msg

string

"成功"

返回消息

appId

int

是

1

项目ID，获取方式见资源 ID 获取方式

subjectId

number

是

12

用户组ID，获取方式见查询项目下的用户组列表

groups

array[number]

否

[12,13]

用户组 ID 列表

users

array[number]

否

[1,2]

用户 ID 列表

originUsers

array[string]

否

["admin"]

用户名列表，与 users 取并集

code

string

"aeolus/ok"

接口返回的状态码，标识请求处理结果

msg

string

"成功"

接口返回的状态描述

appId

int

是

1

项目 ID，获取方式见资源 ID 获取方式

subjectId

number

是

6

用户组 ID

groups

array[number]

否

[12,13]

用户组 ID 列表

users

array[number]

否

[1,2]

用户 ID 列表

originUsers

array[string]

否

["admin"]

用户名列表，与 users 取并集

code

string

"aeolus/ok"

接口返回的状态码，标识请求处理结果

msg

string

"成功"

接口返回的状态描述

appId

int

是

1

项目 ID，获取方式见资源 ID 获取方式

subjectIdList

array[number]

是

[12,13]

用户组 ID 列表

code

string

"aeolus/ok"

接口返回的状态码，标识请求处理结果

data

object

{}

包含请求返回的具体数据内容

msg

string

"成功"

接口返回的状态描述

appId

int

是

1

项目 ID，获取方式见资源 ID 获取方式

originIdList

array[string]

是

["xiajinfu.xjf"]

被操作的用户列表，元素为用户名

action

string

是

"read_role"

用户拥有的项目权限，枚举值：read_role（读权限）、write_role（写权限）、read_all_role（全读权限）、admin（管理员权限）。重复添加用户时，会取消其已有的更高级权限

code

string

"aeolus/ok"

接口返回的状态码，标识请求处理结果

data

object

{}

包含操作结果的具体数据

data.fails

array[string]

[]

添加失败的用户列表

data.users

array[string]

[]

添加成功的用户列表

msg

string

"成功"

接口返回的状态描述

appId

int

是

1

项目 ID，获取方式见资源 ID 获取方式

originIdList

array[number]

是

[122345]

用户组的主键 ID 列表，元素为数字

code

string

"aeolus/ok"

接口返回的状态码，标识请求处理结果

data

object

{}

包含关联结果的具体数据

data.fails

array[number]

[]

关联失败的用户组 ID 列表

data.groups

array[number]

[]

关联成功的用户组 ID 列表

msg

string

"成功"

接口返回的状态描述

appId

int

是

1

项目 ID，获取方式见资源 ID 获取方式

code

string

"aeolus/ok"

接口返回的状态码，标识请求处理结果

data

array

项目信息列表，每个元素为项目对象

data.appSettings

object

{}

项目设置

data.ctime

string

"2023-07-11 21:17:19"

项目创建时间，格式为 "YYYY-MM-DD HH:MM:SS"

data.id

int

1

项目 ID

data.isAdmin

int

1

是否为管理员项目（1 = 是，0 = 否）

data.isFavored

int

0

是否收藏（1 = 是，0 = 否）

data.isPermitted

int

1

是否有权限访问（1 = 是，0 = 否）

data.name

string

"测试项目 1"

项目名称

data.org

object

项目所属组织信息

data.org.id

int

1

组织 ID

data.org.name

string

"默认集团"

组织名称

msg

string

"成功"

接口返回的状态描述

appId

int

是

1

项目 ID，获取方式见资源 ID 获取方式

kw

string

否

"keywords"

搜索关键词参数，默认为空表示查询全部

perPage

int

否

20

分页参数，指定每页个数，默认20

page

int

否

1

分页参数，指定第几页，默认1

code

string

“aeolus/ok”

返回状态码

data.total

int

1

用户数量

data.users

array

见返回示例

用户列表数组

data.users.id

long

100000000

用户 id

data.users.originId

string

“admin”

原始 id

data.users.name

string

“admin”

用户名

data.users.email

string

""

用户邮箱

data.users.phoneNumber

string

""

用户手机号

data.users.enable

boolean

true

用户是否启用

msg

string

成功

返回信息

appId

int

是

123

项目 id，获取方式见资源 ID 获取方式

resId

int

是

456

授权资源 id

resType

string

是

data_set

资源类型（数据集：data_set，仪表盘：dashboard，数据连接：data_connection）

actions

array

是

["read_role"]

权限列表（读：read_role，写：write_role，管理：admin）

subjectList

array

是

[{"originId":"user_1", "type":0}]

授权对象列表，每个对象包含 originId（用户名 / 组名）和 type（0-> 人，1-> 组）

code

string

aeolus/ok

返回状态码

data.fails

array

[{"originId":"user_1","subjectType":0,"reason":"xxx"}]

授权失败的对象列表，如果有失败则fails不为空，每个对象包含 originId（用户名 / 组名）、subjectType（0-> 人，1-> 组）和失败原因

msg

string

成功