[comment]: # translation:outdated [comment]: # ({2485e0f7-2485e0f7}) # user.get [comment]: # ({/2485e0f7-2485e0f7}) [comment]: # ({5aeb1b12-36f89e39}) ### Beschreibung `integer/array user.get(object parameters)` Mit dieser Methode können Benutzer entsprechend den angegebenen Parametern abgerufen werden. ::: noteclassic Diese Methode ist für Benutzer aller Typen verfügbar. Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter [Benutzerrollen](/manual/web_interface/frontend_sections/users/user_roles). ::: [comment]: # ({/5aeb1b12-36f89e39}) [comment]: # ({d5bb139f-888512e9}) ### Parameter `(object)` Parameter, die die gewünschte Ausgabe definieren. Die Methode unterstützt die folgenden Parameter. ::: noteclassic Beim Anfordern von Benutzermedien, Berechtigungen oder Rolleninformationen können Benutzer des Typs *Admin* und *User* Daten nur über ihren eigenen Benutzer abrufen. Ein Beispiel finden Sie unter [Abrufen von Benutzern als *Admin*](#retrieving-users-as-admin). ::: |Parameter|[Typ](/manual/api/reference_commentary#data-types)|Beschreibung| |--|--|------| |mediaids|ID/array|Gibt nur Benutzer zurück, die die angegebenen Medien verwenden.| |mediatypeids|ID/array|Gibt nur Benutzer zurück, die die angegebenen Medientypen verwenden.| |userids|ID/array|Gibt nur Benutzer mit den angegebenen IDs zurück.| |usrgrpids|ID/array|Gibt nur Benutzer zurück, die zu den angegebenen Benutzergruppen gehören.| |getAccess|flag|Fügt zusätzliche Informationen über Benutzerberechtigungen hinzu.

