OAuthHandler<TOptions> Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Ein Authentifizierungshandler, der OAuth unterstützt.
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)Typparameter
- TOptions
Der Typ der Optionen.
- Vererbung
- Abgeleitet
Konstruktoren
| OAuthHandler<TOptions>(HttpClient) |
Ein Authentifizierungshandler, der OAuth unterstützt. |
| OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock) |
Veraltet.
Initialisiert eine neue Instanz von OAuthHandler<TOptions>. |
| OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder) |
Initialisiert eine neue Instanz von OAuthHandler<TOptions>. |
Eigenschaften
| Backchannel |
Ruft die HttpClient Instanz ab, die für die Kommunikation mit dem Remoteauthentifizierungsanbieter verwendet wird. |
| ChallengeCalled |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>) |
| ClaimsIssuer |
Ruft den Aussteller ab, der verwendet werden soll, wenn Ansprüche ausgegeben werden. (Geerbt von AuthenticationHandler<TOptions>) |
| Clock |
Veraltet.
Ruft die ISystemClockab. (Geerbt von AuthenticationHandler<TOptions>) |
| Context |
Dient zum Abrufen oder Festlegen des HttpContext. (Geerbt von AuthenticationHandler<TOptions>) |
| CurrentUri |
Ruft die absolute aktuelle URL ab. (Geerbt von AuthenticationHandler<TOptions>) |
| Events |
Der Handler ruft Methoden für die Ereignisse auf, die dem Anwendungssteuerelement an bestimmten Stellen, an denen die Verarbeitung erfolgt, übergeben. Wenn keine Standardinstanz bereitgestellt wird, wird nichts angegeben, wenn die Methoden aufgerufen werden. |
| Events |
Der Handler ruft Methoden für die Ereignisse auf, die dem Anwendungssteuerelement an bestimmten Stellen, an denen die Verarbeitung erfolgt, übergeben. Wenn keine Standardinstanz bereitgestellt wird, wird nichts angegeben, wenn die Methoden aufgerufen werden. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| InitializeResult |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>) |
| Logger |
Ruft die ILoggerab. (Geerbt von AuthenticationHandler<TOptions>) |
| Options |
Ruft die Optionen ab, die diesem Authentifizierungshandler zugeordnet sind, oder legt diese fest. (Geerbt von AuthenticationHandler<TOptions>) |
| OptionsMonitor |
Ruft die IOptionsMonitor<TOptions> ab, um Änderungen an Optionen zu erkennen. (Geerbt von AuthenticationHandler<TOptions>) |
| OriginalPath |
Ruft den Pfad ab, wie von der Authentifizierungs-Middleware gesehen. (Geerbt von AuthenticationHandler<TOptions>) |
| OriginalPathBase |
Ruft die Pfadbasis ab, wie von der Authentifizierungs-Middleware gesehen. (Geerbt von AuthenticationHandler<TOptions>) |
| PriorHandler |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>) |
| Request |
Ruft die HttpRequest ab, die der aktuellen Anforderung zugeordnet ist. (Geerbt von AuthenticationHandler<TOptions>) |
| Response |
Ruft die HttpResponse ab, die der aktuellen Anforderung zugeordnet ist. (Geerbt von AuthenticationHandler<TOptions>) |
| Scheme |
Dient zum Abrufen oder Festlegen des AuthenticationScheme, das diesem Authentifizierungshandler zugeordnet ist. (Geerbt von AuthenticationHandler<TOptions>) |
| SignInAccepted |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>) |
| SignInScheme |
Das Authentifizierungsschema, das standardmäßig für die Anmeldung verwendet wird. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| SignOutAccepted |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>) |
| TimeProvider |
Ruft die aktuelle Zeit in erster Linie für Komponententests ab. (Geerbt von AuthenticationHandler<TOptions>) |
| UrlEncoder |
Ruft die UrlEncoderab. (Geerbt von AuthenticationHandler<TOptions>) |
Methoden
| AuthenticateAsync() |
Authentifizieren Sie die aktuelle Anforderung. (Geerbt von AuthenticationHandler<TOptions>) |
| AuthenticateAsync(AuthenticateContext) |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>) |
| BuildChallengeUrl(AuthenticationProperties, String) |
Erstellt die OAuth-Abfrage-URL. |
| BuildChallengeUrl(AuthenticationProperties, String) |
Ein Authentifizierungshandler, der OAuth unterstützt. |
| BuildRedirectUri(String) |
Erstellt eine absolute URL für die angegebene |
| ChallengeAsync(AuthenticationProperties) |
Fordern Sie die aktuelle Anforderung an. (Geerbt von AuthenticationHandler<TOptions>) |
| ChallengeAsync(ChallengeContext) |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>) |
| CreateEventsAsync() |
Erstellt eine neue Instanz der Ereignisinstanz. |
| CreateEventsAsync() |
Erstellt eine neue Instanz der Ereignisinstanz. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| CreateTicketAsync(ClaimsIdentity, AuthenticationProperties, OAuthTokenResponse) |
Ein Authentifizierungshandler, der OAuth unterstützt. |
| CreateTicketAsync(ClaimsIdentity, AuthenticationProperties, OAuthTokenResponse) |
Erstellt eine AuthenticationTicket aus dem angegebenen |
| ExchangeCodeAsync(OAuthCodeExchangeContext) |
Austausch des Autorisierungscodes für ein Autorisierungstoken vom Remoteanbieter. |
| ExchangeCodeAsync(String, String) |
Ein Authentifizierungshandler, der OAuth unterstützt. |
| FinishResponseAsync() |
Hook, der aufgerufen wird, wenn die Antwort gesendet werden soll (Geerbt von AuthenticationHandler<TOptions>) |
| ForbidAsync(AuthenticationProperties) |
Verbieten Sie die aktuelle Anforderung. (Geerbt von AuthenticationHandler<TOptions>) |
| FormatScope() |
Formatieren Sie die Scope-Eigenschaft. |
| FormatScope(IEnumerable<String>) |
Formatieren einer Liste von OAuth-Bereichen. |
| GenerateCorrelationId(AuthenticationProperties) |
Erzeugt ein Cookie, das eine Nonce enthält, die verwendet wird, um die aktuelle Remoteauthentifizierungsanforderung zu korrelieren. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| GenerateCorrelationId(AuthenticationProperties) |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| GetDescriptions(DescribeSchemesContext) |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>) |
| HandleAccessDeniedErrorAsync(AuthenticationProperties) |
Abgeleitete Typen können diese Methode außer Kraft setzen, um Zugriff verweigerte Fehler zu behandeln. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| HandleAuthenticateAsync() |
Ermöglicht abgeleiteten Typen die Authentifizierung zu verarbeiten. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| HandleAuthenticateOnceAsync() |
Wird verwendet, um sicherzustellen, dass HandleAuthenticateAsync nur einmal aufgerufen wird. Die nachfolgenden Aufrufe geben dasselbe Authentifizierungsergebnis zurück. (Geerbt von AuthenticationHandler<TOptions>) |
| HandleAuthenticateOnceSafeAsync() |
Wird verwendet, um sicherzustellen, dass HandleAuthenticateAsync nur einmal sicher aufgerufen wird. Die nachfolgenden Aufrufe geben dasselbe Authentifizierungsergebnis zurück. Alle Ausnahmen werden in ein fehlgeschlagenes Authentifizierungsergebnis konvertiert, das die Ausnahme enthält. (Geerbt von AuthenticationHandler<TOptions>) |
| HandleChallengeAsync(AuthenticationProperties) |
Überschreiben Sie diese Methode, um probleme mit 401-Herausforderungen zu umgehen, wenn ein fragliches Authentifizierungsschema eine Authentifizierungsinteraktion als Teil des Anforderungsflusses behandelt. (wie das Hinzufügen eines Antwortheaders oder das Ändern des Ergebnisses 401 auf 302 einer Anmeldeseite oder eines externen Anmeldespeicherorts.) |
| HandleChallengeAsync(AuthenticationProperties) |
Überschreiben Sie diese Methode, um probleme mit 401-Herausforderungen zu umgehen, wenn ein fragliches Authentifizierungsschema eine Authentifizierungsinteraktion als Teil des Anforderungsflusses behandelt. (wie das Hinzufügen eines Antwortheaders oder das Ändern des Ergebnisses 401 auf 302 einer Anmeldeseite oder eines externen Anmeldespeicherorts.) (Geerbt von AuthenticationHandler<TOptions>) |
| HandleForbiddenAsync(AuthenticationProperties) |
Überschreiben Sie diese Methode, um Forbid zu behandeln. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| HandleForbiddenAsync(ChallengeContext) |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| HandleRemoteAuthenticateAsync() |
Authentifizieren Sie die Benutzeridentität beim Identitätsanbieter. Die Methode verarbeitet die Anforderung auf dem von CallbackPath definierten Endpunkt. |
| HandleRemoteCallbackAsync() |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| HandleRequestAsync() |
Behandelt die aktuelle Authentifizierungsanforderung. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| HandleSignInAsync(SignInContext) |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| HandleSignOutAsync(SignOutContext) |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| HandleUnauthorizedAsync(ChallengeContext) |
Ein Authentifizierungshandler, der OAuth unterstützt. |
| HandleUnauthorizedAsync(ChallengeContext) |
Überschreiben Sie diese Methode, um probleme mit 401-Herausforderungen zu umgehen, wenn ein fragliches Authentifizierungsschema eine Authentifizierungsinteraktion als Teil des Anforderungsflusses behandelt. (wie das Hinzufügen eines Antwortheaders oder das Ändern des Ergebnisses 401 auf 302 einer Anmeldeseite oder eines externen Anmeldespeicherorts.) (Geerbt von AuthenticationHandler<TOptions>) |
| InitializeAsync(AuthenticationScheme, HttpContext) |
Initialisieren Sie den Handler, lösen Sie die Optionen auf, und überprüfen Sie sie. (Geerbt von AuthenticationHandler<TOptions>) |
| InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder) |
Initialisieren wird einmal pro Anforderung aufgerufen, um diese Instanz mit dem entsprechenden Zustand zu kontextualisieren. (Geerbt von AuthenticationHandler<TOptions>) |
| InitializeEventsAsync() |
Initialisiert das Ereignisobjekt, das einmal pro Anforderung durch InitializeAsync(AuthenticationScheme, HttpContext)aufgerufen wird. (Geerbt von AuthenticationHandler<TOptions>) |
| InitializeHandlerAsync() |
Wird aufgerufen, nachdem Optionen/Ereignisse für den Handler initialisiert wurden, um die Initialisierung selbst abzuschließen. (Geerbt von AuthenticationHandler<TOptions>) |
| ResolveTarget(String) |
Löst das Schema auf, an das dieser Authentifizierungsvorgang weitergeleitet wird. (Geerbt von AuthenticationHandler<TOptions>) |
| ShouldHandleRequestAsync() |
Ruft einen Wert ab, der bestimmt, ob die aktuelle Authentifizierungsanforderung von HandleRequestAsync()behandelt werden soll. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| ShouldHandleScheme(String, Boolean) |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>) |
| SignInAsync(SignInContext) |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>) |
| SignOutAsync(SignOutContext) |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von AuthenticationHandler<TOptions>) |
| ValidateCorrelationId(AuthenticationProperties) |
Überprüft, ob die aktuelle Anforderung mit der aktuellen Remoteauthentifizierungsanforderung korreliert. (Geerbt von RemoteAuthenticationHandler<TOptions>) |
| ValidateCorrelationId(AuthenticationProperties) |
Ein Authentifizierungshandler, der OAuth unterstützt. (Geerbt von RemoteAuthenticationHandler<TOptions>) |