user.update

Описание

object user.update(объект/массив users)

Этот метод позволяет обновлять существующих пользователей.

Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Сложность пароля пользователя проверяется в соответствии с правилами политики паролей, определенными API аутентификации. Подробнее см. в API аутентификации.

Параметры

(объект/массив) Свойства пользователей, которые будут обновлены.

Свойство userid должно быть указано по каждому пользователю, все остальные свойства опциональны. Будут обновлены только переданные свойства, все остальные останутся неизменными.

В дополнение к стандартным свойствам пользователя, этот метод принимает следующие параметры.

Параметр Тип Описание
passwd строка Пароль пользователя.
usrgrps массив Группы пользователей, которые заменят существующие группы пользователей.

У групп пользователей должно быть задано свойство usrgrpid.
user_medias массив Оповещения, которые заменят текущие оповещения пользователя.

Возвращаемые значения

(объект) Возвращает объект, который содержит ID обновленных пользователей, указанных в свойствеuserids.

Примеры

Переименование пользователя

Переименовать пользователя в John Doe.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "user.update",
    "params": {
        "userid": "1",
        "name": "John",
        "surname": "Doe"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "userids": [
            "1"
        ]
    },
    "id": 1
}

Изменение роли пользователя

Изменить роль пользователя.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "user.update",
    "params": {
        "userid": "12",
        "roleid": "6"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "userids": [
            "12"
        ]
    },
    "id": 1
}

Смотрите также

Источник

CUser::update() в ui/include/classes/api/services/CUser.php.