完整文档索引见 llms.txt。在页面 URL 后附加 .md 即可获取 Markdown 版本；本页的 Markdown 版本可在此获取。

LDAP 设置

LDAP 设置相关操作

获取 LDAP 配置

获取当前 LDAP 配置，包括界面中提供的所有字段。读取时会遮蔽绑定管理员密码。需要 `ldap:manage` 作用域，并获得 LDAP 功能许可。

GET/settings/ldap

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问

响应结构：200 · application/json

字段	类型	必填	说明
loginEnabled	boolean	是	是否启用 LDAP 登录。
loginLabel	string	是	LDAP 登录按钮显示的标签。
connectionUrl	string	是	LDAP 服务器 URL。
allowUnauthorizedCerts	boolean	是	是否允许不受信任的证书（自签名证书）。
connectionSecurity	string	是	LDAP 连接的 TLS/SSL 安全模式。 可选值：none, tls, startTls
connectionPort	number	是	LDAP 服务器端口。
baseDn	string	是	LDAP 搜索查询的基础 DN。
bindingAdminDn	string	是	用于绑定的 LDAP 管理员用户 DN。
bindingAdminPassword	string	是	LDAP 管理员用户密码。GET 读取时会遮蔽：已存储密码时返回遮蔽占位符，未设置时返回空字符串。提交先前 GET 返回的遮蔽占位符，可保持已存储密码不变。
firstNameAttribute	string	是	映射到用户名字的 LDAP 属性。
lastNameAttribute	string	是	映射到用户姓氏的 LDAP 属性。
emailAttribute	string	是	映射到用户邮箱的 LDAP 属性。
loginIdAttribute	string	是	用于登录的 LDAP 属性，通常与 emailAttribute 相同。
ldapIdAttribute	string	是	用于唯一标识用户的 LDAP 属性。
userFilter	string	是	搜索用户时使用的附加 LDAP 筛选条件；空字符串表示无附加筛选条件。
synchronizationEnabled	boolean	是	是否启用 LDAP 自动同步。
synchronizationInterval	number	是	自动同步的间隔，单位为分钟；synchronizationEnabled 为 false 时忽略。
searchPageSize	number	是	每页搜索获取的 LDAP 条目数量。
searchTimeout	number	是	LDAP 搜索超时时长，单位为秒。
enforceEmailUniqueness	boolean	是	是否强制 LDAP 用户邮箱唯一。为 true 时，如果两个用户邮箱相同，只导入第一个用户。
linkExistingAccountsByEmail	boolean	是	是否允许将 LDAP 用户关联到邮箱相同的现有 n8n 账户。为 false 时，登录和同步都会跳过此类用户。PUT 中此字段可选，省略时保留已存储的值。

下载完整 OpenAPI 定义（JSON）

设置 LDAP 配置

使用提供的完整对象替换 LDAP 配置，不支持部分更新。对于 bindingAdminPassword，提交先前 GET 返回的遮蔽占位符，可保持已存储密码不变。需要 `ldap:manage` 作用域，并获得 LDAP 功能许可。将 loginEnabled 设为 false 具有破坏性：会删除所有已存储的 LDAP 用户身份，并禁用同步。

PUT/settings/ldap

请求体

application/json

字段	类型	必填	说明
loginEnabled	boolean	是	是否启用 LDAP 登录。设为 false 具有破坏性：会删除所有已存储的 LDAP 用户身份，并禁用同步。
loginLabel	string	是	LDAP 登录按钮显示的标签。
connectionUrl	string	是	LDAP 服务器 URL。
allowUnauthorizedCerts	boolean	是	是否允许不受信任的证书（自签名证书）。
connectionSecurity	string	是	LDAP 连接的 TLS/SSL 安全模式。 可选值：none, tls, startTls
connectionPort	integer	是	LDAP 服务器端口。
baseDn	string	是	LDAP 搜索查询的基础 DN。
bindingAdminDn	string	是	用于绑定的 LDAP 管理员用户 DN。
bindingAdminPassword	string	是	LDAP 管理员用户密码。提交先前 GET 响应中的遮蔽占位符，可保持现有密码不变；使用空字符串可清除密码。
firstNameAttribute	string	是	映射到用户名字的 LDAP 属性。
lastNameAttribute	string	是	映射到用户姓氏的 LDAP 属性。
emailAttribute	string	是	映射到用户邮箱的 LDAP 属性。
loginIdAttribute	string	是	用于登录的 LDAP 属性，通常与 emailAttribute 相同。
ldapIdAttribute	string	是	用于唯一标识用户的 LDAP 属性。
userFilter	string	是	搜索用户时使用的附加 LDAP 筛选条件；空字符串表示无附加筛选条件。
synchronizationEnabled	boolean	是	是否启用 LDAP 自动同步。
synchronizationInterval	integer	是	自动同步的间隔，单位为分钟；synchronizationEnabled 为 false 时忽略。
searchPageSize	integer	是	每页搜索获取的 LDAP 条目数量。
searchTimeout	integer	是	LDAP 搜索超时时长，单位为秒。
enforceEmailUniqueness	boolean	是	是否强制 LDAP 用户邮箱唯一。为 true 时，如果两个用户邮箱相同，只导入第一个用户。
linkExistingAccountsByEmail	boolean	否	是否允许将 LDAP 用户关联到邮箱相同的现有 n8n 账户。为 false 时，登录和同步都会跳过此类用户。PUT 中此字段可选，省略时保留已存储的值。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
415	不支持的媒体类型。

