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
(objecte) Paràmetres que defineixen la sortida desitjada.
El mètode admet els paràmetres següents.
Des de Zabbix 7.0.9, quan demanen mitjans d'usuari, permisos o informació de rol, els usuaris de tipus Administrador i Usuari només poden recuperar dades del seu propi usuari. Per obtenir un exemple, vegeu Recuperació d'usuaris com a Administrador.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| mediaids | ID/array | Retorn només els usuaris que utilitzen el suport donat. |
| mediatypeids | ID/array | Retorna només els usuaris que utilitzen els tipus de suports donats. |
| identificacions d'usuari | ID/matriu | Retorna només els usuaris amb els ID donats. |
| usrgrpids | ID/array | Retorna només els usuaris que pertanyen als grups d'usuaris donats. |
| getAccess | flag | Afegeix informació addicional sobre els permisos de l'usuari. Afegeix les propietats següents per a cada usuari: gui_access - (enteger) mètode d'autenticació de la interfície de l'usuari. Consulteu la propietat gui_access de l'objecte del grup d'usuaris per obtenir una llista de valors possibles.debug_mode - (enteger) indica si la depuració està habilitat per a l'usuari. Valors possibles: 0 - depuració desactivada, 1 - depuració activada.users_status - (enteger) indica si l'usuari està desactivat. Valors possibles: 0 - usuari habilitat, 1 - usuari inhabilitat. |
| selectMedias | query | Retorna el mitjà utilitzat per l'usuari a la propietat medias. |
| selectMediatypes | query | Retorn els tipus de suports utilitzats per l'usuari a la propietat mediatypes.Vegeu mediatype.get per a les restriccions basades en el tipus d'usuari. |
| selectUsrgrps | query | Retorn els grups d'usuaris als quals pertany l'usuari a la propietat usrgrps.Vegeu usergroup.get per a les restriccions basades en el tipus d'usuari. |
| selectRole | query | Retorna el rol d'usuari a la propietat role. |
| filtre | objecte | Retorna només aquells resultats que coincideixen exactament amb el filtre donat. Accepta un objecte, on les claus són noms de propietat i els valors són un valor únic o una matriu de valors amb els quals coincideix. No admet propietats de text tipus de dades. object](/manual/api/reference/user/object) propietats per als usuaris de tipus Admin i User quan demanen dades sobre usuaris del seu grup d'usuaris (des de Zabbix 7.0.9): identificador, nom, cognom, nom d'usuari. |
| output | query | User object propietats que s'han de retornar. Des de Zabbix 7.0.9, els usuaris de tipus Admin i User només poden recuperar les propietats següents: - Per al seu propi usuari: userid, attempt_tempttt``,fail_tempttt``autologin,autologout,lang,name,provisioned,refresh,roleid,rows_per_page,cognom,theme,timezone,url,username., : nom d'usuari.Per defecte: extend. |
| cerca | objecte | Retorna resultats que coincideixen amb el patró donat (no distingeix entre majúscules i minúscules). Accepta un objecte, on les claus són noms de propietat i els valors són cadenes per cercar. Si no es donen opcions addicionals, es farà una cerca M'agrada "%...%".Només admet propietats de string i text tipus de dades.Possible User object al seu grup d'usuaris (des de Zabbix 7.0.9): nom, cognom, nom d'usuari. |
| sortfield | string/array | Ordena el resultat per les propietats donades. Valors possibles: identificador d'usuari, nom d'usuari. |
| countOutput | boolean | Aquests paràmetres es descriuen al comentari de referència. |
| editable | booleà | |
| excludeSearch | booleà | |
| límit | número enter | |
| preservekeys | boolean | |
| searchByAny | booleà | |
| searchWildcardsEnabled | booleà | |
| ordenador | cadena/matriu | |
| startSearch | booleà |
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
Recupera tots els usuaris configurats.
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",
"userdirectoryid": "0",
"ts_provisioned": "0"
},
{
"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",
"userdirectoryid": "0",
"ts_provisioned": "0"
},
{
"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",
"userdirectoryid": "0",
"ts_provisioned": "0"
}
],
"id": 1
}Recuperació d'usuaris com a Administrador
Com a usuari de tipus Administrador, recupera dades detallades sobre el teu propi usuari i dades limitades per als usuaris del teu grup d'usuaris.
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": "extend",
"getAccess": true,
"selectMedias": "extend",
"selectMediatypes": "extend",
"selectUsrgrps": "extend",
"selectRole": "extend"
},
"id": 1
}Resposta:
{
"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",
"mfa_status": "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",
"provisioned": "0",
"gui_access": "0",
"debug_mode": "0",
"users_status": "0",
"usrgrps": [
{
"usrgrpid": "7",
"name": "Zabbix administrators",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0",
"mfa_status": "0"
}
],
"medias": [
{
"mediaid": "2",
"mediatypeid": "1",
"sendto": [
"[email protected]"
],
"active": "0",
"severity": "63",
"period": "1-7,00:00-24:00",
"provisioned": 0
}
],
"mediatypes": [
{
"mediatypeid": "1",
"type": "0",
"name": "Email",
"status": "0",
"description": "",
"maxattempts": "3"
}
],
"role": {
"roleid": "2",
"name": "Admin role",
"type": "2",
"readonly": "0"
}
}
],
"id": 1
}Recuperar informació de l'usuari
Recupera la informació de l'usuari amb ID "12".
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": ["userid", "username"],
"selectRole": "extend",
"userids": "12"
},
"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.