Sidebar
fr:manual:api:reference:usergroup:get
Table of Contents
usergroup.get
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.
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é. Se référer à la page 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. Se référer à la page 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. Elle a les propriétés suivantes : groupid - (string) ID du groupe d'hôtes ; tag - (string) Nom du tag ; 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. Elle a les propriétés suivantes : permission - (integer) niveau d'accès au groupe d'hôtes ; id - (string) ID du groupe d'hôtes. Se référer à la page 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. 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. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
Valeurs retournées
(integer/array) Retourne soit:
- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre
countOutputa été utilisé.
Exemples
Récupération des groupes d'utilisateurs activés
Récupérer tous les groupes d'utilisateurs activés
Requête :
{ "jsonrpc": "2.0", "method": "usergroup.get", "params": { "output": "extend", "status": 0 }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Réponse :
{ "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 }
Voir également
Source
CUserGroup::get() dans frontends/php/include/classes/api/services/CUserGroup.php.