OpenIdConnectOptions 類別

定義

命名空間:

Microsoft.AspNetCore.Authentication.OpenIdConnect

組件:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

套件:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

來源:

OpenIdConnectOptions.cs

OpenIdConnectHandler 的組態選項

public ref class OpenIdConnectOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptions

public class OpenIdConnectOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

type OpenIdConnectOptions = class
    inherit RemoteAuthenticationOptions

Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions

繼承

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OpenIdConnectOptions

建構函式

OpenIdConnectOptions()

初始化新的 OpenIdConnectOptions

屬性

AccessDeniedPath	取得或設定當使用者未核准遠端伺服器所要求的授權需求時，使用者代理程式會重新導向至的選擇性路徑。 此屬性預設不會設定。 在此情況下，如果遠端授權伺服器傳回access_denied回應，則會擲回例外狀況。 (繼承來源 RemoteAuthenticationOptions)
AuthenticationMethod	取得或設定用來將使用者代理程式重新導向至識別提供者的方法。
Authority	取得或設定進行 OpenIdConnect 呼叫時要使用的授權單位。
AutomaticRefreshInterval	取得或設定自動元數據重新整理應該發生的頻率。
Backchannel	用來與遠端識別提供者通訊。 (繼承來源 RemoteAuthenticationOptions)
BackchannelHttpHandler	用來與遠端識別提供者通訊的 HttpMessageHandler。 除非值可以向下轉型為 WebRequestHandler，否則無法同時設定為 BackchannelCertificateValidator。 (繼承來源 RemoteAuthenticationOptions)
BackchannelTimeout	取得或設定與遠端識別提供者的反向通道通訊以毫秒為單位的逾時值。 (繼承來源 RemoteAuthenticationOptions)
CallbackPath	應用程式基底路徑內的要求路徑，其中會傳回使用者代理程式。 中間件會在送達時處理此要求。 (繼承來源 RemoteAuthenticationOptions)
ClaimActions	宣告動作的集合，用來從 json 用戶數據中選取值並建立宣告。
ClaimsIssuer	取得或設定應該用於所建立之任何宣告的簽發者 (繼承來源 AuthenticationSchemeOptions)
ClientId	取得或設定 『client_id』。
ClientSecret	取得或設定 『client_secret』。
Configuration	開發人員直接提供的設定。 如果提供，則不會使用 MetadataAddress 和 Backchannel 屬性。 這項資訊不應該在要求處理期間更新。
ConfigurationManager	負責從元數據擷取、快取和重新整理組態。 如果未提供，則會使用 MetadataAddress 和 Backchannel 屬性來建立一個。
CorrelationCookie	決定在 Cookie 新增至回應之前，用來建立相互關聯 Cookie 的設定。 (繼承來源 RemoteAuthenticationOptions)
DataProtectionProvider	取得或設定用來保護數據的型別。 (繼承來源 RemoteAuthenticationOptions)
DisableTelemetry	指出是否應該停用遙測。 啟用此功能時，Microsoft IdentityModel 套件的元件版本會以授權/註銷要求參數的形式傳送至遠端 OpenID Connect 提供者。
Events	取得或設定處理 OpenIdConnect 訊息時要通知的 OpenIdConnectEvents。
EventsType	如果設定，將會作為服務類型來取得 Events 實例，而不是屬性。 (繼承來源 AuthenticationSchemeOptions)
ForwardAuthenticate	如果設定，這會指定此配置應該轉送 AuthenticateAsync 呼叫的目標配置。 例如 Context.AuthenticateAsync（“ThisScheme”） => Context.AuthenticateAsync（“ForwardAuthenticateValue”）：將目標設定為目前的配置，以停用轉送並允許正常處理。 (繼承來源 AuthenticationSchemeOptions)
ForwardChallenge	如果設定，這會指定此配置應該轉送 ChallengeAsync 呼叫的目標配置。 例如 Context.ChallengeAsync（“ThisScheme”） => Context.ChallengeAsync（“ForwardChallengeValue”）：將目標設定為目前的配置，以停用轉送並允許正常處理。 (繼承來源 AuthenticationSchemeOptions)
ForwardDefault	如果設定，這會指定驗證處理程式預設應該將所有驗證作業轉送至的預設配置。 默認轉送邏輯會先檢查最特定的 ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 設定，然後檢查 ForwardDefaultSelector，後面接著 ForwardDefault。 第一個非 Null 結果會作為要轉送的目標配置。 (繼承來源 AuthenticationSchemeOptions)
ForwardDefaultSelector	用來選擇目前要求的預設設定，驗證處理程式預設應將所有驗證作業轉送至 。 默認轉送邏輯會先檢查最特定的 ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 設定，然後檢查 ForwardDefaultSelector，後面接著 ForwardDefault。 第一個非 Null 結果會作為要轉送的目標配置。 (繼承來源 AuthenticationSchemeOptions)
ForwardForbid	如果設定，這會指定此配置應該轉送 ForbidAsync 呼叫的目標配置。 例如 Context.ForbidAsync（“ThisScheme”） => Context.ForbidAsync（“ForwardForbidValue”）：將目標設定為目前的配置，以停用轉送並允許正常處理。 (繼承來源 AuthenticationSchemeOptions)
ForwardSignIn	如果設定，這會指定此配置應該轉送 SignInAsync 呼叫的目標配置。 例如 Context.SignInAsync（“ThisScheme”） => Context.SignInAsync（“ForwardSignInValue”）：將目標設定為目前的配置，以停用轉送並允許正常處理。 (繼承來源 AuthenticationSchemeOptions)
ForwardSignOut	如果設定，這會指定此配置應該轉送 SignOutAsync 呼叫的目標配置。 例如 Context.SignOutAsync（“ThisScheme”） => Context.SignOutAsync（“ForwardSignOutValue”）：將目標設定為目前的配置，以停用轉送並允許正常處理。 (繼承來源 AuthenticationSchemeOptions)
GetClaimsFromUserInfoEndpoint	布爾值，可設定處理程式是否應該移至使用者資訊端點，以擷取從令牌端點收到的id_token身分識別之後擷取其他宣告。 默認值為 『false』。
MapInboundClaims	取得或設定 SecurityTokenValidator 中 JwtSecurityTokenHandler 的預設實例和 TokenHandler 中 JsonWebTokenHandler 的預設實例上的 MapInboundClaims 屬性，這個實例用於判斷驗證 JwtSecurityToken時是否要對應擷取的宣告類型。 如果此值設定為 true，宣告類型會在使用此對應進行翻譯之後，設定為 JSON 宣告 『name』。 否則，不會發生任何對應。 默認值為 true。
MaxAge	取得或設定 『max_age』。 如果設定 『max_age』 參數，則會使用驗證要求傳送。 如果識別提供者未在指定的時間長度內主動驗證使用者，系統會提示使用者重新驗證。 根據預設，不會指定任何max_age。
MetadataAddress	取得或設定用於取得元數據的探索端點
NonceCookie	決定在 Cookie 新增至回應之前，用來建立 nonce Cookie 的設定。
Prompt	取得或設定 『prompt』。
ProtocolValidator	取得或設定 OpenIdConnectProtocolValidator，用來確保收到的 『id_token』 符合下列各項： http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
RefreshInterval	取得或設定擷取、擷取失敗或明確要求重新整理之間的最短時間。
RefreshOnIssuerKeyNotFound	取得或設定是否應該在 SecurityTokenSignatureKeyNotFoundException 之後嘗試元數據重新整理。 這允許在簽章金鑰變換時自動復原。 默認會啟用此功能。
RemoteAuthenticationTimeout	取得或設定完成驗證流程的時間限制（預設為15分鐘）。 (繼承來源 RemoteAuthenticationOptions)
RemoteSignOutPath	在此路徑上收到的要求會導致處理程式使用 SignOutScheme 叫用 SignOut。
RequireHttpsMetadata	取得或設定元數據位址或授權單位是否需要 HTTPS。 默認值為 true。 這應該只在開發環境中停用。
Resource	取得或設定 『resource』。
ResponseMode	取得或設定 『response_mode』。
ResponseType	取得或設定 『response_type』。
ReturnUrlParameter	取得或設定參數的名稱，這個參數用來在遠端挑戰觸發至拒絕存取頁面之前，傳達使用者的原始位置。 只有當明確指定 AccessDeniedPath 時，才會使用這個屬性。 (繼承來源 RemoteAuthenticationOptions)
SaveTokens	定義在成功授權之後，存取權和重新整理令牌是否應該儲存在 AuthenticationProperties 中。 此屬性預設會設定為 false，以減少最終驗證 Cookie 的大小。 (繼承來源 RemoteAuthenticationOptions)
Scope	取得要要求的許可權清單。
SecurityTokenValidator	已淘汰. 取得或設定用來驗證識別令牌的 ISecurityTokenValidator。
SignedOutCallbackPath	從識別提供者註銷之後，使用者代理程式會在應用程式基底路徑內傳回要求路徑。 請參閱 http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout的post_logout_redirect_uri。
SignedOutRedirectUri	從識別提供者註銷應用程式之後，使用者代理程式會重新導向至的 URI。 重新導向會在叫用 SignedOutCallbackPath 之後發生。
SignInScheme	取得或設定與負責在成功驗證之後保存使用者身分識別的中間件對應的驗證配置。 這個值通常會對應至在 Startup 類別中註冊的 Cookie 中間件。 省略時，會使用 DefaultSignInScheme 做為後援值。 (繼承來源 RemoteAuthenticationOptions)
SignOutScheme	要與 SignOutPath 上的 SignOut 搭配使用的驗證配置。 如果未設定，將會使用SignInScheme。
SkipUnrecognizedRequests	指出回呼路徑的要求是否也適用於其他元件。 如果啟用，處理程式將會通過不包含 OpenIdConnect 驗證回應的要求。 停用這個 ，並將 CallbackPath 設定為專用端點可能會提供更好的錯誤處理。 預設會停用此專案。
StateDataFormat	取得或設定用來保護處理程式所處理數據的型別。
StringDataFormat	取得或設定用來保護處理程式所用字串的類型。
TimeProvider	用於測試。 (繼承來源 AuthenticationSchemeOptions)
TokenHandler	取得或設定用來驗證識別令牌的 TokenHandler。 如果 UseSecurityTokenValidator 是 false，則會使用此專案，而不是 SecurityTokenValidator。
TokenValidationParameters	取得或設定用來驗證識別令牌的參數。
UsePkce	啟用或停用使用程式代碼交換證明金鑰 （PKCE） 標準。 只有當 ResponseType 設定為 Code時，才適用此設定。 請參閱 https://tools.ietf.org/html/rfc7636。 預設值為 true。
UseSecurityTokenValidator	取得或設定是否要使用 TokenHandler 或 SecurityTokenValidator 來驗證身分識別令牌。
UseTokenLifetime	指出驗證會話存留期（例如 Cookies）應該符合驗證令牌的存留期。 如果令牌未提供存留期資訊，則會使用一般會話存留期。 預設會停用此專案。

方法

Validate()	檢查選項是否有效。 如果情況不正常，應該擲回例外狀況。
Validate(String)	檢查選項是否對特定配置有效 (繼承來源 RemoteAuthenticationOptions)