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

数据模型

auditVersion.generated 对象

字段	类型	必填	说明
name	string	是
nodes	array	是
createdAt	string	是
description	string	是
documentationUrl	string	是
hasBreakingChange	boolean	是
hasSecurityFix	boolean	是
hasSecurityIssue	boolean	是
securityIssueFixVersion	string	是

下载完整 OpenAPI 定义（JSON）

credentialTypePolicyEffectivePublicDto.generated 对象

字段	类型	必填	说明
scopeId	string	是
rules	array	是	展开字段 字段 类型 必填 说明 rules.[]id string 是 rules.[]action string 是 可选值：allow, deny, delegate rules.[]selector object 是 展开字段 结构 1 结构 2 结构 3
defaultAction	string	是	可选值：allow, deny, delegate
version	integer	是

下载完整 OpenAPI 定义（JSON）

credentialTypePolicyEffectiveWriteResultPublicDto.generated 对象

字段	类型	必填	说明
scopeId	string	是
rules	array	是	展开字段 字段 类型 必填 说明 rules.[]id string 是 rules.[]action string 是 可选值：allow, deny, delegate rules.[]selector object 是 展开字段 结构 1 结构 2 结构 3
defaultAction	string	是	可选值：allow, deny, delegate
version	integer	是
warnings	array	是	展开字段 结构 1 字段 类型 必填 说明 warnings.[]kind string 是 可选值：shadowed warnings.[]ruleId string 是 warnings.[]shadowedByRuleId string 是 结构 2 字段 类型 必填 说明 warnings.[]kind string 是 可选值：notLoaded warnings.[]ruleId string 是

下载完整 OpenAPI 定义（JSON）

credentialTypePolicyDocumentWriteResultPublicDto.generated 对象

字段	类型	必填	说明
policy	object	是	展开字段 字段 类型 必填 说明 policy.id string 是 policy.kind string 是 policy.rules array 是 展开字段 字段 类型 必填 说明 policy.rules.[]id string 是 policy.rules.[]action string 是 可选值：allow, deny, delegate policy.rules.[]selector object 是 policy.version integer 是 policy.updatedBy string 是 policy.createdAt string 是 policy.updatedAt string 是
warnings	array	是	展开字段 结构 1 字段 类型 必填 说明 warnings.[]kind string 是 可选值：shadowed warnings.[]ruleId string 是 warnings.[]shadowedByRuleId string 是 结构 2 字段 类型 必填 说明 warnings.[]kind string 是 可选值：notLoaded warnings.[]ruleId string 是

下载完整 OpenAPI 定义（JSON）

credentialTypePolicyAttachmentsPublicDto.generated 对象

字段	类型	必填	说明
attachments	array	是	展开字段 字段 类型 必填 说明 attachments.[]policyId string 是 attachments.[]rules array 是 attachments.[]priority integer 是 attachments.[]isFloor boolean 是
version	integer	是

下载完整 OpenAPI 定义（JSON）

credentialPublicDto.generated 对象

字段	类型	必填	说明
id	string	是
name	string	是
type	string	是
isManaged	boolean	是
isGlobal	boolean	是
isResolvable	boolean	是
resolvableAllowFallback	boolean	是
resolverId	string	是
createdAt	string	是
updatedAt	string	是
description	string	否	仅在启用凭据说明时返回。

下载完整 OpenAPI 定义（JSON）

dependencyListPublicDto.generated 对象

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]type string 是 与所请求资源的关系。credential、dataTable、subWorkflow、errorWorkflow：所请求的工作流使用此依赖项。parentWorkflow：此工作流使用所请求的资源。errorWorkflowParent：此工作流将所请求的工作流用作错误工作流。agent：此智能体使用所请求的资源。 可选值：agent, credential, dataTable, errorWorkflow, errorWorkflowParent, parentWorkflow, subWorkflow data.[]id string 是 data.[]name string 是 data.[]projectId string 否 依赖项所属项目（已知时返回）。
nextCursor	string	是
inaccessibleCount	integer	是	你无权访问的依赖项数量；这些依赖项不会列出。

下载完整 OpenAPI 定义（JSON）

dataTablePublicDto.generated 对象

字段	类型	必填	说明
id	string	是	数据表的唯一标识符
name	string	是	数据表名称
columns	array	是	列定义 展开字段 字段 类型 必填 说明 columns.[]id string 是 列 ID columns.[]name string 是 列名称 columns.[]type string 是 列的数据类型 可选值：string, number, boolean, date columns.[]index integer 是 列位置 columns.[]createdAt string 是 列创建的时间戳 columns.[]updatedAt string 是 列上次更新的时间戳
projectId	string	是	此表所属项目的 ID
createdAt	string	是	表创建的时间戳
updatedAt	string	是	表上次更新的时间戳
sizeBytes	integer	是	物理存储大小，单位为字节，包括索引和内部开销。删除行后不会立即减少，数值可能延迟几秒更新。

下载完整 OpenAPI 定义（JSON）

dataTableColumnPublicDto.generated 对象

字段	类型	必填	说明
id	string	是	列 ID
name	string	是	列名称
type	string	是	列的数据类型 可选值：string, number, boolean, date
index	integer	是	列位置
createdAt	string	是	列创建的时间戳
updatedAt	string	是	列上次更新的时间戳
dataTableId	string	是	此列所属数据表的 ID

下载完整 OpenAPI 定义（JSON）

executionTagsPublicDto.generated 对象

字段	类型	必填	说明
[]id	string	是	只读。
[]name	string	是
[]createdAt	string	是	只读。
[]updatedAt	string	是	只读。

下载完整 OpenAPI 定义（JSON）

ldapConfigurationPublicDto.generated 对象

字段	类型	必填	说明
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）

logStreamingDestinationPublicDto.generated 对象

结构 1

字段	类型	必填	说明
label	string	否	界面中显示的可读名称。
enabled	boolean	否	目标当前是否接收事件。
subscribedEvents	array	否	此目标接收的事件名称或事件组前缀，例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。
anonymizeAuditMessages	boolean	否	发送审计消息负载之前，是否进行匿名化。
circuitBreaker	object	否	投递熔断器的调节配置。反复失败后，目标会在冷却窗口内停止发送，避免持续请求异常的接收端。所有字段均可选，省略时使用合理的默认值。 展开字段 字段 类型 必填 说明 circuitBreaker.maxFailures integer 否 熔断器断开前，滑动窗口内允许的最大失败次数。 circuitBreaker.failureWindow integer 否 统计失败次数的滑动窗口，单位为毫秒。
type	string	是	将每个事件作为 HTTP 请求发送到 URL。 可选值：webhook
url	string	是	接收事件负载的目标 URL。
method	string	否	请求使用的 HTTP 方法。
sendHeaders	boolean	否	是否为请求附加自定义请求头。
specifyHeaders	string	否	自定义请求头的提供方式：keypair 或 json。
headerParameters	object	否	相应的 specify* 字段为 keypair 时使用的键值对。 展开字段 字段 类型 必填 说明 headerParameters.parameters array 是
jsonHeaders	string	否	specifyHeaders 为 json 时，以 JSON 字符串提供的自定义请求头。
sendQuery	boolean	否	是否为请求附加查询参数。
specifyQuery	string	否	查询参数的提供方式：keypair 或 json。
queryParameters	object	否	相应的 specify* 字段为 keypair 时使用的键值对。 展开字段 字段 类型 必填 说明 queryParameters.parameters array 是
jsonQuery	string	否	specifyQuery 为 json 时，以 JSON 字符串提供的查询参数。
options	object	否	附加 HTTP 请求选项。 展开字段 字段 类型 必填 说明 options.timeout integer 否 请求超时时长，单位为毫秒。 options.allowUnauthorizedCerts boolean 否 接受自签名或其他无效的 TLS 证书。 options.queryParameterArrays string 否 如何将数组值查询参数序列化到查询字符串中。 可选值：indices, brackets, repeat options.redirect object 否 跟随重定向的行为。 展开字段 字段 类型 必填 说明 options.redirect.redirect object 是 options.proxy object 否 出站代理配置。 展开字段 字段 类型 必填 说明 options.proxy.proxy object 是 options.socket object 否 连接套接字选项。 展开字段 字段 类型 必填 说明 options.socket.keepAlive boolean 否 是否保持套接字打开以便复用。 options.socket.maxSockets integer 否 每个主机同时保持打开的最大套接字数。 options.socket.maxFreeSockets integer 否 每个主机保持打开的最大空闲套接字数。
id	string	是	服务器生成的目标唯一 id，响应中返回，请求中不接受。

