OAuthOptions Classe

Definição

Namespace:

Microsoft.AspNetCore.Authentication.OAuth

Assembly:

Microsoft.AspNetCore.Authentication.OAuth.dll

Pacote:

Microsoft.AspNetCore.App.Ref v9.0.0

Opções de configuração OAuth.

public ref class OAuthOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptions

public class OAuthOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

type OAuthOptions = class
    inherit RemoteAuthenticationOptions

Public Class OAuthOptions
Inherits RemoteAuthenticationOptions

Herança

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OAuthOptions

Derivado

Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions

Microsoft.AspNetCore.Authentication.Google.GoogleOptions

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftAccountOptions

Construtores

OAuthOptions()

Inicializa uma nova instância de OAuthOptions.

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.
AuthorizationEndpoint	Obtém ou define o URI em que o cliente será redirecionado para autenticação.
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 a ID do cliente atribuída pelo provedor.
ClientSecret	Obtém ou define o segredo do cliente atribuído pelo provedor.
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)
Events	Obtém ou define o OAuthEvents usado para lidar com eventos de autenticação.
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)
RemoteAuthenticationTimeout	Obtém ou define o limite de tempo para concluir o fluxo de autenticação (15 minutos por padrão). (Herdado de RemoteAuthenticationOptions)
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.
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)
StateDataFormat	Obtém ou define o tipo usado para proteger os dados manipulados pelo middleware.
TimeProvider	Usado para teste. (Herdado de AuthenticationSchemeOptions)
TokenEndpoint	Obtém ou define o URI que o middleware acessará para trocar o token OAuth.
UsePkce	Habilita ou desabilita o uso da Chave de Prova para o padrão PKCE (Code Exchange). Consulte https://tools.ietf.org/html/rfc7636. O valor padrão é false mas os manipuladores derivados devem habilitá-lo se o provedor oferecer suporte a ele.
UserInformationEndpoint	Obtém ou define o URI que o middleware acessará para obter as informações do usuário. Esse valor não é usado na implementação padrão, é para uso em implementações personalizadas de OnCreatingTicket.

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)