OpenIdConnectOptions Klasse

Definition

Namespace:

Microsoft.AspNetCore.Authentication.OpenIdConnect

Assembly:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Paket:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

Quelle:

OpenIdConnectOptions.cs

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

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)
AuthenticationMethod	Dient zum Abrufen oder Festlegen der Methode, mit der der Benutzer-Agent an den Identitätsanbieter umgeleitet wird.
Authority	Ruft die Autorität ab, die beim Ausführen von OpenIdConnect-Aufrufen verwendet werden soll, oder legt sie 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. 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	Dient zum Abrufen oder Festlegen des "client_id".
ClientSecret	Dient zum Abrufen oder Festlegen des "client_secret".
Configuration	Konfiguration, die direkt vom Entwickler bereitgestellt wird. Wenn angegeben, werden "MetadataAddress" und die Backchannel-Eigenschaften nicht verwendet. Diese Informationen sollten während der Anforderungsverarbeitung nicht aktualisiert werden.
ConfigurationManager	Verantwortlich für das Abrufen, Zwischenspeichern und Aktualisieren der Konfiguration aus Metadaten. Wenn nicht angegeben, wird eine mit den Eigenschaften MetadataAddress und Backchannel 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 Telemetrie deaktiviert werden soll. Wenn dieses Feature aktiviert ist, wird die Assemblyversion der Microsoft IdentityModel-Pakete als Autorisierungs-/Abmeldeanforderungsparameter an den Remote-OpenID Connect-Anbieter gesendet.
Events	Ruft den OpenIdConnectEvents ab, der beim Verarbeiten von OpenIdConnect-Nachrichten benachrichtigt werden soll, oder legt diesen fest.
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)
GetClaimsFromUserInfoEndpoint	Boolean to set whether the handler should go to user info endpoint to retrieve additional claims or not after creating an identity from id_token received from token endpoint. Der Standardwert ist "false".
MapInboundClaims	Dient zum Abrufen oder Festlegen der MapInboundClaims -Eigenschaft für die Standardinstanz von JwtSecurityTokenHandler in SecurityTokenValidator und Standardinstanz von JsonWebTokenHandler in TokenHandler, die verwendet wird, wenn bestimmt wird, ob Anspruchstypen zugeordnet werden sollen, die beim Überprüfen eines JwtSecurityTokenextrahiert werden. Wenn dies auf "true" festgelegt ist, wird der Anspruchstyp nach der Übersetzung mithilfe dieser Zuordnung auf den JSON-Anspruchsnamen festgelegt. Andernfalls tritt keine Zuordnung auf. Der Standardwert ist true.
MaxAge	Dient zum Abrufen oder Festlegen des "max_age". Wenn der Parameter "max_age" festgelegt wird, wird mit der Authentifizierungsanforderung gesendet. Wenn der Identitätsanbieter den Benutzer nicht aktiv innerhalb der angegebenen Zeit authentifiziert hat, wird der Benutzer aufgefordert, sich erneut zu authentifizieren. Standardmäßig ist kein max_age angegeben.
MetadataAddress	Ruft den Ermittlungsendpunkt zum Abrufen von Metadaten ab oder legt den Ermittlungsendpunkt fest.
NonceCookie	Bestimmt die Einstellungen, die zum Erstellen des Nonce-Cookies verwendet werden, bevor das Cookie der Antwort hinzugefügt wird.
Prompt	Dient zum Abrufen oder Festlegen der Eingabeaufforderung.
ProtocolValidator	Dient zum Abrufen oder Festlegen des OpenIdConnectProtocolValidator, der verwendet wird, um sicherzustellen, dass der empfangene "id_token" gültig ist pro: http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
RefreshInterval	Dient zum Abrufen oder Festlegen der Mindestzeit zwischen Abrufen, falls ein Abruf fehlgeschlagen ist oder dass eine Aktualisierung explizit angefordert wurde.
RefreshOnIssuerKeyNotFound	Ruft ab oder legt fest, ob eine Metadatenaktualisierung nach einer SecurityTokenSignatureKeyNotFoundException versucht werden soll. Dies ermöglicht die automatische Wiederherstellung im Falle eines Signaturschlüsselrollovers. Dies ist standardmäßig aktiviert.
RemoteAuthenticationTimeout	Ruft das Zeitlimit für das Abschließen des Authentifizierungsflusses ab oder legt diese fest (standardmäßig 15 Minuten). (Geerbt von RemoteAuthenticationOptions)
RemoteSignOutPath	Anforderungen, die auf diesem Pfad empfangen werden, führen dazu, dass der Handler SignOut mithilfe der 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 'Ressource' ab oder legt sie fest.
ResponseMode	Dient zum Abrufen oder Festlegen des "response_mode".
ResponseType	Dient zum Abrufen oder Festlegen des "response_type".
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.
SecurityTokenValidator	Veraltet. Dient zum Abrufen oder Festlegen der ISecurityTokenValidator, die zum Überprüfen von Identitätstoken verwendet wird.
SignedOutCallbackPath	Der Anforderungspfad innerhalb des Basispfads der Anwendung, in dem der Benutzer-Agent nach der Abmeldung vom Identitätsanbieter zurückgegeben wird. Siehe post_logout_redirect_uri aus http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout.
SignedOutRedirectUri	Der URI, an den der Benutzer-Agent umgeleitet wird, nachdem die Anwendung vom Identitätsanbieter abgemeldet wurde. Die Umleitung erfolgt, nachdem der SignedOutCallbackPath aufgerufen wurde.
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)
SignOutScheme	Das Authentifizierungsschema, das mit SignOut im 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 der Handler aktiviert ist, werden Anforderungen übergeben, die keine OpenIdConnect-Authentifizierungsantworten enthalten. Wenn Sie dies deaktivieren und den CallbackPath auf einen dedizierten Endpunkt festlegen, kann dies eine bessere Fehlerbehandlung bieten. Dies ist standardmäßig deaktiviert.
StateDataFormat	Ruft den Typ ab, der zum Sichern 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 zum Testen verwendet. (Geerbt von AuthenticationSchemeOptions)
TokenHandler	Dient zum Abrufen oder Festlegen der TokenHandler, die zum Überprüfen von Identitätstoken verwendet wird. Dies wird anstelle von SecurityTokenValidator verwendet, wenn UseSecurityTokenValidatorfalseist.
TokenValidationParameters	Dient zum Abrufen oder Festlegen der Parameter, die zum Überprüfen von Identitätstoken verwendet werden.
UsePkce	Aktiviert oder deaktiviert die Verwendung des Proof Key for Code Exchange (PKCE)-Standards. Dies gilt nur, wenn die ResponseType auf Codefestgelegt ist. Siehe https://tools.ietf.org/html/rfc7636. Der Standardwert ist true.
UseSecurityTokenValidator	Ruft ab oder legt fest, ob die TokenHandler oder die SecurityTokenValidator zum Überprüfen von Identitätstoken verwendet werden soll.
UseTokenLifetime	Gibt an, dass die Lebensdauer der Authentifizierungssitzung (z. B. Cookies) mit dem des Authentifizierungstokens übereinstimmen soll. Wenn das Token keine Lebenszeitinformationen bereitstellt, werden normale Sitzungsdauern verwendet. Dies ist standardmäßig deaktiviert.

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)