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

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

El método admite los siguientes parámetros.

Parámetro	Tipo	Descripción
mfaids	ID/array	Devuelve sólo métodos MFA con los ID proporcionados.
selectUsrgrps	query	Devuelve una propiedad `usrgrps` con grupos de usuarios asociada con métodos MFA. Admite `count`.
filtro	objeto	Devuelve sólo aquellos resultados que coinciden exactamente con el filtro dado. 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 comparar. Propiedades compatibles: `mfaid` - ID del método MFA; `type` - Tipo del método MFA.
sortfield	cadena/matriz	Ordena el resultado según las propiedades dadas. Valores posibles: `nombre`.
búsqueda	objeto	Devuelve resultados que coinciden con el patrón dado (no distingue entre mayúsculas y minúsculas). Valores posibles: `nombre`.
countOutput	boolean	Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en la página comentario de referencia.
excluirBuscar	booleano
límite	entero
salida	consulta
preservekeys	booleano
searchByAny	booleano
searchWildcardsEnabled	booleano
clasificación	cadena/matriz
iniciarBuscar	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