mfa.get

Descripció

integer/array mfa.get(object parameters)

El mètode permet recuperar els mètodes MFA segons els paràmetres proveïts.

Aquest mètode és disponible només per a usuaris de tipus Super admin. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre Tipus Descripció
mfaids ID/array Retorna només els mètodes MFA amb els IDs donats.
selectUsrgrps query Retorna una propietat usrgrps amb grups d'usuaris associats amb els mètodes MFA.

Admet count.
filter object Retorna només resultats que coincideixen exactament amb el filtre donat.

Admet un objecte, on les claus són noms de propietat i els valors són un valor únic o una matriu de valors per comparar.

Admet les propietats:
mfaid - ID del mètode MFA;
type - Tipus del mètode MFA.
sortfield string/array Ordena el resultat segons les propietats donades.

Valors possibles: name.
search object Retorna el resultat que coincideix amb el patró donat (sensible a majúscules i minúscules).

Valors possibles: name.
countOutput boolean Com que aquests paràmetres són comuns a tots els mètodes get, es descriuen detalladament a comentari de referència.
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valors de retorn

(integer/array) Retorna un d'entre:

  • una taula d'objectes;
  • el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Trobar mètodes MFA per nom

Recupera tots els mètodes MFA que ténen "Zabbix" al seu nom.

Petició:

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

Resposta:

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

Font

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