JwtBearerOptions Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Třída Options poskytuje informace potřebné k řízení chování obslužné rutiny bearer authentication
public ref class JwtBearerOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptionspublic class JwtBearerOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptionstype JwtBearerOptions = class
inherit AuthenticationSchemeOptionsPublic Class JwtBearerOptions
Inherits AuthenticationSchemeOptions- Dědičnost
Konstruktory
| JwtBearerOptions() |
Inicializuje novou instanci JwtBearerOptions. |
Vlastnosti
| Audience |
Získá nebo nastaví jednu platnou hodnotu cílové skupiny pro libovolný přijatý token OpenIdConnect. Tato hodnota se předává do TokenValidationParameters.ValidAudience, pokud je tato vlastnost prázdná. |
| Authority |
Získá nebo nastaví autoritu, která se má použít při volání OpenIdConnect. |
| AutomaticRefreshInterval |
Získá nebo nastaví, jak často má dojít k automatické aktualizaci metadat. |
| Backchannel |
Backchannel se používá k načtení metadat. |
| BackchannelHttpHandler |
HttpMessageHandler použitý k načtení metadat. Tuto možnost nelze nastavit ve stejnou dobu jako BackchannelCertificateValidator, pokud hodnota není WebRequestHandler. |
| BackchannelTimeout |
Získá nebo nastaví časový limit při použití backchannel k provedení volání HTTP. |
| Challenge |
Získá nebo nastaví výzvu k vložení do hlavičky WWW-Authenticate. |
| ClaimsIssuer |
Získá nebo nastaví vystavitele, který se má 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 se neměly během zpracování žádosti aktualizovat. |
| ConfigurationManager |
Zodpovídá za načítání, ukládání do mezipaměti a aktualizaci konfigurace z metadat. Pokud není k dispozici, vytvoří se jeden pomocí vlastností MetadataAddress a Backchannel. |
| Events |
Objekt poskytovaný aplikací ke zpracování událostí vyvolaný obslužnou rutinou ověřování nosný. Aplikace může plně implementovat rozhraní, nebo může vytvořit instanci JwtBearerEvents a přiřadit delegáty pouze k událostem, které chce zpracovat. |
| EventsType |
Pokud je nastavena, 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, kterému má toto schéma předávat volání AuthenticateAsync. Například Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Nastavte cíl na aktuální schéma a zakažte předávání a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions) |
| ForwardChallenge |
Pokud je tato možnost nastavená, určuje cílové schéma, kterému má toto schéma předávat volání ChallengeAsync. Například Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Nastavte cíl na aktuální schéma a zakažte předávání a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions) |
| ForwardDefault |
Pokud je tato možnost nastavená, určuje výchozí schéma, do kterého by obslužné rutiny ověřování měly ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika předávání nejprve zkontroluje nejsměrnější nastavení ForwardAuthenticate,Challenge/Forbid/SignIn/SignOut a pak zkontroluje ForwardDefaultSelector a pak forwardDefault. První výsledek, který není null, se použije jako cílové schéma, na které se má přeposlat. (Zděděno od AuthenticationSchemeOptions) |
| ForwardDefaultSelector |
Používá se k výběru výchozího schématu pro aktuální požadavek, do kterého by obslužné rutiny ověřování měly ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika předávání nejprve zkontroluje nejsměrnější nastavení ForwardAuthenticate,Challenge/Forbid/SignIn/SignOut a pak zkontroluje ForwardDefaultSelector a pak forwardDefault. První výsledek, který není null, se použije jako cílové schéma, na které se má přeposlat. (Zděděno od AuthenticationSchemeOptions) |
| ForwardForbid |
Pokud je tato možnost nastavená, určuje cílové schéma, kterému má toto schéma předávat volání ForbidAsync. Například Context.ForbidAsync("ThisScheme") => Context.Forbidasync("ForwardForbidValue"); Nastavte cíl na aktuální schéma a zakažte předávání a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions) |
| ForwardSignIn |
Pokud je tato možnost nastavená, určuje cílové schéma, kterému má toto schéma předávat volání SignInAsync. Například Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Nastavte cíl na aktuální schéma a zakažte předávání a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions) |
| ForwardSignOut |
Pokud je tato možnost nastavená, určuje cílové schéma, kterému má toto schéma předávat volání SignOutAsync. Například Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Nastavte cíl na aktuální schéma a zakažte předávání a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions) |
| IncludeErrorDetails |
Definuje, jestli se volajícímu mají vrátit chyby ověření tokenu. Ve výchozím nastavení je tato možnost zakázaná, aby obslužná rutina JWT nevrátil chybu a error_description v hlavičce WWW-Authenticate. |
| MapInboundClaims |
Získá nebo nastaví MapInboundClaims vlastnost výchozí instance JwtSecurityTokenHandler v SecurityTokenValidators, která se používá při určování, zda mapovat typy deklarací identity, které jsou extrahovány při ověřování JwtSecurityToken. Pokud je tato hodnota nastavená na hodnotu true, typ deklarace identity se po překladu pomocí tohoto mapování nastaví na název deklarace IDENTITY JSON. 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í čas mezi načteními, v případě, že načtení selhalo nebo že byla aktualizace explicitně požadována. |
| RefreshOnIssuerKeyNotFound |
Získá nebo nastaví, pokud se má aktualizace metadat pokusit securityTokenSignatureKeyNotFoundException. To umožňuje automatické obnovení v případě vrácení klíče podpisu. Tato možnost je ve výchozím nastavení zapnutá. |
| RequireHttpsMetadata |
Získá nebo nastaví, pokud je pro adresu nebo autoritu metadat vyžadován protokol HTTPS. Výchozí hodnota je true. Tato možnost by měla být zakázána pouze ve vývojových prostředích. |
| SaveToken |
Definuje, jestli má být nosný token uložen v AuthenticationProperties po úspěšné autorizaci. |
| SecurityTokenValidators |
Získá seřazený ISecurityTokenValidator seznam použitý k ověření přístupových tokenů. |
| TokenValidationParameters |
Získá nebo nastaví parametry použité k ověření tokenů identity. |
Metody
| Validate() |
Zkontrolujte, jestli jsou možnosti platné. Pokud nejsou věci v pořádku, měla 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) |