批量获取角色列表

用于查询飞书人事中的角色列表（对应飞书人事管理后台 - 设置 - 权限设置 - 角色设置中的角色列表），列表内包含角色 ID、名称、状态以及描述等信息。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/corehr/v1/security_groups
HTTP Method	GET
接口频率限制	100 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	corehr:corehr:readonly 获取核心人事信息 corehr:security_group:read 获取角色信息 corehr:corehr 更新核心人事信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

查询参数

名称	类型	必填	描述
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：10
page_size	string	是	分页大小 示例值：100

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	security_group\[\]	查询的用户角色信息
└ id	string	角色ID
└ code	string	角色code，通常用于与其他系统进行交互
└ name	name	角色名称
└ zh_cn	string	中文
└ en_us	string	英文
└ active_status	int	状态，可能值有： - 1 = Inactive / 停用 - 2 = Active / 启用 - 3 = TobeActivated / 待启用
└ description	name	角色描述
└ zh_cn	string	中文
└ en_us	string	英文
└ group_type	int	角色类型 - 3 = 组织类角色 - 7 = 非组织类角色
└ created_by	string	创建人 - 返回"sys"时，表示角色是系统创建角色 - 返回用户ID时，表示是角色是用户自定义角色，可以使用 ID转换服务 换取 飞书人事的employment_id
└ update_time	string	更新时间
└ org_truncation	org_truncation\[\]	组织管理维度
└ org_key	string	组织管理维度名称
└ type	int	下钻类型 - 0 = 对当前管理维度及下级管理维度均有权限 - 1 = 只对当前管理维度有权限，不包含其下级管理维度
└ depth	int	下钻深度
└ has_more	boolean	是否还有更多项
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "id": "7034393015968122400",
                "code": "department_manager",
                "name": {
                    "zh_cn": "cn",
                    "en_us": "en"
                },
                "active_status": 1,
                "description": {
                    "zh_cn": "cn",
                    "en_us": "en"
                },
                "group_type": 1,
                "created_by": "6967639606963471902",
                "update_time": "1",
                "org_truncation": [
                    {
                        "org_key": "department",
                        "type": 0,
                        "depth": 0
                    }
                ]
            }
        ],
        "has_more": true,
        "page_token": "1234452132"
    }
}

错误码

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	1161405	Parameter parsing error	请检查请求体json格式是否正确
400	1161406	Parameter exceeds the optional range	请检查枚举类参数的可选范围
500	1161501	System internal error	请参考详细错误信息，如有问题请咨询技术支持