帮你快速理解、总结文档立即下载

配置私有化企业微信数据源

最近更新时间:2026-09-16 21:22:00
我的收藏
如果企业已使用私有化企业微信作为办公 IM 软件,可将其配置为数据源,将组织架构快速导入企业控制台,并进行后续同步。
本文档介绍私有化企业微信数据源的配置方法。完成配置后,可通过自动同步或手动同步,将私有化企业微信组织架构数据同步至企业控制台目录。开始配置前,请确保您拥有企业微信管理平台权限。

步骤1:私有化企业微信侧应用创建及配置

以管理员身份登录私有化企业微信管理后台,创建一个应用。
1. 在“应用管理”中找到“自建应用”,单击创建应用

2. 上传 Logo,填写应用名称和应用描述,选择可见范围。可见范围决定应用在企业微信中可访问的数据范围,请慎重选择。

3. 勾选开发者能力,选择安全配置授权登录API 访问通讯录API 设置应用。根据企业微信开发管理规则,自建应用获取企业微信数据前需提前配置可信 IP,可信 IP 为腾讯统一身份 agent 服务器的访问 IP,此处可先填写临时 IP,后续配置完成后再修改。可信域名及可信 IP 是数据源配置的必需步骤,省略将导致接口调用失败、无法获取企业微信数据。完成后进入下一步。

4. 进入自建应用页面,选择安全配置,单击设置

5. 配置应用可读取字段。此处配置的是腾讯统一身份可获取的企业微信字段信息,未配置或缺少配置将导致对应字段无法同步,其中姓名和部门为必选项。



步骤2:获取私有化企业微信相关信息

1. 回到自建应用页面,单击开发者功能-API,查看 AgentId 和 Secret。请记录这两个值,用于后续数据源/数据源配置。

2. 单击我的企业,进入企业信息页面,查看并记录 CorpID 字段(部分私有化企业微信显示为企业 ID)。


步骤3:配置私有化企业微信数据源

1. 企业管理后台 > 组织与成员 > 数据源管理中,单击添加数据源。跳转数据源选择页面选择私有化企微

2. 手动填写私有化企微凭证信息
进入私有化企微应用凭证配置页面,依次填写并选择 agent、“AgentId”、“Secret”和“企业 ID”。
由于多数私有化企微服务器无法直接连接外网,需通过 agent 代理连接,具体请参见 Agent 配置。配置 agent 成功后,选择运行中的 agent 完成与私有化企微的通信连接。

3. 一键获取凭证信息
若已完成私有化企微数据源配置,且私有化企微数据源与数据源使用同一台服务器,系统将自动获取数据源中的私有化企微信息。单击私有化企微数据源选项,即可自动拉取私有化企微配置信息。


步骤4:私有化企微数据源配置

根据实际需求完成以下配置项,全部配置完成后,单击保存配置即可生效。
1. 数据范围配置
企业控制台暂不支持设置部门或人员范围。若同步时需指定数据范围,可在步骤1创建应用时,按需配置“可见范围”。

2. 配置字段映射
字段映射用于建立私有化企微人员字段与腾讯统一身份人员字段的对应关系,同步时按此关系写入数据。详细说明请参见字段映射
系统已预置常见的私有化企微字段映射,可按需调整。

3. 配置定时同步
定时器可使同步任务定时触发,确保私有化企微组织架构的变更周期性同步至腾讯统一身份。详细说明请参见同步方式
定时器支持设置触发时间和触发间隔。

4. 配置删除保护
为避免误删除,系统设置了删除保护条件。执行同步任务前,系统会检查本次操作是否触发保护条件;若触发,本次同步任务将中止,并通过预留联系方式发送通知。删除保护条件支持修改,为避免误删除影响,若非频繁触发导致日常同步难以进行,不建议修改。触发删除保护时,系统仅自动停止删除操作请求,同一同步中的新建、修改请求会继续执行,不受影响。


步骤5:配置私有化企微可信域名及可信 IP

根据企业微信开发管理规则,自建应用获取企业微信数据前需提前配置可信域名及可信 IP。可信域名及可信 IP 是数据源配置的必需步骤,省略将导致接口调用失败、无法获取企业微信数据。配置前请提前准备企业可信域名,并查询企业控制台部署服务的对外访问 IP。
1. 在企业微信管理后台 > 应用管理 > 自建区域,找到新创建的应用并单击,进入应用详情页面。在页面下方开发者接口区域,单击设置可信域名,进入可信域名配置页面。

2. 在“可信域名”处填写企业可信域名,单击确定。企业微信将校验域名的真实性与所有权,校验不通过时请参见本文末 常见问题 排查。

3. 域名配置成功后,返回应用详情页面,在开发者接口区域 > 企业可信 IP 处单击配置,进入可信 IP 配置页面。

4. 在“企业可信 IP”地址框中,填写企业控制台部署服务器的对外访问 IP。若为集群部署,可配置多个 IP,以英文分号(;)分隔。


步骤6:配置私有化企微范围及权限管理

企业微信创建应用时会对应用可访问的数据(包括用户数据和组织机构数据)进行权限控制。本节介绍如何配置访问权限。
1. 在应用详情页找到“可见范围”,该处显示当前应用可访问的数据范围。单击编辑进入权限编辑页面。

2. 进入权限编辑页面,可对当前权限进行删除、添加等操作,单击添加进入添加页面。

3. 支持“根据部门”“根据成员”“根据标签”三种权限添加方式,可单独或组合使用,请根据业务需要选择,完成后单击确认

4. 回到权限编辑页面,单击完成,完成权限变更。


步骤7:启动同步

支持手动同步和定时同步两种方式。
1. 手动同步
配置好私有化企微数据源后,“数据源”页面将显示手动同步按钮。
单击手动同步,系统将立即执行一次导入/同步任务。手动同步即点即执行。

2. 定时同步
如需频繁维护目录数据,可设置定时器周期性自动同步,避免每次维护后手动进入腾讯统一身份后台执行同步。
在“设置同步策略”模块,打开定时同步开关,在时间设定选项中设置定时同步频率。
例如:设置每1小时自动同步一次,每天从零点开始同步,配置如下:
img
img


步骤8:查看同步日志

同步完成后,进入账号同步页面查看同步日志,包括同步时间、同步方式(手动或自动),以及同步成功和失败的数据。

单击具体同步日志,可查看该次同步的详情。

进入日志详情页面,可查看同步数据的具体信息。


其他:数据源更换(非必要不建议更换)

1. 单击数据源更换,二次确认后可更换数据源类型。若仅需更换应用凭证,可直接编辑数据源并更新凭证。
2. 更换数据源后,原数据源的所有配置和同步记录将被清空,已同步至企业控制台的人员将保留。

常见问题

Q1:为什么没有展示可选的 agent?

Agent 部署并运行成功后才会展示,请检查 Agent 是否已正确安装。

Q2:配置私有化企微数据源信息后,单击下一步提示“凭证不正确”。

请检查以下两项:1)“AgentId”、“Secret”和“企业 ID”三个信息是否正确;2)Agent 安装服务器与私有化企微服务的网络是否互通。

Q3:选择未匹配逻辑-新建用户后,登录成功但报错:创建用户失败,缺少必需属性。

请登录私有化企微管理后台,选择配置的自建应用,打开安全配置,检查是否已按步骤1配置必需的属性字段。