user.update

説明

object user.update(object/array users)

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

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

ユーザーパスワードの強度はAuthentication APIによって定義されたパスワードポリシールールに従って検証されます。詳細についてはAuthentication APIを参照してください。

パラメータ

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

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

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

パラメータ	タイプ	説明
passwd	string	ユーザーのパスワードユーザーがLDAPアクセス権を持つグループに属しているまたはLDAPアクセス権を持つグループのみに移動する場合は、空文字にすることができます。
usrgrps	array	ユーザーグループを使用して既存のユーザーグループを置き換えます。ユーザーグループには`usrgrpid`プロパティを定義する必要があります。
medias	array	既存のメディアを置き換えるユーザーメディア

戻り値

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

例

ユーザー名変更

ユーザー名をJohn Doeに変更

Request:

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

Response:

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

ユーザーの役割を変更