Guide de flux de travail du connecteur de service web pour un exemple d’API REST

2025-04-23

Cet article décrit le déploiement d’un exemple d’API REST pour parcourir l’outil De configuration du service web avec une source de données web d’API REST.

Conditions préalables

Les conditions préalables suivantes sont requises pour utiliser l’exemple :

L’outil de configuration du service web est installé.
L’exemple de service de source de données REST est déployé. Téléchargez et installez l’exemple à partir de (voir ici).

Remarque

Les données JSON doivent contenir un seul objet avec une propriété qui contient un tableau.

{

"EmployeeList":[

{"id":"1","employee_name":"Albano","employee_salary":"22213","employee_age":"37","profile_image":""},{"id":"2","employee_name":"Albano","employee_salary":"22213","employee_age":"37","profile_image":""}

]

}

Configurer la découverte de projets REST dans l’outil de configuration du service web

Les étapes suivantes vous montrent comment créer un projet pour votre source de données dans l’outil de configuration du service web.

Ouvrez l’outil de configuration du service web. Il ouvre un projet SOAP vide.
Sélectionnez Fichier>Nouveau>projet REST.
Sur la gauche, sélectionnez Projet REST , puis Sélectionnez Ajouter.
Dans la page suivante, fournissez les informations suivantes :
- Nouveau nom du service web
- Adresse (chemin d’URL de l’API REST)
- Namespace
- Mode de sécurité (type d’authentification)
L’écran suivant présente des exemples pour ces valeurs :

Définissez le mode de sécurité sur Aucun. Définissez Adresse sur le serveur JSON d’exemple hébergé dans Azure.
Cliquez sur OK. Projet REST répertorié dans l’outil de configuration des services web.
L’étape suivante consiste à définir l’appel d’API REST et à traduire l’appel vers les appels Windows Communication Foundation (WCF).
1. Développez le projet REST et sélectionnez le service RESTSAMPLE .
2. Sélectionnez Ajouter. Vous êtes invité à ajouter deux valeurs :
  1. Entrez le Nom. Cette étape est étiquetée comme 3 dans la capture d’écran.
  2. Entrez une adresse. Cette étape est étiquetée comme 4 dans la capture d’écran.
  3. Cliquez sur OK. Une ressource REST est ajoutée à la description du service RESTSAMPLE .
Dans la zone Ressources , sélectionnez la ressource REST que vous venez d’ajouter. Ajoutez la méthode suivante :
Sélectionnez la méthode REST. Notez qu’il est possible de créer plusieurs méthodes dans la même ressource et de définir les requêtes passées pendant l’exécution.
Pour la méthode GETALL, aucune requête n’est requise. Laissez les valeurs de paramètre vides. Lors de l’exportation ou de l’importation de l’API REST, vous devez définir l’exemple de requête /ou réponse en fonction de la fonction. Copiez et collez le retour JSON lors de la navigation vers cet exemple.
Cliquez sur Enregistrer. Enregistrez le projet dans C:\Program Files\Microsoft Forefront Identity Manager\2010\Synchronization Service\Extensions.

Remarque

Une fois le projet enregistré, le fichier WsConfig est généré. Le fichier de configuration contient plusieurs fichiers définis précédemment dans la vue d’ensemble du service Web.

Configurer des types d’objets dans l’outil de configuration du service web

Les étapes suivantes vous montrent comment configurer des types d’objets pour votre source de données dans l’outil de configuration du service web.

L’étape suivante consiste à définir le schéma d’espace du connecteur. Pour ce faire, créez le type d’objet et définissez leurs types d’objets. Cliquez sur Types d’objets dans le volet gauche, puis cliquez sur Bouton Ajouter . Cette opération ouvre l’écran ci-dessous. Ajoutez un nouveau type d’objet et fournissez un nom. Cliquez sur le bouton OK .
L'ajout d'un type d'objet donne lieu à l'écran ci-dessous.
Le volet droit correspondant au type d’objet vous permet de conserver les attributs et leurs propriétés pour le type d’objet sélectionné. Cliquer sur le bouton Ajouter fournit l’écran ci-dessous pour ajouter des attributs.
L’écran ci-dessous s’affiche après l’ajout de tous les attributs requis.
Le type d’objet et les attributs une fois créés fournissent des flux de travail vides qui répondent aux opérations effectuées dans Microsoft Identity Manager (MIM).

Configurer des flux de travail dans l’outil de configuration du service web

L’étape suivante consiste à configurer les flux de travail pour votre type d’objet. Les fichiers de flux de travail sont une série d’activités utilisées par le connecteur de services web au moment de l’exécution. Les flux de travail sont utilisés pour implémenter l’opération MIM appropriée. L’outil de configuration du service web vous aide à créer quatre flux de travail différents :

