Documentation
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；
- 如果使用了
countOutput参数，则为检索到的 objects 的数量。
示例
按名称查找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 中。