目录
此内容是否有帮助?

# 用户管理 API

调用方法请参见Open API文档中的调用方法描述。

# 一、用户管理

# 查询用户 ID

注意

仅支持公司级 token

接口 URL

/open/list-auth-users-by-login-names?token=xxx

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥

请求 Body 参数

{
    "loginNames": [
        "test_user1",
        "test_user2"
    ]
}
参数名
示例值
参数类型
是否必填
参数描述
loginNames
["test_user1"]
List

登录用户名成列表

成功响应示例

{
    "return_code": 0,
    "return_message": "success",
    "data": {
        "authUsers": [
            {
                "userId": 88,
                "loginName": "test_user1"
            },
            {
                "userId": 89,
                "loginName": "test_user2"
            }
        ]
    }
}
参数名
示例值
参数类型
参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息
data
-
Object
校验结果查询key
authUsers -
List
用户列表
userId 88
Integer
用户ID
loginName test_user1
String
用户名

# 查询单个用户信息,包括角色

注意

  • 用户是超管时返回 companyRole,用户不是超管时返回 projectRoles
  • 仅支持公司级 token

接口 URL

/open/get-auth-user-info-by-login-name?token=xxx&loginName= test_user1

请求方式

GET

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
loginName
test_user1
String

登录名称

成功响应示例

用户是超管时返回 companyRole:

{
  "return_code": 0,
  "return_message": "success",
  "data": {
    "userId": 88,
    "loginName": "test_user1",
    "userName": "测试用户A",
    "roleInfo": {
      "companyRole": {
        "roleName": "root",
        "roleDesc": "公司超管"
      }
    }
  }
}
参数名
示例值
参数类型
参数描述
data
-
Object
返回数据
loginName test_user1
String
登录名称
roleInfo -
Object
角色信息
companyRole -
List
公司角色列表
roleName root
String
角色描述
roleDesc 公司超管
String
角色名称
userId 88
Integer
用户ID
userName 测试用户A
String
用户名称
return_code
0
Integer
返回码
return_message
success
String
返回信息

用户不是超管时返回 projectRoles:

{
  "return_code": 0,
  "return_message": "success",
  "data": {
    "userId": 88,
    "loginName": "test_user1",
    "userName": "测试用户A",
    "roleInfo": {
      "projectRoles": [
        {
          "projectId": 3,
          "roleName": "admin",
          "roleDesc": "管理员"
        },
        {
          "projectId": 4,
          "roleName": "analyst",
          "roleDesc": "分析师"
        }
      ]
    }
  }
}
参数名
示例值
参数类型
参数描述
data
-
Object
返回数据
loginName test_user1
String
登录名称
roleInfo -
Object
角色信息
projectRoles -
List
项目角色列表
projectId 3
Integer
项目ID
roleDesc 管理员
String
角色描述
roleName admin
String
角色名称
userId 88
Integer
用户ID
userName 测试用户A
String
用户名称
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "Find no user with loginName: test007"
}
参数名
示例值
参数类型
参数描述
return_code
-1008
Integer
返回码
return_message
Find no user with loginName: test007
String
返回信息

# 查询用户账户状态

注意

  • 根据用户登录名查询用户账号状态

接口 URL

/open/get-auth-user-status?token=xxx&loginName=user007

请求方式

GET

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
loginName
user007
String

登录名称

成功响应示例

