The method allows to retrieve users according to the given parameters.

    Parameters

    (object) Parameters defining the desired output.

    The method supports the following parameters.

    • an array of objects;

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

    Examples

    Retrieving users

    Retrieve all of the configured users.

    Response:

    1. {
    2.     "jsonrpc": "2.0",
    3.     "result": [
    4.         {
    5.             "userid": "1",
    6.             "alias": "Admin",
    7.             "name": "Zabbix",
    8.             "url": "",
    9.             "autologin": "1",
    10.             "autologout": "0s",
    11.             "lang": "ru_RU",
    12.             "refresh": "0s",
    13.             "type": "3",
    14.             "theme": "default",
    15.             "attempt_failed": "0",
    16.             "attempt_ip": "",
    17.             "attempt_clock": "0",
    18.             "rows_per_page": "50"
    19.         },
    20.         {
    21.             "userid": "2",
    22.             "alias": "guest",
    23.             "name": "Default2",
    24.             "url": "",
    25.             "autologin": "0",
    26.             "autologout": "15m",
    27.             "lang": "en_GB",
    28.             "refresh": "30s",
    29.             "type": "1",
    30.             "theme": "default",
    31.             "attempt_failed": "0",
    32.             "attempt_ip": "",
    33.             "attempt_clock": "0",
    34.             "rows_per_page": "50"
    35.         }
    36.     ],
    37.     "id": 1
    38. }

    Source

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