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/array Devuelve solo los métodos MFA con los ID proporcionados.
selectUsrgrps query Devuelve una propiedad usrgrps con los grupos de usuarios asociados a los métodos MFA.

Admite count.
filter object Devuelve solo aquellos resultados que coincidan exactamente con el filtro proporcionado.

Acepta un objeto, donde las claves son nombres de propiedades y los valores son un valor único o un array de valores con los que se debe coincidir.

Admite las propiedades:
mfaid - ID del método MFA;
type - Tipo del método MFA.
sortfield string/array Ordena el resultado por las propiedades proporcionadas.

Valores posibles: name.
search object Devuelve resultados que coincidan con el patrón proporcionado (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 boolean Estos parámetros se describen en los comentarios de referencia.
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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.