列出角色下的成员调试
1. 简介
1.1 接口简介
列出角色下的所有成员信息。支持公共模式和集成模式。
1.2 接口版本
接口版本 | 更新时间 | 版本说明 |
v2 | 2022.4.8 | 初始版本:
|
v4 | 2022.6.30 | 返回值新增字段 status |
v5 | 2022.10.28 | 在 v4 的基础上,接口请求频率由 5 次/秒提升至 30 次/秒; 接口路由修改为 POST corp/role/user/list |
2023.10.11 | 1)新增请求参数:
2)新增响应参数:
|
2. 接口调用
列出角色下的所有成员信息。支持公共模式和集成模式。
注:只会返回邀请中和已激活的成员。
请求地址:https://api.jiandaoyun.com/api/v5/corp/role/user/list
请求频率:30 次/秒
请求方式:POST
请求参数:
参数 | 位置 | 是否必需 | 说明 |
skip | Number | 否 | 分页偏移 |
limit | Number | 否 | 分页大小,最大值为 10000。 |
role_no | Number | 是 | 角色编号 |
has_manage_range | Boolean | 否 | 是否包含分管部门信息,默认值为 false。 |
请求示例:
{
"skip": 0,
"limit": 3,
"role_no": 72,
"has_manage_range": True
}
响应内容:
参数 | 类型 | 是否必须 | 说明 |
username | String | 是 | 成员的编号,企业内唯一 |
name | String | 是 | 成员昵称 |
departments | Number[] | 是 | 成员所在部门编号列表 |
type | Number | 是 | 成员类型:
|
status | Number | 是 | 成员状态:
|
integrate_id | String | 否 | 集成模式同步角色关联 ID,仅在集成模式下返回 |
departments_range | Number[] | 否 | 角色分管部门编号 注:只有配置了分管部门的成员才会显示此参数。 |
has_child | Boolean | 否 | 是否包含子部门 注:只有配置了分管部门的成员才会显示此参数。 |
返回示例:
{
"users": [
{
"username": "jdy-xulalikdbj82",
"name": "frank",
"departments": [212],
"type": 0,
"status": 1,
"deptarments_range": [378,1157],
"has_child": true
},
{
"username": "R-E9rRNbwL",
"name": "成员删除1",
"departments": [338,226],
"type": 0,
"status": 1,
"deptarments_range": [1157],
"has_child": false
},
{
"username": "UPDATE",
"name": "testadmin",
"departments": [1],
"type": 0,
"status": 1
}
]
}