{
    "data": {
        "accountStatus": "NORMAL",
        "loginName": "user007"
    },
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
data
-
Object
返回数据
accountStatus NORMAL
String
账户状态
INVALID:无效
NORMAL:正常状态
LOCK:锁定状态
loginName user007
String
登录名称
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
参数名
示例值
参数类型
参数描述
return_code
-1008
Integer
返回码
return_message
参数(token)为空
String
返回信息

# 获取用户账户状态

接口 URL

/open/get-auth-user-status?token=xxx&loginName=test007

请求方式

GET

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
loginName
test007
String

登录名称

成功响应示例

{
    "data": {
        "accountStatus": "NORMAL",
        "loginName": "Test"
    },
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
data
-
Object
返回数据
accountStatus NORMAL
String
账户状态
INVALID:无效
NORMAL:正常状态
LOCK:锁定状态
loginName Test
String
登录名称
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
参数名
示例值
参数类型
参数描述
return_code
-1008
Integer
返回码
return_message
参数(token)为空
String
返回信息

# 用户冻结

注意

  • 根据用户登录名称冻结用户

接口 URL

/open/member-lock?token=xxx&loginName=user007

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
loginName
user007
String

登录名称

成功响应示例

{
    "data": true,
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
data
true
Object
返回数据
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1006,
    "return_message": "您无权限操作,请检查token值是否正确"
}
参数名
示例值
参数类型
参数描述
return_code
-1006
Integer
返回码
return_message
您无权限操作,请检查token值是否正确
String
返回信息

# 用户解冻

注意

  • 根据用户登录名称解冻用户

接口 URL

/open/member-unlock?token=xxx&loginName=user007

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
loginName
user007
String

登录名称

成功响应示例

{
    "data": true,
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
data
true
Object
返回数据
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1006,
    "return_message": "您无权限操作,请检查token值是否正确"
}
参数名
示例值
参数类型
参数描述
return_code
-1006
Integer
返回码
return_message
您无权限操作,请检查token值是否正确
String
返回信息

# 解绑用户的 MFA 绑定

注意

仅支持公司级 token

接口 URL

/open/unbind-auth-user-mfa?token=xxx&loginName=root

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
loginName
root
String

登录名称

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1009,
    "return_message": "用户名不存在"
}
参数名
示例值
参数类型
参数描述
return_code
-1009
Integer
返回码
return_message
用户名不存在
String
返回信息

# 批量创建用户角色

注意

  • 该 API 完成以下功能:
    1. 创建用户账号,初始密码为"ta2020"; 若用户账号已经存在,则跳过创建用户账号这一步;
    2. 设置用户账号在各项目里的角色,角色必须已经在项目里被定义好。
  • 仅支持公司级 token

接口 URL

/open/batch-create-auth-user-and-set-roles?token=xxx

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥

请求 Body 参数

{
    "authUsers": [{
        "loginName": "test_user1",
        "roles": [{
            "projectId": 57,
            "roleDesc": "数据分析师A"
        }, {
            "projectId": 0,
            "roleDesc": "角色测试A"
        }]
    }, {
        "loginName": "test_user2",
        "roles": [{
            "projectId": 390,
            "roleDesc": "测试2"
        }, {
            "projectId": 377,
            "roleDesc": "普通成员"
                }]
        }]
}
参数名
示例值
参数类型
是否必填
参数描述
authUsers
-
List

用户信息实体
loginName test_user1
String

用户登录账号名
roles -
List

角色列表
projectId 390
Integer

项目ID
roleDesc 测试2
String

角色显示名

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1006,
    "return_message": "This API is Forbidden in SAAS"
}
参数名
示例值
参数类型
参数描述
return_code
-1006
Integer
返回码
return_message
This API is Forbidden in SAAS
String
返回信息

# 创建 SSO 用户

注意

  • 用于 sso 用户信息创建

接口 URL

/open/create/ssoUser?token=xxx&loginType=dingtalk&loginName=user007

请求方式

GET

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
loginType
dingtalk
String

三方登录类型
loginName
user007
String

登录名称
password
-
String

登录密码(不传系统会自动生成)

成功响应示例

{
    "data": true,
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
data
true
Object
返回数据
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1006,
    "return_message": "您无权限操作,请检查token值是否正确"
}
参数名
示例值
参数类型
参数描述
return_code
-1006
Integer
返回码
return_message
您无权限操作,请检查token值是否正确
String
返回信息

# 从项目中删除用户, 可选择移交工作

接口 URL

/open/delete-auth-user-from-project?token=xxx&projectId=0&loginName=user007&handoverToLoginName=user008

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
loginName
user007
String

要删除的用户登录名称
handoverToLoginName
user008
String

可以移交的用户登录名称

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1023,
    "return_message": "user user007不存在"
}
参数名
示例值
参数类型
参数描述
return_code
-1023
Integer
返回码
return_message
user user007不存在
String
返回信息

# 从系统中删除用户, 可选择移交工作

注意

仅支持公司级 token

接口 URL