Fügt für jeden Benutzer die folgenden Eigenschaften hinzu:
`gui_access` - `(integer)` Authentifizierungsmethode des Benutzers im Frontend. Eine Liste möglicher Werte finden Sie in der Eigenschaft `gui_access` des [Benutzergruppenobjekts](/manual/api/reference/usergroup/object#user-group).
`debug_mode` - `(integer)` gibt an, ob Debugging für den Benutzer aktiviert ist. Mögliche Werte: 0 - Debugging deaktiviert, 1 - Debugging aktiviert.
`users_status` - `(integer)` gibt an, ob der Benutzer deaktiviert ist. Mögliche Werte: 0 - Benutzer aktiviert, 1 - Benutzer deaktiviert.| |selectMedias|query|Gibt die vom Benutzer verwendeten Medien in der Eigenschaft [`medias`](/manual/api/reference/user/object#media) zurück.| |selectMediatypes|query|Gibt die vom Benutzer verwendeten Medientypen in der Eigenschaft [`mediatypes`](/manual/api/reference/mediatype/object) zurück.

Siehe [`mediatype.get`](/manual/api/reference/mediatype/get) für Einschränkungen basierend auf dem Benutzertyp.| |selectUsrgrps|query|Gibt die Benutzergruppen, zu denen der Benutzer gehört, in der Eigenschaft [`usrgrps`](/manual/api/reference/usergroup/object) zurück.

Siehe [`usergroup.get`](/manual/api/reference/usergroup/get) für Einschränkungen basierend auf dem Benutzertyp.| |selectRole|query|Gibt die Benutzerrolle in der Eigenschaft [`role`](/manual/api/reference/role/object#role) zurück.| |filter|object|Gibt nur Ergebnisse zurück, die exakt mit dem angegebenen Filter übereinstimmen.

Akzeptiert ein Objekt, bei dem die Schlüssel Eigenschaftsnamen sind und die Werte entweder ein einzelner Wert oder ein Array von Werten sind, mit denen abgeglichen werden soll.

Unterstützt keine Eigenschaften des [Datentyps](/manual/api/reference_commentary#data-types) `text`.

Mögliche Eigenschaften des [Benutzerobjekts](/manual/api/reference/user/object) für Benutzer des Typs *Admin* und *User* beim Anfordern von Daten über Benutzer in ihrer Benutzergruppe: `userid`, `name`, `surname`, `username`.| |output|query|Eigenschaften des [Benutzerobjekts](/manual/api/reference/user/object), die zurückgegeben werden sollen.

Benutzer des Typs *Admin* und *User* können nur die folgenden Eigenschaften abrufen:
- Für ihren eigenen Benutzer: `userid`, `attempt_clock`, `attempt_failed`, `attempt_ip`, `autologin`, `autologout`, `lang`, `name`, `provisioned`, `refresh`, `roleid`, `rows_per_page`, `surname`, `theme`, `timezone`, `url`, `username`.
- Für Benutzer in ihrer Benutzergruppe: `userid`, `name`, `surname`, `username`.

Standard: `extend`.| |search|object|Gibt Ergebnisse zurück, die dem angegebenen Muster entsprechen (Groß-/Kleinschreibung wird nicht beachtet).

Akzeptiert ein Objekt, bei dem die Schlüssel Eigenschaftsnamen sind und die Werte Zeichenfolgen sind, nach denen gesucht werden soll. Wenn keine zusätzlichen Optionen angegeben sind, wird eine Suche vom Typ `LIKE "%…%"` durchgeführt.

Unterstützt nur Eigenschaften des [Datentyps](/manual/api/reference_commentary#data-types) `string` und `text`.

Mögliche Eigenschaften des [Benutzerobjekts](/manual/api/reference/user/object) für Benutzer des Typs *Admin* und *User* beim Anfordern von Daten über Benutzer in ihrer Benutzergruppe: `name`, `surname`, `username`.| |sortfield|string/array|Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: `userid`, `username`.| |countOutput|boolean|Diese Parameter werden in der [Referenzkommentierung](/manual/api/reference_commentary#common-get-method-parameters) beschrieben.| |editable|boolean|^| |excludeSearch|boolean|^| |limit|integer|^| |preservekeys|boolean|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|boolean|^| [comment]: # ({/d5bb139f-888512e9}) [comment]: # ({7223bab1-7223bab1}) ### Rückgabewerte `(integer/array)` Gibt entweder Folgendes zurück: - ein Array von Objekten; - die Anzahl der abgerufenen Objekte, wenn der Parameter `countOutput` verwendet wurde. [comment]: # ({/7223bab1-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Beispiele [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({6a55e19e-7b5c610b}) #### Benutzer abrufen Rufen Sie alle konfigurierten Benutzer ab. [Anfrage](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "user.get", "params": { "output": "extend" }, "id": 1 } ``` Antwort: ```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}) #### Abrufen von Benutzern als *Admin* Als Benutzer vom Typ *Admin* rufen Sie detaillierte Daten über Ihren eigenen Benutzer sowie eingeschränkte Daten für Benutzer in Ihrer Benutzergruppe ab. [Anfrage](/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 } ``` Antwort: ```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}) #### Abrufen von Benutzerdaten Rufen Sie die Daten eines Benutzers mit der ID „12“ ab. [Anfrage](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "user.get", "params": { "output": ["userid", "username"], "selectRole": "extend", "userids": "12" }, "id": 1 } ``` Antwort: ```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}) ### Siehe auch - [Medien](/manual/api/reference/user/object#media) - [Medientyp](/manual/api/reference/mediatype/object#media-type) - [Benutzergruppe](/manual/api/reference/usergroup/object#user-group) - [Rolle](/manual/api/reference/role/object#role) [comment]: # ({/f7109d71-8d892781}) [comment]: # ({842f2a42-842f2a42}) ### Quelle CUser::get() in *ui/include/classes/api/services/CUser.php*. [comment]: # ({/842f2a42-842f2a42})