行权限

行权限模式 RowPermissionMode

字段值	说明
1	需要满足全部的条件才可以看到对应的信息
2	只需要满足任意一个条件就可以看到对应的信息

控制方式 effect

字段值	说明
allow	符合该条件下的数据
deny	不符合该条件下的数据

控制类型 operator

字段值	说明
contain	包含，模糊匹配，含有控制的值均受控制
equal	等于，精准匹配，与控制的值完全一致
startswith	字段以控制的值开头
endswith	字段以控制的值结尾
isNull	字段为空，此时不需要传入控制的值

查看行权限开关

GET
URL: /openapi/v1/workspaces/{workspaceId}/members/{member_uid}/enable-row-permission/
请求头：
{
 "Authorization": "连接密钥"
}

返回结果

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

开启/关闭行权限

PUT
URL: /openapi/v1/workspaces/{workspaceId}/members/{member_uid}/enable-row-permission/
请求头：
{
 "Authorization": "连接密钥"
}
请求包体：
{
 "enableRowPermission": true
}

参数说明

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

返回结果

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

获取受控字段

GET
URL: /openapi/v1/workspaces/{workspaceId}/row-permission-resource/
请求头：
{
 "Authorization": "连接密钥"
}

返回结果

{
 "errcode": 200,
 "errmsg": "success",
 "data": [
  {
   "isAttr": true,
   "label": "xxx",
   "value": "xxxx"
  }
 ]
}

参数说明

参数	类型	说明
data.isAttr	bool	是否为维度
data.label	string	字段名
data.value	string	字段属性

获取行权限

GET
URL: /openapi/v1/workspaces/{workspaceId}/members/{member_uid}/row-permission/
请求头：
{
 "Authorization": "连接密钥"
}

返回结果

{
 "errcode": 200,
 "errmsg": "success",
 "data": {
  "rowPermission": [
            {
                "effect": "allow",
                "resource": "xxx",
                "resourceLabel": "xxx",
                "values": ["xxx", "xxx"],
                "operator": "equal",
            }
        ],
        "rowPermissionMode": 1,
 }
}

参数说明

参数	类型	说明
rowPermissionMode	int	详见行权限模式 RowPermissionMode
rowPermission	array	行权限数组
effect	string	详见控制方式 effect
resource	string	受控字段属性
resourceLabel	string	受控字段名
values	array	设置控制的值，当 operator 为 isNull 时，传入空数组
operator	string	详见控制的类型 operator

修改行权限

PUT
URL: /openapi/v1/workspaces/{workspaceId}/members/{member_uid}/row-permission/
请求头：
{
 "Authorization": "连接密钥"
}
请求包体：
{
 "rowPermissionMode": 1,
 "rowPermission": [
  {
   "effect": "allow",
   "resource": "xxx",
   "resourceLabel": "xxx",
   "values": ["xxx", "xxx"],
   "operator": "equal"
  }
 ]
}

参数说明

参数	类型	是否必填	说明
rowPermissionMode	int	是	详见行权限模式 RowPermissionMode
rowPermission	array	是	行权限数组
effect	string	是	受控字段匹配之后的处理效果，允许为"allow"，禁止为"deny"
resource	string	是	受控字段属性，该字段使用的是维度/维度表中的维度属性/指标的 ID d -> 维度 m -> 指标 例如： 1. 想针对某一维度设置权限，该维度的 id 为 1，则 resource 字段设置的值应该为 d1 2. 针对某个维度表下的某个维度属性设置权限，该维度表的 ID 为 1，维度属性的 ID 为 A，则 resource 字段设置的值应该为 d1. A 3. 针对某一指标设置权限，该指标的 id 为 1，则 resource 字段设置的值应该为 m1
resourceLabel	string	是	受控字段名
values	array	是	设置允许访问的内容
operator	string	是	详见控制的类型 operator

返回结果

{
 "errcode": 200,
 "errmsg": "success",
 "data": {
     "rowPermissionMode": 1,
        rowPermission: [
            {
                "effect": "allow",
                "resource": "xxx",
                "resourceLabel": "xxx",
                "values": ["xxx", "xxx"],
                "operator": "equal"
            }
        ]
 }
}

参数说明

参数	类型	说明
rowPermissionMode	int	详见行权限模式 RowPermissionMode
rowPermission	array	行权限数组
effect	string	受控字段匹配之后的处理效果
resource	string	受控字段属性
resourceLabel	string	受控字段名
values	array	设置允许访问的内容
operator	string	详见控制的类型 operator

批量修改成员行权限

PUT
URL: /openapi/v1/workspaces/{workspaceId}/members/update-row-permissions/
请求头：
{
 "Authorization": "连接密钥"
}
请求包体：
{
 "memberRowPermissions": [
  {
   "memberUid": "xxxxxx",
   "rowPermissionMode": 1,
   "rowPermission": [
                {
                    "effect": "allow",
                    "resource": "xxx",
                    "resourceLabel": "xxx",
                    "values": ["xxx", "xxx"],
                    "operator": "equal",
                },
            ]
  },
 ]
}