user.update

Описание

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

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

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

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

Параметры

(object/array) Пользовательские свойства, которые необходимо обновить.

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

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

Parameter Type Description
current_passwd string Текущий пароль пользователя.

Значение этого параметра может быть пустой строкой, если пользователь связан с каталогом пользователей.

Поведение параметра:
- только для записи
- обязательно, если passwd объекта User object задан и пользователь изменяет собственный пароль
usrgrps array Группы пользователей, которые заменят существующие группы пользователей.

Группы пользователей должны иметь определенным только свойство usrgrpid.
medias array Пользовательские способы оповещения, которые заменят существующие, не предоставленные системой способы оповещения. Предоставленные системой способы оповещения можно не указывать при обновлении способов оповещения.

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

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

Примеры

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

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

Запрос:

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

Ответ:

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

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

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

Запрос:

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

Ответ:

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

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

Источник

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