usergroup.update

Description

object usergroup.update(object/array userGroups)

Cette méthode permet de mettre à jour les groupes d'utilisateurs existants.

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

Paramètres

(object/array) Propriétés du groupe d'utilisateurs à mettre à jour.

La propriété usrgrpid doit être définie pour chaque groupe d'utilisateurs, toutes les autres propriétés sont facultatives. Seules les propriétés transmises seront mises à jour, toutes les autres resteront inchangées.

Additionally to the standard user group properties, the method accepts the following parameters.

Paramètre	Type	Description
rights	object/array	Autorisations en remplacement des autorisations actuellement assignées au groupe.
tag_filters	array	Autorisations basées sur les balises à assigner au groupe.
users	object/array	Utilisateurs à ajouter au groupe. L'utilisateur doit avoir la propriété `userid` définie.

Valeurs retournées

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

Exemples

Désactivation d'un groupe d'utilisateurs

Désactiver un groupe d'utilisateurs.

Requête :

{
           "jsonrpc": "2.0",
           "method": "usergroup.update",
           "params": {
               "usrgrpid": "17",
               "users_status": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

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

Voir également

Autorisation

Source

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

Documentation