角色管理

更新时间:2020-10-12

创建角色

接口简介

创建角色

接口详情

请求地址

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

请求类型

POST

请求参数

{
  name: "运营",                                                // 角色名称
  remark: "test",                                             // 角色描述
  reports: "r_ada15-50z688xs-p284kv,r_ada15-qo0s8m6-g2vp2r",  // 权限配置,角色可访问的报表
  users: ["gengshaozhen@baidu.com"]                          // 用户配置,属于本角色的用户(用户列表通过【组织管理->用户管理->获取用户列表】获取)
}
参数名 类型 必填 描述 默认值 参考值
name String 角色名称 - 运营
remark String 角色描述 - -
reports String 权限配置,角色可访问的报表( 创建数据模型 ) - "r ada15-50z688xs-p284kv,r ada15-qo0s8m6-g2vp2r"
users Array 用户配置,属于本角色的用户 - [ "gengshaozhen@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/{roleHash}?__scp__={__scp__}

请求类型

PUT

请求参数

{
  name: "运营",                                                // 角色名称
  reports: "r_ada15-50z688xs-p284kv,r_ada15-qo0s8m6-g2vp2r",  // 权限配置,角色可访问的报表
  users: ["gengshaozhen@baidu.com"]                          // 用户配置,属于本角色的用户
}
参数名 类型 必填 描述 默认值 参考值
name String 角色名称 - 运营
remark String 角色描述 - -
reports String 权限配置,角色可访问的报表( 创建数据模型 ) - "r ada15-50z688xs-p284kv,r ada15-qo0s8m6-g2vp2r"
users Array 用户配置,属于本角色的用户( 创建数据模型 - [ "gengshaozhen@baidu.com" ]

返回正确 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'
}

本页内容