Freigeben über


OAuthOptions Klasse

Definition

Konfigurationsoptionen für OAuthMiddleware<TOptions>.

public ref class OAuthOptions : Microsoft::AspNetCore::Builder::RemoteAuthenticationOptions
public class OAuthOptions : Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions
type OAuthOptions = class
    inherit RemoteAuthenticationOptions
Public Class OAuthOptions
Inherits RemoteAuthenticationOptions
Vererbung
Abgeleitet

Konstruktoren

OAuthOptions()

Konfigurationsoptionen für OAuthMiddleware<TOptions>.

Eigenschaften

AuthenticationScheme

Die AuthenticationScheme in den Optionen entspricht dem logischen Namen für ein bestimmtes Authentifizierungsschema. Es kann ein anderer Wert zugewiesen werden, um den gleichen Authentifizierungsmiddlewaretyp mehrmals in einer Pipeline zu verwenden.

(Geerbt von AuthenticationOptions)
AuthorizationEndpoint

Ruft den URI ab, an dem der Client zur Authentifizierung umgeleitet wird, oder legt diesen fest.

AutomaticAuthenticate

Wenn true, ändert die Authentifizierungs-Middleware den anforderungsbenutzer, der eingeht. Bei "false" gibt die Authentifizierungs-Middleware nur dann Identität an, wenn sie von AuthenticationScheme explizit angegeben wird.

(Geerbt von AuthenticationOptions)
AutomaticChallenge

Wenn true, sollte die Middleware für die Authentifizierung automatische Herausforderungen verarbeiten. Bei "false" ändert die Authentifizierungs-Middleware antworten nur, wenn sie von AuthenticationScheme explizit angegeben werden.

(Geerbt von AuthenticationOptions)
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)
ClaimsIssuer

Ruft den Aussteller ab, der für alle ansprüche verwendet werden soll, die erstellt werden sollen, oder legt diesen fest.

(Geerbt von AuthenticationOptions)
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.

Description

Zusätzliche Informationen zum Authentifizierungstyp, die der Anwendung zur Verfügung gestellt werden.

(Geerbt von AuthenticationOptions)
DisplayName

Ruft den Text ab, den der Benutzer in einer Anmeldebenutzeroberfläche anzeigen kann, oder legt ihn fest.

(Geerbt von RemoteAuthenticationOptions)
Events

Ruft die ab, die IOAuthEvents zum Behandeln von Authentifizierungsereignissen verwendet wird, oder legt diese fest.

RemoteAuthenticationTimeout

Ruft das Zeitlimit für den Abschluss des Authentifizierungsflows ab oder legt dieses fest (standardmäßig 15 Minuten).

(Geerbt von RemoteAuthenticationOptions)
SaveTokens

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

(Geerbt von RemoteAuthenticationOptions)
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 es fest. Dieser Wert entspricht in der Regel einer Cookie-Middleware, die in der Startup-Klasse registriert ist. Wird bei Auslassung SignInScheme 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.

SystemClock

Nur zu Testzwecken.

SystemClock

Nur zu Testzwecken.

(Geerbt von AuthenticationOptions)
TokenEndpoint

Ruft den URI ab, auf den die Middleware zugreifen soll, um das OAuth-Token auszutauschen, oder legt diesen fest.

UserInformationEndpoint

Ruft den URI ab, auf den die Middleware zum Abrufen der Benutzerinformationen zugreifen soll, oder legt diesen fest. Dieser Wert wird nicht in der Standardimplementierung verwendet, er dient zur Verwendung in benutzerdefinierten Implementierungen von IOAuthAuthenticationEvents.Authenticated oder OAuthAuthenticationHandler.CreateTicketAsync.

Gilt für: