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

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

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

`integer/array mfa.get(object parameters)`

La méthode permet de récupérer les méthodes MFA selon les paramètres fournis.

::: noteclassic
Cette méthode est uniquement disponible pour le type d’utilisateur *Super admin*.
Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur.
Voir [User roles](/manual/web_interface/frontend_sections/users/user_roles) pour plus d’informations.
:::

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

[comment]: # ({92d432f9-b64d62fe})
### Paramètres

`(object)` Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|mfaids|ID/array|Ne renvoyer que les méthodes MFA avec les IDs donnés.|
|selectUsrgrps|query|Renvoyer une propriété `usrgrps` avec les [groupes d'utilisateurs](/manual/api/reference/usergroup/object) associés aux méthodes MFA.<br><br>Prend en charge `count`.|
|filter|object|Ne renvoyer que les résultats qui correspondent exactement au filtre donné.<br><br>Accepte un objet, où les clés sont des noms de propriétés et les valeurs sont soit une valeur unique, soit un tableau de valeurs à comparer.<br><br>Prend en charge les propriétés :<br>`mfaid` - ID de la méthode MFA ;<br>`type` - Type de la méthode MFA.|
|sortfield|string/array|Trier le résultat selon les propriétés données.<br><br>Valeurs possibles : `name`.|
|search|object|Renvoyer les résultats qui correspondent au modèle donné (insensible à la casse).<br><br>Accepte un objet, où les clés sont des noms de propriétés et les valeurs sont des chaînes à rechercher. Si aucune option supplémentaire n'est fournie, cela effectuera une recherche `LIKE "%…%"`.<br><br>Propriétés prises en charge : `name`.|
|countOutput|boolean|Ces paramètres sont décrits dans le [commentaire de référence](/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})
### Valeurs de retour

`(integer/array)` Renvoie soit :

-   un tableau d’objets ;
-   le nombre d’objets récupérés, si le paramètre `countOutput` a été utilisé.

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

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

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

[comment]: # ({b539b291-a4c952d8})
#### Recherche de méthodes MFA par nom

Récupérez toutes les méthodes MFA dont le nom contient « Zabbix ».

[Requête](/manual/api#performing-requests) :

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

Réponse :

```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})
### Source

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

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