JwtBearerOptions Klasse

Definition

Namespace:

Microsoft.AspNetCore.Authentication.JwtBearer

Assembly:

Microsoft.AspNetCore.Authentication.JwtBearer.dll

Paket:

Microsoft.AspNetCore.Authentication.JwtBearer v9.0.0

Quelle:

JwtBearerOptions.cs

Die Optionsklasse stellt Informationen bereit, die zum Steuern des Bearer authentication-Handlerverhaltens erforderlich sind.

public ref class JwtBearerOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptions

public class JwtBearerOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions

type JwtBearerOptions = class
    inherit AuthenticationSchemeOptions

Public Class JwtBearerOptions
Inherits AuthenticationSchemeOptions

Vererbung

Object

AuthenticationSchemeOptions

JwtBearerOptions

Konstruktoren

JwtBearerOptions()

Initialisiert eine neue Instanz von JwtBearerOptions.

Eigenschaften

Audience	Ruft einen einzelnen gültigen Zielgruppenwert für jedes empfangene OpenIdConnect-Token ab oder legt diesen fest. Dieser Wert wird an TokenValidationParameters.ValidAudience übergeben, wenn diese Eigenschaft leer ist.
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	Der Backchannel, der zum Abrufen von Metadaten verwendet wird.
BackchannelHttpHandler	Der HttpMessageHandler, der zum Abrufen von Metadaten verwendet wird. Diese Option kann nur dann zur gleichen Zeit wie BackchannelCertificateValidator festgelegt werden, wenn der Wert ein WebRequestHandler ist.
BackchannelTimeout	Ruft das Timeout beim Verwenden des Backchannels zum Vornehmen eines HTTP-Aufrufs ab oder legt es fest.
Challenge	Ruft die Challenge ab, die in den Header "WWW-Authenticate" eingefügt werden soll, oder legt sie fest.
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)
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.
Events	Das von der Anwendung bereitgestellte Objekt zur Verarbeitung von Ereignissen, die vom Bearerauthentifizierungshandler ausgelöst werden. Die Anwendung kann die Schnittstelle vollständig implementieren oder eine instance von JwtBearerEvents erstellen und Delegaten nur den Ereignissen zuweisen, die sie verarbeiten möchte.
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)
IncludeErrorDetails	Definiert, ob die Tokenüberprüfungsfehler an den Aufrufer zurückgegeben werden sollen. Standardmäßig aktiviert, kann diese Option deaktiviert werden, um zu verhindern, dass der JWT-Handler einen Fehler und eine error_description im WWW-Authenticate-Header zurückgibt.
MapInboundClaims	Ruft die -Eigenschaft für die MapInboundClaims Standard-instance von JwtSecurityTokenHandler in SecurityTokenValidators oder JsonWebTokenHandler in TokenHandlers ab, die verwendet wird, um zu bestimmen, ob Anspruchstypen zugeordnet werden, die beim Überprüfen eines JwtSecurityToken oder eines JsonWebTokenextrahiert 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“.
MetadataAddress	Ruft den Erkennungsendpunkt zum Abrufen von Metadaten ab oder legt ihn fest.
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.
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.
SaveToken	Definiert, ob das Bearertoken nach einer erfolgreichen Autorisierung in gespeichert AuthenticationProperties werden soll.
SecurityTokenValidators	Veraltet. Ruft die geordnete Liste der zum Überprüfen von ISecurityTokenValidator Zugriffstoken verwendeten Ab.
TimeProvider	Wird für Tests verwendet. (Geerbt von AuthenticationSchemeOptions)
TokenHandlers	Ruft die geordnete Liste der zum Überprüfen von TokenHandler Zugriffstoken verwendeten Ab.
TokenValidationParameters	Ruft die Parameter ab, die zum Überprüfen von Identitätstoken verwendet werden, oder legt sie fest.
UseSecurityTokenValidators	Ruft ab oder legt fest, ob TokenHandlers oder SecurityTokenValidators zum Überprüfen des eingehenden Tokens verwendet wird.

Methoden

Validate()	Überprüfen Sie, ob die Optionen gültig sind. Sollte eine Ausnahme auslösen, wenn die Dinge nicht in Ordnung sind. (Geerbt von AuthenticationSchemeOptions)
Validate(String)	Überprüft, ob die Optionen für ein bestimmtes Schema gültig sind. (Geerbt von AuthenticationSchemeOptions)