Sidebar

usergroup.update

Description

object usergroup.update(object/array userGroups)

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

Paramètres

(object/array) Groupes 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.

En plus des propriétés du groupe d'utilisateurs standard, la méthode accepte les paramètres suivants.

Paramètre Type Description
rights object/array Permissions en remplacement des permissions actuelles assignées au groupe d'utilisateurs.
tag_filters array Permissions par filtre de tag à assigner au groupe d'utilisateurs.
userids string/array Identifiants des utilisateurs en remplacement des utilisateurs actuels assignés au groupe d'utilisateurs.

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

Source

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