Freigeben über


OAuthOptions Klasse

Definition

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 Autorisierungsanforderungen nicht genehmigt, oder legt diesen fest. Diese Eigenschaft ist standardmäßig nicht festgelegt. In diesem Fall wird eine Ausnahme ausgelöst, wenn eine access_denied Antwort vom Remoteautorisierungsserver zurückgegeben wird.

(Geerbt von RemoteAuthenticationOptions)
AdditionalAuthorizationParameters

Ruft die zusätzlichen Parameter ab, die in der Autorisierungsanforderung enthalten sein werden.

AuthorizationEndpoint

Ruft den URI ab, an den 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. Dies kann nicht gleichzeitig mit BackchannelCertificateValidator festgelegt werden, es sei denn, der Wert kann in einen WebRequestHandler downcast ausgeführt werden.

(Geerbt von RemoteAuthenticationOptions)
BackchannelTimeout

Ruft den Timeoutwert in Millisekunden für die Kommunikation mit dem Remoteidentitätsanbieter ab, oder legt den Timeoutwert fest.

(Geerbt von RemoteAuthenticationOptions)
CallbackPath

Der Anforderungspfad innerhalb des Basispfads der Anwendung, in dem der Benutzer-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

Dient zum Abrufen oder Festlegen des vom Anbieter zugewiesenen geheimen Clientschlüssels.

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

Dient zum Abrufen oder Festlegen der OAuthEvents, die zum Behandeln von Authentifizierungsereignissen verwendet wird.

EventsType

Wenn dieser Wert festgelegt ist, wird er als Diensttyp verwendet, um die Ereignisinstanz 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 die Authentifizierungshandler alle Authentifizierungsvorgänge standardmäßig 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 oder legt diese fest (standardmäßig 15 Minuten).

(Geerbt von RemoteAuthenticationOptions)
ReturnUrlParameter

Dient zum Abrufen oder Festlegen des Namens des Parameters, der verwendet wird, um den ursprünglichen Speicherort des Benutzers zu vermitteln, bevor die Remoteabfrage bis zur Seite "Zugriff verweigert" ausgelöst wurde. Diese Eigenschaft wird nur verwendet, wenn der AccessDeniedPath explizit angegeben wird.

(Geerbt von RemoteAuthenticationOptions)
SaveTokens

Definiert, ob Zugriffs- und Aktualisierungstoken nach erfolgreicher Autorisierung im AuthenticationProperties gespeichert werden sollen. Diese Eigenschaft ist standardmäßig auf false festgelegt, um die Größe des endgültigen Authentifizierungscookies zu verringern.

(Geerbt von RemoteAuthenticationOptions)
Scope

Ruft die Liste der Berechtigungen ab, die angefordert werden sollen.

SignInScheme

Ruft ab oder legt das Authentifizierungsschema, das der Middleware entspricht, die für die Beibehaltung der Identität des Benutzers nach einer erfolgreichen Authentifizierung verantwortlich ist. Dieser Wert entspricht in der Regel einer Cookie-Middleware, die in der Startup-Klasse registriert ist. Wenn sie weggelassen wird, wird DefaultSignInScheme als Fallbackwert verwendet.

(Geerbt von RemoteAuthenticationOptions)
StateDataFormat

Dient zum Abrufen oder Festlegen des Typs, der zum Sichern von Daten verwendet wird, die von der Middleware verarbeitet werden.

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 Proof Key for Code Exchange (PKCE)-Standards. Siehe https://tools.ietf.org/html/rfc7636. Der Standardwert ist false, aber abgeleitete Handler sollten dies aktivieren, wenn ihr Anbieter ihn unterstützt.

UserInformationEndpoint

Ruft den URI ab, auf den die Middleware zugreift, um die Benutzerinformationen abzurufen, oder legt diesen fest. Dieser Wert wird in der Standardimplementierung nicht verwendet, es wird in benutzerdefinierten Implementierungen von OnCreatingTicketverwendet.

Methoden

Validate()

Überprüfen Sie, ob die Optionen gültig sind. Sollte eine Ausnahme auslösen, wenn die Dinge nicht ok sind.

Validate(String)

Überprüft, ob die Optionen für ein bestimmtes Schema gültig sind.

(Geerbt von RemoteAuthenticationOptions)

Gilt für: