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

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

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

`integer/array usergroup.get(object parameters)`

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

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

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

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

`(object)` 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|
|--|--|------|
|mfaids|ID/array|Devolver solo los grupos de usuarios con los métodos MFA indicados.<br><br>[Comportamiento del parámetro](/manual/api/reference_commentary#parameter-behavior):<br>- *admitido* para usuarios de tipo *Super admin*|
|mfa_status|integer|Devolver solo los grupos de usuarios con el estado MFA indicado.<br><br>Consulte la [página de grupo de usuarios](object#user-group) para ver la lista de estados admitidos.|
|status|integer|Devolver solo los grupos de usuarios con el estado indicado.<br><br>Consulte la [página de grupo de usuarios](object#user-group) para ver la lista de estados admitidos.|
|userids|ID/array|Devolver solo los grupos de usuarios que contienen los usuarios indicados.|
|usrgrpids|ID/array|Devolver solo los grupos de usuarios con los IDs indicados.|
|selectTagFilters|query|Devolver los permisos basados en etiquetas del grupo de usuarios en la propiedad [`tag_filters`](/manual/api/reference/usergroup/object#tag-based-permission).|
|selectUsers|query|Devolver los usuarios del grupo de usuarios en la propiedad [`users`](/manual/api/reference/user/object#user).<br><br>Consulte [`user.get`](/manual/api/reference/user/get) para conocer las restricciones según el tipo de usuario.|
|selectHostGroupRights|query|Devolver los [permisos](/manual/api/reference/usergroup/object#permission) del grupo de usuarios sobre los grupos de hosts en la propiedad `hostgroup_rights`.<br><br>Consulte la [página de grupo de usuarios](object#permission) para ver la lista de niveles de acceso a los grupos de hosts.|
|selectTemplateGroupRights|query|Devolver los [permisos](/manual/api/reference/usergroup/object#permission) del grupo de usuarios sobre los grupos de templates en la propiedad `templategroup_rights`.<br><br>Consulte la [página de grupo de usuarios](object#permission) para ver la lista de niveles de acceso a los grupos de templates.|
|limitSelects|integer|Limita el número de registros devueltos por subconsultas.|
|output|query|Propiedades del [objeto grupo de usuarios](/manual/api/reference/usergroup/object) que se devolverán.<br><br>Los usuarios de tipo *Admin* y *User* solo pueden recuperar las siguientes propiedades: `usrgrpid`, `name`, `gui_access`, `users_status`, `debug_mode`, `mfa_status`.<br><br>Por defecto: `extend`.|
|sortfield|string/array|Ordenar el resultado por las propiedades indicadas.<br><br>Valores posibles: `usrgrpid`, `name`.|
|countOutput|boolean|Estos parámetros se describen en el [comentario de referencia](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/5591bd09-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]: # ({e685bea9-62cd5d8e})
#### Recuperando grupos de usuarios habilitados

Recupera todos los grupos de usuarios habilitados.

[Solicitud](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "método": "usergroup.get",
    "parámetros": {
        "salida": "extender",
        "estado": 0
    },
    "identificación": 1
}
```

Respuesta:

```json
{
    "jsonrpc": "2.0",
    "resultado": [
        {
            "usrgrpid": "7",
            "name": "Administradores de Zabbix",
            "gui_access": "0",
            "usuarios_status": "0",
            "debug_mode": "1",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "8",
            "nombre": "Invitados",
            "gui_access": "0",
            "usuarios_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "11",
            "name": "Modo de depuración habilitado",
            "gui_access": "0",
            "usuarios_status": "0",
            "debug_mode": "1",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "12",
            "name": "No hay acceso al frontend",
            "gui_access": "2",
            "usuarios_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "14",
            "nombre": "Solo lectura",
            "gui_access": "0",
            "usuarios_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "18",
            "nombre": "Denegar",
            "gui_access": "0",
            "usuarios_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        }
    ],
    "identificación": 1
}
```

[comment]: # ({/e685bea9-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})