成员组管理

查看工作区成员组

GET /openapi/v1/workspaces/{workspaceId}/member-groups/

参数说明

字段	类型	是否必填	说明
q	string	否	当该字段不传值时，查询所有成员组；该字段传值时，会针对成员组的 name 字段和 desc 字段进行筛选
count	int	否	是否只返回数量

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": [
    {
      "uid": "xxxx",
      "name": "xxx",
      "desc": "xxxx",
      "auto_add_member": false,
      "actions": {
        "disableDownload": false
      }
    }
  ]
}

工作区新建成员组

POST /openapi/v1/workspaces/{workspaceId}/member-groups/

请求参数

{
  "name": "xxx",
  "desc": "xxxx",
  "auto_add_member": false,
  "actions": {}
}

参数说明

参数	类型	是否必填	说明
name	string	是	成员组名称
desc	string	否	成员组描述
auto_add_member	bool	否	是否自动添加用户到该成员组
actions	object	否	功能配置（26.21.1 版本之后支持）

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "uid": "xxxxxxxxxxxxx",
    "name": "xxx",
    "desc": "xxxx",
    "auto_add_member": false,
    "actions": {
      "disableDownload": false
    }
  }
}

actions 功能配置字段说明

actions 为功能配置对象，目前支持以下字段：

参数	类型	是否必填	说明
disableDownload	bool	否	是否禁用下载数据功能，true 表示禁用，默认不禁用

成员组的 disableDownload 会作用于组内所有成员：成员的下载功能是否禁用，由成员自身的 actions 与其所属的所有成员组的 actions 共同决定，任一设置为 true 即禁用。

工作区批量创建成员组

POST /openapi/v1/workspaces/{workspaceId}/member-groups/create-member-groups/

请求参数

{
  "memberGroups": [
    {
      "name": "xxx",
      "desc": "xxxx",
      "auto_add_member": false,
      "actions": {} // 功能配置（26.21.1 版本之后支持）
    },
    {
      "name": "xxx",
      "desc": "xxxx",
      "auto_add_member": false,
      "actions": {} // 功能配置（26.21.1 版本之后支持）
    }
  ]
}

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": [
    {
      "uid": "xxxx",
      "name": "xxx",
      "desc": "xxxx",
      "auto_add_member": false,
      "actions": {
        "disableDownload": false
      }
    },
    {
      "uid": "xxxx",
      "name": "xxx",
      "desc": "xxxx",
      "auto_add_member": false,
      "actions": {
        "disableDownload": false
      }
    }
  ]
}

工作区编辑成员组

PUT /openapi/v1/workspaces/{workspaceId}/member-groups/{member_groups_pk}/

请求参数

{
  "name": "xxx",
  "desc": "xxxx",
  "auto_add_member": false,
  "actions": {}
}

参数说明

参数	类型	是否必填	说明
name	string	否	成员组名称
desc	string	否	成员组描述
auto_add_member	bool	否	是否自动添加用户到该成员组
actions	object	否	功能配置（26.21.1 版本之后支持）

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "uid": "xxxxxxxxxxxxx",
    "name": "xxx",
    "desc": "xxxx",
    "auto_add_member": false,
    "actions": {
      "disableDownload": false
    }
  }
}

工作区批量编辑成员组

PUT /openapi/v1/workspaces/{workspaceId}/member-groups/update-member-groups/

请求参数

{
  "memberGroups": [
    {
      "uid": "xxxx",
      "name": "xxx",
      "desc": "xxxx",
      "auto_add_member": false,
      "actions": {} // 功能配置（26.21.1 版本之后支持）
    }
  ]
}

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": [
    {
      "uid": "xxxx",
      "name": "xxx",
      "desc": "xxxx",
      "auto_add_member": false,
      "actions": {
        "disableDownload": false
      }
    }
  ]
}

工作区删除成员组

DELETE /openapi/v1/workspaces/{workspaceId}/member-groups/{member_groups_pk}/

工作区批量删除成员组

DELETE /openapi/v1/workspaces/{workspaceId}/member-groups/delete-member-groups/

请求参数

{
  "memberGroupUids": ["xxxx", "xxxx"]
}

成员组查看成员

GET /openapi/v1/workspaces/{workspaceId}/member-groups/{member_groups_pk}/members/

参数说明

字段	类型	是否必填	说明
q	string	否	当该字段不传值时，查询所有成员；该字段传值时，会针对用户名、昵称、描述、邮箱进行筛选
status	int	否	按状态筛选成员
role	int	否	按角色筛选成员
tier	int	否	按用户等级筛选成员
count	int	否	是否只返回数量

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": [
    {
      "uid": "xxxx",
      "account": {
        "uid": "xxxx",
        "nickname": "xxx",
        "username": "xxx",
        "email": "xxx",
        "desc": "xxx",
        "status": 1,
        "memberUid": "xxxx"
      },
      "created_at": "2024-01-01T00:00:00Z"
    }
  ]
}

成员组添加成员

POST /openapi/v1/workspaces/{workspaceId}/member-groups/{member_groups_pk}/members/

请求参数

{
  "memberUids": ["xxxx", "xxxx"]
}

参数说明

参数	类型	是否必填	说明
memberUids	array	是	成员 uid 数组

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": [
    {
      "uid": "xxxx",
      "account": {
        "uid": "xxxx",
        "nickname": "xxx",
        "username": "xxx",
        "email": "xxx",
        "desc": "xxx",
        "status": 1,
        "memberUid": "xxxx"
      },
      "created_at": "2024-01-01T00:00:00Z"
    }
  ]
}

成员组删除成员

DELETE /openapi/v1/workspaces/{workspaceId}/member-groups/{member_groups_pk}/members/{memberUid}/

成员组批量删除成员

DELETE /openapi/v1/workspaces/{workspaceId}/member-groups/{member_groups_pk}/members/delete-group-members/

请求参数

{
  "memberUids": ["xxxx", "xxxx"]
}