userdirectory.update

説明

object userdirectory.update(object/array userDirectory)

このメソッドは、既存のユーザーディレクトリを更新することができます。

パラメーター

(object/array) 更新するユーザーディレクトリのプロパティ。

userdirectoryidプロパティは各ユーザーディレクトリに対して定義する必要があり、その他のプロパティはオプションです。 渡されたプロパティのみが更新され、他は一切変更されません。

戻り値

(object) userdirectoryidsプロパティの下にある更新されたユーザーディレクトリのIDを含むオブジェクトを返します。

例

ユーザーディレクトリのバインドパスワードの更新

ユーザーディレクトリの新しいバインドパスワードを設定します。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "userdirectory.update",
    "params": {
        "userdirectoryid": "3",
        "bind_password": "newldappassword"
    },
    "id": 1
}

レスポンス :

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

ユーザーディレクトリのマッピングの更新

ユーザーディレクトリ"2"のプロビジョニンググループマッピングとメディアタイプマッピングを更新します。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "userdirectory.update",
    "params": {
        "userdirectoryid": "2",
        "provision_media": [
                {
                    "userdirectory_mediaid": "2"
                }
            ],
            "provision_groups": [
                {
                    "name": "Zabbix administrators",
                    "roleid": "2",
                    "user_groups": [
                        {
                            "usrgrpid": "7"
                        },
                        {
                            "usrgrpid": "8"
                        },
                        {
                            "usrgrpid": "11"
                        }
                    ]
                }
            ]
    },
    "id": 1
}

レスポンス :

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

ソース

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