🤖 For AI agents: The complete documentation index is available at /docs/llms.txt. A markdown version of this page is available at /docs/apis/two-factor.md.

Multi-Factor API

Edit on GitHub
View Markdown
Starter plan required

This feature requires at least a Starter plan.

This API controls multi-factor authentication (MFA) options.

Authentication#

Some of these operations can use JWT authentication instead of API key authentication. In some cases, when you have a valid twoFactorId, neither a JWT nor an API key is required.

Learn more about JWT authentication and see examples here.

TOTP Implementation#

Support for Authy, Google Authenticator and other time based one-time password solutions are not premium features and are included in the Community plan.

While there is underlying support for different code lengths, algorithms and time steps, at the current time the system only allows for the following TOTP settings:

Configuration settingCurrently allowed value
authenticator.algorithmHmacSHA1
authenticator.codeLength6
authenticator.timeStep30

Any attempt to change these configuration values will currently be ignored. If you need different configuration settings, please file a GitHub issue detailing your use case.

Enable Multi-Factor

API documentation for the FusionAuth Enable Multi-Factor API.

Disable Multi-Factor

API documentation for the FusionAuth Disable Multi-Factor API.

Update Multi-Factor Method

API documentation for the FusionAuth Update Multi-Factor Method API.

Generate a Secret

API documentation for the FusionAuth Generate a Secret API.

Start Multi-Factor

API documentation for the FusionAuth Start Multi-Factor API.

Retrieve Multi-Factor Status

API documentation for the FusionAuth Retrieve Multi-Factor Status API.

Send a Multi-Factor Code During Login or Step Up

API documentation for the FusionAuth Send a Multi-Factor Code During Login or Step Up API.

Send a Multi-Factor Code When Enabling MFA

API documentation for the FusionAuth Send a Multi-Factor Code When Enabling MFA API.

Send a Multi-Factor Code When Disabling MFA

API documentation for the FusionAuth Send a Multi-Factor Code When Disabling MFA API.

Generate Recovery Codes

API documentation for the FusionAuth Generate Recovery Codes API.

Retrieve Recovery Codes

API documentation for the FusionAuth Retrieve Recovery Codes API.