delete https://api.banking.netevia.dev/settings/MfaSecret
API Method: DELETE /settings/MfaSecret
DELETE /settings/MfaSecretDescription:
This API method removes or deactivates the common Multi-Factor Authentication (MFA) secret for a user's account in a banking application. Once the secret is removed, the user will no longer be able to generate one-time passwords (OTPs) using an authenticator app (e.g., Google Authenticator or Authy), effectively disabling the TOTP-based MFA for the account.
Endpoint:
DELETE /settings/MfaSecret
Functionality:
- Purpose: Deletes the shared MFA secret, preventing further use of an authenticator app for generating time-based one-time passwords (TOTP) during login or other secure actions.
- User Flow: When a user decides to disable their authenticator-based MFA, this API is called to remove the secret that the authenticator app relies on. After successful removal, the user will no longer need to enter OTPs generated from the app for authentication.
Request Headers:
- Authorization: Bearer token required to authenticate the user and authorize the removal of the MFA secret.
- Content-Type:
application/json
Request Body:
- This API method typically does not require a request body. The bearer token identifies the user, and the MFA secret is removed from their account.
Response:
-
200 OK: Indicates that the MFA secret has been successfully removed. The response confirms that the user’s account no longer has an active TOTP-based MFA.
-
401 Unauthorized: If the bearer token is invalid or expired, indicating that the user is not authenticated.
-
500 Internal Server Error: If there is an issue removing the MFA secret due to a server-side error.
Notes:
- Disabling MFA: Removing the MFA secret effectively disables the use of an authenticator app for generating OTPs. However, other forms of MFA (e.g., SMS or email) might still be active if they were enabled separately.
- Security Implications: Removing the MFA secret reduces account security by eliminating the need for OTPs from an authenticator app, making it crucial for the user to ensure other security measures (such as strong passwords or alternative MFA methods) are in place.
- This endpoint is typically used in account settings where users manage their MFA preferences.