Skip to main content
POST
Start enrolling a required MFA factor

Body

application/json
mfaToken
string
required

The enrollment-only token of a 401 AUT-0019 refusal.

Example:

"eyJhbGciOiJIUzI1NiJ9..."

mfaType
enum<string>
required

The factor to enroll: one of the availableMethods of the AUT-0019 refusal.

Available options:
app,
email
Example:

"app"

Response

OK

mfaType
string
required
Example:

"app"

recoveryCodes
string[] | null
required

The recovery code to show once and ask the person to keep.

secret
string

The authenticator secret for manual entry. App only.

Example:

"JBSWY3DPEHPK3PXP"

url
string

The otpauth URI to render as a QR code. App only.

Example:

"otpauth://totp/Lerian:ana?secret=JBSWY3DPEHPK3PXP"