[comment]: # translation:outdated

[comment]: # ({2485e0f7-2485e0f7})
# user.get

[comment]: # ({/2485e0f7-2485e0f7})

[comment]: # ({36f89e39-36f89e39})
### Описание

`integer/array user.get(параметры объекта)`

Метод позволяет получать пользователей по заданным параметрам.

::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/administration/user_roles).
:::

[comment]: # ({/36f89e39-36f89e39})

[comment]: # ({new-888512e9})
### Параметры

`(объект)` Параметры задают желаемый вывод.

Этот метод поддерживает следующие параметры.

|Параметр|Тип|Описание|
|----------------|------|----------------|
|mediaids|строка/массив|Возврат только тех пользователей, которые используют заданные оповещения пользователя.|
|mediatypeids|строка/массив|Возврат только тех пользователей, которые используют заданные способы оповещения.|
|userids|строка/массив|Возврат пользователей только с заданными ID.|
|usrgrpids|строка/массив|Возврат только тех пользователей, которые принадлежат заданным группам пользователей.|
|getAccess|флаг|Добавление дополнительной информации о правах доступа пользователя.<br><br>Добавление следующих свойств каждому пользователю:<br>`gui_access` - *(целое число)* метод аутентификации пользователя в веб-интерфейсе. Обратитесь к свойству `gui_access` [объекта группы пользователей](/ru/manual/api/reference/usergroup/object#группа_пользователей) для получения списка возможных значений.<br>`debug_mode` - *(целое число)* указывает, активирован ли пользователю режим отладки. Возможные значения: 0 - режим отладки деактивирован, 1 - режим отладки активирован.<br>`users_status` - *(целое число)* указывет, активирован ли пользователь. Возможные значения: 0 - пользователь активирован, 1 - пользователь деактивирован.|
|selectMedias|запрос|Возврат оповещений пользователея, которые используются пользователем, в свойстве `medias`.|
|selectMediatypes|запрос|Возврат способов оповещения, которые используются пользователем, в свойстве `mediatypes`.|
|selectUsrgrps|запрос|Возврат групп пользователей, которым принадлежат пользователи, в свойстве `usrgrps`.|
|sortfield|строка/массив|Сортировка результата в соответствии с заданными свойствами.<br><br>Возможные значения: `userid` и `alias`.|
|countOutput|логический|Эти параметры являются общими для всех методов `get` и они описаны в [справочных комментариях](/ru/manual/api/reference_commentary#общие_параметры_get_метода).|
|editable|логический|^|
|excludeSearch|логический|^|
|filter|объект|^|
|limit|целое число|^|
|output|запрос|^|
|preservekeys|логический|^|
|search|объект|^|
|searchByAny|логический|^|
|searchWildcardsEnabled|логический|^|
|sortorder|строка/массив|^|
|startSearch|логический|^|

[comment]: # ({/new-888512e9})

[comment]: # ({7223bab1-7223bab1})
### Возвращаемые значения

`(целое число/массив)` Возвращает либо:

- · массив объектов;
- · количество извлеченных объектов, если использовался параметр `countOutput`.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Примеры

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({new-7b5c610b})
#### Получение пользователей

Получение всех добавленных пользователей.

Запрос:

``` {.java}
{
    "jsonrpc": "2.0",
    "method": "user.get",
    "params": {
        "output": "extend"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Ответ:

``` {.java}
{
    "jsonrpc": "2.0",
    "result": [
        {
            "userid": "1",
            "alias": "Admin",
            "name": "Zabbix",
            "surname": "Administrator",
            "url": "",
            "autologin": "1",
            "autologout": "0s",
            "lang": "ru_RU",
            "refresh": "0s",
            "type": "3",
            "theme": "default",
            "attempt_failed": "0",
            "attempt_ip": "",
            "attempt_clock": "0",
            "rows_per_page": "50"
        },
        {
            "userid": "2",
            "alias": "guest",
            "name": "Default2",
            "surname": "User",
            "url": "",
            "autologin": "0",
            "autologout": "15m",
            "lang": "en_GB",
            "refresh": "30s",
            "type": "1",
            "theme": "default",
            "attempt_failed": "0",
            "attempt_ip": "",
            "attempt_clock": "0",
            "rows_per_page": "50"
        }
    ],
    "id": 1
}
```

[comment]: # ({/new-7b5c610b})

[comment]: # ({new-746d14f7})
#### Retrieving users as *Admin*

As an *Admin* type user, retrieve detailed data about your own user and limited data for users in your user group.

Request:

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

Response:

```json
{
    "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"
                }
            ]
        },
        {
            "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",
            "gui_access": "0",
            "debug_mode": "0",
            "users_status": "0",
            "usrgrps": [
                {
                    "usrgrpid": "7",
                    "name": "Zabbix administrators",
                    "gui_access": "0",
                    "users_status": "0",
                    "debug_mode": "0"
                }
            ],
            "medias": [
                {
                    "mediaid": "2",
                    "userid": "3",
                    "mediatypeid": "1",
                    "sendto": [
                        "john.doe@example.com"
                    ],
                    "active": "0",
                    "severity": "63",
                    "period": "1-7,00:00-24:00"
                }
            ],
            "mediatypes": [
                {
                    "mediatypeid": "1",
                    "type": "0",
                    "name": "Email",
                    "status": "0",
                    "description": "",
                    "maxattempts": "3"
                }
            ],
            "role": {
                "roleid": "2",
                "name": "Admin role",
                "type": "2",
                "readonly": "0"
            }
        }
    ],
    "id": 1
}
```

[comment]: # ({/new-746d14f7})

[comment]: # ({new-d85f9654})
### Смотрите также

-   [Оповещение
    пользователя](/ru/manual/api/reference/user/object#оповещение_пользователя)
-   [Способ
    оповещения](/ru/manual/api/reference/mediatype/object#способ_оповещения)
-   [Группа
    пользователей](/ru/manual/api/reference/usergroup/object#группа_пользователей)

[comment]: # ({/new-d85f9654})

[comment]: # ({new-8d892781})
### Исходный код

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

[comment]: # ({/new-8d892781})

[comment]: # ({842f2a42-842f2a42})
### Источник

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

[comment]: # ({/842f2a42-842f2a42})