飞书插件配置手册

1. 上游同步任务配置

1.1 前置条件

1. 拥有飞书企业管理后台的权限

2. 在飞书开放平台 (opens new window)创建应用

3. 您必须在飞书开放平台配置应用API权限（该步骤必须进行，否则在SSO360同步时会报错）

创建自建应用

在【飞书管理后台＞工作台＞应用管理】模块创建

设置应用api权限

在【飞书开放平台＞权限管理】模块，配置并开通对应权限，如下图

配置完成后，在【应用发布＞版本管理与发布】模块创建应用版本并发布。（发布后，您的权限配置生效）

返回后台管理设置 应用权限，应用可用性设置为【全部成员】

1.2 飞书上游数据同步配置

1. 创建飞书同步应用

在租户后台【应用管理＞应用中心＞新增应用】模块创建飞书集成应用

填写应用名称、地址

填写飞书的AppKey、AppSecret参数（从飞书的开放平台＞应用详情中获取）

飞书应用详情中，点击【测试联通】按钮，提示“已联通”则证明配置正确，再点击【保存】按钮

2. 飞书上游回调配置

回调作用：IDaaS中飞书配置回调后，飞书用户离职后，SSO360中用户会自动删除；飞书组织删除后，SSO360中组织自动删除

飞书后台->app应用详情->事件订阅

\1. 添加事件：部门被删除、员工离职

\2. 进行请求地址配置

3. 添加应用属性

说明：每个插件都会自动内置部分必需属性（内置的属性请勿删除），如果您的插件没有自定义属性，则无需添加，您可以跳过此步骤。

在【应用中心＞应用详情＞属性池】模块添加更多的应用同步的映射属性

4. 新增同步任务

注意事项：

\1. 同步任务中配置的用户分类，用户分类下所包含的必填属性必须全部在任务中设为同步属性。

\2. 同步任务中组织的分类为默认组织分类，默认组织分类下所包含的必填属性必须全部在任务中设为同步属性。

\3. 任务的同步属性配置时，需核对字段名和字段类型无误，否则会导致数据同步失败。

\4. 飞书上游暂不支持职级、入职日期同步至SSO360，其他扩展数据需要视飞书接口返回结果是否支持

1）用户属性映射配置

飞书	字段名	字段类型	飞书是否必填	sso360	字段名	字段类型	SSO360是否必填	备注
name	姓名	string	是	username	用户名	string	是
mobile	手机号码	string	是	phone	手机号	string	否
email	邮箱	string	是	email	邮箱	string	否
gender	性别	int	否	gender	性别	enum	否
status	状态	string	是	status	状态	enum	是

飞书用户属性中employeeNo（工号）、country（国家）、city（城市）租户可选择是否同步

2）组织属性映射

飞书	飞书是否必填	sso360	SSO360是否必填
name	是	orgName	是

5. 应用授权

飞书作为上游应用，不需要在SSO360中进行应用授权

6. 进行数据同步

注意事项：

· 飞书同步用户/组织数据至SSO360时，飞书同步任务中属性映射关系必须包含同步任务指定用户分类下的所有必填属性且符合校验规则才能同步成功

· 飞书中离职用户不会同步至SSO360

· 飞书应用详情中不配置回调注册，飞书删除用户/组织时，SSO360无法删除已同步数据

· 飞书上游支持用户多组织同步，即飞书用户存在多组织同步至SSO360用户也为多组织

· 飞书上游暂不支持用户直属领导同步

1) 全量同步验证

执行全量同步飞书中的用户/组织会同步至SSO360中

2) 飞书删除用户/组织回调验证

飞书上游删除用户/组织数据后，若SSO360中存在对应同步的用户/组织数据时会同步删除

7. 验证同步结果

飞书上游数据同步后，可在SSO360用户管理模块查看已同步的用户/组织数据

2. 下游同步任务配置

2.1 前置条件（同上游配置）

1. 拥有飞书企业管理后台的权限

2. 在飞书开放平台 (opens new window)创建应用

3. 您必须在飞书开放平台配置应用API权限（该步骤必须进行，否则在SSO360同步时会报错）

创建自建应用

在【飞书管理后台＞工作台＞应用管理】模块创建

设置应用api权限

在【飞书开放平台＞权限管理】模块，配置并开通对应权限，如下图

配置完成后，在【应用发布＞版本管理与发布】模块创建应用版本并发布。（发布后，您的权限配置生效）

返回后台管理设置 应用权限，应用可用性设置为【全部成员】

2.2 飞书下游数据同步配置

1. 创建飞书同步应用

在租户后台【应用管理＞应用中心＞新增应用】模块创建飞书集成应用

填写应用名称、地址

填写飞书的AppKey、AppSecret参数（从飞书的开放平台＞应用详情中获取），并点击【测试联通】按钮，提示“已联通”则证明配置正确，再点击【保存】按钮

2. 添加应用属性

说明：每个插件都会自动内置部分必需属性（内置的属性请勿删除），如果您的插件没有自定义属性，则无需添加，您可以跳过此步骤。

