文档

在飞书中绑定Quick BI微应用

更新时间:

Quick BI支持添加飞书用户为组织成员。在实际应用时,组织管理员可以绑定Quick BI飞书微应用并给飞书接口授权。本文为您介绍如何进行飞书接口授权。

前提条件

您已下载并注册飞书。

使用限制

仅专业版支持该功能。

步骤一:在飞书中创建自建微应用

  1. 登录飞书开放平台,单击创建应用

    添加应用
  2. 创建应用页面,选择企业自建应用,并填入应用名称、应用描述和应用图标后,单击确定创建

    创建应用
  3. 企业自建应用列表中,单击目标应用的名称,进入应用详情页面。

    应用详情
  4. 单击左侧导航栏的凭证与基础信息,在应用凭证区域,获取App IDApp Secret

    获取凭证

步骤二:在飞书中配置自建微应用

用于配置微应用的域名、重定向URL和应用所需的权限。

  1. 单击左侧导航栏的应用功能网页,按照下图操作,配置自建应用(Quick BI应用)主页的域名。

    image
  2. (可选)

    单击左侧导航栏的应用功能机器人,按照下图操作,开通飞书机器人。

    若您选择飞书通知、飞书群的方式接收订阅或告警信息时,需要开启飞书机器人。飞书机器人

  3. 单击左侧导航栏的安全设置,按照下图指引,配置应用安全。

    配置应用安全

    配置应用安全时,您需要在重定向URL中添加用于登录验证的URL和用于用户绑定的URL:

    • 登录验证的URL:<Quick BI服务域名>/authx/feishu/identity/verify

    • 用户绑定的URL:<Quick BI服务域名>/api/v2/organization/feishu/binding

    Quick BI服务域名,以具体环境域名为准。例如:Quick BI公共云环境域名为bi.aliyun.com;Quick BI金融云环境域名为bi-finance.aliyun.com,则:

    • 登录验证的URL为https://bi.aliyun.com/authx/feishu/identity/verify

    • 用户绑定的URL为https://bi.aliyun.com/api/v2/organization/feishu/binding

    添加域名

  4. 单击左侧导航栏的权限管理,按照下图指引,配置应用权限。

    配置应用权限

    配置应用权限时,需要参考以下权限进行配置:

    • 必须配置以下权限:

      • 基础权限:

        • 获取用户user ID

        • 获取用户基本信息

        • 获取企业信息

        • 获取用户组织架构信息

        • 获取部门组织架构信息

        • 获取部门基础信息

        • 获取用户组信息

        • 更新用户组信息

        • 以应用身份访问通讯录(历史版本)

        • 以应用身份读取通讯录

      • 飞书通知权限

        • 选择飞书通知的方式接收监控告警时,必须配置以下权限:

          • 获取与发送单聊、群组消息

          • 给多个用户批量发消息

        • 选择飞书通知的方式接收订阅时,必须配置以下权限:

          • 获取与发送单聊、群组消息

          • 给多个用户批量发消息

          • 获取上传图片或文件资源

      • 飞书群权限

        • 选择飞书群的方式接收监控告警时,无需额外配置权限。

        • 选择飞书群的方式接收订阅时,必须配置以下权限:

          • 获取上传图片或文件资源

    • 可能会用到的权限:

      • 获取用户邮箱信息

      • 获取用户手机号

      • 通过手机号或邮箱获取用户ID

      • 获取用户雇佣信息

      • 搜索用户

    已添加权限的列表见下图。添加权限如果用户需要升级权限,请参见升级用户权限

  5. 单击左侧导航栏的应用发布版本管理与发布,按照下图指引,创建版本。

    企业自建应用若要供企业内其他用户使用,或应用目录应用若要上架飞书应用目录,都必须发布一个版本。

    您可以单击创建版本点击创建,进行创建版本。创建版本

  6. 版本详情页面,配置以下参数,并单击保存

    版本详情

    参数

    描述

    示例

    应用版本号

    设置微应用的版本号。

    1.0.0

    PC客户端默认的应用功能

    您通过工作台访问应用时打开的功能。

    网页

    更新说明

    对微应用版本变更的说明。

    可用性状态

    支持修改为指定人员或企业所有员工。

    更新应用版本号时,若权限不敏感建议将可用性状态调整为所有员工

    所有员工

    说明

    本文的后续操作中,系统会将飞书的通讯录同步至Quick BI中,故本示例必须选择所有员工

  7. 配置完成后,单击申请发布

    申请发布

    则应用状态更新为审核中状态

步骤三:在管理后台审核并配置微应用

  1. 超级管理员登录管理后台,审核应用。

    1. 在顶部菜单栏单选择九宫格管理后台,进入飞书管理后台。

      进入配置后台
    2. 在左侧导航栏选择工作台应用审核,在应用审核页面单击通过

      审核
  2. 在左侧导航栏单击应用管理,在已安装的应用中,找到目标应用并单击操作列的配置

    配置应用

    确保应用可用成员全员成员4

升级用户权限

在飞书管理后台,在左侧导航栏单击安全用户权限,可以针对组织架构的可见范围进行升级。

步骤四:在Quick BI中绑定飞书

  1. 登录Quick BI控制台

  2. 在Quick BI首页,按照下图指引,配置接口信息。

    飞书接口授权_4.3
  3. 填入AppIdAPPSecret,并单击保存

后续步骤

配置完成后,您可以在Quick BI中绑定飞书账号,将飞书账号所在的组织通讯录体系同步到Quick BI。请参见添加飞书账号为组织成员