OAuthOptions 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í.
Opciones de configuración de 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
- Herencia
- Derivado
Constructores
OAuthOptions() |
Inicializa una nueva instancia de la clase OAuthOptions. |
Propiedades
AccessDeniedPath |
Obtiene o establece la ruta de acceso opcional a la que se redirige el agente de usuario si el usuario no aprueba la demanda de autorización solicitada por el servidor remoto. Esta propiedad no se establece de forma predeterminada. En este caso, se produce una excepción si el servidor de autorización remoto devuelve una respuesta access_denied. (Heredado de RemoteAuthenticationOptions) |
AuthorizationEndpoint |
Obtiene o establece el URI donde se redirigirá al cliente para autenticarse. |
Backchannel |
Se usa para comunicarse con el proveedor de identidades remoto. (Heredado de RemoteAuthenticationOptions) |
BackchannelHttpHandler |
HttpMessageHandler se usa para comunicarse con el proveedor de identidades remoto. Esto no puede establecerse al mismo tiempo que el objeto BackchannelCertificateValidator a menos que el valor se pueda convertir a tipo heredado de un objeto WebRequestHandler. (Heredado de RemoteAuthenticationOptions) |
BackchannelTimeout |
Obtiene o establece el valor de tiempo de espera en milisegundos para las comunicaciones de canal back con el proveedor de identidades remoto. (Heredado de RemoteAuthenticationOptions) |
CallbackPath |
La ruta de acceso de la solicitud en la ruta de acceso base de la aplicación en la que se devolverá el agente de usuario. El middleware procesará esta solicitud cuando llegue. (Heredado de RemoteAuthenticationOptions) |
ClaimActions |
Colección de acciones de notificación usadas para seleccionar valores de los datos de usuario json y crear notificaciones. |
ClaimsIssuer |
Obtiene o establece el emisor que se debe usar para las notificaciones que se crean. (Heredado de AuthenticationSchemeOptions) |
ClientId |
Obtiene o establece el identificador de cliente asignado por el proveedor. |
ClientSecret |
Obtiene o establece el secreto de cliente asignado por el proveedor. |
CorrelationCookie |
Determina la configuración utilizada para crear la cookie de correlación antes de que la cookie se agregue a la respuesta. (Heredado de RemoteAuthenticationOptions) |
DataProtectionProvider |
Obtiene o establece el tipo utilizado para proteger los datos. (Heredado de RemoteAuthenticationOptions) |
Events |
Obtiene o establece el OAuthEvents objeto utilizado para controlar los eventos de autenticación. |
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) |
RemoteAuthenticationTimeout |
Obtiene o establece el límite de tiempo para completar el flujo de autenticación (15 minutos de forma predeterminada). (Heredado de RemoteAuthenticationOptions) |
ReturnUrlParameter |
Obtiene o establece el nombre del parámetro utilizado para transmitir la ubicación original del usuario antes de que se desencadene el desafío remoto hasta la página de acceso denegado. Esta propiedad solo se usa cuando AccessDeniedPath se especifica explícitamente . (Heredado de RemoteAuthenticationOptions) |
SaveTokens |
Define si los tokens de acceso y actualización deben almacenarse en AuthenticationProperties después de una autorización correcta.
Esta propiedad se establece |
Scope |
Obtiene la lista de permisos que se van a solicitar. |
SignInScheme |
Obtiene o establece el esquema de autenticación correspondiente al middleware responsable de conservar la identidad del usuario después de una autenticación correcta. Este valor normalmente corresponde a un middleware de cookies registrado en la clase Startup. Cuando se omite, DefaultSignInScheme se usa como valor de reserva. (Heredado de RemoteAuthenticationOptions) |
StateDataFormat |
Obtiene o establece el tipo que se usa para proteger los datos que controla el middleware. |
TimeProvider |
Se usa para las pruebas. (Heredado de AuthenticationSchemeOptions) |
TokenEndpoint |
Obtiene o establece el URI al que el middleware tendrá acceso para intercambiar el token de OAuth. |
UsePkce |
Habilita o deshabilita el uso del estándar Proof Key for Code Exchange (PKCE). Vea https://tools.ietf.org/html/rfc7636.
El valor predeterminado es |
UserInformationEndpoint |
Obtiene o establece el URI al que el middleware tendrá acceso para obtener la información del usuario. Este valor no se usa en la implementación predeterminada, es para su uso en implementaciones personalizadas de OnCreatingTicket. |
Métodos
Validate() |
Compruebe que las opciones son válidas. Debe producir una excepción si las cosas no están bien. |
Validate(String) |
Comprueba que las opciones son válidas para un esquema específico. (Heredado de RemoteAuthenticationOptions) |
Se aplica a
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de