获取用户角色列表
通过用户ID、角色ID等筛选条件获取用户角色列表,可获取的信息包括用户ID、角色ID、角色姓名、业务管理范围等
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/hire/v1/user_roles |
| HTTP Method | GET |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | hire:auth:readonly 获取招聘权限信息 hire:auth 更新招聘权限信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE2Mjc1NTUyMjM2NzIsImlkIjpudWxsfQ== |
page_size | int | 否 | 每页获取记录数量 示例值:10 默认值: 10数据校验规则: - 最大值: 100 |
user_id | string | 否 | 用户 ID,与入参 user_id_type 类型一致示例值:7326856229396906012 |
role_id | string | 否 | 角色 ID,可通过接口 获取角色列表 获取 示例值:101 |
update_start_time | string | 否 | 最早更新时间,毫秒时间戳 示例值:1618500278663 |
update_end_time | string | 否 | 最晚更新时间,毫秒时间戳 示例值:1618500278663 |
user_id_type | string | 否 | 用户 ID 类型 示例值:open_id 可选值有: - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?默认值: open_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | user_role\[\] | 用户角色列表 |
└ user_id | string | 用户 ID,与入参 user_id_type 类型一致 |
└ role_id | string | 角色 ID,可通过接口 获取角色列表 获取 |
└ modify_time | string | 修改时间,毫秒时间戳 |
└ role_name | i18n | 角色名称 |
└ zh_cn | string | 角色中文名称 |
└ en_us | string | 角色英文名称 |
└ role_description | i18n | 角色描述 |
└ zh_cn | string | 角色中文描述 |
└ en_us | string | 角色英文描述 |
└ business_management_scopes | user_business_management_scope\[\] | 业务管理范围 |
└ entity | entity_info | 实体 |
└ code | string | 实体code,枚举如下 - talent:人才 - application:投递 - interview:面试 - interview_appointment_project:预约面试 - jobfair:集中面试 - exam_session:集中笔试 - offer:Offer - job:职位 - job_recruitment:招聘需求 - reward:内推奖励 - info_session:宣讲会 - bi:BI - subject:对应项目 |
└ name | i18n | 实体名称 |
└ zh_cn | string | 实体中文名称 |
└ en_us | string | 实体英文名称 |
└ scope_rule | permission_scope_rule | 管理范围规则 |
└ rule_type | int | 规则类型 可选值有: - 0: 无数据权限 - 1: 全部数据权限 - 2: 按规则制定范围 |
└ has_more | boolean | 是否还有更多项 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
响应体示例
json
{
"code": 0,
"msg": "SUCCESS",
"data": {
"items": [
{
"user_id": "7326856229396906012",
"role_id": "101",
"modify_time": "1618500278663",
"role_name": {
"zh_cn": "招聘 HRBP",
"en_us": "Recruitment HRBP"
},
"role_description": {
"zh_cn": "赋予HRBP的权限",
"en_us": "Authority given to HRBP"
},
"business_management_scopes": [
{
"entity": {
"code": "application",
"name": {
"zh_cn": "测试",
"en_us": "test"
}
},
"scope_rule": {
"rule_type": 1
}
}
]
}
],
"has_more": true,
"page_token": "eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE2Mjc1NTUyMjM2NzIsImlkIjpudWxsfQ=="
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1002001 | 系统错误 | 请根据实际报错信息定位或咨询技术支持 |
| 400 | 1002002 | 参数错误 | 检查参数是否正确,例如类型,大小 |