/open/delete-auth-user-from-system?token=xxx&loginName=user007&handoverToLoginName=user008

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
loginName
user007
Integer

登录名称
handoverToLoginName
user008
String

移交的用户登录名称

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1010,
    "return_message": "Unsupported in SAAS"
}
参数名
示例值
参数类型
参数描述
return_code
-1010
Integer
返回码
return_message
Unsupported in SAAS
String
返回信息

# 二、用户组管理

# 查询用户组 ID 和成员列表

接口 URL

/open/get-user-group-by-name?token=xxx&projectId=0&userGroupName=demo007

请求方式

GET

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
userGroupName
demo007
String

用户组名称

成功响应示例

{
    "data": {
        "groupName": "demo007",
        "id": 133,
        "isDefault": false,
        "members": [
            {
                "userId": 16426
            }
        ],
        "updateTime": "2021-11-22 19:22:15"
    },
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
data
-
Object
返回数据
groupName demo007
String
群组名称
id 133
Integer
id
isDefault false
Boolean
是否默认
members -
List
成员列表
userId 16426
Integer
用户ID
updateTime 2021-11-22 19:22:15
Date
更新时间
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1023,
    "return_message": "用户分组不存在"
}
参数名
示例值
参数类型
参数描述
return_code
-1023
Integer
返回码
return_message
用户分组不存在
String
返回信息

# 创建用户分组

接口 URL

/open/create-user-group?token=xxx&projectId=2

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
projectId
2
Integer

项目ID

请求 Body 参数

{
    "groupName": "demo007",
    "isDefault": false,
    "members": [
        {
            "userId": 16426,
            "userName": "user007"
        }
    ]
}
参数名
示例值
参数类型
是否必填
参数描述
groupName
demo007
String

分组名称,最多64个字符
isDefault
false
Boolean

新用户是否默认加入群组
members
-
List

成员列表
userId 16426
Integer

成员用户ID
userName user007
String

成员用户姓名

成功响应示例

{
    "data": {
        "id": 135
    },
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
data
-
Object
返回数据
id 135
Integer
id
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1015,
    "return_message": "已存在"
}
参数名
示例值
参数类型
参数描述
return_code
-1015
Integer
返回码
return_message
已存在
String
返回信息

# 更新用户组成员列表

可用于新增或更新用户组组名称,新增或更新组成员信息

注意

  1. 提交的成员列表将整体替换掉原来的成员列表

接口 URL

/open/update-user-group?token=xxx&projectId=0

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID

请求 Body 参数

{
  "id": 99,
  "groupName": "testGroup",
  "isDefault": false,
  "members": [
    {
      "userId": 88,
      "userName": "test88"
    },
    {
      "userId": 100,
      "userName": "test100"
    }
  ]
}
参数名
示例值
参数类型
是否必填
参数描述
id
99
Integer

用户组id
groupName
testGroup
String

用户组名称,最大支持64个字符
isDefault
false
Boolean

项目新用户默认加入本组
members
-
List

用户组成员
userId 88
String

用户成员用户ID
userName test88
String

用户成员用户名称

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1023,
    "return_message": "用户分组不存在"
}
参数名
示例值
参数类型
参数描述
return_code
-1023
Integer
返回码
return_message
用户分组不存在
String
返回信息

# 删除用户分组

接口 URL

/open/delete-user-group?token=xxx&projectId=0&groupId=1

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
groupId
1
String

分组ID

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1023,
    "return_message": "用户分组不存在"
}
参数名
示例值
参数类型
参数描述
return_code
-1023
Integer
返回码
return_message
用户分组不存在
String
返回信息

# 三、项目角色管理

# 获取项目角色详情

接口 URL

/open/get-project-role-by-role-desc?token=xxx&projectId=2&roleDesc=分析师 007

请求方式

GET

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
projectId
2
Integer

项目ID
roleDesc
分析师007
String

角色描述

成功响应示例

