用户同步

概述

用户同步把企业已有系统里的组织架构和人员批量导入 Sight Report，避免手工维护两套账号。支持同步四类对象：用户、部门、角色、岗位，数据来源可以是关系数据库、HTTP 接口或 LDAP/AD 服务器。

用户接入的方式有两种：

同步只支持数据库、HTTP、LDAP 三种数据源，界面上没有 Excel 数据源。Excel 只用于「所有用户」页面的手工导入。

功能入口

系统 > 用户管理 > 「用户同步」 标签页。页面顶部为「同步配置」，下面是四张卡片：「用户同步」「部门同步」「角色同步」「岗位同步」。每类对象最多一份配置。

卡片上的操作：

注意：「清空已同步数据」按数据来源（同步产生的记录）判断，会删除全部同步数据，操作前确认。

操作步骤

以从企业数据库同步用户为例。

新建同步配置

1. 打开「用户同步」标签页，在「用户同步」卡片点击「创建配置」，对话框标题为「新增同步配置」，共三步：「基础设置」「数据配置」「字段映射与选项」。

2. 在「基础设置」填写「配置名称」（最多 50 字），「同步类型」在从卡片进入时已固定，「数据源类型」选「数据库」，「同步策略」选「全量同步」，点击「下一步」。

3. 在「数据配置」选择「数据源」（来自 数据源 管理里已有的连接），填写「SQL语句」，例如：

   SELECT user_id, user_name, email, phone FROM sys_user WHERE status = 1
   

   点击「数据预览」确认返回了预期的行，点击「下一步」。此时系统加载源字段，加载失败会提示「未能获取到源字段，请先点击"预览数据"加载字段」。

4. 在「字段映射与选项」把源字段映射到目标字段，至少映射目标字段中标为必填的「账号」和「姓名」。

5. 按需设置数据处理、定时同步等选项，点击「保存配置」，提示「保存成功」。

6. 回到卡片，点击「立即同步」，在弹窗中确认。

7. 同步结束后在「所有用户」页面确认用户已出现。

属性/参数说明

基础设置

数据库数据源

HTTP 数据源

LDAP 数据源

目标字段

字段映射的右侧是平台的目标字段，由同步类型决定：

同步选项

管理端接口

用户同步接口只允许管理员的登录会话调用，请求头带 satoken。这些接口用于平台自己的管理页面，不属于面向第三方系统的开放接口，不接受签名认证。

BASE=https://your-domain
TOKEN=<管理员登录后的 satoken>

# 执行某个同步配置
curl -s -X POST "$BASE/api/user-sync/config/<配置ID>/execute" -H "satoken: $TOKEN"

# 查看是否仍在运行
curl -s "$BASE/api/user-sync/config/<配置ID>/is-running" -H "satoken: $TOKEN"

示例

从 OpenLDAP 同步部门和人员：

1. 依次为「部门同步」「用户同步」创建配置，「数据源类型」都选「LDAP」。
2. 「服务器地址」填 ldap://ldap.example.com:389，「Base DN」填 dc=example,dc=com，填写「绑定DN」和「绑定密码」。
3. 部门配置里「部门过滤器」用 (objectClass=organizationalUnit)；用户配置里「用户过滤器」用 (&(objectClass=inetOrgPerson)(uid=*))，「用户ID属性」填 uid。
4. 分别在「数据配置」步骤点击预览数据，确认返回记录，映射字段后保存。
5. 依次「立即同步」部门与用户。
6. 在「身份验证」中把「同步用户的认证方式」设为「LDAP 认证」，用户即可用域密码登录，见登录集成。

预期：部门树与用户出现在 系统 > 用户管理 中，用户归属到对应部门。

注意事项

注意：初次同步前先点击「预览数据」确认数据源返回的记录、字段名正确，避免带入脏数据。

注意：把「处理多余数据」设为「删除」时，数据源里暂时查不到的记录会被删除，建议同时启用「熔断」作为保护。

提示：同步用户的登录认证由「身份验证」页面的「同步用户的认证方式」决定，与用户同步的数据源相互独立。

相关文档

• 登录集成
• 三方集成应用
• 签名免登
• 数据源配置
• Webhook 通知