使用 Postman 進行 API 驅動輸入布建的快速入門
本教學課程說明如何使用 Postman 快速測試 API 導向的輸入布建 。
必要條件
- 您已設定 API 驅動輸入布建應用程式。
- 您已設定服務主體,且可存取輸入布建 API。 記下
TenantId
服務主體應用程式的 和ClientSecret
,ClientId
以供本教學課程使用。
將用戶數據上傳至輸入布建 API
在此步驟中,您將設定 Postman 應用程式,並使用已設定的服務帳戶叫用 API。
- 下載並安裝 Postman應用程式。
- 開啟Postman傳統型應用程式。
- 從 [ 工作區] 功能表中,選取 [建立工作區 ] 以建立名為 Microsoft Entra 布建 API 的新工作區。
- 下載下列 Postman 集合,並將其儲存在您的本機目錄中。
- Microsoft Entra Inbound Provisioning.postman_collection.json (要求集合)
- Test-API2AAD.postman_environment.json (API 驅動布建至 Microsoft Entra ID 的環境集合)-
- Test-API2AD.postman_environment.json (API 驅動布建至內部部署 AD 的環境集合)
- 使用 Postman 中的 [ 匯 入] 選項,將這兩個檔案匯入您的工作區。
- 單擊 [ 環境] 功能表,然後開啟 Test-API2AAD 環境。
- 從已註冊的應用程式擷取client_id、client_secret和token_endpoint的值。
- 在資料行 [初始值] 和 [目前] 值下,將每個變數的值貼到數據表中。
- 開啟布建應用程式登陸頁面,並複製變數的作業標識碼
jobId
值,以及變數的bulk_upload_endpoint
布建 API 端點值 - 保留ms_graph_resource_id的值不變,並儲存環境集合。 請確定已 填入 [初始值 ] 和 [目前值 ] 資料行。
- 接下來,開啟 Microsoft Entra Inbound Provisioning 集合。
- 從 [ 環境] 下拉式清單中,選取 [ Test-API2AAD]。
- 選取與集合相關聯的 [ 授權] 索引標籤。
- 請確定授權已設定為使用 OAuth 設定。
- [進階選項] 區段應該會顯示下列組態:
- 按兩下 [ 取得新的存取令牌] 以起始採購存取令牌 的程式。
- 選取 [使用令牌] 選項,將存取令牌與這個集合中的所有要求搭配使用。
注意
使用
client_credentials
授與類型所產生的 OAuth 存取令牌有效一小時。 您可以使用 將令牌 https://jwt.ms 譯碼,並檢查令牌到期的時間。 令牌到期之後,要求會失敗。 如果您的存取令牌已過期,請按兩下 Postman 中的 [取得新的存取令牌 ] 以取得新的存取令牌。 令牌會自動複製到 [授權] 索引標籤的 [目前令牌 ] 區段。您現在可以使用令牌進行 API 呼叫。 讓我們從這個集合中的第一個呼叫開始。 - 開啟要求 SCIM 大量要求上傳。
- 在 [ 授權] 索引標籤下,確定類型設定為 [從父系繼承驗證]。
- 變更為 [ 要求本文 ] 索引卷標,以檢視和編輯範例 SCIM 大量要求。 當您完成編輯時,請按兩下 [ 傳送]。
如果 API 叫用成功,您會看到 [標頭] 下方的訊息 202 Accepted.
, [位置 ] 屬性會指向布建記錄 API 端點。
驗證大量要求承載的處理
您可以從 Microsoft Entra 系統管理中心或使用 Postman 來驗證處理。
驗證 Microsoft Entra 系統管理中心的處理
使用至少應用程式 管理員 istrator 層級認證登入 Microsoft Entra 系統管理中心。
流覽至 Microsoft Entra ID -> Applications -> Enterprise 應用程式。
在所有應用程式下,使用 [搜尋篩選] 文本框來尋找並開啟您的 API 驅動布建應用程式。
開啟 [布建] 刀鋒視窗。 登陸頁面會顯示上次執行的狀態。
按兩下 [ 檢視布建記錄 ] 以開啟 [布建記錄] 刀鋒視窗。 或者,您也可以按單選項 [監視 -> 布建記錄]。
按兩下布建記錄中的任何記錄,以檢視其他處理詳細數據。
布建記錄詳細數據畫面會顯示為特定用戶執行的所有步驟。
- 在 [ 從 API 匯入] 步驟底下,查看從大量要求擷取的用戶數據詳細數據。
- [比對使用者] 步驟會根據比對標識符顯示任何使用者比對的詳細數據。 如果使用者相符,布建服務就會執行更新作業。 如果沒有使用者相符專案,則布建服務會執行建立作業。
- 判斷 使用者是否在範圍 步驟中會顯示範圍篩選評估的詳細數據。 根據預設,所有用戶都會進行處理。 如果您已設定範圍篩選條件(例如,僅處理屬於銷售部門的使用者),範圍篩選的評估詳細數據會顯示在此步驟中。
- 布 建使用者 步驟會呼叫最後的處理步驟,以及套用至用戶帳戶的變更。
- 使用 [ 修改的屬性] 索引 標籤來檢視屬性更新。
在 Postman 中使用布建記錄 API 驗證處理
本節說明如何使用您設定的相同服務帳戶(服務主體)在 Postman 中查詢布建記錄。
- 在Postman傳統型應用程式中開啟工作區 Microsoft Entra 布建 API 。
- Microsoft Entra 輸入布建集合包含三個範例要求,可讓您查詢布建記錄。
- 您可以開啟上述任何預先定義的要求。
- 如果您沒有有效的存取令牌,或不確定存取令牌是否仍然有效,請移至集合物件的根授權索引標籤,並使用 [取得新存取令牌] 選項 來取得新的令牌 。
- 按兩下 [ 傳送 ] 以取得布建記錄檔記錄。
成功執行時,您會收到
200 HTTP
來自伺服器的回應,以及布建記錄檔記錄。
附錄
使用 SCIM 企業用戶架構的大量要求
如下所示的大量要求會使用 SCIM 標準核心用戶和企業用戶架構。
要求本文
{
"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
}