OAuthOptions 類別
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
OAuthMiddleware<TOptions> 的組態選項。
public ref class OAuthOptions : Microsoft::AspNetCore::Builder::RemoteAuthenticationOptions
public class OAuthOptions : Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions
type OAuthOptions = class
inherit RemoteAuthenticationOptions
Public Class OAuthOptions
Inherits RemoteAuthenticationOptions
- 繼承
- 衍生
建構函式
OAuthOptions() |
OAuthMiddleware<TOptions> 的組態選項。 |
屬性
AuthenticationScheme |
選項中的 AuthenticationScheme 會對應至特定驗證配置的邏輯名稱。 可能會指派不同的值以便在管線中多次使用相同的驗證中介軟體類型。 (繼承來源 AuthenticationOptions) |
AuthorizationEndpoint |
取得或設定將重新導向用戶端以驗證的 URI。 |
AutomaticAuthenticate |
如果為 true,驗證中介軟體會改變傳入的要求使用者。 如果為 false,驗證中介軟體只會在 AuthenticationScheme 明確指出時提供身分識別。 (繼承來源 AuthenticationOptions) |
AutomaticChallenge |
如果為 true,驗證中介軟體應該處理自動挑戰。 如果為 false,驗證中介軟體只會在 AuthenticationScheme 明確指出時改變回應。 (繼承來源 AuthenticationOptions) |
BackchannelHttpHandler |
用來與遠端識別提供者通訊的 HttpMessageHandler。 此屬性不能與 BackchannelCertificateValidator 同時設定,除非此值可以向下轉型為 WebRequestHandler。 (繼承來源 RemoteAuthenticationOptions) |
BackchannelTimeout |
取得或設定與遠端識別提供者進行反向通道通訊的毫秒逾時值。 (繼承來源 RemoteAuthenticationOptions) |
CallbackPath |
應用程式的基本路徑中將傳回 user-agent 的要求路徑。 中介軟體將會在此要求送達時予以處理。 (繼承來源 RemoteAuthenticationOptions) |
ClaimsIssuer |
取得或設定應該用於任何已建立宣告的簽發者 (繼承來源 AuthenticationOptions) |
ClientId |
取得或設定提供者指派的用戶端識別碼。 |
ClientSecret |
取得或設定提供者指派的用戶端密碼。 |
Description |
驗證類型的其他相關資訊可在應用程式中找到。 (繼承來源 AuthenticationOptions) |
DisplayName |
取得或設定使用者可以顯示在登入使用者介面上的文字。 (繼承來源 RemoteAuthenticationOptions) |
Events |
取得或設定 IOAuthEvents 用來處理驗證事件的 。 |
RemoteAuthenticationTimeout |
根據預設,取得或設定完成驗證流程的時間限制 (15 分鐘) 。 (繼承來源 RemoteAuthenticationOptions) |
SaveTokens |
定義在成功授權之後,是否應該將存取和重新整理權杖儲存在 AuthenticationProperties 中。
此屬性預設會設定為 |
Scope |
取得要要求的許可權清單。 |
SignInScheme |
取得或設定驗證配置,此配置對應至在成功驗證之後負責保存使用者身分識別的中介軟體。 這個值通常對應至在 Startup 類別中註冊的 Cookie 中介軟體。 省略時, SignInScheme 會當做後援值使用。 (繼承來源 RemoteAuthenticationOptions) |
StateDataFormat |
取得或設定類型,用以保護中介軟體所處理資料的安全。 |
SystemClock |
僅供測試用途使用。 |
SystemClock |
僅供測試用途使用。 (繼承來源 AuthenticationOptions) |
TokenEndpoint |
取得或設定中介軟體將存取以交換 OAuth 權杖的 URI。 |
UserInformationEndpoint |
取得或設定中介軟體將存取以取得使用者資訊的 URI。 這個值不會用於預設實作中,它用於 IOAuthAuthAuthenticationEvents.Authenticated 或 OAuthAuthenticationHandler.CreateTicketAsync 的自訂實作。 |