列出角色接口 - 简道云

列出角色接口调试

1. 简介

1.1 接口简介

将角色列出来。支持公共模式和集成模式。

1.2 接口版本

接口版本	更新时间	版本说明
v2	2022.4.8	初始版本：角色使用 role_no 角色组使用 group_no 包含 integrate_id、type 字段
v4	2022.6.30	返回值新增字段 status
v5	2022.10.28	在 v4 的基础上，接口请求频率由 5 次/秒提升至 30 次/秒；接口路由修改为 POST corp/role/list

2. 接口调用

将角色列出来。支持公共模式和集成模式。

请求地址：https://api.jiandaoyun.com/api/v5/corp/role/list

请求频率：30 次/秒

请求方式：POST

请求参数：

参数	类型	是否必需	说明
skip	Number	否	偏移量
limit	Number	否	limit，不传递时默认值为 1
has_internal	Boolean	否	是否包含自建角色默认为 true
has_sync	Boolean	否	是否包含集成角色默认为 true

请求示例：

{
    "skip": 0,
    "limit": 3,
    "has_internal": true,
    "has_sync": true
}

响应内容：

参数	类型	是否必需	说明
role_no	Number	是	角色编号
group_no	Number	否	角色组编号
name	String	是	角色名称
type	Number	是	角色类型, 若为 0 则表示为常规角色, 若为 2 则表示为企业互联外部角色
status	Number	是	成员状态： 0: 未确认的成员 1: 已加入
integrate_id	String	否	集成模式同步角色关联 ID，仅在集成模式下返回

响应示例：

{
    "roles": [
        {
            "role_no": 3,
            "group_no": 2547,
            "name": "设计中心",
            "type": 0,
            "status": 1
        },
        {
            "role_no": 2551,
            "group_no": 2550,
            "name": "销售总监",
            "type": 0,
           "status": 1
        },
        {
            "role_no": 2552,
            "group_no": 2550,
            "name": "销售主管",
            "type": 0,
           "status": 1
        }
    ]
}