OAuthHandler<TOptions> Sınıf

Tanım

Ad Alanı:

Microsoft.AspNetCore.Authentication.OAuth

Bütünleştirilmiş Kod:

Microsoft.AspNetCore.Authentication.OAuth.dll

Paket:

Microsoft.AspNetCore.App.Ref v8.0.0

Kaynak:

OAuthHandler.cs

OAuth'u destekleyen bir kimlik doğrulama işleyicisi.

public class OAuthHandler<TOptions> : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions> where TOptions : OAuthOptions, new()

type OAuthHandler<'Options (requires 'Options :> OAuthOptions and 'Options : (new : unit -> 'Options))> = class
    inherit RemoteAuthenticationHandler<'Options (requires 'Options :> OAuthOptions and 'Options : (new : unit -> 'Options))>

Public Class OAuthHandler(Of TOptions)
Inherits RemoteAuthenticationHandler(Of TOptions)

Tür Parametreleri

TOptions

Seçeneklerin türü.

Devralma

Object

AuthenticationHandler<TOptions>

RemoteAuthenticationHandler<TOptions>

OAuthHandler<TOptions>

Türetilmiş

Microsoft.AspNetCore.Authentication.Facebook.FacebookHandler

Microsoft.AspNetCore.Authentication.Google.GoogleHandler

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftAccountHandler

Oluşturucular

OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder)	yeni bir OAuthHandler<TOptions>örneği başlatır.
OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	Geçersiz. yeni bir OAuthHandler<TOptions>örneği başlatır.

Özellikler

Backchannel	Uzak kimlik doğrulama sağlayıcısıyla iletişim kurmak için kullanılan HttpClient örneğini alır.
ChallengeCalled	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: AuthenticationHandler<TOptions>)
ClaimsIssuer	Herhangi bir talep verildiğinde kullanılması gereken vereni alır. (Devralındığı yer: AuthenticationHandler<TOptions>)
Clock	Geçersiz. ISystemClockalır. (Devralındığı yer: AuthenticationHandler<TOptions>)
Context	HttpContextalır veya ayarlar. (Devralındığı yer: AuthenticationHandler<TOptions>)
CurrentUri	Mutlak geçerli URL'yi alır. (Devralındığı yer: AuthenticationHandler<TOptions>)
Events	İşleyici, işlemenin gerçekleştiği belirli noktalarda uygulama denetimi sağlayan olaylar üzerinde yöntemleri çağırır. Sağlanmazsa, yöntemler çağrıldığında hiçbir şey yapmaz bir varsayılan örnek sağlanır.
InitializeResult	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: AuthenticationHandler<TOptions>)
Logger	ILoggeralır. (Devralındığı yer: AuthenticationHandler<TOptions>)
Options	Bu kimlik doğrulama işleyicisiyle ilişkili seçenekleri alır veya ayarlar. (Devralındığı yer: AuthenticationHandler<TOptions>)
OptionsMonitor	Seçeneklerdeki değişiklikleri algılamak için IOptionsMonitor<TOptions> alır. (Devralındığı yer: AuthenticationHandler<TOptions>)
OriginalPath	Kimlik doğrulama ara yazılımı tarafından görüldüğü gibi yolu alır. (Devralındığı yer: AuthenticationHandler<TOptions>)
OriginalPathBase	Kimlik doğrulaması ara yazılımı tarafından görüldüğü gibi yol tabanını alır. (Devralındığı yer: AuthenticationHandler<TOptions>)
PriorHandler	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: AuthenticationHandler<TOptions>)
Request	Geçerli istekle ilişkili HttpRequest alır. (Devralındığı yer: AuthenticationHandler<TOptions>)
Response	Geçerli istekle ilişkili HttpResponse alır. (Devralındığı yer: AuthenticationHandler<TOptions>)
Scheme	Bu kimlik doğrulama işleyicisiyle ilişkili AuthenticationScheme alır veya ayarlar. (Devralındığı yer: AuthenticationHandler<TOptions>)
SignInAccepted	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: AuthenticationHandler<TOptions>)
SignInScheme	Oturum açmak için varsayılan olarak kullanılan kimlik doğrulama düzeni. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)
SignOutAccepted	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: AuthenticationHandler<TOptions>)
TimeProvider	Öncelikle birim testi için geçerli saati alır. (Devralındığı yer: AuthenticationHandler<TOptions>)
UrlEncoder	UrlEncoderalır. (Devralındığı yer: AuthenticationHandler<TOptions>)

Yöntemler

