role.create

説明

object role.create(object/array roles)

このメソッドは新しいロールを作成します。

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

パラメータ

(object/array) 作成するロール。

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

パラメータ タイプ 説明
rules array ロールに作成するロールルール

戻り値

(object) roleidsプロパティの下に作成されたロールのIDを含むオブジェクトを返します。 返されるIDの順序は、渡されたロールの順序と一致します。

ロールの作成

タイプ「User」で2つのUI要素へのアクセスを拒否したロールを作成します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "role.create",
    "params": {
        "name": "Operator",
        "type": "1",
        "rules": {
            "ui": [
                {
                    "name": "monitoring.hosts",
                    "status": "0"
                },
                {
                    "name": "monitoring.maps",
                    "status": "0"
                }
            ]
        }
    },
    "id": 1
}

レスポンス:

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

参照

ソース

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