查询可搜可见规则

管理员视角查询可搜可见规则。用户需具备关联组织管理员权限。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/directory/v1/collaboration_rules
HTTP Method	GET
接口频率限制	100 次/分钟
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	trust_party:collaboration_rule:read 获取关联组织协作规则

请求头

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

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小 示例值：10 默认值：100 数据校验规则： - 取值范围：0 ～ 100
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=
target_tenant_key	string	是	对方组织的tenant key，可通过管理员获取所有关联组织列表获取 示例值：test_key

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	collaboration_rule\[\]	规则列表
└ rule_id	string	规则ID
└ subjects	collaboration_rule_entities	实体数量之和需要小于100
└ open_user_ids	string\[\]	用户 open id
└ open_department_ids	string\[\]	部门 open id，0代表全部成员
└ open_group_ids	string\[\]	用户组 open id
└ subject_is_valid	boolean	是否生效，如果规则主体超出了分享的范围，则is_valid为false，规则主体将不返回
└ objects	collaboration_rule_entities	实体数量之和需要小于100
└ open_user_ids	string\[\]	用户 open id
└ open_department_ids	string\[\]	部门 open id，0代表全部成员
└ open_group_ids	string\[\]	用户组 open id
└ object_is_valid	boolean	是否生效，如果规则客体超出了分享的范围，则is_valid为false，规则客体将不返回
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "rule_id": "12121",
                "subjects": {
                    "open_user_ids": [
                        "od-112121"
                    ],
                    "open_department_ids": [
                        "od-12121212"
                    ],
                    "open_group_ids": [
                        "od-12121"
                    ]
                },
                "subject_is_valid": true,
                "objects": {
                    "open_user_ids": [
                        "od-112121"
                    ],
                    "open_department_ids": [
                        "od-12121212"
                    ],
                    "open_group_ids": [
                        "od-12121"
                    ]
                },
                "object_is_valid": true
            }
        ],
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	2223109	page_token is invalid	请填写正确的page_token
400	2224001	No permission to operate	无操作权限，请联系超管配置你为关联组织管理员