mfa.get

描述

integer/array mfa.get(object parameters)

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

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

参数

(object) 定义期望输出的参数.

该方法支持以下参数.

参数	数据类型	描述
mfaids	ID/array	仅返回具有指定ID的MFA方法.
selectUsrgrps	query	返回一个包含与MFA方法关联的user groups的`usrgrps`属性. 支持`count`.
filter	object	仅返回完全匹配给定筛选条件的结果. 接受一个object,其中键是属性名称,值是要匹配的单个值或array值. 支持的属性: `mfaid` - MFA方法的ID; `type` - MFA方法的类型.
sortfield	string/array	按给定属性对结果进行排序. 可能的值: `name`.
search	object	返回匹配给定模式的结果(不区分大小写). 接受一个object,其中键是属性名称,值是要搜索的字符串.如果没有给出其他选项,将执行`LIKE "%…%"`搜索. 支持的属性: `name`.
countOutput	boolean	这些参数在通用get方法参数中有描述.
excludeSearch	boolean
limit	integer
output	query
preservekeys	boolean
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

返回值

(integer/array) 返回以下两种结果之一:

一个包含array的objects数组
检索到的objects数量（当使用了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() 位于 ui/include/classes/api/services/CMfa.php 文件中。

Documentation

mfa.get

描述

参数

返回值

示例

按名称查找MFA方法

来源