Importation : importez des données à partir d’une source de données pour les deux types de flux de travail suivants :
- Importation complète : importation complète qui peut être configurée.
- Importation delta : non prise en charge par l’outil de configuration du service web.
Exportation : exportez des données de MIM vers une source de données connectée. Les trois actions suivantes sont prises en charge pour l’opération. Vous pouvez configurer ces actions en fonction de vos besoins.
- Ajouter
- Supprimer
- Replace
Mot de passe : effectuez la gestion des mots de passe pour l’utilisateur (type d’objet). Deux actions sont disponibles pour cette opération :
- Définir le mot de passe
- Modifier le mot de passe
Tester la connexion : configurez un flux de travail pour vérifier si la connexion avec le serveur de source de données est correctement établie.

Remarque

Vous pouvez configurer ces flux de travail pour votre projet ou télécharger le projet par défaut à partir du Centre de téléchargement Microsoft.

Concepteur de flux de travail

Le Concepteur de flux de travail ouvre la zone de travail pour configurer le flux de travail en fonction des besoins. Pour chaque type d’objet (nouveau /existant), l’outil de configuration fournit les nœuds des flux de travail pris en charge par l’outil.

Concepteur de flux de travail

Le Concepteur de flux de travail se compose des éléments d’interface utilisateur suivants :

Nœuds dans le volet gauche : ceux-ci vous aident à sélectionner le flux de travail que vous souhaitez concevoir.
Concepteur de flux de travail central : ici, vous pouvez supprimer les activités de configuration des flux de travail. Pour effectuer différentes opérations MIM (Exportation, Importation, Gestion des mots de passe), vous pouvez utiliser les activités de flux de travail standard et personnalisées de .NET Workflow Framework 4. L’outil Configuration du service web utilise des activités de flux de travail standard et personnalisées. Pour plus d’informations sur les activités standard, consultez Utilisation des concepteurs d’activités.
- Dans le Concepteur de flux de travail central, un cercle rouge avec une marque d’exclamation à côté d’une activité indique que l’opération a été supprimée et n’est pas définie correctement et complètement. Pointez sur le cercle rouge pour connaître l’erreur exacte. Une fois l’activité définie correctement, le cercle rouge passe à la marque d’informations jaune.
- Dans le Concepteur de flux de travail central, une marque d’informations de triangle jaune à côté de n’importe quelle activité indique que l’activité est définie, mais il y a plus à faire pour terminer l’activité. Pointez sur le triangle jaune pour afficher plus d’informations.
Boîte à outils : Empaquette tous les outils, y compris les activités système et personnalisées et les instructions prédéfinies pour concevoir le flux de travail. Pour plus d’informations, consultez Boîte à outils.
Sections de boîte à outils : La boîte à outils comporte les sections et catégories suivantes :
- Description : en-tête de la boîte à outils. Un onglet accède à la boîte à outils et aux propriétés de l’activité de flux de travail sélectionnée.
- Flux de travail d’importation : activités personnalisées pour configurer les flux de travail d’importation.
- Flux de travail d’exportation : activités personnalisées pour configurer des flux de travail d’exportation.
- Commun : activités personnalisées pour configurer tout flux de travail.
- Débogage : activités de flux de travail système pour le débogage défini dans Workflow 4. Ces activités permettent le suivi des problèmes pour un flux de travail.
- Instructions : activités de flux de travail système définies dans workflow 4. Pour plus d’informations, consultez Utilisation des concepteurs d’activités.
Propriétés : l’onglet Propriétés affiche les propriétés d’une activité de flux de travail particulière qui est supprimée dans la zone du concepteur et sélectionnée. La figure à gauche montre les propriétés de l’activité Assigner . Pour chaque activité, les propriétés diffèrent et sont utilisées lors de la configuration du flux de travail personnalisé. Cet onglet vous permet de définir les attributs de l’outil sélectionné qui a été supprimé dans le concepteur de flux de travail central. Pour plus d’informations, consultez Propriétés.
Barre des tâches : La barre des tâches comprend trois éléments : variables, arguments et importations. Ces éléments sont utilisés avec les activités de flux de travail. Pour plus d’informations, consultez l’introduction d’un développeur à Windows Workflow Foundation (WF) dans .NET 4.

Configurer un flux de travail d’importation complet dans l’outil de configuration du service web

Les étapes suivantes montrent comment configurer des flux de travail d’importation complets pour l’API REST à l’aide de l’outil de configuration du service web.

Avertissement

Cet exemple crée uniquement un flux de travail. Les modifications apportées au flux de travail, telles que l’utilisation d’une logique personnalisée dans l’API, peuvent être requises.

Sélectionnez le flux de travail d’importation complète à configurer. Les arguments et les importations sont déjà définis et sont spécifiques aux activités. Pour plus d’informations, consultez les écrans suivants.

