按 ID 获取客户
适用于:合作伙伴中心 | 由世纪互联运营的合作伙伴中心 | Microsoft Cloud for US Government 合作伙伴中心
获取对应于客户 ID 的客户资源。
先决条件
合作伙伴中心身份验证中所述的凭据。 此方案支持应用+用户凭据或仅限应用的身份验证。
客户 ID (
customer-tenant-id
)。 如果不知道客户的 ID,可以在合作伙伴中心查找它。 从合作伙伴中心主页中选择“客户”工作区。 从 “客户”列表中选择客户,然后选择“ 帐户”。 在客户的“帐户”页上,在“客户帐户详细信息”部分查找Microsoft ID。 Microsoft ID 与客户 ID (customer-tenant-id
) 相同。
重要
如果合作伙伴在客户租户上没有 DAP 访问权限,获取客户 ID API 调用将不会返回响应中的以下属性。 否则,它将返回响应示例中列出的所有属性。
- CompanyProfileAddress
- CompanyProfileEmail
- 自定义域
GDAP 角色
至少需要以下 GDAP 角色之一,才能为 CompanyProfileAddress、CompanyProfileEmail 和获取 CustomDomain 的客户自定义域调用 Get 客户组织:
- 目录写入者
- 全局读取者
- 域管理员
C#
若要按 ID 获取客户,请使用 IAggregatePartner.Customers 集合,调用 ById() 方法,然后调用 Get() 或 GetAsync() 方法。
// IAggregatePartner partnerOperations;
// string customerIdToRetrieve;
Customer customerInfo = partnerOperations.Customers.ById(customerIdToRetrieve).Get();
示例: 控制台测试应用。 项目:PartnerSDK.FeatureSamples 类:CustomerInformation.cs
Java
合作伙伴中心 Java SDK 可用于管理合作伙伴中心资源。 它是由合作伙伴社区维护的开源项目,不受Microsoft正式支持。 如果遇到问题,可以从社区获取帮助或在 GitHub 上创建问题。
若要按 ID 获取客户,请使用 IAggregatePartner.getCustomers 函数,调用 byId() 函数,然后调用 get() 函数。
// IAggregatePartner partnerOperations;
// String customerIdToRetrieve;
Customer customerInfo = partnerOperations.getCustomers().byId(customerIdToRetrieve).get();
PowerShell
合作伙伴中心 PowerShell 模块可用于管理合作伙伴中心资源。 它是由合作伙伴社区维护的开源项目,不受Microsoft正式支持。 如果遇到问题,可以从社区获取帮助或在 GitHub 上创建问题。
若要按 ID 获取客户,请执行 Get-PartnerCustomer 命令并指定 CustomerId 参数。
Get-PartnerCustomer -CustomerId '2ca7de6c-c05c-46b5-b689-32e53573a97a'
REST 请求
请求语法
方法 | 请求 URI |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id} HTTP/1.1 |
URI 参数
将以下查询参数用于特定客户。
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
customer-tenant-id | guid | Y | 该值是 GUID 格式 的客户租户 ID ,允许经销商筛选属于经销商的给定客户的结果。 |
请求标头
有关详细信息,请参阅合作伙伴中心 REST 标头。
请求正文
无。
请求示例
GET https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id> HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b
REST 响应
如果成功,此方法在响应正文中返回 Customer 资源。
响应的成功和错误代码
每个响应都带有一个 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
{
"id": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"commerceId": "99e6a635-48e7-424d-9059-c9db944e3c54",
"companyProfile": {
"tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"domain": "abcdefgh1234.onmicrosoft.com",
"companyName": "1kl as kjk",
"address": {
"country": "US",
"region": "wa",
"city": "redmond",
"addressLine1": "1 ms way",
"postalCode": "98052",
"phoneNumber": "1234567890"
},
"email": "a@a.com",
"links": {
"self": {
"uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/profiles/company",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "CustomerCompanyProfile"
}
},
"billingProfile": {
"id": "eeada110-69d6-4cc9-b093-75feb7ca9d3f",
"firstName": "d0d89d776d03471c819bf772191ed728",
"lastName": "kjkAJJAAAAAAAAAAAAAAAAAAAA",
"email": "a@a.com",
"culture": "en-US",
"language": "en",
"companyName": "1kl as kjkAAAAAAAAAAAAAAAJJJJJJJJJJJAAAAAJJJJJJJJJJJAAJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJAJJJJJAJJAAAAJAJJAAAAAAAAAAAAAAAAAAAA",
"defaultAddress": {
"country": "US",
"city": "redmond",
"state": "WA",
"addressLine1": "1 ms way",
"postalCode": "98052",
"firstName": "1kl as",
"lastName": "kjk",
"phoneNumber": "1234567890"
},
"links": {
"self": {
"uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/profiles/billing",
"method": "GET",
"headers": [
]
}
},
"attributes": {
"etag": "-4242348048554929329",
"objectType": "CustomerBillingProfile"
}
},
"relationshipToPartner": "reseller",
"allowDelegatedAccess": true,
"customDomains": [
"abcdefgh1234.onmicrosoft.com"
],
tags": [
"TestCustomer",
"USCustomer"
],
"links": {
"self": {
"uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Customer"
}
}