OpenIdConnectOptions Classe

Définition

Espace de noms:

Microsoft.AspNetCore.Authentication.OpenIdConnect

Assembly:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Paquet:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

Source:

OpenIdConnectOptions.cs

Options de configuration pour 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

Héritage

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OpenIdConnectOptions

Constructeurs

OpenIdConnectOptions()

Initialise un nouveau OpenIdConnectOptions

Propriétés

AccessDeniedPath	Obtient ou définit le chemin d’accès facultatif vers lequel l’agent utilisateur est redirigé si l’utilisateur n’approuve pas la demande d’autorisation demandée par le serveur distant. Cette propriété n’est pas définie par défaut. Dans ce cas, une exception est levée si une réponse access_denied est retournée par le serveur d’autorisation distant. (Hérité de RemoteAuthenticationOptions)
AuthenticationMethod	Obtient ou définit la méthode utilisée pour rediriger l’agent utilisateur vers le fournisseur d’identité.
Authority	Obtient ou définit l'autorité à utiliser lors des appels OpenIdConnect.
AutomaticRefreshInterval	Obtient ou définit la fréquence à laquelle une actualisation automatique des métadonnées doit se produire.
Backchannel	Utilisé pour communiquer avec le fournisseur d’identité distant. (Hérité de RemoteAuthenticationOptions)
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)
ClaimActions	Collection d’actions de revendication utilisées pour sélectionner des valeurs à partir des données utilisateur json et créer des revendications.
ClaimsIssuer	Obtient ou définit l’émetteur qui doit être utilisé pour toutes les revendications créées (Hérité de AuthenticationSchemeOptions)
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.
CorrelationCookie	Détermine les paramètres utilisés pour créer le cookie de corrélation avant l’ajout du cookie à la réponse. (Hérité de RemoteAuthenticationOptions)
DataProtectionProvider	Obtient ou définit le type utilisé pour sécuriser les données. (Hérité de RemoteAuthenticationOptions)
DisableTelemetry	Indique si la télémétrie doit être désactivée. Lorsque cette fonctionnalité est activée, la version d’assembly des packages Microsoft IdentityModel est envoyée au fournisseur OpenID Connect distant en tant que paramètre de demande d’autorisation/déconnexion.
Events	Obtient ou définit le OpenIdConnectEvents à notifier lors du traitement des messages OpenIdConnect.
EventsType	S’il est défini, sera utilisé comme type de service pour obtenir les instance d’événements au lieu de la propriété . (Hérité de AuthenticationSchemeOptions)
ForwardAuthenticate	Si cette option est définie, elle spécifie le schéma cible auquel ce schéma doit transférer les appels AuthenticateAsync. Par exemple Context.AuthenticateAsync(« ThisScheme ») => Context.AuthenticateAsync(« ForwardAuthenticateValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal. (Hérité de AuthenticationSchemeOptions)
ForwardChallenge	Si cette option est définie, elle spécifie le schéma cible auquel ce schéma doit transférer les appels ChallengeAsync. Par exemple Context.ChallengeAsync(« ThisScheme ») => Context.ChallengeAsync(« ForwardChallengeValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal. (Hérité de AuthenticationSchemeOptions)
ForwardDefault	Si cette option est définie, elle spécifie un schéma par défaut auquel les gestionnaires d’authentification doivent transférer toutes les opérations d’authentification par défaut. La logique de transfert par défaut case activée d’abord le paramètre ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut le plus spécifique, suivi de ForwardDefaultSelector, puis de ForwardDefault. Le premier résultat non null sera utilisé comme schéma cible à transférer. (Hérité de AuthenticationSchemeOptions)
ForwardDefaultSelector	Permet de sélectionner un schéma par défaut pour la demande actuelle à laquelle les gestionnaires d’authentification doivent transférer toutes les opérations d’authentification par défaut. La logique de transfert par défaut case activée d’abord le paramètre ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut le plus spécifique, suivi de ForwardDefaultSelector, puis de ForwardDefault. Le premier résultat non null sera utilisé comme schéma cible à transférer. (Hérité de AuthenticationSchemeOptions)
ForwardForbid	Si cette option est définie, elle spécifie le schéma cible auquel ce schéma doit transférer les appels ForbidAsync. Par exemple Context.ForbidAsync(« ThisScheme ») => Context.ForbidAsync(« ForwardForbidValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal. (Hérité de AuthenticationSchemeOptions)
ForwardSignIn	S’il est défini, spécifie le schéma cible auquel ce schéma doit transférer les appels SignInAsync. Par exemple Context.SignInAsync(« ThisScheme ») => Context.SignInAsync(« ForwardSignInValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal. (Hérité de AuthenticationSchemeOptions)
ForwardSignOut	Si cette option est définie, elle spécifie le schéma cible auquel ce schéma doit transférer les appels SignOutAsync. Par exemple Context.SignOutAsync(« ThisScheme ») => Context.SignOutAsync(« ForwardSignOutValue »); Définissez la cible sur le schéma actuel pour désactiver le transfert et autoriser un traitement normal. (Hérité de AuthenticationSchemeOptions)
GetClaimsFromUserInfoEndpoint	Boolean pour définir si le gestionnaire 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 ».
MapInboundClaims	Obtient ou définit la MapInboundClaims propriété sur le instance par défaut de JwtSecurityTokenHandler dans SecurityTokenValidator et le instance par défaut de JsonWebTokenHandler dans TokenHandler, qui est utilisé pour déterminer si les types de revendications qui sont extraits lors de la validation d’un JwtSecurityToken. Si cette valeur est définie sur true, le type de revendication est défini sur la revendication JSON « name » après la traduction à l’aide de ce mappage. Sinon, aucun mappage ne se produit. La valeur par défaut est true.
MaxAge	Obtient ou définit le « max_age ». Si vous définissez le paramètre « max_age » est envoyé avec la demande d’authentification. Si le fournisseur d’identité n’a pas authentifié activement l’utilisateur dans la durée spécifiée, l’utilisateur est invité à s’authentifier à nouveau. Par défaut, aucune max_age n’est spécifiée.
MetadataAddress	Obtient ou définit le point de terminaison de découverte pour l'obtention des métadonnées
NonceCookie	Détermine les paramètres utilisés pour créer le cookie de nonce avant l’ajout du cookie à la réponse.
Prompt	Obtient ou définit l’invite.
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
RefreshInterval	Obtient ou définit la durée minimale entre les récupérations, en cas d’échec d’une récupération ou d’une actualisation explicitement demandée.
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 le délai d’exécution du 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 du gestionnaire SignOut à l’aide de SignOutScheme.
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 ».
ReturnUrlParameter	Obtient ou définit le nom du paramètre utilisé pour transmettre l’emplacement d’origine de l’utilisateur avant le déclenchement du défi distant jusqu’à la page accès refusé. Cette propriété n’est utilisée que lorsque le AccessDeniedPath est explicitement spécifié. (Hérité de RemoteAuthenticationOptions)
SaveTokens	Définit si les jetons d’accès et d’actualisation doivent être stockés dans le AuthenticationProperties après 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	Obsolète. 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é. Consultez post_logout_redirect_uri de http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout.
SignedOutRedirectUri	URI vers lequel l’agent utilisateur sera redirigé une fois l’application déconnectée du fournisseur d’identité. La redirection se produit après l’appel de SignedOutCallbackPath.
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, DefaultSignInScheme 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. Si cette option est activée, le gestionnaire transmet les requêtes 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 utilisé pour sécuriser les données gérées par le gestionnaire.
StringDataFormat	Obtient ou définit le type utilisé pour sécuriser les chaînes utilisées par le gestionnaire.
TimeProvider	Utilisé pour les tests. (Hérité de AuthenticationSchemeOptions)
TokenHandler	Obtient ou définit le TokenHandler utilisé pour valider les jetons d’identité. Il sera utilisé à la place de SecurityTokenValidator si UseSecurityTokenValidator est false.
TokenValidationParameters	Obtient ou définit les paramètres utilisés pour valider les jetons d’identité.
UsePkce	Active ou désactive l’utilisation de la clé de preuve pour la norme PKCE (Code Exchange). Cela s’applique uniquement lorsque est ResponseType défini sur Code. Consultez https://tools.ietf.org/html/rfc7636. La valeur par défaut est true.
UseSecurityTokenValidator	Obtient ou définit s’il faut utiliser ou TokenHandler pour SecurityTokenValidator 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.

Méthodes

Validate()	Vérifiez que les options sont valides. Doit lever une exception si les choses ne sont pas correctes.
Validate(String)	Vérifie que les options sont valides pour un schéma spécifique (Hérité de RemoteAuthenticationOptions)