Обновление информации о пользователе

Метод используется для изменения статуса или роли другого пользователя в аккаунте, в том числе, для назначения его Владельцем вместо текущего пользователя. У текущего пользователя должен быть доступ к указанному аккаунту и необходимые разрешения в рамках роли (см. Получение информации об уровнях доступа пользователей), а другой пользователь аккаунта должен иметь глобальный статус Активный.

Чтобы изменить информацию о текущем пользователе, см. Обновление информации о текущем пользователе и Изменение пароля. Однако изменить роль или статус пользователя в аккаунте может только другой пользователь аккаунта.

PATCH {reseller_domain}/internal_api/account/{account_id}/users/{user_id}

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	path	integer	Обязательный	ID аккаунта, в рамках которого изменяется статус или роль пользователя
user_id	path	integer	Обязательный	ID пользователя, для которого изменяется статус или роль в указанном аккаунте
status	form	string	Опциональный	Целевой статус пользователя в указанном аккаунте: active — чтобы активировать пользователя. inactive — чтобы деактивировать пользователя.
role	form	string	Опциональный	Целевой уровень доступа пользователя в указанном аккаунте (см. ): Изменить уровень доступа можно только для пользователя в статусе Активный в указанном аккаунте. Назначить другого пользователя Владельцем может только текущий Владелец аккаунта. При этом сам он автоматически получит роль Администратор.

Модель ответа

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		string	ID пользователя
	type		string	Тип данных
	attributes		object	Информация о пользователе
		created_at	string	Дата и время создания пользователя
		first_name	string	Имя пользователя
		middle_name	string	Отчество пользователя
		last_name	string	Фамилия пользователя
		status_for_account	string	Статус пользователя в указанном аккаунте: active — Активный inactive — Неактивный.
		role_for_account	string	Уровень доступа в указанном аккаунте (подробнее см. ):
		email	string	Email пользователя, который используется как логин для входа в Панель управления Клиента
		custom_attributes	object	Список пар ключ-значение дополнительных атрибутов пользователя (см. Получение списка атрибутов пользователя )
meta			object	Дополнительная информация
	server_current_time		string	Текущие дата и время сервера

Пример запроса

Bash

curl --location --request PATCH 'https://test.activeplatform.com/internal_api/accounts/1185/users/2479' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \
--data-raw '{
    "data": {
        "attributes": {
            "role" : "admin"
        }
    }
}'

Пример ответа

JSON

{
    "data": {
        "id": "2479",
        "type": "users",
        "attributes": {
            "created_at": "2023-01-05T17:50:18.925604+0300",
            "first_name": "Eloisa",
            "middle_name": "",
            "last_name": "Carroll",
            "status_for_account": "active",
            "role_for_account": "admin",
            "email": "user76@example.com",
            "custom_attributes": null
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}