Partilhar via

Obter o domínio personalizado de um cliente

  • Artigo

Aplica-se a: Partner Center

Obtém um CustomDomain recurso.

Quando uma nova conta de cliente é criada no Partner Center, é-lhe atribuído um domínio exclusivo. Esse domínio pode ser usado para identificar um cliente e também pode ser usado para outros fins, como configuração de caixa de correio.

Pré-requisitos

  • Credenciais conforme descritas na autenticação do Partner Center. Este cenário suporta credenciais de aplicativo+usuário ou autenticação somente de aplicativo.

  • 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 de Clientes e, em seguida, selecione Conta. Na página Conta do cliente, procure o ID da Microsoft na secção detalhes da conta de cliente. O ID Microsoft é o mesmo que o ID do cliente (customer-tenant-id).

Importante

As funções GDAP são necessárias para chamar essa API. O DAP não é suportado. A autenticação do parceiro ainda é necessária (AdminAgent/HelpDeskAgent/SalesAgent)

Funções GDAP

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

  • Criador de Diretórios
  • Leitor Global
  • Administrador de Domínio

Solicitação REST

Sintaxe da solicitação

Método URI do pedido
GET {baseURL}/v1/customers/{customer-tenant-id}/customDomains 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 GUID formatado customer-tenant-id que permite ao revendedor filtrar os resultados para um determinado cliente 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}/customDomains 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 bem-sucedido, esse método retorna um recurso de domínio personalizado 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 outras informações de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e outros parâmetros. Para 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

["contosco.onmicrosoft.com"]

Conteúdos relacionados