Documentation
mfa.get
説明
integer/array mfa.get(object parameters)
このメソッドは、与えられたパラメータに基づいてMFAメソッドを取得します。
このメソッドは、Super admin ユーザータイプでのみ使用できます。 このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳しくは、ユーザーロール をご覧ください。
パラメータ
(object) は、必要な出力を定義するパラメータです。
このメソッドは以下のパラメータをサポートしています。
| パラメータ | タイプ | 説明 |
|---|---|---|
| mfaids | ID/配列 | 指定されたIDのMFAメソッドのみを返します。 |
| selectUsrgrps | クエリ | MFAメソッドに関連付けられたユーザーグループを含む usrgrps プロパティを返します。count をサポートしています。 |
| filter | object | 指定されたフィルターに完全に一致する結果のみを返します。 オブジェクトを受け入れます。キーはプロパティ名、値は照合する単一の値または値の配列です。 サポートされるプロパティ: mfaid - MFA メソッドの IDtype - MFA メソッドのタイプ |
| sortfield | 文字列/配列 | 指定されたプロパティで結果を並べ替えます。 可能な値: name |
| search | object | 指定されたパターンに一致する結果を返します（大文字と小文字は区別されません） オブジェクトを受け入れます。キーはプロパティ名、値は検索する文字列です。追加のオプションが指定されていない場合は、 LIKE "%…%" 検索が実行されます。サポートされるプロパティ: name |
| countOutput | boolean | これらのパラメータについては、リファレンス解説で説明されています。 |
| 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
}Response:
{
"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.