Skip to navigation

Admin Reset User Multi-Factor Authentication

View as Markdown

Resets user Multi-Factor Authentication (MFA) by Company Admin.

You can use this endpoint, for example, if a user has lost their MFA device and MFA has been enabled. The user cannot log in so a Company Admin needs to reset their MFA, after which the user can set MFA up again later on their device during log in.

This is equivalent to resetting MFA for a user from the Company > Manage Users option in the Megaport Portal. For more information, see Adding and Modifying Users.

You can find the employee ID (personId) using the GET List Company Users /v2/employment endpoint.

Path parameters

employeeIdstringRequired

Response

Admin Reset User Multi-Factor Authentication - Success / Admin Reset User Multi-Factor Authentication - Success

messagestringOptional
termsstringOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error