OpenIdConnectOptions Klasse

Definition

Namespace:

Microsoft.AspNetCore.Authentication.OpenIdConnect

Assembly:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Paket:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

Konfigurationsoptionen für .OpenIdConnectHandler

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

public class OpenIdConnectOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

type OpenIdConnectOptions = class
    inherit RemoteAuthenticationOptions

Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions

Vererbung

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OpenIdConnectOptions

Konstruktoren

OpenIdConnectOptions()

Initialisiert eine neue OpenIdConnectOptions-Schnittstelle.

Eigenschaften

AccessDeniedPath	Ruft den optionalen Pfad ab, an den der Benutzer-Agent umgeleitet wird, oder legt diesen fest, wenn der Benutzer die vom Remoteserver angeforderte Autorisierungsanforderung nicht genehmigt. 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)
AuthenticationMethod	Ruft die Methode ab, die verwendet wird, um den Benutzer-Agent an den Identitätsanbieter umzuleiten, oder legt sie fest.
Authority	Ruft die bei OpenIdConnect-Aufrufen zu verwendende Authority ab oder legt diese fest.
AutomaticRefreshInterval	Ruft ab oder legt fest, wie oft eine automatische Metadatenaktualisierung erfolgen soll.
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 ansprüche verwendet werden soll, die erstellt werden sollen, oder legt diesen fest. (Geerbt von AuthenticationSchemeOptions)
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.
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)
DisableTelemetry	Gibt an, ob Telemetriedaten deaktiviert werden sollen. Wenn dieses Feature aktiviert ist, wird die Assemblyversion der Microsoft IdentityModel-Pakete als Autorisierungs-/Abmeldeanforderungsparameter an den OpenID Connect-Remoteanbieter gesendet.
Events	Ruft die ab, die OpenIdConnectEvents beim Verarbeiten von OpenIdConnect-Nachrichten benachrichtigt werden soll, oder legt diesen fest.
EventsType	Falls festgelegt, wird als Diensttyp verwendet, um anstelle der -Eigenschaft die instance Ereignisse 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 Nicht-NULL-Ergebnis 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 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 Nicht-NULL-Ergebnis 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)
GetClaimsFromUserInfoEndpoint	Boolean, um festzulegen, ob der Handler zum 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".
MapInboundClaims	Ruft die -Eigenschaft für die MapInboundClaims Standard-instance von JwtSecurityTokenHandler in SecurityTokenValidator und standard instance von JsonWebTokenHandler in TokenHandler ab, die verwendet wird, um zu bestimmen, ob Anspruchstypen zugeordnet werden sollen, die beim Überprüfen eines JwtSecurityTokenextrahiert werden oder nicht. Wenn dies auf true festgelegt ist, wird der Anspruchstyp nach der Übersetzung mithilfe dieser Zuordnung auf den JSON-Anspruch "name" festgelegt. Andernfalls erfolgt keine Zuordnung. Der Standardwert lautet „true“.
MaxAge	Ruft den "max_age" ab oder legt diese fest. Wenn der Parameter "max_age" festgelegt ist, wird mit der Authentifizierungsanforderung gesendet. Wenn der Identitätsanbieter den Benutzer nicht innerhalb der angegebenen Zeitspanne aktiv authentifiziert hat, wird der Benutzer zur erneuten Authentifizierung aufgefordert. Standardmäßig ist kein max_age angegeben.
MetadataAddress	Ruft den Erkennungsendpunkt zum Abrufen von Metadaten ab oder legt ihn fest.
NonceCookie	Bestimmt die Einstellungen, die zum Erstellen des Nonce-Cookies verwendet werden, bevor das Cookie der Antwort hinzugefügt wird.
Prompt	Ruft die "Eingabeaufforderung" ab oder legt sie fest.
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
RefreshInterval	Ruft die Mindestzeit zwischen den Abrufen ab, falls ein Abruf fehlgeschlagen ist oder eine Aktualisierung explizit angefordert wurde, oder legt diese fest.
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 das Abschließen des Authentifizierungsflusses ab (standardmäßig 15 Minuten). (Geerbt von RemoteAuthenticationOptions)
RemoteSignOutPath	Anforderungen, die für diesen Pfad empfangen werden, führen dazu, dass der Handler die SignOut-Anmeldung mithilfe von SignOutScheme 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.
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 false festgelegt, um die Größe des endgültigen Authentifizierungscookies zu verringern. (Geerbt von RemoteAuthenticationOptions)
Scope	Ruft die Liste der anzufordernden Berechtigungen ab.
SecurityTokenValidator	Veraltet. 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. Siehe post_logout_redirect_uri von http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout.
SignedOutRedirectUri	Der URI, zu dem der Benutzer-Agent umgeleitet wird, nachdem die Anwendung vom Identitätsanbieter abgemeldet wurde. Die Umleitung erfolgt, nachdem der SignedOutCallbackPath aufgerufen wurde.
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)
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 der Handler 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 Schützen von Daten verwendet wird, die vom Handler verarbeitet werden, oder legt diesen fest.
StringDataFormat	Ruft den Typ ab, der zum Sichern von Zeichenfolgen verwendet wird, die vom Handler verwendet werden, oder legt diesen fest.
TimeProvider	Wird für Tests verwendet. (Geerbt von AuthenticationSchemeOptions)
TokenHandler	Ruft die zum Überprüfen von TokenHandler Identitätstoken verwendeten ab oder legt diese fest. Dies wird anstelle von SecurityTokenValidator verwendet, wenn UseSecurityTokenValidator ist false.
TokenValidationParameters	Ruft die Parameter ab, die zum Überprüfen von Identitätstoken verwendet werden, oder legt sie fest.
UsePkce	Aktiviert oder deaktiviert die Verwendung des PKCE-Standards (Proof Key for Code Exchange). Dies gilt nur, wenn auf ResponseType festgelegt Codeist. Siehe https://tools.ietf.org/html/rfc7636. Standardwert: true.
UseSecurityTokenValidator	Ruft ab oder legt fest, ob oder TokenHandlerSecurityTokenValidator zum Überprüfen von Identitätstoken verwendet werden soll.
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.

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)