Getting a list of users who have verified rights

Description

Gets a list of users who have verified site management rights.

Request format

Send a GET request to the address of the resource for getting a list of users who have verified rights to the site:

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

Path parameters

Name Required Type Default value Description
user-id Yes int64 The user ID.
host-id Yes host id Site ID.

Response format

If successful, the server returns 200 OK and information about users who have verified their site management rights.

Samples

{
  "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 Verification code.
verification_type Yes ApiExplicitVerificationType Method for verifying rights.
verification_date No yyyy-MM-ddTHH:mm:ss,sssZ Verification date.

Explicit methods of verifying rights (ApiExplicitVerificationType)

Verification method Whether a verification status check can be requested Description
DNS Yes Verifying rights using DNS records.
HTML_FILE Yes Placing an HTML file in the site's root directory.
META_TAG Yes Adding a metatag to the header on the site's main page.
WHOIS Yes

Verifying data with the information provided by the WHOIS service.

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

Errors

403 Forbidden

The user ID for the token doesn't match the one specified in the request. In the examples below, {user_id} is the correct uid for the owner of the OAuth token.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Parameter Description
error_code Error code.
available_user_id ID of the user who allowed access.
error_message Error message.

404 Not Found

The site isn't in the list of the user's sites, or rights to the site haven't been verified.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
Parameter Description
error_code Error code.
host_id The ID of the requested site.
error_message Error message.