管理员获取所有关联组织列表
在创建规则时,需要知道对方组织的tenant key,可通过该接口获取有效的tenant key。只允许关联组织管理员权限调用。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/directory/v1/collaboration_tenants |
| 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 获取查询结果 示例值:g102aggaEYLRMSHU6DENYI4HMBAJB75XOQN2CUTV |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | collaboration_tenant\[\] | 对方的关联组织信息 |
└ tenant_key | string | 关联组织列表 |
└ connect_time | int | 建联时间 |
└ avatar | image_link | 租户头像 |
└ avatar_72 | string | 72*72像素头像链接 |
└ avatar_240 | string | 240*240像素头像链接 |
└ avatar_640 | string | 640*640像素头像链接 |
└ avatar_origin | string | 原始头像链接 |
└ brand | string | 租户品牌 |
└ name | i18n_text | i18n文本 |
└ default_value | string | 默认值 |
└ i18n_value | map<string, string> | 国际化值,key为zh_cn, ja_jp, en_us, value为对应的值 |
└ short_name | i18n_text | i18n文本 |
└ default_value | string | 默认值 |
└ i18n_value | map<string, string> | 国际化值,key为zh_cn, ja_jp, en_us, value为对应的值 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"tenant_key": "121s121234df",
"connect_time": 1724296400,
"avatar": {
"avatar_72": "http://qwed.com",
"avatar_240": "http://wssd.com",
"avatar_640": "http://wssd.com",
"avatar_origin": "https:inernal-api/image"
},
"brand": "feishu",
"name": {
"default_value": "张三",
"i18n_value": {
"en_us": "test"
}
},
"short_name": {
"default_value": "张三",
"i18n_value": {
"en_us": "test"
}
}
}
],
"page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
"has_more": true
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 2223109 | page_token is invalid | 请选择有效的page_token |
| 400 | 2224001 | No permission to operate | 需要有关联组织管理员的权限,请联系本租户超管将你配置为关联组织管理员 |
