Autoriser des comptes de développeurs à l’aide de Microsoft Entra ID dans Azure API Management

S’applique à : Développeur | Essentiel v2 | Standard | Standard v2 | Premium | Premium v2

Dans cet article, vous allez apprendre à :

• Activer l’accès au portail des développeurs pour des utilisateurs à partir de Microsoft Entra ID.
• Gérer des groupes d’utilisateurs Microsoft Entra en ajoutant des groupes externes qui contiennent les utilisateurs.

Pour bénéficier d’une vue d’ensemble des options permettant de sécuriser le portail des développeurs, consultez Sécuriser l’accès au portail des développeurs Gestion des API.

Important

• Cet article a été mis à jour avec les étapes de configuration d’une application Microsoft Entra à l’aide de la bibliothèque d’authentification Microsoft (MSAL).
• Si vous avez précédemment configuré une application Microsoft Entra pour une connexion utilisateur à l’aide de la bibliothèque Azure AD Authentication (ADAL), nous vous recommandons de migrer vers MSAL.

Prérequis

• Suivez le guide de démarrage rapide Créer une instance du service Gestion des API Azure.

• Importez et publiez une API dans l’instance Gestion des API Azure.

• Utilisez l’environnement Bash dans Azure Cloud Shell. Pour plus d’informations, consultez Démarrage rapide pour Bash dans Azure Cloud Shell.

  

• Si vous préférez exécuter les commandes de référence de l’interface de ligne de commande localement, installez l’interface Azure CLI. Si vous exécutez sur Windows ou macOS, envisagez d’exécuter Azure CLI dans un conteneur Docker. Pour plus d’informations, consultez Guide pratique pour exécuter Azure CLI dans un conteneur Docker.

  • Si vous utilisez une installation locale, connectez-vous à Azure CLI à l’aide de la commande az login. Pour finir le processus d’authentification, suivez les étapes affichées dans votre terminal. Pour connaître les autres options de connexion, consultez Se connecter avec Azure CLI.

  • Lorsque vous y êtes invité, installez l’extension Azure CLI lors de la première utilisation. Pour plus d’informations sur les extensions, consultez Utiliser des extensions avec Azure CLI.

  • Exécutez az version pour rechercher la version et les bibliothèques dépendantes installées. Pour effectuer une mise à niveau vers la dernière version, exécutez az upgrade.

Accéder à votre instance Gestion des API

1. Dans le Portail Azure, recherchez et sélectionnez Services API Management.

   

2. Dans la page Services Gestion des API, sélectionnez votre instance Gestion des API.

   

Activer la connexion utilisateur à l’aide de Microsoft Entra ID - portail

Pour simplifier la configuration, Gestion des API peut activer automatiquement une application et un fournisseur d’identité Microsoft Entra pour les utilisateurs du portail des développeurs. Vous pouvez également activer manuellement l’application et le fournisseur d’identité Microsoft Entra.

Activer automatiquement une application et un fournisseur d’identité Microsoft Entra

1. Dans le menu de gauche de votre instance de Gestion des API, sous Portail des développeurs, sélectionnez Vue d’ensemble du portail.

2. Dans la page Vue d’ensemble du portail, défilez vers le bas jusque Activer la connexion utilisateur avec Microsoft Entra ID.

3. Sélectionnez Activez Microsoft Entra ID.

4. Dans la page Activer Microsoft Entra ID, sélectionnez Activer Microsoft Entra ID.

5. Sélectionnez Fermer.

   

Après avoir activé le fournisseur Microsoft Entra :

• Les utilisateurs de l’instance Microsoft Entra spécifiée peuvent se connecter au portail des développeurs à l’aide d’un compte Microsoft Entra.
• Vous pouvez gérer la configuration Microsoft Entra dans la page Portail des développeurs>Identités du portail.
• Configurez éventuellement d’autres paramètres de connexion en sélectionnant Identités>Paramètres. Par exemple, vous souhaiterez peut-être rediriger les utilisateurs anonymes vers la page de connexion.
• Republiez le portail des développeurs après toute modification de configuration.

Activer manuellement une application et un fournisseur d’identité Microsoft Entra

1. Dans le menu de gauche de votre instance de Gestion des API, sous Portail des développeurs, sélectionnez Identités.

2. Sélectionnez + Ajouter en haut pour ouvrir le volet Ajouter un fournisseur d’identité à droite.

