Schnellstart: API-gesteuerte eingehende Bereitstellung mit Postman

Artikel
02/28/2024

In diesem Tutorial wird beschrieben, wie Sie die API-gesteuerte eingehende Bereitstellung schnell mit Postman testen können.

Voraussetzungen

Sie haben die API-gesteuerte eingehende Bereitstellungs-App konfiguriert.
Sie haben einen Dienstprinzipal mit Zugriff auf die API für die eingehende Bereitstellung konfiguriert. Notieren Sie die TenantId-, ClientId- und ClientSecret-Werte Ihrer Dienstprinzipal-App zur Verwendung in diesem Tutorial.

Hochladen von Benutzerdaten in die API für die eingehende Bereitstellung

In diesem Schritt konfigurieren Sie die Postman-App und rufen die API mithilfe des konfigurierten Dienstkontos auf.

Laden Sie die Postman-App herunter, und installieren Sie sie.
Öffnen Sie die Postman-Desktop-App.
Wählen Sie im Menü Workspaces (Arbeitsbereiche) die Option Create Workspace (Arbeitsbereich erstellen) aus, um einen neuen Arbeitsbereich namens Microsoft Entra ID Provisioning API zu erstellen.
Laden Sie die folgenden Postman-Sammlungen herunter, und speichern Sie sie in Ihrem lokalen Verzeichnis.
- Microsoft Entra ID Inbound Provisioning.postman_collection.json (Anforderungssammlung)
- Test-API2AAD.postman_environment.json (Umgebungssammlung für die API-gesteuerte Bereitstellung in Microsoft Entra ID)-
- Test-API2AD.postman_environment.json (Umgebungssammlung für die API-gesteuerte Bereitstellung in der lokalen AD-Instanz)
Verwenden Sie die Option Import in Postman, um beide Dateien in Ihren Arbeitsbereich zu importieren.
Klicken Sie auf das Menü Umgebungen, und öffnen Sie die Umgebung Test-API2AAD.
Rufen Sie die Werte von client_id, client_secret und token_endpoint aus Ihrer registrierten App ab.
Fügen Sie die Werte für jede Variable in der Tabelle in die Spalten Anfänglicher Wert und Aktueller Wert ein.
Öffnen Sie die Startseite Ihrer Bereitstellungs-App, und fügen Sie den Wert für jobid aus der Variable jobId und den Wert für Endpunkt der Bereitstellungs-API aus der Variable bulk_upload_endpoint ein.
Behalten Sie den Wert von ms_graph_resource_id unverändert bei, und speichern Sie die Umgebungssammlung. Stellen Sie sicher, dass sowohl die Spalte Initial value (Anfänglicher Wert) als auch die Spalte Current value (Aktueller Wert) aufgefüllt ist.
Öffnen Sie als Nächstes die Sammlung Microsoft Entra ID Inbound Provisioning.
Wählen Sie aus der Dropdownliste Environment (Umgebung) das Element Test-API2AAD aus.
Wählen Sie die Registerkarte Authorization (Autorisierung) für die Sammlung aus.
Stellen Sie sicher, dass die Autorisierung so konfiguriert ist, dass sie OAuth-Einstellungen verwendet.
Im Abschnitt Advanced options (Erweiterte Optionen) sollte die folgende Konfiguration angezeigt werden:
Klicken Sie auf Get New Access Token (Neues Zugriffstoken abrufen), um den Prozess für die Bereitstellung eines Zugriffstokens zu starten.
Wählen Sie die Option Use Token (Token verwenden) aus, um das Zugriffstoken mit allen Anforderungen in dieser Sammlung zu verwenden.

Hinweis

Das mithilfe des Gewährungstyps client_credentials generierte OAuth-Zugriffstoken ist eine Stunde lang gültig. Sie können das Token mithilfe von https://jwt.ms decodieren und bei Ablauf überprüfen. Nach Ablauf des Tokens werden keine Anforderungen mehr ausgeführt. Wenn das Zugriffstoken abgelaufen ist, klicken Sie in Postman auf Get New Access Token (Neues Zugriffstoken abrufen), um ein neues Zugriffstoken zu erhalten. Das Token wird automatisch in den Abschnitt Current token (Aktuelles Token) der Registerkarte „Authorization“ (Autorisierung) kopiert, und Sie können es jetzt für API-Aufrufe verwenden. Beginnen wir mit dem ersten Aufruf in dieser Sammlung.
Öffnen Sie die Anforderung SCIM bulk request upload (Upload durch SCIM-Massenanforderung).
Stellen Sie auf der Registerkarte Authorization (Autorisierung) sicher, dass der Typ auf Inherit auth from parent (Authentifizierung von übergeordnetem Element erben) festgelegt ist.
Wechseln Sie zur Registerkarte Request body (Anforderungstext), um das Beispiel für die SCIM-Massenanforderung anzuzeigen und zu bearbeiten. Wenn Sie mit der Bearbeitung fertig sind, klicken Sie auf Send (Senden).

