[comment]: # translation:outdated

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

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

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

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

Questo metodo consente di recuperare i gruppi di utenti in base ai
parametri specificati.

::: noteclassic
Questo metodo è disponibile per utenti di qualsiasi tipo. I permessi
per chiamare il metodo possono essere revocati nelle impostazioni del ruolo utente. Vedere [User
roles](/manual/web_interface/frontend_sections/users/user_roles)
per ulteriori informazioni.
:::

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

[comment]: # ({5591bd09-4be9c06e})
### Parametri

`(object)` Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

|Parametro|[Tipo](/manual/api/reference_commentary#data-types)|Descrizione|
|--|--|------|
|mfaids|ID/array|Restituisce solo i gruppi utenti con i metodi MFA specificati.<br><br>[Comportamento del parametro](/manual/api/reference_commentary#parameter-behavior):<br>- *supportato* per utenti di tipo *Super admin*|
|mfa_status|integer|Restituisce solo i gruppi utenti con lo stato MFA specificato.<br><br>Fare riferimento alla [pagina del gruppo utenti](object#user-group) per un elenco degli stati supportati.|
|status|integer|Restituisce solo i gruppi utenti con lo stato specificato.<br><br>Fare riferimento alla [pagina del gruppo utenti](object#user-group) per un elenco degli stati supportati.|
|userids|ID/array|Restituisce solo i gruppi utenti che contengono gli utenti specificati.|
|usrgrpids|ID/array|Restituisce solo i gruppi utenti con gli ID specificati.|
|selectTagFilters|query|Restituisce i permessi del gruppo utenti basati sui tag nella proprietà [`tag_filters`](/manual/api/reference/usergroup/object#tag-based-permission).|
|selectUsers|query|Restituisce gli utenti del gruppo utenti nella proprietà [`users`](/manual/api/reference/user/object#user).<br><br>Vedere [`user.get`](/manual/api/reference/user/get) per le restrizioni basate sul tipo di utente.|
|selectHostGroupRights|query|Restituisce i [permessi](/manual/api/reference/usergroup/object#permission) del gruppo utenti sui gruppi host nella proprietà `hostgroup_rights`.<br><br>Fare riferimento alla [pagina del gruppo utenti](object#permission) per un elenco dei livelli di accesso ai gruppi host.|
|selectTemplateGroupRights|query|Restituisce i [permessi](/manual/api/reference/usergroup/object#permission) del gruppo utenti sui gruppi template nella proprietà `templategroup_rights`.<br><br>Fare riferimento alla [pagina del gruppo utenti](object#permission) per un elenco dei livelli di accesso ai gruppi template.|
|limitSelects|integer|Limita il numero di record restituiti dalle sottoquery.|
|output|query|Proprietà dell'[oggetto gruppo utenti](/manual/api/reference/usergroup/object) da restituire.<br><br>Gli utenti di tipo *Admin* e *User* possono recuperare solo le seguenti proprietà: `usrgrpid`, `name`, `gui_access`, `users_status`, `debug_mode`, `mfa_status`.<br><br>Predefinito: `extend`.|
|sortfield|string/array|Ordina il risultato in base alle proprietà specificate.<br><br>Valori possibili: `usrgrpid`, `name`.|
|countOutput|boolean|Questi parametri sono descritti nel [commento di riferimento](/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})
### Valori restituiti

`(integer/array)` Restituisce o:

- una matrice di oggetti;
- il conteggio degli oggetti recuperati, se il parametro `countOutput` è
    stato usato.

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

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

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

[comment]: # ({e685bea9-62cd5d8e})
#### Recupero dei gruppi utenti abilitati

Recupera tutti i gruppi utenti abilitati.

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

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

Risposta:

```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})
### Guarda anche

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

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

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

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

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