JwtBearerOptions Classe
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
A classe Options fornece informações necessárias para controlar o comportamento do manipulador de autenticação 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
- Herança
Jwt |
Inicializa uma nova instância de JwtBearerOptions. |
Audience |
Obtém ou define um único valor de audiência válido para qualquer token OpenIdConnect recebido. Esse valor será passado para TokenValidationParameters.ValidAudience se essa propriedade estiver vazia. |
Authority |
Obtém ou define a Autoridade a ser usada ao fazer chamadas OpenIdConnect. |
Automatic |
Obtém ou define a frequência com que uma atualização automática de metadados deve ocorrer. |
Backchannel |
O Backchannel usado para recuperar metadados. |
Backchannel |
O HttpMessageHandler usado para recuperar metadados. Ele não pode ser definido ao mesmo tempo que BackchannelCertificateValidator, a menos que o valor seja um WebRequestHandler. |
Backchannel |
Obtém ou define o tempo limite ao usar o backchannel para fazer uma chamada http. |
Challenge |
Obtém ou define o desafio a ser colocado no cabeçalho "WWW-Authenticate". |
Claims |
Obtém ou define o emissor que deve ser usado para quaisquer declarações criadas (Herdado de AuthenticationSchemeOptions) |
Configuration |
Configuração fornecida diretamente pelo desenvolvedor. Se fornecida, as propriedades MetadataAddress e Backchannel não serão usadas. Essas informações não devem ser atualizadas durante o processamento da solicitação. |
Configuration |
Responsável pela recuperação, armazenamento em cache e atualização da configuração a partir de metadados. Se não fornecido, então um será criado usando as propriedades MetadataAddress e Backchannel. |
Events |
O objeto fornecido pelo aplicativo para processar eventos gerados pelo manipulador de autenticação do portador. O aplicativo pode implementar a interface totalmente ou pode criar uma instância de JwtBearerEvents e atribuir delegados somente aos eventos que deseja processar. |
Events |
Se definido, será usado como o tipo de serviço para obter a instância eventos em vez da propriedade . (Herdado de AuthenticationSchemeOptions) |
Forward |
Se definido, isso especifica o esquema de destino para o qual esse esquema deve encaminhar chamadas AuthenticateAsync. Por exemplo, Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Defina o destino para o esquema atual para desabilitar o encaminhamento e permitir o processamento normal. (Herdado de AuthenticationSchemeOptions) |
Forward |
Se definido, isso especifica o esquema de destino para o qual esse esquema deve encaminhar chamadas ChallengeAsync. Por exemplo, Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Defina o destino para o esquema atual para desabilitar o encaminhamento e permitir o processamento normal. (Herdado de AuthenticationSchemeOptions) |
Forward |
Se definido, isso especifica um esquema padrão para o qual os manipuladores de autenticação devem encaminhar todas as operações de autenticação por padrão. A lógica de encaminhamento padrão marcar a configuração forwardAuthenticate/Challenge/Forbid/SignIn/SignOut mais específica primeiro, seguida pela verificação da configuração ForwardDefaultSelector, seguida por ForwardDefault. O primeiro resultado não nulo será usado como o esquema de destino para o qual encaminhar. (Herdado de AuthenticationSchemeOptions) |
Forward |
Usado para selecionar um esquema padrão para a solicitação atual para a qual os manipuladores de autenticação devem encaminhar todas as operações de autenticação por padrão. A lógica de encaminhamento padrão marcar a configuração forwardAuthenticate/Challenge/Forbid/SignIn/SignOut mais específica primeiro, seguida pela verificação da configuração ForwardDefaultSelector, seguida por ForwardDefault. O primeiro resultado não nulo será usado como o esquema de destino para o qual encaminhar. (Herdado de AuthenticationSchemeOptions) |
Forward |
Se definido, isso especifica o esquema de destino para o qual esse esquema deve encaminhar chamadas de ForbidAsync. Por exemplo, Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Defina o destino para o esquema atual para desabilitar o encaminhamento e permitir o processamento normal. (Herdado de AuthenticationSchemeOptions) |
Forward |
Se definido, isso especifica o esquema de destino para o qual esse esquema deve encaminhar chamadas SignInAsync. Por exemplo, Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Defina o destino para o esquema atual para desabilitar o encaminhamento e permitir o processamento normal. (Herdado de AuthenticationSchemeOptions) |
Forward |
Se definido, isso especifica o esquema de destino para o qual esse esquema deve encaminhar chamadas SignOutAsync. Por exemplo, Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Defina o destino para o esquema atual para desabilitar o encaminhamento e permitir o processamento normal. (Herdado de AuthenticationSchemeOptions) |
Include |
Define se os erros de validação de token devem ser retornados ao chamador. Habilitada por padrão, essa opção pode ser desabilitada para impedir que o manipulador JWT retorne um erro e um error_description no cabeçalho WWW-Authenticate. |
Map |
Obtém ou define a MapInboundClaims propriedade na instância padrão de JwtSecurityTokenHandler em SecurityTokenValidators ou JsonWebTokenHandler em TokenHandlers, que é usada ao determinar se os tipos de declaração são extraídos ou não ao validar um JwtSecurityToken ou um JsonWebToken. Se isso for definido como true, o Tipo de Declaração será definido como a declaração JSON 'name' depois de traduzir usando esse mapeamento. Caso contrário, nenhum mapeamento ocorrerá. O valor padrão é true. |
Metadata |
Obtém ou define o ponto de extremidade de descoberta para obtenção de metadados |
Refresh |
Obtém ou define o tempo mínimo entre as recuperações, caso uma recuperação tenha falhado ou que uma atualização tenha sido solicitada explicitamente. |
Refresh |
Obtém ou define se uma atualização de metadados deve ser tentada após uma SecurityTokenSignatureKeyNotFoundException. Isso permite a recuperação automática no caso de uma substituição de chave de assinatura. Isso é habilitado por padrão. |
Require |
Obtém ou define se HTTPS é necessário para o endereço de metadados ou autoridade. O padrão é true. Isso deve ser desabilitado somente em ambientes de desenvolvimento. |
Save |
Define se o token de portador deve ser armazenado no AuthenticationProperties após uma autorização bem-sucedida. |
Security |
Obsoleto.
Obtém a lista ordenada de ISecurityTokenValidator usada para validar tokens de acesso. |
Time |
Usado para teste. (Herdado de AuthenticationSchemeOptions) |
Token |
Obtém a lista ordenada de TokenHandler usada para validar tokens de acesso. |
Token |
Obtém ou define os parâmetros usados para validar tokens de identidade. |
Use |
Obtém ou define se TokenHandlers ou SecurityTokenValidators será usado para validar o token de entrada. |
Validate() |
Verifique se as opções são válidas. Deve gerar uma exceção se as coisas não estiverem bem. (Herdado de AuthenticationSchemeOptions) |
Validate(String) |
Verifica se as opções são válidas para um esquema específico (Herdado de AuthenticationSchemeOptions) |