角色管理
更新时间：2023-01-18
创建角色
接口简介
创建角色
接口详情
请求地址
/openapi/v1/group/{groupKey}/role?__scp__={__scp__}
请求类型
POST
请求参数
{
name: "运营", // 角色名称
remark: "test", // 角色描
users: ["test@baidu.com"] // 用户配置，属于本角色的用户
}同编辑角色，参考编辑角色
返回正确 JSON 示例
{
data: {},
msg: '',
status: 0
}返回错误 JSON 示例
{
msg: '错误详情',
status: 499,
requestId: '',
code: 'NoSuchKey'
}获取角色列表
接口简介
获取角色列表
接口详情
请求地址
/openapi/v1/group/{groupKey}/role?__scp__={__scp__}&page=1&perPage=12
请求类型
GET
请求参数
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| page | Number | 否 | 第几页 | 1 | 1 |
| perPage | Number | 否 | 每页条数 | 12 | 12 |
返回正确 JSON 示例
{
status: 0,
msg: "",
data: {
count: 3,
rows: [
{
name: "销售", // 角色名称
remark: "", // 角色描述
hash: "ro_ada15-2eihxpp2-p284kv" // 角色hash
},
{
name: "开发",
remark: "",
hash: "ro_ada15-1i6h64lc-g2vp2r"
},
{
name: "运营",
remark: "",
hash: "ro_ada15-8tdzmbh8-9kqzkx"
}
]
}
}返回错误 JSON 示例
{
msg: '错误详情',
status: 499,
requestId: '',
code: 'NoSuchKey'
}获取角色用户列表
接口简介
获取角色中用户列表
接口详情
请求地址
/openapi/v1/group/{groupKey}/role/users?__scp__={__scp__}&hash={hash}
请求类型
GET
请求 query 参数
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| hash | String | 是 | 角色 hash | - | ro_ada15-2eihxpp2-p284kv |
返回正确 JSON 示例
{
status: 0,
msg: "",
data: ["test@baidu.com"]
}返回错误 JSON 示例
{
msg: '错误详情',
status: 499,
requestId: '',
code: 'NoSuchKey'
}编辑角色
接口简介
编辑角色
接口详情
请求地址
/openapi/v1/group/{groupKey}/role/{roleHash}?__scp__={__scp__}
请求类型
PUT
请求参数
{
name: "运营", // 角色名称
remark: "", // 编辑角色的描述
users: ["test@baidu.com"] //用户配置，属于本角色的用户
}| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| name | String | 是 | 角色名称 | - | 运营 |
| remark | String | 否 | 角色描述 | - | - |
| users | Array | 是 | 用户配置，属于本角色的用户(详细描述见下方) | - | - |
| 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 | 否 | 使用邮件组自动同步用户时相关配置 | - | - |
users 配置
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| String | 是 | 用户邮箱 | - | "test@baidu.com" | |
| avatar | String | 否 | 头像地址 | - | "/static/user.png" |
| name | String | 否 | 用户名称 | - | "test@baidu.com" |
| realName | String | 否 | 用户真实姓名 | - | "/static/user.png" |
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}/role/{roleHash}?__scp__={__scp__}
请求类型
DELETE
请求参数
无
返回正确 JSON 示例
{
data: {},
msg: '',
status: 0
}返回错误 JSON 示例
{
msg: '错误详情',
status: 499,
requestId: '',
code: 'NoSuchKey'
}