mfa.get

Beschreibung

integer/array mfa.get(object parameters)

Diese Methode ermöglicht es, MFA-Methoden entsprechend den angegebenen Parametern abzurufen.

Diese Methode ist nur für den Benutzertyp Super admin verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Typ Beschreibung
mfaids ID/array Nur MFA-Methoden mit den angegebenen IDs zurückgeben.
selectUsrgrps query Eine usrgrps-Eigenschaft mit den Benutzergruppen zurückgeben, die mit MFA-Methoden verknüpft sind.

Unterstützt count.
filter object Nur Ergebnisse zurückgeben, die genau dem angegebenen Filter entsprechen.

Akzeptiert ein Objekt, wobei die Schlüssel Eigenschaftsnamen sind und die Werte entweder ein einzelner Wert oder ein Array von Werten sind, mit denen verglichen werden soll.

Unterstützte Eigenschaften:
mfaid - ID der MFA-Methode;
type - Typ der MFA-Methode.
sortfield string/array Das Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: name.
search object Ergebnisse zurückgeben, die dem angegebenen Muster entsprechen (Groß-/Kleinschreibung wird nicht berücksichtigt).

Akzeptiert ein Objekt, wobei die Schlüssel Eigenschaftsnamen sind und die Werte Zeichenfolgen sind, nach denen gesucht werden soll. Wenn keine zusätzlichen Optionen angegeben sind, wird eine LIKE "%…%"-Suche ausgeführt.

Unterstützte Eigenschaften: name.
countOutput boolean Diese Parameter werden in der Referenzkommentierung beschrieben.
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Gibt entweder:

  • eine Reihe von Objekten zurück;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde zurück.

Beispiele

MFA-Methoden nach Namen finden

Rufen Sie alle MFA-Methoden ab, die „Zabbix“ in ihrem Namen enthalten.

Anfrage:

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

Antwort:

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

Quelle

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