结构 2

字段	类型	必填	说明
label	string	否	界面中显示的可读名称。
enabled	boolean	否	目标当前是否接收事件。
subscribedEvents	array	否	此目标接收的事件名称或事件组前缀，例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。
anonymizeAuditMessages	boolean	否	发送审计消息负载之前，是否进行匿名化。
circuitBreaker	object	否	投递熔断器的调节配置。反复失败后，目标会在冷却窗口内停止发送，避免持续请求异常的接收端。所有字段均可选，省略时使用合理的默认值。 展开字段 字段 类型 必填 说明 circuitBreaker.maxFailures integer 否 熔断器断开前，滑动窗口内允许的最大失败次数。 circuitBreaker.failureWindow integer 否 统计失败次数的滑动窗口，单位为毫秒。
type	string	是	将每个事件发送到 syslog 服务器。 可选值：syslog
host	string	是	Syslog 服务器主机。
port	integer	否	Syslog 服务器端口。
protocol	string	否	传输协议。 可选值：udp, tcp, tls
facility	integer	否	Syslog facility 代码（0–23，按 RFC 5424）。常用值：0 Kernel（内核）、1 User（用户）、3 System（系统）、13 Audit（审计）、14 Alert（警报）、16 Local0、17 Local1、18 Local2、19 Local3、20 Local4、21 Local5、22 Local6、23 Local7。
app_name	string	否	syslog 消息中报告的应用名称。
tlsCa	string	否	protocol 为 tls 时使用的 PEM 编码 CA 证书。
id	string	是	服务器生成的目标唯一 id，响应中返回，请求中不接受。

结构 3

字段	类型	必填	说明
label	string	否	界面中显示的可读名称。
enabled	boolean	否	目标当前是否接收事件。
subscribedEvents	array	否	此目标接收的事件名称或事件组前缀，例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。
anonymizeAuditMessages	boolean	否	发送审计消息负载之前，是否进行匿名化。
circuitBreaker	object	否	投递熔断器的调节配置。反复失败后，目标会在冷却窗口内停止发送，避免持续请求异常的接收端。所有字段均可选，省略时使用合理的默认值。 展开字段 字段 类型 必填 说明 circuitBreaker.maxFailures integer 否 熔断器断开前，滑动窗口内允许的最大失败次数。 circuitBreaker.failureWindow integer 否 统计失败次数的滑动窗口，单位为毫秒。
type	string	是	将每个事件发送到 Sentry 项目。 可选值：sentry
dsn	string	是	接收事件的 Sentry DSN。
id	string	是	服务器生成的目标唯一 id，响应中返回，请求中不接受。

下载完整 OpenAPI 定义（JSON）

importResultDto.generated 对象

