- Email: for email verification.
- Phone: for SMS verification.
- OTP: for One-Time Passwords (OTPs) used with authenticator applications, such as Google Authenticator.
Schema
The schema applies to MFA factors for both of the following workflows.Automatic migration
MFA enrollments can also be imported during an automatic migration. This can be accomplished by providing any existing enrollments in themfa_factors
field of the user that is provided to the callback at the end of your custom DB login script.
Any failures will appear in your tenant logs as failed logins, and will be distinguishable from other failures by their description: Unable to import MFA factors
. For example:
Bulk user import
- Prepare a
users.json
file. See bulk user imports for details. - Include existing MFA enrollments for each user.
- Start a bulk user import.
- Update the factors of any existing users by enabling the
upsert
option in your initial request. - Once the import job completes, check the response for any errors. If any of the users’ MFA factors failed to import, you will see errors such as:
upsert
option, any non-MFA related updates to existing users will have been applied to the user’s profile. For example, the following error summary shows the user’s picture
attribute was successfully set to http://example.org/jdoe.png
, however we were unable to import the provided MFA factors. In cases like this, it is safe to retry the import for failed users.