{
    "data": {
        "baseRole": "analyst",
        "funcList": [
            {
                "functionClass": "用户分群设置",
                "functionDesc": "查看条件分群、结果分群、上传ID分群的列表",
                "functionId": 14,
                "functionName": "viewCluster",
                "functionType": "查看"
            },
            {
                "functionClass": "用户标签管理",
                "functionDesc": "查看标签列表",
                "functionId": 53,
                "functionName": "viewTag",
                "functionType": "查看"
            },
            {
                "functionClass": "看板使用",
                "functionDesc": "查看看板及看板设置",
                "functionId": 34,
                "functionName": "viewDashbord",
                "functionType": "查看"
            }
        ],
        "projectId": 2,
        "roleDesc": "分析师007",
        "roleName": "analyst_1462717171385241600"
    },
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
data
-
Object
返回数据
baseRole analyst
String
基础角色
funcList -
List
功能列表
functionClass 用户分群设置
String
功能分类
functionDesc 查看条件分群、结果分群、上传ID分群的列表
String
功能描述
functionId 14
Integer
功能ID
functionName viewCluster
String
功能名称
functionType 查看
String
功能类型
projectId 2
Integer
项目ID
roleDesc 分析师007
String
角色描述
roleName analyst_1462717171385241600
String
角色名称
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1023,
    "return_message": "role test不存在"
}
参数名
示例值
参数类型
参数描述
return_code
-1023
Integer
返回码
return_message
role test不存在
String
返回信息

# 获取基本角色功能列

注意

仅支持公司级 token

接口 URL

/open/get-base-role-functions?token=xxx&baseRoleName=analyst

请求方式

GET

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
baseRoleName
analyst
String

基础角色名称
analyst:分析师
member:普通成员

成功响应示例

{
    "data": {
        "defaultHaveCouldRemove": [
            {
                "functionClass": "看板使用",
                "functionDesc": "临时调整看板的筛选条件、使用全局筛选",
                "functionId": 35,
                "functionName": "useDashbordFilter",
                "functionType": "查看"
            }
        ],
        "defaultNotHaveCouldAdd": [
            {
                "functionClass": "模型使用",
                "functionDesc": "使用模型、保存报表、进行报表管理",
                "functionId": 28,
                "functionName": "useModel",
                "functionType": "功能使用"
            }
        ],
        "mustHave": [
            {
                "functionClass": "看板使用",
                "functionDesc": "查看看板及看板设置",
                "functionId": 34,
                "functionName": "viewDashbord",
                "functionType": "查看"
            }
        ],
        "mustNotHave": [
            {
                "functionClass": "系统管理",
                "functionDesc": "新增项目",
                "functionId": 1,
                "functionName": "addProject",
                "functionType": "接入管理"
            }
        ]
    },
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
data
-
Object
返回数据
defaultHaveCouldRemove -
Object
默认功能可移除功能列表
functionClass 看板使用
String
功能分类
functionDesc 临时调整看板的筛选条件、使用全局筛选
String
功能描述
functionId 35
Integer
功能ID
functionName useDashbordFilter
String
功能名称
functionType 查看
String
功能类型
defaultNotHaveCouldAdd -
Object
默认无可新增功能列表
functionClass 模型使用
String
功能分类
functionDesc 使用模型、保存报表、进行报表管理
String
功能描述
functionId 28
Integer
功能ID
functionName useModel
String
功能名称
functionType 功能使用
String
功能类型
mustHave -
Object
必须拥有的功能列表
functionClass 看板使用
String
功能分类
functionDesc 查看看板及看板设置
String
功能描述
functionId 34
Integer
功能ID
functionName viewDashbord
String
功能名称
functionType 查看
String
功能类型
mustNotHave -
Object
必须没有的功能列表
functionClass 系统管理
String
功能分类
functionDesc 新增项目
String
功能描述
functionId 1
Integer
功能ID
functionName addProject
String
功能名称
functionType 接入管理
String
功能类型
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "getBaseRoleFunctions.baseRoleName 需要匹配正则表达式\"analyst|member\""
}
参数名
示例值
参数类型
参数描述
return_code
-1008
Integer
返回码
return_message
getBaseRoleFunctions.baseRoleName 需要匹配正则表达式"analyst
String
返回信息

# 新建项目角色

注意

新建项目角色并分配权限,建议与接口: 获取基本角色功能列接口搭配使用

接口 URL

/open/create-project-role?token=xxx&projectId=2

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
projectId
2
Integer

项目ID

请求 Body 参数

