User

Two-Factor Authentication

Changed on Aug 6, 2026

Sets the authentication token seed (key) for the user. This key may be then be used in the appropriate 2FA authenticator.

put/api/3/users/{id}/2FA

Request

Base URL
https://<host>:<port>
Auth
none declared
TypeScript
https://skmtc.dev/rapid7/apis/rapid7-vm-api/docs/api/3/users/:id/2FA/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

The identifier of the user.

Example:9

Request body

string required

The authentication token seed (key) to use for the user.

Response

OK

Example response

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ]
}

Changes

Aug 6, 20263a8197c22d71 Revision changes
- breaking
  added required request body
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status

Operation history