Manage customer accounts - Get customers
파트너 고객의 세그먼트를 검색합니다. 고객의 선택적 필터링도 적용할 수 있습니다. 고객은 회사 이름 또는 도메인 이름이 시작되는 문자열로만 필터링할 수 있습니다. 전체 검색은 현재 지원되지 않습니다. 고객은 {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} 필터 작업을 사용하고 DisplayName(회사 이름) 또는 DefaultDomainName을 필터 필드로 지정하여 필터링할 수 있습니다.
GET https://api.partnercenter.microsoft.com/v{version}/customersGET https://api.partnercenter.microsoft.com/v{version}/customers?seekOperation={seekOperation}&size={size}&filter.operator={filter.operator}URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
version
|
path | True |
string |
|
|
filter.
|
query |
integer int32 |
||
|
seek
|
query |
integer int32 |
검색 작업입니다. |
|
|
size
|
query |
integer int32 |
반환할 최대 고객 수입니다. |
요청 헤더
Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| Name | 필수 | 형식 | Description |
|---|---|---|---|
| Authorization | True |
string |
권한 부여 전달자 토큰 |
| ms-correlationid |
string |
내부적으로 요청을 추적하는 데 사용됩니다. ms-correlationid가 제공되지 않으면 서버는 각 요청에 대해 새 상관 관계를 생성합니다. |
|
| ms-cv |
string |
내부적으로 요청을 추적하는 데 사용됩니다. ms-cv 제공되지 않으면 서버는 각 요청에 대해 새 ms-cv 생성합니다. |
|
| ms-requestid |
string |
요청의 idempotency에 사용됩니다. ms-requestid가 제공되지 않으면 서버는 각 요청에 대해 새 요청을 생성합니다. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK |
요청이 성공했습니다. 응답 본문에는 필터와 일치하는 고객 목록이 포함되어 있습니다. 응답이 페이지 크기로 페이징되는 경우 연속 토큰이 포함됩니다. 이 토큰을 /customers?seek=에 전달하여 고객 결과를 검색할 수 있습니다. Media Types: "application/json", "text/json" |
정의
Microsoft.Partner.Core.Collections.Link
| Name | 형식 | Description |
|---|---|---|
| body |
string |
|
| headers |
System. |
|
| method |
string |
|
| uri |
string |
Microsoft.Partner.Core.Collections.ResourceAttributes
| Name | 형식 | Description |
|---|---|---|
| etag |
string |
|
| objectType |
string |
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]
| Name | 형식 | Description |
|---|---|---|
| attributes | ||
| items | ||
| links | ||
| totalCount |
integer |
Microsoft.Partner.Core.Collections.ResourceLinks
| Name | 형식 | Description |
|---|---|---|
| next | ||
| previous | ||
| self |
Microsoft.Partner.Service.Customers.Contracts.V1.Address
| Name | 형식 | Description |
|---|---|---|
| addressLine1 |
string |
|
| addressLine2 |
string |
|
| addressLine3 |
string |
|
| city |
string |
|
| country |
string |
|
| district |
string |
|
| emailAddress |
string |
|
| firstName |
string |
|
| id |
string |
|
| lastName |
string |
|
| middleName |
string |
|
| phoneNumber |
string |
|
| postalCode |
string |
|
| region |
string |
|
| state |
string |
Microsoft.Partner.Service.Customers.Contracts.V1.Customer
| Name | 형식 | Description |
|---|---|---|
| allowDelegatedAccess |
boolean |
|
| associatedPartnerId |
string |
|
| attributes | ||
| billingProfile |
Microsoft. |
|
| commerceId |
string |
|
| companyProfile |
Microsoft. |
|
| customDomains |
string[] |
|
| id |
string |
|
| links | ||
| relationshipToPartner |
enum:
|
|
| userCredentials |
Microsoft. |
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile
| Name | 형식 | Description |
|---|---|---|
| attributes | ||
| companyName |
string |
|
| culture |
string |
|
| defaultAddress | ||
|
string |
||
| firstName |
string |
|
| id |
string |
|
| language |
string |
|
| lastName |
string |
|
| links |
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile
| Name | 형식 | Description |
|---|---|---|
| address | ||
| attributes | ||
| companyName |
string |
|
| domain |
string |
|
|
string |
||
| links | ||
| organizationRegistrationNumber |
string |
|
| tenantId |
string |
Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials
| Name | 형식 | Description |
|---|---|---|
| password | ||
| userName |
string |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| Name | 형식 | Description |
|---|---|---|
| key |
string |
|
| value |
string |
System.Security.SecureString
| Name | 형식 | Description |
|---|---|---|
| length |
integer |