role.update

説明

object role.update(object/array roles)

このメソッドは、既存のロールを更新するためのものです。

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

パラメーター

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

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

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

パラメーター	型	説明
rules	array	ロールに対して更新するアクセスルール。

戻り値

(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"メソッドの呼び出しを拒否します。