mfa.get

Descrição

integer/array mfa.get(object parameters)

O método permite recuperar métodos MFA de acordo com os parâmetros fornecidos.

Este método está disponível apenas para o tipo de usuário Super admin. As permissões para chamar o método podem ser revogadas nas configurações de função de usuário. Consulte Funções de usuário para mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

Parâmetro	Tipo	Descrição
mfaids	ID/array	Retorna apenas métodos MFA com os IDs fornecidos.
selectUsrgrps	query	Retorna uma propriedade `usrgrps` com grupos de usuários associados aos métodos MFA. Suporta `count`.
filter	object	Retorna apenas os resultados que correspondem exatamente ao filtro fornecido. Aceita um objeto, onde as chaves são nomes de propriedades e os valores são um único valor ou um array de valores para comparar. Suporta propriedades: `mfaid` - ID do método MFA; `type` - Tipo do método MFA.
sortfield	string/array	Ordena o resultado pelas propriedades fornecidas. Valores possíveis: `name`.
search	object	Retorna resultados que correspondam ao padrão fornecido (case-insensitive). Aceita um objeto, onde as chaves são nomes de propriedades e os valores são strings a serem pesquisadas. Se nenhuma opção adicional for fornecida, será realizada uma busca `LIKE "%…%"`. Propriedades suportadas: `name`.
countOutput	boolean	Esses parâmetros são descritos no comentário de referência.
excludeSearch	boolean
limit	integer
output	query
preservekeys	boolean
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valores de retorno

(integer/array) Retorna:

um array de objetos;
a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Encontrando métodos MFA pelo nome

Recupere todos os métodos MFA com "Zabbix" em seu nome.

Requisição:

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

Fonte

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

Documentation