AcquireTokenForClientParameterBuilder 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.
Générateur pour AcquireTokenForClient (utilisé dans les flux d’informations d’identification du client, dans les applications démon). Voir https://aka.ms/msal-net-client-credentials
public sealed class AcquireTokenForClientParameterBuilder : Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder>
type AcquireTokenForClientParameterBuilder = class
inherit AbstractConfidentialClientAcquireTokenParameterBuilder<AcquireTokenForClientParameterBuilder>
Public NotInheritable Class AcquireTokenForClientParameterBuilder
Inherits AbstractConfidentialClientAcquireTokenParameterBuilder(Of AcquireTokenForClientParameterBuilder)
- Héritage
Méthodes
| Nom | Description |
|---|---|
| ExecuteAsync() |
Exécute la demande de jeton de façon asynchrone. (Hérité de BaseAbstractAcquireTokenParameterBuilder<T>) |
| ExecuteAsync(CancellationToken) |
Exécute la demande de jeton de manière asynchrone, avec une possibilité d’annulation de la méthode asynchrone. (Hérité de AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| Validate() |
Valide les paramètres de l’opération AcquireToken. (Hérité de AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithAdfsAuthority(String, Boolean) |
Ajoute une autorité connue correspondant à un serveur ADFS. Voir https://aka.ms/msal-net-adfs. (Hérité de AbstractAcquireTokenParameterBuilder<T>) |
| WithAttributes(String) |
Spécifie un attribut d’identité à inclure dans la demande de jeton. Les valeurs d’attribut sont retournées sous la forme d’une revendication dans le jeton appelé « xms_attr » dans les revendications de jeton d’accès. Cela est généralement utilisé avec les scénarios FMI (Identité managée fédérée). Exemple d’attribut json : « {"sg1 » :"0000-0000-0001 »,"sg2 » :["0000-0000-0002 »,"0000-0000-0003 »,"0000-0000-0000-0004"]} |
| WithAuthority(AadAuthorityAudience, Boolean) |
Obsolète.
Important : Utilisez WithTenantId ou WithTenantIdFromAuthority à la place, ou WithB2CAuthority pour les autorités B2C. Ajoute une autorité AZURE AD connue à l’application pour connecter les utilisateurs spécifiant l’audience de connexion (le cloud étant le cloud Azure cloud public). Voir https://aka.ms/msal-net-application-configuration. (Hérité de AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) |
Obsolète.
Ajoute une autorité AZURE AD connue à l’application pour connecter des utilisateurs spécifiant l’instance cloud et l’audience de connexion. Voir https://aka.ms/msal-net-application-configuration. (Hérité de AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, Guid, Boolean) |
Obsolète.
Important : Utilisez WithTenantId ou WithTenantIdFromAuthority à la place, ou WithB2CAuthority pour les autorités B2C. Ajoute une autorité Azure AD connue à l’application pour connecter des utilisateurs à partir d’une seule organisation (application monolocataire) décrite par son instance cloud et son ID de locataire. Voir https://aka.ms/msal-net-application-configuration. (Hérité de AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, String, Boolean) |
Obsolète.
Important : Utilisez WithTenantId ou WithTenantIdFromAuthority à la place, ou WithB2CAuthority pour les autorités B2C. Ajoute une autorité AZURE AD connue à l’application pour connecter des utilisateurs à partir d’une seule organisation (application à locataire unique) décrite par son instance cloud et son nom de domaine ou son ID de locataire. Voir https://aka.ms/msal-net-application-configuration. (Hérité de AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Boolean) |
Obsolète.
Important : Utilisez WithTenantId ou WithTenantIdFromAuthority à la place, ou WithB2CAuthority pour les autorités B2C. Autorité spécifique pour laquelle le jeton est demandé. La transmission d’une valeur différente de celle configurée au niveau du constructeur d’application limite la sélection à un locataire spécifique. Cela ne modifie pas la valeur configurée dans l’application. Il s’agit d’applications qui gèrent plusieurs comptes (comme un client de messagerie avec plusieurs boîtes aux lettres). Voir https://aka.ms/msal-net-application-configuration. (Hérité de AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Guid, Boolean) |
Obsolète.
Important : Utilisez WithTenantId ou WithTenantIdFromAuthority à la place, ou WithB2CAuthority pour les autorités B2C. Ajoute une autorité AD connue Azure à l’application pour connecter des utilisateurs à partir d’une seule organisation (application à locataire unique) spécifiée par son ID de locataire. Voir https://aka.ms/msal-net-application-configuration. (Hérité de AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, String, Boolean) |
Obsolète.
Important : Utilisez WithTenantId ou WithTenantIdFromAuthority à la place, ou WithB2CAuthority pour les autorités B2C. Ajoute une autorité Azure AD connue à l’application pour connecter des utilisateurs à partir d’une seule organisation (application à locataire unique) décrite par son nom de domaine. Voir https://aka.ms/msal-net-application-configuration. (Hérité de AbstractAcquireTokenParameterBuilder<T>) |
| WithAzureRegion(Boolean) |
Obsolète.
Utilisez WithAzureRegion sur l’objet ConfidentialClientApplicationBuilder |
| WithB2CAuthority(String) |
Ajoute une autorité connue correspondant à une stratégie AD B2C Azure. Voir https://aka.ms/msal-net-b2c-specificities (Hérité de AbstractAcquireTokenParameterBuilder<T>) |
| WithClaims(String) |
Définit les revendications dans la requête. Utiliser lorsque l’administrateur AAD a activé l’accès conditionnel. L’acquisition du jeton entraîne normalement un MsalUiRequiredException jeu de Claims propriétés. Réessayez l’acquisition de jetons et utilisez cette valeur dans la WithClaims(String) méthode. Pour https://aka.ms/msal-exceptions plus d’informations et pour plus d’informations, voir https://aka.ms/msal-net-claim-challenge. (Hérité de AbstractAcquireTokenParameterBuilder<T>) |
| WithCorrelationId(Guid) |
Définit l’ID de corrélation à utiliser dans la demande d’authentification. Permet de suivre une demande dans les journaux du Kit de développement logiciel (SDK) et du service Identity Provider. S’il n’est pas défini, un aléatoire est généré. (Hérité de BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(Dictionary<String,String>) |
Obsolète.
Définit des paramètres de requête supplémentaires pour la chaîne de requête dans la demande d’authentification HTTP. (Hérité de BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>) |
Définit des paramètres de requête supplémentaires pour la chaîne de requête dans la demande d’authentification HTTP avec le contrôle sur les paramètres inclus dans la clé de cache (Hérité de BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(String) |
Obsolète.
Définit des paramètres de requête supplémentaires pour la chaîne de requête dans la demande d’authentification HTTP. (Hérité de AbstractAcquireTokenParameterBuilder<T>) |
| WithFmiPath(String) |
Ajoute un paramètre fmi_path à la requête. Il modifie l’objet du jeton. |
| WithForceRefresh(Boolean) |
Spécifie si l’application cliente doit ignorer les jetons d’accès lors de la lecture du cache de jetons. Les nouveaux jetons sont toujours écrits dans le cache des jetons d’application. Par défaut, le jeton est extrait du cache du jeton d’application (forceRefresh=false) |
| WithMtlsProofOfPossession() |
Spécifie que le certificat fourni sera utilisé pour les jetons PoP avec l’authentification mTLS (TLS mutuelle). Pour plus d’informations, reportez-vous à la documentation de preuve de possession. |
| WithPreferredAzureRegion(Boolean, String, Boolean) |
Obsolète.
Utilisez WithAzureRegion sur l’objet ConfidentialClientApplicationBuilder |
| WithProofOfPossession(PoPAuthenticationConfiguration) |
Obsolète.
Modifie la demande d’acquisition de jeton afin que le jeton acquis soit un jeton de preuve de possession (POP) plutôt qu’un jeton porteur. Les jetons PoP sont similaires aux jetons du porteur, mais sont liés à la requête HTTP et à une clé de chiffrement, que MSAL peut gérer sur Windows. Voir https://aka.ms/msal-net-pop (Hérité de AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithScopes(IEnumerable<String>) |
Spécifie les étendues à demander. Cette méthode est utilisée lorsque votre application doit spécifier les étendues nécessaires pour appeler une API protégée. <Voir>https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent</voir> pour en savoir plus sur les étendues, les autorisations et le consentement, et <voir/voir>https://docs.microsoft.com/azure/active-directory/develop/msal-v1-app-scopes<> comment créer des étendues pour les applications héritées utilisées pour exposer des autorisations OAuth2. (Hérité de AbstractAcquireTokenParameterBuilder<T>) |
| WithSendX5C(Boolean) |
Applicable uniquement aux applications internes, cette méthode permet également de spécifier si la revendication x5c doit être envoyée à Azure AD. L’envoi du x5c permet aux développeurs d’applications d’obtenir un remplacement de certificat facile dans Azure AD : cette méthode envoie la chaîne de certificats à Azure AD avec la demande de jeton, afin que Azure AD puisse l’utiliser pour valider le nom de l’objet en fonction d’une stratégie d’émetteur approuvée. Cela permet à l’administrateur de l’application de gérer explicitement la substitution de certificat (via le portail ou l’opération PowerShell/CLI). Pour plus d’informations, consultez https://aka.ms/msal-net-sni |
| WithSignedHttpRequestProofOfPossession(PoPAuthenticationConfiguration) |
Modifie la requête pour acquérir un jeton de preuve de possession (POP) de requête HTTP signé (SHR) plutôt qu’un porteur. Les jetons poP SHR sont liés à la requête HTTP et à une clé de chiffrement, que MSAL gère sur Windows. Les jetons SHR PoP sont différents des jetons mTLS PoP, qui sont utilisés pour l’authentification mTLS (Mutual TLS). Pour plus d’informations, consultez https://aka.ms/mtls-pop. (Hérité de AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithTenantId(String) |
Remplace l’ID de locataire spécifié dans l’autorité au niveau de l’application. Cette opération conserve l’hôte d’autorité (environnement). Si une autorité n’a pas été spécifiée au niveau de l’application, la valeur par défaut utilisée est |
| WithTenantIdFromAuthority(Uri) |
Extrait l’ID de locataire de l’URI d’autorité fourni et remplace l’ID de locataire spécifié dans l’autorité au niveau de l’application. Cette opération conserve l’hôte d’autorité (environnement) fourni au générateur d’applications.
Si une autorité n’a pas été fournie au générateur d’applications, cette méthode remplace l’ID de locataire dans l’autorité par défaut . |
Méthodes d’extension
| Nom | Description |
|---|---|
| OnBeforeTokenRequest<T>(AbstractAcquireTokenParameterBuilder<T>, Func<OnBeforeTokenRequestData,Task>) |
Intervient dans le pipeline de requête, en exécutant un délégué fourni par l’utilisateur avant que MSAL effectue la demande de jeton. Le délégué peut modifier la charge utile de la requête en ajoutant ou en supprimant des paramètres de corps et des en-têtes. OnBeforeTokenRequestData |
| WithAccessTokenSha256ToRefresh(AcquireTokenForClientParameterBuilder, String) |
Configure le Kit de développement logiciel (SDK) pour ne pas récupérer un jeton à partir du cache s’il correspond au hachage SHA256 du jeton configuré. Comme pour l’API WithForceRefresh(bool), mais au lieu de contourner le cache pour tous les jetons, le contournement du cache se produit uniquement pour 1 jeton |
| WithAdditionalCacheParameters<T>(AbstractAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
Spécifie des paramètres supplémentaires acquis à partir des réponses d’authentification à mettre en cache avec le jeton d’accès qui ne sont normalement pas inclus dans l’objet cache. ces valeurs peuvent être lues à partir du AdditionalResponseParameters paramètre. |
| WithAttributeTokens<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
Envoie |
| WithAuthenticationExtension<T>(AbstractAcquireTokenParameterBuilder<T>, MsalAuthenticationExtension) |
Permet aux applications clientes de fournir une opération d’authentification personnalisée à utiliser dans la demande d’acquisition de jeton. |
| WithCachePartitionKey<T>(BaseAbstractAcquireTokenParameterBuilder<T>, String, String) |
Ajoute une paire clé-valeur à la clé de cache de jeton sans l’envoyer en tant que paramètre de requête.
Utilisez-le pour partitionner des jetons mis en cache (par exemple, isoler les sessions à courte durée de vie des sessions régulières pour le même utilisateur). Les deux |
| WithClaimsFromClient<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, String) |
Spécifie les revendications provenant du client à inclure dans la demande de jeton. Contrairement WithClaims(String) à (pour les défis liés aux revendications émises par le serveur), les jetons acquis avec les revendications clientes sont mis en cache et l’entrée du cache est clé sur la valeur des revendications. Différentes valeurs de revendications produisent des entrées de cache distinctes. Utilisez des valeurs stables et non dynamiques pour éviter la croissance du cache non liée. |
| WithExtraBodyParameters(AcquireTokenForClientParameterBuilder, Dictionary<String,Func<CancellationToken,Task<String>>>) |
Ajoutez des paramètres de corps supplémentaires à la demande de jeton. Ces paramètres sont ajoutés à la clé de cache pour associer ces paramètres au jeton acquis. |
| WithExtraBodyParameters<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, Dictionary<String,Func<CancellationToken,Task<String>>>) |
Ajoutez des paramètres de corps supplémentaires à la demande de jeton. Ces paramètres sont ajoutés à la clé de cache pour associer ces paramètres au jeton acquis. Fonctionne pour les flux client confidentiels (AcquireTokenForClient, AcquireTokenOnBehalfOf, AcquireTokenByAuthorizationCode). |
| WithExtraClientAssertionClaims<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
Spécifie les revendications supplémentaires à inclure dans l’assertion du client. Ces revendications sont fusionnées avec les revendications par défaut lorsque l’assertion cliente est générée. Cela permet aux API de niveau supérieur comme Microsoft. Identity.Web fournit des revendications supplémentaires pour l’assertion du client. Important : les jetons sont associés aux revendications d’assertion de client supplémentaires, ce qui affecte les recherches de cache. Il s’agit d’une API d’extensibilité qui ne doit pas être utilisée directement par les applications. |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
Obsolète.
Ajoute des en-têtes Http supplémentaires à la demande de jeton. |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
Ajoute des en-têtes HTTP supplémentaires à la demande de jeton. |
| WithFmiPathForClientAssertion<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
Spécifie un chemin d’accès FMI à utiliser pour l’assertion du client. Cela permet aux API de niveau supérieur, telles que Id.Web, de fournir des informations d’identification sensibles au FMI. Important : les jetons sont associés au chemin d’identification FMI, ce qui affecte les recherches de cache : il s’agit d’une API d’extensibilité et ne doit pas être utilisée par les applications. |
| WithProofOfPosessionKeyId(AcquireTokenForClientParameterBuilder, String, String) |
Lie le jeton à une clé dans le cache. Les clés de cache L2 contiennent l’ID de clé. Aucune opération de chiffrement n’est effectuée sur le jeton. |
| WithProofOfPosessionKeyId<T>(AbstractAcquireTokenParameterBuilder<T>, String, String) |
Lie le jeton à une clé dans le cache. Aucune opération de chiffrement n’est effectuée sur le jeton. |