mfa.get

Opis

integer/array mfa.get(object parameters)

Ta metoda umożliwia pobieranie metod MFA zgodnie z podanymi parametrami.

Ta metoda jest dostępna tylko dla użytkownika typu Super admin. Uprawnienia do wywołania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji User roles.

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
mfaids ID/array Zwraca tylko metody MFA o podanych identyfikatorach.
selectUsrgrps query Zwraca właściwość usrgrps z grupami użytkowników powiązanymi z metodami MFA.

Obsługuje count.
filter object Zwraca tylko te wyniki, które dokładnie odpowiadają podanemu filtrowi.

Akceptuje obiekt, w którym kluczami są nazwy właściwości, a wartościami są pojedyncza wartość lub tablica wartości do dopasowania.

Obsługiwane właściwości:
mfaid - identyfikator metody MFA;
type - typ metody MFA.
sortfield string/array Sortuje wynik według podanych właściwości.

Możliwe wartości: name.
search object Zwraca wyniki pasujące do podanego wzorca (bez rozróżniania wielkości liter).

Akceptuje obiekt, w którym kluczami są nazwy właściwości, a wartościami są ciągi znaków do wyszukania. Jeśli nie podano dodatkowych opcji, zostanie wykonane wyszukiwanie LIKE "%…%".

Obsługiwane właściwości: name.
countOutput boolean Te parametry opisano w komentarzu referencyjnym.
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Zwracane wartości

(integer/array) Zwraca:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli użyto parametru countOutput.

Przykłady

Wyszukiwanie metod MFA po nazwie

Pobierz wszystkie metody MFA, które mają w nazwie „Zabbix”.

Żądanie:

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

Odpowiedź:

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

Źródło

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