[comment]: # translation:outdated [comment]: # ({2485e0f7-2485e0f7}) # user.get [comment]: # ({/2485e0f7-2485e0f7}) [comment]: # ({5aeb1b12-36f89e39}) ### Apraksts `integer/array user.get(object parameters)` Metode ļauj izgūt lietotājus atbilstoši norādītajiem parametriem. ::: noteclassic Šī metode ir pieejama jebkura tipa lietotājiem. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet sadaļā [Lietotāju lomas](/manual/web_interface/frontend_sections/users/user_roles). ::: [comment]: # ({/5aeb1b12-36f89e39}) [comment]: # ({d5bb139f-888512e9}) ### Parametri `(object)` Parametri, kas nosaka vēlamo izvadi. Metode atbalsta šādus parametrus. ::: noteclassic Pieprasot lietotāja medijus, atļaujas vai lomas informāciju, *Admin* un *User* tipa lietotāji var iegūt datus tikai par savu lietotāju. Piemēru skatiet sadaļā [Lietotāju izgūšana kā *Admin*](#retrieving-users-as-admin). ::: |Parametrs|[Tips](/manual/api/reference_commentary#data-types)|Apraksts| |--|--|------| |mediaids|ID/array|Atgriezt tikai tos lietotājus, kuri izmanto norādīto mediju.| |mediatypeids|ID/array|Atgriezt tikai tos lietotājus, kuri izmanto norādītos mediju tipus.| |userids|ID/array|Atgriezt tikai lietotājus ar norādītajiem ID.| |usrgrpids|ID/array|Atgriezt tikai tos lietotājus, kuri pieder norādītajām lietotāju grupām.| |getAccess|flag|Pievieno papildu informāciju par lietotāja atļaujām.

