適用於:合作夥伴中心
傳回合作夥伴的所有客戶清單,也指出客戶是否有 DAP/非 DAP 關聯性。
目的:合作夥伴遵循規範,以安全地管理客戶租戶,並使用 移除與客戶的 DAP 關聯性 - 合作夥伴中心應用程式開發人員,來移除超過 90 天的非作用中 DAP 關聯性。
注意
此 API 的存留期很短,而且會在 DAP 淘汰階段受到支援。 在 DAP 淘汰計劃之後,此 API 將會停用。
先決條件
憑據
此案例僅支援使用 App+User 認證進行驗證。
令牌交換以獲得存取令牌
如需詳細資訊,請參閱 設定應用程式以存取 Web API。
從 PowerShell 控制台執行下列命令,為合作夥伴租戶中的合作夥伴客戶委派管理 API 應用程式建立服務主體。
連接至 Microsoft Entra ID。
Connect-MgGraph開啟要登入的互動式視窗。 輸入沙箱合作夥伴租戶的登入憑證。
接下來,建立新的服務主體:
New-MgServicePrincipal -AppId 00001111-aaaa-2222-bbbb-3333cccc4444物件識別碼 AppId 顯示名稱 c1bf31da-09e5-4985-ab50-3232d4ae4f5a 00001111-aaaa-2222-bbbb-3333cccc4444 合作夥伴客戶委派管理 接下來,您可以移至 Azure 入口網站,然後 應用程式註冊,然後在租使用者中建立公用用戶端應用程式 ,或使用現有的應用程式來建立公用用戶端應用程式。
選取 [檢視 API 許可權]>[新增許可權]>[組織使用的 API]
選取 [合作夥伴客戶委派管理],>[委派的許可權]>[新增許可權]
為這個新權限授予系統管理員同意。
您現在可以使用 App+使用者令牌(搭配資源 https://api.partnercustomeradministration.microsoft.com),使用此應用程式(使用登入的租用戶系統管理員)來呼叫 GDAP API。
POST https://login.microsoftonline.com/<partner_tenant_id>/oauth2/token grant_type=client_credentials&scope:https://api.partnercustomeradministration.microsoft.com&client_id:<client_id>&client_secret:<client_secret>
REST 要求
請求語法
| 方法 | 要求 URI |
|---|---|
| 獲取 | https://traf-pcsvcadmin-prod.trafficmanager.net/CustomerServiceAdminApi/Web/v1/delegatedAdminCustomers |
URI 參數
此 API 不需要 URI 參數。
請求標頭
| 頁眉 | 描述 | 價值 |
|---|---|---|
| 授權 | 授權令牌格式為 Bearer <token>。 |
字串 |
請求主體
不要提供此 API 的請求主體。
選擇性查詢參數
此方法支援 $select、$filter、$top、$count、$skip 和 $orderBy(允許的欄位:organizationDisplayName、dapEnabled、startDateTime、lastSignInDateTime),以協助自定義回應。
$top 最多支援 300 個物件。
要求範例
GET https://traf-pcsvcadmin-prod.trafficmanager.net/CustomerServiceAdminApi/Web/v1/delegatedAdminCustomers
HTTP/1.1
Authorization: Bearer \<token\>
Content-Type: application/json; charset=utf-8
REST 回應
如果成功,這個方法會在回應主體中傳回 delegatedAdminCustomers 資源的集合。
回應成功和錯誤碼
每個回應都有一個 HTTP 狀態代碼,指出成功或失敗和其他偵錯資訊。 使用網路追蹤工具來讀取此程式代碼、錯誤類型和其他參數。 如需完整清單,請參閱 合作夥伴中心 REST 錯誤碼。
委任管理客戶資源
代表合作夥伴的被授權系統管理員客戶,以及有關合作夥伴對客戶租戶的存取詳細資料。
性能
| 財產 | 類型 | 描述 |
|---|---|---|
| 識別碼 | 字串 | 客戶租戶的唯一標識符。 |
| 客戶租戶識別碼 | 字串 | 客戶租戶的唯一標識符。 |
| 組織顯示名稱 | 字串 | 客戶組織的顯示名稱。 |
| 合作代理數 | 整數 | 於過去一天內已登入客戶租用戶的合作夥伴數目。 |
| 合作夥伴登入次數 | 整數 | 合作夥伴在過去一天內登入客戶租戶的次數。 |
| dap已啟用 | 布爾 | 該值表示合作夥伴是否與客戶有 DAP 合作關係。
如果是假的話:該客戶不存在 DAP 關係。 若為 True:該客戶已建立 DAP 關聯。 |
| 開始日期時間 | 字串 | 建立 DAP 關係的日期和時間。 |
| 結束日期時間 | 字串 | DAP 關聯關係終止的日期時間。 |
| 最後登入時間 | 字串 | 合作夥伴最後一次登入此客戶租用戶的日期和時間。 Null/空白:合作夥伴未曾登入客戶租用戶。 |
回應範例
{
"@odata.context": "https://traf-pcsvcadmin-prod.trafficmanager.net/CustomerServiceAdminApi/Web/v1/$metadata#delegatedAdminCustomers",
"value": [
{
"id": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
"customerTenantId": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
"organizationDisplayName": "Test_Test_GAA_Partner_Account",
"partnerAgentCount": 0,
"partnerSignInCount": 0,
"globalAdminSignInCount": 0,
"dapEnabled": false,
"startDateTime": "2021-08-06T21:15:04.3461507Z",
"endDateTime": null,
"lastSignInDateTime": null
},
{
"id": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"organizationDisplayName": "StagingTest",
"partnerAgentCount": 0,
"partnerSignInCount": 0,
"globalAdminSignInCount": 0,
"dapEnabled": true,
"startDateTime": "2022-04-20T06:11:11.7227953Z",
"endDateTime": null,
"lastSignInDateTime": "2022-04-20T06:11:11.7227953Z"
}
]
}