mfa.get
説明
integer/array connector.get(object parameters)
このメソッドは、与えられたパラメーターに従ってコネクタオブジェクトを取得することができます。
このメソッドは、Super adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメータ
(object) 目的の出力を定義するパラメータです。
このメソッドは以下のパラメータをサポートしています。
| パラメータ | 型 | 説明 |
|---|---|---|
| mfaids | ID/array | 指定したIDを持つMFA方式のみを返します。 |
| selectUsrgrps | query | MFA方式に関連付けられた ユーザーグループ を含む usrgrps プロパティを返します。count をサポートします。 |
| filter | object | 指定したフィルターに完全に一致する結果のみを返します。 キーがプロパティ名、値が照合対象の単一の値または値の配列であるオブジェクトを受け付けます。 サポートされるプロパティ: mfaid - MFA方式のID;type - MFA方式のタイプ。 |
| sortfield | string/array | 指定したプロパティで結果をソートします。 指定可能な値: 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.