mfa.get

Descrizione

integer/array mfa.get(object parameters)

Il metodo consente di recuperare i metodi MFA in base ai parametri specificati.

Questo metodo è disponibile solo per il tipo di utente Super admin. Le autorizzazioni per chiamare il metodo possono essere revocate nelle impostazioni del ruolo utente. Per ulteriori informazioni, vedere Ruoli utente.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parameter Type Description
mfaids ID/array Restituisce solo i metodi MFA con gli ID specificati.
selectUsrgrps query Restituisce una proprietà usrgrps con i gruppi utente associati ai metodi MFA.

Supporta count.
filter object Restituisce solo i risultati che corrispondono esattamente al filtro specificato.

Accetta un oggetto, in cui le chiavi sono nomi di proprietà e i valori sono un singolo valore o un array di valori da confrontare.

Supporta le proprietà:
mfaid - ID del metodo MFA;
type - Tipo del metodo MFA.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: name.
search object Restituisce i risultati che corrispondono al pattern specificato (senza distinzione tra maiuscole e minuscole).

Accetta un oggetto, in cui le chiavi sono nomi di proprietà e i valori sono stringhe da cercare. Se non vengono fornite opzioni aggiuntive, verrà eseguita una ricerca LIKE "%…%".

Proprietà supportate: name.
countOutput boolean Questi parametri sono descritti nella reference commentary.
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valori restituiti

(intero/array) Restituisce:

  • un array di oggetti;
  • il conteggio degli oggetti recuperati, se è stato utilizzato il parametro countOutput.

Esempi

Ricercare metodi MFA per nome

Recupera tutti i metodi MFA con "Zabbix" nel nome.

Richiesta:

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

Risposta:

{
"jsonrpc": "2.0",
"risultato": [
{
"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
}

Sorgente

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