集成飞书
1.适用版本
此文档仅适用于「企业版-私有部署」的 ONES 系统 v3.6及以后的版本
适用版本 | 企业版-私有部署 |
2.功能入口
管理员可在系统「团队配置中心」(多团队下「组织管理」)>「帐号集成」页面,点击「添加帐号集成」并选择「飞书」进行添加集成配置。
配置步骤
3.1 添加飞书
私有部署版用户,需要通过创建飞书自建应用的方式实现 ONES 与飞书的集成。
飞书自建应用开发流程
3.1.1 填写应用信息
在「添加飞书」页面,按照提示填写 App ID 和 App Secret。
获取 App ID 和 App Secret:打开「飞书开发平台」进入对应的自建应用,从「凭证与基础信息」中获取,如下图所示。
3.1.2 配置应用权限
在「添加飞书 - 配置应用权限」中,查看需要的应用权限并完成飞书应用权限配置。
在飞书应用中添加权限:在飞书「权限管理」中添加权限。
3.1.3 配置网页
为实现在飞书内打开系统页面,需要在「添加飞书 - 配置网页」中,将桌面端主页和移动端主页分别复制并添加到飞书应用配置中。
配置桌面端主页和移动端主页:进入飞书「应用功能」>「网页应用」(如没有,需要先「添加应用能力」>「网页应用」),将以下信息复制并粘贴到「桌面端主页」和「移动端主页」中。
3.1.4 配置重定向URL
在【添加飞书 - 配置应用权限】中,将绑定企业重定向URL和登陆重定向URL复制并添加到飞书应用配置中。
在飞书应用添加URL:进入飞书「安全设置」,将上述URL依次添加到「重定向URL」中。
3.1.5 选择帐号绑定方式
「帐号绑定方式」用于匹配飞书帐号和ONES系统已有帐号,具体规则可查看帐号绑定方式。
3.1.6 用户属性映射
用于设置从飞书同步的用户属性字段,以及飞书属性字段和系统属性字段的映射关系,目前系统支持同步的字段包含:用户名、邮箱、工号、公司、职位
注意:需要保证用户的邮箱、工号是企业唯一的
查看飞书属性字段:进入「飞书开发平台」>「开发文档」>「服务端文档」,查看「通讯录 - 获取单个用户信息」中「响应体」提供的属性字段
飞书属性字段参考
字段名 | 描述 |
---|---|
name | 用户名 |
邮箱 | |
employee_no | 工号 |
job_title | 职位 |
3.2 配置集成功能
添加集成后,进入【飞书详情】 可以选择需要启用集成功能。
3.2.1 启用「用户目录同步」
启用「用户目录同步」可以获取飞书“组织架构”的成员和部门。在【飞书详情】 > 【用户目录同步】页面,点击「配置同步」进入【配置同步】页面,选择同步方式。
- 定时同步:每10分钟ONES系统会从飞书获取一次最新的成员和部门数据;
- 事件消息同步:当飞书组织架构数据发生变动时,ONES系统会从飞书获取一次最新的成员和部门数据。
开启「事件消息同步」需要先将ONES系统提供的Encrypt Key、Verification Token、请求网址 URL复制并粘贴到飞书自建应用中。
配置Encrypt Key、Verification Token、请求网址 URL:进入「飞书开发平台」>「应用详情」>「事件订阅」,将Encrypt Key、Verification Token和请求网址 URL复制并粘贴到飞书自建应用中,如下图所示。
添加事件消息:配置网址URL后,需要在「事件订阅」中添加「接收消息」、「用户和机器人的会话首次被创建」和「通讯录变更」事件。
配置完成后,点击「启用」即可启用「用户目录同步」。
3.2.2 启用「登录验证」
启用「登录验证」后,已绑定飞书账号的ONES用户(提示:用户如何绑定第三方账号)通过飞书扫码登录ONES系统。在【飞书详情】>【登录验证】点击「启用」,即可开启登录验证。
启用「登录验证」后,系统登陆页面将显示「飞书」登陆入口,点击可以进入飞书扫码登陆页面,如下图所示。也可以通过「登陆链接」直接打开飞书扫码登陆页面。
启用「登录即时创建成员」后,新用户通过「飞书」登录到系统时,会自动创建帐号并同步用户数据
注意:在「多团队」模式下,需要选择新用户默认加入的团队
3.2.3 启用「消息通知」
启用「消息通知」可以允许用户在「飞书」接收系统消息通知,启用飞书消息通知前,需要先在飞书添加「应用能力」>「机器人」,并根据提示进行配置。
启用机器人后,在【飞书详情】>【消息通知】点击「启用」,即可开启消息通知。
注意:启用消息通知后,需要在「项目管理」、「知识库管理」等产品的配置中添加通知方式,具体可查看 如何添加通知方式
3.3 移除集成
在【飞书详情】点击「移除集成」,在确认弹窗输入“移除飞书”即可移除集成,集成移除后,从飞书获取的部门和已激活邮箱的用户将会保留,未激活邮箱的用户将会被清除。