user.get

Beschrijving

integer/array user.get(object parameters)

Deze methode maakt het mogelijk om gebruikers op te halen op basis van de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Toestemming om de methode te gebruiken kan worden ingetrokken in de gebruikersrol-instellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter Type Omschrijving
mediaids string/array Geeft alleen gebruikers terug die de opgegeven media gebruiken.
mediatypeids string/array Geeft alleen gebruikers terug die de opgegeven mediatypen gebruiken.
userids string/array Geeft alleen gebruikers terug met de opgegeven ID's.
usrgrpids string/array Geeft alleen gebruikers terug die behoren tot de opgegeven gebruikersgroepen.
getAccess flag Voegt aanvullende informatie toe over de gebruikersrechten.

Voegt de volgende eigenschappen toe voor elke gebruiker:
gui_access - (integer) de authenticatiemethode van de gebruiker voor de frontend. Raadpleeg de eigenschap gui_access van het gebruikersgroep object voor een lijst van mogelijke waarden.
debug_mode - (integer) geeft aan of debuggen is ingeschakeld voor de gebruiker. Mogelijke waarden: 0 - debuggen uitgeschakeld, 1 - debuggen ingeschakeld.
users_status - (integer) geeft aan of de gebruiker is uitgeschakeld. Mogelijke waarden: 0 - gebruiker ingeschakeld, 1 - gebruiker uitgeschakeld.
selectMedias query Geeft de door de gebruiker gebruikte media terug in de eigenschap medias.
selectMediatypes query Geeft de door de gebruiker gebruikte mediatypen terug in de eigenschap mediatypes.
selectUsrgrps query Geeft de gebruikersgroepen terug waartoe de gebruiker behoort in de eigenschap usrgrps.
selectRole query Geeft de gebruikersrol terug in de eigenschap role.
sortfield string/array Sorteer het resultaat op basis van de opgegeven eigenschappen.

Mogelijke waarden: userid, username.
countOutput boolean Deze parameters, die gemeenschappelijk zijn voor alle get-methoden, worden in detail beschreven in het referentiecommentaar.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Return values

(integer/array) Returns either:

  • an array of objects;
  • the count of retrieved objects, if the countOutput parameter has been used.

Voorbeelden

Gebruikers ophalen

Haal alle geconfigureerde gebruikers op.

Aanvraag:

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

Reactie:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "userid": "1",
            "username": "Admin",
            "name": "Zabbix",
            "surname": "Administrator",
            "url": "",
            "autologin": "1",
            "autologout": "0",
            "lang": "en_GB",
            "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
}

Gebruikersgegevens ophalen

Haal gegevens op van een gebruiker met ID "12".

Aanvraag:

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

Reactie:

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

Zie ook

Bron

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