以控制面板廠商身分取得客戶同意
身為控制面板廠商(CPV),您可以使用 REST API 取得和移除 CSP 客戶的同意,以取得其租用戶的許可權。
POST https://api.partnercenter.microsoft.com/v1/customers/{<customer_id>}/applicationconsents
注意
每個 applicationId 的速率限製為每秒 50 個要求 (RPS) (CPV 合作夥伴的應用程式識別碼)。
取得同意
URI 參數
名字 | 在 | 必填 | 類型 | 描述 |
---|---|---|---|---|
客戶識別碼 | 路徑 | 是 | 字串 | 合作夥伴中心產生的客戶標識碼 |
要求標題
媒體類型:application/json
名字 | 必填 | 類型 | 描述 |
---|---|---|---|
授權 | 是 | 字串 | 針對對象 https://api.partnercenter.microsoft.com 的存取令牌 |
接受 | 是 | 字串 | 可接受的內容類型;廣泛接受的類型應用程式/json |
ms-correlationid | 字串 | 用於內部追蹤請求。 如果未提供 ms-correlationid,伺服器會為每個請求產生一個新的識別碼 | |
ms-requestid | 字串 | 用於保證請求的等冪性,即保證重複執行相同請求會產生相同的結果。 如果未提供 ms-requestid,伺服器會為每個要求產生一個新的識別碼。 |
請求正文
媒體類型:application/json
名字 | 類型 | 描述 |
---|---|---|
applicationId | 字串 | CPV 合作夥伴的應用程式識別碼 |
applicationGrants | Microsoft.Partner.Core.ApplicationConsents.ApplicationGrant[] | 應用程式許可清單,以取得客戶在其租戶中的存取權 |
反應
名字 | 類型 | 描述 |
---|---|---|
200 確定 | 要求成功。 媒體類型:application/json 、application/xml 、text/xml 、text/json |
|
201 已建立 | 應用程式同意已建立。 媒體類型:application/json 、application/xml 、text/xml 、text/json |
|
400 錯誤請求 | 輸入遺失或無效。 回應主體包含錯誤詳情。 媒體類型:application/json 、application/xml 、text/xml 、text/json |
|
401 未經授權 | 要求未通過驗證。 客戶端需要為目標用戶傳遞有效的存取令牌。 媒體類型:application/json 、application/xml 、text/xml 、text/json |
|
403 禁止存取 | 要求已通過驗證,但遭到拒絕,因為呼叫端沒有叫用它的許可權。 媒體類型:application/json 、application/xml 、text/xml 、text/json |
|
404 找不到 | 找不到資源,或無法使用指定的輸入參數。 媒體類型:application/json 、application/xml 、text/xml 、text/json |
|
500 內部伺服器錯誤 | 合作夥伴 API 服務或其其中一個相依性無法滿足要求。 呼叫者可以重試請求。 媒體類型:application/json 、application/xml 、text/xml 、text/json |
定義
Microsoft.Partner.Core.ApplicationConsents.ApplicationGrant
名字 | 類型 | 描述 |
---|---|---|
企業應用程式ID | 字串 | 獲得存取權的資源的 GUID 表示法 |
範圍 | 字串 | 取得存取權之範圍的逗號分隔值 |
撤銷同意
DELETE https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/applicationconsents/{application_id}
注意
每個 applicationId 的速率限製為每秒 50 個要求 (RPS) (CPV 合作夥伴的應用程式識別碼)。
URI 參數
名字 | 在 | 必填 | 類型 | 描述 |
---|---|---|---|---|
客戶識別碼 | 路徑 | 是 | 字串 | 合作夥伴中心產生的客戶標識碼 |
應用程式識別碼 | 路徑 | 是 | 字串 | CPV 應用程式的識別碼 |
請求標頭
媒體類型:application/json
名字 | 必填 | 類型 | 描述 |
---|---|---|---|
授權 | 是 | 字串 | 受眾 https://api.partnercenter.microsoft.com 的存取令牌 |
接受 | 是 | 字串 | 可接受的內容類型,通常輸入application/json |
ms-correlationid | 字串 | 用於內部追蹤請求。 如果未提供 ms-correlationid ,伺服器會為每個要求產生新的要求 |
|
ms-requestid | 字串 | 用於保證請求的等冪性,即保證重複執行相同請求會產生相同的結果。 如果未提供 ms-requestid,伺服器會為每個要求產生一個新的識別碼。 |
反應
名字 | 類型 | 描述 |
---|---|---|
200 確定 | 要求成功。 媒體類型:application/json 、application/xml 、text/xml 、text/json |
|
201 已建立 | 應用程式同意會遭到刪除。 媒體類型:application/json 、application/xml 、text/xml 、text/json |
|
400 錯誤請求 | 輸入遺失或無效。 回應主體包含錯誤詳情。 媒體類型:application/json 、application/xml 、text/xml 、text/json |
|
401 未經授權 | 要求未通過驗證。 客戶端必須針對有效的對象傳遞有效的存取令牌。 媒體類型:application/json 、application/xml 、text/xml 、text/json |
|
403 禁止存取 | 要求已通過驗證,但遭到拒絕,因為呼叫端沒有叫用它的許可權。 媒體類型:application/json 、application/xml 、text/xml 、text/json |
|
404 找不到 | 找不到資源,或無法使用指定的輸入參數。 媒體類型:application/json 、application/xml 、text/xml 、text/json |
|
500 內部伺服器錯誤 | 合作夥伴 API 服務或其其中一個相依性無法滿足要求。 呼叫者可以重試請求。 媒體類型:application/json 、application/xml 、text/xml 、text/json |