user.resettotp

説明

object user.resettotp(object/array users)

このメソッドを使用すると、ユーザーの TOTP シークレットをリセットできます。

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

パラメータ

(配列) TOTPシークレットをリセットするユーザーのID

指定されたユーザーのユーザーセッションも削除されます（リクエストを送信したユーザーを除く）。

戻り値

(object) TOTPシークレットがリセットされたユーザーのIDをuseridsプロパティに格納したオブジェクトを返します。

例

複数のユーザーのTOTPシークレットのリセット

2人のユーザーのTOTPシークレットをリセットします。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "user.resettotp",
    "params": [
        "1",
        "5"
    ],
    "id": 1
}

レスポンス :

{
    "jsonrpc": "2.0",
    "result": {
        "userids": [
            "1",
            "5"
        ]
    },
    "id": 1
}

参照

ソース

CUser::resettotp() in ui/include/classes/api/services/CUser.php.