This is a translation of the original English documentation page. Help us make it better.



object usergroup.update(object/array userGroups)

This method allows to update existing user groups.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.


(object/array) User group properties to be updated.

The usrgrpid property must be defined for each user group, all other properties are optional. Only the passed properties will be updated, all others will remain unchanged.

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

Parameter Type Description
rights object/array Permissions to replace the current permissions assigned to the user group.
tag_filters array Tag based permissions to assign to the group.
users object/array Users to add to the user group.

The user must have the userid property defined.

Restituisce valori

"(object)" Restituisce un oggetto contenente gli ID dell'utente aggiornato gruppi sotto la proprietà usrgrids.


Disabling a user group

Disable a user group.


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


           "jsonrpc": "2.0",
           "result": {
               "usrgrpids": [
           "id": 1

Guarda anche


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