user.update

説明

object user.update(object/array users)

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

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

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

パラメータ

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

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

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

パラメータ 型 説明
current_passwd string ユーザーの現在のパスワード。

ユーザーが ユーザーディレクトリ に関連付けられている場合、このパラメータの値は空文字列にできます。

パラメータの動作:
- write-only
- User object の passwd が設定され、ユーザーが自身のユーザーパスワードを変更する場合は required
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
}

ユーザーロールの変更

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

リクエスト:

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

レスポンス:

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

参照

ソース

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