跳到主要内容

用户管理 API

最近更新 2026/10/03

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

一、用户管理​

1. 查询用户ID​

注意

仅支持公司级token

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求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_code0Integer返回码
return_messagesuccessString返回信息
data-Object校验结果查询key
data.authUsers-List用户列表
data.authUsers.userId88Integer用户ID
data.authUsers.loginNametest_user1String用户名

2. 查询单个用户信息，包括角色​

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

接口URL

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

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
loginNametest_user1String是登录名称

成功响应示例

用户是超管时返回companyRole:

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

用户不是超管时返回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返回数据
data.loginNametest_user1String登录名称
data.roleInfo-Object角色信息
data.roleInfo.projectRoles-List项目角色列表
data.roleInfo.projectRoles.projectId3Integer项目ID
data.roleInfo.projectRoles.roleDesc管理员String角色描述
data.roleInfo.projectRoles.roleNameadminString角色名称
data.userId88Integer用户ID
data.userName测试用户AString用户名称
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

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

3. 查询用户账户状态​

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

接口URL

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

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
loginNameuser007String是登录名称

成功响应示例

{
    "data": {
        "accountStatus": "NORMAL",
        "loginName": "user007"
    },
    "return_code": 0,
    "return_message": "success"
}
$$参数名示例值参数类型参数描述
data-Object返回数据
data.accountStatusNORMALString

账户状态

  • INVALID：无效
  • NORMAL：正常状态
  • LOCK：锁定状态
data.loginNameuser007String登录名称
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

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

4. 用户冻结​

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

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
loginNameuser007String是登录名称

成功响应示例

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

错误响应示例

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

5. 用户解冻​

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

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
loginNameuser007String是登录名称

成功响应示例

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

错误响应示例

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

6. 解绑用户的MFA绑定​

注意

仅支持公司级token

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
loginNamerootString是登录名称

成功响应示例

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

错误响应示例

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

7. 批量创建用户角色​

注意

  • 该API完成以下功能：

    1. 创建用户账号，初始密码为"ta2020"; 若用户账号已经存在，则跳过创建用户账号这一步；
    2. 设置用户账号在各项目里的角色，角色必须已经在项目里被定义。

  • 仅支持公司级token

注意

在历史版本中, 创建 “分析管理员” 角色时需要传入的角色名称为 “管理员”

以上限制自 v5.0版本角色优化后解除, 直接传入项目中的分析角色名称即可

由于名称可修改, 请进入AE系统中 系统管理/项目管理 内的 <角色管理>页面 确认所需的角色名称

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求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是用户信息实体
authUsers.loginNametest_user1String是用户登录账号名
authUsers.roles-List是角色列表
authUsers.roles.projectId390Integer否项目ID
authUsers.roles.roleDesc测试2String是分析角色显示名，目前暂不支持通过API设置运营角色

成功响应示例

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

错误响应示例

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

9. 创建SSO用户​

注意
  • 用于sso用户信息创建

接口URL

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

请求方式

GET

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
loginTypedingtalkString是三方登录类型
loginNameuser007String是登录名称
password-String否登录密码（不传系统会自动生成）

成功响应示例

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

错误响应示例

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

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

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID
loginNameuser007String是要删除的用户登录名称
handoverToLoginNameuser008String是可以移交的用户登录名称

成功响应示例

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

错误响应示例

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

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

注意

仅支持公司级token

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
loginNameuser007Integer是登录名称
handoverToLoginNameuser008String是移交的用户登录名称

成功响应示例

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

错误响应示例

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

二、用户组管理​

1. 查询用户组ID和成员列表​

接口URL

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

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID
userGroupNamedemo007String是用户组名称

成功响应示例

