user.update

Описание

объект user.update(объект/массив пользователи)

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

Параметры

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

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

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

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

У групп пользователей должно быть задано свойство usrgrpid.

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

(объект) Возвращает объект, который содержит 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 }

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

Исходный код

CUser::update() в frontends/php/api/classes/CUser.php.