Получить список пользователей сайта

GET

/wp-json/wp2/site-manager/v1/sites/{blog_id}/users

curl --request GET \
  --url 'https://example.com/wp-json/wp2/site-manager/v1/sites/1/users?page=1&per_page=20' \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Пользователи, привязанные к этому блогу (WP_User_Query с blog_id), с первой ролью на сайте. Нужно право управлять блогом. Query page (по умолчанию 1) и per_page (по умолчанию 20, max 100).

Authorizations

• cookie
• applicationPassword

Parameters

Path Parameters

blog_id

required

integer

ID сайта в текущей сети (WP_Site->blog_id).

Query Parameters

page

integer

default: 1

Номер страницы. PHP: max(1, page ?: 1).

per_page

integer

default: 20 <= 100

Пользователей на странице. PHP: max(1, min(100, per_page ?: 20)).

Responses

200

Страница пользователей сайта (items, total, page, per_page).

Media typeapplication/json

object

items

Пользователи этого блога (WP_User_Query с blog_id), одна страница.

Array<object>

object

user_id

ID пользователя WordPress (WP_User->ID).

integer

login

Логин (WP_User->user_login), не display_name.

string

email

Email учётки (WP_User->user_email).

string

role

Первая роль пользователя на этом сайте ($user->roles[0]); пустая строка, если ролей нет.

string

total

Полное число пользователей на сайте (WP_User_Query->get_total()), не длина items.

integer

page

Номер страницы после clamp (max(1, page)).

integer

per_page

Размер страницы после clamp (max(1, min(100, per_page))).

integer

Example

{
  "items": [
    {
      "user_id": 14,
      "login": "editor.ivan",
      "email": "editor@example.com",
      "role": "editor"
    }
  ],
  "total": 3,
  "page": 1,
  "per_page": 20
}

401

Не аутентифицирован. DualRest: rest_forbidden (status 401), если нет cookie-сессии. Cookie + X-WP-Nonce или Application Password.

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

403

Нет права на этот блог (forbidden) или невалидный REST nonce.

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

404

Site_not_in_network — сайт не в текущей сети.

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}