Après la reconfiguration des appels, vous devez modifier les noms des attributs qui changent ou ajoutent l’espace de noms aux variables qui font référence à la structure de retour de l’API et des types d’objets qui font référence à l’ancien espace de noms. La boîte à outils dans le volet droit contient toutes les activités personnalisées spécifiques au flux de travail dont vous avez besoin pour la configuration. Affectez les valeurs aux variables que vous allez utiliser pour votre logique. Accédez à la section inférieure du concepteur de flux de travail central et déclarez les variables. Les variables sont déclarées à l’étape suivante.
Ajoutez une activité de séquence. Faites glisser le concepteur d'activités Séquence de la boîte à outils et déposez-le sur la surface du Windows Workflow Designer. Reportez-vous aux écrans suivants. L'activité Séquence contient une collection ordonnée d'activités enfants qu'elle exécute dans l'ordre.
Pour ajouter une variable, recherchez Créer une variable. Tapez wsResponse pour le nom, sélectionnez la liste déroulante Type de variable , puis recherchez les types. Une boîte de dialogue s’affiche. Sélectionnez generated>GETALL>Response. Conservez les valeurs Étendue et Par défaut non sélectionnées. Vous pouvez également définir ces valeurs à l’aide de la vue Propriétés .
Faites glisser un autre concepteur d'activité de séquence de la boîte à outils dans l'activité de séquence déjà ajoutée.
Faites glisser une activité WebServiceCallActivity présentée sous Common. Cette activité est utilisée pour invoquer les opérations des services Web disponibles après la découverte. Il s’agit d’une activité personnalisée et est courante dans différents scénarios d’opération.

Pour utiliser l’opération de service web, définissez les propriétés suivantes :
- Nom du service : entrez un nom pour le service web.
- Nom du point de terminaison : spécifiez un nom de point de terminaison pour le service sélectionné.
- Nom de l’opération : spécifiez l’opération correspondante pour le service.
- Argument : sélectionner des arguments. Dans la boîte de dialogue suivante, affectez les valeurs d’argument, comme illustré dans la figure suivante :
  
  Importante
  
  Ne modifiez pas le nom, la direction ou le type d’un argument à l’aide de cette boîte de dialogue. Si l’une de ces valeurs est modifiée, l’activité devient non valide. Définissez uniquement la valeur de l’argument. Comme illustré dans cette figure, la valeur wsResponse est définie.
Ajoutez une activité ForEach juste en dessous de WebServiceCallActivity. Cette activité est utilisée pour itérer sur tous les attributs (ancres et non ancres) du type d’objet. Lors du glissement de cette activité dans votre surface du Concepteur de flux de travail, elle énumère automatiquement tous les noms d’attributs de votre objet. Définissez les valeurs requises conformément à l’écran suivant :
Dans certains cas, vous devrez peut-être ouvrir le generated.dll qui se trouve dans le fichier WsConfig. Copiez ce fichier WsConfig et renommez-le avec l’extension .zip. Ouvrez et extrayez le generated.dll à l’aide de votre outil de réflecteur .NET préféré.
Identifiez l’espace de noms public pour EmployeeList :

Ensuite, ajoutez ce retour au workflow ForEach :
Faites glisser une activité CreateCSEntryChangeScope dans le corps de ForEach. Cette activité est utilisée pour créer une instance d’objet CSEntryChange dans le domaine de flux de travail pour chaque enregistrement respectif lors de la récupération de données à partir de la source de données cible. En faisant glisser cette activité, vous obtenez l'écran ci-dessous. Les activités CreateAnchorAttribute sont automatiquement héritées. Mettez à jour la valeur du nom de domaine de votre choix.

Remarque

Les valeurs d’ancrage et les noms d’objets varient en fonction du service web exposé. La figure montre un exemple.
Faites glisser une activité CreateAttributeChange sous l’activité CreateAnchorAttribute . Le nombre d'activités à faire glisser est égal au nombre d'attributs non ancrés. Consultez la figure suivante pour référence.

Remarque

Pour utiliser cette activité, choisissez et affectez les champs respectifs dans la liste déroulante et affectez les valeurs. Pour les attributs à valeurs multiples, supprimez plusieurs activités CreateValueChangeActivity dans une activité CreateAttributeChangeActivity .
Enregistrez ce projet à l’emplacement %FIM_INSTALL_FOLDER%\Synchronization Service\Extensions. Configurez ensuite l’agent de gestion comme décrit dans la configuration ma du service web.

Les projets par défaut doivent être téléchargés et enregistrés à l’emplacement %FIM_INSTALL_DIR\2010\Synchronization Service\Extensions sur le système cible. Les projets sont alors visibles dans l'assistant du connecteur de service Web.

Lorsque vous exécutez le fichier exécutable, vous êtes invité à spécifier l’emplacement de l’installation. Saisissez l'emplacement de sauvegarde.

Importante

Le fichier projet peut être enregistré et ouvert à partir de n’importe quel emplacement (avec les privilèges d’accès appropriés de son exécuteur). Seuls les fichiers de projet enregistrés dans le dossier Synchronization Service\Extension peuvent être sélectionnés dans l'assistant du connecteur de service Web auquel on accède par l'interface utilisateur de synchronisation du MIM.

L’utilisateur qui exécute l’outil De configuration du service web nécessite les privilèges suivants :
- Contrôle total dans le dossier d’extension du service de synchronisation.
- Accès en lecture à la clé de registre HKLM\System\CurrentControlSet\Services\FIMSynchronizationService\Parameters dans laquelle se trouve le chemin du dossier Extension.