OAuthOptions 類別

定義

命名空間:

Microsoft.AspNetCore.Authentication.OAuth

組件:

Microsoft.AspNetCore.Authentication.OAuth.dll

套件:

Microsoft.AspNetCore.App.Ref v8.0.0

組態選項 OAuth。

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

public class OAuthOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

type OAuthOptions = class
    inherit RemoteAuthenticationOptions

Public Class OAuthOptions
Inherits RemoteAuthenticationOptions

繼承

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OAuthOptions

衍生

Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions

Microsoft.AspNetCore.Authentication.Google.GoogleOptions

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftAccountOptions

建構函式

OAuthOptions()

初始化 OAuthOptions 的新執行個體。

屬性

AccessDeniedPath	取得或設定當使用者未核准遠端伺服器所要求的授權要求時，使用者代理程式會重新導向至的選擇性路徑。 此屬性預設不會設定。 在此情況下，如果遠端授權伺服器傳回access_denied回應，就會擲回例外狀況。 (繼承來源 RemoteAuthenticationOptions)
AuthorizationEndpoint	取得或設定將重新導向用戶端以驗證的 URI。
Backchannel	用來與遠端識別提供者通訊。 (繼承來源 RemoteAuthenticationOptions)
BackchannelHttpHandler	用來與遠端識別提供者通訊的 HttpMessageHandler。 此屬性不能與 BackchannelCertificateValidator 同時設定，除非此值可以向下轉型為 WebRequestHandler。 (繼承來源 RemoteAuthenticationOptions)
BackchannelTimeout	取得或設定與遠端識別提供者進行反向通道通訊的毫秒逾時值。 (繼承來源 RemoteAuthenticationOptions)
CallbackPath	應用程式的基本路徑中將傳回 user-agent 的要求路徑。 中介軟體將會在此要求送達時予以處理。 (繼承來源 RemoteAuthenticationOptions)
ClaimActions	用來從 json 使用者資料中選取值的宣告動作集合，並建立宣告。
ClaimsIssuer	取得或設定應該用於任何已建立宣告的簽發者 (繼承來源 AuthenticationSchemeOptions)
ClientId	取得或設定提供者指派的用戶端識別碼。
ClientSecret	取得或設定提供者指派的用戶端密碼。
CorrelationCookie	決定在 Cookie 新增至回應之前，用來建立相互關聯 Cookie 的設定。 (繼承來源 RemoteAuthenticationOptions)
DataProtectionProvider	取得或設定用來保護資料的型別。 (繼承來源 RemoteAuthenticationOptions)
Events	取得或設定 OAuthEvents 用來處理驗證事件的 。
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	取得要要求的許可權清單。
SignInScheme	取得或設定驗證配置，此配置對應至在成功驗證之後負責保存使用者身分識別的中介軟體。 這個值通常對應至在 Startup 類別中註冊的 Cookie 中介軟體。 省略時， DefaultSignInScheme 會當做後援值使用。 (繼承來源 RemoteAuthenticationOptions)
StateDataFormat	取得或設定類型，用以保護中介軟體所處理資料的安全。
TimeProvider	用於測試。 (繼承來源 AuthenticationSchemeOptions)
TokenEndpoint	取得或設定中介軟體將存取以交換 OAuth 權杖的 URI。
UsePkce	啟用或停用使用程式碼交換證明金鑰 (PKCE) 標準。 請參閱 https://tools.ietf.org/html/rfc7636。 預設值為 false ，但如果其提供者支援，則衍生處理常式應該啟用這個。
UserInformationEndpoint	取得或設定中介軟體將存取以取得使用者資訊的 URI。 這個值不會用於預設實作中，它用於 的 OnCreatingTicket 自訂實作。

方法

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