role.update

説明

object role.update(object/array roles)

このメソッドでは、既存のロールを更新できます。

パラメータ

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

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

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

戻り値

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

例

スクリプト実行機能の無効化

ID が "5" のロールを更新し、スクリプトを実行する機能を無効にします。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "role.update",
    "params": [
        {
            "roleid": "5",
            "rules": {
                "actions": [
                    {
                        "name": "execute_scripts",
                        "status": "0"
                    }
                ]
            }
        }
    ],
    "id": 1
}

レスポンス:

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

APIへのアクセス制限

ID「5」のロールを更新し、任意の「create」、「update」、または「delete」メソッドの呼び出しを拒否します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "role.update",
    "params": [
        {
            "roleid": "5",
            "rules": {
                "api.access": "1",
                "api.mode": "0",
                "api": ["*.create", "*.update", "*.delete"]
            }
        }
    ],
    "id": 1
}

レスポンス:

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

ソース

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