Obtenir un client par ID

S’applique à : Espace partenaires | Espace partenaires géré par 21Vianet | Espace partenaires de Microsoft Cloud for US Government

Obtient une ressource client qui correspond à un ID client.

Prérequis

  • Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario prend en charge les informations d’identification d’application+utilisateur ou l’authentification par application uniquement.

  • ID du client (customer-tenant-id). Si vous ne connaissez pas l’ID du client, vous pouvez le rechercher dans l’Espace partenaires. Sélectionnez l’espace de travail Clients dans la page d’accueil de l’Espace partenaires. Sélectionnez le client dans la liste Des clients, puis sélectionnez Compte. Dans la page Compte du client, recherchez l’ID Microsoft dans la section Détails du compte client. L’ID Microsoft est le même que l’ID de client (customer-tenant-id).

Important

L’appel d’API Obtenir l’ID client ne renvoie pas les attributs suivants dans la réponse si le partenaire n’a pas d’accès DAP sur le locataire client. Sinon, elle retourne tous les attributs répertoriés dans l’exemple de réponse.

  • CompanyProfileAddress
  • CompanyProfileEmail
  • Domainepersonnalisé

Rôles GDAP

Vous aurez besoin d’au moins l’un des rôles GDAP suivants pour appeler Obtenir une organisation cliente pour CompanyProfileAddress, CompanyProfileEmail et obtenir un domaine personnalisé client pour CustomDomain :

  • Enregistreur d’annuaire
  • Lecteur général
  • Administrateur de domaine

C#

Pour obtenir un client par ID, utilisez votre collection IAggregatePartner.Customers, appelez la méthode ById(), puis appelez les méthodes Get() ou GetAsync().

// IAggregatePartner partnerOperations;
// string customerIdToRetrieve;

Customer customerInfo = partnerOperations.Customers.ById(customerIdToRetrieve).Get();

Exemple : Application de test de console. Projet : Classe PartnerSDK.FeatureSamples : CustomerInformation.cs

Java

Le Kit de développement logiciel (SDK) Java de l’Espace partenaires peut être utilisé pour gérer les ressources de l’Espace partenaires. Il s’agit d’un projet open source géré par la communauté partenaire et non officiellement pris en charge par Microsoft. Si vous rencontrez un problème, vous pouvez obtenir de l’aide auprès de la communauté ou le signaler dans GitHub.

Pour obtenir un client par ID, utilisez votre fonction IAggregatePartner.getCustomers, appelez la fonction byId(), puis appelez la fonction get().

// IAggregatePartner partnerOperations;
// String customerIdToRetrieve;

Customer customerInfo = partnerOperations.getCustomers().byId(customerIdToRetrieve).get();

PowerShell

Le module PowerShell de l’Espace partenaires peut être utilisé pour gérer les ressources de l’Espace partenaires. Il s’agit d’un projet open source géré par la communauté partenaire et non officiellement pris en charge par Microsoft. Si vous rencontrez un problème, vous pouvez obtenir de l’aide auprès de la communauté ou le signaler dans GitHub.

Pour obtenir un client par ID, exécutez la commande Get-PartnerCustomer et spécifiez le paramètre CustomerId.

Get-PartnerCustomer -CustomerId '2ca7de6c-c05c-46b5-b689-32e53573a97a'

Demande REST

Syntaxe de la requête

Method URI de demande
GET {baseURL}/v1/customers/{customer-tenant-id} HTTP/1.1

Paramètre d’URI

Utilisez le paramètre de requête suivant pour un client spécifique.

Nom Type Requise Description
id-locataire-client guid Y La valeur est un ID client au format GUID qui permet au revendeur de filtrer les résultats d’un client donné qui appartient au revendeur.

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.

Corps de la demande

Aucune.

Exemple de requête

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

Réponse REST

Si elle réussit, cette méthode retourne une ressource Client dans le corps de la réponse.

Codes d’erreur et de réussite de la réponse

Chaque réponse est accompagnée d’un code d’état HTTP qui indique la réussite ou l’échec ainsi que des informations de débogage supplémentaires. Utilisez un outil de trace réseau pour lire ce code, le type d’erreur et des paramètres supplémentaires. Pour obtenir la liste complète, consultez Codes d’erreur.

Exemple de réponse

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"
  }
}