mfa.get

Description

integer/array mfa.get(object parameters)

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

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 pour plus d’informations.

Paramètres

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

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

Paramètre Type Description
mfaids ID/array Retourner uniquement les méthodes MFA avec les ID donnés.
selectUsrgrps query Retourner une propriété usrgrps avec les groupes d’utilisateurs associés aux méthodes MFA.

Prend en charge count.
filter object Retourner uniquement les résultats qui correspondent exactement au filtre donné.

Accepte un objet, où les clés sont des noms de propriété, et les valeurs sont soit une valeur unique, soit un tableau de valeurs à comparer.

Prend en charge les propriétés suivantes :
mfaid - ID de la méthode MFA ;
type - Type de la méthode MFA.
sortfield string/array Trier le résultat selon les propriétés données.

Valeurs possibles : name.
search object Retourner les résultats qui correspondent au motif donné (insensible à la casse).

Accepte un objet, où les clés sont des noms de propriété, et les valeurs sont des chaînes à rechercher. Si aucune option supplémentaire n’est fournie, cela effectuera une recherche LIKE "%…%".

Propriétés prises en charge : name.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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é.

Exemples

Recherche de méthodes MFA par nom

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

Requête :

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

Réponse :

{
    "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
}

Source

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