OAuthHandler<TOptions> Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth.
generic <typename TOptions>
where TOptions : OAuthOptionspublic ref class OAuthHandler : Microsoft::AspNetCore::Authentication::RemoteAuthenticationHandler<TOptions>generic <typename TOptions>
where TOptions : OAuthOptionsgcnew()public ref class OAuthHandler : Microsoft::AspNetCore::Authentication::RemoteAuthenticationHandler<TOptions>public class OAuthHandler<TOptions> : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions> where TOptions : OAuthOptionspublic class OAuthHandler<TOptions> : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions> where TOptions : OAuthOptions, new()type OAuthHandler<'Options (requires 'Options :> OAuthOptions)> = class
inherit RemoteAuthenticationHandler<'Options (requires 'Options :> OAuthOptions)>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)Parametry typu
- TOptions
Typ opcji.
- Dziedziczenie
- Pochodne
Konstruktory
| OAuthHandler<TOptions>(HttpClient) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. |
| OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock) |
Przestarzałe.
Inicjuje nowe wystąpienie OAuthHandler<TOptions>. |
| OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder) |
Inicjuje nowe wystąpienie OAuthHandler<TOptions>. |
Właściwości
| Backchannel |
Pobiera wystąpienie HttpClient używane do komunikowania się z dostawcą uwierzytelniania zdalnego. |
| ChallengeCalled |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po AuthenticationHandler<TOptions>) |
| ClaimsIssuer |
Pobiera wystawcę, który powinien być używany podczas wydawania oświadczeń. (Odziedziczone po AuthenticationHandler<TOptions>) |
| Clock |
Przestarzałe.
Pobiera ISystemClock. (Odziedziczone po AuthenticationHandler<TOptions>) |
| Context |
Pobiera lub ustawia HttpContext. (Odziedziczone po AuthenticationHandler<TOptions>) |
| CurrentUri |
Pobiera bezwzględny bieżący adres URL. (Odziedziczone po AuthenticationHandler<TOptions>) |
| Events |
Procedura obsługi wywołuje metody dla zdarzeń, które dają kontrolę aplikacji w określonych punktach, w których odbywa się przetwarzanie. Jeśli nie podano wystąpienia domyślnego, które nie wykonuje żadnych operacji, gdy metody są wywoływane. |
| Events |
Procedura obsługi wywołuje metody dla zdarzeń, które dają kontrolę aplikacji w określonych punktach, w których odbywa się przetwarzanie. Jeśli nie podano wystąpienia domyślnego, które nie wykonuje żadnych operacji, gdy metody są wywoływane. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| InitializeResult |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po AuthenticationHandler<TOptions>) |
| Logger |
Pobiera ILogger. (Odziedziczone po AuthenticationHandler<TOptions>) |
| Options |
Pobiera lub ustawia opcje skojarzone z tą procedurą obsługi uwierzytelniania. (Odziedziczone po AuthenticationHandler<TOptions>) |
| OptionsMonitor |
Pobiera IOptionsMonitor<TOptions> w celu wykrywania zmian w opcjach. (Odziedziczone po AuthenticationHandler<TOptions>) |
| OriginalPath |
Pobiera ścieżkę widzianą przez oprogramowanie pośredniczące uwierzytelniania. (Odziedziczone po AuthenticationHandler<TOptions>) |
| OriginalPathBase |
Pobiera bazę ścieżki, jak widać w przypadku oprogramowania pośredniczącego uwierzytelniania. (Odziedziczone po AuthenticationHandler<TOptions>) |
| PriorHandler |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po AuthenticationHandler<TOptions>) |
| Request |
Pobiera HttpRequest skojarzone z bieżącym żądaniem. (Odziedziczone po AuthenticationHandler<TOptions>) |
| Response |
Pobiera HttpResponse skojarzone z bieżącym żądaniem. (Odziedziczone po AuthenticationHandler<TOptions>) |
| Scheme |
Pobiera lub ustawia AuthenticationScheme skojarzone z tą procedurą obsługi uwierzytelniania. (Odziedziczone po AuthenticationHandler<TOptions>) |
| SignInAccepted |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po AuthenticationHandler<TOptions>) |
| SignInScheme |
Schemat uwierzytelniania używany domyślnie do logowania. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| SignOutAccepted |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po AuthenticationHandler<TOptions>) |
| TimeProvider |
Pobiera bieżący czas, głównie na potrzeby testów jednostkowych. (Odziedziczone po AuthenticationHandler<TOptions>) |
| UrlEncoder |
Pobiera UrlEncoder. (Odziedziczone po AuthenticationHandler<TOptions>) |
Metody
| AuthenticateAsync() |
Uwierzytelnij bieżące żądanie. (Odziedziczone po AuthenticationHandler<TOptions>) |
| AuthenticateAsync(AuthenticateContext) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po AuthenticationHandler<TOptions>) |
| BuildChallengeUrl(AuthenticationProperties, String) |
Tworzy adres URL wyzwania OAuth. |
| BuildChallengeUrl(AuthenticationProperties, String) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. |
| BuildRedirectUri(String) |
Tworzy bezwzględny adres URL dla określonego |
| ChallengeAsync(AuthenticationProperties) |
Wyśmiej bieżące żądanie. (Odziedziczone po AuthenticationHandler<TOptions>) |
| ChallengeAsync(ChallengeContext) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po AuthenticationHandler<TOptions>) |
| CreateEventsAsync() |
Tworzy nowe wystąpienie wystąpienia zdarzeń. |
| CreateEventsAsync() |
Tworzy nowe wystąpienie wystąpienia zdarzeń. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| CreateTicketAsync(ClaimsIdentity, AuthenticationProperties, OAuthTokenResponse) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. |
| CreateTicketAsync(ClaimsIdentity, AuthenticationProperties, OAuthTokenResponse) |
Tworzy AuthenticationTicket z określonego |
| ExchangeCodeAsync(OAuthCodeExchangeContext) |
Wymienia kod autoryzacji tokenu autoryzacji od dostawcy zdalnego. |
| ExchangeCodeAsync(String, String) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. |
| FinishResponseAsync() |
Hak, który jest wywoływany, gdy odpowiedź ma zostać wysłana (Odziedziczone po AuthenticationHandler<TOptions>) |
| ForbidAsync(AuthenticationProperties) |
Zabronić bieżącego żądania. (Odziedziczone po AuthenticationHandler<TOptions>) |
| FormatScope() |
Sformatuj właściwość Scope. |
| FormatScope(IEnumerable<String>) |
Sformatuj listę zakresów protokołu OAuth. |
| GenerateCorrelationId(AuthenticationProperties) |
Tworzy plik cookie zawierający nonce używany do korelowania bieżącego żądania uwierzytelniania zdalnego. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| GenerateCorrelationId(AuthenticationProperties) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| GetDescriptions(DescribeSchemesContext) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po AuthenticationHandler<TOptions>) |
| HandleAccessDeniedErrorAsync(AuthenticationProperties) |
Typy pochodne mogą zastąpić tę metodę w celu obsługi błędów odmowy dostępu. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| HandleAuthenticateAsync() |
Umożliwia typom pochodnym obsługę uwierzytelniania. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| HandleAuthenticateOnceAsync() |
Służy do zapewnienia, że funkcja HandleAuthenticateAsync jest wywoływana tylko raz. Kolejne wywołania będą zwracać ten sam wynik uwierzytelnienia. (Odziedziczone po AuthenticationHandler<TOptions>) |
| HandleAuthenticateOnceSafeAsync() |
Służy do zapewnienia, że funkcja HandleAuthenticateAsync jest wywoływana tylko raz. Kolejne wywołania będą zwracać ten sam wynik uwierzytelniania. Wszelkie wyjątki zostaną przekonwertowane na wynik uwierzytelniania, który zakończył się niepowodzeniem zawierający wyjątek. (Odziedziczone po AuthenticationHandler<TOptions>) |
| HandleChallengeAsync(AuthenticationProperties) |
Zastąpij tę metodę, aby poradzić sobie z problemami z wyzwaniem 401, jeśli schemat uwierzytelniania, którego dotyczy problem, dotyczy interakcji z uwierzytelnianiem w ramach przepływu żądań. (na przykład dodanie nagłówka odpowiedzi lub zmiana wyniku 401 na 302 na stronę logowania lub lokalizację logowania zewnętrznego). |
| HandleChallengeAsync(AuthenticationProperties) |
Zastąpij tę metodę, aby poradzić sobie z problemami z wyzwaniem 401, jeśli schemat uwierzytelniania, którego dotyczy problem, dotyczy interakcji z uwierzytelnianiem w ramach przepływu żądań. (na przykład dodanie nagłówka odpowiedzi lub zmiana wyniku 401 na 302 na stronę logowania lub lokalizację logowania zewnętrznego). (Odziedziczone po AuthenticationHandler<TOptions>) |
| HandleForbiddenAsync(AuthenticationProperties) |
Zastąp tę metodę, aby obsługiwać metodę Forbid. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| HandleForbiddenAsync(ChallengeContext) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| HandleRemoteAuthenticateAsync() |
Uwierzytelnianie tożsamości użytkownika za pomocą dostawcy tożsamości. Metoda przetwarza żądanie w punkcie końcowym zdefiniowanym przez callbackPath. |
| HandleRemoteCallbackAsync() |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| HandleRequestAsync() |
Obsługuje bieżące żądanie uwierzytelniania. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| HandleSignInAsync(SignInContext) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| HandleSignOutAsync(SignOutContext) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| HandleUnauthorizedAsync(ChallengeContext) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. |
| HandleUnauthorizedAsync(ChallengeContext) |
Zastąpij tę metodę, aby poradzić sobie z problemami z wyzwaniem 401, jeśli schemat uwierzytelniania, którego dotyczy problem, dotyczy interakcji z uwierzytelnianiem w ramach przepływu żądań. (na przykład dodanie nagłówka odpowiedzi lub zmiana wyniku 401 na 302 na stronę logowania lub lokalizację logowania zewnętrznego). (Odziedziczone po AuthenticationHandler<TOptions>) |
| InitializeAsync(AuthenticationScheme, HttpContext) |
Zainicjuj procedurę obsługi, rozwiąż opcje i zweryfikuj je. (Odziedziczone po AuthenticationHandler<TOptions>) |
| InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder) |
Inicjowanie jest wywoływane raz na żądanie w celu kontekstowania tego wystąpienia z odpowiednim stanem. (Odziedziczone po AuthenticationHandler<TOptions>) |
| InitializeEventsAsync() |
Inicjuje obiekt zdarzeń, wywoływany raz na żądanie przez InitializeAsync(AuthenticationScheme, HttpContext). (Odziedziczone po AuthenticationHandler<TOptions>) |
| InitializeHandlerAsync() |
Wywołana po zainicjowaniu opcji/zdarzeń została zainicjowana, aby program obsługi zakończył inicjowanie. (Odziedziczone po AuthenticationHandler<TOptions>) |
| ResolveTarget(String) |
Rozwiązuje schemat, do którego jest przekazywana ta operacja uwierzytelniania. (Odziedziczone po AuthenticationHandler<TOptions>) |
| ShouldHandleRequestAsync() |
Pobiera wartość określającą, czy bieżące żądanie uwierzytelniania powinno być obsługiwane przez HandleRequestAsync(). (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| ShouldHandleScheme(String, Boolean) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po AuthenticationHandler<TOptions>) |
| SignInAsync(SignInContext) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po AuthenticationHandler<TOptions>) |
| SignOutAsync(SignOutContext) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po AuthenticationHandler<TOptions>) |
| ValidateCorrelationId(AuthenticationProperties) |
Sprawdza, czy bieżące żądanie jest skorelowane z bieżącym żądaniem uwierzytelniania zdalnego. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |
| ValidateCorrelationId(AuthenticationProperties) |
Procedura obsługi uwierzytelniania, która obsługuje protokół OAuth. (Odziedziczone po RemoteAuthenticationHandler<TOptions>) |