[comment]: # ({bd1d3801-e25d0b8e})
# mfa.get

[comment]: # ({/bd1d3801-e25d0b8e})

[comment]: # ({5967f82a-32584e90})
### Описание

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

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

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

[comment]: # ({/5967f82a-32584e90})

[comment]: # ({92d432f9-b64d62fe})
### Параметры

`(object)` Параметры, определяющие требуемый результат.

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

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|mfaids|ID/array|Возвращать только методы MFA с указанными ID.|
|selectUsrgrps|query|Возвращать свойство `usrgrps` с [группами пользователей](/manual/api/reference/usergroup/object), связанными с методами MFA.<br><br>Поддерживает `count`.|
|filter|object|Возвращать только те результаты, которые в точности соответствуют заданному фильтру.<br><br>Принимает объект, где ключи — это имена свойств, а значения — либо одно значение, либо массив значений для сопоставления.<br><br>Поддерживаемые свойства:<br>`mfaid` - ID метода MFA;<br>`type` - тип метода MFA.|
|sortfield|string/array|Сортировать результат по указанным свойствам.<br><br>Возможные значения: `name`.|
|search|object|Возвращать результаты, соответствующие заданному шаблону (без учета регистра).<br><br>Принимает объект, где ключи — это имена свойств, а значения — строки для поиска. Если дополнительные параметры не указаны, будет выполнен поиск `LIKE "%…%"`.<br><br>Поддерживаемые свойства: `name`.|
|countOutput|boolean|Эти параметры описаны в [справочном комментарии](/manual/api/reference_commentary#common-get-method-parameters).|
|excludeSearch|boolean|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/92d432f9-b64d62fe})

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

`(integer/array)` Возвращает либо:

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

[comment]: # ({/07ca11ca-be3c5307})

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

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

[comment]: # ({b539b291-a4c952d8})
#### Поиск методов MFA по имени

Получить все методы MFA, в названии которых есть "Zabbix".

[Запрос](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "mfa.get",
    "params": {
        "output": "extend",
        "search": {
            "name": "Zabbix"
        }
    },
    "id": 1
}
```

Ответ:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "mfaid": "1",
            "type": "1",
            "name": "Zabbix TOTP 1",
            "hash_function": "1",
            "code_length": "6",
            "api_hostname": "",
            "clientid": ""
        },
        {
            "mfaid": "2",
            "type": "1",
            "name": "Zabbix TOTP 2",
            "hash_function": "3",
            "code_length": "8",
            "api_hostname": "",
            "clientid": ""
        }
    ],
    "id": 1
}
```

[comment]: # ({/b539b291-a4c952d8})

[comment]: # ({35eefc20-fdffee34})
### Исходный код

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

[comment]: # ({/35eefc20-fdffee34})