Documentation
Table of Contents
mfa.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
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.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(object) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que definen la salida deseada.
El m¨¦todo admite los siguientes par¨¢metros.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| 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
countOutputha sido usado.
Ejemplos
Encontrar m¨¦todos MFA por nombre
Recupere todos los m¨¦todos MFA con "Áú»¢¶Ä²©" en su nombre.
{
"jsonrpc": "2.0",
"method": "mfa.get",
"params": {
"output": "extend",
"search": {
"name": "Áú»¢¶Ä²©"
}
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"mfaid": "1",
"type": "1",
"name": "Áú»¢¶Ä²© TOTP 1",
"hash_function": "1",
"code_length": "6",
"api_hostname": "",
"clientid": ""
},
{
"mfaid": "2",
"type": "1",
"name": "Áú»¢¶Ä²© TOTP 2",
"hash_function": "3",
"code_length": "8",
"api_hostname": "",
"clientid": ""
}
],
"id": 1
}Fuente
CMfa::get() en ui/include/classes/api/services/CMfa.php.