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

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

[comment]: # ({53e872d8-61aaa2ea})
### Description

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

La méthode permet de récupérer des groupes d'utilisateurs en fonction
des paramètres donnés.

[comment]: # ({/53e872d8-61aaa2ea})

[comment]: # ({c278a88c-4570df35})
### Paramètres

`(object)` Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

|Paramètre|Type|Description|
|----------|----|-----------|
|status|integer|Renvoie uniquement les groupes d'utilisateurs ayant le statut donné.<br><br>Se référer à la [page groupe d'utilisateurs](/fr/manual/api/reference/usergroup/object#groupe_d_utilisateurs) pour la liste des statuts supportés.|
|userids|string/array|Renvoie uniquement les groupes d'utilisateurs contenant les utilisateurs donnés.|
|usrgrpids|string/array|Renvoie uniquement les groupes d'utilisateurs avec les identifiants donnés.|
|with\_gui\_access|integer|Renvoie uniquement les groupes d'utilisateurs avec la méthode d'authentification à l'interface donnée.<br><br>Se référer à la [page groupe d'utilisateurs](/fr/manual/api/reference/usergroup/object#groupe_d_utilisateurs) pour la liste des méthodes supportés.|
|selectTagFilters|query|Renvoie uniquement les groupes d'utilisateurs avec les autorisations basées sur les filtres de tag dans la propriété `tag_filters`.<br><br>Elle a les propriétés suivantes :<br>`groupid` - (string) ID du groupe d'hôtes ;<br>`tag` - (string) Nom du tag ;<br>`value` - (string) Valeur du tag.|
|selectUsers|query|Renvoie les utilisateurs du groupe d'utilisateurs dans la propriété `users`.|
|selectRights|query|Renvoie les droits du groupe d'utilisateurs dans la propriété `rights`.<br><br>Elle a les propriétés suivantes :<br>`permission` - (integer) niveau d'accès au groupe d'hôtes ;<br>`id` - (string) ID du groupe d'hôtes.<br><br>Se référer à la [page groupe d'utilisateurs](/fr/manual/api/reference/usergroup/object#groupe_d_utilisateurs) pour la liste des niveaux d'accès aux groupes d'hôtes.|
|limitSelects|integer|Limite le nombre d'enregistrements renvoyés par les sous-requêtes.|
|sortfield|string/array|Trie le résultat en fonction des propriétés données.<br><br>Valeurs possibles : `usrgrpid`, `name`.|
|countOutput|boolean|Ces paramètres, communs à toutes les méthodes "get", sont décrits dans les [commentaires de référence](/fr/manual/api/reference_commentary#Parametres_communs_de_la_methode_get).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/c278a88c-4570df35})

[comment]: # ({83f7357a-7223bab1})
### Valeurs retournées

`(integer/array)` Retourne soit:

-   un tableau d'objets ;
-   le nombre d'objets récupérés, si le paramètre `countOutput` a été
    utilisé.

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

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

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

[comment]: # ({cf5b8e7a-62cd5d8e})
#### Récupération des groupes d'utilisateurs activés

Récupérer tous les groupes d'utilisateurs activés

Requête :

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

Réponse :

``` {.java}
{
    "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]: # ({/cf5b8e7a-62cd5d8e})

[comment]: # ({d9427eee-039ccba1})
### Voir également

-   [Utilisateur](/fr/manual/api/reference/user/object#utilisateur)

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

[comment]: # ({8fed4018-26102450})
### Source

CUserGroup::get() dans
*frontends/php/include/classes/api/services/CUserGroup.php*.

[comment]: # ({/8fed4018-26102450})