用户管理
更新时间：2023-01-18
获取用户列表
接口简介
获取用户列表
接口详情
请求地址
/openapi/v1/group/{groupKey}/user?__scp__={__scp__}&page=1&perPage=12&searchText=
请求类型
GET
请求参数
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| page | Number | 否 | 第几页 | 1 | 1 |
| perPage | Number | 否 | 每页条数 | 12 | 12 |
| searchText | String | 否 | 搜索的用户名(不填时默认搜索全部) | - | - |
返回正确 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
请求参数
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| searchText | String | 否 | 搜索的用户名(不加这个属性时为全部列表) | - | - |
返回正确 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 | Array | 是 | 用户列表(从[获取用户列表]接口获取) | - | - |
如果只需增加用户只传 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
请求参数
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| String | 是 | 邮箱(从获取用户列表接口获取,只用在编辑中用户接口中，添加用户使用 users 参数，其它参数参考编辑用户参数) | - | - | |
| realName | String | 否 | 真实名字(从获取用户列表接口获取) | - | - |
| isAdmin | Boolean | 是 | 是否设为管理员 | false | false/true |
| roles | String | 是 | 角色配置,传入角色 hash(角色列表) | - | "ro_ada15-1i6h64lc-g2vp2r" |
| dataDevelop_dataModel | Object | 否 | 用户权限配置->数据开发权限->数据模型相关配置(详细描述见下方) | - | - |
| dataDevelop_database | Object | 否 | 用户权限配置->数据开发权限->数据源相关配置(详细描述见下方) | - | - |
| page_dashboard | Object | 否 | 用户权限配置->可视化分析权限->大屏相关配置(详细描述见下方) | - | - |
| page_report | Object | 否 | 用户权限配置->可视化分析权限->报表相关配置(详细描述见下方) | - | - |
| page_dataModel | Object | 否 | 用户权限配置->可视化分析权限->数据模型相关配置(详细描述见下方) | - | - |
| page_dataSubmit | Object | 否 | 用户权限配置->可视化分析权限->数据填报相关配置(详细描述见下方) | - | - |
| page_other | Object | 否 | 用户权限配置->可视化分析权限->其他资源相关配置(详细描述见下方) | - | - |
| view_dashboard | Object | 否 | 用户权限配置->阅览者权限->大屏相关配置(详细描述见下方) | - | - |
| view_report | Object | 否 | 用户权限配置->阅览者权限->报表相关配置(详细描述见下方) | - | - |
| roleType | Number | 否 | 添加用户方式 | 0 | 0：手动选择用户、1：使用邮件组自动同步用户 |
| superDataDevelop | Boolean | 否 | 用户权限配置->数据开发权限->超级数据开发师细粒度权限 | - | true/false |
| superPage | Boolean | 否 | 用户权限配置->可视化分析权限->超级可视化分析师细粒度权限 | - | true/false |
| superView | Boolean | 否 | 用户权限配置->阅览者权限->超级阅览者细粒度权限 | - | true/false |
| config | Object | 否 | 使用邮件组自动同步用户时相关配置 | - | - |
dataDevelop_dataModel|dataDevelop_database|page_dashboard|page_report|page_dataModel|page_dataSubmit|view_dashboard|view_report 配置
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| detail | Object | 是 | 资源配置的详细信息（资源包括报表、大屏、数据模型、数据源、数据填报）(详细描述见下方) | - | - |
detail 配置
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| data | Array | 是 | 资源的 hash 和 name 集合（资源包括报表、大屏、数据模型、数据源、数据填报） | - | - |
| changeData | Object | 是 | 资源的配置(如配置某个报表或者大屏的编辑或者查看权限等)（资源包括报表、大屏、数据模型、数据源、数据填报）(详细描述见下方) | {} | - |
changeData 配置
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| 报表、大屏、数据模型、数据源、数据填报的 hash 值 | Object | 是 | 报表、大屏、数据模型、数据源、数据填报的 hash 作为 key 值(详细描述见下方) | - | - |
报表、大屏、数据模型、数据源、数据填报的 hash 值作为 changeData 的 key 的配置
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| delete | Boolean | 否 | 删除权限 | - | true/false |
| edit | Boolean | 否 | 编辑权限 | - | true/false |
| use | Boolean | 否 | 使用权限（只在数据开发权限、可视化分析->数据模型中使用） | - | true/false |
| view | Boolean | 否 | 查看权限（只在阅览者权限中使用） | - | true/false |
page_other 配置
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| api | Boolean | 否 | API 转换器权限 | false | true/false |
| map | Boolean | 否 | 数据值映射 | false | true/false |
| scene | Boolean | 否 | 三维场景 | false | true/false |
| slide | Boolean | 否 | 轮播 | false | true/false |
| sql | Boolean | 否 | SQL 模型 | false | true/false |
| template | Boolean | 否 | 组件模板 | false | true/false |
返回正确 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'; // 用户邮箱
}| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| String | 是 | 邮箱(从[获取用户列表]接口获取) | - | - |
返回正确 JSON 示例
{
data: {},
msg: '',
status: 0
}返回错误 JSON 示例
{
msg: '错误详情',
status: 499,
requestId: '',
code: 'NoSuchKey'
}