Begin TOTP enrolment

POST/api/auth/totp/enroll

totpEnroll

Generates a fresh shared secret + provisioning URI. The user must verify a code via `/api/auth/totp/confirm` before TOTP is treated as enabled. **Requires sudo-mode** (plans/auth-flows.md slice #5) — *unless* the account has no step-up credential yet (a freshly OAuth-claimed / passwordless account enrolling its **first** factor, which has no way to acquire sudo). When sudo is required and the window has elapsed the response is `403 { error: "sudo_required", challenge: "password"|"totp" }`; the SPA's interceptor prompts for the matching factor via `/api/auth/sudo/{password,totp}` and retries. The request body's `password` field is retained for wire-compat but ignored — re-auth is enforced by the sudo-or-first-credential extractor, not a password recheck.

Requires authentication using a session cookie — see tokens and scopes.

curl

curl -X POST 'https://neosource.dev/api/auth/totp/enroll' \
  -b 'ns_session=$NEOSOURCE_SESSION' \
  -H 'Content-Type: application/json' \
  -d '{"password":"string"}'

fetch

fetch("https://neosource.dev/api/auth/totp/enroll", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify({"password":"string"}),
});

Request bodyrequired

application/json

TotpEnrollRequest

object

passwordrequired: string
Re-auth: the user's current password.

additional propertiesnot allowed

Responses

200Pending secret

application/json

TotpEnrollResponse

object

provisioning_urirequired: string
secret_b32required: string

403Forbidden — one of: forbidden, sudo_required

application/json

one of

ErrorForbidden
SudoRequiredError
object
Wire shape of the 403 a sudo-gated endpoint returns when sudo is missing or expired. `challenge` tells the SPA which sudo-prove endpoint to call.
challengerequired
string
Which sudo-prove endpoint the account should use: `"passkey"` (`/api/auth/sudo/passkey/{start,finish}`), `"password"` (`/api/auth/sudo/password`), or `"totp"` (`/api/auth/sudo/totp`), chosen from the account's registered credentials — passkey first when present, since it is both the strongest credential and the least friction. A hint for which prompt to show first, not an authorization decision: each sudo route verifies its own credential regardless of what was advertised here, so a client may use a different one.
errorrequired
string
Always `sudo_required` — this body exists to carry the extra fields that kind needs.
"sudo_required"
messagerequired
string

Standard errors

Bodies documented once for the whole API — see standard errors.

400Bad Request — one of: invalid_input
401Authentication required
429Rate limited — retry after the `Retry-After` header
500Internal server error
503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
504Gateway timeout — the request exceeded the server's handling budget