Documentation
Table of Contents
user.get
Descripció
integer/array user.get(object parameters)
El mètode permet recuperar usuaris segons els paràmetres proveïts.
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.
Paràmetres
(object) Paràmetres que defineixen la sortida esperada.
El mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| mediaids | string/array | Retorna només els usuaris que són emprant el suport donat. |
| mediatypeids | string/array | Retorna només els usuaris que empren els tipus de suport donats. |
| userids | string/array | Retorna només els usuaris amb els identificadors donats. |
| usrgrpids | string/array | Retorna només els usuaris que pertanyen als grups d'usuaris donats. |
| getAccess | flag | Afegeix informació addicional sobre els permisos d'usuari. Afegeix les propietats següents per a cada usuari: gui_access - (integer) mètode d'autenticació frontal de l'usuari. Consulteu la propietat gui_access de l'objecte de grup d'usuaris per pbtomdre una llista de possibles valors.debug_mode - ( integer) indica si el mode de depuració és habilitat per a l'usuari. Valors possibles: 0 - depuració desactivada, 1 - depuració activada.users_status - (enteger) indica si l'usuari és desactivat. Valors possibles: 0 - usuari actiu, 1 - usuari desactivat. |
| selectMedias | query | Retorna el suport emprat per l'usuari a la propietat suports. |
| selectMediatypes | query | Retorna els tipus de suport emprats per l'usuari a la propietat mediatypes. |
| selectUsrgrps | query | Retorna els grups d'usuaris als quals pertany l'usuari a la propietat usrgrps. |
| selectRole | query | Retorna el rol d'usuari a la propietat rol. |
| sortfield | string/array | Ordena el resultat per les propietats donades. Els valors possibles són: userid i username. |
| countOutput | boolean | Aquests paràmetres, comuns a tots els mètodes get, es descriuen als comentaris de referència. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el paràmetre
countOutput.
Exemples
Recuperar usuaris
Recuperar tots els usuaris configurats.
Petició:
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"userid": "1",
"username": "Admin",
"name": "Zabbix",
"surname": "Administrator",
"url": "",
"autologin": "1",
"autologout": "0",
"lang": "en_US",
"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
}Recuperar informació de l'usuari
Recuperar la informació de l'usuari amb ID "12".
Petició:
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": ["userid", "username"],
"selectRole": "extend",
"userids": "12"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"userid": "12",
"username": "John",
"role": {
"roleid": "5",
"name": "Operator",
"type": "1",
"readonly": "0"
}
}
],
"id": 1
}Veieu també
Font
CUser::get() in ui/include/classes/api/services/CUser.php.