Partilhar via


OpenIdConnectOptions Classe

Definição

Opções de configuração para OpenIdConnectHandler

public ref class OpenIdConnectOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptions
public class OpenIdConnectOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions
type OpenIdConnectOptions = class
    inherit RemoteAuthenticationOptions
Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions
Herança

Construtores

OpenIdConnectOptions()

Inicializa um novo OpenIdConnectOptions

Propriedades

AccessDeniedPath

Obtém ou define o caminho opcional para o qual o agente do usuário será redirecionado se o usuário não aprovar a demanda de autorização solicitada pelo servidor remoto. Essa propriedade não é definida por padrão. Nesse caso, uma exceção será gerada se uma resposta access_denied for retornada pelo servidor de autorização remota.

(Herdado de RemoteAuthenticationOptions)
AdditionalAuthorizationParameters

Obtém os parâmetros adicionais que serão incluídos na solicitação de autorização.

AuthenticationMethod

Obtém ou define o método usado para redirecionar o agente de usuário para o provedor de identidade.

Authority

Obtém ou define a Autoridade a ser usada ao fazer chamadas OpenIdConnect.

AutomaticRefreshInterval

Obtém ou define a frequência com que uma atualização automática de metadados deve ocorrer.

Backchannel

Usado para se comunicar com o provedor de identidade remoto.

(Herdado de RemoteAuthenticationOptions)
BackchannelHttpHandler

O HttpMessageHandler usado para se comunicar com o provedor de identidade remoto. Isso não pode ser definido ao mesmo tempo que BackchannelCertificateValidator, a menos que o valor possa ser reduzido para um WebRequestHandler.

(Herdado de RemoteAuthenticationOptions)
BackchannelTimeout

Obtém ou define o valor do tempo limite em milissegundos para comunicações de canal de fundo com o provedor de identidade remoto.

(Herdado de RemoteAuthenticationOptions)
CallbackPath

O caminho da solicitação dentro do caminho base do aplicativo em que o agente-usuário será retornado. O middleware processará essa solicitação quando ela chegar.

(Herdado de RemoteAuthenticationOptions)
ClaimActions

Uma coleção de ações de declaração usadas para selecionar valores dos dados do usuário json e criar Declarações.

ClaimsIssuer

Obtém ou define o emissor que deve ser usado para quaisquer declarações criadas

(Herdado de AuthenticationSchemeOptions)
ClientId

Obtém ou define o 'client_id'.

ClientSecret

Obtém ou define o 'client_secret'.

Configuration

Configuração fornecida diretamente pelo desenvolvedor. Se fornecido, as propriedades MetadataAddress e Backchannel não serão usadas. Essas informações não devem ser atualizadas durante o processamento da solicitação.

ConfigurationManager

Responsável por recuperar, armazenar em cache e atualizar a configuração de metadados. Se não for fornecido, um será criado usando as propriedades MetadataAddress e Backchannel.

CorrelationCookie

Determina as configurações usadas para criar o cookie de correlação antes que o cookie seja adicionado à resposta.

(Herdado de RemoteAuthenticationOptions)
DataProtectionProvider

Obtém ou define o tipo usado para proteger dados.

(Herdado de RemoteAuthenticationOptions)
DisableTelemetry

Indica se a telemetria deve ser desabilitada. Quando esse recurso está habilitado, a versão do assembly dos pacotes Do Microsoft IdentityModel é enviada para o provedor remoto do OpenID Connect como um parâmetro de solicitação de autorização/logout.

Events

Obtém ou define o OpenIdConnectEvents para notificar ao processar mensagens OpenIdConnect.

EventsType

Se definido, será usado como o tipo de serviço para obter a instância eventos em vez da propriedade.

(Herdado de AuthenticationSchemeOptions)
ForwardAuthenticate

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)
ForwardChallenge

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)
ForwardDefault

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 verificará primeiro a configuração forwardAuthenticate/Challenge/Forbid/SignIn/SignOut mais específica, seguida pela verificação do ForwardDefaultSelector, seguida por ForwardDefault. O primeiro resultado não nulo será usado como o esquema de destino para o qual encaminhar.

(Herdado de AuthenticationSchemeOptions)
ForwardDefaultSelector

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 verificará primeiro a configuração forwardAuthenticate/Challenge/Forbid/SignIn/SignOut mais específica, seguida pela verificação do ForwardDefaultSelector, seguida por ForwardDefault. O primeiro resultado não nulo será usado como o esquema de destino para o qual encaminhar.

(Herdado de AuthenticationSchemeOptions)
ForwardForbid

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)
ForwardSignIn

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)
ForwardSignOut

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)
GetClaimsFromUserInfoEndpoint

Booliano para definir se o manipulador deve ir para o ponto de extremidade de informações do usuário para recuperar declarações adicionais ou não depois de criar uma identidade de id_token recebido do ponto de extremidade do token. O padrão é 'false'.

MapInboundClaims

Obtém ou define a propriedade MapInboundClaims na instância padrão de JwtSecurityTokenHandler no SecurityTokenValidator e na instância padrão de JsonWebTokenHandler no TokenHandler, que é usada ao determinar se os tipos de declaração são extraídos ou não ao validar um JwtSecurityToken.

