usergroup.update

Descripción

object usergroup.update(object/array userGroups)

Este método permite actualizar grupos de usuarios existentes.

Este método solo está disponible para el tipo de usuario Superadministrador. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para obtener más información.

Parameters

(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.

Valores de retorno

(objeto) Devuelve un objeto que contiene los ID de los grupos de usuario actualizados bajo la propiedad usrgrpids.

Ejemplos

Disabling a user group

Disable a user group.

Request:

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

Response:

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

Ver también

Permiso

Fuente

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

Documentation