For AI agents: a documentation index is available at /llms.txt. A markdown version of this page is available at the same URL with .md appended (or via Accept: text/markdown).
Skip to main content

Manage MFA for a user

The manageMFA method is used to trigger manage MFA flow for users, allowing users to update their MFA settings. If you are using default sign-in providers, you don't need to pass LoginParams. If the user signed in with a custom auth connection that needs extra sign-in options (for example, Auth0), pass the same LoginParams you used to sign in.

manageMFA returns a CompletableFuture<Boolean>. It fails with MFA is not enabled. Please enable MFA first. if the user hasn't enabled MFA, and with No user found, please login again! if there's no active session.

The SDK fills in the auth connection details from the current session, so the authConnection value you pass doesn't change which connection is used.

warning
  • Don't pass idToken in LoginParams. The method fails with Enabling MFA is not allowed for this user. if idToken is set.
  • This method isn't available for users who signed in with SFA (connectTo with idToken).

Usage​

val manageMFACF = web3Auth.manageMFA()

manageMFACF.whenComplete{_, error ->
if (error == null) {
// Handle success
} else {
// Handle error
}
}
On this page