role.update

Description

object role.update(object/array roles)

Cette méthode permet de mettre à jour des rôles existants.

Cette méthode est disponible uniquement pour le type d’utilisateur Super admin. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles pour plus d’informations.

Paramètres

(object/array) Propriétés du rôle à mettre à jour.

La propriété roleid doit être définie pour chaque rôle, toutes les autres propriétés sont facultatives. Seules les propriétés transmises seront mises à jour, toutes les autres resteront inchangées.

En plus des propriétés de rôle standard, la méthode accepte les paramètres suivants.

Paramètre Type Description
rules array Règles d’accès à mettre à jour pour le rôle.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des rôles mis à jour sous la propriété roleids.

Exemples

Désactivation de la possibilité d’exécuter des scripts

Mettez à jour le rôle avec l’ID « 5 » afin de désactiver la possibilité d’exécuter des scripts.

Requête:

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

Réponse :

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

Limitation de l'accès à l'API

Mettez à jour le rôle avec l'ID « 5 » afin d'interdire l'appel de toutes les méthodes « create », « update » ou « delete ».

Requête:

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

Réponse :

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

Source

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