组织云钉钉API
  1. 角色管理
组织云钉钉API
  • 服务端API
    • 如何调用服务端API
    • 服务端SDK下载
    • 获取凭证(access_token)
      • 获取企业内部应用的access_token
      • 获取jsapi_ticket
    • 身份验证(免登)
      • 企业内部应用免登
      • 免登常见问题
    • 通讯录管理
      • 通讯录事件
      • 用户管理
        • 创建用户
        • 更新用户信息
        • 删除用户
        • 根据userid获取用户详情
        • 获取部门用户基础信息
        • 获取部门用户userid列表
        • 获取部门用户详情
        • 获取员工人数
        • 获取未登录钉钉的员工列表
        • 根据手机号获取userid
        • 根据unionid获取用户userid
        • 获取管理员列表
        • 获取管理员通讯录权限范围
        • 获取管理员的应用管理权限
      • 部门管理
        • 获取部门详情
        • 获取部门列表
        • 获取子部门ID列表
        • 获取指定部门的所有父部门列表
        • 获取指定用户的所有父部门列表
      • 角色管理
        • 删除角色
          POST
        • 创建角色
          POST
        • 创建角色组
          POST
        • 更新角色
          POST
        • 批量增加员工角色
          POST
        • 批量删除员工角色
          POST
        • 设定角色成员管理范围
          POST
        • 获取角色组列表
          POST
        • 获取角色列表
          POST
        • 获取角色详情
          POST
        • 获取指定角色的员工列表
          POST
    • 消息通知
      • 消息通知概述
      • 消息类型与数据格式
      • 消息链接说明
      • 工作通知
        • 发送工作通知
        • 更新工作通知状态栏
        • 获取工作通知消息的发送进度
        • 获取工作通知消息的发送结果
        • 撤回工作通知消息
      • 普通消息
        • 发送普通消息
  • 钉钉回调相关
    • 钉钉Stream回调
    • 事件订阅列表
  1. 角色管理

获取角色列表

POST
/topapi/role/list
企业内部应用第三方企业应用oapi

说明#

调用本接口获取角色列表。
服务地址:https://oapi.dingtalk.com

权限#

服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。详情请参考获取通讯录权限范围。
应用类型是否支持调用权限申请方式API Explorer调试
企业内部应用是开发者后台申请调试
第三方企业应用是开发者后台申请调试
第三方个人应用否——

请求参数

Query 参数
access_token
必需
调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。
示例值:
6ed1bxxx
Body 参数application/json
size
number 
可选
支持分页查询,与offset参数同时设置时才生效,此参数代表分页大小,默认值20,最大值200。
offset
number 
可选
支持分页查询,与size参数同时设置时才生效,此参数代表偏移量,偏移量从0开始。
示例
{
        "size":"20",
        "offset":"0"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/topapi/role/list?access_token=6ed1bxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
        "size":"20",
        "offset":"0"
}'

返回响应

🟢200成功
application/json
Body
request_id
string 
请求ID。
可选
errcode
number 
返回码。
可选
errmsg
string 
返回码描述。
可选
result
object 
结果列表。
可选
hasMore
boolean 
是否还有更多数据。
可选
list
array [object {3}] 
角色组列表。
可选
示例
{
    "request_id": "string",
    "errcode": 0,
    "errmsg": "string",
    "result": {
        "hasMore": true,
        "list": [
            {
                "name": "string",
                "groupId": 0,
                "roles": [
                    {
                        "name": "string",
                        "id": 0
                    }
                ]
            }
        ]
    }
}
修改于 2023-12-26 06:53:24
上一页
获取角色组列表
下一页
获取角色详情
Built with