user.resettotp

説明

object user.resettotp(object/array users)

このメソッドは、ユーザーのTOTP秘密鍵をリセットします。

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

パラメータ

(配列) TOTP秘密鍵をリセットするユーザーのID

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

戻り値

(object) useridsプロパティの下にある削除されたユーザーのIDを含むオブジェクトを返します。

例

複数のユーザーの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.