user.get

Apraksts

integer/array user.get(object parameters)

Metode ļauj izgūt lietotājus atbilstoši norādītajiem parametriem.

Šī 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.

Parametri

(object) Parametri, kas definē vēlamo izvadi.

Metode atbalsta šādus parametrus.

Kopš Zabbix 7.0.9, pieprasot lietotāju mediju, atļauju vai lomas informāciju, Admin un User tipa lietotāji var izgūt datus tikai par savu lietotāju. Piemēru skatiet sadaļā Lietotāju izgūšana kā Admin.

Parametrs Tips Apraksts
mediaids ID/array Atgriež tikai lietotājus, kas izmanto norādīto mediju.
mediatypeids ID/array Atgriež tikai lietotājus, kas izmanto norādītos mediju tipus.
userids ID/array Atgriež tikai lietotājus ar norādītajiem ID.
usrgrpids ID/array Atgriež tikai lietotājus, kas pieder norādītajām lietotāju grupām.
getAccess flag Pievieno papildu informāciju par lietotāju atļaujām.

Pievieno šādas īpašības katram lietotājam:
gui_access - (integer) lietotāja lietotāja saskarnes autentifikācijas metode. Iespējamo vērtību sarakstu skatiet lietotāju grupas objekta gui_access īpašībā.
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 Atgriež medijus, ko lietotājs izmanto medias īpašībā.
selectMediatypes query Atgriež mediju tipus, ko lietotājs izmanto mediatypes īpašībā.

Skatiet mediatype.get ierobežojumus, kas balstīti uz lietotāja tipu.
selectUsrgrps query Atgriež lietotāju grupas, kurām lietotājs pieder, usrgrps īpašībā.

Skatiet usergroup.get ierobežojumus, kas balstīti uz lietotāja tipu.
selectRole query Atgriež lietotāja lomu role īpašībā.
filter object Atgriež 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 īpašības.

Iespējamās lietotāja objekta īpašības Admin un User tipa lietotājiem, pieprasot datus par lietotājiem viņu lietotāju grupā (kopš Zabbix 7.0.9): userid, name, surname, username.
output query Lietotāja objekta īpašības, kas jāatgriež.

Kopš Zabbix 7.0.9, Admin un User tipa lietotāji var izgūt tikai šādas īpašības:
- Par savu lietotāju: userid, attempt_clock, attempt_failed, attempt_ip, autologin, autologout, lang, name, provisioned, refresh, roleid, rows_per_page, surname, theme, timezone, url, username.
- Par lietotājiem savā lietotāju grupā: userid, name, surname, username.

Noklusējums: extend.
search object Atgriež rezultātus, kas atbilst norādītajam paraugam (nav reģistrjutīgs).

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

Atbalsta tikai string un text datu tipa īpašības.

Iespējamās lietotāja objekta īpašības Admin un User tipa lietotājiem, pieprasot datus par lietotājiem viņu lietotāju grupā (kopš Zabbix 7.0.9): name, surname, username.
sortfield string/array Kārto 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ā.
editable boolean
excludeSearch boolean
limit integer
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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.

Piemēri

Lietotāju izgūšana

Izgūst visus konfigurētos lietotājus.

Pieprasījums:

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

Atbilde:

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

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:

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

Atbilde:

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

Lietotāja datu iegūšana

Iegūstiet lietotāja ar ID "12" datus.

Pieprasījums:

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

Atbilde:

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

Skatiet arī

Avots

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