3. Sous Type, sélectionnez Microsoft Entra ID dans le menu déroulant. Une fois cette option sélectionnée, vous pouvez entrer d’autres informations nécessaires.

   • Dans la liste déroulante Bibliothèque de client, sélectionnez MSAL.
   • Pour ajouter un ID client et une Clé secrète client, consultez les étapes décrites plus loin dans l’article.

4. Enregistrez l’URL de redirection pour plus tard.

   

5. Dans votre navigateur, ouvrez le portail Azure dans un nouvel onglet.

6. Accédez à Inscriptions d’applications pour inscrire une application dans Active Directory.

7. Sélectionnez Nouvelle inscription. Sur la page Inscrire une application, définissez les valeurs comme suit :

   • Définissez Nom sur un nom explicite tel que portail-développeurs.
   • Définissez Types de comptes pris en charge sur Comptes dans un annuaire organisationnel.
   • Dans URI de redirection, sélectionnez Application monopage (SPA) et collez l’URL de redirection que vous avez enregistrée lors d’une étape précédente.
   • Sélectionnez Inscription.

8. Après avoir inscrit l’application, copiez l’ID (client) d’application à partir de la page Vue d’ensemble.

9. Basculez sur l’onglet de navigateur avec votre instance Gestion des API.

10. Dans la fenêtre Ajouter le fournisseur d’identité, collez la valeur de l’ID (client) d’application dans la zone ID client.

11. Basculez vers l’onglet du navigateur avec l’inscription d’application.

12. Sélectionnez l’inscription d’application appropriée.

13. Sous la section Gérer du menu latéral, sélectionnez Certificats et secrets.

14. Dans la page Certificats et secrets, sélectionnez le bouton Nouvelle clé secrète client sous Clés secrètes client.

    • Entrez une Description.
    • Sélectionnez une option pour Date d’expiration.
    • Choisissez Ajouter.

15. Copiez la valeur du secret du client avant de quitter la page. Vous en aurez besoin ultérieurement.

16. Sous Gérer dans le menu latéral, sélectionnez Configuration du jeton>+ Ajouter une revendication facultative.

    1. Dans Type de jeton, sélectionnez ID.
    2. Sélectionnez (cochez) les revendications suivantes : email, family_name, given_name.
    3. Sélectionnez Ajouter. Si vous y êtes invité, sélectionnez Activer l’e-mail Microsoft Graph, autorisation de profil.

17. Basculez sur l’onglet de navigateur avec votre instance Gestion des API.

18. Collez le secret dans le champ Clé secrète client dans le volet Ajouter un fournisseur d’identité.

    Important

    Mettez à jour la clé secrète client avant l’expiration de la clé.

19. Dans Locataire de connexion, spécifiez un nom de locataire ou un ID à utiliser pour la connexion à Microsoft Entra. Si aucune valeur n’est spécifiée, le point de terminaison commun est utilisé.

20. Dans Locataires autorisés, ajoutez des noms de locataires ou ID de locataire Microsoft Entra spécifiques pour la connexion à Microsoft Entra.

21. Après avoir spécifié la configuration désirée, sélectionnez Ajouter.

22. Republiez le portail des développeurs pour que la configuration Microsoft Entra prenne effet. Dans le menu de gauche, sous Portail des développeurs, sélectionnez Vue d’ensemble du portail>Publier.

Après avoir activé le fournisseur Microsoft Entra :

• Les utilisateurs du ou des locataires Microsoft Entra spécifiés peuvent se connecter au portail des développeurs à l’aide d’un compte Microsoft Entra.
• Vous pouvez gérer la configuration Microsoft Entra dans la page Portail des développeurs>Identités du portail.
• Configurez éventuellement d’autres paramètres de connexion en sélectionnant Identités>Paramètres. Par exemple, vous souhaiterez peut-être rediriger les utilisateurs anonymes vers la page de connexion.
• Republiez le portail des développeurs après toute modification de configuration.

Migration vers MSAL

Si vous avez précédemment configuré une application Microsoft Entra pour une connexion utilisateur à l’aide de la bibliothèque ADAL, vous pouvez utiliser le portail pour migrer l’application vers MSAL et mettre à jour le fournisseur d’identité dans Gestion des API.

Mettre à jour l’application Microsoft Entra pour une compatibilité MSAL

Pour connaître les étapes, consultez Basculer les URI de redirection vers le type d’application monopage.

Mettre à jour la configuration du fournisseur d’identité