AuthenticateAsync()	Geçerli isteğin kimliğini doğrulama. (Devralındığı yer: AuthenticationHandler<TOptions>)
AuthenticateAsync(AuthenticateContext)	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: AuthenticationHandler<TOptions>)
BuildChallengeUrl(AuthenticationProperties, String)	OAuth sınama url'sini oluşturur.
BuildRedirectUri(String)	Belirtilen targetPathiçin mutlak bir URL oluşturur. (Devralındığı yer: AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	Geçerli isteği sınama. (Devralındığı yer: AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext)	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: AuthenticationHandler<TOptions>)
CreateEventsAsync()	Olay örneğinin yeni bir örneğini oluşturur.
CreateTicketAsync(ClaimsIdentity, AuthenticationProperties, OAuthTokenResponse)	Belirtilen tokensbir AuthenticationTicket oluşturur.
ExchangeCodeAsync(OAuthCodeExchangeContext)	Uzak sağlayıcıdan bir yetkilendirme belirteci için yetkilendirme kodunu değiştirir.
FinishResponseAsync()	Yanıt gönderilmek üzereyken çağrılan kanca (Devralındığı yer: AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	Geçerli isteği yasakla. (Devralındığı yer: AuthenticationHandler<TOptions>)
FormatScope()	Scope özelliğini biçimlendirin.
FormatScope(IEnumerable<String>)	OAuth kapsamlarının listesini biçimlendirin.
GenerateCorrelationId(AuthenticationProperties)	Geçerli uzak kimlik doğrulama isteğini ilişkilendirmek için kullanılan bir nonce içeren bir tanımlama bilgisi oluşturur. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)
GenerateCorrelationId(AuthenticationProperties)	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)
GetDescriptions(DescribeSchemesContext)	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: AuthenticationHandler<TOptions>)
HandleAccessDeniedErrorAsync(AuthenticationProperties)	Türetilmiş türler, erişim reddedilen hataları işlemek için bu yöntemi geçersiz kılabilir. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	Türetilmiş türlerin kimlik doğrulamasını işlemesine izin verir. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()	HandleAuthenticateAsync'in yalnızca bir kez çağrıldığından emin olmak için kullanılır. Sonraki çağrılar aynı kimlik doğrulama sonucunu döndürür. (Devralındığı yer: AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()	HandleAuthenticateAsync'in yalnızca bir kez güvenli bir şekilde çağrıldığından emin olmak için kullanılır. Sonraki çağrılar aynı kimlik doğrulama sonucunu döndürür. Tüm özel durumlar, özel durumu içeren başarısız bir kimlik doğrulama sonucuna dönüştürülür. (Devralındığı yer: AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	Söz konusu bir kimlik doğrulama şeması, istek akışının bir parçası olarak bir kimlik doğrulama etkileşimiyle ilgileniyorsa, 401 sınaması endişeleriyle başa çıkmak için bu yöntemi geçersiz kılın. (yanıt üst bilgisi ekleme veya 401 sonucunu oturum açma sayfasının veya dış oturum açma konumunun 302'sine değiştirme gibi.)
HandleForbiddenAsync(AuthenticationProperties)	Forbid'i işlemek için bu yöntemi geçersiz kılın. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)
HandleForbiddenAsync(ChallengeContext)	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)
HandleRemoteAuthenticateAsync()	Kimlik sağlayıcısıyla kullanıcı kimliğinin kimliğini doğrulama. yöntemi, isteği CallbackPath tarafından tanımlanan uç noktada işler.
HandleRemoteCallbackAsync()	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)
HandleRequestAsync()	Geçerli kimlik doğrulama isteğini işler. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)
HandleSignInAsync(SignInContext)	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)
HandleSignOutAsync(SignOutContext)	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)
HandleUnauthorizedAsync(ChallengeContext)	Söz konusu bir kimlik doğrulama şeması, istek akışının bir parçası olarak bir kimlik doğrulama etkileşimiyle ilgileniyorsa, 401 sınaması endişeleriyle başa çıkmak için bu yöntemi geçersiz kılın. (yanıt üst bilgisi ekleme veya 401 sonucunu oturum açma sayfasının veya dış oturum açma konumunun 302'sine değiştirme gibi.) (Devralındığı yer: AuthenticationHandler<TOptions>)
InitializeAsync(AuthenticationScheme, HttpContext)	İşleyiciyi başlatın, seçenekleri çözün ve doğrulayın. (Devralındığı yer: AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)	Initialize, bu örneği uygun durumla bağlamsal hale getirmek için istek başına bir kez çağrılır. (Devralındığı yer: AuthenticationHandler<TOptions>)
InitializeEventsAsync()	InitializeAsync(AuthenticationScheme, HttpContext)tarafından istek başına bir kez çağrılan events nesnesini başlatır. (Devralındığı yer: AuthenticationHandler<TOptions>)
InitializeHandlerAsync()	İşleyicinin kendisini başlatmayı tamamlaması için seçenekler/olaylar başlatıldıktan sonra çağrılır. (Devralındığı yer: AuthenticationHandler<TOptions>)
ResolveTarget(String)	Bu kimlik doğrulama işleminin ilettiği düzeni çözümler. (Devralındığı yer: AuthenticationHandler<TOptions>)
ShouldHandleRequestAsync()	Geçerli kimlik doğrulama isteğinin HandleRequestAsync()tarafından işlenip işlenmediğini belirleyen bir değer alır. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)
ShouldHandleScheme(String, Boolean)	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: AuthenticationHandler<TOptions>)
SignInAsync(SignInContext)	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: AuthenticationHandler<TOptions>)
SignOutAsync(SignOutContext)	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: AuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	Geçerli isteğin geçerli uzak kimlik doğrulama isteğiyle bağıntılı olduğunu doğrular. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	OAuth'u destekleyen bir kimlik doğrulama işleyicisi. (Devralındığı yer: RemoteAuthenticationHandler<TOptions>)