SaaS 供應專案的ISV應用程式授權管理

如果您已在合作夥伴中心啟用 SaaS 供應專案的授權管理(目前僅適用於 AppSource),則必須與 usageRights Graph API 整合,以查閱客戶的授權。 您可以使用 usageRights API 來判斷客戶呼叫解決方案的授權狀態,以便據以採取行動。

重要

自 2023 年 6 月 30 日起,Azure Active Directory (Azure AD) Graph 已淘汰。 接下來,我們不會對 Azure AD Graph 進行進一步的投資。 Azure AD Graph API 除了安全性相關修正之外,沒有 SLA 或維護承諾。 對新功能的投資只會在 Microsoft Graph 中進行。

我們會以累加步驟淘汰 Azure AD Graph,讓您有足夠的時間將應用程式遷移至 Microsoft Graph API。 在稍後宣佈的日期,我們將封鎖使用 Azure AD Graph 建立任何新的應用程式。

若要深入瞭解,請參閱 重要事項:Azure AD Graph 淘汰和 Powershell 模組淘汰

usageRights API

APIusageRight 資源類型

如何使用usageRights API

您可以呼叫 usageRights Graph API,以判斷已登入使用者購買供應專案訂閱的授權狀態。 若要呼叫 API,請遵循下列步驟:

  1. 代表令牌取得使用者:請參閱 代表使用者取得存取權
  2. 呼叫 Graph 以取得使用者的物件識別碼:請參閱 使用 Microsoft Graph API
  3. 呼叫usageRights API以判斷使用者具有方案的授權:請參閱 列出使用者usageRights

注意

您必須具備最低 User.Read 許可權,才能呼叫 usageRights。 usageRights API 目前為 Beta 版本。 將版本更新為 V1 之後,ISV 應該會在可用時從 Beta 升級至 V1 版本。

回應碼

具有回應本文的程式代碼 200:

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('ea201692-eb91-44e0-b82a-9dd4c78ced32')/usageRights",
    "@odata.nextLink": "https://graph.microsoft.com/beta/users/ea201692-eb91-44e0-b82a-9dd4c78ced32/usageRights?$skiptoken=ZXlKamIzTnRiM05FWWxSdmEyVnVJam9pVzN0Y0ltTnZiWEJ2YzJsMFpWUnZhMlZ1WENJNmUxd2lkRzlyWlc1Y0lqcHVkV3hzTEZ3aWNtRnVaMlZjSWpwN1hDSnRhVzVjSWpwY0lqRkdSa1pHUmtaR1JrWkdSa1pHUmtaR1JrWkdSa1pHUmt.......",
    "value": [
        {
            "id": "635991be-b7a3-4dd4-a48c-f1d39732fe94",
            "catalogId": "ID of the Product",
            "serviceIdentifier": "ISV friendly ID of the product, this is same as planID in partner center",
            "state": "active"
        }
    ]
}

API 回應說明

  • Odata.nextLink:如果您的要求有數個結果且需要分頁, 則 Odata.nextLink 會在回應中。 您可以使用此選項來分頁結果,直到不再出現 Odata.nextLink 值,這表示回應的結尾。
  • serviceIdentifier:客戶購買之方案的 planId。
  • state:授權的狀態。 您可以在 usageRights API 檔案中查看所有可能的狀態值。 一般而言,如果使用者的授權狀態為 作用 中或 警告,則應該能夠執行您的解決方案。 任何其他狀態都表示使用者的訂用帳戶狀況不佳,因為它已過期、因未付款而暫停等。
  • 具有空白回應的程式代碼 200: 這可能是因為客戶未獲指派授權。
  • 程序代碼 400 不正確的要求: 這可能是因為呼叫如持有人令牌的 API 時遺漏欄位。檢查您的 API 呼叫參數。
  • 程序代碼 403 禁止: 這可能是因為令牌過期或未經授權的。確認您使用正確的 Microsoft Entra 應用程式來驗證 usageRights Graph API。
  • 程序代碼 500 內部伺服器錯誤:重試 API 呼叫。如果錯誤持續發生,請連絡 Microsoft 支援服務。

注意

如果您用於 SaaS 履行 API 的 Microsoft Entra 應用程式也用於 usageRights API,請確定建立新增應用程式的租使用者是合作夥伴中心的發佈租使用者或相關聯的租使用者。

使用下列步驟來判斷 Microsoft Entra App 建立的租使用者是合作夥伴中心設定的一部分:

  1. 使用用來發佈 SaaS 供應專案的發行者帳戶登入 Microsoft 合作夥伴中心
  2. 在右上角的 [設定] 連結下,選取 [帳戶設定],然後選取 [租使用者]
  3. 您可以在 Microsoft AI Cloud Partner 計劃帳戶中看到所有相關聯的租使用者。
  4. Microsoft Entra App 擁有者的租用戶應該在此清單中。
  5. 如果租使用者不在清單中,您可以使用 [建立 Azure 標識符關聯] 按鈕來連結租使用者。

Screenshot illustrating the Microsoft Entra app list of tenants.