JwtBearerOptions Klasa

Definicja

Przestrzeń nazw:

Microsoft.AspNetCore.Authentication.JwtBearer

Zestaw:

Microsoft.AspNetCore.Authentication.JwtBearer.dll

Pakiet:

Microsoft.AspNetCore.Authentication.JwtBearer v8.0.0

Źródło:

JwtBearerOptions.cs

Klasa Options udostępnia informacje potrzebne do kontrolowania zachowania programu obsługi uwierzytelniania elementu nośnego

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

Dziedziczenie

Object

AuthenticationSchemeOptions

JwtBearerOptions

Konstruktory

JwtBearerOptions()

Inicjuje nowe wystąpienie klasy JwtBearerOptions.

Właściwości

Audience	Pobiera lub ustawia pojedynczą prawidłową wartość odbiorców dla dowolnego odebranego tokenu OpenIdConnect. Ta wartość jest przekazywana do elementu TokenValidationParameters.ValidAudience, jeśli ta właściwość jest pusta.
Authority	Pobiera lub ustawia urząd do użycia podczas wykonywania wywołań OpenIdConnect.
AutomaticRefreshInterval	Pobiera lub ustawia częstotliwość automatycznego odświeżania metadanych.
Backchannel	Element Backchannel używany do pobierania metadanych.
BackchannelHttpHandler	Metoda HttpMessageHandler używana do pobierania metadanych. Nie można go ustawić w tym samym czasie co BackchannelCertificateValidator, chyba że wartość jest elementem WebRequestHandler.
BackchannelTimeout	Pobiera lub ustawia limit czasu podczas używania zaplecza do wywołania http.
Challenge	Pobiera lub ustawia wyzwanie, aby umieścić w nagłówku "WWW-Authenticate".
ClaimsIssuer	Pobiera lub ustawia wystawcę, który ma być używany dla wszelkich utworzonych oświadczeń (Odziedziczone po AuthenticationSchemeOptions)
Configuration	Konfiguracja dostarczana bezpośrednio przez dewelopera. Jeśli zostanie podana, właściwości MetadataAddress i Backchannel nie będą używane. Te informacje nie powinny być aktualizowane podczas przetwarzania żądań.
ConfigurationManager	Odpowiedzialny za pobieranie, buforowanie i odświeżanie konfiguracji z metadanych. Jeśli nie zostanie podany, zostanie utworzony przy użyciu właściwości MetadataAddress i Backchannel.
Events	Obiekt dostarczony przez aplikację do przetwarzania zdarzeń zgłaszanych przez program obsługi uwierzytelniania elementu nośnego. Aplikacja może zaimplementować interfejs w pełni lub może utworzyć wystąpienie modułu JwtBearerEvents i przypisać delegatów tylko do zdarzeń, które chce przetworzyć.
EventsType	Jeśli jest ustawiona, zostanie użyta jako typ usługi, aby pobrać wystąpienie Zdarzenia zamiast właściwości . (Odziedziczone po AuthenticationSchemeOptions)
ForwardAuthenticate	W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania AuthenticateAsync. Na przykład Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie. (Odziedziczone po AuthenticationSchemeOptions)
ForwardChallenge	W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania ChallengeAsync. Na przykład Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie. (Odziedziczone po AuthenticationSchemeOptions)
ForwardDefault	W przypadku ustawienia określa domyślny schemat, do którego programy obsługi uwierzytelniania powinny domyślnie przekazywać wszystkie operacje uwierzytelniania. Domyślna logika przekazywania najpierw sprawdzi najbardziej konkretne ustawienie ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, a następnie sprawdź wartość ForwardDefaultSelector, a następnie pozycję ForwardDefaultSelector. Pierwszy wynik o wartości innej niż null będzie używany jako schemat docelowy do przekazywania dalej. (Odziedziczone po AuthenticationSchemeOptions)
ForwardDefaultSelector	Służy do wybierania domyślnego schematu dla bieżącego żądania, do którego programy obsługi uwierzytelniania powinny domyślnie przekazywać wszystkie operacje uwierzytelniania. Domyślna logika przekazywania najpierw sprawdzi najbardziej konkretne ustawienie ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, a następnie sprawdź wartość ForwardDefaultSelector, a następnie pozycję ForwardDefaultSelector. Pierwszy wynik o wartości innej niż null będzie używany jako schemat docelowy do przekazywania dalej. (Odziedziczone po AuthenticationSchemeOptions)
ForwardForbid	W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania ForbidAsync. Na przykład Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie. (Odziedziczone po AuthenticationSchemeOptions)
ForwardSignIn	W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania SignInAsync. Na przykład Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie. (Odziedziczone po AuthenticationSchemeOptions)
ForwardSignOut	W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania SignOutAsync. Na przykład Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie. (Odziedziczone po AuthenticationSchemeOptions)
IncludeErrorDetails	Określa, czy błędy weryfikacji tokenu powinny być zwracane do elementu wywołującego. Domyślnie tę opcję można wyłączyć, aby zapobiec zwracaniu błędu przez program obsługi JWT i error_description w nagłówku WWW-Authenticate.
MapInboundClaims	Pobiera lub ustawia MapInboundClaims właściwość w domyślnym wystąpieniu JwtSecurityTokenHandler klasy SecurityTokenValidators lub JsonWebTokenHandler w tokenhandlers, który jest używany podczas określania, czy mapować typy oświadczeń wyodrębnione podczas walidacji JwtSecurityToken lub JsonWebToken. Jeśli ta wartość ma wartość true, typ oświadczenia jest ustawiony na oświadczenie JSON "name" po przetłumaczeniu przy użyciu tego mapowania. W przeciwnym razie nie ma mapowania. Wartością domyślną jest true.
MetadataAddress	Pobiera lub ustawia punkt końcowy odnajdywania na potrzeby uzyskiwania metadanych
RefreshInterval	Pobiera lub ustawia minimalny czas między pobieraniem, w przypadku niepowodzenia pobierania lub jawnego żądania odświeżenia.
RefreshOnIssuerKeyNotFound	Pobiera lub ustawia, jeśli odświeżanie metadanych powinno zostać podjęta po operacji SecurityTokenSignatureKeyNotFoundException. Umożliwia to automatyczne odzyskiwanie w przypadku przerzucania klucza podpisu. Ta opcja jest domyślnie włączona.
RequireHttpsMetadata	Pobiera lub ustawia, jeśli dla adresu lub urzędu metadanych jest wymagany protokół HTTPS. Wartość domyślna to true. Powinno to być wyłączone tylko w środowiskach deweloperskich.
SaveToken	Określa, czy token elementu nośnego AuthenticationProperties powinien być przechowywany w obiekcie po pomyślnym uwierzytelnieniu.
SecurityTokenValidators	Przestarzałe. Pobiera uporządkowaną listę używanych ISecurityTokenValidator do weryfikowania tokenów dostępu.
TimeProvider	Służy do testowania. (Odziedziczone po AuthenticationSchemeOptions)
TokenHandlers	Pobiera uporządkowaną listę używanych TokenHandler do weryfikowania tokenów dostępu.
TokenValidationParameters	Pobiera lub ustawia parametry używane do weryfikowania tokenów tożsamości.
UseSecurityTokenValidators	Pobiera lub ustawia, czy TokenHandlersSecurityTokenValidators będzie używany do weryfikowania tokenu przychodzącego.

Metody

Validate()	Sprawdź, czy opcje są prawidłowe. Jeśli elementy nie są prawidłowe, należy zgłosić wyjątek. (Odziedziczone po AuthenticationSchemeOptions)
Validate(String)	Sprawdza, czy opcje są prawidłowe dla określonego schematu (Odziedziczone po AuthenticationSchemeOptions)