[comment]: # translation:outdated

[comment]: # ({ce8d2bd2-ce8d2bd2})
# usergroup.get

[comment]: # ({/ce8d2bd2-ce8d2bd2})

[comment]: # ({ef79b8a9-ef79b8a9})
### Descripción

`entero/matriz usergroup.get(parámetros de objeto)`

El método permite recuperar grupos de usuarios según los parámetros suministrados.

::: noteclassic
Este método está disponible para usuarios de cualquier tipo. Los permisos para
llamar al método se pueden revocar en la configuración de roles de usuario. Ver [Roles de usuario](/manual/web_interface/frontend_sections/administration/user_roles)
para más información.
:::

[comment]: # ({/ef79b8a9-ef79b8a9})

[comment]: # ({ec24a83b-4be9c06e})
### Parámetros

`(objeto)` Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

|Parámetro|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|status|integer|Devuelve solo grupos de usuarios con el estado dado.<br><br>Consulte la [página del grupo de usuarios](object#user_group) para obtener una lista de los estados admitidos.|
|userids|cadena/matriz|Devuelve solo grupos de usuarios que contengan los usuarios dados.|
|usrgrpids|string/array|Devuelve sólo grupos de usuarios con los ID proporcionados.|
|selectTagFilters|query|Devuelve permisos basados en etiquetas de grupo de usuarios en la propiedad [tag\_filters](/manual/api/reference/usergroup/object#tag_based_permission).<br><br>Tiene las siguientes propiedades:<br>` groupid` - (cadena) ID del grupo de host;<br>`tag` - (cadena) nombre de etiqueta;<br>`value` - (cadena) valor de etiqueta.|
|selectUsers|query|Devuelve los usuarios del grupo de usuarios en la propiedad [usuarios](/manual/api/reference/user/object#user).|
|selectRights|query|Devuelve derechos de grupo de usuarios en la propiedad [rights](/manual/api/reference/usergroup/object#permission).<br><br>Tiene las siguientes propiedades:<br>`permission` - ( entero) nivel de acceso al grupo de hosts;<br>`id` - (cadena) ID del grupo de hosts.<br><br>Consulte la [página del grupo de usuarios](objeto#permiso) para obtener una lista de niveles de acceso para acoger grupos.|
|limitSelects|integer|Limita el número de registros devueltos por subselecciones.|
|sortfield|string/array|Ordena el resultado según las propiedades dadas.<br><br>Los valores posibles son: `usrgrpid`, `name`.|
|countOutput|boolean|Estos parámetros, que son comunes para todos los métodos `get`, se describen detalladamente en el [comentario de referencia](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|booleano|^|
|excluirBuscar|booleano|^|
|filtro|objeto|^|
|límite|entero|^|
|salida|consulta|^|
|preservekeys|booleano|^|
|buscar|objeto|^|
|searchByAny|booleano|^|
|searchWildcardsEnabled|booleano|^|
|clasificación|cadena/matriz|^|
|iniciarBuscar|booleano|^|

[comment]: # ({/ec24a83b-4be9c06e})

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno

`(entero/matriz)` Devuelve:

- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro `countOutput`
    ha sido usado.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Ejemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({a3c99a8f-62cd5d8e})
#### Recuperando grupos de usuarios habilitados

Recupera todos los grupos de usuarios habilitados.

Solicitud:

```json
{
    "jsonrpc": "2.0",
    "method": "usergroup.get",
    "params": {
        "output": "extend",
        "status": 0
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Respuesta:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "usrgrpid": "7",
            "name": "Zabbix administrators",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "1"
        },
        {
            "usrgrpid": "8",
            "name": "Guests",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0"
        },
        {
            "usrgrpid": "11",
            "name": "Enabled debug mode",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "1"
        },
        {
            "usrgrpid": "12",
            "name": "No access to the frontend",
            "gui_access": "2",
            "users_status": "0",
            "debug_mode": "0"
        },
        {
            "usrgrpid": "14",
            "name": "Read only",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0"
        },
        {
            "usrgrpid": "18",
            "name": "Deny",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0"
        }
    ],
    "id": 1
}
```

[comment]: # ({/a3c99a8f-62cd5d8e})

[comment]: # ({039ccba1-039ccba1})
### Ver también

- [Usuario](/manual/api/reference/user/object#user)

[comment]: # ({/039ccba1-039ccba1})

[comment]: # ({e72b2ac9-e72b2ac9})
### Fuente

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

[comment]: # ({/e72b2ac9-e72b2ac9})