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

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

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

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.

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

Примеры

{
  "users": [
    {
      "user_login": "vassily123",
      "verification_uin": "1123",
      "verification_type": "META_TAG",
      "verification_date": "2016-01-01T00:00:00,000+0300"
    }, ...
  ]
}
<Data>
    <user>
        <user_login>vassily123</user_login>
        <verification_uin>1123</verification_uin>
        <verification_type>META_TAG</verification_type>
        <verification_date>2016-01-01T00:00:00,000+0300</verification_date>
    </user>
    ...
</Data>

Имя

Обязательный

Тип

Описание

user_login

Да

string

Логин пользователя.

verification_uin

Да

string

Код подтверждения.

verification_type

Да

string (ApiExplicitVerificationType)

Способ подтверждения прав.

verification_date

Нет

timedate

Дата подтверждения.

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

Способ подтверждения

Возможность запроса проверки подтверждения

Описание

DNS

Есть

Подтверждение прав с помощью DNS-записи.

HTML_FILE

Есть

Размещение HTML-файла в корневом каталоге сайта.

META_TAG

Есть

Добавление метатега в заголовок главной страницы сайта.

Коды ответа

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

Код

Причина

Описание

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."
}
<Data>
    <error_code>INVALID_USER_ID</error_code>
    <available_user_id>1</available_user_id>
    <error_message>Invalid user id. {user_id} should be used.</error_message>
</Data>

404

HOST_NOT_VERIFIED

Не подтверждены права на управление сайтом.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
<Data>
  <error_code>HOST_NOT_VERIFIED</error_code>  
  <host_id>http:ya.ru:80</host_id>
  <error_message>some string</error_message>
</Data>

Узнайте больше

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

Тип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

Обязательный параметр

Смещение в списке. Минимальное значение — 0. Значение по умолчанию: 0.

Количество записей (1-100). Значение по умолчанию: 10.

Описание

Код ошибки.

Описание

Сообщение об ошибке.

Описание

Значение.

Описание

Поле.

Описание

ID запрошенного сайта.

Описание

ID сайта.

Описание

Признак подтверждения сайта.

Описание

ID файла Sitemap.

Описание

Список поддерживаемых типов контента.

Описание

Лимит на количество добавленных сайтов.

Описание

Лимит количества фидов.

Описание

Лимит количества добавленных фидов.

Описание

ID пользователя, от имени которого разрешен доступ.

Описание

Дата и время, до которого адрес доступен для создания задачи.

Описание

Список поддерживаемых типов контента.

Описание

Список поддерживаемых типов кодировки.

Описание

Максимальная длина.

Описание

Минимальная длина.

Описание

Доступное количество запросов в сутки.

Обязательный

Да

Тип

string

Описание

Логин пользователя.

Обязательный

Да

Тип

string

Описание

Код подтверждения.

Обязательный

Да

Тип

string (ApiExplicitVerificationType)

Описание

Способ подтверждения прав.

Обязательный

Нет

Тип

timedate

Описание

Дата подтверждения.