JwtBearerOptions Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
La classe Options fournit les informations nécessaires pour contrôler le comportement du gestionnaire d’authentification du porteur
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
- Héritage
Constructeurs
JwtBearerOptions() |
Initialise une nouvelle instance de JwtBearerOptions. |
Propriétés
Audience |
Obtient ou définit une seule valeur d’audience valide pour tout jeton OpenIdConnect reçu. Cette valeur est passée dans TokenValidationParameters.ValidAudience si cette propriété est vide. |
Authority |
Obtient ou définit l'autorité à utiliser lors des appels OpenIdConnect. |
AutomaticRefreshInterval |
Obtient ou définit la fréquence à laquelle une actualisation automatique des métadonnées doit se produire. |
Backchannel |
Backchannel utilisé pour récupérer les métadonnées. |
BackchannelHttpHandler |
HttpMessageHandler utilisé pour extraire les métadonnées. Ce paramètre ne peut pas être défini en même temps que BackchannelCertificateValidator, sauf si la valeur est un WebRequestHandler. |
BackchannelTimeout |
Obtient ou définit le délai d'attente lors de l'utilisation du backchannel pour effectuer un appel http. |
Challenge |
Obtient ou définit le défi à placer dans l’en-tête « WWW-Authenticate ». |
ClaimsIssuer |
Obtient ou définit l’émetteur qui doit être utilisé pour toutes les revendications créées (Hérité de AuthenticationSchemeOptions) |
Configuration |
Configuration fournie directement par le développeur. Si elle est fournie, les propriétés MetadataAddress et Backchannel ne seront pas utilisées. Ces informations ne doivent pas être mises à jour pendant le traitement de la demande. |
ConfigurationManager |
En charge de l'extraction, de la mise en cache et de l'actualisation de la configuration à partir des métadonnées. En l'absence de spécification, création à l'aide des propriétés MetadataAddress et Backchannel. |
Events |
Objet fourni par l’application pour traiter les événements déclenchés par le gestionnaire d’authentification du porteur. L’application peut implémenter entièrement l’interface, ou créer un instance de JwtBearerEvents et affecter des délégués uniquement aux événements qu’elle souhaite traiter. |
EventsType |
S’il est défini, sera utilisé comme type de service pour obtenir les instance d’événements au lieu de la propriété . (Hérité de AuthenticationSchemeOptions) |
ForwardAuthenticate |
Si cette option est définie, elle spécifie le schéma cible auquel ce schéma doit transférer les appels AuthenticateAsync. Par exemple Context.AuthenticateAsync(« ThisScheme ») => Context.AuthenticateAsync(« ForwardAuthenticateValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal. (Hérité de AuthenticationSchemeOptions) |
ForwardChallenge |
Si cette option est définie, elle spécifie le schéma cible auquel ce schéma doit transférer les appels ChallengeAsync. Par exemple Context.ChallengeAsync(« ThisScheme ») => Context.ChallengeAsync(« ForwardChallengeValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal. (Hérité de AuthenticationSchemeOptions) |
ForwardDefault |
Si cette option est définie, elle spécifie un schéma par défaut auquel les gestionnaires d’authentification doivent transférer toutes les opérations d’authentification par défaut. La logique de transfert par défaut case activée d’abord le paramètre ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut le plus spécifique, suivi de ForwardDefaultSelector, puis de ForwardDefault. Le premier résultat non null sera utilisé comme schéma cible à transférer. (Hérité de AuthenticationSchemeOptions) |
ForwardDefaultSelector |
Permet de sélectionner un schéma par défaut pour la demande actuelle à laquelle les gestionnaires d’authentification doivent transférer toutes les opérations d’authentification par défaut. La logique de transfert par défaut case activée d’abord le paramètre ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut le plus spécifique, suivi de ForwardDefaultSelector, puis de ForwardDefault. Le premier résultat non null sera utilisé comme schéma cible à transférer. (Hérité de AuthenticationSchemeOptions) |
ForwardForbid |
Si cette option est définie, elle spécifie le schéma cible auquel ce schéma doit transférer les appels ForbidAsync. Par exemple Context.ForbidAsync(« ThisScheme ») => Context.ForbidAsync(« ForwardForbidValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal. (Hérité de AuthenticationSchemeOptions) |
ForwardSignIn |
S’il est défini, spécifie le schéma cible auquel ce schéma doit transférer les appels SignInAsync. Par exemple Context.SignInAsync(« ThisScheme ») => Context.SignInAsync(« ForwardSignInValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal. (Hérité de AuthenticationSchemeOptions) |
ForwardSignOut |
Si cette option est définie, elle spécifie le schéma cible auquel ce schéma doit transférer les appels SignOutAsync. Par exemple Context.SignOutAsync(« ThisScheme ») => Context.SignOutAsync(« ForwardSignOutValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal. (Hérité de AuthenticationSchemeOptions) |
IncludeErrorDetails |
Définit si les erreurs de validation de jeton doivent être retournées à l’appelant. Activée par défaut, cette option peut être désactivée pour empêcher le gestionnaire JWT de retourner une erreur et une error_description dans l’en-tête WWW-Authenticate. |
MapInboundClaims |
Obtient ou définit la MapInboundClaims propriété sur la instance par défaut de JwtSecurityTokenHandler dans SecurityTokenValidators ou JsonWebTokenHandler dans TokenHandlers, qui est utilisée pour déterminer si les types de revendications qui sont extraits lors de la validation d’un JwtSecurityToken ou d’un JsonWebToken. Si cette valeur est définie sur true, le type de revendication est défini sur la revendication JSON « name » après la traduction à l’aide de ce mappage. Sinon, aucun mappage ne se produit. La valeur par défaut est true. |
MetadataAddress |
Obtient ou définit le point de terminaison de découverte pour l'obtention des métadonnées |
RefreshInterval |
Obtient ou définit la durée minimale entre les récupérations, en cas d’échec d’une récupération ou d’une actualisation explicitement demandée. |
RefreshOnIssuerKeyNotFound |
Obtient ou définit si une actualisation des métadonnées doit être tentée après une exception SecurityTokenSignatureKeyNotFoundException. Cela permet la récupération automatique en cas d'une substitution de clé de signature. Cette option est activée par défaut. |
RequireHttpsMetadata |
Obtient ou définit si HTTPS est requis pour l’adresse ou l’autorité de métadonnées. La valeur par défaut est true. Cette option doit être désactivée uniquement dans les environnements de développement. |
SaveToken |
Définit si le jeton du porteur doit être stocké dans après AuthenticationProperties une autorisation réussie. |
SecurityTokenValidators |
Obsolète.
Obtient la liste triée des ISecurityTokenValidator éléments utilisés pour valider les jetons d’accès. |
TimeProvider |
Utilisé pour les tests. (Hérité de AuthenticationSchemeOptions) |
TokenHandlers |
Obtient la liste triée des TokenHandler éléments utilisés pour valider les jetons d’accès. |
TokenValidationParameters |
Obtient ou définit les paramètres utilisés pour valider les jetons d’identité. |
UseSecurityTokenValidators |
Obtient ou définit si TokenHandlers ou SecurityTokenValidators sera utilisé pour valider le jeton entrant. |
Méthodes
Validate() |
Vérifiez que les options sont valides. Doit lever une exception si les choses ne sont pas correctes. (Hérité de AuthenticationSchemeOptions) |
Validate(String) |
Vérifie que les options sont valides pour un schéma spécifique (Hérité de AuthenticationSchemeOptions) |