User

Two-Factor Authentication

Regenerates a new authentication token seed (key) and updates it for the user. This key may be then be used in the appropriate 2FA authenticator.

post/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/post.ts
A function with typed inputs. Its response is checked against the schema.

idinteger required

The identifier of the user.

Example:9

keystring

The two-factor authentication token seed (key).

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