Partager via

Manage customer accounts - Get customers

  • Référence
Service:
Partner Center Rest
Version d'API:
v1

Récupère un segment des clients d’un partenaire. Le filtrage facultatif des clients peut également être appliqué. Les clients ne peuvent être filtrés que par une chaîne avec laquelle leur nom de société ou leur nom de domaine commence. La recherche complète n’est pas prise en charge actuellement. Les clients peuvent être filtrés à l’aide d’une opération de filtre {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} et en spécifiant : DisplayName (nom de la société) ou DefaultDomainName comme champ de filtre.

GET https://api.partnercenter.microsoft.com/v{version}/customers
Avec des paramètres facultatifs: 
GET https://api.partnercenter.microsoft.com/v{version}/customers?seekOperation={seekOperation}&size={size}&filter.operator={filter.operator}

Paramètres URI

Nom Dans Obligatoire Type Description
version
 path True

string

filter.operator
 query

integer

int32
seekOperation
 query

integer

int32

Opération de recherche.
size
 query

integer

int32

Nombre maximal de clients à retourner.

En-tête de la demande

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Nom Obligatoire Type Description
Authorization True

string

Jeton du porteur d’autorisation
ms-correlationid

string

Utilisé pour le suivi des demandes en interne. Si un ms-correlationid n’est pas fourni, le serveur en génère un nouveau pour chaque requête
ms-cv

string

Utilisé pour le suivi des demandes en interne. Si un ms-cv n’est pas fourni, le serveur en génère un nouveau pour chaque requête
ms-requestid

string

Utilisé pour l’idempotency des requêtes. Si un ms-requestid n’est pas fourni, le serveur en génère un nouveau pour chaque requête

Réponses

Nom Type Description
200 OK

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]

La demande a réussi. Le corps de la réponse contient une liste de clients qui correspondent au filtre. Un jeton de continuation est inclus si la réponse est paginée par la taille de la page. Ce jeton peut être transmis à /customers ?seek= pour rechercher les résultats des clients.

Media Types: "application/json", "text/json"

Définitions

Nom Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Service.Customers.Contracts.V1.Address
Microsoft.Partner.Service.Customers.Contracts.V1.Customer
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile
Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials
System.Collections.Generic.KeyValuePair[System.String,System.String]
System.Security.SecureString
Nom Type Description
body

string

headers

System.Collections.Generic.KeyValuePair[System.String,System.String][]

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Nom Type Description
etag

string

objectType

string

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]

Nom Type Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

items

Microsoft.Partner.Service.Customers.Contracts.V1.Customer[]

links

Microsoft.Partner.Core.Collections.ResourceLinks

totalCount

integer

Nom Type Description
next

Microsoft.Partner.Core.Collections.Link

previous

Microsoft.Partner.Core.Collections.Link

self

Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Service.Customers.Contracts.V1.Address

Nom Type 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

Nom Type Description
allowDelegatedAccess

boolean

associatedPartnerId

string

attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

billingProfile

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile

commerceId

string

companyProfile

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile

customDomains

string[]

id

string

links

Microsoft.Partner.Core.Collections.ResourceLinks

relationshipToPartner enum:
  • advisor
  • microsoft_support
  • none
  • reseller
  • syndication
  • unknown
userCredentials

Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile

Nom Type Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

companyName

string

culture

string

defaultAddress

Microsoft.Partner.Service.Customers.Contracts.V1.Address

email

string

firstName

string

id

string

language

string

lastName

string

links

Microsoft.Partner.Core.Collections.ResourceLinks

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile

Nom Type Description
address

Microsoft.Partner.Service.Customers.Contracts.V1.Address

attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

companyName

string

domain

string

email

string

links

Microsoft.Partner.Core.Collections.ResourceLinks

organizationRegistrationNumber

string

tenantId

string

Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials

Nom Type Description
password

System.Security.SecureString

userName

string

System.Collections.Generic.KeyValuePair[System.String,System.String]

Nom Type Description
key

string

value

string

System.Security.SecureString

Nom Type Description
length

integer