取得客戶的自定義網域
適用於:合作夥伴中心
取得 CustomDomain 資源。
在合作夥伴中心建立新的客戶帳戶時,系統會指派唯一的網域。 此網域可用來識別客戶,也可以用於其他用途,例如信箱設定。
必要條件
認證,如合作夥伴中心驗證所述。 此案例支援應用程式+用戶認證或僅限應用程式驗證。
客戶識別碼 (
customer-tenant-id
)。 如果您不知道客戶的識別碼,您可以在合作夥伴中心查閱。 從合作夥伴中心首頁選取 [客戶] 工作區。 從 [客戶] 列表中選取客戶,然後選取 [ 帳戶]。 在客戶的 [帳戶] 頁面上,在 [客戶帳戶詳細數據] 區段中尋找Microsoft標識符。 Microsoft 識別碼與客戶識別碼 (customer-tenant-id
) 相同。
重要
需要 GDAP 角色才能呼叫此 API。 不支援 DAP。 仍然需要合作夥伴驗證(AdminAgent/HelpDeskAgent/SalesAgent)
GDAP 角色
您至少需要下列其中一個 GDAP 角色:
- 目錄寫入者
- 全域讀取者
- 網域系統管理員
REST 要求
要求語法
方法 | 要求 URI |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id}/customDomains HTTP/1.1 |
URI 參數
將下列查詢參數用於特定客戶。
名稱 | 類型 | 必要 | 描述 |
---|---|---|---|
customer-tenant-id | guid | Y | 此值是 GUID 格式的客戶 租使用者識別碼 ,可讓轉銷商篩選屬於轉銷商之指定客戶的結果。 |
要求標頭
如需詳細資訊,請參閱合作夥伴中心 REST 標頭。
要求本文
無。
要求範例
GET https://api.partnercenter.microsoft.com/v1/customers/{customer-tenant-id}/customDomains HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b
REST 回應
如果成功,這個方法會在回應本文中傳回自定義網域資源。
回應成功和錯誤碼
每個回應都有一個 HTTP 狀態代碼,指出成功或失敗和其他偵錯資訊。 使用網路追蹤工具來讀取此程式代碼、錯誤類型和其他參數。 如需完整清單,請參閱錯誤碼。
回應範例
HTTP/1.1 200 OK
Content-Length: 1530
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b
["contosco.onmicrosoft.com"]