文档中心

API 网关

认证鉴权

OAuth2 单点登录插件

OAuth2 单点登录插件支持验证用户请求中的 Token 或授权凭证合法性，完成身份校验后转发请求，用于保障 API 访问安全，本文介绍如何创建 OAuth2 单点登录插件。

背景信息

API 网关的 OAuth2 单点登录插件，是将 OAuth 协议与单点登录（SSO）结合，通过 API 网关实现多应用统一身份验证的方案，简化登录流程、保障 API 访问安全。

前提条件

已创建网关实例，操作详情参见创建实例。

已创建服务，操作详情参见创建服务。

已创建路由，操作详情参见创建路由。

已在身份认证平台完成应用注册，并获取 OIDC Discovery 地址、客户端 ID 和客户端密钥。

操作步骤

在顶部导航栏，选择目标地域。

在左侧导航栏实例管理下拉框中选择目标实例后，单击插件中心 > 认证鉴权 > OAuth2 单点登录插件。

单击创建插件，配置插件规则。

配置项	说明
生效级别	选择插件的生效级别，包括：服务级别：插件在服务内生效，需要指定生效的目标实例和目标服务。路由级别：插件在路由内生效，需要指定生效的目标实例、目标服务和目标路由。
所属服务	选择插件所属服务。
所属路由	选择插件所属路由。
OAuth 认证	支持以下方式配置认证服务地址。从 Identity 选择：选择用户池和客户端。通过 OIDC Discovery 地址获取：输入 OIDC Discovery 地址后单击解析，系统自动填充授权端点和令牌端点。 OIDC Discovery 地址：OIDC 服务发现端点的完整 URL。输入后单击解析，系统将自动获取并填充授权端点和令牌端点地址。格式示例：https://<your-domain>/.well-known/openid-configuration。授权端点：OAuth 认证服务器的授权地址，用于引导用户完成身份认证并获取授权码。令牌端点：OAuth 认证服务器的令牌签发地址，用于凭授权码换取 Access Token。 Client ID：在身份认证平台注册应用时获取的客户端 ID，用于标识当前应用的身份。填写身份认证平台为您分配的应用 ID。 Client Secret：在身份认证平台注册应用时获取的客户端密钥，与 Client ID 配合使用，用于验证应用身份的合法性。填写身份认证平台为您分配的密钥字符串。自定义配置：手动填写授权端点和令牌端点地址，参数说明参见通过 OIDC Discovery 地址获取。
重定向 URL	填写认证后跳转地址时，必须和注册的地址保持一致，这样才能确保认证结果安全返回给客户端，避免认证凭证被非法地址获取。例如，网关的域名是 example.com，跳转路径是 /callback，那就要在身份认证平台里填写完整地址 https://example.com/callback。
Token 有效期	填写 Token 有效时长，Token 过期需重新获取，降低凭证泄露风险。
隐藏认证信息	开启后，会在 API 请求转发到后端时，将认证相关 Header 隐藏，避免认证过程中密钥、Token 等敏感数据明文传输或展示，减少信息泄露隐患。该功能默认关闭。
允许匿名访问	开启后，支持指定部分接口无需 OAuth 认证直接访问，满足公开资源（如登录页）的直接访问需求。该功能默认关闭。
忽略 Options	开启后，跳过对预检请求（Options）的 OAuth 认证校验，避免跨域场景下预检请求被拦截，保障跨域流程正常。该功能默认关闭。

单击确定，完成配置。

最近更新时间：2026.08.10 17:59:43

这个页面对您有帮助吗？

有用

无用