v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB

Enrollment

Start TOTP enrollment

Returns a TOTP secret and an otpauth:// provisioning URI. Render the URI as a QR code (or expose the base32 secret) so the user can add the entry to their authenticator app, then call /user/resume/setup-two-factor with the first 6-digit code. — Requires 'totp' to be present in the application's allowedScaMethods.

post/user/start/setup-two-factor

Request body

userIdstring required

Response

TOTP secret and provisioning URI.

secretstring

Raw TOTP secret.

secretBase32Encodedstring

Base32-encoded TOTP secret for authenticator apps.

totpUristring

otpauth://totp/... URI; encode as a QR code on the client.