1. Dans le menu de gauche de votre instance de Gestion des API, sous Portail des développeurs, sélectionnez Identités.
2. Sélectionnez Microsoft Entra ID dans la liste.
3. Dans la liste déroulante Bibliothèque de client, sélectionnez MSAL.
4. Sélectionnez Mettre à jour.
5. Republiez votre portail des développeurs.

Ajouter un groupe Microsoft Entra externe

Maintenant que vous avez activé l’accès pour les utilisateurs d’un locataire Microsoft Entra, vous pouvez :

• Ajouter des groupes Microsoft Entra dans Gestion des API. Les groupes ajoutés doivent se trouver dans le locataire dans lequel votre instance Gestion des API est déployée.
• Contrôler la visibilité des produits à l’aide de groupes Microsoft Entra.

1. Accédez à la page d’inscription d’application pour l’application que vous avez inscrite dans la section précédente.
2. Sélectionnez Autorisations de l’API.
3. Ajoutez les autorisations minimales d’application suivantes pour Microsoft API Graph :
   • User.Read.All Autorisation d’application : Gestion des API peut donc lire l’appartenance au groupe d’utilisateurs pour effectuer la synchronisation de groupe au moment où l’utilisateur se connecte.
   • Autorisation d’application Group.Read.All : Gestion des API peut donc lire les groupes Microsoft Entra lorsqu’un administrateur tente d’ajouter le groupe à Gestion des API à l’aide du panneau Groupes dans le portail.
4. Sélectionnez Accorder un consentement administrateur pour {tenantname} afin d’accorder l’accès à tous les utilisateurs de ce répertoire.

Vous pouvez maintenant ajouter des groupes Microsoft Entra externes à partir de l’onglet Groupes de votre instance Gestion des API.

1. Sous Portail des développeurs dans le menu latéral, sélectionnez Groupes.

2. Sélectionnez le bouton Ajouter un groupe Microsoft Entra.

   

3. Sélectionnez le locataire dans la liste déroulante.

4. Recherchez et sélectionnez le groupe que vous voulez ajouter.

5. Appuyez sur le bouton Sélectionner.

Une fois que vous avez ajouté un groupe Microsoft Entra externe, vous pouvez passer en revue ses propriétés et les configurer :

1. Sélectionnez le nom du groupe sous l’onglet Groupes.
2. Modifiez les informations Nom et Description du groupe.

Les utilisateurs de l’instance Microsoft Entra configurée peuvent désormais :

• Se connecter au portail des développeurs.
• Voir tous les groupes pour lesquels ils disposent d’une visibilité et s’y abonner.

Notes

Pour en savoir plus sur la différence entre les types d’autorisations déléguées et de permissions d’application, consultez l’article Autorisations et consentement dans la plateforme d’identités Microsoft.

Synchroniser des groupes Microsoft Entra dans Gestion des API

Les groupes configurés dans Microsoft Entra doivent être synchronisés avec Gestion des API pour pouvoir être ajoutés à votre instance. Si les groupes ne se synchronisent pas automatiquement, effectuez une des opérations suivantes pour synchroniser manuellement les informations sur les groupes :

• Déconnectez-vous et connectez-vous à Microsoft Entra ID. Cette activité déclenche généralement la synchronisation des groupes.
• Vérifiez que le locataire de connexion Microsoft Entra est spécifié de la même façon (en utilisant l’ID de locataire ou le nom de domaine) dans vos paramètres de configuration de Gestion des API. Vous spécifiez le locataire de connexion dans le fournisseur d’identité Microsoft Entra ID pour le portail des développeurs et quand vous ajoutez un groupe Microsoft Entra à Gestion des API.

Portail des développeurs : Ajouter une authentification de compte Microsoft Entra

Dans le portail des développeurs, vous pouvez vous connecter avec Microsoft Entra ID à l’aide du widget Bouton de connexion : OAuth inclus sur la page de connexion du contenu par défaut du portail des développeurs.

Bien qu’un nouveau compte soit automatiquement créé lorsqu’un nouvel utilisateur se connecte avec Microsoft Entra ID, envisagez d’ajouter le même widget à la page d’inscription. Le widget Formulaire d’inscription : OAuth représente un formulaire utilisé pour s’inscrire à l’aide d’OAuth.

Important

Vous devez republier le portail pour que les modifications apportées à Microsoft Entra ID prennent effet.

Contenu connexe

• En savoir plus sur Microsoft Entra ID et OAuth2.0.
• En savoir plus sur MSAL et la migration vers MSAL.
• Résoudre les problèmes de connectivité réseau à Microsoft Graph à partir d’un VNet.