获取客户的自定义域
适用于:合作伙伴中心
获取 CustomDomain 资源。
在合作伙伴中心创建新客户帐户时,会为其分配唯一域。 此域可用于标识客户,还可以用于其他目的,例如邮箱设置。
先决条件
合作伙伴中心身份验证中所述的凭据。 此方案支持应用+用户凭据或仅限应用的身份验证。
客户 ID (
customer-tenant-id
)。 如果不知道客户的 ID,可以在合作伙伴中心查找它。 从合作伙伴中心主页中选择“客户”工作区。 从 “客户”列表中选择客户,然后选择“ 帐户”。 在客户的“帐户”页上,在“客户帐户详细信息”部分查找Microsoft ID。 Microsoft ID 与客户 ID (customer-tenant-id
) 相同。
重要
调用此 API 需要 GDAP 角色。 不支持 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 格式 的客户租户 ID ,允许经销商筛选属于经销商的给定客户的结果。 |
请求标头
有关详细信息,请参阅合作伙伴中心 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"]