MicrosoftAccountOptions 類別

定義

命名空間:

Microsoft.AspNetCore.Authentication.MicrosoftAccount

組件:

Microsoft.AspNetCore.Authentication.MicrosoftAccount.dll

套件:

Microsoft.AspNetCore.Authentication.MicrosoftAccount v8.0.0

來源:

MicrosoftAccountOptions.cs

MicrosoftAccountHandler的組態選項。

public ref class MicrosoftAccountOptions : Microsoft::AspNetCore::Authentication::OAuth::OAuthOptions

public class MicrosoftAccountOptions : Microsoft.AspNetCore.Authentication.OAuth.OAuthOptions

type MicrosoftAccountOptions = class
    inherit OAuthOptions

Public Class MicrosoftAccountOptions
Inherits OAuthOptions

繼承

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OAuthOptions

MicrosoftAccountOptions

建構函式

MicrosoftAccountOptions()

初始化新的 MicrosoftAccountOptions。

屬性

AccessDeniedPath	取得或設定當使用者未核准遠端伺服器所要求的授權需求時，使用者代理程式會重新導向至的選擇性路徑。 此屬性預設不會設定。 在此情況下，如果遠端授權伺服器傳回access_denied回應，則會擲回例外狀況。 (繼承來源 RemoteAuthenticationOptions)
AdditionalAuthorizationParameters	取得將包含在授權要求中的其他參數。 (繼承來源 OAuthOptions)
AuthorizationEndpoint	取得或設定將重新導向客戶端以驗證的 URI。 (繼承來源 OAuthOptions)
Backchannel	用來與遠端識別提供者通訊。 (繼承來源 RemoteAuthenticationOptions)
BackchannelHttpHandler	用來與遠端識別提供者通訊的 HttpMessageHandler。 除非值可以向下轉型為 WebRequestHandler，否則無法同時設定為 BackchannelCertificateValidator。 (繼承來源 RemoteAuthenticationOptions)
BackchannelTimeout	取得或設定與遠端識別提供者的反向通道通訊以毫秒為單位的逾時值。 (繼承來源 RemoteAuthenticationOptions)
CallbackPath	應用程式基底路徑內的要求路徑，其中會傳回使用者代理程式。 中間件會在送達時處理此要求。 (繼承來源 RemoteAuthenticationOptions)
ClaimActions	宣告動作的集合，用來從 json 用戶數據中選取值並建立宣告。 (繼承來源 OAuthOptions)
ClaimsIssuer	取得或設定應該用於所建立之任何宣告的簽發者 (繼承來源 AuthenticationSchemeOptions)
ClientId	取得或設定提供者指派的用戶端標識碼。 (繼承來源 OAuthOptions)
ClientSecret	取得或設定提供者指派的客戶端密碼。 (繼承來源 OAuthOptions)
CorrelationCookie	決定在 Cookie 新增至回應之前，用來建立相互關聯 Cookie 的設定。 (繼承來源 RemoteAuthenticationOptions)
DataProtectionProvider	取得或設定用來保護數據的型別。 (繼承來源 RemoteAuthenticationOptions)
Events	取得或設定用來處理驗證事件的 OAuthEvents。 (繼承來源 OAuthOptions)
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)
RemoteAuthenticationTimeout	取得或設定完成驗證流程的時間限制（預設為15分鐘）。 (繼承來源 RemoteAuthenticationOptions)
ReturnUrlParameter	取得或設定參數的名稱，這個參數用來在遠端挑戰觸發至拒絕存取頁面之前，傳達使用者的原始位置。 只有當明確指定 AccessDeniedPath 時，才會使用這個屬性。 (繼承來源 RemoteAuthenticationOptions)
SaveTokens	定義在成功授權之後，存取權和重新整理令牌是否應該儲存在 AuthenticationProperties 中。 此屬性預設會設定為 false，以減少最終驗證 Cookie 的大小。 (繼承來源 RemoteAuthenticationOptions)
Scope	取得要要求的許可權清單。 (繼承來源 OAuthOptions)
SignInScheme	取得或設定與負責在成功驗證之後保存使用者身分識別的中間件對應的驗證配置。 這個值通常會對應至在 Startup 類別中註冊的 Cookie 中間件。 省略時，會使用 DefaultSignInScheme 做為後援值。 (繼承來源 RemoteAuthenticationOptions)
StateDataFormat	取得或設定用來保護中間件所處理數據的型別。 (繼承來源 OAuthOptions)
TimeProvider	用於測試。 (繼承來源 AuthenticationSchemeOptions)
TokenEndpoint	取得或設定中間件將存取以交換 OAuth 令牌的 URI。 (繼承來源 OAuthOptions)
UsePkce	啟用或停用使用程式代碼交換證明金鑰 （PKCE） 標準。 請參閱 https://tools.ietf.org/html/rfc7636。 預設值是 false 但衍生處理程式應該在提供者支援時啟用這個。 (繼承來源 OAuthOptions)
UserInformationEndpoint	取得或設定中間件將存取以取得用戶資訊的 URI。 這個值不會用於預設實作中，它是用於自訂實作的 OnCreatingTicket。 (繼承來源 OAuthOptions)

方法

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