mfa.get

説明

integer/array mfa.get(object parameters)

このメソッドは、与えられたパラメータに基づいてMFAメソッドを取得します。

このメソッドは、Super admin ユーザータイプでのみ使用できます。 このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳しくは、ユーザーロール をご覧ください。

パラメータ

(object) 目的の出力を定義するパラメータ。

このメソッドは次のパラメータをサポートします。

Parameter Type Description
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 これらのパラメータは reference commentary で説明されています。
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.