Compartilhar via


Obtenha uma organização de clientes

Aplica-se a: Partner Center

Obtém um recurso da Organização do Cliente.

Pré-requisitos

  • Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário dá suporte a credenciais ou autenticação de aplicativo+usuário.

  • Uma ID do cliente (customer-tenant-id). Se você não souber a ID do cliente, poderá procurá-la no Partner Center. Selecione o espaço de trabalho Clientes na página inicial do Partner Center. Selecione o cliente na lista Cliente e, em seguida, selecione Conta. Na página Conta do cliente, procure a ID da Microsoft na seção Detalhes da Conta do Cliente. A ID da Microsoft é igual à ID do cliente (customer-tenant-id).

Importante

As funções GDAP são necessárias para chamar essa API. O DAP não é suportado.

Funções GDAP

Você precisará de pelo menos uma das seguintes funções GDAP:

  • Gravador de diretório
  • Leitor global

Solicitação REST

Sintaxe da solicitação

Método URI da solicitação
GET {baseURL}/v1/customers/{customer-tenant-id}/organization HTTP/1.1

Parâmetro do URI

Use o parâmetro de consulta a seguir para um cliente específico.

Nome Digitar Obrigatória Descrição
id de locatário do cliente guid Y O valor é um customer-tenant-id formatado em GUID que permite que o revendedor filtre os resultados de um determinado cliente que pertence ao revendedor.

Cabeçalhos da solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center.

Corpo da solicitação

Nenhum.

Exemplo de solicitação

GET https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>/organization HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b

Resposta REST

Se for bem-sucedido, esse método retornará um recurso Customer no corpo da resposta.

Códigos de êxito e de erro de resposta

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais. Para obter a lista completa, confira Códigos de Erro.

Exemplo de resposta

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

[
  {
    "street": "1 Microsoft Way",
    "countryLetterCode": "US",
    "postalCode": "98052-8300",
    "city": "Redmond",
    "state": "WA",
    "displayName": "Contoso",
    "technicalNotificationMails": [
      "test@contoso.com"
    ]
  }
]