[comment]: # ({084d9051-084d9051})
# user.update

[comment]: # ({/084d9051-084d9051})

[comment]: # ({131691fb-dbc24bad})
### Описание

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

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

::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles).
:::

::: noteclassic
Сложность пароля пользователя проверяется в соответствии с правилами политики паролей, определенными API аутентификации. Подробнее см. в [API аутентификации](/manual/api/reference/authentication).
:::

[comment]: # ({/131691fb-dbc24bad})

[comment]: # ({7e3aeefe-3b478f18})
### Параметры

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

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

Кроме [стандартных пользовательских свойств](object#user), метод
принимает следующие параметры.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|current_passwd|string|Текущий пароль пользователя.<br><br>Значение этого параметра может быть пустой строкой, если пользователь связан с [каталогом пользователей](/manual/api/reference/userdirectory/object).<br><br>[Поведение параметра](/manual/api/reference_commentary#parameter-behavior):<br>- *только для записи*<br>- *обязательно*, если `passwd` объекта [User object](object#user) задан и пользователь изменяет собственный пароль|
|usrgrps|array|[Группы пользователей](/manual/api/reference/usergroup/object#user-group), которые заменят существующие группы пользователей.<br><br>Группы пользователей должны иметь определенным только свойство `usrgrpid`.|
|medias|array|[Пользовательские способы оповещения](/manual/api/reference/user/object#media), которые заменят существующие, не предоставленные системой способы оповещения. Предоставленные системой способы оповещения можно не указывать при обновлении способов оповещения.|

[comment]: # ({/7e3aeefe-3b478f18})

[comment]: # ({4c3fb877-4c3fb877})
### Возвращаемые значения

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

[comment]: # ({/4c3fb877-4c3fb877})

[comment]: # ({b41637d2-b41637d2})
### Примеры

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({9e930c76-c0483e48})
#### Переименование пользователя

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

[Запрос](/manual/api#performing-requests):

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

Ответ:

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

[comment]: # ({/9e930c76-c0483e48})

[comment]: # ({d54d987f-7ae4c491})
#### Изменение роли пользователя

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

[Запрос](/manual/api#performing-requests):

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

Ответ:

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

[comment]: # ({/d54d987f-7ae4c491})

[comment]: # ({1083dc26-1083dc26})
### Смотрите также

-   [Аутентификация](/manual/api/reference/authentication)

[comment]: # ({/1083dc26-1083dc26})

[comment]: # ({bbd5a07f-bbd5a07f})
### Источник

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

[comment]: # ({/bbd5a07f-bbd5a07f})