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.

Parámetros

(object/array) Propiedades del grupo de usuarios que se van a actualizar.

La propiedad usrgrpid debe estar definida para cada grupo de usuarios, todas las demás propiedades son opcionales. Sólo se actualizarán las propiedades pasadas, todas las demás permanecerán sin cambios.

Además de las propiedades estándar del grupo de usuarios, el método acepta los siguientes parámetros.

Parámetro Tipo Descripción
hostgroup_rights object/array Permisos de grupo de host para reemplazar los permisos actuales asignados al grupo de usuarios.
templategroup_rights object/array Permisos de grupo de template para reemplazar los permisos actuales asignados al grupo de usuarios.
tag_filters array Permisos basados en etiquetas para reemplazar los permisos actuales asignados al grupo de usuarios.
users object/array Usuarios para reemplazar los usuarios actuales asignados al grupo de usuarios.

El usuario debe tener definida sólo la propiedad userid.

Valores de retorno

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

Ejemplos

Habilitar un grupo de usuarios y actualizar permisos

Habilite un grupo de usuarios y proporciónele acceso de lectura y escritura para alojar los grupos "2" y "4".

Solicitud:

{
    "jsonrpc": "2.0",
    "method": "usergroup.update",
    "params": {
        "usrgrpid": "17",
        "users_status": "0",
        "hostgroup_rights": [
            {
                "id": "2",
                "permission": 3
            },
            {
                "id": "4",
                "permission": 3
            }
        ]
    },
    "id": 1
}

Respuesta:

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

Ver también

Fuente

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