OIDCAuthProviderConfig interface

[OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html) 驗證提供者設定介面。您可以透過 BaseAuth.createProviderConfig() 建立 OIDC 提供者。

簽名:

export interface OIDCAuthProviderConfig extends BaseAuthProviderConfig 

擴充: BaseAuthProviderConfig

屬性

屬性 類型 說明
clientId 字串 這是必要的用戶端 ID,用於確認 OIDC 供應商 [ID 權杖](https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken) 的目標對象。
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,以建構要在其他使用者資訊回應中傳回的使用者屬性。
ID 權杖驗證會依照 [規格](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation) 執行。
responseType OAuthResponseType OIDC 供應商對 OAuth 授權流程的回應物件。

OIDCAuthProviderConfig.clientId

這是必要的用戶端 ID,用於確認 OIDC 供應商 [ID 權杖](https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken) 的目標對象。

簽名:

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,以建構要在其他使用者資訊回應中傳回的使用者屬性。
ID 權杖驗證會依照 [規格](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation) 執行。

簽名:

issuer: string;

OIDCAuthProviderConfig.responseType

OIDC 供應商對 OAuth 授權流程的回應物件。

簽名:

responseType?: OAuthResponseType;