文档中心 > API类目 > 钉钉API

dingtalk.oapi.authorization.rbac.role.query (批量查询管理组信息)

批量查询管理组信息

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
agent_id	String	必须	微应用agenId,需要联系权限平台配置		微应用agenId,需要联系权限平台配置
open_role_ids	String []	必须	管理组id	最大列表长度：999	管理组id

响应参数

名称	类型	示例值	描述
result	DingOpenResult	响应结果	响应结果
result OpenEamRoleVo [] 响应结果响应结果 └ open_role_id String rolexxx 管理组id └ open_role_name String IT管理组管理组名称 └ open_resources String [] aa.bb.* 管理组授权的资源 open_action OpenActionVo openAction openAction └ action_ids String [] actionIds actionIds open_conditon OpenConditionVo 约束条件约束条件 open_contact_scope OpenContactScopeVo 通讯录约束条件通讯录约束条件 └ dept_ids Number [] 被授权人可管理的部门列表被授权人可管理的部门列表 └ userids String [] 被授权人可管理的员工列表被授权人可管理的员工列表 └ include_member_depts Boolean false 被授权人所在部门 └ include_self_manage_depts Boolean false 被授权人所能管理的部门 open_members OpenMemberVo [] openMemberVO openMemberVO └ member_type String user member类型 └ member_id String staff001 member id └ belong_corpid String dingxxx member所属组织corpid └ operate_userid String staff002 操作人userid └ success Boolean true 调用是否成功 └ errcode Number 0 errcode └ errmsg String ok errmsg

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/authorization/rbac/role/query");
OapiAuthorizationRbacRoleQueryRequest req = new OapiAuthorizationRbacRoleQueryRequest();
req.setAgentId("微应用agenId,需要联系权限平台配置");
req.setOpenRoleIds("管理组id");
OapiAuthorizationRbacRoleQueryResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/authorization/rbac/role/query");
OapiAuthorizationRbacRoleQueryRequest req = new OapiAuthorizationRbacRoleQueryRequest();
req.AgentId = "微应用agenId,需要联系权限平台配置";
req.OpenRoleIds = "管理组id";
OapiAuthorizationRbacRoleQueryResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiAuthorizationRbacRoleQueryRequest;
$req->setAgentId("微应用agenId,需要联系权限平台配置");
$req->setOpenRoleIds("管理组id");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/authorization/rbac/role/query");

curl -X POST "https://oapi.dingtalk.com/topapi/authorization/rbac/role/query" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=29276c11-0ed5-45f1-bad9-f336539f1e30' \
-d 'agent_id=%E5%BE%AE%E5%BA%94%E7%94%A8agenId%2C%E9%9C%80%E8%A6%81%E8%81%94%E7%B3%BB%E6%9D%83%E9%99%90%E5%B9%B3%E5%8F%B0%E9%85%8D%E7%BD%AE' \
-d 'open_role_ids=%E7%AE%A1%E7%90%86%E7%BB%84id'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiAuthorizationRbacRoleQueryRequest("https://oapi.dingtalk.com/topapi/authorization/rbac/role/query")

req.agent_id="微应用agenId,需要联系权限平台配置"
req.open_role_ids="管理组id"
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.authorization.rbac.role.query");
add_param(pRequest,"agent_id","微应用agenId,需要联系权限平台配置");
add_param(pRequest,"open_role_ids","管理组id");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.authorization.rbac.role.query', {
	'agent_id':'微应用agenId,需要联系权限平台配置',
	'open_role_ids':'管理组id'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "result":[
            {
                    "open_role_id":"rolexxx",
                    "open_role_name":"IT管理组",
                    "open_resources":{
                        "string":[
                            "aa.bb.*"
                        ]
                    },
                    "open_action":{
                        "action_ids":{
                            "string":[
                                "actionIds"
                            ]
                        },
                        "open_conditon":{
                            "open_contact_scope":{
                                "dept_ids":{
                                    "number":[
                                        被授权人可管理的部门列表
                                    ]
                                },
                                "userids":{
                                    "string":[
                                        "被授权人可管理的员工列表"
                                    ]
                                },
                                "include_member_depts":false,
                                "include_self_manage_depts":false
                            }
                        }
                    },
                    "open_members":[
                        {
                                "member_type":"user",
                                "member_id":"staff001",
                                "belong_corpid":"dingxxx",
                                "operate_userid":"staff002"
                        }
                    ]
            }
        ],
        "success":true,
        "errcode":0,
        "errmsg":"ok"
    }
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.authorization.rbac.role.query (批量查询管理组信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