{
    "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返回数据
data.groupNamedemo007String群组名称
data.id133Integerid
data.isDefaultfalseBoolean是否默认
data.members-List成员列表
data.members.userId16426Integer用户ID
data.updateTime2021-11-22 19:22:15Date更新时间
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

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

2. 创建用户分组​

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId2Integer是项目ID

请求Body参数

{
    "groupName": "demo007",
    "isDefault": false,
    "members": [
        {
            "userId": 16426,
            "userName": "user007"
        }
    ]
}
$$参数名示例值参数类型是否必填参数描述
groupNamedemo007String是分组名称，最多64个字符
isDefaultfalseBoolean否新用户是否默认加入群组
members-List否成员列表
members.userId16426Integer否成员用户ID
members.userNameuser007String否成员用户姓名

成功响应示例

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

错误响应示例

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

3. 更新用户组成员列表​

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

注意

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

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID

请求Body参数

{
  "id": 99,
  "groupName": "testGroup",
  "isDefault": false,
  "members": [
    {
      "userId": 88,
      "userName": "test88"
    },
    {
      "userId": 100,
      "userName": "test100"
    }
  ]
}
$$参数名示例值参数类型是否必填参数描述
id99Integer是用户组id
groupNametestGroupString否用户组名称，最大支持64个字符
isDefaultfalseBoolean否项目新用户默认加入本组
members-List否用户组成员
members.userId88String否用户成员用户ID
members.userNametest88String否用户成员用户名称

成功响应示例

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

错误响应示例

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

5. 删除用户分组​

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID
groupId1String是分组ID

成功响应示例

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

错误响应示例

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

三、项目角色管理​

1. 获取项目角色详情​

接口URL

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

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId2Integer是项目ID
roleDesc分析师007String是角色描述

成功响应示例

{
    "data": {
        "projectId": 2,
        "roleDesc": "分析师007",
        "roleName": "analyst_1462717171385241600",
        "funcList": [
            {
                "functionClass": "用户分群设置",
                "functionDesc": "查看条件分群、结果分群、上传ID分群的列表",
                "functionId": 14,
                "functionName": "viewCluster",
                "functionType": "查看"
            },
            {
                "functionId": 34,
                "functionClass": "看板使用",
                "functionDesc": "查看看板及看板设置",
                "functionName": "viewDashbord",
                "functionType": "查看"
            },
            {
                "functionId": 35,
                "preFunctionId": 34,
                "functionClass": "看板使用",
                "functionDesc": "临时调整看板的筛选条件、使用全局筛选",
                "functionName": "useDashbordFilter",
                "functionType": "查看"
            }
        ]
    },
    "return_code": 0,
    "return_message": "success"
}
$$参数名示例值参数类型参数描述
data-Object返回数据
data.projectId2Integer项目ID
data.roleDesc分析师007String角色描述
data.roleNameanalyst_1462717171385241600String角色名称
data.funcList-List功能列表
data.funcList.functionClass看板使用String功能分类
data.funcList.functionDesc临时调整看板的筛选条件、使用全局筛选String功能描述
data.funcList.functionId35Integer功能ID
data.funcList.functionNameuseDashbordFilterString功能名称
data.funcList.functionType查看String功能类型
data.funcList.preFunctionId34Integer依赖功能ID
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

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

2. (已废弃)获取基本角色功能列​

注意

AE 5.0版本已升级角色权限管理功能 ，不再需要基于baseRole创建自定义角色

请通过 “获取所有功能列” 接口查询全量功能列表，结合角色功能需求、功能依赖直接创建自定义角色。

3. 获取所有功能列​

注意

仅支持公司级token

接口URL

/open/get-all-functions?token=xxx

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

成功响应示例

{
    "data": [
                {
                    "functionId":6,
                    "functionName":"viewProjectInfo",
                    "functionDesc":"查看项目接入信息",
                    "functionType":"查看",
                    "functionClass":"项目接入"
                },
                {
                    "functionId":8,
                    "functionName":"configProjectParm",
                    "functionDesc":"编辑项目接入信息",
                    "functionType":"编辑",
                    "functionClass":"项目接入",
                    "preFunctionId":6
                },
                {
                    "functionId":14,
                    "functionName":"viewCluster",
                    "functionDesc":"查看分群列表",
                    "functionType":"查看",
                    "functionClass":"用户分群管理"
                }
],
    "return_code": 0,
    "return_message": "success"
}
$$参数名示例值参数类型参数描述
data-Object返回数据
data.functionId8Integer功能ID
data.functionNameconfigProjectParmString功能名称
data.functionDesc编辑项目接入信息String功能描述
data.functionType编辑String功能类别
data.functionClass项目接入String功能模块
data.preFunctionId6Interger依赖功能ID
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

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

3. 新建项目角色​

注意

新建项目角色并分配权限，建议先通过 "获取所有功能列" 接口查询需要的功能权限，然后再根据其中的权限ID调用该接口

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId2Integer是项目ID

请求Body参数

{
    "roleDesc": "分析师007",
    "roleFuncList": [
        14,34,53
    ]
}
参数名示例值参数类型是否必填参数描述
roleDesc分析师007String是角色描述，最多60字符
roleFuncList[14]List是角色功能ID列表，必须是有效的ID

成功响应示例

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

错误响应示例

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

4. 修改项目角色​

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId2Integer是项目ID
roleNameadminString是角色名称

请求Body参数

{
    "roleDesc": "分析师009",
    "roleFuncList": [
        14,34,53
    ]
}
参数名示例值参数类型是否必填参数描述
roleDesc分析师009String否角色描述
roleFuncList[14]List否角色功能ID列表

成功响应示例

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

错误响应示例

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

5. 删除项目角色​

注意

AE 5.0版本升级了自定义功能权限，在删除旧角色时需指定替代的新角色，以保证旧角色账号的正常使用。

接口URL

/open/delete-project-role?token=xxx&projectId=0&roleName=role_1&newRoleName=role_2

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID
roleNamerole_1String是角色名称
newRoleNamerole_2String是指定新的角色名

成功响应示例

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

错误响应示例

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

四、看板分享黑名单​

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

1. 添加黑名单​

注意

仅支持公司级token

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
loginNamerootString是登录名称
blackProjectId0Integer是

黑名单项目ID

0：所有项目共享黑名单

项目ID：仅该项目下黑名单

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息
dataObject返回结果

错误响应示例

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

2. 批量添加黑名单(csv)​

注意

仅支持公司级token

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

文件模板如下：

loginName,blackProjectId
demo@thinkingdata,-1
user1,298

成功响应示例

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

错误响应示例

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

3. 设置黑名单组​

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

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
groupIdList[1]List是分组ID列表
groupType1Integer是1：黑名单分组

成功响应示例

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

错误响应示例

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

4. 删除黑名单​

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

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
loginNamerootString是登录名称
blackProjectId0Integer否黑名单项目ID

成功响应示例

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

错误响应示例

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

5. 下载黑名单​

注意
  • 仅支持公司级token

接口URL

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

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

成功响应示例

csv文件，示例截图如下

错误响应示例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
参数名示例值参数类型参数描述
return_code-1008Integer返回码
return_message参数(token)为空String返回信息
这篇文档对你有帮助吗？
本页内容