Obter uma organização de clientes
Aplica-se a: Partner Center
Obtém um recurso de Organização de Cliente.
Pré-requisitos
Credenciais, conforme descrito em autenticação do Partner Center. Este cenário oferece suporte a credenciais de aplicativo e de utilizador ou autenticação.
Um ID de cliente (
customer-tenant-id
). Se não souber o ID do cliente, pode procurá-lo 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 é a mesma que a 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:
- Escritor de Diretórios
- Leitor Global
Pedido REST
Sintaxe da solicitação
Método | URI do pedido |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id}/organização HTTP/1.1 |
Parâmetro URI
Use o seguinte parâmetro de consulta para um cliente específico.
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
ID do cliente-locatário | GUID | Y | O valor é um ID de cliente-inquilino no formato GUID que permite ao revendedor filtrar os resultados para um cliente específico que pertence ao revendedor. |
Cabeçalhos do pedido
Para obter mais informações, consulte Cabeçalhos REST do Partner Center.
Corpo do pedido
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 do REST
Se for bem-sucedido, esse método retornará um recurso Customer no corpo da resposta.
Códigos de sucesso e erro de resposta
Cada resposta vem com um código de status HTTP que indica sucesso ou falha e informações adicionais de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e parâmetros adicionais. Para obter a lista completa, consulte 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"
]
}
]