Katram lietotājam pievieno šādas īpašības:
`gui_access` - `(integer)` lietotāja lietotāja saskarne autentifikācijas metode. Iespējamo vērtību sarakstu skatiet [lietotāju grupas objekta](/manual/api/reference/usergroup/object#user-group) īpašībā `gui_access`.
`debug_mode` - `(integer)` norāda, vai lietotājam ir iespējots atkļūdošanas režīms. Iespējamās vērtības: 0 - atkļūdošana atspējota, 1 - atkļūdošana iespējota.
`users_status` - `(integer)` norāda, vai lietotājs ir atspējots. Iespējamās vērtības: 0 - lietotājs iespējots, 1 - lietotājs atspējots.| |selectMedias|query|Atgriezt lietotāja izmantotos medijus īpašībā [`medias`](/manual/api/reference/user/object#media).| |selectMediatypes|query|Atgriezt lietotāja izmantotos mediju tipus īpašībā [`mediatypes`](/manual/api/reference/mediatype/object).

Skatiet [`mediatype.get`](/manual/api/reference/mediatype/get), lai uzzinātu par ierobežojumiem atkarībā no lietotāja tipa.| |selectUsrgrps|query|Atgriezt lietotāju grupas, kurām lietotājs pieder, īpašībā [`usrgrps`](/manual/api/reference/usergroup/object).

Skatiet [`usergroup.get`](/manual/api/reference/usergroup/get), lai uzzinātu par ierobežojumiem atkarībā no lietotāja tipa.| |selectRole|query|Atgriezt lietotāja lomu īpašībā [`role`](/manual/api/reference/role/object#role).| |filter|object|Atgriezt tikai tos rezultātus, kas precīzi atbilst norādītajam filtram.

Pieņem objektu, kurā atslēgas ir īpašību nosaukumi, bet vērtības ir vai nu viena vērtība, vai vērtību masīvs, ar ko salīdzināt.

Neatbalsta `text` [datu tipa](/manual/api/reference_commentary#data-types) īpašības.

Iespējamās [lietotāja objekta](/manual/api/reference/user/object) īpašības *Admin* un *User* tipa lietotājiem, pieprasot datus par lietotājiem savā lietotāju grupā: `userid`, `name`, `surname`, `username`.| |output|query|Atgriežamās [lietotāja objekta](/manual/api/reference/user/object) īpašības.

*Admin* un *User* tipa lietotāji var iegūt tikai šādas īpašības:
- Savam lietotājam: `userid`, `attempt_clock`, `attempt_failed`, `attempt_ip`, `autologin`, `autologout`, `lang`, `name`, `provisioned`, `refresh`, `roleid`, `rows_per_page`, `surname`, `theme`, `timezone`, `url`, `username`.
- Lietotājiem savā lietotāju grupā: `userid`, `name`, `surname`, `username`.

Noklusējums: `extend`.| |search|object|Atgriezt rezultātus, kas atbilst norādītajam paraugam (reģistrnejutīgi).

Pieņem objektu, kurā atslēgas ir īpašību nosaukumi, bet vērtības ir meklējamās virknes. Ja nav norādītas papildu opcijas, tiks veikta `LIKE "%…%"` meklēšana.

Atbalsta tikai `string` un `text` [datu tipa](/manual/api/reference_commentary#data-types) īpašības.

Iespējamās [lietotāja objekta](/manual/api/reference/user/object) īpašības *Admin* un *User* tipa lietotājiem, pieprasot datus par lietotājiem savā lietotāju grupā: `name`, `surname`, `username`.| |sortfield|string/array|Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: `userid`, `username`.| |countOutput|boolean|Šie parametri ir aprakstīti [atsauces komentārā](/manual/api/reference_commentary#common-get-method-parameters).| |editable|boolean|^| |excludeSearch|boolean|^| |limit|integer|^| |preservekeys|boolean|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|boolean|^| [comment]: # ({/d5bb139f-888512e9}) [comment]: # ({7223bab1-7223bab1}) ### Atgrieztās vērtības `(integer/array)` Atgriež vienu no šīm vērtībām: - objektu masīvu; - izgūto objektu skaitu, ja ir izmantots parametrs `countOutput`. [comment]: # ({/7223bab1-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Piemēri [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({6a55e19e-7b5c610b}) #### Lietotāju izgūšana Izgūst visus konfigurētos lietotājus. [Pieprasījums](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "user.get", "params": { "output": "extend" }, "id": 1 } ``` Atbilde: ```json { "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 } ``` [comment]: # ({/6a55e19e-7b5c610b}) [comment]: # ({93e2b113-18cd65ae}) #### Lietotāju izgūšana kā *Admin* Kā *Admin* tipa lietotājs izgūstiet detalizētus datus par savu lietotāju un ierobežotus datus par lietotājiem savā lietotāju grupā. [Pieprasījums](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "user.get", "params": { "output": "extend", "getAccess": true, "selectMedias": "extend", "selectMediatypes": "extend", "selectUsrgrps": "extend", "selectRole": "extend" }, "id": 1 } ``` Atbilde: ```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", "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": [ "john.doe@example.com" ], "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 } ``` [comment]: # ({/93e2b113-18cd65ae}) [comment]: # ({2c8d809a-d85f9654}) #### Lietotāja datu iegūšana Iegūstiet lietotāja ar ID "12" datus. [Pieprasījums](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "user.get", "params": { "output": ["userid", "username"], "selectRole": "extend", "userids": "12" }, "id": 1 } ``` Atbilde: ```json { "jsonrpc": "2.0", "result": [ { "userid": "12", "username": "John", "role": { "roleid": "5", "name": "Operator", "type": "1", "readonly": "0" } } ], "id": 1 } ``` [comment]: # ({/2c8d809a-d85f9654}) [comment]: # ({f7109d71-8d892781}) ### Skatiet arī - [Medijs](/manual/api/reference/user/object#media) - [Medija tips](/manual/api/reference/mediatype/object#media-type) - [Lietotāju grupa](/manual/api/reference/usergroup/object#user-group) - [Loma](/manual/api/reference/role/object#role) [comment]: # ({/f7109d71-8d892781}) [comment]: # ({842f2a42-842f2a42}) ### Avots CUser::get() failā *ui/include/classes/api/services/CUser.php*. [comment]: # ({/842f2a42-842f2a42})