OpenIdConnectOptions Clase

Definición

Espacio de nombres:

Microsoft.AspNetCore.Authentication.OpenIdConnect

Ensamblado:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Paquete:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

Source:

OpenIdConnectOptions.cs

Opciones de configuración 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

Herencia

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OpenIdConnectOptions

Constructores

OpenIdConnectOptions()

Inicializa un nuevo OpenIdConnectOptions

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 remota devuelve una respuesta access_denied. (Heredado de RemoteAuthenticationOptions)
AuthenticationMethod	Obtiene o establece el método utilizado para redirigir el agente de usuario al proveedor de identidades.
Authority	Obtiene o establece la entidad que se va a usar al realizar llamadas a OpenIdConnect.
AutomaticRefreshInterval	Obtiene o establece la frecuencia con la que debe producirse una actualización automática de metadatos.
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. No se puede establecer al mismo tiempo que BackchannelCertificateValidator a menos que el valor se pueda reducir a 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	Ruta de acceso de solicitud dentro de la ruta de acceso base de la aplicación donde 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 "client_id".
ClientSecret	Obtiene o establece el "client_secret".
Configuration	Configuración proporcionada directamente por el desarrollador. Si se proporciona, las propiedades MetadataAddress y Backchannel no se usarán. Esta información no se debe actualizar durante el procesamiento de solicitudes.
ConfigurationManager	Responsable de recuperar, almacenar en caché y actualizar la configuración de los metadatos. Si no se proporciona, se creará uno con las propiedades MetadataAddress y Backchannel.
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)
DisableTelemetry	Indica si se debe deshabilitar la telemetría. Cuando esta característica está habilitada, la versión de ensamblado de los paquetes de Microsoft IdentityModel se envía al proveedor remoto de OpenID Connect como parámetro de solicitud de autorización o cierre de sesión.
Events	Obtiene o establece el OpenIdConnectEvents que se va a notificar al procesar mensajes de OpenIdConnect.
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 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 debe reenviar las 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 más específica forwardAuthenticate/Challenge/Allow/SignIn/SignOut, seguida de la comprobación de ForwardDefaultSelector, seguida de ForwardDefault. El primer resultado distinto de NULL se usará como esquema de destino al que se va a 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 más específica forwardAuthenticate/Challenge/Allow/SignIn/SignOut, seguida de la comprobación de ForwardDefaultSelector, seguida de ForwardDefault. El primer resultado distinto de NULL se usará como esquema de destino al que se va a reenviar. (Heredado de AuthenticationSchemeOptions)
ForwardForbid	Si se establece, especifica el esquema de destino al que este esquema debe reenviar las llamadas a 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 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 llamadas 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)
GetClaimsFromUserInfoEndpoint	Boolean para establecer si el controlador debe ir al punto de conexión de información de usuario para recuperar notificaciones adicionales o no después de crear una identidad a partir de id_token recibido del punto de conexión del token. El valor predeterminado es "false".
MapInboundClaims	Obtiene o establece la propiedad MapInboundClaims en la instancia predeterminada de JwtSecurityTokenHandler en SecurityTokenValidator y la instancia predeterminada de JsonWebTokenHandler en TokenHandler, que se usa al determinar si se van a asignar o no tipos de notificación que se extraen al validar un JwtSecurityToken. 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.
MaxAge	Obtiene o establece el "max_age". Si establece el parámetro "max_age" se enviará con la solicitud de autenticación. Si el proveedor de identidades no ha autenticado activamente al usuario durante el período de tiempo especificado, se le pedirá que vuelva a autenticarse. De forma predeterminada, no se especifica ningún max_age.
MetadataAddress	Obtiene o establece el punto de conexión de detección para obtener metadatos.
NonceCookie	Determina la configuración utilizada para crear la cookie nonce antes de que la cookie se agregue a la respuesta.
Prompt	Obtiene o establece el "prompt".
ProtocolValidator	Obtiene o establece el OpenIdConnectProtocolValidator que se usa para asegurarse de que la "id_token" recibida es válida por: http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
RefreshInterval	Obtiene o establece el tiempo mínimo entre las recuperaciones, en caso de que se produzca un error en la recuperación o que se haya solicitado explícitamente una actualización.
RefreshOnIssuerKeyNotFound	Obtiene o establece si se debe intentar una actualización de metadatos después de una excepción SecurityTokenSignatureKeyNotFoundException. Esto permite la recuperación automática en caso de sustitución de claves de firma. Esto está habilitado de forma predeterminada.
RemoteAuthenticationTimeout	Obtiene o establece el límite de tiempo para completar el flujo de autenticación (15 minutos de forma predeterminada). (Heredado de RemoteAuthenticationOptions)
RemoteSignOutPath	Las solicitudes recibidas en esta ruta de acceso harán que el controlador invoque SignOut mediante SignOutScheme.
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.
Resource	Obtiene o establece el "recurso".
ResponseMode	Obtiene o establece el "response_mode".
ResponseType	Obtiene o establece el "response_type".
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 se especifica explícitamente el AccessDeniedPath. (Heredado de RemoteAuthenticationOptions)
SaveTokens	Define si los tokens de acceso y actualización deben almacenarse en el AuthenticationProperties después de una autorización correcta. Esta propiedad se establece en false de forma predeterminada para reducir el tamaño de la cookie de autenticación final. (Heredado de RemoteAuthenticationOptions)
Scope	Obtiene la lista de permisos que se van a solicitar.
SecurityTokenValidator	Obsoletos. Obtiene o establece el ISecurityTokenValidator usado para validar los tokens de identidad.
SignedOutCallbackPath	Ruta de acceso de solicitud dentro de la ruta de acceso base de la aplicación donde se devolverá el agente de usuario después de cerrar la sesión del proveedor de identidades. Consulte post_logout_redirect_uri de http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout.
SignedOutRedirectUri	El URI al que se redirigirá el agente de usuario después de que la aplicación se cierre la sesión del proveedor de identidades. La redirección se producirá después de invocar SignedOutCallbackPath.
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)
SignOutScheme	Esquema de autenticación que se va a usar con SignOut en SignOutPath. SignInScheme se usará si no se establece.
SkipUnrecognizedRequests	Indica si las solicitudes a CallbackPath también pueden ser para otros componentes. Si está habilitado, el controlador pasará solicitudes a través de las que no contengan respuestas de autenticación de OpenIdConnect. Deshabilitar esto y establecer CallbackPath en un punto de conexión dedicado puede proporcionar un mejor control de errores. Esto está deshabilitado de forma predeterminada.
StateDataFormat	Obtiene o establece el tipo utilizado para proteger los datos administrados por el controlador.
StringDataFormat	Obtiene o establece el tipo utilizado para proteger las cadenas usadas por el controlador.
TimeProvider	Se usa para las pruebas. (Heredado de AuthenticationSchemeOptions)
TokenHandler	Obtiene o establece el TokenHandler usado para validar los tokens de identidad. Se usará en lugar de SecurityTokenValidator si UseSecurityTokenValidator es false.
TokenValidationParameters	Obtiene o establece los parámetros usados para validar los tokens de identidad.
UsePkce	Habilita o deshabilita el uso del estándar Proof Key for Code Exchange (PKCE). Esto solo se aplica cuando el ResponseType está establecido en Code. Consulte https://tools.ietf.org/html/rfc7636. El valor predeterminado es true.
UseSecurityTokenValidator	Obtiene o establece si se va a usar el TokenHandler o el SecurityTokenValidator para validar los tokens de identidad.
UseTokenLifetime	Indica que la duración de la sesión de autenticación (por ejemplo, cookies) debe coincidir con la del token de autenticación. Si el token no proporciona información de duración, se usarán las duraciones de sesión normales. Esto está deshabilitado de forma predeterminada.

Métodos

Validate()	Compruebe que las opciones son válidas. Debe producir una excepción si las cosas no son correctas.
Validate(String)	Comprueba que las opciones son válidas para un esquema específico (Heredado de RemoteAuthenticationOptions)