[comment]: # translation:outdated

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

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

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

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

El mètode permet recuperar grups d'usuaris segons els paràmetres proveïts.

::: noteclassic
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu [Rols d'usuari](/manual/web_interface/frontend_sections/users/user_roles).
:::

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

[comment]: # ({47e05e15-4be9c06e})
### Paràmetres

`(object)` Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

|Paràmetre|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|mfaids|ID/array|Retorna només els grups d'usuaris amb els mètodes MFA donats.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#parameter-behavior):<br>- *admès* per a usuaris de tipus *Super admin*|
|mfa_status|integer|Retorna només els grups d'usuaris amb l'estat MFA donat.<br><br>Veieu la [pàgina de grups d'usuaris](object#user_group) per tindre una llista d'estats admesos.|
|status|integer|Retorna només els grups d'usuaris amb l'estat donat.<br><br>Consulteu la pàgina de [grup d'usuaris](object#user_group) per obtindre una llista d'estats admesos.
|userids|ID/array|Retorna només els grups d'usuaris que contenen els usuaris especificats.|
|usrgrpids|ID/array|Retorna només els grups d'usuaris amb els ID donats.|
|selectTagFilters|query|Retorna els permisos basats en etiquetes de grup d'usuaris a la propietat [`tag_filters`](/manual/api/reference/usergroup/object#tag_based_permission).|
|selectUsers|query|Retorna els usuaris del grup d'usuaris a la propietat [`users`](/manual/api/reference/user/object#user).|
|selectHostGroupRights|query|Retorna els permisos del grup d'usuaris del grup de [permisos](/manual/api/reference/usergroup/object#permission) a la propietat `hostgroup_rights`.<br><br>Consulteu [pàgina del grup d'usuaris](object#permission) per obtindre una llista dels nivells d'accés del grup d'equips.|
|selectTemplateGroupRights|query|Retorna els permisos del grup de [permisos](/manual/api/reference/usergroup/object#permission) a la propietat `templategroup_rights`.<br><br>Consulteu la [pàgina del grup d'usuaris](object#permission) per obtindre una llista dels nivells d'accés del grup de plantilles.|
|limitSelects|integer|Limita el nombre de registres retornats per subseleccions.|
|output|query|Propietats de l'[objecte grup d'usuaris](/manual/api/reference/usergroup/object) que han de retornar.<br><br>Els usuaris de tipus *Admin* i *User* només poden recuperar les propietats següents: `usrgrpid`, `name`, `gui_access`debu`, `us`access`debu` `mfa_status`.<br><br>Per defecte: `extend`.|
|sortfield|string/array|Ordena el resultat segons les propietats donades.<br><br>Els valors possibles són: `usrgrpid`, `name`.|
|countOutput|boolean|Aquests paràmetres es descriuen en detall a la pàgina [comentaris de referència](/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]: # ({/47e05e15-4be9c06e})

[comment]: # ({7223bab1-7223bab1})
### Valors de retorn

`(integer/array)` Retorna un d'entre:

-   una taula d'objectes;
-   el recompte d'objectes recuperats, si s'empra el paràmetre `countOutput`.

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

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

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

[comment]: # ({e685bea9-62cd5d8e})
#### Recuperar els grups d'usuaris actius

Recupera tots els grups d'usuaris actius.

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

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

Resposta:

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

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

[comment]: # ({039ccba1-039ccba1})
### Veieu també

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

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

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

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

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