Skip to content

成员组

查看工作区成员组

GET
URL: /openapi/v1/workspaces/{workspaceId}/member_groups/
请求头:
{
 "Authorization": "连接密钥"
}

返回结果

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

工作区新建成员组

POST
URL: /openapi/v1/workspaces/{workspaceId}/member_groups/
请求头:
{
 "Authorization": "连接密钥"
}
请求包体:
{
 "auto_add_member": false,
 "desc": "xxxx",
 "name": "xxxx"
}

参数说明

参数 类型 说明
auto_add_member bool 是否自动添加用户到该成员组
desc string 成员组描述
name string 成员组名称

返回结果

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

参数说明

参数 类型 说明
data.uid string 成员组 uid
data.name string 成员组名称
data.desc string 成员组描述
data.auto_add_member bool 是否自动添加用户到该成员组

工作区批量创建成员组

POST
URL: /openapi/v1/workspaces/{workspaceId}/create-member-groups/
请求头:
{
 "Authorization": "连接密钥"
}
请求包体:
{
 "memberGroups": [
  {
         "auto_add_member": false,
            "desc": "xxxx",
            "name": "xxxx"
  },
  {
         "auto_add_member": false,
            "desc": "xxxx",
            "name": "xxxx"
  }
 ]
}

返回结果

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

工作区编辑成员组

PUT
URL: /openapi/v1/workspaces/{workspaceId}/member_groups/{member_groups_uid}/
请求头:
{
 "Authorization": "连接密钥"
}
请求包体:
{
 "auto_add_member": false,
 "desc": "xxxx",
 "name": "xxxx"
}

参数说明

参数 类型 说明
auto_add_member bool 是否自动添加用户到该成员组
desc string 成员组描述
name string 成员组名称

返回结果

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

参数说明

参数 类型 说明
data.uid string 成员组 uid
data.name string 成员组名称
data.desc string 成员组描述
data.auto_add_member bool 是否自动添加用户到该成员组

工作区批量编辑成员组

PUT
URL: /openapi/v1/workspaces/{workspaceId}/member_groups/update-member-groups/
请求头:
{
 "Authorization": "连接密钥"
}
请求包体:
{
 "memberGroups": [
  {
   "uid": "xxxxxxx",
            "auto_add_member": false,
            "desc": "xxxx",
            "name": "xxxx"
  },
 ]
}

返回结果

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

查看成员组权限

具体权限操作见 行权限列权限表权限,id 为成员组的 id

暂时只支持单条记录的修改

成员组查看成员

GET
URL: /openapi/v1/workspaces/{workspaceId}/member-groups/{member_groups_uid}/members/
请求头:
{
 "Authorization": "连接密钥"
}

返回结果

{
 "errcode": 200,
 "errmsg": "success",
 "data": [
  {
   "uid": "xxxxx"
  }
 ]
}

成员组添加成员

POST
URL: /openapi/v1/workspaces/{workspaceId}/member-groups/{member_groups_uid}/members/
请求头:
{
 "Authorization": "连接密钥"
}
请求包体:
{
 "memberUids": ["xxxxxxxxx"]
}

参数说明

参数 类型 说明
memberUids array 成员 uid 数组

返回结果

{
 "errcode": 200,
 "errmsg": "success"
}

成员组删除成员

DELETE
URL: /openapi/v1/workspaces/{workspaceId}/member-groups/{member_groups_uid}/members/{member_uid}/
请求头:
{
 "Authorization": "连接密钥"
}

返回结果

{
 "errcode": 200,
 "errmsg": "success"
}

成员组批量删除成员

DELETE
URL: /openapi/v1/workspaces/{workspaceId}/member-groups/{member_groups_uid}/members/delete-group-members/
请求头:
{
 "Authorization": "连接密钥"
}
请求包体:
{
 "memberUids": ["xxxx", "xxxx"]
}

返回结果

{
 "errcode": 200,
 "errmsg": "success"
}