role.update

Beschreibung

object role.update(object/array roles)

Diese Methode ermöglicht die Aktualisierung bestehender Rollen.

Diese Methode ist nur für den Benutzertyp Super admin verfügbar. Die Berechtigung zum Aufrufen der Methode kann in den Einstellungen der Benutzerrolle entzogen werden. Siehe Benutzerrollen für weitere Informationen.

Parameter

(object/array) Zu aktualisierende Rolleneigenschaften.

Die Eigenschaft roleid muss für jede Rolle definiert werden, alle anderen Eigenschaften sind optional. Nur die übergebenen Eigenschaften werden aktualisiert, alle anderen bleiben unverändert.

Zusätzlich zu den Standard-Rolleneigenschaften akzeptiert die Methode die folgenden Parameter.

Parameter Type Beschreibung
rules array Zugriffs-Regeln, die für die Rolle aktualisiert werden sollen.

Rückgabewerte

(object) Gibt ein Objekt zurück, das die IDs der aktualisierten Rollen unter der Eigenschaft roleids enthält.

Beispiele

Deaktivieren der Möglichkeit, Skripte auszuführen

Aktualisieren Sie die Rolle mit der ID „5“ und deaktivieren Sie die Möglichkeit, Skripte auszuführen.

Anfrage:

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

Antwort:

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

Zugriff auf die API einschränken

Aktualisieren Sie die Rolle mit der ID „5“ und verweigern Sie den Aufruf aller Methoden „create“, „update“ oder „delete“.

Anfrage:

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

Antwort:

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

Quelle

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