user.get

Descrizione

integer/array user.get(object parameters)

Questo metodo consente di recuperare gli utenti in base ai parametri specificati.

Questo metodo è disponibile per utenti di qualsiasi tipo. I permessi per chiamare il metodo possono essere revocati nelle impostazioni del ruolo utente. Vedere User roles per ulteriori informazioni.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Quando si richiedono media utente, permessi o informazioni sul ruolo, gli utenti di tipo Admin e User possono recuperare dati solo relativi al proprio utente. Per un esempio, vedere Recupero degli utenti come Admin.

Parametro Type Descrizione
mediaids ID/array Restituisce solo gli utenti che utilizzano i media specificati.
mediatypeids ID/array Restituisce solo gli utenti che utilizzano i tipi di media specificati.
userids ID/array Restituisce solo gli utenti con gli ID specificati.
usrgrpids ID/array Restituisce solo gli utenti che appartengono ai gruppi utenti specificati.
getAccess flag Aggiunge informazioni aggiuntive sui permessi dell'utente.

Aggiunge le seguenti proprietà per ciascun utente:
gui_access - (integer) metodo di autenticazione al frontend dell'utente. Fare riferimento alla proprietà gui_access del user group object per un elenco dei valori possibili.
debug_mode - (integer) indica se il debug è abilitato per l'utente. Valori possibili: 0 - debug disabilitato, 1 - debug abilitato.
users_status - (integer) indica se l'utente è disabilitato. Valori possibili: 0 - utente abilitato, 1 - utente disabilitato.
selectMedias query Restituisce i media utilizzati dall'utente nella proprietà medias.
selectMediatypes query Restituisce i tipi di media utilizzati dall'utente nella proprietà mediatypes.

Vedere mediatype.get per le limitazioni basate sul tipo di utente.
selectUsrgrps query Restituisce i gruppi utenti a cui l'utente appartiene nella proprietà usrgrps.

Vedere usergroup.get per le limitazioni basate sul tipo di utente.
selectRole query Restituisce il ruolo utente nella proprietà role.
filter object Restituisce solo i risultati che corrispondono esattamente al filtro specificato.

Accetta un oggetto, in cui le chiavi sono nomi di proprietà e i valori sono un singolo valore oppure un array di valori da confrontare.

Non supporta le proprietà del data type text.

Possibili proprietà del User object per utenti di tipo Admin e User quando richiedono dati sugli utenti del proprio gruppo utenti: userid, name, surname, username.
output query Proprietà del User object da restituire.

Gli utenti di tipo Admin e User possono recuperare solo le seguenti proprietà:
- Per il proprio utente: userid, attempt_clock, attempt_failed, attempt_ip, autologin, autologout, lang, name, provisioned, refresh, roleid, rows_per_page, surname, theme, timezone, url, username.
- Per gli utenti del proprio gruppo utenti: userid, name, surname, username.

Predefinito: extend.
search object Restituisce i risultati che corrispondono al modello specificato (senza distinzione tra maiuscole e minuscole).

Accetta un oggetto, in cui le chiavi sono nomi di proprietà e i valori sono stringhe da cercare. Se non vengono fornite opzioni aggiuntive, verrà eseguita una ricerca LIKE "%…%".

Supporta solo le proprietà del data type string e text.

Possibili proprietà del User object per utenti di tipo Admin e User quando richiedono dati sugli utenti del proprio gruppo utenti: name, surname, username.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: userid, username.
countOutput boolean Questi parametri sono descritti nel commento di riferimento.
editable boolean
excludeSearch boolean
limit integer
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valori restituiti

(integer/array) Restituisce o:

  • una matrice di oggetti;
  • il conteggio degli oggetti recuperati, se il parametro countOutput è stato usato.

Esempi

Recupero degli utenti

Recupera tutti gli utenti configurati.

Richiesta:

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

Risposta:

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

Recupero degli utenti come Admin

Come utente di tipo Admin, recupera dati dettagliati sul tuo utente e dati limitati per gli utenti del tuo gruppo utenti.

Richiesta:

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

Risposta:

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

Recupero dei dati utente

Recupera i dati di un utente con ID "12".

Richiesta:

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

Risposta:

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

Vedi anche

Fonte

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