JwtBearerOptions Clase
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
La clase Options proporciona información necesaria para controlar el comportamiento del controlador de autenticación de portador.
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
- Herencia
Constructores
JwtBearerOptions() |
Inicializa una nueva instancia de la clase JwtBearerOptions. |
Propiedades
Audience |
Obtiene o establece un único valor de audiencia válido para cualquier token de OpenIdConnect recibido. Este valor se pasa a TokenValidationParameters.ValidAudience si esa propiedad está vacía. |
Authority |
Obtiene o establece el valor de Authority que se va a usar al realizar llamadas de OpenIdConnect. |
AutomaticRefreshInterval |
Obtiene o establece la frecuencia con la que se debe producir una actualización automática de metadatos. |
Backchannel |
Backchannel usado para recuperar metadatos. |
BackchannelHttpHandler |
HttpMessageHandler que se usa para recuperar metadatos. Esto no puede establecerse al mismo tiempo que el objeto BackchannelCertificateValidator a menos que el valor sea un objeto WebRequestHandler. |
BackchannelTimeout |
Obtiene o establece el tiempo de espera cuando se usa el canal secundario para realizar una llamada HTTP. |
Challenge |
Obtiene o establece el desafío que se va a colocar en el encabezado "WWW-Authenticate". |
ClaimsIssuer |
Obtiene o establece el emisor que se debe usar para las notificaciones que se crean. (Heredado de AuthenticationSchemeOptions) |
Configuration |
Configuración proporcionada directamente por el desarrollador. Si se proporciona, las propiedades MetadataAddress y Backchannel no se usan. Esta información no se debe actualizar durante el procesamiento de la solicitud. |
ConfigurationManager |
Responsable de recuperar, almacenar en caché y actualizar la configuración de los metadatos. Si no se proporciona, se creará una mediante las propiedades MetadataAddress y Backchannel. |
Events |
Objeto proporcionado por la aplicación para procesar eventos generados por el controlador de autenticación de portador. La aplicación puede implementar la interfaz por completo o puede crear una instancia de JwtBearerEvents y asignar delegados solo a los eventos que desea procesar. |
EventsType |
Si se establece, se usará como tipo de servicio para obtener la instancia de Eventos en lugar de la propiedad . (Heredado de AuthenticationSchemeOptions) |
ForwardAuthenticate |
Si se establece, especifica el esquema de destino al que este esquema debe reenviar las llamadas a AuthenticateAsync. Por ejemplo, Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Establezca el destino en el esquema actual para deshabilitar el reenvío y permitir el procesamiento normal. (Heredado de AuthenticationSchemeOptions) |
ForwardChallenge |
Si se establece, especifica el esquema de destino al que este esquema debe reenviar llamadas ChallengeAsync. Por ejemplo, Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Establezca el destino en el esquema actual para deshabilitar el reenvío y permitir el procesamiento normal. (Heredado de AuthenticationSchemeOptions) |
ForwardDefault |
Si se establece, especifica un esquema predeterminado al que los controladores de autenticación deben reenviar todas las operaciones de autenticación a de forma predeterminada. La lógica de reenvío predeterminada comprobará primero la configuración forwardAuthenticate/Challenge/Allow/SignIn/SignOut más específica, seguida de comprobar forwardDefaultSelector, seguida de ForwardDefault. El primer resultado distinto de NULL se usará como esquema de destino al que reenviar. (Heredado de AuthenticationSchemeOptions) |
ForwardDefaultSelector |
Se usa para seleccionar un esquema predeterminado para la solicitud actual a la que los controladores de autenticación deben reenviar todas las operaciones de autenticación a de forma predeterminada. La lógica de reenvío predeterminada comprobará primero la configuración forwardAuthenticate/Challenge/Allow/SignIn/SignOut más específica, seguida de comprobar forwardDefaultSelector, seguida de ForwardDefault. El primer resultado distinto de NULL se usará como esquema de destino al que reenviar. (Heredado de AuthenticationSchemeOptions) |
ForwardForbid |
Si se establece, especifica el esquema de destino al que este esquema debe reenviar las llamadas de ProhibidoAsync. Por ejemplo, Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Establezca el destino en el esquema actual para deshabilitar el reenvío y permitir el procesamiento normal. (Heredado de AuthenticationSchemeOptions) |
ForwardSignIn |
Si se establece, especifica el esquema de destino al que este esquema debe reenviar las llamadas a SignInAsync. Por ejemplo, Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Establezca el destino en el esquema actual para deshabilitar el reenvío y permitir el procesamiento normal. (Heredado de AuthenticationSchemeOptions) |
ForwardSignOut |
Si se establece, especifica el esquema de destino al que este esquema debe reenviar las llamadas a SignOutAsync. Por ejemplo, Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Establezca el destino en el esquema actual para deshabilitar el reenvío y permitir el procesamiento normal. (Heredado de AuthenticationSchemeOptions) |
IncludeErrorDetails |
Define si los errores de validación de tokens deben devolverse al autor de la llamada. Esta opción se puede deshabilitar de forma predeterminada para evitar que el controlador JWT devuelva un error y un error_description en el encabezado WWW-Authenticate. |
MapInboundClaims |
Obtiene o establece la MapInboundClaims propiedad en la instancia predeterminada de JwtSecurityTokenHandler en SecurityTokenValidators, o JsonWebTokenHandler en TokenHandlers, que se usa al determinar si se asignan o no tipos de notificación que se extraen al validar o JwtSecurityToken .JsonWebToken Si se establece en true, el tipo de notificación se establece en la notificación JSON "name" después de traducir mediante esta asignación. De lo contrario, no se produce ninguna asignación. El valor predeterminado es true. |
MetadataAddress |
Obtiene o establece el extremo de detección para obtener metadatos |
RefreshInterval |
Obtiene o establece el tiempo mínimo entre las recuperaciones, en caso de error de recuperación o de que se solicitó explícitamente una actualización. |
RefreshOnIssuerKeyNotFound |
Obtiene o establece si se deben actualizar los metadatos después de una SecurityTokenSignatureKeyNotFoundException. Esto permite una recuperación automática en caso de que se sustituyan las claves de firma. Esta opción está habilitada de manera predeterminada. |
RequireHttpsMetadata |
Obtiene o establece si se requiere HTTPS para la dirección o autoridad de metadatos. El valor predeterminado es true. Esto solo debe deshabilitarse en entornos de desarrollo. |
SaveToken |
Define si el token de portador debe almacenarse en AuthenticationProperties después de una autorización correcta. |
SecurityTokenValidators |
Obsoletos.
Obtiene la lista ordenada de usada para validar los tokens de ISecurityTokenValidator acceso. |
TimeProvider |
Se usa para las pruebas. (Heredado de AuthenticationSchemeOptions) |
TokenHandlers |
Obtiene la lista ordenada de usada para validar los tokens de TokenHandler acceso. |
TokenValidationParameters |
Obtiene o establece los parámetros usados para validar los tokens de identidad. |
UseSecurityTokenValidators |
Obtiene o establece si TokenHandlers se usará o SecurityTokenValidators para validar el token de entrada. |
Métodos
Validate() |
Compruebe que las opciones son válidas. Debe producir una excepción si las cosas no están bien. (Heredado de AuthenticationSchemeOptions) |
Validate(String) |
Comprueba que las opciones son válidas para un esquema específico. (Heredado de AuthenticationSchemeOptions) |