获取

获取

描述

integer/array mfa.get(object parameters)

此方法允许根据给定参数检索 MFA 方法。

此方法仅适用于 超级管理员 用户类型。可以在用户角色设置中撤销调用该方法的权限。查阅用户角色了解更多信息。

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数	类型	描述
mfaids	ID/array	仅返回具有给定 ID 的 MFA 方法。
selectUsrgrps	query	返回一个 `usrgrps` 属性，其中包含与 MFA 方法关联的用户组。支持 `count`.
filter	object	仅返回与给定过滤器完全匹配的结果。接受一个对象，其中键是属性名称，同时值是要匹配的单个值或值数组。支持属性： `mfaid` - MFA方法的ID; `type` - MFA 方法的类型。
sortfield	string/array	按给定属性对结果进行排序。可能的值： `name`。
search	object	返回与给定模式匹配的结果(不区分大小写)。可能的值： `name`。
countOutput	boolean	这些对于所有 `get` 方法通用的参数在参考注释页面中有详细描述。
excludeSearch	boolean
limit	integer
output	query
preservekeys	boolean
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

返回值

(integer/array) 返回两者其中任一：

一组对象;
如果已经使用了 countOutput 参数，则检索对象的计数。

示例

按名称查找 MFA 方法

检索名称中包含”Zabbix” 的所有 MFA 方法。

请求:

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

响应：

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

来源

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