Getting a list of users who verified their rights to manage the site

Returns the list of users who verified their site management rights.

  1. Request format
  2. Response format
  3. Response codes

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/owners
user-idType: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.
host-idType: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.
user-idType: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.
host-idType: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.

Response format

Examples

{
  "users": [
    {
      "user_login": "vassily123",
      "verification_uin": "1123",
      "verification_type": "META_TAG",
      "verification_date": "2016-01-01T00:00:00,000+0300"
    }, ...
  ]
}
Name Required Type Description
user_login Yes string Username.
verification_uin Yes string Confirmation code.
verification_type Yes string (ApiExplicitVerificationType ) Rights verification method.
verification_date No timedate The confirmation date.
Name Required Type Description
user_login Yes string Username.
verification_uin Yes string Confirmation code.
verification_type Yes string (ApiExplicitVerificationType ) Rights verification method.
verification_date No timedate The confirmation date.

Explicit methods of rights verification (ApiExplicitVerificationType)

Verification method Whether a verification check can be requested Description
DNS Yes Verifying rights with the DNS record.
HTML_FILE Yes Placing an HTML file in the site's root directory.
META_TAG Yes Adding a meta tag to the site's home page header.
WHOIS Yes

Verifying data with information provided by the WHOIS service.

This method works only for second-level domains (such as example.com).

Verification method Whether a verification check can be requested Description
DNS Yes Verifying rights with the DNS record.
HTML_FILE Yes Placing an HTML file in the site's root directory.
META_TAG Yes Adding a meta tag to the site's home page header.
WHOIS Yes

Verifying data with information provided by the WHOIS service.

This method works only for second-level domains (such as example.com).

Response codes

To view the response structure in detail, click the reason.

Code Reason Description
200 OK
403

INVALID_USER_ID

The ID of the user who issued the token differs from the one specified in the request. In the examples below, {user_id} shows the correct uid of the OAuth token owner.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_VERIFIED
Site management rights are not verified.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
Code Reason Description
200 OK
403

INVALID_USER_ID

The ID of the user who issued the token differs from the one specified in the request. In the examples below, {user_id} shows the correct uid of the OAuth token owner.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_VERIFIED
Site management rights are not verified.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}