字段	类型	必填	说明
package	object	是	展开字段 字段 类型 必填 说明 package.sourceN8nVersion string 是 package.sourceId string 是 package.exportedAt string 是
workflows	array	是	展开字段 字段 类型 必填 说明 workflows.[]sourceWorkflowId string 是 工作流在包中的 id。 workflows.[]localId string 是 目标实例上的工作流 id：created 时新建（workflowIdPolicy=new 时生成新 id，source 时使用包中的 id）；updated/skipped 时使用现有工作流的 id。 workflows.[]name string 是 workflows.[]projectId string 是 workflows.[]parentFolderId string 是 workflows.[]activeVersionId string 是 目标实例上的已发布版本（如有）。导入后工作流未发布时为 null。 workflows.[]isArchived boolean 是 导入后工作流在目标上是否归档。采用 new-version 时，遵循包中的 isArchived 标记；被跳过的工作流保留自身状态。 workflows.[]publishing object 是 将所选发布策略应用到此工作流的结果。 展开字段 字段 类型 必填 说明 workflows.[]publishing.state string 是 blocked 表示导入版本无法发布，且没有激活版本，例如工作流使用了空白或不完整凭据，或使用实例未安装的节点类型。如果先前发布的版本仍处于激活状态，state 会为 unchanged，并附带 skippedPublishReason。failed 表示尝试了发布或取消发布，但操作未成功。 可选值：published, unpublished, unchanged, blocked, failed workflows.[]publishing.error string 否 state 为 failed 时返回，说明无法应用发布或取消发布操作的原因。 workflows.[]publishing.blockedReason string 否 state 为 blocked 时返回：导入版本无法发布，且没有激活版本。 可选值：stub-credential, incomplete-credential, missing-node-type workflows.[]publishing.skippedPublishReason string 否 state 为 unchanged，但策略原本要求发布导入版本时返回：先前发布的版本仍处于激活状态，例如更新后凭据为空或不完整。 可选值：stub-credential, incomplete-credential, missing-node-type workflows.[]status string 是 此包中工作流的导入结果。 可选值：created, updated, skipped
removedWorkflows	array	是	此次导入期间从目标移除的工作流。 展开字段 字段 类型 必填 说明 removedWorkflows.[]workflowId string 是 此实例上被移除工作流的 id。 removedWorkflows.[]name string 是 removedWorkflows.[]projectId string 是 对工作流进行对齐处理的项目。 removedWorkflows.[]parentFolderId string 是 工作流原所在文件夹；位于项目根目录时为 null。 removedWorkflows.[]deletion string 是 实际发生的结果，而非 overwriteDeletionPolicy 请求的操作：如果请求 hard-delete，但相应记录尚不能删除，则报告为 archived。 可选值：archived, deleted
removedFolders	array	是	包未定义、且在对齐处理后变为空的文件夹，由 folderConflictPolicy=overwrite 移除。仍包含任何内容的文件夹会保留，因此不会一并清理仅存在于目标的内容。其他策略下始终为空。 展开字段 字段 类型 必填 说明 removedFolders.[]folderId string 是 removedFolders.[]name string 是 removedFolders.[]projectId string 是 removedFolders.[]parentFolderId string 是 原所在文件夹；位于项目根目录时为 null。
folders	array	是	在目标项目中创建或跳过的文件夹结构。 展开字段 字段 类型 必填 说明 folders.[]sourceFolderId string 是 文件夹在包中的 id。 folders.[]localId string 是 目标实例上的文件夹 id，等于 sourceFolderId，即复用文件夹 id。 folders.[]name string 是 folders.[]parentFolderId string 是 目标上解析得到的父文件夹；位于项目根目录时为 null。 folders.[]status string 是 此包中文件夹的导入结果。 可选值：created, skipped
projects	array	是	创建的项目结构，或匹配后更新或保留原样的项目结构，参见 projectConflictPolicy。项目包中会返回；导入独立工作流或文件夹时为空。 展开字段 字段 类型 必填 说明 projects.[]sourceProjectId string 是 项目在包中的 id。 projects.[]localId string 是 目标实例上的项目 id，等于 sourceProjectId，即复用项目 id。 projects.[]name string 是 目标上的项目名称：采用 overwrite 时使用包中的名称，采用 merge 时使用原有名称。 projects.[]status string 是 此包中项目的导入结果。skipped 表示项目已存在，且 projectConflictPolicy=merge 保留了原项目详情；项目内容仍会导入。 可选值：created, updated, skipped
bindings	object	是	导入产生的源 id → 目标 id 映射，每种实体类型一个映射。每个值都将实体在包中的 id 映射到目标实例上的 id。 展开字段 字段 类型 必填 说明 bindings.workflows object 是 bindings.credentials object 是 包清单 requirements.credentials 中的凭据 id → 目标实例上解析得到的凭据 id。同时涵盖匹配的现有凭据，以及通过 credentialMissingMode=create-stub 或 create-with-values 创建的凭据。
credentials	object	是	按解析结果分组的源凭据 id：匹配现有凭据、创建空白占位凭据、创建带初始数据的凭据、创建不完整凭据，或匹配到此次导入已更新的凭据。完整的源→目标 id 映射见 bindings.credentials。 展开字段 字段 类型 必填 说明 credentials.matched array 是 包中匹配到目标实例现有凭据的源凭据 id。 credentials.stubbed array 是 已在目标项目中为其创建空白占位凭据的源凭据 id。 credentials.seeded array 是 已在目标项目中为其创建凭据的源凭据 id；这些凭据包含包内表达式值携带的全部源数据。 credentials.incomplete array 是 已在目标项目中使用包内表达式值创建凭据的源凭据 id，但包未确认其包含全部源数据。这些凭据还需补充信息。导入不会发布使用它们的工作流导入版本，原因为 incomplete-credential。 credentials.updated array 是 此次导入通过 credentialConflictPolicy=overwrite 更改了其匹配凭据的源凭据 id。这些 id 不会列在 matched 中。其他策略下为空。
dataTables	object	是	展开字段 字段 类型 必填 说明 dataTables.matched integer 是 dataTables.created integer 是 dataTables.updated integer 是
variables	object	是	包的变量需求解析结果。仅返回名称，响应绝不包含值。对于项目包，这些数组是在包级别汇总各目标结果得到的并集，可能重叠，例如某名称在一个项目中创建时带有值，在另一个项目中创建为空白占位变量；存在外部并发写入时，只能尽力准确分类。 展开字段 字段 类型 必填 说明 variables.matched array 是 解析到现有变量且保持不变的变量名，优先查找导入项目作用域，再查找全局作用域。此次导入重写的已解析变量会列在 updated 中。 variables.missing array 是 导入后仍未解析到的变量名。variableMissingMode=do-nothing 下，这些仅为警告：导入仍成功，不创建任何变量。成功的 create-stub 或 create-with-value 导入通常使此列表为空。 variables.created array 是 通过 variableMissingMode=create-with-value 使用包内值创建的变量名。空白占位变量会列在 stubbed 中。 variables.stubbed array 是 此次导入创建为空值的变量名：使用了 variableMissingMode=create-stub，或 create-with-value 没有可导出的值。其他结果下为空。 variables.updated array 是 此次导入通过 variableConflictPolicy=overwrite，将其现有值替换为包内值的变量名。其他策略下为空。
tags	object	是	导入工作流引用的标签的解析结果，按源 id 匹配，仅包含标签名称。 展开字段 字段 类型 必填 说明 tags.matched array 是 解析到 id 和名称均相同的现有标签，按原样附加。 tags.created array 是 此次导入通过 tagMissingMode=create 创建的标签，按名称列出。 tags.renamed array 是 通过 tagConflictPolicy=rename 重命名为包内名称的目标标签，按新名称列出。 tags.reconciled array 是 发生名称冲突时，通过 tagConflictPolicy=rename 将 id 改为包（源）id 的现有目标标签；其名称、工作流标签关联和文件夹标签关联均保留。 tags.skipped array 是 通过 tagMissingMode=do-nothing 或 tagConflictPolicy=skip 从导入中丢弃的标签：不创建、不重命名，也不附加到任何导入工作流。

下载完整 OpenAPI 定义（JSON）

packageRequirementConsumer.generated 对象

字段	类型	必填	说明
kind	string	是	可选值：workflow, agent
id	string	是

下载完整 OpenAPI 定义（JSON）

importBlockingIssue.generated 对象

结构 1

字段	类型	必填	说明
type	string	是	可选值：agent-conflict
kind	string	是	可选值：existing, id, task-id
sourceAgentId	string	是
projectId	string	是
sourceTaskId	string	否
targetIds	array	是

结构 2

字段	类型	必填	说明
type	string	是	可选值：agent-invalid
sourceAgentId	string	是
path	string	是
message	string	是

结构 3

字段	类型	必填	说明
type	string	是	可选值：agent-dependency-unresolved
sourceAgentId	string	是
projectId	string	是
dependencyType	string	是	可选值：agent, workflow, credential
referenceId	string	是
path	string	是
reason	string	是	可选值：missing, inaccessible, ambiguous, unsupported

结构 4

字段	类型	必填	说明
type	string	是	可选值：agent-policy-violation
sourceAgentId	string	是
name	string	是
violations	array	是	展开字段 字段 类型 必填 说明 violations.[]kind string 是 violations.[]checkId string 是 violations.[]message string 是 violations.[]subject string 否 violations.[]subjectType string 否 violations.[]scope string 否 violations.[]matchedRuleId string 否 violations.[]projectId string 否 violations.[]optInAvailable boolean 否

结构 5

字段	类型	必填	说明
type	string	是	可选值：workflow-conflict
sourceWorkflowId	string	是
existingWorkflowId	string	是
name	string	是

结构 6

字段	类型	必填	说明
type	string	是	可选值：workflow-lineage-conflict
sourceWorkflowId	string	是
projectId	string	是
existingWorkflows	array	是	展开字段 字段 类型 必填 说明 existingWorkflows.[]id string 是 existingWorkflows.[]name string 是 existingWorkflows.[]isArchived boolean 是

结构 7

字段	类型	必填	说明
type	string	是	可选值：workflow-id-conflict
sourceWorkflowId	string	是
existingWorkflowId	string	是
existingProjectId	string	是	现有工作流所属的项目；无法确定所属项目时为 null。
isArchived	boolean	是	现有工作流是否归档。
name	string	是

结构 8

字段	类型	必填	说明
type	string	是	可选值：workflow-folder-conflict
sourceWorkflowId	string	是
existingWorkflowId	string	是
existingParentFolderId	string	是	匹配工作流当前所在的文件夹；位于项目根目录时为 null。
targetFolderId	string	是	请求导入到的文件夹；项目包将工作流放在项目根目录时为 null。
name	string	是

结构 9

字段	类型	必填	说明
type	string	是	可选值：workflow-archive-forbidden
sourceWorkflowId	string	是
existingWorkflowId	string	是
name	string	是
projectId	string	是	匹配工作流所属的项目。
transition	string	是	导入为使工作流与包中状态一致而需要执行的步骤。 可选值：archive, unarchive

结构 10

