[comment]: # translation:outdated

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

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

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

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

La méthode permet de récupérer des groupes d’utilisateurs selon les paramètres donnés.

::: noteclassic
Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir [User
roles](/manual/web_interface/frontend_sections/users/user_roles)
pour plus d’informations.
:::

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

[comment]: # ({5591bd09-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|
|--|--|------|
|mfaids|ID/array|Retourne uniquement les groupes d'utilisateurs avec les méthodes MFA indiquées.<br><br>[Comportement des paramètres](/manual/api/reference_commentary#parameter-behavior) :<br>- *pris en charge* pour les utilisateurs de type *Super admin*|
|mfa_status|integer|Retourne uniquement les groupes d'utilisateurs avec l'état MFA indiqué.<br><br>Consultez la [page des groupes d'utilisateurs](object#user-group) pour obtenir la liste des états pris en charge.|
|status|integer|Retourne uniquement les groupes d'utilisateurs avec l'état indiqué.<br><br>Consultez la [page des groupes d'utilisateurs](object#user-group) pour obtenir la liste des états pris en charge.|
|userids|ID/array|Retourne uniquement les groupes d'utilisateurs qui contiennent les utilisateurs indiqués.|
|usrgrpids|ID/array|Retourne uniquement les groupes d'utilisateurs avec les ID indiqués.|
|selectTagFilters|query|Retourne les autorisations basées sur les tags du groupe d'utilisateurs dans la propriété [`tag_filters`](/manual/api/reference/usergroup/object#tag-based-permission).|
|selectUsers|query|Retourne les utilisateurs du groupe d'utilisateurs dans la propriété [`users`](/manual/api/reference/user/object#user).<br><br>Voir [`user.get`](/manual/api/reference/user/get) pour les restrictions selon le type d'utilisateur.|
|selectHostGroupRights|query|Retourne les [autorisations](/manual/api/reference/usergroup/object#permission) du groupe d'utilisateurs sur les groupes d'hôtes dans la propriété `hostgroup_rights`.<br><br>Consultez la [page des groupes d'utilisateurs](object#permission) pour obtenir la liste des niveaux d'accès aux groupes d'hôtes.|
|selectTemplateGroupRights|query|Retourne les [autorisations](/manual/api/reference/usergroup/object#permission) du groupe d'utilisateurs sur les groupes de modèles dans la propriété `templategroup_rights`.<br><br>Consultez la [page des groupes d'utilisateurs](object#permission) pour obtenir la liste des niveaux d'accès aux groupes de modèles.|
|limitSelects|integer|Limite le nombre d'enregistrements renvoyés par les sous-sélections.|
|output|query|Propriétés de l'[objet groupe d'utilisateurs](/manual/api/reference/usergroup/object) à renvoyer.<br><br>Les utilisateurs de type *Admin* et *User* peuvent récupérer uniquement les propriétés suivantes : `usrgrpid`, `name`, `gui_access`, `users_status`, `debug_mode`, `mfa_status`.<br><br>Par défaut : `extend`.|
|sortfield|string/array|Trie le résultat selon les propriétés indiquées.<br><br>Valeurs possibles : `usrgrpid`, `name`.|
|countOutput|boolean|Ces paramètres sont décrits dans le [commentaire de référence](/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})
### 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]: # ({e685bea9-62cd5d8e})
#### Récupération des groupes d'utilisateurs activés

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

[Requête](/manual/api#performing-requests):

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

Réponse :

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