本文面向身份集成管理员。完成后,你可以按照当前页面完成“基础说明”相关配置,并通过用户、组织、关系或同步结果回读确认效果。本文不覆盖目标系统自身的采购、网络和管理员审批流程。本文按 6.7.1 系列固定源码基线整理。由于当前仓库没有独立的 6.7.1.1 Tag,正式发布前还需核对实际构建版本,并在目标租户完成运行验证。
本文档介绍如何将专属集成平台中的组织架构和用户数据推送到钉钉通讯录。配置完成后,平台可按设定的同步策略自动将用户和组织数据同步至钉钉,实现用户在钉钉端的自动创建、更新和删除,确保平台与钉钉之间的用户数据一致性。适用场景#
多系统身份打通:已通过平台集中管理用户,需要将用户数据分发到钉钉
账号自动创建:新员工入职后在平台创建账号,自动创建钉钉账号
员工信息变更同步:员工调岗、更名等信息变更后自动同步到钉钉
离职账号清理:员工离职后自动在钉钉中清理或禁用账号
准备工作#
钉钉管理员权限:拥有钉钉管理后台的管理员权限,用于创建应用和配置 API 权限
平台管理员权限:拥有专属集成平台的管理员权限,用于配置同步连接器
钉钉应用准备:已在钉钉开放平台创建企业内部应用,并获取 AppKey 和 AppSecret
钉钉应用配置步骤#
2.
创建企业内部应用:导航至「应用开发 → 企业内部应用」,点击「创建应用」,填写应用名称和描述
3.
获取凭证信息:创建完成后,在应用详情页「凭证与基础信息」中记录 AppKey 和 AppSecret
5.
配置服务器出口 IP:在「开发管理」中,将平台服务器的公网出口 IP 添加至白名单
重要:请妥善保管 AppSecret,该信息仅在创建时显示一次。如忘记,可在应用详情页重新生成。
操作步骤#
步骤 1:创建同步任务#
5.
名称:建议使用具有业务含义的名称,如"总部钉钉同步"
步骤 2:配置目标连接#
| 参数 | 说明 | 是否必填 |
|---|
| AppKey | 钉钉应用的 AppKey,从钉钉开放平台获取 | 是 |
| AppSecret | 钉钉应用的 AppSecret,从钉钉开放平台获取 | 是 |
| 企业 CorpId | 钉钉企业的 CorpId,从钉钉管理后台获取 | 是 |
配置完成后,点击「测试连接」按钮验证配置是否正确。提示:测试连接成功表明 AppKey、AppSecret 和 CorpId 配置正确,且网络连通性良好。
步骤 3:配置字段映射#
字段映射用于建立平台用户/部门属性与钉钉字段之间的对应关系。用户属性映射#
| 平 台属性 | 钉钉字段 | 数据类型 | 必填 | 建议映射方式 |
|---|
| sub(用户ID) | userid | String | 是 | 创建且更新 |
| name(姓名) | name | String | 是 | 创建且更新 |
| mobile(手机号) | mobile | String | 是 | 创建且更新 |
| email(邮箱) | email | String | 是 | 创建且更新 |
| department_ids(部门) | dept_id_list | Array | 是 | 创建且更新 |
| position(职位) | title | String | 否 | 创建且更新 |
| job_number(工号) | job_number | String | 否 | 创建且更新 |
| leader(直属上级) | senior | String | 否 | 创建且更新 |
注意:钉钉中 userid 支持字母、数字和下划线,长度 1~64 字符,且不可包含中文。如果平台用户 ID 不满足此格式,请使用转换规则进行格式化。
部门属性映射#
| 平台属性 | 钉钉字段 | 数据类型 | 必填 | 建议映射方式 |
|---|
| id(部门ID) | dept_id | Number | 是 | 创建且更新 |
| name(部门名称) | name | String | 是 | 创建且更新 |
| parent_id(父部门ID) | parent_id | Number | 是 | 创建且更新 |
步骤 4:配置同步规则#
| 参数 | 说明 | 建议配置 |
|---|
| 同步范围 | 指定同步内容类型 | 用户和部门 |
| 根组织ID | 组织架构同步起始节点 | 全量同步填"1",部分同步填具体部门ID |
| 同步方式 | 同步执行的模式 | 日常运维选「自动增量」,定期校验选「自动全量」 |
| 同步周期 | 执行同步的频率 | 建议初始为"每小时",稳定后调整为"每6小时"或"每天" |
| 开始时间 | 同步执行的起始时间 | 建议选择业务低峰期(如凌晨) |
| 强制创建 | 是否强制在下游创建用户/部门 | 建议开启 |
| 删除用户阈值 | 触发删除保护的阈值比例 | 小型企业 810%,中大型企业 35% |
警告:删除用户阈值是重要的安全保护机制。当待删除用户比例超过阈值时,系统会暂停删除操作并将用户放入待删除列表,需管理员确认后才执行。请勿将阈值设置过低,以免正常离职流程被阻断。
步骤 5:执行同步并验证#
1.
保存并同步:完成上述配置后,点击「保存并同步」按钮触发首次同步
2.
监控同步状态:在通讯录同步列表页查看同步进度和结果
3.
登录钉钉管理后台,进入「通讯录」,检查用户和部门是否已同步
验证结果#
连接测试#
同步结果验证#
| 验证项 | 验证方法 | 预期结果 |
|---|
| 用户同步 | 对比平台用户列表与钉钉通讯录用户列表 | 用户数量和关键信息一致 |
| 部门同步 | 对比平台组织架构与钉钉部门结构 | 部门名称和层级关系一致 |
| 增量同步 | 在平台新增/修改/删除用户后触发同步 | 变更在钉钉端正确生效 |
| 字段映射 | 检查同步后用户在钉钉的属性值 | 字段值与平台一致 |
同步日志查看#
2.
查看同步操作的详细记录,包括操作时间、操作类型(CREATE/UPDATE/DELETE)、操作结果和错误信息
常见问题#
Q1:测试连接时报"AppKey 或 AppSecret 无效"#
AppKey 或 AppSecret 填写错误(注意多余空格)
1.
检查复制的 AppKey 和 AppSecret 是否完整,确保没有多余空格或换行
3.
如 AppSecret 不确定是否正确,在应用详情页重新生成并更新平台配置
Q2:同步后钉钉中用户手机号为空#
2.
确认字段映射中 mobile 字段已配置为"创建且更新"
3.
在钉钉开放平台检查应用是否已申请通讯录敏感信息权限
Q3:同步后部分用户未在钉钉中创建#
1.
检查同步范围配置,确认用户所在组织是否在同步范围内
3.
检查用户 ID 是否满足钉钉规范,必要时使用转换规则进行格式化
Q4:删除阈值触发后如何继续同步#
可能原因:平台检测到需删除的用户比例超过设定的删除阈值,触发了安全保护。2.
确认删除的用户点击「确认删除」,不应删除的用户点击「拒绝删除」
停用或回滚#
停止相关任务或调度后,再恢复上一版配置并使用测试对象复核。涉及删除、覆盖或外部系统写入的数据不能只靠恢复配置找回;执行高风险操作前应保留可恢复的数据基线。