OAuthOptions 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.
Konfigurationsoptionen 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
- Vererbung
- Abgeleitet
Konstruktoren
OAuthOptions() |
Initialisiert eine neue Instanz von OAuthOptions. |
Eigenschaften
AccessDeniedPath |
Ruft den optionalen Pfad ab, an den der Benutzer-Agent umgeleitet wird, wenn der Benutzer die vom Remoteserver angeforderte Autorisierungsanforderung nicht genehmigt, oder legt diesen fest. Diese Eigenschaft ist nicht standardmäßig festgelegt. In diesem Fall wird eine Ausnahme ausgelöst, wenn vom Remoteautorisierungsserver eine access_denied Antwort zurückgegeben wird. (Geerbt von RemoteAuthenticationOptions) |
AuthorizationEndpoint |
Ruft den URI ab, an dem der Client zur Authentifizierung umgeleitet wird, oder legt diesen fest. |
Backchannel |
Wird für die Kommunikation mit dem Remoteidentitätsanbieter verwendet. (Geerbt von RemoteAuthenticationOptions) |
BackchannelHttpHandler |
Der httpMessageHandler, der für die Kommunikation mit dem Remoteidentitätsanbieter verwendet wird. Diese Option kann nur dann zur gleichen Zeit wie BackchannelCertificateValidator festgelegt werden, wenn der Wert in eine abgeleitete Klasse WebRequestHandler umgewandelt werden kann. (Geerbt von RemoteAuthenticationOptions) |
BackchannelTimeout |
Ruft den Timeoutwert in Millisekunden für die Rückkanalkommunikation mit dem Remoteidentitätsanbieter ab oder legt diese fest. (Geerbt von RemoteAuthenticationOptions) |
CallbackPath |
Der Anforderungspfad im Basispfad der Anwendung, an den user-agent zurückgegeben wird. Die Middleware verarbeitet diese Anforderung, wenn sie eingeht. (Geerbt von RemoteAuthenticationOptions) |
ClaimActions |
Eine Sammlung von Anspruchsaktionen, die zum Auswählen von Werten aus den JSON-Benutzerdaten und zum Erstellen von Ansprüchen verwendet werden. |
ClaimsIssuer |
Ruft den Aussteller ab, der für alle erstellten Ansprüche verwendet werden soll, oder legt diesen fest. (Geerbt von AuthenticationSchemeOptions) |
ClientId |
Ruft die vom Anbieter zugewiesene Client-ID ab oder legt sie fest. |
ClientSecret |
Ruft den vom Anbieter zugewiesenen geheimen Clientschlüssel ab oder legt dieses fest. |
CorrelationCookie |
Bestimmt die Einstellungen, die zum Erstellen des Korrelationscookies verwendet werden, bevor das Cookie der Antwort hinzugefügt wird. (Geerbt von RemoteAuthenticationOptions) |
DataProtectionProvider |
Ruft den Typ ab, der zum Sichern von Daten verwendet wird, oder legt diesen fest. (Geerbt von RemoteAuthenticationOptions) |
Events |
Ruft den ab, der OAuthEvents zum Behandeln von Authentifizierungsereignissen verwendet wird, oder legt diesen fest. |
EventsType |
Wenn festgelegt, wird als Diensttyp verwendet, um die Ereignisse instance anstelle der -Eigenschaft abzurufen. (Geerbt von AuthenticationSchemeOptions) |
ForwardAuthenticate |
Wenn festgelegt, gibt dies das Zielschema an, an das dieses Schema AuthenticateAsync-Aufrufe weiterleiten soll. Beispiel: Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Legen Sie das Ziel auf das aktuelle Schema fest, um die Weiterleitung zu deaktivieren und die normale Verarbeitung zuzulassen. (Geerbt von AuthenticationSchemeOptions) |
ForwardChallenge |
Wenn festgelegt, gibt dies das Zielschema an, an das dieses Schema ChallengeAsync-Aufrufe weiterleiten soll. Beispiel: Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Legen Sie das Ziel auf das aktuelle Schema fest, um die Weiterleitung zu deaktivieren und die normale Verarbeitung zuzulassen. (Geerbt von AuthenticationSchemeOptions) |
ForwardDefault |
Wenn festgelegt, gibt dies ein Standardschema an, an das Authentifizierungshandler standardmäßig alle Authentifizierungsvorgänge weiterleiten sollen. Die Standardweiterleitungslogik überprüft zuerst die spezifische Einstellung ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, gefolgt von ForwardDefaultSelector, gefolgt von ForwardDefault. Das erste Ergebnis ungleich NULL wird als Zielschema verwendet, an das weitergeleitet werden soll. (Geerbt von AuthenticationSchemeOptions) |
ForwardDefaultSelector |
Wird verwendet, um ein Standardschema für die aktuelle Anforderung auszuwählen, an das Authentifizierungshandler standardmäßig alle Authentifizierungsvorgänge weiterleiten sollen. Die Standardweiterleitungslogik überprüft zuerst die spezifische Einstellung ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, gefolgt von ForwardDefaultSelector, gefolgt von ForwardDefault. Das erste Ergebnis ungleich NULL wird als Zielschema verwendet, an das weitergeleitet werden soll. (Geerbt von AuthenticationSchemeOptions) |
ForwardForbid |
Wenn festgelegt, gibt dies das Zielschema an, an das dieses Schema ForbidAsync-Aufrufe weiterleiten soll. Beispiel: Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Legen Sie das Ziel auf das aktuelle Schema fest, um die Weiterleitung zu deaktivieren und die normale Verarbeitung zuzulassen. (Geerbt von AuthenticationSchemeOptions) |
ForwardSignIn |
Wenn festgelegt, gibt dies das Zielschema an, an das dieses Schema SignInAsync-Aufrufe weiterleiten soll. Beispiel: Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Legen Sie das Ziel auf das aktuelle Schema fest, um die Weiterleitung zu deaktivieren und die normale Verarbeitung zuzulassen. (Geerbt von AuthenticationSchemeOptions) |
ForwardSignOut |
Wenn festgelegt, gibt dies das Zielschema an, an das dieses Schema SignOutAsync-Aufrufe weiterleiten soll. Beispiel: Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Legen Sie das Ziel auf das aktuelle Schema fest, um die Weiterleitung zu deaktivieren und die normale Verarbeitung zuzulassen. (Geerbt von AuthenticationSchemeOptions) |
RemoteAuthenticationTimeout |
Ruft das Zeitlimit für das Abschließen des Authentifizierungsflusses ab (standardmäßig 15 Minuten). (Geerbt von RemoteAuthenticationOptions) |
ReturnUrlParameter |
Ruft den Namen des Parameters ab, der verwendet wird, um den ursprünglichen Speicherort des Benutzers zu übermitteln, bevor die Remoteanforderung bis zur Seite "Zugriff verweigert" ausgelöst wurde, oder legt diesen fest. Diese Eigenschaft wird nur verwendet, wenn explizit AccessDeniedPath angegeben wird. (Geerbt von RemoteAuthenticationOptions) |
SaveTokens |
Definiert, ob Zugriffs- und Aktualisierungstoken nach einer erfolgreichen Autorisierung in gespeichert AuthenticationProperties werden sollen.
Diese Eigenschaft ist standardmäßig auf |
Scope |
Ruft die Liste der anzufordernden Berechtigungen ab. |
SignInScheme |
Ruft das Authentifizierungsschema ab, das der Middleware entspricht, die für die Beibehaltung der Benutzeridentität nach einer erfolgreichen Authentifizierung verantwortlich ist, oder legt dieses fest. Dieser Wert entspricht in der Regel einer Cookie-Middleware, die in der Startup-Klasse registriert ist. Wenn nicht angegeben, DefaultSignInScheme wird als Fallbackwert verwendet. (Geerbt von RemoteAuthenticationOptions) |
StateDataFormat |
Ruft den Typ ab, der zum Sichern von Daten verwendet wird, die von der Middleware verarbeitet werden, oder legt diesen fest. |
TimeProvider |
Wird zum Testen verwendet. (Geerbt von AuthenticationSchemeOptions) |
TokenEndpoint |
Ruft den URI ab, auf den die Middleware zugreifen wird, um das OAuth-Token auszutauschen, oder legt diesen fest. |
UsePkce |
Aktiviert oder deaktiviert die Verwendung des PKCE-Standards (Proof Key for Code Exchange). Siehe https://tools.ietf.org/html/rfc7636.
Der Standardwert ist |
UserInformationEndpoint |
Ruft den URI ab, auf den die Middleware zum Abrufen der Benutzerinformationen zugreift, oder legt diesen fest. Dieser Wert wird nicht in der Standardimplementierung verwendet, er dient zur Verwendung in benutzerdefinierten Implementierungen von OnCreatingTicket. |
Methoden
Validate() |
Überprüfen Sie, ob die Optionen gültig sind. Sollte eine Ausnahme auslösen, wenn die Dinge nicht in Ordnung sind. |
Validate(String) |
Überprüft, ob die Optionen für ein bestimmtes Schema gültig sind. (Geerbt von RemoteAuthenticationOptions) |
Gilt für:
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für