适用版本 | 专属版 |
飞书集成支持同步飞书通讯录到云效站点的用户管理，同时支持飞书的单点登录、消息通知。
站点管理员可以在站点管理-第三方集成中配置和管理飞书集成。如果需要创建不在飞书同步范围的用户，可以勾选支持内建用户，可以创建同步范围外的用户。
配置飞书集成信息
步骤一 配置企业内部应用
首先，需要在飞书开放平台上创建企业内部云效应用，可参考查看如何创建企业自建应用，可按照下方提示填写创建企业内部应用表单信息，然后单击确定创建。
云效应用图标：
当应用创建好后将可以在应用详情-凭证与基础信息中即可查看 App ID 和 App Secret：
将飞书应用凭证中 App ID、App Secret 粘贴到以下输入框：
企业内部应用中的信息都填写完成后，单击下一步。
步骤二 配置应用权限
云效需要获取飞书的相应权限，才能够同步飞书通讯录、通过飞书登录、或推送飞书消息通知，所需权限如下：
通讯录管理 | 获取通讯录部门组织架构信息 |
获取用户组织架构信息 | |
获取用户邮箱信息 | |
获取用户 user ID | |
通过手机号或邮箱获取用户 ID | |
消息与群组 | 获取发送单聊、群组消息 |
进入飞书开放平台，在第一步已创建的企业应用详情页面-权限管理中配置权限，如果需要限制飞书通讯录同步的用户范围，请配置权限范围。
步骤三 配置信息同步与映射
账号绑定方式：自动绑定邮箱相同的用户，按照同步策略，自动将云效上、飞书组织中邮箱账号相同的用户绑定在一起。
云效将按照下图中字段映射关系，自动将飞书的用户信息与云效中的用户信息，按照同步策略进行映射同步，目前暂不支持修改字段映射关系，确认后单击下一步。
步骤四 开启飞书集成的功能服务
目前提供 4 种功能服务：
用户和组织同步：开启后，可保持云效用户管理中的用户目录和飞书通讯录的同步，建议确认飞书应用可见权限范围;
单点登录：开启后，在云效登录页面中即可快速跳转飞书登录页面，通过飞书登录云效;
消息通知：开启后，可支持飞书消息通知，云效上有消息订阅功能的产品内消息均可触达用户;
飞书客户端内访问云效：开启后，可以通过飞书客户端免登录快速进入云效网页。
以上 4 种功能服务在配置过程中默认不开启，如果不开启功能的情况下保存飞书集成配置，后续可以在飞书集成详情页面中开启对应的功能服务。
如果选择开启对应的功能情况下，需要进行相关配置（以下内容适配于修改对应功能配置）。
开启飞书的用户和组织同步
当云效上未开启其他第三方集成的用户和组织同步功能时，可以配置飞书的用户和组织同步，支持配置同步时机、用户差异处理、组织差异处理的规则。
数据同步时机：默认为手动同步，并支持手动同步、定时同步的切换；
手动同步：需要站点管理员在有数据变更后，手动在飞书集成详情页面单击执行手动同步按钮完成用户和组织同步。
提示：每次手动同步操作尽量间隔 1 个小时。
定时同步：配置同步的时机和规则按每天（某刻）、每周（某天某刻）、每月（某天某刻）、每隔一定时间进行同步，如果设置为定时同步，建议保存配置后完成一次手动同步，以保证数据可以及时同步至云效。
用户差异处理：默认忽略云效上多余的账号且为在同步范围内的飞书账号创建云效账号并绑定，可根据诉求修改；
已有云效账号未匹配到飞书账号-忽略：当已有云效账号未匹配到飞书账号时，不删除云效上的多余账号；
已有云效账号未匹配到飞书账号-删除云效账号：当已有云效账号未匹配到飞书账号时，删除云效上的账号；
已有飞书账号未匹配到云效账号-忽略：当已有飞书账号未匹配到云效账号时，不在云效上创建新账号；
已有飞书账号未匹配到云效账号-新建云效账号并绑定：当已有飞书账号未匹配到云效账号时，会按照账号绑定和属性映射规则在云效上创建新账号，并与飞书账号绑定；
组织差异处理：默认忽略云效上多余的部门节点且为在同步范围内的飞书部门节点创建云效部门并绑定，可根据诉求修改；
已有云效部门未匹配到飞书部门-忽略：当已有云效部门未匹配到飞书部门时，不删除云效上的部门节点；
已有云效部门未匹配到飞书部门-删除云效部门：当已有云效部门未匹配到飞书部门时，删除云效上的部门节点；
已有飞书部门未匹配到云效部门-忽略：当已有飞书部门未匹配到云效部门时，不在云效上创建部门节点；
已有飞书部门未匹配到云效部门-创建云效部门并绑定：当已有飞书部门未匹配到云效部门时，会在云效上创建部门节点，并将两方部门节点进行绑定；
开启单点登录
打开单点登录的开关后，需要将云效的回调地址配置在第一步创建的飞书应用的应用详情-安全设置-重定向 URL 的输入框，即可完成飞书单点登录的配置。
开启消息通知
打开消息通知的功能，首先需要启用飞书应用中的机器人，后需要根据诉求选择消息通知的方式，目前支持 2 种消息通知方式：
通过账号绑定关系：需开启用户和组织同步或单点登录功能，完成云效账号与飞书通讯录中账号的关系绑定后，对应的飞书账号即可接收到消息通知；
通过邮箱：个人设置中添加飞书绑定的邮箱，即可接收到消息通知。
开启飞书客户端访问云效
如果需要通过飞书 PC 客户端的工作台访问云效，可打开飞书客户端访问云效的开关，同时需要进入飞书开放平台，在第一步创建的飞书应用的应用详情-应用功能中开启网页应用，把下方同时云效网页地址粘贴到网页应用的桌面端主页输入框中并保存配置。
在完成功能开启配置后，如果需要飞书的功能生效，需要在飞书开放平台中进行应用上线，可在第一步创建的飞书应用的应用详情-应用发布-版本管理与发布中，创建版本并进行应用发布，可参考飞书开发文档应用发布与使用。
当完成所有配置后，单击保存配置按钮即可完成飞书集成的配置。
通过飞书登录云效
开启单点登录后，云效登录页面将显示飞书登录入口，点击后可进入飞书登录页面，已绑定飞书账号的用户可以通过飞书登录云效。
查看用户和组织同步结果
在开启用户和组织同步的情况下，打开飞书集成详情页面，可以查看最新同步结果：未执行同步、同步成功、同步失败、部分同步成功。
修改/关闭飞书集成的功能服务
在飞书集成详情页中，如果开启了某个功能服务，可以看到修改服务配置的按钮，点击后即可进行相关功能服务配置的修改或者关闭该功能：
关闭用户和组织同步：
不解除云效账号与飞书账号的绑定关系;
不再执行飞书通讯录的用户和组织同步。
关闭单点登录：
不会解除云效账号与飞书账号的绑定关系；
不支持通过飞书账号登录云效，用户若需要登录云效，可使用云效的登录账号和密码进行登录。
关闭消息通知：
如果没有配置飞书邮箱的情况下，同时关闭了用户和组织同步、单点登录功能，将关闭消息通知功能；
关闭后，不会再通过飞书给用户发送消息通知。
关闭飞书客户端访问云效：
不支持通过飞书桌面端工作台直接访问云效。
移除飞书集成
在飞书集成详情页中，可单击移除集成按钮，二次确认后即可移除飞书集成，移除集成后：
解除云效账号和飞书账号的绑定关系，不会影响已同步的用户和组织架构信息；
不支持接收飞书消息通知；
不支持通过飞书登录云效，用户若需要登录云效，可使用云效的登录账号和密码进行登录。
