OIDCAuthProviderConfig interface

[OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html) 身份验证提供方配置界面。您可以通过 BaseAuth.createProviderConfig() 创建 OIDC 提供方。

签名

export interface OIDCAuthProviderConfig extends BaseAuthProviderConfig 

扩展BaseAuthProviderConfig

属性

属性 类型 说明
clientId 字符串 这是用于确认 OIDC 提供方的 [ID 令牌](https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken) 的目标设备所必需的客户端 ID。
clientSecret 字符串 OIDC 提供方的客户端密钥,用于启用 OIDC 代码流程。
颁发者 字符串 这是必需的提供方颁发者,用于匹配 ID 令牌的提供方颁发者并确定对应的 OIDC 发现文档,例如[/.well-known/openid-configuration](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig)。这是执行以下操作的必要条件:
  • 验证所提供的发卡机构。
  • 在 OAuth id_token 身份验证流程中确定身份验证/授权端点。
  • 通过 jwks_uri 检索公共签名密钥以验证 OIDC 提供方的 ID 令牌的签名。
  • 确定 claims_supported,以构建要在其他用户信息响应中返回的用户属性。
系统将按照 [规范](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation)中的定义执行 ID 令牌验证。
responseType OAuthResponseType OIDC 提供方 OAuth 授权流程的响应对象。

OIDCAuthProviderConfig.clientId

这是用于确认 OIDC 提供方的 [ID 令牌](https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken) 的目标设备所必需的客户端 ID。

签名

clientId: string;

OIDCAuthProviderConfig.clientSecret

OIDC 提供方的客户端密钥,用于启用 OIDC 代码流程。

签名

clientSecret?: string;

OIDCAuthProviderConfig.issuer

这是必需的提供方颁发者,用于匹配 ID 令牌的提供方颁发者并确定对应的 OIDC 发现文档,例如[/.well-known/openid-configuration](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig)。以下情况需要此设置:

  • 验证所提供的发卡机构。
  • 在 OAuth id_token 身份验证流程中确定身份验证/授权端点。
  • 通过 jwks_uri 检索公共签名密钥以验证 OIDC 提供方的 ID 令牌的签名。
  • 确定 claims_supported,以构建要在其他用户信息响应中返回的用户属性。
系统将按照 [规范](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation)中的定义执行 ID 令牌验证。

签名

issuer: string;

OIDCAuthProviderConfig.responseType

OIDC 提供方 OAuth 授权流程的响应对象。

签名

responseType?: OAuthResponseType;