[comment]: # translation:outdated

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

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

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

::: noteclassic
Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir [Rôles Utilisateur](/manual/web_interface/frontend_sections/administration/user_roles) pour plus d'informations.
:::

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

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

### Paramètres

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

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

|Paramètre|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|status|integer|Renvoie uniquement les groupes d'utilisateurs avec le statut donné.<br><br>Reportez-vous à la [page du groupe d'utilisateurs](object#user_group) pour une liste des statuts pris en charge.|
|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 ID donnés.|
|selectTagFilters|query|Renvoie les autorisations basées sur les tags de groupe d'utilisateurs dans la propriété [tag\_filters](/manual/api/reference/usergroup/object#tag_based_permission).<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` - valeur du tag (string).|
|selectUsers|query|Renvoie les utilisateurs du groupe d'utilisateurs dans la propriété [users](/manual/api/reference/user/object#user).|
|selectRights|query|Renvoie les droits du groupe d'utilisateurs dans la propriété [rights](/manual/api/reference/usergroup/object#permission).<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>Reportez-vous à la [page groupe d'utilisateurs](object#permission) pour obtenir une liste des niveaux d'accès aux groupes d'hôtes.|
|limitSelects|integer|Limite le nombre d'enregistrements renvoyés par les sous-sélections.|
|sortfield|string/array|Trie le résultat selon les propriétés données.<br><br>Les valeurs possibles sont : `usrgrpid`, `name`.|
|countOutput|boolean|Ces paramètres communs à toutes les méthodes `get` sont décrits en détail dans la page de [commentaire de référence](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

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

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

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

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

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

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

Requête :

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

Réponse :

```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})
### Voir également

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

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

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

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

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