mfa.get

Descripción

entero/matriz mfa.get (parámetros del objeto)

El método permite recuperar métodos MFA según los parámetros dados.

Este método solo está disponible para el tipo de usuario Super administrador. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Consulte Roles de usuario para obtener más información.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro	Tipo	Descripción
mfaids	ID/matriz	Devuelve solo métodos MFA con los ID indicados.
selectUsrgrps	consulta	Devuelve una propiedad `usrgrps` con grupos de usuarios asociados con métodos MFA. Admite `count`.
filter	objeto	Devuelve solo los resultados que coinciden exactamente con el filtro indicado. Acepta un objeto, donde las claves son nombres de propiedades y los valores son un valor único o una matriz de valores con los que se realizará la búsqueda. Admite propiedades: `mfaid` - ID del método MFA; `type` - Tipo del método MFA.
sortfield	cadena/matriz	Ordena el resultado por las propiedades indicadas. Valores posibles: `name`.
search	objeto	Devuelve los resultados que coinciden con el patrón indicado (sin distinguir entre mayúsculas y minúsculas). Acepta un objeto, donde las claves son nombres de propiedades y los valores son cadenas para buscar. Si no se proporcionan opciones adicionales, se realizará una búsqueda `LIKE "%…%"`. Propiedades admitidas: `name`.
countOutput	booleano	Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en la página comentario de referencia.
excludeSearch	booleano
limit	integer
output	query
preservekeys	booleano
searchByAny	booleano
searchWildcardsEnabled	booleano
sortorder	cadena/matriz
startSearch	booleano

Valores de devueltos

(integer/array) Devuelve:

una matriz de objetos;
la suma de los objetos devueltos, si el parámetro countOutput ha sido usado.

Ejemplos

Encontrar métodos MFA por nombre

Recupere todos los métodos MFA con "Zabbix" en su nombre.

Solicitud:

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

Respuesta:

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

Fuente

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

Documentation