[comment]: # translation:outdated [comment]: # ({2485e0f7-2485e0f7}) # user.get [comment]: # ({/2485e0f7-2485e0f7}) [comment]: # ({5aeb1b12-36f89e39}) ### Opis `integer/array user.get(object parameters)` Ta metoda umożliwia pobieranie użytkowników zgodnie z podanymi parametrami. ::: noteclassic Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji [Role użytkowników](/manual/web_interface/frontend_sections/users/user_roles). ::: [comment]: # ({/5aeb1b12-36f89e39}) [comment]: # ({d5bb139f-888512e9}) ### Parametry `(object)` Parametry definiujące żądane dane wyjściowe. Metoda obsługuje następujące parametry. ::: noteclassic Podczas żądania informacji o mediach użytkownika, uprawnieniach lub roli, użytkownicy typu *Admin* i *User* mogą pobierać dane tylko o swoim własnym użytkowniku. Przykład znajduje się w sekcji [Pobieranie użytkowników jako *Admin*](#retrieving-users-as-admin). ::: |Parametr|[Typ](/manual/api/reference_commentary#data-types)|Opis| |--|--|------| |mediaids|ID/array|Zwracaj tylko użytkowników, którzy używają podanych mediów.| |mediatypeids|ID/array|Zwracaj tylko użytkowników, którzy używają podanych typów mediów.| |userids|ID/array|Zwracaj tylko użytkowników o podanych ID.| |usrgrpids|ID/array|Zwracaj tylko użytkowników należących do podanych grup użytkowników.| |getAccess|flag|Dodaje dodatkowe informacje o uprawnieniach użytkownika.

Dodaje następujące właściwości dla każdego użytkownika:
`gui_access` - `(integer)` metoda uwierzytelniania użytkownika we frontendzie. Listę możliwych wartości można znaleźć we właściwości `gui_access` obiektu [grupy użytkowników](/manual/api/reference/usergroup/object#user-group).
`debug_mode` - `(integer)` wskazuje, czy debugowanie jest włączone dla użytkownika. Możliwe wartości: 0 - debugowanie wyłączone, 1 - debugowanie włączone.
`users_status` - `(integer)` wskazuje, czy użytkownik jest wyłączony. Możliwe wartości: 0 - użytkownik włączony, 1 - użytkownik wyłączony.| |selectMedias|query|Zwracaj media używane przez użytkownika we właściwości [`medias`](/manual/api/reference/user/object#media).| |selectMediatypes|query|Zwracaj typy mediów używane przez użytkownika we właściwości [`mediatypes`](/manual/api/reference/mediatype/object).

Zobacz [`mediatype.get`](/manual/api/reference/mediatype/get), aby poznać ograniczenia zależne od typu użytkownika.| |selectUsrgrps|query|Zwracaj grupy użytkowników, do których należy użytkownik, we właściwości [`usrgrps`](/manual/api/reference/usergroup/object).

Zobacz [`usergroup.get`](/manual/api/reference/usergroup/get), aby poznać ograniczenia zależne od typu użytkownika.| |selectRole|query|Zwracaj rolę użytkownika we właściwości [`role`](/manual/api/reference/role/object#role).| |filter|object|Zwracaj tylko te wyniki, które dokładnie odpowiadają podanemu filtrowi.

Akceptuje obiekt, w którym kluczami są nazwy właściwości, a wartościami są pojedyncza wartość lub tablica wartości do dopasowania.

Nie obsługuje właściwości typu danych `text` [data type](/manual/api/reference_commentary#data-types).

Możliwe właściwości [obiektu User](/manual/api/reference/user/object) dla użytkowników typu *Admin* i *User* podczas żądania danych o użytkownikach z ich grupy użytkowników: `userid`, `name`, `surname`, `username`.| |output|query|Właściwości [obiektu User](/manual/api/reference/user/object), które mają zostać zwrócone.

Użytkownicy typu *Admin* i *User* mogą pobierać tylko następujące właściwości:
- Dla własnego użytkownika: `userid`, `attempt_clock`, `attempt_failed`, `attempt_ip`, `autologin`, `autologout`, `lang`, `name`, `provisioned`, `refresh`, `roleid`, `rows_per_page`, `surname`, `theme`, `timezone`, `url`, `username`.
- Dla użytkowników z ich grupy użytkowników: `userid`, `name`, `surname`, `username`.

Domyślnie: `extend`.| |search|object|Zwracaj wyniki pasujące do podanego wzorca (bez rozróżniania wielkości liter).

Akceptuje obiekt, w którym kluczami są nazwy właściwości, a wartościami są ciągi znaków do wyszukania. Jeśli nie podano dodatkowych opcji, zostanie wykonane wyszukiwanie `LIKE "%…%"`.

Obsługuje tylko właściwości typu danych `string` i `text` [data type](/manual/api/reference_commentary#data-types).

Możliwe właściwości [obiektu User](/manual/api/reference/user/object) dla użytkowników typu *Admin* i *User* podczas żądania danych o użytkownikach z ich grupy użytkowników: `name`, `surname`, `username`.| |sortfield|string/array|Sortuj wynik według podanych właściwości.

Możliwe wartości: `userid`, `username`.| |countOutput|boolean|Te parametry są opisane w [komentarzu referencyjnym](/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}) ### Zwracane wartości `(integer/array)` Zwraca: - tablicę obiektów; - liczbę pobranych obiektów, jeśli został użyty parametr `countOutput`. [comment]: # ({/7223bab1-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Przykłady [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({6a55e19e-7b5c610b}) #### Pobieranie użytkowników Pobierz wszystkich skonfigurowanych użytkowników. [Żądanie](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "user.get", "params": { "output": "extend" }, "id": 1 } ``` Odpowiedź: ```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}) #### Pobieranie użytkowników jako *Admin* Jako użytkownik typu *Admin* pobierz szczegółowe dane o własnym użytkowniku oraz ograniczone dane użytkowników z własnej grupy użytkowników. [Żądanie](/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 } ``` Odpowiedź: ```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}) #### Pobieranie danych użytkownika Pobierz dane użytkownika o ID „12”. [Żądanie](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "user.get", "params": { "output": ["userid", "username"], "selectRole": "extend", "userids": "12" }, "id": 1 } ``` Odpowiedź: ```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}) ### Zobacz także - [Media](/manual/api/reference/user/object#media) - [Typ nośnika](/manual/api/reference/mediatype/object#media-type) - [Grupa użytkowników](/manual/api/reference/usergroup/object#user-group) - [Rola](/manual/api/reference/role/object#role) [comment]: # ({/f7109d71-8d892781}) [comment]: # ({842f2a42-842f2a42}) ### Źródło CUser::get() w *ui/include/classes/api/services/CUser.php*. [comment]: # ({/842f2a42-842f2a42})