Wenn der API-Aufruf erfolgreich ist, wird die Meldung 202 Accepted. angezeigt. Unter „Headers“ zeigt das Attribut Location (Standort) auf den API-Endpunkt für Bereitstellungsprotokolle.

Überprüfen der Verarbeitung der Massenanforderungspayload

Sie können die Verarbeitung entweder im Microsoft Entra Admin Center oder mithilfe von Postman überprüfen.

Überprüfen der Verarbeitung im Microsoft Entra Admin Center

Melden Sie sich beim Microsoft Entra Admin Center mindestens als Anwendungsadministrator an.
Navigieren Sie zu Microsoft Entra ID –> Anwendungen –> Unternehmensanwendungen.
Verwenden Sie unter allen Anwendungen das Suchfilter-Textfeld, um Ihre API-gesteuerte Bereitstellungsanwendung zu suchen und zu öffnen.
Öffnen Sie das Blatt „Bereitstellung“. Die Landing Page zeigt den Status der letzten Ausführung an.
Klicken Sie auf Bereitstellungsprotokolle anzeigen, um das Blatt „Bereitstellungsprotokolle“ zu öffnen. Alternativ können Sie auf die Menüoption Überwachen –> Bereitstellungsprotokolle klicken.
Klicken Sie in den Bereitstellungsprotokollen auf einen beliebigen Datensatz, um zusätzliche Verarbeitungsdetails anzuzeigen.
Auf dem Bildschirm mit den Details des Bereitstellungsprotokolls werden alle Schritte angezeigt, die für einen bestimmten Benutzer ausgeführt werden.
- Sehen Sie sich im Schritt Importieren aus API Details zu den Benutzerdaten an, die aus der Massenanforderung extrahiert wurden.
- Der Schritt Abgleichen der Benutzer zeigt Details zu jeder Benutzerabgleichung basierend auf dem übereinstimmenden Bezeichner an. Wenn eine Benutzerübereinstimmung auftritt, führt der Bereitstellungsdienst einen Aktualisierungsvorgang aus. Wenn keine Benutzerübereinstimmung vorhanden ist, führt der Bereitstellungsdienst einen Erstellungsvorgang aus.
- Der Schritt Ermitteln, ob sich der Benutzer im Bereich befindet, zeigt Details zur Bereichsfilterauswertung an. Standardmäßig werden alle Benutzer verarbeitet. Wenn Sie einen Bereichsfilter festgelegt haben (z. B. nur Benutzer verarbeiten, die zur Vertriebsabteilung gehören), werden in diesem Schritt die Auswertungsdetails des Bereichsfilters angezeigt.
- Der Schritt Bereitstellen des Benutzers ruft den letzten Verarbeitungsschritt und die auf das Benutzerkonto angewendeten Änderungen auf.
- Verwenden Sie die Registerkarte Geänderte Eigenschaften, um Attributupdates anzuzeigen.

Überprüfen der Verarbeitung mithilfe der Bereitstellungsprotokoll-API in Postman

In diesem Abschnitt wird gezeigt, wie Sie Bereitstellungsprotokolle in Postman mit dem Dienstkonto (Dienstprinzipal) abfragen können, das Sie konfiguriert haben.

Öffnen Sie den Arbeitsbereich Microsoft Entra ID Provisioning API in Ihrer Postman-Desktop-App.
Die Sammlung Microsoft Entra ID Inbound Provisioning enthält drei Beispielanforderungen, mit denen Sie die Bereitstellungsprotokolle abfragen können.
Sie können jede dieser vordefinierten Anforderungen öffnen.
Wenn Sie nicht über ein gültiges Zugriffstoken verfügen oder nicht sicher sind, ob das Token noch gültig ist, wechseln Sie zur Registerkarte „Authorization“ (Autorisierung) im Stammverzeichnis Ihres Sammlungsobjekts, und verwenden Sie die Option Get New Access Token (Neues Zugriffstoken abrufen), um ein neues Token zu erhalten.
Klicken Sie auf Send (Senden), um Protokolldatensätze zur Bereitstellung abzurufen. Nach erfolgreicher Ausführung erhalten Sie eine 200 HTTP-Antwort vom Server sowie die Protokolldatensätze zur Bereitstellung.

Anhang

Massenanforderung mit Schema für SCIM-Enterprise-Benutzer

Die unten gezeigte Massenanforderung verwendet die SCIM-Standardschemas „Core-Benutzer“ und „Enterprise-Benutzer“.

Anforderungstext

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:BulkRequest"],
    "Operations": [
    {
        "method": "POST",
        "bulkId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
        "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": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
        "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
}

Teilen über