Skip to main content
POST
Initiate MFA setup

Authorizations

nile-auth.session-token
string
cookie
required

Session token stored in a cookie after user signs in, prefixed with __Secure if on https

Path Parameters

database
string
required

The string (id or name, depending on the credentials)

Response

MFA setup challenge created.

ok
boolean
required
method
enum<string>
required
Available options:
authenticator,
email
token
string
required
expiresAt
string<date-time>
required
scope
enum<string>
required
Available options:
setup
otpauthUrl
string

Present when the user is enrolling an authenticator app.

secret
string

Base32 secret returned for authenticator enrollment.

maskedEmail
string

Masked email address used for email OTP delivery.