字段	类型	必填	说明
type	string	是	可选值：credential-unresolved
kind	string	是	可选值：not_found, unknown_type, source_not_found, type_mismatch
sourceId	string	是
targetId	string	否	目标凭据 id：对于 not_found，是无法解析的显式绑定；对于 type_mismatch，是通过显式绑定或自动匹配已解析到、但类型错误的凭据 id。
expectedType	string	否	对于 type_mismatch：包中工作流节点需要的凭据类型。
actualType	string	否	对于 type_mismatch：已解析目标凭据的实际类型。
usedBy	array	是	展开字段 字段 类型 必填 说明 usedBy.[]kind string 是 可选值：workflow, agent usedBy.[]id string 是

结构 11

字段	类型	必填	说明
type	string	是	可选值：credential-conflict
kind	string	是	differs：在 credentialConflictPolicy=fail 下，包会更改目标凭据的名称或值。divergent：在 overwrite 下，包内两个或多个名称或值不同的凭据解析到了同一个目标凭据。导入不会代为选择其中之一。 可选值：differs, divergent
targetId	string	是	目标凭据的 id。
sourceIds	array	是	解析到该目标凭据的包内凭据 id。对于 differs，是会更改该目标凭据的包内凭据。
name	string	是	目标凭据的名称。
usedBy	array	是	包中使用所列包内凭据的使用方。 展开字段 字段 类型 必填 说明 usedBy.[]kind string 是 可选值：workflow, agent usedBy.[]id string 是

结构 12

字段	类型	必填	说明
type	string	是	可选值：credential-update-forbidden
targetId	string	是	目标凭据的 id。
sourceIds	array	是	解析到此凭据的包内凭据 id。
name	string	是	目标凭据的名称。
usedBy	array	是	包中使用所列包内凭据的使用方。 展开字段 字段 类型 必填 说明 usedBy.[]kind string 是 可选值：workflow, agent usedBy.[]id string 是

结构 13

字段	类型	必填	说明
type	string	是	可选值：project-conflict
kind	string	是	可选值：fail-policy
sourceProjectId	string	是
name	string	是	项目在包中的名称。

结构 14

字段	类型	必填	说明
type	string	是	可选值：folder-conflict
kind	string	是	可选值：parent-mismatch, id-in-other-project, fail-policy
sourceFolderId	string	是
name	string	是
existingParentFolderId	string	否	对于 parent-mismatch：目标上匹配文件夹的当前父文件夹。
expectedParentFolderId	string	否	对于 parent-mismatch：包要求放置该文件夹的父文件夹。
existingProjectId	string	否	对于 id-in-other-project：已拥有此 id 的项目。

结构 15

字段	类型	必填	说明
type	string	是	可选值：workflow-removal-forbidden
workflowId	string	是
name	string	是
projectId	string	是	当时对工作流进行对齐处理的项目。

结构 16

字段	类型	必填	说明
type	string	是	可选值：workflow-removal-conflict
sourceWorkflowId	string	是
workflowId	string	是	所选工作流的目标 id。
projectId	string	是

结构 17

字段	类型	必填	说明
type	string	是	可选值：folder-removal-forbidden
folderId	string	是
name	string	是
projectId	string	是	当时对文件夹进行对齐处理的项目。

结构 18

字段	类型	必填	说明
type	string	是	可选值：data-table-unresolved
kind	string	是	可选值：missing, id-conflict, name-conflict, schema-incompatible, module-disabled, permission-denied
sourceId	string	否	整个导入层面的失败（module-disabled、permission-denied）不返回此字段。
name	string	否
existingProjectId	string	否	对于 id-conflict：拥有冲突目标表的项目。
missingColumns	array	否	对于 schema-incompatible：目标表缺少的包内列。
typeMismatches	array	否	对于 schema-incompatible：目标类型不同的包内列。 展开字段 字段 类型 必填 说明 typeMismatches.[]column string 是 typeMismatches.[]expectedType string 是 typeMismatches.[]actualType string 是
extraColumns	array	否	对于 schema-incompatible，在 fail 策略下：目标上存在、但包内架构中没有的列。
overwriteChanges	array	否	对于 schema-incompatible：overwrite 将对目标表进行的变更。 展开字段 结构 1 结构 2 结构 3 结构 4 结构 5 结构 6
missingScope	string	否	对于 permission-denied：用户缺少的项目作用域。 可选值：dataTable:create, dataTable:update
conflictingTableId	string	否	对于 name-conflict：已占用或声明使用该名称的其他表。
currentName	string	否	对于重命名的 name-conflict：匹配表的当前名称。
usedBy	array	是	展开字段 字段 类型 必填 说明 usedBy.[]kind string 是 可选值：workflow, agent usedBy.[]id string 是

结构 19

字段	类型	必填	说明
type	string	是	可选值：tag-unresolved
kind	string	是	可选值：rename-drift, name-collision, invalid-name, invalid-id, permission-denied
sourceId	string	否	标签在包中的 id。permission-denied 时不返回。
name	string	否	包内标签名称，已去除两端空白。permission-denied 时不返回。
missingScope	string	否	对于 permission-denied：导入用户缺少的全局作用域。 可选值：tag:create, tag:update
existingTagId	string	否	存在争用的目标标签 id：当前占用所需名称的其他标签，或原本要在对齐处理中更改 id、但该操作被阻止的目标标签。如果只是两个包内标签彼此冲突，而非争用目标标签，则不返回。
existingName	string	否	对于 rename-drift：相同 id 的目标标签当前名称。
usedBy	array	是	包中引用源标签的使用方。不包括被跳过的使用方，也不包括关联到争用目标标签的工作流。 展开字段 字段 类型 必填 说明 usedBy.[]kind string 是 可选值：workflow, agent usedBy.[]id string 是

结构 20

字段	类型	必填	说明
type	string	是	可选值：variable-unresolved
name	string	是	在目标项目和全局作用域中均无匹配项的需求名称。
usedBy	array	是	展开字段 字段 类型 必填 说明 usedBy.[]kind string 是 可选值：workflow, agent usedBy.[]id string 是

结构 21

字段	类型	必填	说明
type	string	是	可选值：variable-conflict
name	string	是	值不同的变量名称。
projectId	string	否	已解析变量所属的项目；在全局作用域解析到时不返回。
usedBy	array	是	展开字段 字段 类型 必填 说明 usedBy.[]kind string 是 可选值：workflow, agent usedBy.[]id string 是

结构 22

字段	类型	必填	说明
type	string	是	可选值：variable-limit-exceeded
limit	integer	是	实例变量配额。
remaining	integer	是	配额内仍可创建的变量行数。导入被阻止是因为 requested 超过此剩余数，而非超过 limit。
requested	integer	是	导入原本会创建的新变量行数，已按目标去重。
names	array	是	导入原本会创建的唯一变量名称。
usedBy	array	是	包中引用任一所列变量的使用方。 展开字段 字段 类型 必填 说明 usedBy.[]kind string 是 可选值：workflow, agent usedBy.[]id string 是

结构 23

字段	类型	必填	说明
type	string	是	可选值：missing-node-type
nodeType	string	是	包中工作流使用的完整节点类型名称。
typeVersion	number	是	包中工作流使用的节点类型版本。
usedBy	array	是	包中使用此节点类型和版本的使用方。 展开字段 字段 类型 必填 说明 usedBy.[]kind string 是 可选值：workflow, agent usedBy.[]id string 是

结构 24

字段	类型	必填	说明
type	string	是	可选值：policy-violation
sourceWorkflowId	string	是	工作流在包中的 id。
name	string	是
violations	array	是	展开字段 字段 类型 必填 说明 violations.[]kind string 是 violations.[]checkId string 是 violations.[]message string 是 violations.[]subject string 否 violations.[]subjectType string 否 violations.[]scope string 否 violations.[]matchedRuleId string 否 violations.[]projectId string 否 violations.[]optInAvailable boolean 否

