OpenIdConnectOptions Klasse

Definition

Namespace:

Microsoft.AspNetCore.Builder

Assembly:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Paket:

Microsoft.AspNetCore.Authentication.OpenIdConnect v1.1.0

Konfigurationsoptionen für .OpenIdConnectMiddleware

public ref class OpenIdConnectOptions : Microsoft::AspNetCore::Builder::RemoteAuthenticationOptions

public class OpenIdConnectOptions : Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions

type OpenIdConnectOptions = class
    inherit RemoteAuthenticationOptions

Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions

Vererbung

Object

AuthenticationOptions

RemoteAuthenticationOptions

OpenIdConnectOptions

Konstruktoren

OpenIdConnectOptions()	Initialisiert eine neue OpenIdConnectOptions-Schnittstelle.
OpenIdConnectOptions(String)	Initialisiert eine neue OpenIdConnectOptions-Schnittstelle.

Eigenschaften

AuthenticationMethod	Ruft die Methode ab, die verwendet wird, um den Benutzer-Agent an den Identitätsanbieter umzuleiten, oder legt sie fest.
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)
Authority	Ruft die bei OpenIdConnect-Aufrufen zu verwendende Authority ab oder legt diese 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 client_id ab oder legt diese fest.
ClientSecret	Ruft client_secret ab oder legt diesen Wert fest.
Configuration	Konfiguration, die direkt vom Entwickler bereitgestellt wird. Wenn diese Konfiguration bereitgestellt wird, werden MetadataAddress und die Backchannel-Eigenschaften nicht verwendet. Diese Informationen sollten während der Anforderungsverarbeitung nicht aktualisiert werden.
ConfigurationManager	Verantwortlich für den Abruf, das Caching und die Aktualisierung der Konfiguration aus den Metadaten. Wenn diese Konfiguration nicht bereitgestellt wird, wird mit MetadataAddress und den Backchannel-Eigenschaften eine Konfiguration erstellt.
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 IOpenIdConnectEvents beim Verarbeiten von OpenIdConnect-Nachrichten benachrichtigt werden soll, oder legt diesen fest.
GetClaimsFromUserInfoEndpoint	Boolean, um festzulegen, ob die Middleware an den Benutzerinformationsendpunkt wechseln soll, um zusätzliche Ansprüche abzurufen oder nicht, nachdem eine Identität von id_token vom Tokenendpunkt empfangen wurde. Der Standardwert ist "false".
MetadataAddress	Ruft den Erkennungsendpunkt zum Abrufen von Metadaten ab oder legt ihn fest.
PostLogoutRedirectUri	Der URI, an den der Benutzer-Agent zurückgegeben wird, nachdem die Anwendung vom Identitätsanbieter abgemeldet wurde. Die Umleitung erfolgt, nachdem der SignedOutCallbackPath aufgerufen wurde.
ProtocolValidator	Ruft den ab, der OpenIdConnectProtocolValidator verwendet wird, um sicherzustellen, dass der empfangene "id_token" gültig ist, oder legt diesen fest: http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
RefreshOnIssuerKeyNotFound	Ruft ab oder legt fest, ob nach einer SecurityTokenSignatureKeyNotFoundException eine Metadatenaktualisierung versucht werden soll. Dies ermöglicht automatische Wiederherstellung, im Fall eines Signaturschlüsselrollovers. Diese Einstellung ist standardmäßig aktiviert.
RemoteAuthenticationTimeout	Ruft das Zeitlimit für den Abschluss des Authentifizierungsflows ab oder legt dieses fest (standardmäßig 15 Minuten). (Geerbt von RemoteAuthenticationOptions)
RemoteSignOutPath	Anforderungen, die für diesen Pfad empfangen werden, führen dazu, dass die Middleware die SignOut-Instanz mithilfe von SignInScheme aufruft.
RequireHttpsMetadata	Ruft ab oder legt fest, ob HTTPS für die Metadatenadresse oder -autorität erforderlich ist. Der Standardwert ist „true“. Dies sollte nur in Entwicklungsumgebungen deaktiviert werden.
Resource	Ruft die resource ab oder legt sie fest.
ResponseMode	Ruft den "response_mode" ab oder legt diese fest.
ResponseType	Ruft den response_type ab bzw. legt ihn fest.
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.
SecurityTokenValidator	Ruft die zum Überprüfen von ISecurityTokenValidator Identitätstoken verwendeten ab oder legt diese fest.
SignedOutCallbackPath	Der Anforderungspfad innerhalb des Basispfads der Anwendung, in dem der Benutzer-Agent zurückgegeben wird, nachdem er sich vom Identitätsanbieter abgemeldet hat.
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)
SignOutScheme	Das Authentifizierungsschema, das mit SignOut Für signOutPath verwendet werden soll. SignInScheme wird verwendet, wenn dies nicht festgelegt ist.
SkipUnrecognizedRequests	Gibt an, ob Anforderungen an den CallbackPath möglicherweise auch für andere Komponenten gelten. Wenn aktiviert, übergibt die Middleware Anforderungen, die keine OpenIdConnect-Authentifizierungsantworten enthalten. Wenn Sie diesen Deaktivieren und den CallbackPath auf einen dedizierten Endpunkt festlegen, kann dies zu einer besseren Fehlerbehandlung führen. Diese Einstellung ist standardmäßig deaktiviert.
StateDataFormat	Ruft den Typ ab, der zum Sichern von Daten verwendet wird, die von der Middleware verarbeitet werden, oder legt diesen fest.
StringDataFormat	Ruft den Typ ab, der zum Schützen von Zeichenfolgen verwendet wird, die von der Middleware verwendet werden, oder legt diesen fest.
SystemClock	Nur zu Testzwecken. (Geerbt von AuthenticationOptions)
TokenValidationParameters	Ruft die Parameter ab, die zum Überprüfen von Identitätstoken verwendet werden, oder legt sie fest.
UseTokenLifetime	Gibt an, dass die Lebensdauer der Authentifizierungssitzung (z. B. Cookies) mit der des Authentifizierungstokens übereinstimmen soll. Wenn das Token keine Informationen zur Lebensdauer bereitstellt, wird die normale Lebensdauer der Sitzung verwendet. Diese Einstellung ist standardmäßig deaktiviert.