[comment]: # translation:outdated
[comment]: # ({2485e0f7-2485e0f7})
# user.get
[comment]: # ({/2485e0f7-2485e0f7})
[comment]: # ({36f89e39-36f89e39})
### Beschrijving
`integer/array gebruiker.get(objectparameters)`
De methode maakt het mogelijk om gebruikers op te halen volgens de gegeven parameters.
::: noteclassic
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](/manual/web_interface/frontend_sections/administration/user_roles)
voor meer informatie.
:::
[comment]: # ({/36f89e39-36f89e39})
[comment]: # ({c8d70767-888512e9})
### Parameters
`(object)` Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
|Parameter|[Type](/manual/api/reference_commentary#data_types)|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](/manual/api/reference/usergroup/object#user_group) 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](/manual/api/reference/user/object#media).|
|selectMediatypes|query|Retourneer mediatypen die door de gebruiker zijn gebruikt in de eigenschap [mediatypes](/manual/api/reference/mediatype/object).|
|selectUsrgrps|query|Retourneer gebruikersgroepen waartoe de gebruiker behoort in de eigenschap [usrgrps](/manual/api/reference/usergroup/object).|
|selectRole|query|Retourneer de gebruikersrol in de eigenschap [role](/manual/api/reference/role/object#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](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|booleaans|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limiet|geheel getal|^|
|uitvoer|query|^|
|preservekeys|boolean|^|
|zoeken|object|^|
|searchByAny|boolean|^|
|searchWildcardsIngeschakeld|boolean|^|
|sortorde|string/array|^|
|startZoeken|booleaans|^|
[comment]: # ({/c8d70767-888512e9})
[comment]: # ({7223bab1-7223bab1})
### Return values
`(integer/array)` Returns either:
- an array of objects;
- the count of retrieved objects, if the `countOutput` parameter has
been used.
[comment]: # ({/7223bab1-7223bab1})
[comment]: # ({b41637d2-b41637d2})
### Voorbeelden
[comment]: # ({/b41637d2-b41637d2})
[comment]: # ({bf3b0e50-7b5c610b})
#### Gebruikers worden opgehaald
Haal alle geconfigureerde gebruikers op.
Verzoek:
```json
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Antwoord:
```json
{
"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
}
```
[comment]: # ({/bf3b0e50-7b5c610b})
[comment]: # ({new-746d14f7})
#### Retrieving users as *Admin*
As an *Admin* type user, retrieve detailed data about your own user and limited data for users in your user group.
Request:
```json
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": "extend",
"getAccess": true,
"selectMedias": "extend",
"selectMediatypes": "extend",
"selectUsrgrps": "extend",
"selectRole": "extend"
},
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
{
"userid": "1",
"username": "Admin",
"name": "Zabbix",
"surname": "Administrator",
"usrgrps": [
{
"usrgrpid": "7",
"name": "Zabbix administrators",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0"
}
]
},
{
"userid": "3",
"username": "database-admin",
"name": "John",
"surname": "Doe",
"url": "",
"autologin": "0",
"autologout": "0",
"lang": "default",
"refresh": "30s",
"theme": "default",
"attempt_failed": "0",
"attempt_ip": "",
"attempt_clock": "0",
"rows_per_page": "50",
"timezone": "default",
"roleid": "2",
"gui_access": "0",
"debug_mode": "0",
"users_status": "0",
"usrgrps": [
{
"usrgrpid": "7",
"name": "Zabbix administrators",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0"
}
],
"medias": [
{
"mediaid": "2",
"userid": "3",
"mediatypeid": "1",
"sendto": [
"john.doe@example.com"
],
"active": "0",
"severity": "63",
"period": "1-7,00:00-24:00"
}
],
"mediatypes": [
{
"mediatypeid": "1",
"type": "0",
"name": "Email",
"status": "0",
"description": "",
"maxattempts": "3"
}
],
"role": {
"roleid": "2",
"name": "Admin role",
"type": "2",
"readonly": "0"
}
}
],
"id": 1
}
```
[comment]: # ({/new-746d14f7})
[comment]: # ({b2b58125-d85f9654})
#### Gebruikersgegevens ophalen
Gegevens ophalen van een gebruiker met ID "12".
Verzoek:
```json
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": ["userid", "username"],
"selectRole": "extend",
"userids": "12"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Antwoord:
```json
{
"jsonrpc": "2.0",
"result": [
{
"userid": "12",
"username": "John",
"role": {
"roleid": "5",
"name": "Operator",
"type": "1",
"readonly": "0"
}
}
],
"id": 1
}
```
[comment]: # ({/b2b58125-d85f9654})
[comment]: # ({8d892781-8d892781})
### Zie ook
- [Media](/manual/api/referentie/gebruiker/object#media)
- [Mediatype](/manual/api/reference/mediatype/object#media_type)
- [Gebruikersgroep](/manual/api/reference/usergroup/object#user_group)
- [Rol](/manual/api/reference/role/object#role)
[comment]: # ({/8d892781-8d892781})
[comment]: # ({842f2a42-842f2a42})
### Bron
CUser::get() in *ui/include/classes/api/services/CUser.php*.
[comment]: # ({/842f2a42-842f2a42})