Поделиться через


Получение личного домена клиента

Область применения: Центр партнеров

Возвращает ресурс CustomDomain.

При создании новой учетной записи клиента в Центре партнеров он назначается уникальным доменом. Этот домен можно использовать для идентификации клиента, и его также можно использовать для других целей, таких как настройка почтового ящика.

Необходимые компоненты

  • Учетные данные, описанные в статье о проверке подлинности в Центре партнеров. Этот сценарий поддерживает учетные данные приложения и пользователя или проверку подлинности только для приложений.

  • Идентификатор клиента (customer-tenant-id). Если вы не знаете идентификатор клиента, его можно найти в Центре партнеров. Выберите рабочую область "Клиенты" на домашней странице Центра партнеров. Выберите клиента из списка клиентов и выберите учетную запись. На странице "Учетная запись клиента" найдите идентификатор Майкрософт в разделе сведений о учетной записи клиента. Идентификатор Майкрософт совпадает с идентификатором клиента (customer-tenant-id).

Внимание

Роли GDAP необходимы для вызова этого API. DAP не поддерживается. Проверка подлинности партнера по-прежнему требуется (AdminAgent/HelpDeskAgent/SalesAgent)

Роли GDAP

Вам потребуется по крайней мере одна из следующих ролей GDAP:

  • Редактор каталогов
  • Глобальный читатель
  • Администратор домена

Запрос REST

Синтаксис запроса

Способ URI запроса
GET {baseURL}/v1/customers/{customer-tenant-id}/customDomains HTTP/1.1

Параметр универсального кода ресурса

Используйте следующий параметр запроса для конкретного клиента.

Имя. Type Обязательно Описание
customer-tenant-id guid Y Это значение — идентификатор GUID, отформатированный клиентом клиента , который позволяет торговому посреднику фильтровать результаты для данного клиента, который принадлежит торговому посреднику.

Заголовки запросов

Дополнительные сведения см. в статье о заголовках REST Центра партнеров.

Текст запроса

Нет.

Пример запроса

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

Ответ REST

В случае успешного выполнения этот метод возвращает ресурс личного домена в тексте ответа.

Коды успешного выполнения и ошибок в ответе

Каждый ответ содержит код состояния HTTP, указывающий на успешность или сбой, а также другие сведения об отладке. Используйте средство трассировки сети для чтения этого кода, типа ошибки и других параметров. См. полный список кодов ошибок.

Пример ответа

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