飞书集成支持同步飞书通讯录到到Qoder CN企业,并提供单点登录和消息通知功能。
适用版本 | 专属版 |
创建范围外用户
企业管理员可以在中配置和管理飞书集成。如需要创建不在飞书同步范围的用户,可以勾选支持内建用户选项。
配置飞书集成信息
步骤一 配置组织内部应用
首先在飞书开放平台上创建组织内部Qoder CN应用,可参考查看如何创建企业自建应用,填写创建表单信息,单击确定创建。
弹窗中需填写名称(最多 32 字符)、应用描述(最多 120 字符),并设置应用图标(支持 JPEG/PNG/SVG/BMP 格式,2 MB 以内,大于 240×240 px),完成后单击创建。
当应用创建好后将可以在中查看 App ID 和 App Secret。
将飞书应用凭证中 App ID、App Secret 粘贴到输入框。
组织内部应用中的信息都填写完成后,单击下一步。
步骤二 配置应用权限
Qoder CN需要获取飞书的相应权限,才能够同步飞书通讯录、通过飞书登录或推送飞书消息通知,所需权限如下:
通讯录管理 | 获取通讯录基本信息 |
获取部门基础信息 | |
获取通讯录部门组织架构信息 | |
获取用户基本信息 | |
获取用户组织架构信息 | |
获取用户邮箱信息 | |
获取用户 user ID | |
获取个人邮箱信息 | |
消息与群组 | 获取发送单聊、群组消息 |
在飞书开放平台的企业应用详情页面权限管理中配置权限,并根据需要限制飞书通讯录同步的用户范围。
步骤三 配置信息同步与映射
账号绑定方式:自动绑定邮箱相同的用户,按照同步策略,自动将Qoder CN上、飞书组织中邮箱账号相同的用户绑定在一起。
Qoder CN将按照下方字段映射关系,自动将飞书的用户信息与Qoder CN中的用户信息,按照同步策略进行映射同步,目前暂不支持修改字段映射关系,确认后单击下一步。
默认字段映射关系为:姓名对应name(默认开启)、邮箱对应email(默认开启)、手机对应mobile、部门对应department_ids(默认开启)、工号对应employee_no、昵称对应nickname。
步骤四 开启飞书集成的功能服务
目前提供 4 种功能服务:
用户和组织同步。
单点登录。
消息通知。
飞书客户端内访问Qoder CN。
以上 4 种功能服务在配置过程中默认不开启,如果不开启功能的情况下保存飞书集成配置,后续可以在飞书集成详情页面中开启对应的功能服务。
如果选择开启对应功能的情况下,需要进行相关配置(以下内容适用于修改对应功能配置)。
开启飞书的用户和组织同步
当Qoder CN上未开启其他第三方集成的用户和组织同步功能时,可以配置飞书的用户和组织同步,支持配置同步时机、用户差异处理、组织差异处理的规则。
数据同步时机:默认为手动同步,并支持手动同步、定时同步的切换:
手动同步:需要企业管理员在有数据变更后,手动在飞书集成详情页面单击执行手动同步按钮完成用户和组织同步。
说明提示:每次手动同步操作尽量间隔 1 个小时。
定时同步:配置同步的时机和规则按每天(某刻)、每周(某天某刻)、每月(某天某刻)、每隔一定时间进行同步,如果设置为定时同步,建议保存配置后完成一次手动同步,以保证数据可以及时同步至Qoder CN。
用户差异处理:默认忽略Qoder CN上多余的账号,并为在同步范围内的飞书账号创建Qoder CN账号并绑定,可根据诉求修改。
已有Qoder CN账号未匹配到飞书账号-忽略:当已有Qoder CN账号未匹配到飞书账号时,不删除Qoder CN上的多余账号。
已有Qoder CN账号未匹配到飞书账号-删除Qoder CN账号:当已有Qoder CN账号未匹配到飞书账号时,删除Qoder CN上的账号。
已有飞书账号未匹配到Qoder CN账号-忽略:当已有飞书账号未匹配到Qoder CN账号时,不在Qoder CN上创建新账号。
已有飞书账号未匹配到Qoder CN账号-新建Qoder CN账号并绑定:当已有飞书账号未匹配到Qoder CN账号时,会按照账号绑定和属性映射规则在Qoder CN上创建新账号,并与飞书账号绑定。
组织差异处理:默认忽略Qoder CN上多余的部门节点,并且为在同步范围内的飞书部门节点创建Qoder CN部门并绑定,可根据诉求修改:
已有Qoder CN部门未匹配到飞书部门-忽略:当已有Qoder CN部门未匹配到飞书部门时,不删除Qoder CN上的部门节点。
已有Qoder CN部门未匹配到飞书部门-删除Qoder CN部门:当已有Qoder CN部门未匹配到飞书部门时,删除Qoder CN上的部门节点。
已有飞书部门未匹配到Qoder CN部门-忽略:当已有飞书部门未匹配到Qoder CN部门时,不在Qoder CN上创建部门节点。
已有飞书部门未匹配到Qoder CN部门-创建Qoder CN部门并绑定:当已有飞书部门未匹配到Qoder CN部门时,会在Qoder CN上创建部门节点,并将两方部门节点进行绑定。
开启单点登录
打开单点登录的开关后,需要将Qoder CN的回调地址配置在第一步创建的飞书应用的应用详情-安全设置-重定向 URL 的输入框,即可完成飞书单点登录的配置。
回调请求地址为 https://yunxiao-dev.devops.aliyun.com/users/callback/lark,单击旁边的复制图标复制该地址后粘贴到飞书应用的重定向 URL 输入框中。
开启消息通知
打开消息通知的功能,首先需要启用飞书应用中的机器人,然后需要根据诉求选择消息通知的方式,目前支持 2 种消息通知方式:
通过账号绑定关系:需开启用户和组织同步或单点登录功能,完成Qoder CN账号与飞书通讯录中账号的关系绑定后,对应的飞书账号即可接收到消息通知;
通过邮箱:个人设置中添加飞书绑定的邮箱,即可接收到消息通知。
在飞书开放平台开发者后台,选择左侧边栏应用能力 > 添加应用能力,在按能力添加页签中找到机器人卡片,单击+添加。
开启飞书客户端访问Qoder CN
如果需要通过飞书 PC 客户端的工作台访问Qoder CN,可打开飞书客户端访问Qoder CN的开关,同时需要进入飞书开放平台,在第一步创建的飞书应用的中开启网页应用,把下方的Qoder CN网页地址粘贴到网页应用的桌面端主页输入框中并保存配置。
在完成功能开启配置后,如果需要飞书的功能生效,需要在飞书开放平台中进行应用上线,可在第一步创建的飞书应用的,创建版本并进行应用发布,您可参考飞书开发文档应用发布与使用。
当完成所有配置后,单击保存配置按钮即可完成飞书集成的配置。
通过飞书登录Qoder CN
开启单点登录后,Qoder CN登录页面将显示飞书登录入口,单击该入口,已绑定飞书账号的用户可以通过飞书登录Qoder CN。
查看用户和组织同步结果
在开启用户和组织同步后,打开飞书集成详情页面,可以查看最新同步结果:未执行同步、同步成功、同步失败、部分同步成功。
修改/关闭飞书集成的功能服务
在飞书集成详情页中,如果开启了某个功能服务,可以看到修改服务配置的按钮,单击后即可进行相关功能服务配置的修改或者关闭。
关闭用户和组织同步:
不解除Qoder CN账号与飞书账号的绑定关系。
不再执行飞书通讯录的用户和组织同步。
关闭单点登录:
不会解除Qoder CN账号与飞书账号的绑定关系。
不支持通过飞书账号登录Qoder CN,用户需使用Qoder CN账号和密码进行登录。
关闭消息通知:
如果未配置飞书邮箱,且关闭了用户和组织同步、单点登录功能,将关闭消息通知功能。
关闭后,不再通过飞书发送消息通知。
关闭飞书客户端访问Qoder CN:
不支持通过飞书桌面端工作台直接访问Qoder CN。
移除飞书集成
在飞书集成详情页中,单击移除集成按钮,确认后即可移除,移除后:
解除Qoder CN账号和飞书账号的绑定,不会影响已同步的用户和组织架构信息。
不再接收飞书消息通知。
无法通过飞书登录Qoder CN,需使用Qoder CN账号和密码登录。