user.get

Description

integer/array user.get(object parameters)

La méthode permet de récupérer des 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
mediaids	string/array	Renvoie uniquement les utilisateurs qui utilisent le média donné.
mediatypeids	string/array	Renvoie uniquement les utilisateurs qui utilisent les types de média donnés.
userids	string/array	Renvoie uniquement les utilisateurs avec les identifiants donnés.
usrgrpids	string/array	Renvoie uniquement les utilisateurs appartenant aux groupes d'utilisateurs donnés.
getAccess	flag	Ajoute des informations supplémentaires sur les autorisations des utilisateurs. Ajoute les propriétés suivantes pour chaque utilisateur : `gui_access` - (integer) méthode d'authentification frontale de l'utilisateur. Reportez-vous à la propriété `gui_access` de l'objet groupe d'utilisateurs pour obtenir une liste des valeurs possibles. `debug_mode` - (integer) indique si le mode debug est activé pour l'utilisateur. Valeurs possibles : 0 - debug désactivé, 1 - debug activé. `users_status` - (integer) indique si l'utilisateur est désactivé. Valeurs possibles : 0 - utilisateur activé, 1 - utilisateur désactivé.
selectMedias	query	Renvoie le média utilisé par l'utilisateur dans la propriété `medias`.
selectMediatypes	query	Renvoie les types de média utilisés par l'utilisateur dans la propriété `mediatypes`.
selectUsrgrps	query	Renvoie les groupes d'utilisateurs auxquels l'utilisateur appartient dans la propriété `usrgrps`.
sortfield	string/array	Trie le résultat par les propriétés données. Les valeurs possibles sont : `userid` et `alias`.
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 countOutput a été utilisé.

Exemples

Récupération d'utilisateurs

Récupération de tous les utilisateurs configurés.

Requête :

{
           "jsonrpc": "2.0",
           "method": "user.get",
           "params": {
               "output": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "userid": "1",
                   "alias": "Admin",
                   "name": "Zabbix",
                   "surname": "Administrator",
                   "url": "",
                   "autologin": "1",
                   "autologout": "0s",
                   "lang": "ru_RU",
                   "refresh": "0s",
                   "type": "3",
                   "theme": "default",
                   "attempt_failed": "0",
                   "attempt_ip": "",
                   "attempt_clock": "0",
                   "rows_per_page": "50"
               },
               {
                   "userid": "2",
                   "alias": "guest",
                   "name": "Default2",
                   "surname": "User",
                   "url": "",
                   "autologin": "0",
                   "autologout": "15m",
                   "lang": "en_GB",
                   "refresh": "30s",
                   "type": "1",
                   "theme": "default",
                   "attempt_failed": "0",
                   "attempt_ip": "",
                   "attempt_clock": "0",
                   "rows_per_page": "50"
               }
           ],
           "id": 1
       }

Voir également

Source

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

Documentation