[comment]: # translation:outdated

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

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

[comment]: # ({2e6169a9-dbc24bad})
### 説明

`object user.update(object/array users)`

このメソッドでは既存のユーザーを更新できます

::: noteclassic
このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくは[ユーザーの役割](/manual/web_interface/frontend_sections/administration/user_roles)を参照してください。
:::

::: noteclassic
ユーザーパスワードの強度はAuthentication APIによって定義されたパスワードポリシールールに従って検証されます。 詳細については[Authentication API](/manual/api/reference/authentication)を参照してください。
:::

[comment]: # ({/2e6169a9-dbc24bad})

[comment]: # ({32788830-3b478f18})
### パラメータ

`(object/array)` 更新するユーザープロパティ

`userid`プロパティはユーザーごとに定義する必要があり、すべてのプロパティはオプションです。 渡されたプロパティのみが更新され、他のプロパティは変更されません。

このメソッドは[標準ユーザープロパティ](object#user)に加えて、次のパラメーターを受け入れます。

|パラメータ|[タイプ](/manual/api/reference_commentary#data_types)|説明|
|--|--|------|
|passwd|string|ユーザーのパスワード<br><br>ユーザーがLDAPアクセス権を持つグループに属しているまたはLDAPアクセス権を持つグループのみに移動する場合は、空文字にすることができます。|
|usrgrps|array|ユーザー[グループ](/manual/api/reference/user/create)を使用して既存のユーザーグループを置き換えます。<br> <br>ユーザーグループには`usrgrpid`プロパティを定義する必要があります。|
|medias|array|既存のメディアを置き換える[ユーザーメディア](/manual/api/reference/user/object#media)|

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

[comment]: # ({4c3fb877-4c3fb877})
### 戻り値

`(object)` `userids`プロパティの下で更新されたユーザーのIDを含むオブジェクトを返します。

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

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

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

[comment]: # ({c1f963ff-c0483e48})
#### ユーザー名変更

ユーザー名をJohn Doeに変更

Request:

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

Response:

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

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

[comment]: # ({f2705800-7ae4c491})
#### ユーザーの役割を変更

ユーザーの役割を変更

Request:

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

Response:

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

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

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

-   [Authentication](/manual/api/reference/authentication)

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

[comment]: # ({bbd5a07f-bbd5a07f})
### ソース

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

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