Partager via


OpenIdConnectOptions Classe

Définition

Options de configuration pour OpenIdConnectMiddleware

public ref class OpenIdConnectOptions : Microsoft::AspNetCore::Builder::RemoteAuthenticationOptions
public class OpenIdConnectOptions : Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions
type OpenIdConnectOptions = class
    inherit RemoteAuthenticationOptions
Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions
Héritage

Constructeurs

OpenIdConnectOptions()

Initialise un nouveau OpenIdConnectOptions

OpenIdConnectOptions(String)

Initialise un nouveau OpenIdConnectOptions

Propriétés

AuthenticationMethod

Obtient ou définit la méthode utilisée pour rediriger l’agent utilisateur vers le fournisseur d’identité.

AuthenticationScheme

AuthenticationScheme dans les options correspond au nom logique d’un schéma d’authentification particulier. Une valeur différente peut être attribuée afin d'utiliser le même type d'intergiciel (middleware) d'authentification plus d'une fois dans un pipeline.

(Hérité de AuthenticationOptions)
Authority

Obtient ou définit l'autorité à utiliser lors des appels OpenIdConnect.

AutomaticAuthenticate

Si la valeur est true, l’intergiciel d’authentification modifie l’utilisateur de demande entrant. Si la valeur est false, l’intergiciel d’authentification fournit l’identité uniquement lorsqu’il est explicitement indiqué par authenticationScheme.

(Hérité de AuthenticationOptions)
AutomaticChallenge

Si la valeur est true, l’intergiciel d’authentification doit gérer la demande automatique. Si la valeur est false, l’intergiciel d’authentification modifie les réponses uniquement lorsqu’il est explicitement indiqué par authenticationScheme.

(Hérité de AuthenticationOptions)
BackchannelHttpHandler

HttpMessageHandler utilisé pour communiquer avec le fournisseur d’identité distant. Ce paramètre ne peut pas être défini en même temps que BackchannelCertificateValidator, sauf si la valeur peut être convertie en WebRequestHandler.

(Hérité de RemoteAuthenticationOptions)
BackchannelTimeout

Obtient ou définit la valeur de délai d’expiration en millisecondes pour les communications de canal back-end avec le fournisseur d’identité distant.

(Hérité de RemoteAuthenticationOptions)
CallbackPath

Chemin d'accès à la demande au sein du chemin d'accès de base de l'application où l'agent utilisateur est renvoyé. L'intergiciel (middleware) traitera cette demande à son arrivée.

(Hérité de RemoteAuthenticationOptions)
ClaimsIssuer

Obtient ou définit l’émetteur qui doit être utilisé pour toutes les revendications créées

(Hérité de AuthenticationOptions)
ClientId

Obtient ou définit le « client_id ».

ClientSecret

Obtient ou définit le « client_secret ».

Configuration

Configuration fournie directement par le développeur. Si elle est fournie, les propriétés MetadataAddress et Backchannel ne seront pas utilisées. Ces informations ne doivent pas être mises à jour pendant le traitement de la demande.

ConfigurationManager

En charge de l'extraction, de la mise en cache et de l'actualisation de la configuration à partir des métadonnées. En l'absence de spécification, création à l'aide des propriétés MetadataAddress et Backchannel.

Description

Informations supplémentaires sur le type d'authentification qui est mis à la disposition de l'application.

(Hérité de AuthenticationOptions)
DisplayName

Obtient ou définit le texte que l'utilisateur peut afficher sur une interface utilisateur de connexion.

(Hérité de RemoteAuthenticationOptions)
Events

Obtient ou définit le IOpenIdConnectEvents à notifier lors du traitement des messages OpenIdConnect.

GetClaimsFromUserInfoEndpoint

Boolean pour définir si le middleware doit accéder au point de terminaison d’informations utilisateur pour récupérer des revendications supplémentaires ou non après avoir créé une identité à partir de id_token reçu du point de terminaison de jeton. La valeur par défaut est « false ».

