Documentation
Table of Contents
user.get
Description
integer/array user.get(object parameters)
La méthode permet de récupérer les utilisateurs en fonction des paramètres donnés.
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 pour plus d'informations.
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. |
| selectRole | query | Renvoie le rôle utilisateur dans la propriété role. |
| sortfield | string/array | Trie le résultat par les propriétés données. Les valeurs possibles sont : userid et username. |
| 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) Renvoie 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 utilisateurs
Récupérez 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",
"username": "Admin",
"name": "Zabbix",
"surname": "Administrator",
"url": "",
"autologin": "1",
"autologout": "0",
"lang": "en_GB",
"refresh": "0s",
"theme": "default",
"attempt_failed": "0",
"attempt_ip": "",
"attempt_clock": "0",
"rows_per_page": "50",
"timezone": "default",
"roleid": "3"
},
{
"userid": "2",
"username": "guest",
"name": "",
"surname": "",
"url": "",
"autologin": "0",
"autologout": "15m",
"lang": "default",
"refresh": "30s",
"theme": "default",
"attempt_failed": "0",
"attempt_ip": "",
"attempt_clock": "0",
"rows_per_page": "50",
"timezone": "default",
"roleid": "4"
},
{
"userid": "3",
"username": "user",
"name": "Zabbix",
"surname": "User",
"url": "",
"autologin": "0",
"autologout": "0",
"lang": "ru_RU",
"refresh": "15s",
"theme": "dark-theme",
"attempt_failed": "0",
"attempt_ip": "",
"attempt_clock": "0",
"rows_per_page": "100",
"timezone": "default",
"roleid": "1"
}
],
"id": 1
}Récupération des données utilisateur
Récupérer les données d'un utilisateur avec l'ID "12".
Requête :
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": ["userid", "username"],
"selectRole": "extend",
"userids": "12"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": [
{
"userid": "12",
"username": "John",
"role": {
"roleid": "5",
"name": "Operator",
"type": "1",
"readonly": "0"
}
}
],
"id": 1
}Voir également
Source
CUser::get() dans ui/include/classes/api/services/CUser.php.