usergroup.delete

Description

object usergroup.delete(array userGroupIds)

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

Le groupe d'utilisateurs des utilisateurs déprovisionnés (le groupe d'utilisateurs spécifié pour disabled_usrgrpid dans Authentication) ne peut pas être supprimé.

Cette méthode est uniquement disponible pour le type d'utilisateur Super admin. Les autorisations d'appeler cette méthode peuvent être révoquées dans les paramètres des rôles utilisateur. Consultez Rôles utilisateur pour plus d'informations.

Paramètres

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

Valeurs de retour

(object) Renvoie un objet contenant les ID des groupes d’utilisateurs supprimés dans la propriété usrgrpids.

Exemples

Suppression de plusieurs groupes d'utilisateurs

Supprimez deux groupes d'utilisateurs.

Requête:

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

Réponse :

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

Source

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