usergroup.delete

Description

object usergroup.delete(array userGroupIds)

Cette méthode permet de supprimer des groupes d'utilisateurs.

Cette méthode est disponible uniquement pour les utilisateurs de type Super admin. Les autorisations d'appel de la méthode peuvent être révoquées dans les réglages du rôle d'utilisateur. Voir les Rôles utilisateur pour plus d'informations.

Paramètres

(array) ID des groupes d'utilisateurs à supprimer.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des groupes d'utilisateurs supprimés sous la propriété usrgrpids.

Exemples

Suppression de plusieurs groupes d'utilisateurs

Supprimer deux groupes d'utilisateurs

Requête :

{
    "jsonrpc": "2.0",
    "method": "usergroup.delete",
    "params": [
        "20",
        "21"
    ],
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": {
        "usrgrpids": [
            "20",
            "21"
        ]
    },
    "id": 1
}

Source

CUserGroup::delete() dans ui/include/classes/api/services/CUserGroup.php.