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

OIDC SSO 设置

OIDC SSO 设置相关操作

获取 OIDC SSO 配置

获取当前 OIDC SSO 配置，包括界面中提供的所有字段。读取时会遮蔽客户端密钥，绝不以明文返回。需要 `oidc:manage` 作用域，并获得 OIDC 功能许可。

GET/settings/sso/oidc

响应

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

响应结构：200 · application/json

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

设置 OIDC SSO 配置

设置 OIDC SSO 配置。更新使用与界面相同的校验，并以相同方式生效。`clientId`、`clientSecret` 和 `discoveryEndpoint` 为必填项；提交已遮蔽的客户端密钥标记值，可保持已存储密钥不变。需要 `oidc:manage` 作用域，并获得 OIDC 功能许可。响应中会遮蔽客户端密钥。配置由环境变量以声明方式管理时，写入会以 409 拒绝，且不作任何更改。

PUT/settings/sso/oidc

请求体

application/json

字段	类型	必填	说明
clientId	string	是	向 OIDC 提供方注册 n8n 时获得的客户端 ID。
clientSecret	string	是	向 OIDC 提供方注册 n8n 时获得的客户端密钥。提交读取时返回的遮蔽标记值，可保持已存储密钥不变。
discoveryEndpoint	string	是	OIDC 提供方的 well-known 发现端点。
loginEnabled	boolean	是	是否启用 OIDC 单点登录。
prompt	string	是	身份验证时使用的 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 本地会话。

响应

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

响应结构：200 · application/json

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