绑定飞书

本文介绍绑定飞书的操作步骤和常见用法。

实现场景

绑定飞书后,您可以使用下述能力。

分类

实现能力

账户

  • 将飞书通讯录数据全量同步到IDaaS EIAM(包含定时校验)。

  • 将飞书通讯录数据增量同步到IDaaS EIAM(未来支持)。

登录

  • 使用飞书扫码登录IDaaS EIAM或其中的应用。

  • 在飞书工作台免登到IDaaS EIAM或其中的应用。

绑定飞书

身份提供方菜单中,单击其他身份提供方 > 飞书,即可开始绑定流程。

image

第一步:应用权限配置

重要

飞书对应用权限有较为细致的要求,部分权限需要管理员审批并发布应用后才可生效,您可能需要企业其他管理员协助。缺少权限将无法使用数据同步等能力,建议完成本步骤权限配置后,再进行后续绑定操作。

1、创建飞书应用

前往飞书开放平台,登录开发者后台。在开发者后台中创建企业自建应用。

image

完成创建后,将自动进入飞书应用详情页。点击凭证与基础信息菜单,获取 App IDApp Secret,并填写到 IDaaS 中。

image

image

2、分配飞书 API 权限

在飞书应用详情页,点击权限管理菜单,在 API 权限中,分别进行如下授权。这些均属于通讯录的查询权限,以实现数据同步和用户登录。

image

权限名称

权限值

特殊说明

获取通讯录基本信息

contact:contact.base:readonly

--

获取用户 user ID

contact:user.employee_id:readonly

--

获取部门基础信息

contact:department.base:readonly

--

获取通讯录部门组织架构信息

contact:department.organize:readonly

申请权限后需提交版本发布申请并通过审核才可生效

获取用户基本信息

contact:user.base:readonly

--

获取用户组织架构信息

contact:user.department:readonly

申请权限后需提交版本发布申请并通过审核才可生效

获取用户邮箱信息

contact:user.email:readonly

该权限非强制要求,只有您希望同步该字段数据到 IDaaS 时才需分配

获取用户手机号

contact:user.phone:readonly

申请权限后需提交版本发布申请并通过审核才可生效

该权限非强制要求,只有您希望同步该字段数据到 IDaaS 时才需分配

说明

提交发布申请后,将在飞书中通知管理员,管理员需要在飞书管理后台中进行审核。

3、分配飞书数据权限

权限管理 > 数据权限中,选择通讯录权限范围进行数据权限授权。这个范围决定哪些用户、组织数据可以同步到 IDaaS 并使用飞书登录。

image

4、在 IDaaS 中提交

完成上述权限配置后,在 IDaaS 中点击下一步,IDaaS 将检查对应的 API 权限和数据权限。具备所有必需的权限后,即可进入到下一步。

image

第二步:开发配置

1、填写基础信息

填写显示名称和企业编号等基础信息。

image

企业编号需要在飞书管理后台中获取。

image

2、配置开发信息

image

重定向 URL:该地址用于处理用户登录请求。请在飞书应用详情的安全设置 > 重定向 URL中填入 URL。

image

应用主页:如果您希望用户在飞书工作台中可以免登到 IDaaS 用户门户,则需要配置该主页。请在飞书应用详情的添加应用能力中,添加网页应用

image

完成添加后,在桌面端主页和移动端主页中填入该 URL。

image

若您希望网络有请求 IP 限制,请复制 IDaaS 的出口 IP 列表,加入飞书应用安全设置 > IP 白名单中,通过批量修改填写。

image

通过专属端点,您也可以使用专属的 IP 实现飞书的数据同步和委托认证,专属端点介绍请参考:网络端点

完成配置后,点击下一步。

第三步:选择场景

在第三步中,选择希望使用的场景能力。

image

能力说明

  • 同步目标:飞书的通讯录数据将会导入到 IDaaS 的这个节点之下。

  • 定时校验:IDaaS将于每日凌晨自动全量同步企业微信来源节点下的全量数据。未来将支持增量同步能力。

    • 您可以在字段映射中设置映射标识,使用 IDaaS 账户的某个字段(如账户名)与飞书用户的某个字段(如userid)进行匹配,如果匹配成功,将绑定并覆盖更新;否则将创建 IDaaS 账户。

    • 如果需要及时同步数据,请手动触发全量同步。

    • IDaaS 内置了同步保护能力, 当 30 个以上的账户或 10 个以上的组织需要被删除时,自动取消同步任务,以防止数据被误删除。建议根据企业规模调整同步保护设置。

  • 扫码登录:开启后,会在登录菜单中创建飞书扫码登录,并处于启用状态,可直接扫码登录。如果在上一步配置了应用主页,则支持在飞书工作台中免登到 IDaaS。

第四步:字段映射

如果您在 IDaaS 中已存在存量数据,需要飞书成员/部门和IDaaS账户/组织绑定,或者希望使用飞书中成员的某些字段数据作为 IDaaS 账户的数据,例如将飞书用户的姓名作为IDaaS账户的显示名,则需要在第四步配置字段映射。

image

重要

飞书中的用户 ID(即userid)作为飞书用户的唯一标识,可以被修改。由于此字段是 IDaaS 能唯一依赖的主键,如果该字段被修改,将导致对应的 IDaaS 账户被删除并重新创建,请谨慎修改。

管理飞书身份提供方

完成绑定后,会自动跳转到身份提供方菜单中。您可在此处对与身份提供方联动的不同功能进行管理。

image