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

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

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/owners
user-id Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
host-idТип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts.
user-id Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
host-idТип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts.

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

Примеры

{
  "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 Да string (ApiExplicitVerificationType ) Способ подтверждения прав.
verification_date Нет timedate Дата подтверждения.
Имя Обязательный Тип Описание
user_login Да string Логин пользователя.
verification_uin Да string Код подтверждения.
verification_type Да string (ApiExplicitVerificationType ) Способ подтверждения прав.
verification_date Нет timedate Дата подтверждения.

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

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

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

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

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

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

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

Коды ответа

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код Причина Описание
200 OK
403

INVALID_USER_ID

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

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
Код Причина Описание
200 OK
403

INVALID_USER_ID

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

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}