MetadataAddress

Obtient ou définit le point de terminaison de découverte pour l'obtention des métadonnées

PostLogoutRedirectUri

URI vers lequel l’agent utilisateur sera retourné une fois l’application déconnectée du fournisseur d’identité. La redirection se produit après l’appel de SignedOutCallbackPath.

ProtocolValidator

Obtient ou définit le OpenIdConnectProtocolValidator qui est utilisé pour s’assurer que le « id_token » reçu est valide par : http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation

RefreshOnIssuerKeyNotFound

Obtient ou définit si une actualisation des métadonnées doit être tentée après une exception SecurityTokenSignatureKeyNotFoundException. Cela permet la récupération automatique en cas d'une substitution de clé de signature. Cette option est activée par défaut.

RemoteAuthenticationTimeout

Obtient ou définit la limite de temps pour terminer le flux d’authentification (15 minutes par défaut).

(Hérité de RemoteAuthenticationOptions)
RemoteSignOutPath

Les demandes reçues sur ce chemin d’accès entraînent l’appel de l’intergiciel SignOut à l’aide de SignInScheme.

RequireHttpsMetadata

Obtient ou définit si HTTPS est requis pour l’adresse ou l’autorité de métadonnées. La valeur par défaut est true. Cette option doit être désactivée uniquement dans les environnements de développement.

Resource

Obtient ou définit le paramètre « resource ».

ResponseMode

Obtient ou définit le « response_mode ».

ResponseType

Obtient ou définit le paramètre « response_type ».

SaveTokens

Définit si les jetons d’accès et d’actualisation doivent être stockés dans après AuthenticationProperties une autorisation réussie. Cette propriété est définie false sur par défaut pour réduire la taille du cookie d’authentification final.

(Hérité de RemoteAuthenticationOptions)
Scope

Obtient la liste des autorisations à demander.

SecurityTokenValidator

Obtient ou définit le ISecurityTokenValidator utilisé pour valider les jetons d’identité.

SignedOutCallbackPath

Chemin de la requête dans le chemin de base de l’application où l’agent utilisateur sera retourné après déconnexion du fournisseur d’identité.

SignInScheme

Obtient ou définit le schéma d’authentification correspondant au middleware responsable de la persistance de l’identité de l’utilisateur après une authentification réussie. Cette valeur correspond généralement à un intergiciel de cookie inscrit dans la classe Startup. En cas d’omission, SignInScheme est utilisé comme valeur de secours.

(Hérité de RemoteAuthenticationOptions)
SignOutScheme

Schéma d’authentification à utiliser avec SignOut sur SignOutPath. SignInScheme sera utilisé si ce n’est pas défini.

SkipUnrecognizedRequests

Indique si les demandes adressées à CallbackPath peuvent également concerner d’autres composants. S’il est activé, l’intergiciel transmet les demandes qui ne contiennent pas de réponses d’authentification OpenIdConnect. La désactivation de ce paramètre et la définition de CallbackPath sur un point de terminaison dédié peuvent améliorer la gestion des erreurs. Elle est désactivée par défaut.

StateDataFormat

Obtient ou définit le type servant à sécuriser les données traitées par l'intergiciel (middleware).

StringDataFormat

Obtient ou définit le type utilisé pour sécuriser les chaînes utilisées par l’intergiciel.

SystemClock

For testing purposes only.

SystemClock

For testing purposes only.

(Hérité de AuthenticationOptions)
TokenValidationParameters

Obtient ou définit les paramètres utilisés pour valider les jetons d’identité.

UseTokenLifetime

Indique que la durée de vie de la session d’authentification (par exemple, les cookies) doit correspondre à celle du jeton d’authentification. Si le jeton ne fournit pas les informations de durée de vie, la durée de vie d'une session normale sera utilisée. Elle est désactivée par défaut.

S’applique à