结构 25

字段	类型	必填	说明
type	string	是	可选值：credential-policy-violation
sourceId	string	是	凭据在包中的 id。
targetId	string	否	目标实例上匹配凭据的 id。策略在 credentialConflictPolicy=overwrite 下拒绝更新此凭据时返回；策略拒绝的是导入原本会创建的凭据时不返回。
name	string	否
credentialType	string	是
usedBy	array	是	包中使用此凭据的使用方。 展开字段 字段 类型 必填 说明 usedBy.[]kind string 是 可选值：workflow, agent usedBy.[]id string 是
violations	array	是	展开字段 字段 类型 必填 说明 violations.[]kind string 是 violations.[]checkId string 是 violations.[]message string 是 violations.[]subject string 否 violations.[]subjectType string 否 violations.[]scope string 否 violations.[]matchedRuleId string 否 violations.[]projectId string 否 violations.[]optInAvailable boolean 否

字段	类型	必填	说明
kind	string	是	可选值：workflow, agent
id	string	是

下载完整 OpenAPI 定义（JSON）

policyEffectivePublicDto.generated 对象

字段	类型	必填	说明
scopeId	string	是
rules	array	是	展开字段 字段 类型 必填 说明 rules.[]id string 是 rules.[]action string 是 可选值：allow, deny, delegate rules.[]selector object 是 展开字段 结构 1 结构 2
defaultAction	string	是	可选值：allow, deny, delegate
version	integer	是

下载完整 OpenAPI 定义（JSON）

policyEffectiveWriteResultPublicDto.generated 对象

字段	类型	必填	说明
scopeId	string	是
rules	array	是	展开字段 字段 类型 必填 说明 rules.[]id string 是 rules.[]action string 是 可选值：allow, deny, delegate rules.[]selector object 是 展开字段 结构 1 结构 2
defaultAction	string	是	可选值：allow, deny, delegate
version	integer	是
warnings	array	是	展开字段 结构 1 字段 类型 必填 说明 warnings.[]kind string 是 可选值：shadowed warnings.[]ruleId string 是 warnings.[]shadowedByRuleId string 是 结构 2 字段 类型 必填 说明 warnings.[]kind string 是 可选值：notLoaded warnings.[]ruleId string 是

下载完整 OpenAPI 定义（JSON）

policyDocumentWriteResultPublicDto.generated 对象

字段	类型	必填	说明
policy	object	是	展开字段 字段 类型 必填 说明 policy.id string 是 policy.kind string 是 policy.rules array 是 展开字段 字段 类型 必填 说明 policy.rules.[]id string 是 policy.rules.[]action string 是 可选值：allow, deny, delegate policy.rules.[]selector object 是 policy.version integer 是 policy.updatedBy string 是 policy.createdAt string 是 policy.updatedAt string 是
warnings	array	是	展开字段 结构 1 字段 类型 必填 说明 warnings.[]kind string 是 可选值：shadowed warnings.[]ruleId string 是 warnings.[]shadowedByRuleId string 是 结构 2 字段 类型 必填 说明 warnings.[]kind string 是 可选值：notLoaded warnings.[]ruleId string 是

下载完整 OpenAPI 定义（JSON）

policyAttachmentsPublicDto.generated 对象

字段	类型	必填	说明
attachments	array	是	展开字段 字段 类型 必填 说明 attachments.[]policyId string 是 attachments.[]rules array 是 attachments.[]priority integer 是 attachments.[]isFloor boolean 是
version	integer	是

下载完整 OpenAPI 定义（JSON）

otelSettingsPublicDto.generated 对象

字段	类型	必填	说明
enabled	boolean	是	是否启用 OpenTelemetry 跟踪。
exporterProtocol	string	是	用于导出跟踪片段（span）的传输协议。收集器通常在端口 4318 提供 OTLP/HTTP，在端口 4317 提供 OTLP/gRPC。两种协议都由端点的 URL 协议（http:// 或 https://）控制 TLS。此字段可选：写入时省略会选择 http/protobuf，但实例通过环境变量将此字段设为其他值时，会以 409 拒绝该写入。 可选值：http/protobuf, grpc 默认值："http/protobuf"
exporterEndpoint	string	是	用于接收跟踪数据的 OTLP 收集器基础 URL。必须使用 http:// 或 https:// URL，由 URL 协议决定是否使用 TLS：对于 gRPC，https:// 使用 SSL，http:// 使用明文。
exporterTracingPath	string	是	追加到端点上的 OTLP 跟踪信号路径。exporterProtocol 为 grpc 时忽略，因为 gRPC 不使用 URL 路径。
exporterServiceName	string	是	每个 span 上报告的 service.name 资源属性。
exporterHeaders	string	是	发送到 OTLP 收集器的附加请求头，使用单个字符串表示，以逗号分隔各个 key=value，例如 authorization=Bearer my-token,x-tenant-id=acme。每个键和值两端的空白会被移除；值可以包含空格，但不能包含逗号。未使用时填写空字符串。
tracesSampleRate	number	是	跟踪采样比例，范围为 0（不采样）到 1（全部采样）。
startupConnectivityTimeoutMs	integer	是	检查收集器是否可访问时的等待时间，单位为毫秒；也用作发送测试跟踪端点的超时时长。
includeNodeSpans	boolean	是	除工作流 span 外，是否还为每次节点执行生成 span。
emitWorkflowStartSpan	boolean	是	每次执行或恢复运行的片段开始时，是否生成持续时间为 0 ms 的 workflow.execute.started span。此字段可选：写入时省略会选择 false，但实例通过环境变量将此字段设为 true 时，会以 409 拒绝该写入。
emitNodeStartSpan	boolean	是	每个节点 span 开始时，是否生成持续时间为 0 ms 的 node.execute.started span。这会使节点 span 数量加倍。includeNodeSpans 为 false 时无效。此字段可选：写入时省略会选择 false，但实例通过环境变量将此字段设为 true 时，会以 409 拒绝该写入。
injectOutbound	boolean	是	是否向节点发出的 HTTP 请求注入跟踪上下文请求头。
productionExecutionsOnly	boolean	是	为 true 时，仅跟踪已发布（激活）工作流的生产执行，不跟踪手动或测试运行。

下载完整 OpenAPI 定义（JSON）

promotionProviderPublicDto.generated 对象

字段	类型	必填	说明
id	string	是
name	string	是
type	string	是	可选值：git, gitlab
authType	string	是	可选值：ssh-key, token
config	联合类型	是	展开字段 结构 1 字段 类型 必填 说明 config.schemaVersion number 是 可选值：1 config.publicKey string 是 config.keyType string 是 可选值：ed25519, rsa 结构 2 字段 类型 必填 说明 config.schemaVersion number 是 可选值：1 结构 3 字段 类型 必填 说明 config.schemaVersion number 是 可选值：1 config.baseUrl string 是
createdAt	string	是
updatedAt	string	是

下载完整 OpenAPI 定义（JSON）

promotionEnvironmentPublicDto.generated 对象

结构 1

