Получение списка пользователей, подтвердивших права на сайт

Описание

Позволяет получить список пользователей, которые подтвердили права на управление сайтом.

Формат запроса

Отправьте GET-запрос на адрес ресурса получения списка пользователей, подтвердивших права на сайт:

GET https://api.webmaster.yandex.net/v3/user/{user-id}/hosts/{host-id}/owners/

Path-параметры

Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /user/.
host-id Да host id ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts/.

Формат ответа

В случае успеха сервер возвращает 200 OK и данные о пользователях, подтвердивших свое право на управление сайтом.

Примеры

{
  "users": [
    {
      "user_login": "vassily123",
      "verification_uin": "1123",
      "verification_type": "META_TAG",
      "verification_date": "2016-01-01T00:00:00,000+0300"
    }, ...
  ]
}
Имя Обязательный Тип Описание
user_login Да string Логин пользователя.
verification_uin Да string Код подтверждения.
verification_type Да ApiExplicitVerificationType Способ подтверждения прав.
verification_date Нет yyyy-MM-ddTHH:mm:ss,sssZ Дата подтверждения.

Явные способы подтверждения прав (ApiExplicitVerificationType)

Способ подтверждения Возможность запроса проверки подтверждения Описание
DNS Есть Подтверждение прав с помощью DNS-записи.
HTML_FILE Есть Размещение HTML-файла в корневом каталоге сайта.
META_TAG Есть Добавление мета-тега в заголовок главной страницы сайта.
WHOIS Есть

Сверка данных с информацией, предоставляемой сервисом WHOIS.

Метод работает только для доменов второго уровня (например, example.com).

Ошибки

403 Forbidden

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена. Проверьте OAuth-токен.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Параметр Описание
error_code Код ошибки.
available_user_id ID пользователя, от имени которого разрешен доступ.
error_message Сообщение об ошибке.

404 Not Found

Сайт отсутствует в списке сайтов пользователя или на него не подтверждены права.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
Параметр Описание
error_code Код ошибки.
host_id ID запрошенного сайта.
error_message Сообщение об ошибке.