Compartilhar via

Obter o domínio personalizado de um cliente

  • Artigo

Aplica-se a: Partner Center

Obtém um recurso CustomDomain .

Quando uma nova conta de cliente é criada no Partner Center, ela recebe um domínio exclusivo. Esse domínio pode ser usado para identificar um cliente e também pode ser usado para outras finalidades, como configuração de caixa de correio.

Pré-requisitos

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

  • 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. Não há suporte para DAP. A autenticação de parceiro ainda é necessária (AdminAgent/HelpDeskAgent/SalesAgent)

Funções GDAP

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

  • Gravador de diretório
  • Leitor global
  • Administrador do Domínio

Solicitação REST

Sintaxe da solicitação

Método URI da solicitação
GET {baseURL}/v1/customers/{customer-tenant-id}/customDomains 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}/customDomains HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: a176c585-b5de-4d65-824c-67a6deb45cd9
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b

Resposta REST

Se for bem-sucedido, esse método retornará um recurso de domínio personalizado 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 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 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: a176c585-b5de-4d65-824c-67a6deb45cd9
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b

["contosco.onmicrosoft.com"]

Conteúdo relacionado