mfa.get

Apraksts

integer/array mfa.get(object parameters)

Metode ļauj izgūt MFA metodes atbilstoši norādītajiem parametriem.

Šī metode ir pieejama tikai Super admin lietotāja tipam. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet Lietotāju lomas.

Parametri

(object) Parametri, kas definē vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parameter Type Description
mfaids ID/array Atgriezt tikai MFA metodes ar norādītajiem ID.
selectUsrgrps query Atgriezt usrgrps īpašību ar lietotāju grupām, kas saistītas ar MFA metodēm.

Atbalsta count.
filter object Atgriezt tikai tos rezultātus, kas precīzi atbilst norādītajam filtram.

Pieņem objektu, kur atslēgas ir īpašību nosaukumi, bet vērtības ir vai nu viena vērtība, vai vērtību masīvs, ar ko salīdzināt.

Atbalstītās īpašības:
mfaid - MFA metodes ID;
type - MFA metodes tips.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: name.
search object Atgriezt rezultātus, kas atbilst norādītajam paraugam (nav reģistrjutīgi).

Pieņem objektu, kur atslēgas ir īpašību nosaukumi, bet vērtības ir meklējamās virknes. Ja papildu opcijas nav norādītas, tiks veikta LIKE "%…%" meklēšana.

Atbalstītās īpašības: name.
countOutput boolean Šie parametri ir aprakstīti atsauces komentārā.
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Atgrieztās vērtības

(integer/array) Atgriež vienu no šīm vērtībām:

  • objektu masīvu;
  • iegūto objektu skaitu, ja ir izmantots parametrs countOutput.

Piemēri

MFA metožu atrašana pēc nosaukuma

Iegūstiet visas MFA metodes, kuru nosaukumā ir "Zabbix".

Pieprasījums:

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

Atbilde:

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

Avots

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