JwtBearerOptions Třída

Definice

Obor názvů:

Microsoft.AspNetCore.Authentication.JwtBearer

Sestavení:

Microsoft.AspNetCore.Authentication.JwtBearer.dll

Balíček:

Microsoft.AspNetCore.Authentication.JwtBearer v8.0.0

Zdroj:

JwtBearerOptions.cs

Třída Options poskytuje informace potřebné k řízení chování obslužné rutiny ověřování nosné.

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

Dědičnost

Object

AuthenticationSchemeOptions

JwtBearerOptions

Konstruktory

JwtBearerOptions()

Inicializuje novou instanci objektu JwtBearerOptions.

Vlastnosti

Audience	Získá nebo nastaví jednu platnou hodnotu cílové skupiny pro jakýkoli přijatý token OpenIdConnect. Tato hodnota se předá do TokenValidationParameters.ValidAudience, pokud je tato vlastnost prázdná.
Authority	Získá nebo nastaví autoritu pro použití při volání OpenIdConnect.
AutomaticRefreshInterval	Získá nebo nastaví, jak často by mělo dojít k automatické aktualizaci metadat.
Backchannel	Backchannel použitý k načtení metadat.
BackchannelHttpHandler	HttpMessageHandler použitý k načtení metadat. To nelze nastavit ve stejnou dobu jako BackchannelCertificateValidator, pokud hodnota není WebRequestHandler.
BackchannelTimeout	Získá nebo nastaví časový limit při použití backchannel k volání http.
Challenge	Získá nebo nastaví výzvu vložit do hlavičky "WWW-Authenticate".
ClaimsIssuer	Získá nebo nastaví vystavitele, který by se měl použít pro všechny vytvořené deklarace identity. (Zděděno od AuthenticationSchemeOptions)
Configuration	Konfigurace poskytovaná přímo vývojářem. Pokud je k dispozici, nebudou použity vlastnosti MetadataAddress a Backchannel. Tyto informace by neměly být aktualizovány během zpracování žádosti.
ConfigurationManager	Zodpovídá za načítání, ukládání do mezipaměti a aktualizaci konfigurace z metadat. Pokud není k dispozici, vytvoří se pomocí vlastností MetadataAddress a Backchannel.
Events	Objekt poskytnutý aplikací ke zpracování událostí vyvolaný obslužnou rutinou ověřování nosné. Aplikace může rozhraní plně implementovat nebo může vytvořit instanci JwtBearerEvents a přiřadit delegáty pouze k událostem, které chce zpracovat.
EventsType	Pokud je nastaveno, použije se jako typ služby k získání instance Events místo vlastnosti. (Zděděno od AuthenticationSchemeOptions)
ForwardAuthenticate	Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by mělo toto schéma směrovat volání AuthenticateAsync. Například Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions)
ForwardChallenge	Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by toto schéma mělo přesměrovávat volání ChallengeAsync. Například Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions)
ForwardDefault	Pokud je tato možnost nastavená, určuje výchozí schéma, do kterého by měly obslužné rutiny ověřování ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika přesměrování nejprve zkontroluje nastavení ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut a potom zkontroluje ForwardDefaultSelector a pak ForwardDefault. První výsledek, který není null, se použije jako cílové schéma, do které se má předat. (Zděděno od AuthenticationSchemeOptions)
ForwardDefaultSelector	Slouží k výběru výchozího schématu pro aktuální požadavek, do kterého by měly obslužné rutiny ověřování ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika přesměrování nejprve zkontroluje nastavení ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut a potom zkontroluje ForwardDefaultSelector a pak ForwardDefault. První výsledek, který není null, se použije jako cílové schéma, do které se má předat. (Zděděno od AuthenticationSchemeOptions)
ForwardForbid	Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by toto schéma mělo přesměrovávat volání ForbidAsync. Například Context.ForbidAsync("ThisScheme") => Context.Forbidasync("ForwardForbidValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions)
ForwardSignIn	Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by mělo toto schéma směrovat volání SignInAsync. Například Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions)
ForwardSignOut	Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by toto schéma mělo přesměrovávat volání SignOutAsync. Například Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions)
IncludeErrorDetails	Definuje, jestli se mají volajícímu vracet chyby ověření tokenu. Ve výchozím nastavení je tato možnost zakázaná, aby obslužná rutina JWT vracela chybu a error_description v hlavičce WWW-Authenticate.
MapInboundClaims	Získá nebo nastaví MapInboundClaims vlastnost výchozí instance JwtSecurityTokenHandler v SecurityTokenValidators nebo JsonWebTokenHandler v TokenHandlers, která se používá při určování, zda mapovat typy deklarací, které jsou extrahovány při ověřování JwtSecurityToken nebo JsonWebToken. Pokud je nastavená hodnota true, typ deklarace identity se po překladu pomocí tohoto mapování nastaví na deklaraci identity JSON name. V opačném případě nedojde k žádnému mapování. Výchozí hodnotou je hodnota true.
MetadataAddress	Získá nebo nastaví koncový bod zjišťování pro získání metadat.
RefreshInterval	Získá nebo nastaví minimální dobu mezi načteními v případě, že načtení selhalo nebo že byla explicitně požadována aktualizace.
RefreshOnIssuerKeyNotFound	Získá nebo nastaví, pokud metadata aktualizace by měla být pokus po SecurityTokenSignatureKeyNotFoundException. To umožňuje automatické obnovení v případě přechodu klíče podpisu. Tato možnost je ve výchozím nastavení zapnutá.
RequireHttpsMetadata	Získá nebo nastaví, pokud https je vyžadována pro metadata adresa nebo autorita. Výchozí hodnota je true. Tato možnost by měla být zakázaná pouze ve vývojových prostředích.
SaveToken	Definuje, zda má být nosný token uložen v po AuthenticationProperties úspěšné autorizaci.
SecurityTokenValidators	Zastaralé. Získá seřazený ISecurityTokenValidator seznam použitých k ověření přístupových tokenů.
TimeProvider	Používá se k testování. (Zděděno od AuthenticationSchemeOptions)
TokenHandlers	Získá seřazený TokenHandler seznam použitých k ověření přístupových tokenů.
TokenValidationParameters	Získá nebo nastaví parametry používané k ověření tokenů identity.
UseSecurityTokenValidators	Získá nebo nastaví, zda TokenHandlers nebo SecurityTokenValidators se použije k ověření příchozího tokenu.

Metody

Validate()	Zkontrolujte, jestli jsou možnosti platné. Pokud to není v pořádku, měl by vyvolat výjimku. (Zděděno od AuthenticationSchemeOptions)
Validate(String)	Zkontroluje, jestli jsou možnosti platné pro konkrétní schéma. (Zděděno od AuthenticationSchemeOptions)