Добавить пользователя на сайт

POST

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

curl --request POST \
  --url https://example.com/wp-json/wp2/site-manager/v1/sites/1/users \
  --header 'Content-Type: application/json' \
  --header 'X-WP-Nonce: <X-WP-Nonce>' \
  --data '{ "user_id": 14, "role": "editor" }'

Добавляет существующего пользователя на блог (add_user_to_blog) с ролью из тела. Обязательны user_id > 0 и непустой role, иначе 400 missing_fields. Роль только из списка ядра (administrator/editor/author/contributor/subscriber) — иначе 400 invalid_role. Назначить administrator — manage_network_users или manage_network, иначе 403 forbidden. Глобальная учётка не создаётся.

Authorizations

• cookie
• applicationPassword

Parameters

Path Parameters

blog_id

required

integer

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

Request Body^required

Media typeapplication/json

object

user_id

required

Существующий пользователь WordPress (get_user_by('id')). Обязательно, > 0; иначе 400 missing_fields. Нет такого пользователя — 404 user_not_found.

integer

role

required

Роль на этом сайте для add_user_to_blog. Обязательно. PHP принимает только administrator, editor, author, contributor, subscriber; иное — 400 invalid_role. Назначить administrator можно при manage_network_users или manage_network, иначе 403 forbidden.

string

Example

{
  "user_id": 14,
  "role": "editor"
}

Responses

201

Пользователь добавлен на сайт.

Media typeapplication/json

object

added

Всегда true при HTTP 201.

boolean

user_id

ID добавленного пользователя (как в теле запроса).

integer

role

Роль, с которой пользователя добавили.

string

Example

{
  "added": true,
  "user_id": 14,
  "role": "editor"
}

400

Missing_fields — нет user_id или role; invalid_role — роль вне белого списка.

Media typeapplication/json

object

code

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

string

message

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

string

data

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

object

Example^generated

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

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

Нет права на блог, либо роль administrator без manage_network_users/manage_network (forbidden), либо невалидный REST nonce.

Media typeapplication/json

object

code

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

string

message

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

string

data

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

object

Example^generated

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

404

User_not_found — нет такого WP-пользователя; site_not_in_network — сайт не в текущей сети.

Media typeapplication/json

object

code

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

string

message

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

string

data

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

object

Example^generated

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