使用 Graph 總管進行 API 驅動輸入佈建快速入門

發行項
07/06/2024

本教學課程說明如何使用 Microsoft Graph 總管快速測試 API 驅動輸入佈建 (部分機器翻譯)。

必要條件

您已設定 API 驅動輸入佈建應用程式 (部分機器翻譯)。

注意

此佈建 API 主要用於在應用程式或服務中使用。租用戶系統管理員可以設定服務主體或受控識別，以授與執行上傳的權限。此 API 沒有個別的使用者可指派 Microsoft Entra 內建目錄角色。除了已取得系統管理員同意 SynchronizationData-User.Upload 權限的應用程式之外，只有具有全域管理員角色的系統管理員使用者才能叫用 API。本教學課程說明如何在測試設定中使用全域管理員角色來測試 API。

上傳使用者資料至輸入佈建 API

開啟新的瀏覽器索引標籤或瀏覽器視窗。
啟動 URL https://aka.ms/ge 以存取 Microsoft Graph 總管。
按一下使用者設定檔圖示以登入。
使用有全域管理員角色的使用者帳戶完成登入流程。
成功登入時，租用戶資訊會顯示您的租用戶名稱。

您現在可開始叫用 API。
在 [API 要求] 面板中，將 HTTP 要求類型設定為 POST。
複製並貼上從佈建應用程式概觀頁面擷取的佈建 API 端點。
在 [要求標頭] 面板底下，新增 Content-Type = application/scim+json 的新索引鍵值組。
在 [要求本文] 面板底下，複製貼上有 SCIM 企業使用者結構描述的大量要求
按一下 [執行查詢] 按鈕，將要求傳送至佈建 API 端點。
如果要求成功傳送，您將從 API 端點取得 Accepted 202 回應。
開啟 [回應標頭] 面板，並複製位置屬性的 URL 值。這指向您可以查詢的佈建記錄 API 端點，以檢查大量要求中存在的使用者佈建狀態。

驗證大量要求承載的處理

要求本文

{
    "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
}

您可以從 Microsoft Entra 系統管理中心或使用 Graph 總管來驗證處理。

從 Microsoft Entra 系統管理中心驗證處理

使用至少應用程式系統管理員 (部分機器翻譯) 登入認證，登入 Microsoft Entra 系統管理中心。
瀏覽至 Microsoft Entra ID -> [應用程式] -> [企業應用程式]。
在所有應用程式下，使用 [搜尋篩選] 文字輸入框來尋找並開啟您的 API 驅動佈建應用程式。
開啟 [佈建] 刀鋒視窗。登陸頁面會顯示上次執行的狀態。
按一下 [檢視佈建記錄] 以開啟 [佈建記錄] 刀鋒視窗。或者，您可以按一下功能表選項 [監視] -> [佈建記錄]。
按一下佈建記錄中的任何記錄，以檢視其他處理詳細資料。
佈建記錄詳細資料畫面會顯示為特定用戶執行的所有步驟。
- 在 [從 API 匯入] 步驟底下，請參閱從大量要求擷取的使用者資料詳細資料。
- 比對使用者步驟會根據比對識別碼顯示任何使用者比對的詳細資料。如果使用者相符，佈建服務就會執行更新作業。如果使用者不相符，佈建服務就會執行建立作業。
- 判斷使用者是否在範圍步驟顯示範圍篩選評估的詳細資料。根據預設，所有使用者都為已處理狀態。如果您已設定範圍篩選條件 (例如，僅處理屬於銷售部門的使用者)，範圍篩選的評估詳細資料會顯示在此步驟中。
- 佈建使用者步驟會呼叫最後的處理步驟，以及套用至使用者帳戶的變更內容。
- 使用 [修改的屬性] 索引標籤來檢視屬性更新內容。

在 Graph 總管中使用佈建記錄 API 驗證處理

您可以使用佈建記錄 API URL，在佈建 API 呼叫中作為位置回應標頭的一部分來檢查處理。

在 Graph 總管中，在 [要求 URL] 文字輸入框複製並貼上佈建 API 端點傳回的位置 URL，或者您可以使用下列格式建構它：https://graph.microsoft.com/beta/auditLogs/provisioning/?$filter=jobid eq '<jobId>' 您可以從佈建應用程式概觀頁面擷取 jobId。
使用方法 GET ，然後按一下 [執行查詢] 以擷取佈建記錄。根據預設，傳回的回應會包含所有記錄檔的記錄內容。
您可以設定更多篩選條件，只擷取特定時間範圍或具有特定狀態值的資料。 https://graph.microsoft.com/beta/auditLogs/provisioning/?$filter=jobid eq '<jobId> and statusInfo/status eq 'failure' and activityDateTime ge 2022-10-10T09:47:34Z 您也可以透過來源系統中所使用的 externalId 值來檢查使用者的狀態，該值會作為來源錨點/聯結屬性。 https://graph.microsoft.com/beta/auditLogs/provisioning/?$filter=jobid eq '<jobId>' and sourceIdentity/id eq '701984'

附錄

有 SCIM 企業使用者結構描述的大量要求

如下所示有 SCIM 標準核心使用者和企業使用者結構描述的大量要求。