用户管理

获取用户列表

接口简介

获取用户列表

接口详情

请求地址

/openapi/v1/group/{groupKey}/user?__scp__={__scp__}&page=1&perPage=12&searchText=

请求类型

GET

请求参数

返回正确 JSON 示例

{
  status: 0,
  msg: "",
  data: ["test@baidu.com"]   // 邮箱列表
}

返回错误 JSON 示例

{
  msg: '错误详情',
  status: 499,
  requestId: '',
  code: 'NoSuchKey'
}

搜索要添加的用户

接口简介

搜索要添加的用户

接口详情

请求地址

/openapi/v1/group/{groupKey}/user/addSearch?__scp__={__scp__}&searchText=

请求类型

GET

请求参数

返回正确 JSON 示例

{
  data: [
    {
      email: "test@baidu.com",          // 用户邮箱
      disabled: false                   // 是否可添加(false/可添加、true/不可添加)
    }
  ],
  msg: "",
  status: 0
}

返回错误 JSON 示例

{
  msg: '错误详情',
  status: 499,
  requestId: '',
  code: 'NoSuchKey'
}

添加用户

接口简介

添加用户(每次授权的报表和角色会覆盖之前的设置，如需单独新增报表权限可以使用【新增用户报表权限接口】)

接口详情

请求地址

/openapi/v1/group/{groupKey}/user?__scp__={__scp__}

请求类型

POST

请求参数

如果只需增加用户只传 users 即可，如果想在增加用户同时增加用户报表或者大屏权限对应参数同编辑用户，参考编辑用户

返回正确 JSON 示例

{
  data: {},
  msg: '',
  status: 0
}

返回错误 JSON 示例

{
  msg: '错误详情',
  status: 499,
  requestId: '',
  code: 'NoSuchKey'
}

新增用户报表权限

接口简介

新增用户报表权限

接口详情

请求地址

/openapi/v1/group/{groupKey}/user/addReport?__scp__={__scp__}

请求类型

PUT

请求参数

参数参考编辑用户。 只需传递对应报表或大屏的权限参数即可，比如想新增某用户在某报表的阅览者权限：

{
    email: "test@baidu.com",
    isAdmin: false,
    view_report: {
        detail: {
            changeData: {
                "r_ada15-cl1rbqe9-pm13j2": {
                    view: true
                }
            }
        }
    }
}

返回正确 JSON 示例

{
  data: {},
  msg: '',
  status: 0
}

返回错误 JSON 示例

{
  msg: '错误详情',
  status: 499,
  requestId: '',
  code: 'NoSuchKey'
}

编辑用户

接口简介

编辑用户

接口详情

请求地址

/openapi/v1/group/{groupKey}/user/editUser?__scp__={__scp__}

请求类型

PUT

请求参数

dataDevelopdataModel|dataDevelopdatabase|pagedashboard|pagereport|pagedataModel|pagedataSubmit|viewdashboard|viewreport 配置

detail 配置

changeData 配置

报表、大屏、数据模型、数据源、数据填报的 hash 值作为 changeData 的 key 的配置

page_other 配置

返回正确 JSON 示例

{
  data: {},
  msg: '',
  status: 0
}

返回错误 JSON 示例

{
  msg: '错误详情',
  status: 499,
  requestId: '',
  code: 'NoSuchKey'
}

删除用户

接口简介

删除用户

接口详情

请求地址

/openapi/v1/group/{groupKey}/user/deleteUser?__scp__={__scp__}

请求类型

DELETE

请求参数

{
  email: 'test@baidu.com'; // 用户邮箱
}

返回正确 JSON 示例

{
  data: {},
  msg: '',
  status: 0
}

返回错误 JSON 示例

{
  msg: '错误详情',
  status: 499,
  requestId: '',
  code: 'NoSuchKey'
}