Reset Users TOTP

Prev Next
Post
/api/v1/users.resetTOTP

Reset 2FA via TOTP for a user in the workspace. Make sure that the Enable Two Factor Authentication setting is enabled under Administration > Settings > Accounts > Two Factor Authentication.

  • It requires the edit-other-user-totp permission.
  • It requires two-factor authentication.

Changelog

Version Description
3.6.0 Added
Header parameters
X-Auth-Token
stringRequired

The authenticated user token.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The authenticated user ID.

ExamplerbAXPnMktTFbNpwtJ
x-2fa-code
stringRequired

The 2fa code. See Introduction to Two-Factor Authentication.

Example148750
x-2fa-method
stringRequired

The desired method to get the 2FA code. It can be email, totp, or password.

Body parameters
Example 1
{
  "userId": "GonjPyg3gB3Z9ur9s"
}
object
userId
string

The userId of the user whose TOTP you want to reset. You can also use the username. If you do not enter a value, the sender's TOTP is reset.

Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "TOTP Required [totp-required]",
  "errorType": "totp-required",
  "details": {
    "method": "password",
    "codeGenerated": false,
    "availableMethods": []
  }
}
Example 2
{
  "success": false,
  "error": "Not allowed [error-not-allowed]",
  "errorType": "error-not-allowed"
}
Example 3
{
  "success": false,
  "error": "The required \"userId\" or \"username\" param provided does not match any users [error-invalid-user]",
  "errorType": "error-invalid-user"
}
Expand All
object
success
boolean
error
string
errorType
string
details
object
method
string
codeGenerated
boolean
availableMethods
Array of object
object
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string