user.get

Beschreibung

integer/array user.get(object parameters)

Mit dieser Methode können Benutzer entsprechend den angegebenen Parametern abgerufen werden.

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.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

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.

Parameter Typ 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.
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 zurück.
selectMediatypes query Gibt die vom Benutzer verwendeten Medientypen in der Eigenschaft mediatypes zurück.

Siehe 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 zurück.

Siehe usergroup.get für Einschränkungen basierend auf dem Benutzertyp.
selectRole query Gibt die Benutzerrolle in der Eigenschaft 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 text.

Mögliche Eigenschaften des Benutzerobjekts 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, 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 string und text.

Mögliche Eigenschaften des Benutzerobjekts 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 beschrieben.
editable boolean
excludeSearch boolean
limit integer
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Gibt entweder Folgendes zurück:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Benutzer abrufen

Rufen Sie alle konfigurierten Benutzer ab.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "user.get",
    "params": {
        "output": "extend"
    },
    "id": 1
}

Antwort:

{
    "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
}

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:

{
    "jsonrpc": "2.0",
    "method": "user.get",
    "params": {
        "output": "extend",
        "getAccess": true,
        "selectMedias": "extend",
        "selectMediatypes": "extend",
        "selectUsrgrps": "extend",
        "selectRole": "extend"
    },
    "id": 1
}

Antwort:

{
    "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
}

Abrufen von Benutzerdaten

Rufen Sie die Daten eines Benutzers mit der ID „12“ ab.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "user.get",
    "params": {
        "output": ["userid", "username"],
        "selectRole": "extend",
        "userids": "12"
    },
    "id": 1
}

Antwort:

{
  "jsonrpc": "2.0",
  "result": [
      {
          "userid": "12",
          "username": "John",
          "role": {
              "roleid": "5",
              "name": "Operator",
              "type": "1",
              "readonly": "0"
          }
      }
  ],
  "id": 1
}

Siehe auch

Quelle

CUser::get() in ui/include/classes/api/services/CUser.php.