字段	类型	必填	说明
id	string	是
name	string	是
scope	string	是	可选值：instance, projects
remote	object	是	展开字段 字段 类型 必填 说明 remote.schemaVersion number 是 可选值：1 remote.remoteUrl string 是 remote.repositoryPath string 否 Git 主机远程地址所存储的仓库路径。将其用作 repositoryId 列出分支前，请进行 URL 编码。请求不接受此字段。
provider	object	是	展开字段 字段 类型 必填 说明 provider.id string 是 provider.name string 是 provider.type string 是 可选值：git, gitlab provider.authType string 是 可选值：ssh-key, token provider.createdAt string 是 provider.updatedAt string 是
createdAt	string	是
updatedAt	string	是
direction	string	是	可选值：apply
settings	object	是	展开字段 字段 类型 必填 说明 settings.schemaVersion number 是 可选值：1 settings.branchName string 是
checkout	object	是	展开字段 字段 类型 必填 说明 checkout.hasCheckout boolean 是 checkout.matchesEnvironment boolean 是

结构 2

字段	类型	必填	说明
id	string	是
name	string	是
scope	string	是	可选值：instance, projects
remote	object	是	展开字段 字段 类型 必填 说明 remote.schemaVersion number 是 可选值：1 remote.remoteUrl string 是 remote.repositoryPath string 否 Git 主机远程地址所存储的仓库路径。将其用作 repositoryId 列出分支前，请进行 URL 编码。请求不接受此字段。
provider	object	是	展开字段 字段 类型 必填 说明 provider.id string 是 provider.name string 是 provider.type string 是 可选值：git, gitlab provider.authType string 是 可选值：ssh-key, token provider.createdAt string 是 provider.updatedAt string 是
createdAt	string	是
updatedAt	string	是
direction	string	是	可选值：promote
settings	object	是	展开字段 字段 类型 必填 说明 settings.schemaVersion number 是 可选值：1 settings.baseBranchName string 是 settings.createBranchOnPromotion boolean 是
checkout	object	是	展开字段 字段 类型 必填 说明 checkout.hasCheckout boolean 是 checkout.matchesEnvironment boolean 是

下载完整 OpenAPI 定义（JSON）

promotionCheckoutPublicDto.generated 对象

字段	类型	必填	说明
environmentId	string	是
direction	string	是	可选值：apply, promote
branchName	string	是
hasCheckout	boolean	是

下载完整 OpenAPI 定义（JSON）

promotePackageResultDto.generated 对象

字段	类型	必填	说明
environmentId	string	是
counts	object	是	展开字段 字段 类型 必填 说明 counts.workflows integer 是 counts.folders integer 是 counts.credentials integer 是 counts.dataTables integer 是 counts.variables integer 是 counts.tags integer 是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
review	object	否	展开字段 字段 类型 必填 说明 review.reviewId string 是 review.number integer 是 review.webUrl string 是
warnings	array	否	展开字段 字段 类型 必填 说明 warnings.[]message string 是 warnings.[]linkUrl string 否

下载完整 OpenAPI 定义（JSON）

promotionCredentialExpressionValue.generated 对象

结构 1

结构 2

结构 1

结构 2

结构 3

结构 3

下载完整 OpenAPI 定义（JSON）

applyPackageResultDto.generated 对象

结构 1

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：applied
counts	object	是	展开字段 字段 类型 必填 说明 counts.projects object 是 展开字段 字段 类型 必填 说明 counts.projects.created integer 是 counts.projects.updated integer 是 counts.projects.skipped integer 是 counts.projects.deleted integer 是 counts.folders object 是 展开字段 字段 类型 必填 说明 counts.folders.created integer 是 counts.folders.updated integer 是 Apply 为匹配分支而移动或重命名的现有文件夹。 counts.folders.skipped integer 是 counts.folders.moved integer 是 Apply 将其移到项目内其他父文件夹下的已更新文件夹，也包含在 updated 中。 counts.folders.renamed integer 是 Apply 将其名称改为分支上名称的已更新文件夹，也包含在 updated 中。 counts.folders.removed integer 是 counts.workflows object 是 展开字段 字段 类型 必填 说明 counts.workflows.created integer 是 counts.workflows.updated integer 是 counts.workflows.skipped integer 是 counts.workflows.moved integer 是 Apply 同时将其移到项目内其他文件夹的已更新工作流，也包含在 updated 中。 counts.workflows.archived integer 是 counts.workflows.deleted integer 是 counts.workflows.publishing object 是 counts.credentials object 是 展开字段 字段 类型 必填 说明 counts.credentials.matched integer 是 counts.credentials.stubbed integer 是 counts.credentials.updated integer 是 counts.dataTables object 是 展开字段 字段 类型 必填 说明 counts.dataTables.matched integer 是 counts.dataTables.created integer 是 counts.dataTables.updated integer 是 counts.variables object 是 展开字段 字段 类型 必填 说明 counts.variables.matched integer 是 counts.variables.created integer 是 counts.variables.updated integer 是 counts.variables.stubbed integer 是 counts.variables.missing integer 是 counts.tags object 是 展开字段 字段 类型 必填 说明 counts.tags.matched integer 是 counts.tags.created integer 是 counts.tags.renamed integer 是 counts.tags.reconciled integer 是 counts.tags.skipped integer 是
warnings	array	是	展开字段 字段 类型 必填 说明 warnings.[]kind string 是 可选值：variable warnings.[]code string 是 可选值：variable-shadowed warnings.[]name string 是 warnings.[]scope object 是 warnings.[]consumers array 是

结构 2

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：blocked
preflight	object	是	展开字段 字段 类型 必填 说明 preflight.missingProjects array 是 包中存在、但实例上不存在的项目。预检会保留其元数据，不检查项目创建规则。项目创建 API 可能拒绝无效值。 preflight.missingBindings array 是 preflight.accessRequirements array 是 preflight.conflicts array 是 preflight.warnings array 是

结构 3

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：source-changed

结构 1

结构 2

结构 1

结构 2

结构 3

结构 3

下载完整 OpenAPI 定义（JSON）

roleMappingRulePublicDto.generated 对象

字段	类型	必填	说明
id	string	是
expression	string	是
role	string	是
type	string	是	可选值：instance, project
order	integer	是
projectIds	array	是
createdAt	string	是
updatedAt	string	是

下载完整 OpenAPI 定义（JSON）

rolePublicDto.generated 对象

字段	类型	必填	说明
slug	string	是
displayName	string	是
description	string	是
systemRole	boolean	是
roleType	string	是	可选值：project, global
scopes	array	是
createdAt	string	是
updatedAt	string	是

下载完整 OpenAPI 定义（JSON）

securityPolicyPublicDto.generated 对象

字段	类型	必填	说明
personalSpacePublishing	boolean	是	成员是否可以从个人空间发布工作流和智能体。
personalSpaceSharing	boolean	是	成员是否可以从个人空间共享工作流和凭据。
publishedPersonalWorkflowsCount	integer	是	当前已发布的个人工作流数量，用于收紧策略前了解影响。 只读。
sharedPersonalWorkflowsCount	integer	是	当前与其他用户共享的个人工作流数量。 只读。
sharedPersonalCredentialsCount	integer	是	当前与其他用户共享的个人凭据数量。 只读。
redactionEnforcement	object	是	展开字段 字段 类型 必填 说明 redactionEnforcement.floor string 是 在整个实例上强制执行的最低执行数据遮蔽级别。 可选值：off, production, all

下载完整 OpenAPI 定义（JSON）

oidcConfigurationPublicDto.generated 对象

