Démarrage rapide de l’approvisionnement entrant piloté par API avec Postman

Article
02/28/2024

Ce tutoriel explique comment tester rapidement l’approvisionnement entrant piloté par API avec Postman.

Conditions préalables

Vous avez configuré l’Application d’approvisionnement entrant pilotée par l’API.
Vous avez configuré un principal de service qui a accès à l’API d’approvisionnement entrant. Notez le TenantId, le ClientId et le ClientSecret de l’application de votre principal de service à utiliser dans ce tutoriel.

Charger des données utilisateur vers l’API d’approvisionnement entrant

Dans cette étape, vous allez configurer l’application Postman et appeler l’API avec le compte de service configuré.

Téléchargez et installez l’application Postman.
Ouvrez l’application de bureau Postman.
Dans le menu Espaces de travail, sélectionnez Créer un espace de travail pour créer un espace de travail appelé API d’approvisionnement Microsoft Entra.
Téléchargez les collections Postman ci-dessous et enregistrez-les dans le répertoire local.
- Microsoft Entra Inbound Provisioning.postman_collection.json (Collection de requêtes)
- Test-API2AAD.postman_environment.json (Collection d’environnements pour l’approvisionnement piloté par API vers Microsoft Entra ID)-
- Test-API2AD.postman_environment.json (Collection d’environnement pour l’approvisionnement piloté par API vers AD local)
Utilisez l’option Import (Importer) dans Postman pour importer ces fichiers dans votre espace de travail.
Cliquez sur le menu Environments (Environnements) et ouvrez l’environnement Test-API2AAD.
Récupérez les valeurs de client_id, client_secret et token_endpoint à partir de l’application inscrite.
Collez les valeurs dans la table pour chaque variable sous la colonne Initial value (Valeur initiale) et Current value (Valeur actuelle).
Ouvrez la page de destination de votre application de provisionnement et copiez-collez la valeur de l’ID de travail de la variable jobId et la valeur du Point de terminaison de l’API de provisionnement de la variable bulk_upload_endpoint
Laissez la valeur ms_graph_resource_id inchangée et enregistrez la collection d’environnement. Assurez-vous que les colonnes Initial value (Valeur initiale) et Current value (Valeur actuelle) sont remplies.
Ensuite, ouvrez la collection Microsoft Entra Inbound Provisioning (approvisionnement entrant Microsoft Entra).
Dans la liste déroulante Environment (Environnement), sélectionnez Test-API2AAD.
Sélectionnez l’onglet Authorization (Autorisation) associé à la collection.
Assurez-vous que l’autorisation est configurée pour utiliser les paramètres OAuth.
La section Advanced options (Options avancées) doit maintenant afficher la configuration suivante :
Cliquez sur Get New Access Token (Obtenir un nouveau jeton d’accès) pour lancer le processus d’obtention d’un jeton d’accès.
Sélectionnez l’option Use Token (Utiliser le jeton) pour utiliser le jeton d’accès avec toutes les requêtes de la collection.

Notes

Le jeton d’accès OAuth généré à l’aide du type d’octroi client_credentials est valide pendant une heure. Vous pouvez décoder le jeton avec https://jwt.ms et savoir quand il expire. Les requêtes échouent après l’expiration du jeton. Si le jeton d’accès a expiré, cliquez sur Get New Access Token (Obtenir un nouveau jeton d’accès) dans Postman pour obtenir un nouveau jeton d’accès. Le jeton est automatiquement copié dans la section Current token (Jeton actuel) de l’onglet « Authorization » (Autorisation). Vous pouvez maintenant utiliser le jeton pour effectuer des appels d’API. Commençons par le premier appel de la collection.
Ouvrez la requête SCIM bulk request upload(Chargement de la requête SCIM en bloc).
Sous l’onglet Authorization (Autorisation), vérifiez que le type est défini sur Inherit auth from parent (Hériter de l’authentification du parent).
Accédez à l’onglet Request body (Corps de la demande) pour afficher et modifier l’exemple de requête SCIM en bloc. Cliquez sur Send (Envoyer) quand vous avez terminé les modifications.

Si l’appel d’API réussit, le message 202 Accepted. s’affiche. Sous « Headers » (En-têtes), l’attribut Location (Emplacement) pointe vers le point de terminaison de l’API des journaux d’approvisionnement.

Vérifier le traitement de la charge utile de requête en bloc

Vous pouvez vérifier le traitement à partir du Centre d’administration Microsoft Entra ou à l’aide de Postman.

Vérifier le traitement sur le centre d’administration Microsoft Entra

Connectez-vous au Centre d’administration Microsoft Entra avec au moins les informations d’identification du niveau Administrateur d’application.
Accédez à Microsoft Entra ID –> Applications –> Applications d'entreprise.
Sous toutes les applications, utilisez la zone de texte filtre de recherche pour rechercher et ouvrir votre application de provisionnement pilotée par les API.
Ouvrez le panneau Provisionnement. La page de destination montre le statut de la dernière exécution.
Cliquez sur Afficher les journaux d’approvisionnement pour ouvrir le panneau journaux d’approvisionnement. Vous pouvez également cliquer sur l’option de menu Surveiller -> Journaux d’approvisionnement.
Cliquez sur n’importe quel enregistrement dans les journaux d’approvisionnement pour afficher des détails de traitement supplémentaires.
L’écran détails du journal d’approvisionnement affiche toutes les étapes exécutées pour un utilisateur spécifique.
- Dans l’étape Importer à partir de l’API , consultez les détails des données utilisateur extraites de la requête en bloc.
- L’étape Mettre en correspondance l’utilisateur affiche les détails de toute correspondance utilisateur en fonction de l’identificateur correspondant. Si une correspondance utilisateur se produit, le service d’approvisionnement effectue une opération de mise à jour. S’il n’existe aucune correspondance utilisateur, le service d’approvisionnement effectue une opération de création.
- L’étape Déterminer si l’utilisateur est dans l’étendue affiche les détails de l’évaluation du filtre d’étendue. Par défaut, tous les utilisateurs sont traités. Si vous avez défini un filtre d’étendue (par exemple, traiter uniquement les utilisateurs appartenant au service des ventes), les détails de l’évaluation du filtre d’étendue s’affichent à cette étape.
- L’étape Provisionner l’utilisateur appelle l’étape de traitement finale et les modifications appliquées au compte d’utilisateur.
- Utilisez l’onglet Propriétés modifiées pour afficher les mises à jour des attributs.

