获取组织类角色授权列表
查询组织类角色的授权信息,返回的授权列表中包含被授权的用户ID和被授权的管理维度等信息。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v1/assigned_users/search |
| HTTP Method | POST |
| 接口频率限制 | 10 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | corehr:authorization:read 获取用户授权数据 corehr:corehr:readonly 获取核心人事信息 corehr:corehr 更新核心人事信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
user_id_type | string | 否 | 用户 ID 类型 示例值:people_corehr_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? - people_corehr_id: 以飞书人事的 ID 来识别用户默认值: people_corehr_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
role_id | string | 是 | 角色 ID,仅支持组织类角色, 角色 ID 可通过批量获取角色列表接口获取 示例值:"100" |
management_scope_list | management_scope\[\] | 是 | 管理范围信息 |
└ management_dimension | string | 是 | 管理维度 可选值有: - department:部门 - work_location:工作地点 - company:公司 - social_security_location:社保城市 示例值:"department" |
└ obj_id | string | 是 | 被授权部门/工作地点/公司/社保城市 ID 示例值:"7023318326176777742" |
search_method | string | 是 | 查找方式 可选值有: - 1:只查找指定 部门/工作地点/公司/社保城市,如无授权信息则返回为空 - 2:当指定的 部门/工作地点/公司/社保城市 无授权信息,向上查找第一个授权记录并直接返回 示例值:"1" |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" |
page_size | string | 是 | 分页大小,最大100 示例值:"100" |
请求体示例
json
{
"role_id": "100",
"management_scope_list": [
{
"management_dimension": "department",
"obj_id": "7023318326176777742"
}
],
"search_method": "1",
"page_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"page_size": "100"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | role_authorization\[\] | 用户授权信息 |
└ employment_id | string | 员工 ID > 如想获取员工详细信息,可通过搜索员工信息接口获取。 |
└ management_scope_list | management_scope\[\] | 实际授权管理范围 |
└ management_dimension | string | 管理维度 可选值有: - department:部门 - work_location:工作地点 - company:公司 - social_security_location:社保城市 |
└ obj_id | string | 被授权部门/工作地点/公司/社保城市 ID |
└ has_more | boolean | 是否还有更多项 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"employment_id": "6967639606963471902",
"management_scope_list": [
{
"management_dimension": "department",
"obj_id": "7023318326176777742"
}
]
}
],
"has_more": true,
"page_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1161401 | Incorrect parameter type | 请检查字符串、数字等的参数类型 |
| 400 | 1161402 | Incorrect parameter range | 请检查数字类型参数是否超出约定范围 |
| 400 | 1161403 | Incorrect parameter length | 请检查List,Map等容器类型参数 |
| 400 | 1161404 | Missing or invalid parameter | 请检查参数是否有效 |
| 400 | 1161406 | Parameter exceeds the optional range | 请检查枚举类参数的可选范围 |
| 500 | 1161501 | System internal error | 请参考详细错误信息,如有问题请咨询技术支持 |
