成员组

查看工作区成员组

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
    }
  ]
}

工作区新建成员组

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	否	功能配置

返回结果

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

工作区批量创建成员组

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

请求参数

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

返回结果

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

工作区编辑成员组

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

请求参数

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

参数说明

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

返回结果

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

工作区批量编辑成员组

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

请求参数

{
  "memberGroups": [
    {
      "uid": "xxxx",
      "name": "xxx",
      "desc": "xxxx",
      "auto_add_member": false
    }
  ]
}

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": [
    {
      "uid": "xxxx",
      "name": "xxx",
      "desc": "xxxx",
      "auto_add_member": 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}/enable-row-permission/

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "enableRowPermission": true
  }
}

开启/关闭成员组行权限

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

请求参数

{
  "enableRowPermission": true
}

参数说明

参数	类型	是否必填	说明
enableRowPermission	bool	是	行权限是否开启，当值为 true 时行权限开启，值为 false 时行权限关闭

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "enableRowPermission": true
  }
}

获取成员组行权限

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

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "rowPermission": [
      {
        "effect": "allow",
        "resource": "d1",
        "resourceLabel": "品牌",
        "values": ["耐克", "阿迪达斯"],
        "operator": "equal"
      }
    ],
    "rowPermissionMode": 1
  }
}

修改成员组行权限

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

请求参数

{
  "rowPermissionMode": 1,
  "rowPermission": [
    {
      "effect": "allow",
      "resource": "d2",
      "values": ["三里屯"],
      "operator": "equal"
    }
  ]
}

参数说明

参数	类型	是否必填	说明
rowPermissionMode	int	是	行权限模式，1 表示需要满足全部条件，2 表示满足任一条件即可
rowPermission	array	是	行权限数组
rowPermission.effect	string	是	受控字段匹配后的处理效果，允许为 "allow"，禁止为 "deny"
rowPermission.resource	string	是	维度属性
rowPermission.values	array	是	设置允许访问的内容
rowPermission.operator	string	是	控制类型，可选值：contain(包含), equal(等于), startswith(开头), endswith(结尾), isNull(为空)

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "rowPermissionMode": 1,
    "rowPermission": [
      {
        "effect": "allow",
        "resource": "d2",
        "resourceLabel": "门店",
        "values": ["三里屯"],
        "operator": "equal"
      }
    ]
  }
}

查看成员组列权限开关

GET /openapi/v1/workspaces/{workspaceId}/member-groups/{member_groups_pk}/enable-col-permission/

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "enableColPermission": false
  }
}

开启/关闭成员组列权限

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

请求参数

{
  "enableColPermission": true
}

参数说明

参数	类型	是否必填	说明
enableColPermission	bool	是	列权限是否开启，当值为 true 时列权限开启，值为 false 时列权限关闭

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "enableColPermission": false
  }
}

获取成员组列权限

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

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "dimensions": {
      "effect": "allow",
      "resource": ["d1", "d2.A", "d3.B"]
    },
    "measures": {
      "effect": "deny",
      "resource": ["m1", "m2", "m3"]
    }
  }
}

修改成员组列权限

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

请求参数

{
  "dimensions": {
    "effect": "allow",
    "resource": ["d1.A", "d2.A"]
  },
  "measures": {
    "effect": "deny",
    "resource": ["m1", "m2"]
  }
}

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "dimensions": {
      "effect": "allow",
      "resource": ["d1.A", "d2.A"]
    },
    "measures": {
      "effect": "deny",
      "resource": ["m1", "m2"]
    }
  }
}

查看成员组模型权限开关

GET /openapi/v1/workspaces/{workspaceId}/member-groups/{member_groups_pk}/enable-model-permission/

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "enableModelPermission": false
  }
}

开启/关闭成员组模型权限

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

请求参数

{
  "enableModelPermission": true
}

参数说明

参数	类型	是否必填	说明
enableModelPermission	bool	是	模型权限是否开启，当值为 true 时模型权限开启，值为 false 时模型权限关闭

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "enableModelPermission": false
  }
}

获取成员组模型权限

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

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "effect": "allow",
    "resource": ["模型uid"]
  }
}

修改成员组模型权限

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

请求参数

{
  "effect": "allow",
  "resource": ["模型uid"]
}

参数说明

参数	类型	是否必填	说明
effect	string	是	模型允许或禁止使用
resource	array	是	模型 uid 数组

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "effect": "allow",
    "resource": ["模型uid"]
  }
}

成员组查看成员

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"]
}