配置飞书同步
# 前言
配置 IM 同步流程如下:
- 登陆 IM 后台创建应用,拿到对应的 key 与 secret。
- 配置权限,根据文档说明配置对应的权限。
- 配置字段关联关系,参考此文档配置关联关系:详情参考
- 执行同步时:先同步分组,再同步用户。如果同步失败,通过浏览器右键检查,查看失败原因。
再次提醒如下信息:
警告
- 请注意,操作分组或者用户同步之前,请务必检查是否已经添加了对应的字段关系,详情参考
- 手动同步时,需要先同步分组列表,然后再同步员工列表,员工数据依赖分组数据。
- 默认同步到平台上的员工密码为配置文件中
user-init-password:
配置项的值。
# 感谢
平台当前已集成飞书的集成能力,使用了如下开源库:
# 历程
详情参考: Change Log (opens new window)
v0.3.0
:初步集成了飞书的同步能力。
# 使用
在使用飞书同步之前,我们先看下需要添加的配置信息:
feishu:
# 配置获取详细文档参考:http://ldapdoc.eryajf.net/pages/83c90b/
flag: "feishu" # 作为飞书在平台的标识
app-id: "xxxxxxx" # 飞书的app-id
app-secret: "xxxxxxxxxxx" # 飞书的app-secret
2
3
4
5
首先要在飞书管理后台中创建应用。
# 创建应用
访问 https://open.feishu.cn/app (opens new window) ,登录飞书管理后台,通过路径: 创建应用
。
创建成功之后,进入应用详情,可以拿到应用的 AppID 和 APPSecret:
# 开通权限
飞书的应用创建之后,也需要单独对权限进行管理开放,需要如下权限:
获取部门组织架构信息:
contact:department.organize:readonly
获取用户基本信息:
contact:user.base:readonly
获取用户手机号:
contact:user.phone:readonly
以应用身份读取通讯录:
contact:contact:readonly_as_app
获取飞书人事(标准版)应用中的员工花名册信息:
ehr:employee:readonly
最后一项权限,如果公司没有开通飞书人事,则可以参考这个链接进行开通:https://www.feishu.cn/hc/zh-CN/articles/360049068032 (opens new window)
还需要将通讯录权限范围改为全部成员,如下:
其中权限范围以及人事权限,需要将应用进行版本发布才能够使用。
点击页面上提示的创建版本发布,然后点击创建版本:
说明填写完毕之后,点击申请发布。
此时再跳转到管理总后台,进入工作台:https://bd4loppim5.feishu.cn/admin/appCenter/audit (opens new window),可以看到应用的上线请求:
点击审核,再点击通过,则管理后台的权限就配置完成了。
如果配置准备完毕之后,就可以启动项目进行同步了。
# 手动同步
警告
- 请注意,操作分组或者用户同步之前,请务必检查是否已经添加了对应的字段关系,详情参考
- 手动同步时,需要先同步分组列表,然后再同步员工列表,员工数据依赖分组数据。
- 默认同步到平台上的员工密码为配置文件中
user-init-password:
配置项的值。