integer/array mfa.get(object parameters)
此方法允许根据给定参数检索 MFA 方法。
此方法仅适用于 超级管理员 用户类型。 可以在用户角色设置中撤销调用该方法的权限。 查阅用户角色 了解更多信息。
(object)
定义所需输出的参数。
该方法支持以下参数。
参数 | 类型 | 描述 |
---|---|---|
mfaids | ID/数组 | 仅返回具有指定ID的MFA方法。 |
selectUsrgrps | 查询 | 返回一个usrgrps 属性,其中包含与MFA方法关联的用户组。支持 count 。 |
filter | 对象 | 仅返回与给定过滤器完全匹配的结果。 接受一个对象,其中键是属性名称,值是与之匹配的单个值或值数组。 支持属性: mfaid - MFA方法的ID;type - MFA方法的类型。 |
sortfield | 字符串/数组 | 根据给定属性对结果进行排序。 可能的值: name 。 |
search | 对象 | 返回与给定模式匹配的结果(不区分大小写)。 接受一个对象,其中键是属性名称,值是用于搜索的字符串。如果没有给出其他选项,这将执行一个 LIKE "%…%" 搜索。支持的属性: name 。 |
countOutput | 布尔值 | 这些参数在参考说明中有描述。 |
excludeSearch | 布尔值 | |
limit | 整数 | |
output | 查询 | |
preservekeys | 布尔值 | |
searchByAny | 布尔值 | |
searchWildcardsEnabled | 布尔值 | |
sortorder | 字符串/数组 | |
startSearch | 布尔值 |
(integer/array)
返回两者其中任一:
countOutput
参数,则检索对象的计数。检索名称中包含"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。