字段	类型	必填	说明
clientId	string	是	向 OIDC 提供方注册 n8n 时获得的客户端 ID。
clientSecret	string	是	向 OIDC 提供方注册 n8n 时获得的客户端密钥。已设置时，读取会遮蔽，绝不以明文返回。
discoveryEndpoint	string	是	OIDC 提供方的 well-known 发现端点。
loginEnabled	boolean	是	是否启用 OIDC 单点登录。
prompt	string	是	向 OIDC 提供方进行身份验证时使用的 prompt 参数。 可选值：none, login, consent, select_account, create
authenticationContextClassReference	array	是	授权请求中包含的 ACR 值，即 acr_values 参数，按偏好顺序排列。
additionalScopes	string	是	请求的附加作用域，以空格分隔。n8n 始终请求 openid、profile 和 email。
emailVerifiedRequired	boolean	是	接受登录之前，是否要求身份提供方断言用户邮箱已验证。关闭时，只有明确的否定断言会被拒绝。
rpInitiatedLogoutEnabled	boolean	是	退出 n8n 时，是否同时通过 RP-Initiated Logout 结束 OIDC 提供方的会话。关闭时，仅退出 n8n 本地会话。

下载完整 OpenAPI 定义（JSON）

samlConfigurationPublicDto.generated 对象

字段	类型	必填	说明
entityID	string	是	服务提供方实体 ID，即元数据 URL。 只读。
returnUrl	string	是	断言消费服务（ACS）返回 URL。 只读。
mapping	object	是	SAML 属性到 n8n 用户字段的映射。 展开字段 字段 类型 必填 说明 mapping.email string 是 映射到用户邮箱的 SAML 属性。 mapping.firstName string 是 映射到用户名字的 SAML 属性。 mapping.lastName string 是 映射到用户姓氏的 SAML 属性。 mapping.userPrincipalName string 是 映射到用户主体名称的 SAML 属性。 mapping.emailVerified string 是 表明身份提供方是否已验证用户邮箱的 SAML 属性；未使用时为空字符串。 mapping.n8nInstanceRole string 是 映射到 n8n 实例角色的 SAML 属性。 mapping.n8nProjectRoles array 是 映射到 n8n 项目角色的 SAML 属性，格式为 <projectId>:<role>。
metadata	string	是	XML 格式的身份提供方元数据。由于包含 IdP 证书，已设置时会在读取时遮蔽，绝不以明文返回。未设置时使用空字符串。
metadataUrl	string	是	获取身份提供方元数据的 URL；未设置时使用空字符串。
ignoreSSL	boolean	是	通过 URL 获取元数据时，是否忽略 SSL 证书错误。
loginBinding	string	是	SAML 登录请求的绑定方式。 可选值：redirect, post
loginEnabled	boolean	是	是否启用 SAML 登录。
loginLabel	string	是	SAML 登录按钮显示的标签。
authnRequestsSigned	boolean	是	是否对身份验证请求签名。
wantAssertionsSigned	boolean	是	是否要求断言带有签名。
wantMessageSigned	boolean	是	是否要求 SAML 消息带有签名。
emailVerifiedRequired	boolean	是	按邮箱将登录关联到现有用户之前，是否要求身份提供方断言用户邮箱已验证。关闭时，只有明确的否定断言会被拒绝。
signingPrivateKey	string	是	用于签署 SAML AuthnRequests 的 PEM 编码私钥。已设置时，读取会遮蔽，绝不以明文返回。未设置时使用空字符串。
signingCertificate	string	是	PEM 编码证书，包含与签名私钥匹配的公钥。已设置时，读取会遮蔽，绝不以明文返回。未设置时使用空字符串。
acsBinding	string	是	断言消费服务的绑定方式。 可选值：redirect, post
signatureConfig	object	是	SAML 请求与响应中的签名配置。 展开字段 字段 类型 必填 说明 signatureConfig.prefix string 是 signatureConfig.location object 是 展开字段 字段 类型 必填 说明 signatureConfig.location.reference string 是 signatureConfig.location.action string 是 可选值：before, after, prepend, append
relayState	string	是	SAML 请求的默认 relay state 值；未设置时使用空字符串。

下载完整 OpenAPI 定义（JSON）

tagPublicDto.generated 对象

字段	类型	必填	说明
id	string	是	只读。
name	string	是
createdAt	string	是	只读。
updatedAt	string	是	只读。

下载完整 OpenAPI 定义（JSON）

workflowPublicDto.generated 对象

字段	类型	必填	说明
id	string	是
name	string	是
description	string	是
active	boolean	是	已弃用。请改为检查 activeVersionId 是否非 null。
activeVersionId	string	是
createdAt	string	是
updatedAt	string	是
isArchived	boolean	是
versionId	string	是
versionCounter	number	是
sourceWorkflowId	string	是
triggerCount	number	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	是	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
settings	object	是	工作流的执行和行为设置 展开字段 字段 类型 必填 说明 settings.saveExecutionProgress 联合类型 否 展开字段 结构 1 结构 2 settings.saveManualExecutions 联合类型 否 展开字段 结构 1 结构 2 settings.saveDataErrorExecution string 否 可选值：DEFAULT, all, none settings.saveDataSuccessExecution string 否 可选值：DEFAULT, all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
staticData	object	是	工作流在执行之间保留的数据
pinData	object	否	节点的固定示例数据，以节点名称为键
meta	object	是	工作流元数据，例如模板信息 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	展开字段 字段 类型 必填 说明 tags.[]id string 是 只读。 tags.[]name string 是 tags.[]createdAt string 是 只读。 tags.[]updatedAt string 是 只读。
shared	array	是	展开字段 字段 类型 必填 说明 shared.[]role string 是 shared.[]workflowId string 是 shared.[]projectId string 是 shared.[]project object 是 展开字段 字段 类型 必填 说明 shared.[]project.id string 是 只读。 shared.[]project.name string 是 shared.[]project.type string 是 可选值：personal, team 只读。 shared.[]project.icon object 是 项目图标；项目没有图标时为 null shared.[]project.description string 是 shared.[]project.customTelemetryTags array 是 shared.[]project.creatorId string 是 shared.[]project.createdAt string 是 只读。 shared.[]project.updatedAt string 是 只读。 shared.[]createdAt string 是 shared.[]updatedAt string 是
activeVersion	object	是	展开字段 字段 类型 必填 说明 activeVersion.versionId string 是 activeVersion.workflowId string 是 activeVersion.nodes array 是 组成工作流的节点 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.connections object 是 节点之间的连接，以源节点名称为键 activeVersion.nodeGroups array 是 在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 是 activeVersion.name string 是 activeVersion.description string 是 activeVersion.autosaved boolean 是 activeVersion.createdAt string 是 activeVersion.updatedAt string 是 activeVersion.workflowPublishHistory array 是 展开字段 字段 类型 必填 说明 activeVersion.workflowPublishHistory.[]id number 是 activeVersion.workflowPublishHistory.[]workflowId string 是 activeVersion.workflowPublishHistory.[]versionId string 是 activeVersion.workflowPublishHistory.[]event string 是 可选值：activated, deactivated activeVersion.workflowPublishHistory.[]userId string 是 activeVersion.workflowPublishHistory.[]createdAt string 是

下载完整 OpenAPI 定义（JSON）

workflowPublishPublicDto.generated 对象