{
    "baseRole": "analyst",
    "roleDesc": "分析师007",
    "roleFuncList": [
        14,34,53
    ]
}
参数名
示例值
参数类型
是否必填
参数描述
baseRole
analyst
String

基础角色名称
analyst:分析师
member:普通成员)
roleDesc
分析师007
String

角色描述,最多60字符
roleFuncList
[14]
List

角色功能ID列表,必须是有效的ID

成功响应示例

{
    "data": {
        "roleName": "analyst_1462717171385241600"
    },
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
data
-
Object
返回数据
roleName analyst_1462717171385241600
String
角色名称
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
参数名
示例值
参数类型
参数描述
return_code
-3004
Integer
返回码
return_message
无效项目
String
返回信息

# 修改项目角色

接口 URL

/open/update-project-role?token=xxx&projectId=2&roleName=admin

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
projectId
2
Integer

项目ID
roleName
admin
String

角色名称

请求 Body 参数

{
    "baseRole": "analyst",
    "roleDesc": "分析师009",
    "roleFuncList": [
        14,34,53
    ]
}
参数名
示例值
参数类型
是否必填
参数描述
baseRole
analyst
String

基础角色名称
analyst:分析师
member:普通成员)
roleDesc
分析师009
String

角色描述
roleFuncList
[14]
List

角色功能ID列表

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
参数名
示例值
参数类型
参数描述
return_code
-3004
Integer
返回码
return_message
无效项目
String
返回信息

# 删除项目角色

接口 URL

/open/delete-project-role?token=xxx&projectId=0&roleName=test

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
roleName
test
String

角色名称

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1023,
    "return_message": "role 'test'不存在"
}
参数名
示例值
参数类型
参数描述
return_code
-1023
Integer
返回码
return_message
role 'test'不存在
String
返回信息

# 四、看板分享黑名单

使用场景,当我们设置看板共享时,当共享给全部成员可见时,可使用黑名单排除某些用户

# 添加黑名单

注意

  • 仅支持公司级 token

接口 URL

/open/share/add-black?token=xxx&loginName=root&blackProjectId=0

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
loginName
root
String

登录名称
blackProjectId
0
Integer

黑名单项目ID
0:所有项目共享黑名单
项目ID:仅该项目下黑名单

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息
data
Object
返回结果

错误响应示例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
参数名
示例值
参数类型
参数描述
return_code
-1008
Integer
返回码
return_message
参数(token)为空
String
返回信息

# 批量添加黑名单(csv)

注意

  • 仅支持公司级 token

接口 URL

/open/share/add-black-list?token=xxx

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥

文件模板截图如下:

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
参数名
示例值
参数类型
参数描述
return_code
-1008
Integer
返回码
return_message
参数(token)为空
String
返回信息

# 设置黑名单组

注意

  • 仅支持公司级 token
  • 设置分组为黑名单组后,整组成员都会进入黑名单

接口 URL

/open/share/add-black-group-list?token=xxx&groupIdList=[1]&groupType=1

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
groupIdList
[1]
List

分组ID列表
groupType
1
Integer

1:黑名单分组

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
参数名
示例值
参数类型
参数描述
return_code
-1008
Integer
返回码
return_message
参数(token)为空
String
返回信息

# 删除黑名单

注意

  • 仅支持公司级 token
  • 可选择将某人移除某项目黑名单,也可移除所有黑名单

接口 URL

/open/share/cancel-black?token=xxx&loginName=root&blackProjectId=0

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥
loginName
root
String

登录名称
blackProjectId
0
Integer

黑名单项目ID

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名
示例值
参数类型
参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
参数名
示例值
参数类型
参数描述
return_code
-1008
Integer
返回码
return_message
参数(token)为空
String
返回信息

# 下载黑名单

注意

  • 仅支持公司级 token

接口 URL

/open/share/download-share-black?token=xxx

请求方式

POST

Content-Type

application/json

请求 Query 参数

参数名
示例值
参数类型
是否必填
参数描述
token
xxx
String

查询密钥

成功响应示例

csv 文件,示例截图如下

错误响应示例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
参数名
示例值
参数类型
参数描述
return_code
-1008
Integer
返回码
return_message
参数(token)为空
String
返回信息