Table of Contents
user.get
Beschrijving
integer/array gebruiker.get(objectparameters)
De methode maakt het mogelijk om gebruikers op te halen volgens de gegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Beschrijving |
|---|---|---|
| mediaids | string/array | Retourneer alleen gebruikers die de opgegeven media gebruiken. |
| mediatypeids | string/array | Retourneer alleen gebruikers die de opgegeven mediatypen gebruiken. |
| userids | string/array | Retourneer alleen gebruikers met de opgegeven ID's. |
| usrgrpids | string/array | Retourneer alleen gebruikers die tot de opgegeven gebruikersgroepen behoren. |
| getAccess | flag | Voegt aanvullende informatie toe over gebruikersrechten. Voegt de volgende eigenschappen toe voor elke gebruiker: gui_access - (integer) frontend-authenticatiemethode van de gebruiker. Raadpleeg de eigenschap gui_access van het gebruikersgroepsobject voor een lijst met mogelijke waarden.debug_mode - (integer) geeft aan of debug is ingeschakeld voor de gebruiker. Mogelijke waarden: 0 - debug uitgeschakeld, 1 - debug ingeschakeld.users_status - (integer) geeft aan of de gebruiker is uitgeschakeld. Mogelijke waarden: 0 - gebruiker ingeschakeld, 1 - gebruiker uitgeschakeld. |
| selectMedias | query | Retourneer media die door de gebruiker zijn gebruikt in de eigenschap medias. |
| selectMediatypes | query | Retourneer mediatypen die door de gebruiker zijn gebruikt in de eigenschap mediatypes. |
| selectUsrgrps | query | Retourneer gebruikersgroepen waartoe de gebruiker behoort in de eigenschap usrgrps. |
| selectRole | query | Retourneer de gebruikersrol in de eigenschap role. |
| sortfield | string/array | Sorteer het resultaat op de gegeven eigenschappen. Mogelijke waarden zijn: userid en username. |
| countOutput | boolean | Deze parameters gelden voor alle get-methoden en worden in detail beschreven in de referentiecommentaar. |
| editable | booleaans | |
| excludeSearch | boolean | |
| filter | object | |
| limiet | geheel getal | |
| uitvoer | query | |
| preservekeys | boolean | |
| zoeken | object | |
| searchByAny | boolean | |
| searchWildcardsIngeschakeld | boolean | |
| sortorde | string/array | |
| startZoeken | booleaans |
Return values
(integer/array) Returns either:
- an array of objects;
- the count of retrieved objects, if the
countOutputparameter has been used.
Voorbeelden
Gebruikers worden opgehaald
Haal alle geconfigureerde gebruikers op.
Verzoek:
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"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
}Gebruikersgegevens ophalen
Gegevens ophalen van een gebruiker met ID "12".
Verzoek:
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": ["userid", "username"],
"selectRole": "extend",
"userids": "12"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"userid": "12",
"username": "John",
"role": {
"roleid": "5",
"name": "Operator",
"type": "1",
"readonly": "0"
}
}
],
"id": 1
}Zie ook
Bron
CUser::get() in ui/include/classes/api/services/CUser.php.