user.update

説明

object user.update(object/array users)

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

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

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

パラメーター

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

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

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

パラメーター	タイプ	説明
current_passwd	string	ユーザーの現在のパスワード。このパラメーターの値は、ユーザーがユーザーディレクトリにリンクされている場合、空文字列にすることができます。パラメーターの動作: - write-only - User objectの`passwd`が設定されていて、ユーザー自身がパスワードを変更する場合は必須
usrgrps	array	既存のユーザーグループを置き換えるユーザーグループ。ユーザーグループには`usrgrpid`プロパティのみを定義する必要があります。
medias	array	既存のプロビジョニングされていないメディアを置き換えるユーザーメディア。メディアを更新する際、プロビジョニングされたメディアは省略できます。

戻り値

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

例

ユーザー名の変更

ユーザー名を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
       }

ユーザーロールの変更

ユーザーのロールを変更します。