Skip to content

获取关联组织详情

基于组织tenant key获取关联组织详情,需要对对方组织有可见权限才可以获取。

提示

使用 user_access_token 时,按照 admin 管理后台关联组织列表中针对用户设置的可见性规则进行校验,使用 tenant_access_token 时,按照应用互通界面中针对应用设置的可见性规则进行校验。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/trust_party/v1/collaboration_tenants/:target_tenant_key
HTTP MethodGET
接口频率限制5 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用trust_party:collaboration.tenant:readonly 以应用身份读取关联组织

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

名称类型描述
target_tenant_keystring对方关联组织的tenant key,可通过管理员获取所有关联组织列表获取
示例值:"4e6ac4d14bcd5071a37a39de902c7141"

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ target_tenantcollaboration_tenant对方关联组织详情
    └ tenant_keystring关联组织的租户ID
    └ tenant_namestring目标组织的名称
    └ i18n_tenant_namei18n_name目标组织的i18n名称
      └ zh_cnstring中文名
      └ ja_jpstring日文名
      └ en_usstring英文名
    └ tenant_short_namestring目标组织的简称
    └ i18n_tenant_short_namei18n_name目标组织的i18n简称
      └ zh_cnstring中文名
      └ ja_jpstring日文名
      └ en_usstring英文名
    └ connect_timeint关联时间
    └ tenant_tagstring标签
    └ i18n_tenant_tagi18n_namei18n标签
      └ zh_cnstring中文名
      └ ja_jpstring日文名
      └ en_usstring英文名
    └ avataravatar_info组织icon信息
      └ avatar_72string72*72像素头像链接
      └ avatar_240string240*240像素头像链接
      └ avatar_640string640*640像素头像链接
      └ avatar_originstring原始头像链接
    └ brandstring组织品牌

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "target_tenant": {
            "tenant_key": "abcd",
            "tenant_name": "name",
            "i18n_tenant_name": {
                "zh_cn": "zh_cn_name",
                "ja_jp": "ja_jp_name",
                "en_us": "en_name"
            },
            "tenant_short_name": "tenant_short_name",
            "i18n_tenant_short_name": {
                "zh_cn": "zh_cn_name",
                "ja_jp": "ja_jp_name",
                "en_us": "en_name"
            },
            "connect_time": 1671107493,
            "tenant_tag": "协作",
            "i18n_tenant_tag": {
                "zh_cn": "zh_cn_name",
                "ja_jp": "ja_jp_name",
                "en_us": "en_name"
            },
            "avatar": {
                "avatar_72": "https://foo.icon.com/xxxx",
                "avatar_240": "https://foo.icon.com/xxxx",
                "avatar_640": "https://foo.icon.com/xxxx",
                "avatar_origin": "https://foo.icon.com/xxxx"
            },
            "brand": "feishu"
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
4001971001User not visible to target tenant.配置用户对关联组织的可见性,请更新可搜可见规则来让用户对关联组织可见
4001971007App not visible to target tenant.配置应用对关联组织的可见性,请在应用设置内选择关联组织可用并圈选希望能使用的关联组织人员

内容来源:飞书开放平台 · 自动爬取整理