Vérifier le traitement avec l’API des journaux d’approvisionnement dans Postman

Cette section explique comment interroger les journaux d’approvisionnement dans Postman avec le même compte de service (principal de service) que celui que vous avez configuré.

Ouvrez l’espace de travail API d’approvisionnement Microsoft Entra dans l’application de bureau Postman.
La collection Microsoft Entra Inbound Provisioning contient trois échantillons de requêtes qui vous permettent d’interroger les journaux d’approvisionnement.
Vous pouvez ouvrir l’une de ces requêtes prédéfinies.
Si vous ne disposez pas de jeton d’accès valide (ou si vous ne savez pas si le vôtre est encore valide), accédez à l’onglet racine « Authorization » (Autorisation) de l’objet de collection et utilisez l’option Get New Access Token (Obtenir un nouveau jeton d’accès) pour obtenir un nouveau jeton.
Cliquez sur Send (Envoyer) pour obtenir les enregistrements de journal d’approvisionnement. Une fois l’exécution réussie, vous obtiendrez une réponse 200 HTTP du serveur, ainsi que les enregistrements de journal d’approvisionnement.

Annexe

Requête en bloc à l’aide du schéma d’utilisateur d’entreprise SCIM

La requête en bloc ci-dessous utilise le schéma SCIM standard d’utilisateur principal et d’utilisateur d’entreprise.

Corps de la demande

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:BulkRequest"],
    "Operations": [
    {
        "method": "POST",
        "bulkId": "897401c2-2de4-4b87-a97f-c02de3bcfc61",
        "path": "/Users",
        "data": {
            "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],
            "externalId": "701984",
            "userName": "bjensen@example.com",
            "name": {
                "formatted": "Ms. Barbara J Jensen, III",
                "familyName": "Jensen",
                "givenName": "Barbara",
                "middleName": "Jane",
                "honorificPrefix": "Ms.",
                "honorificSuffix": "III"
            },
            "displayName": "Babs Jensen",
            "nickName": "Babs",
            "emails": [
            {
              "value": "bjensen@example.com",
              "type": "work",
              "primary": true
            }
            ],
            "addresses": [
            {
              "type": "work",
              "streetAddress": "100 Universal City Plaza",
              "locality": "Hollywood",
              "region": "CA",
              "postalCode": "91608",
              "country": "USA",
              "formatted": "100 Universal City Plaza\nHollywood, CA 91608 USA",
              "primary": true
            }
            ],
            "phoneNumbers": [
            {
              "value": "555-555-5555",
              "type": "work"
            }
            ],
            "userType": "Employee",
            "title": "Tour Guide",
            "preferredLanguage": "en-US",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "active":true,
            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
                 "employeeNumber": "701984",
                 "costCenter": "4130",
                 "organization": "Universal Studios",
                 "division": "Theme Park",
                 "department": "Tour Operations",
                 "manager": {
                     "value": "89607",
                     "displayName": "John Smith"
                 }
            }
        }
    },
    {
        "method": "POST",
        "bulkId": "897401c2-2de4-4b87-a97f-c02de3bcfc61",
        "path": "/Users",
        "data": {
            "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],
            "externalId": "701985",
            "userName": "Kjensen@example.com",
            "name": {
                "formatted": "Ms. Kathy J Jensen, III",
                "familyName": "Jensen",
                "givenName": "Kathy",
                "middleName": "Jane",
                "honorificPrefix": "Ms.",
                "honorificSuffix": "III"
            },
            "displayName": "Kathy Jensen",
            "nickName": "Kathy",
            "emails": [
            {
              "value": "kjensen@example.com",
              "type": "work",
              "primary": true
            }
            ],
            "addresses": [
            {
              "type": "work",
              "streetAddress": "100 Oracle City Plaza",
              "locality": "Hollywood",
              "region": "CA",
              "postalCode": "91618",
              "country": "USA",
              "formatted": "100 Oracle City Plaza\nHollywood, CA 91618 USA",
              "primary": true
            }
            ],
            "phoneNumbers": [
            {
              "value": "555-555-5545",
              "type": "work"
            }
            ],
            "userType": "Employee",
            "title": "Tour Lead",
            "preferredLanguage": "en-US",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "active":true,
            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
                 "employeeNumber": "701985",
                 "costCenter": "4130",
                 "organization": "Universal Studios",
                 "division": "Theme Park",
                 "department": "Tour Operations",
                 "manager": {
                     "value": "701984",
                     "displayName": "Barbara Jensen"
                 }
            }
        }
    }
],
    "failOnErrors": null
}

Partager via