Se isso for definido como true, o Tipo de Declaração será definido como o 'nome' da declaração JSON depois de traduzir usando esse mapeamento. Caso contrário, nenhum mapeamento ocorrerá.

O valor padrão é true.

MaxAge

Obtém ou define o 'max_age'. Se definir o parâmetro 'max_age' será enviado com a solicitação de autenticação. Se o provedor de identidade não tiver autenticado ativamente o usuário dentro do período de tempo especificado, o usuário será solicitado a se autenticar novamente. Por padrão, nenhum max_age é especificado.

MetadataAddress

Obtém ou define o ponto de extremidade de descoberta para obter metadados

NonceCookie

Determina as configurações usadas para criar o cookie nonce antes que o cookie seja adicionado à resposta.

Prompt

Obtém ou define o 'prompt'.

ProtocolValidator

Obtém ou define o OpenIdConnectProtocolValidator usado para garantir que o 'id_token' recebido seja válido de acordo com: http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation

RefreshInterval

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.

RefreshOnIssuerKeyNotFound

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.

RemoteAuthenticationTimeout

Obtém ou define o limite de tempo para concluir o fluxo de autenticação (15 minutos por padrão).

(Herdado de RemoteAuthenticationOptions)
RemoteSignOutPath

As solicitações recebidas nesse caminho farão com que o manipulador invoque SignOut usando o SignOutScheme.

RequireHttpsMetadata

Obtém ou define se HTTPS é necessário para o endereço de metadados ou autoridade. O padrão é verdadeiro. Isso deve ser desabilitado apenas em ambientes de desenvolvimento.

Resource

Obtém ou define o 'recurso'.

ResponseMode

Obtém ou define o 'response_mode'.

ResponseType

Obtém ou define o 'response_type'.

ReturnUrlParameter

Obtém ou define o nome do parâmetro usado para transmitir o local original do usuário antes que o desafio remoto seja disparado até a página de acesso negado. Essa propriedade só é usada quando o AccessDeniedPath é especificado explicitamente.

(Herdado de RemoteAuthenticationOptions)
SaveTokens

Define se os tokens de acesso e atualização devem ser armazenados no AuthenticationProperties após uma autorização bem-sucedida. Essa propriedade é definida como false por padrão para reduzir o tamanho do cookie de autenticação final.

(Herdado de RemoteAuthenticationOptions)
Scope

Obtém a lista de permissões a serem solicitadas.

SecurityTokenValidator
Obsoleto.

Obtém ou define o ISecurityTokenValidator usado para validar tokens de identidade.

SignedOutCallbackPath

O caminho da solicitação dentro do caminho base do aplicativo em que o agente do usuário será retornado após sair do provedor de identidade. Veja post_logout_redirect_uri de http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout.

SignedOutRedirectUri

O uri para o qual o agente do usuário será redirecionado depois que o aplicativo for retirado do provedor de identidade. O redirecionamento ocorrerá depois que o SignedOutCallbackPath for invocado.

SignInScheme

Obtém ou define o esquema de autenticação correspondente ao middleware responsável por persistir a identidade do usuário após uma autenticação bem-sucedida. Esse valor normalmente corresponde a um middleware de cookie registrado na classe De inicialização. Quando omitido, DefaultSignInScheme é usado como um valor de fallback.

(Herdado de RemoteAuthenticationOptions)
SignOutScheme

O Esquema de Autenticação a ser usado com o SignOut no SignOutPath. SignInScheme será usado se isso não estiver definido.

SkipUnrecognizedRequests

Indica se as solicitações para o CallbackPath também podem ser para outros componentes. Se habilitado, o manipulador passará solicitações que não contêm respostas de autenticação OpenIdConnect. Desabilitar isso e definir o CallbackPath para um ponto de extremidade dedicado pode fornecer melhor tratamento de erros. Isso está desabilitado por padrão.

StateDataFormat

Obtém ou define o tipo usado para proteger os dados manipulados pelo manipulador.

StringDataFormat

Obtém ou define o tipo usado para proteger cadeias de caracteres usadas pelo manipulador.

TimeProvider

Usado para teste.

(Herdado de AuthenticationSchemeOptions)
TokenHandler

Obtém ou define o TokenHandler usado para validar tokens de identidade.

Isso será usado em vez de SecurityTokenValidator se UseSecurityTokenValidator for false.

TokenValidationParameters

Obtém ou define os parâmetros usados para validar tokens de identidade.

UsePkce

Habilita ou desabilita o uso da Chave de Prova para o padrão PKCE (Code Exchange). Isso só se aplica quando o ResponseType é definido como Code. Consulte https://tools.ietf.org/html/rfc7636. O valor padrão é true.

UseSecurityTokenValidator

Obtém ou define se deve usar o TokenHandler ou o SecurityTokenValidator para validar tokens de identidade.

UseTokenLifetime

Indica que o tempo de vida da sessão de autenticação (por exemplo, cookies) deve corresponder ao do token de autenticação. Se o token não fornecer informações de tempo de vida, os tempos de vida da sessão normal serão usados. Isso está desabilitado por padrão.

Métodos

Validate()

Verifique se as opções são válidas. Deve gerar uma exceção se as coisas não estiverem bem.

Validate(String)

Verifica se as opções são válidas para um esquema específico

(Herdado de RemoteAuthenticationOptions)

Aplica-se a