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

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

Request format

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

user-id

Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.

host-id

Type: 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"
    }, ...
  ]
}

<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>

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.

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."
}

<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

Site management rights are not verified.

  • JSON

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

  • XML

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

Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.

Type: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.

Description

Error code.

Description

ID of the user who allowed access.

Description

Error message.

Description

ID of the requested site.

Required

Yes

Type

string

Description

Username.

Required

Yes

Type

string

Description

Confirmation code.

Required

Yes

Type

string (ApiExplicitVerificationType)

Description

Rights verification method.

Required

No

Type

timedate

Description

The confirmation date.

The status of verifying the right to manage the site (ApiVerificationState)

Status

Description

NONE

Verification wasn't completed and rights are not confirmed.

VERIFIED

The rights are verified.

IN_PROGRESS

The rights verification is in progress.

VERIFICATION_FAILED

Verification was performed but rights are not confirmed.

INTERNAL_ERROR

An unexpected error occurred when verifying the rights.

Rights verification methods (ApiVerificationType)

Verification method

Whether a verification check can be requested

Description

AUTO

No

Automatic rights verification (deprecated; only for *.narod.ru sites).

DELEGATED

No

Rights were delegated.

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.

PDD

No

Rights verification via Yandex.Mail for Domains.

TXT_FILE

No

Placing a text file in the site's root directory.

Reasons for refusal to verify site management rights (ApiVerificationFailReason)

Reason for refusal

Description

DELEGATION CANCELLED

Delegation of site management rights was canceled.

DNS_RECORD_NOT_FOUND

The specified DNS record doesn't exist.

META_TAG_NOT_FOUND

The meta tag is missing in the site's home page header.

PDD_VERIFICATION_CANCELLED

Verification of site management rights via Yandex.Mail for Domain isn't allowed for this site.

WRONG_HTML_PAGE_CONTENT

The HTML file content is set incorrectly.

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.
Previous
Getting the site verification information
Next
Site information