OpenIdConnectOptions Clase

Referencia

Definición

Espacio de nombres:: Microsoft.AspNetCore.Authentication.OpenIdConnect

Ensamblado:: Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Paquete:: Microsoft.AspNetCore.Authentication.OpenIdConnect v2.0.0

Paquete:: Microsoft.AspNetCore.Authentication.OpenIdConnect v2.1.0

Paquete:: Microsoft.AspNetCore.Authentication.OpenIdConnect v2.2.0

Paquete:: Microsoft.AspNetCore.Authentication.OpenIdConnect v3.0.3

Paquete:: Microsoft.AspNetCore.Authentication.OpenIdConnect v3.1.18

Paquete:: Microsoft.AspNetCore.Authentication.OpenIdConnect v5.0.9

Paquete:: Microsoft.AspNetCore.Authentication.OpenIdConnect v6.0.6

Paquete:: Microsoft.AspNetCore.Authentication.OpenIdConnect v7.0.0-preview.5.22303.8

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 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 objeto 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 remoto 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 el valor de Authority que se va a usar al realizar llamadas de 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. 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 valor de 'client_id'.
ClientSecret	Obtiene o establece el valor de 'client_secret'.
Configuration	Configuración proporcionada directamente por el desarrollador. Si se proporciona, las propiedades MetadataAddress y Backchannel no se usan. Esta información no se debe actualizar durante el procesamiento de la solicitud.
ConfigurationManager	Responsable de recuperar, almacenar en caché y actualizar la configuración de los metadatos. Si no se proporciona, se creará una mediante 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 del ensamblado de los paquetes de Microsoft IdentityModel se envía al proveedor de OpenID Connect remoto como parámetro de solicitud de autorización o cierre de sesión.
Events	Obtiene o establece el objeto que OpenIdConnectEvents 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 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)
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 MapInboundClaims propiedad en la instancia predeterminada de JwtSecurityTokenHandler en SecurityTokenValidator, que se usa al determinar si se asignan o no tipos de notificación que se extraen al validar .JwtSecurityToken Si se establece en true, el tipo de notificación se establece en la notificación JSON 'name' después de traducir con 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 dentro del 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 extremo 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 "símbolo del sistema".
ProtocolValidator	Obtiene o establece el OpenIdConnectProtocolValidator objeto que se usa para asegurarse de que el "id_token" recibido es válido 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 error de recuperación o de que se solicitó explícitamente una actualización.
RefreshOnIssuerKeyNotFound	Obtiene o establece si se deben actualizar los metadatos después de una SecurityTokenSignatureKeyNotFoundException. Esto permite una recuperación automática en caso de que se sustituyan las claves de firma. Esta opción está habilitada de manera 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 de metadatos o la autoridad. El valor predeterminado es true. Esto solo debe deshabilitarse en entornos de desarrollo.
Resource	Obtiene o establece el valor de 'resource'.
ResponseMode	Obtiene o establece el "response_mode".
ResponseType	Obtiene o establece el valor de '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 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 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	Obtiene o establece el ISecurityTokenValidator utilizado 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. El redireccionamiento 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á las solicitudes a través de las que no contengan respuestas de autenticación openIdConnect. Deshabilitar esta opción y establecer CallbackPath en un punto de conexión dedicado puede proporcionar un mejor control de errores. Esta opción está deshabilitada de manera 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.
TokenValidationParameters	Obtiene o establece los parámetros usados para validar los tokens de identidad.
UsePkce	Habilita o deshabilita el uso de la clave de prueba para el estándar de Intercambio de código (PKCE). Esto solo se aplica cuando se establece Codeen ResponseType . Vea https://tools.ietf.org/html/rfc7636. El valor predeterminado es `true`.
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 la información de duración, se usa la duración de sesión normal. Esta opción está deshabilitada de manera predeterminada.

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