获取用户列表
接口简介
获取用户列表
接口详情
请求地址
/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: ["gengshaozhen@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
请求参数
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| isAdmin | Boolean | 是 | 是否设为管理员 | false | false/true |
| reports | String | 否 | 权限配置，角色可访问的报表( 报表列表 ) | - | "r ada15-50z688xs-p284kv,r ada15-qo0s8m6-g2vp2r" |
| roles | String | 是 | 角色配置,传入角色 hash( 角色列表 ) | - | "ro_ada15-1i6h64lc-g2vp2r" |
| users | Array | 是 | 添加的用户(已在空间中的用户不可再次添加)(从上方 [ 获取用户列表 ] 获取) | - | [ "test@baidu.com" ] |
返回正确 JSON 示例
{
data: {},
msg: '',
status: 0
}返回错误 JSON 示例
{
msg: '错误详情',
status: 499,
requestId: '',
code: 'NoSuchKey'
}新增用户报表权限
接口简介
新增用户报表权限
接口详情
请求地址
/openapi/v1/group/{groupKey}/user/addReport?__scp__={__scp__}
请求类型
POST
请求参数
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| String | 是 | 邮箱(从 [ 获取用户列表 ] 接口获取) | - | ||
| reports | String | 是 | 权限配置，角色可访问的报表( 报表列表 ) | - | "r ada15-50z688xs-p284kv,r ada15-qo0s8m6-g2vp2r" |
返回正确 JSON 示例
{
data: {},
msg: '',
status: 0
}返回错误 JSON 示例
{
msg: '错误详情',
status: 499,
requestId: '',
code: 'NoSuchKey'
}编辑用户
接口简介
编辑用户
接口详情
请求地址
/openapi/v1/group/{groupKey}/user/editUser?__scp__={__scp__}
请求类型
PUT
请求参数
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| String | 是 | 邮箱(从 [ 获取用户列表 ] 接口获取) | - | - | |
| realName | String | 是 | 真实名字(从 [ 获取用户列表 ] 接口获取) | - | - |
| isAdmin | Boolean | 是 | 是否设为管理员 | false | false/true |
| reports | String | 是 | 权限配置，角色可访问的报表( 报表列表 ) | - | "r ada15-50z688xs-p284kv,r ada15-qo0s8m6-g2vp2r" |
| roles | String | 是 | 角色配置,传入角色 hash( 角色列表 ) | - | "ro_ada15-1i6h64lc-g2vp2r" |
返回正确 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'
}