字段	类型	必填	说明
id	string	是
name	string	是
description	string	是
active	boolean	是	已弃用。请改为检查 activeVersionId 是否非 null。
activeVersionId	string	是
createdAt	string	是
updatedAt	string	是
isArchived	boolean	是
versionId	string	是
versionCounter	number	是
sourceWorkflowId	string	是
triggerCount	number	是
nodes	array	是	组成工作流的节点 展开字段 字段 类型 必填 说明 nodes.[]id string 否 nodes.[]name string 否 nodes.[]webhookId string 否 nodes.[]disabled boolean 否 nodes.[]notesInFlow boolean 否 nodes.[]notes string 否 nodes.[]type string 否 nodes.[]typeVersion number 否 nodes.[]executeOnce boolean 否 nodes.[]alwaysOutputData boolean 否 nodes.[]retryOnFail boolean 否 nodes.[]maxTries number 否 nodes.[]waitBetweenTries number 否 nodes.[]continueOnFail boolean 否 请改用 onError nodes.[]onError string 否 nodes.[]position array 否 nodes.[]parameters object 否 nodes.[]credentials object 否 nodes.[]customTelemetryTags object 否 展开字段 字段 类型 必填 说明 nodes.[]customTelemetryTags.tag array 否
connections	object	是	节点之间的连接，以源节点名称为键
nodeGroups	array	是	在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 nodeGroups.[]id string 是 节点分组的唯一标识符 nodeGroups.[]name string 是 节点分组的显示名称 nodeGroups.[]description string 否 节点分组的可选纯文本说明 nodeGroups.[]nodeIds array 是 属于此分组的节点 ID
settings	object	是	工作流的执行和行为设置 展开字段 字段 类型 必填 说明 settings.saveExecutionProgress 联合类型 否 展开字段 结构 1 结构 2 settings.saveManualExecutions 联合类型 否 展开字段 结构 1 结构 2 settings.saveDataErrorExecution string 否 可选值：DEFAULT, all, none settings.saveDataSuccessExecution string 否 可选值：DEFAULT, all, none settings.executionTimeout number 否 settings.errorWorkflow string 否 包含错误触发器节点的工作流 ID。 settings.timezone string 否 settings.executionOrder string 否 settings.binaryMode string 否 控制如何从节点输入中解析二进制数据。这是内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 可选值：separate, combined settings.engineType string 否 运行此工作流的执行引擎。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。 settings.callerPolicy string 否 控制哪些工作流可以通过 Execute Workflow 节点调用此工作流，默认为 workflowsFromSameOwner。 可选项： any：任何工作流均可调用此工作流，不作限制。 none：其他工作流均不能调用此工作流，即完全阻止。 workflowsFromSameOwner（默认）：仅属于同一项目的工作流可以调用此工作流。 workflowsFromAList：仅 callerIds 中列出的工作流可以调用此工作流。 可选值：any, none, workflowsFromAList, workflowsFromSameOwner settings.callerIds string 否 允许调用此工作流的工作流 ID 列表，以逗号分隔，仅在 workflowsFromAList 策略下使用 settings.timeSavedMode string 否 控制每次执行节省时间的计算方式。 可选项： fixed：使用 timeSavedPerExecution 的值，适用于每次执行节省时间相同的情况。 dynamic：根据实际执行指标计算节省时间，忽略 timeSavedPerExecution。 可选值：fixed, dynamic settings.timeSavedPerExecution number 否 每次执行预计节省的时间，单位为分钟 settings.redactionPolicy string 否 控制是否遮蔽此工作流的执行数据。 可选项： none（默认）：不遮蔽，存储所有执行数据。 non-manual：仅遮蔽生产执行，即非手动触发的执行。 manual-only：仅遮蔽手动触发的执行。 all：遮蔽手动和生产模式的全部执行。 可选值：none, non-manual, manual-only, all settings.redactCallerExecutions boolean 否 控制将此工作流作为子工作流调用的工作流，是否也在相同通道上遮蔽其执行数据。调用方的执行记录会保留此工作流输出的副本。默认为 true，仅当此工作流的输出不敏感时才应关闭。此工作流从自身子工作流收到的遮蔽要求，始终会传递给调用方。 settings.availableInMCP boolean 否 控制能否通过模型上下文协议（MCP）访问此工作流。默认为 false。工作流必须处于激活状态，且至少包含一个激活的 Webhook 节点。 settings.customTelemetryTags array 否 展开字段 字段 类型 必填 说明 settings.customTelemetryTags.[]key string 是 settings.customTelemetryTags.[]value string 是 settings.credentialResolverId string 否 为此工作流解析凭据的凭据解析器 ID。这是通过凭据解析器配置管理的内部派生设置，不应通过编程方式设置。工作流响应中会包含此项以供参考，但创建或更新工作流时传入的任何值都会被忽略。
staticData	object	是	工作流在执行之间保留的数据
pinData	object	否	节点的固定示例数据，以节点名称为键
meta	object	是	工作流元数据，例如模板信息 展开字段 字段 类型 必填 说明 meta.onboardingId string 否 meta.templateId string 否 meta.instanceId string 否 meta.templateCredsSetupCompleted boolean 否
tags	array	否	展开字段 字段 类型 必填 说明 tags.[]id string 是 只读。 tags.[]name string 是 tags.[]createdAt string 是 只读。 tags.[]updatedAt string 是 只读。
activeVersion	object	是	展开字段 字段 类型 必填 说明 activeVersion.versionId string 是 activeVersion.workflowId string 是 activeVersion.nodes array 是 组成工作流的节点 展开字段 字段 类型 必填 说明 activeVersion.nodes.[]id string 否 activeVersion.nodes.[]name string 否 activeVersion.nodes.[]webhookId string 否 activeVersion.nodes.[]disabled boolean 否 activeVersion.nodes.[]notesInFlow boolean 否 activeVersion.nodes.[]notes string 否 activeVersion.nodes.[]type string 否 activeVersion.nodes.[]typeVersion number 否 activeVersion.nodes.[]executeOnce boolean 否 activeVersion.nodes.[]alwaysOutputData boolean 否 activeVersion.nodes.[]retryOnFail boolean 否 activeVersion.nodes.[]maxTries number 否 activeVersion.nodes.[]waitBetweenTries number 否 activeVersion.nodes.[]continueOnFail boolean 否 请改用 onError activeVersion.nodes.[]onError string 否 activeVersion.nodes.[]position array 否 activeVersion.nodes.[]parameters object 否 activeVersion.nodes.[]credentials object 否 activeVersion.nodes.[]customTelemetryTags object 否 activeVersion.connections object 是 节点之间的连接，以源节点名称为键 activeVersion.nodeGroups array 是 在画布上以框架显示的节点视觉分组 展开字段 字段 类型 必填 说明 activeVersion.nodeGroups.[]id string 是 节点分组的唯一标识符 activeVersion.nodeGroups.[]name string 是 节点分组的显示名称 activeVersion.nodeGroups.[]description string 否 节点分组的可选纯文本说明 activeVersion.nodeGroups.[]nodeIds array 是 属于此分组的节点 ID activeVersion.authors string 是 activeVersion.name string 是 activeVersion.description string 是 activeVersion.autosaved boolean 是 activeVersion.createdAt string 是 activeVersion.updatedAt string 是 activeVersion.workflowPublishHistory array 是 展开字段 字段 类型 必填 说明 activeVersion.workflowPublishHistory.[]id number 是 activeVersion.workflowPublishHistory.[]workflowId string 是 activeVersion.workflowPublishHistory.[]versionId string 是 activeVersion.workflowPublishHistory.[]event string 是 可选值：activated, deactivated activeVersion.workflowPublishHistory.[]userId string 是 activeVersion.workflowPublishHistory.[]createdAt string 是

下载完整 OpenAPI 定义（JSON）

workflowTagsPublicDto.generated 对象

字段	类型	必填	说明
[]id	string	是	只读。
[]name	string	是
[]createdAt	string	是	只读。
[]updatedAt	string	是	只读。

下载完整 OpenAPI 定义（JSON）