WsFederationOptions 類別

定義

命名空間:

Microsoft.AspNetCore.Authentication.WsFederation

組件:

Microsoft.AspNetCore.Authentication.WsFederation.dll

套件:

Microsoft.AspNetCore.Authentication.WsFederation v8.0.0

來源:

WsFederationOptions.cs

WsFederationHandler 的組態選項

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

public class WsFederationOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

type WsFederationOptions = class
    inherit RemoteAuthenticationOptions

Public Class WsFederationOptions
Inherits RemoteAuthenticationOptions

繼承

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

WsFederationOptions

建構函式

WsFederationOptions()

初始化新的 WsFederationOptions

屬性

AccessDeniedPath	取得或設定當使用者未核准遠端伺服器所要求的授權需求時，使用者代理程式會重新導向至的選擇性路徑。 此屬性預設不會設定。 在此情況下，如果遠端授權伺服器傳回access_denied回應，則會擲回例外狀況。 (繼承來源 RemoteAuthenticationOptions)
AllowUnsolicitedLogins	Ws-Federation 通訊協定可讓使用者起始登入，而不需要先連絡應用程式進行挑戰。 不過，該流程容易受到 XSRF 和其他攻擊的影響，因此預設會在這裡停用。
Backchannel	用來與遠端識別提供者通訊。 (繼承來源 RemoteAuthenticationOptions)
BackchannelHttpHandler	用來與遠端識別提供者通訊的 HttpMessageHandler。 除非值可以向下轉型為 WebRequestHandler，否則無法同時設定為 BackchannelCertificateValidator。 (繼承來源 RemoteAuthenticationOptions)
BackchannelTimeout	取得或設定與遠端識別提供者的反向通道通訊以毫秒為單位的逾時值。 (繼承來源 RemoteAuthenticationOptions)
CallbackPath	應用程式基底路徑內的要求路徑，其中會傳回使用者代理程式。 中間件會在送達時處理此要求。 (繼承來源 RemoteAuthenticationOptions)
ClaimsIssuer	取得或設定應該用於所建立之任何宣告的簽發者 (繼承來源 AuthenticationSchemeOptions)
Configuration	開發人員直接提供的設定。 如果提供，則不會使用 MetadataAddress 和 Backchannel 屬性。 這項資訊不應該在要求處理期間更新。
ConfigurationManager	負責從元數據擷取、快取和重新整理組態。 如果未提供，則會使用 MetadataAddress 和 Backchannel 屬性來建立一個。
CorrelationCookie	決定在 Cookie 新增至回應之前，用來建立相互關聯 Cookie 的設定。 (繼承來源 RemoteAuthenticationOptions)
DataProtectionProvider	取得或設定用來保護數據的型別。 (繼承來源 RemoteAuthenticationOptions)
Events	取得或設定處理 WsFederation 訊息時要呼叫的 WsFederationEvents。
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)
MetadataAddress	取得或設定要擷取 wsFederation 元數據的位址
RefreshOnIssuerKeyNotFound	取得或設定是否應該在 SecurityTokenSignatureKeyNotFoundException 之後嘗試元數據重新整理。 這允許在簽章金鑰變換時自動復原。 默認會啟用此功能。
RemoteAuthenticationTimeout	取得或設定完成驗證流程的時間限制（預設為15分鐘）。 (繼承來源 RemoteAuthenticationOptions)
RemoteSignOutPath	在此路徑上收到的要求會導致處理程式使用 SignOutScheme 叫用 SignOut。
RequireHttpsMetadata	取得或設定元數據位址或授權單位是否需要 HTTPS。 默認值為 true。 這應該只在開發環境中停用。
ReturnUrlParameter	取得或設定參數的名稱，這個參數用來在遠端挑戰觸發至拒絕存取頁面之前，傳達使用者的原始位置。 只有當明確指定 AccessDeniedPath 時，才會使用這個屬性。 (繼承來源 RemoteAuthenticationOptions)
SaveTokens	WsFederation 不支援SaveTokens
SecurityTokenHandlers	已淘汰. 取得或設定用來讀取和驗證 SecurityToken的 ISecurityTokenValidator 集合。
SignInScheme	取得或設定與負責在成功驗證之後保存使用者身分識別的中間件對應的驗證配置。 這個值通常會對應至在 Startup 類別中註冊的 Cookie 中間件。 省略時，會使用 DefaultSignInScheme 做為後援值。 (繼承來源 RemoteAuthenticationOptions)
SignOutScheme	要與 RemoteSignOutPath 中的 SignOutAsync 搭配使用的驗證配置。 如果未設定，將會使用SignInScheme。
SignOutWreply	取得或設定註銷期間使用的 『wreply』 值。如果未指定任何值，則會使用 [Wreply] 欄位中的值。
SkipUnrecognizedRequests	指出回呼路徑的要求是否也適用於其他元件。 如果啟用，處理程式將會通過不包含 WsFederation 驗證回應的要求。 停用這個 ，並將 CallbackPath 設定為專用端點可能會提供更好的錯誤處理。 預設會停用此專案。
StateDataFormat	取得或設定用來保護中間件所處理數據的型別。
TimeProvider	用於測試。 (繼承來源 AuthenticationSchemeOptions)
TokenHandlers	取得用來讀取和驗證 SecurityToken的 ISecurityTokenValidator 集合。
TokenValidationParameters	取得或設定 TokenValidationParameters
UseSecurityTokenHandlers	取得或設定是否要使用 TokenHandlers 或 SecurityTokenHandlers 來驗證輸入令牌。
UseTokenLifetime	指出驗證會話存留期（例如 Cookies）應該符合驗證令牌的存留期。 如果令牌未提供存留期資訊，則會使用一般會話存留期。 默認會啟用此功能。
Wreply	取得或設定 『wreply』。 CallbackPath 必須設定為符合或清除，才能動態產生。 此欄位為選擇性欄位。 如果未設定，則會從目前的要求和 CallbackPath 產生它。
Wtrealm	取得或設定 『wtrealm』。

方法

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