在【应用中心＞应用详情＞属性池】模块添加更多的应用同步的映射属性

3. 新建同步任务

1. 在SSO360后台，【应用管理＞同步任务】模块，点击新建任务按钮，创建飞书下游同步任务

属性映射参考列表——

自定义属性需要您在SSO360后台【属性管理＞用户属性/组织属性】模块去手动新增

说明：下游的必填属性，在SSO360用户信息中，一定要补全填写，否则会无法同步到下游（缺少必填字段，下游不接收该用户）

1）用户属性映射

\1. 如下表格中SSO360平台中的自定义属性租户管理员可在后台管理属性管理->用户属性中新增，字段名称可根据实际需要命名

\2. 如下表格中飞书joinTime、jobTitle、customAttrs.职级字段需要在飞书应用属性中新增

sso360	字段名	字段类型	SSO360是否必填	飞书	字段名	字段类型	飞书是否必填	备注
username	用户名	string	是	name	姓名	string	是
phone	手机号	string	否	mobile	手机号码	string	是
email	邮箱	string	否	email	邮箱	string	是
status	用户状态	enum	是	status	状态	string	否	配置status状态字段则用户启用禁用生效；不配置，不生效
gender	性别	enum	否	gender	性别	int	否
jobNumber（自定义扩展属性）	工号	string	否	employeeNo	工号	string	否
place（自定义扩展属性）	办公地点	string	否	city	城市	string	否
entryDate（自定义扩展属性-Date类型）	入职日期	date	否	joinTime(自定义)	入职时间	int	否
jobPosition（自定义扩展属性-String类型）	职位	string	否	jobTitle (自定义)	职务	string	否
jobLevel（自定义扩展属性-String类型）	职级	string	否	customAttrs.职级 (自定义)	职级	string	否	SSO360往飞书同步职级时需要在飞书中创建自定义字段

2）组织属性映射

飞书	飞书是否必填	sso360	SSO360是否必填
name	是	orgName	是

注意事项

飞书职级字段同步说明：

• 在飞书的应用属性池添加属性字段：customAttrs.职级-STRING，字段必须是这个名称和类型

• 在飞书的管理后天添加自定义字段：职级，如下图：字段必须是这个名称和类型

• 在IDaaS中添加扩展属性：OIdJobLevelText-STRING，该字段表示职级，字段必须是这个名称和类型
• 在飞书的数据同步中建立如图的属性映射

飞书职级字段需要在飞书中创建自定义字段；并且要开启全局设置中的允许开放平台通讯录API调用。创建好后，需要在SSO360中的飞书应用属性池中创建用户属性：customAttrs.职级。

2. 配置同步的属性映射字段，并点击保存按钮

3. 在同步任务列表，点击执行按钮，则数据同步开始，执行完成后，可以点击同步历史按钮，查看同步结果

4. 应用授权

注意事项：

如果某些用户没有授权该应用，则这些应用将无法同步到下游

给要同步的用户添加飞书应用权限

添加方式有两种：

1）应用授权->授权用户：直接给用户添加飞书应用权限，在用户列表中，搜索到该用户，进入用户详情

2）应用授权->授权组织 : 给用户所关联的组织添加飞书应用权限，在【应用授权】模块批量给组织授权

5. 进行数据同步

注意事项

· 属性映射中配置status状态字段则用户启用/禁用后同步至飞书时用户状态生效；不配置，不生效

· 飞书支持用户多组织同步

· 飞书中职级属性需要手动在飞书后台添加扩展属性

· SSO360新增禁用用户（用户具有飞书应用权限），执行增量/全量同步时，飞书下游会新增一个用户

· SSO360向飞书同步用户时，支持用户直属领导同步，无需配置

页面同步功能按钮

1）增量同步

a、新增用户或组织同步

• 新创建的用户（用户分类和根组织满足同步任务配置），必须加入有飞书应用权限的组织，进行增量同步时，才能同步成功。

• SSO360用户禁用时飞书中删除用户，SSO360用户启用时飞书中新增用户

• 新创建的组织（组织分类为默认分类，根组织满足同步任务配置），不用管是否有飞书应用权限，进行增量同步时，组织都能同步成功。

b、修改或删除用户或组织同步

• 修改或删除用户时（用户分类和根组织满足同步任务配置），用户有飞书的应用权限，进行增量同步时，才能同步成功。

• 修改或删除组织时（组织分类为默认分类，根组织满足同步任务配置），不用管是否有飞书应用权限，进行增量同步时，组织都能同步成功。

2）全量同步

• 新增或修改或删除用户时（用户分类和根组织满足同步任务配置），用户有飞书应用权限，进行全量同步时，才能同步成功。

• 新增或修改或删除组织时（组织分类为默认分类，根组织满足同步任务配置），不用管是否有飞书应用权限，进行全量同步时，都能同步成功。

6. 验证同步结果

在你的飞书企业管理后台，【组织架构＞成员与部门】模块，查看您从SSO360同步过来的组织和用户数据。