响应结构：200 · application/json

字段	类型	必填	说明
loginEnabled	boolean	是	是否启用 LDAP 登录。
loginLabel	string	是	LDAP 登录按钮显示的标签。
connectionUrl	string	是	LDAP 服务器 URL。
allowUnauthorizedCerts	boolean	是	是否允许不受信任的证书（自签名证书）。
connectionSecurity	string	是	LDAP 连接的 TLS/SSL 安全模式。 可选值：none, tls, startTls
connectionPort	number	是	LDAP 服务器端口。
baseDn	string	是	LDAP 搜索查询的基础 DN。
bindingAdminDn	string	是	用于绑定的 LDAP 管理员用户 DN。
bindingAdminPassword	string	是	LDAP 管理员用户密码。GET 读取时会遮蔽：已存储密码时返回遮蔽占位符，未设置时返回空字符串。提交先前 GET 返回的遮蔽占位符，可保持已存储密码不变。
firstNameAttribute	string	是	映射到用户名字的 LDAP 属性。
lastNameAttribute	string	是	映射到用户姓氏的 LDAP 属性。
emailAttribute	string	是	映射到用户邮箱的 LDAP 属性。
loginIdAttribute	string	是	用于登录的 LDAP 属性，通常与 emailAttribute 相同。
ldapIdAttribute	string	是	用于唯一标识用户的 LDAP 属性。
userFilter	string	是	搜索用户时使用的附加 LDAP 筛选条件；空字符串表示无附加筛选条件。
synchronizationEnabled	boolean	是	是否启用 LDAP 自动同步。
synchronizationInterval	number	是	自动同步的间隔，单位为分钟；synchronizationEnabled 为 false 时忽略。
searchPageSize	number	是	每页搜索获取的 LDAP 条目数量。
searchTimeout	number	是	LDAP 搜索超时时长，单位为秒。
enforceEmailUniqueness	boolean	是	是否强制 LDAP 用户邮箱唯一。为 true 时，如果两个用户邮箱相同，只导入第一个用户。
linkExistingAccountsByEmail	boolean	是	是否允许将 LDAP 用户关联到邮箱相同的现有 n8n 账户。为 false 时，登录和同步都会跳过此类用户。PUT 中此字段可选，省略时保留已存储的值。

下载完整 OpenAPI 定义（JSON）

获取 LDAP 同步历史

获取 LDAP 同步历史，最近记录优先。需要 `ldap:sync` 作用域，并获得 LDAP 功能许可。

GET/settings/ldap/sync

请求参数

参数	位置	类型	必填	说明
limit	query	number	否	最多返回的数据项数量。 默认值：100
cursor	query	string	否	将 cursor 参数设为上次请求响应中的 nextCursor 属性，以进行分页。使用默认值时，获取集合的第一页。更多信息，请参阅分页说明。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]id integer 是 此次同步运行的唯一标识符。 data.[]runMode string 是 此次同步是试运行还是实际应用变更。 可选值：dry, live data.[]status string 是 同步状态，例如 success 或 error。 data.[]startedAt string 是 同步开始的时间戳。 data.[]endedAt string 是 同步完成的时间戳。 data.[]scanned integer 是 同步期间扫描的 LDAP 条目数量。 data.[]created integer 是 同步期间新建的用户数量。 data.[]updated integer 是 同步期间更新的现有用户数量。 data.[]disabled integer 是 同步期间禁用的用户数量。 data.[]error string 是 同步失败时的错误消息；成功时为空字符串。
nextCursor	string	是	将 cursor 参数设为上次请求返回的 nextCursor 属性，以对同步历史进行分页。null 值表示没有更多记录。

下载完整 OpenAPI 定义（JSON）

触发 LDAP 同步

手动触发 LDAP 同步，响应返回新建的同步历史记录。需要 `ldap:sync` 作用域，并获得 LDAP 功能许可。

POST/settings/ldap/sync

请求参数

参数	位置	类型	必填	说明
Idempotency-Key	header	string	否	此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。

请求体

application/json

字段	类型	必填	说明
type	string	是	同步类型。'live' 将变更应用到数据库；'dry' 执行试运行，不持久保存变更。 可选值：live, dry

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
409	冲突
415	不支持的媒体类型。
422	无法处理的实体

响应结构：200 · application/json

字段	类型	必填	说明
id	integer	是	此次同步运行的唯一标识符。
runMode	string	是	此次同步是试运行还是实际应用变更。 可选值：dry, live
status	string	是	同步状态，例如 success 或 error。
startedAt	string	是	同步开始的时间戳。
endedAt	string	是	同步完成的时间戳。
scanned	integer	是	同步期间扫描的 LDAP 条目数量。
created	integer	是	同步期间新建的用户数量。
updated	integer	是	同步期间更新的现有用户数量。
disabled	integer	是	同步期间禁用的用户数量。
error	string	是	同步失败时的错误消息；成功时为空字符串。

下载完整 OpenAPI 定义（JSON）