OAuthOptions Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Configuration options 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
- Héritage
- Dérivé
Constructeurs
OAuthOptions() |
Initialise une nouvelle instance de OAuthOptions. |
Propriétés
AccessDeniedPath |
Obtient ou définit le chemin 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) |
AdditionalAuthorizationParameters |
Obtient les paramètres supplémentaires qui seront inclus dans la demande d’autorisation. |
AuthorizationEndpoint |
Obtient ou définit l’URI dans lequel le client sera redirigé pour s’authentifier. |
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. Cela ne peut pas être défini en même temps que BackchannelCertificateValidator, sauf si la valeur peut être rétrodiffusion sur un WebRequestHandler. (Hérité de RemoteAuthenticationOptions) |
BackchannelTimeout |
Obtient ou définit la valeur du délai d’expiration en millisecondes pour les communications avec le fournisseur d’identité distant. (Hérité de RemoteAuthenticationOptions) |
CallbackPath |
Chemin d’accès de la requête dans le chemin de base de l’application où l’agent utilisateur sera retourné. L’intergiciel traite cette demande quand elle arrive. (Hérité de RemoteAuthenticationOptions) |
ClaimActions |
Collection d’actions de revendication utilisées pour sélectionner des valeurs dans les 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 l’ID client attribué par le fournisseur. |
ClientSecret |
Obtient ou définit la clé secrète client affectée par le fournisseur. |
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) |
Events |
Obtient ou définit la OAuthEvents utilisée pour gérer les événements d’authentification. |
EventsType |
Si elle est définie, sera utilisée comme type de service pour obtenir l’instance Events au lieu de la propriété. (Hérité de AuthenticationSchemeOptions) |
ForwardAuthenticate |
S’il est défini, cela spécifie le schéma cible vers lequel 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 le traitement normal. (Hérité de AuthenticationSchemeOptions) |
ForwardChallenge |
S’il est défini, cela spécifie le schéma cible vers lequel 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 le traitement normal. (Hérité de AuthenticationSchemeOptions) |
ForwardDefault |
Si elle est définie, cela 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 vérifie d’abord le paramètre ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, suivi de forwardDefaultSelector, suivi de ForwardDefaultSelector. Le premier résultat non null sera utilisé comme schéma cible à transférer. (Hérité de AuthenticationSchemeOptions) |
ForwardDefaultSelector |
Utilisé pour sélectionner un schéma par défaut pour la demande actuelle que les gestionnaires d’authentification doivent transférer toutes les opérations d’authentification par défaut. La logique de transfert par défaut vérifie d’abord le paramètre ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, suivi de forwardDefaultSelector, suivi de ForwardDefaultSelector. Le premier résultat non null sera utilisé comme schéma cible à transférer. (Hérité de AuthenticationSchemeOptions) |
ForwardForbid |
S’il est défini, cela spécifie le schéma cible vers lequel 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 le traitement normal. (Hérité de AuthenticationSchemeOptions) |
ForwardSignIn |
S’il est défini, cela spécifie le schéma cible vers lequel 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 le traitement normal. (Hérité de AuthenticationSchemeOptions) |
ForwardSignOut |
S’il est défini, cela spécifie le schéma cible vers lequel 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 le traitement normal. (Hérité de AuthenticationSchemeOptions) |
RemoteAuthenticationTimeout |
Obtient ou définit la limite de temps pour terminer le flux d’authentification (15 minutes par défaut). (Hérité de RemoteAuthenticationOptions) |
ReturnUrlParameter |
Obtient ou définit le nom du paramètre utilisé pour transmettre l’emplacement d’origine de l’utilisateur avant que le défi distant ait été déclenché jusqu’à la page d’accès refusée. Cette propriété est utilisée uniquement lorsque le AccessDeniedPath est spécifié explicitement. (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 sur |
Scope |
Obtient la liste des autorisations à demander. |
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) |
StateDataFormat |
Obtient ou définit le type utilisé pour sécuriser les données gérées par le middleware. |
TimeProvider |
Utilisé pour les tests. (Hérité de AuthenticationSchemeOptions) |
TokenEndpoint |
Obtient ou définit l’URI auquel l’intergiciel accède pour échanger le jeton OAuth. |
UsePkce |
Active ou désactive l’utilisation de la clé de preuve pour la norme PKCE (Code Exchange). Voir https://tools.ietf.org/html/rfc7636.
La valeur par défaut est |
UserInformationEndpoint |
Obtient ou définit l’URI auquel le middleware accède pour obtenir les informations utilisateur. Cette valeur n’est pas utilisée dans l’implémentation par défaut, elle est utilisée dans les implémentations personnalisées de OnCreatingTicket. |
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) |