Generate TOTP secret

GET

/mfa/totp/generate

• Nhost Authentication API Server

Generate a Time-based One-Time Password (TOTP) secret for setting up multi-factor authentication

Authorizations

• BearerAuth

Responses

200

TOTP secret successfully generated

Response containing TOTP setup information for MFA

object

imageUrl

required

URL to QR code image for scanning with an authenticator app

string

Example

data:image/png;base64,iVBORw0KGg...

totpSecret

required

TOTP secret key for manual setup with an authenticator app

string

Example

ABCDEFGHIJK23456

default

An error occurred while processing the request

Standardized error response

object

status

required

HTTP status error code

integer

Example

400

message

required

Human-friendly error message

string

Example

Invalid email format

error

required

Error code identifying the specific application error

string

Allowed values: default-role-must-be-in-allowed-roles disabled-endpoint disabled-user email-already-in-use email-already-verified forbidden-anonymous internal-server-error invalid-email-password invalid-request locale-not-allowed password-too-short password-in-hibp-database redirectTo-not-allowed role-not-allowed signup-disabled unverified-user user-not-anonymous invalid-pat invalid-refresh-token invalid-ticket disabled-mfa-totp no-totp-secret invalid-totp mfa-type-not-found totp-already-active invalid-state oauth-token-echange-failed oauth-profile-fetch-failed oauth-provider-error invalid-otp cannot-send-sms provider-account-already-linked