API reference/Auth

Turn off the authenticator app

DELETE /v1/auth/mfa/totp

Requires the password and a code, recovery code or passkey response (start one with POST /v1/auth/passkeys/verification); signs out other devices. Not allowed while a role requires two-factor authentication and no passkey is left.

Authorization

bearer

Authorizationheader · stringrequired

Session token from POST /v1/auth/login with "transport": "bearer". Browsers use the session cookie that login sets instead.

Body

application/json

passwordstringrequired

maxLength: 512

codestring

A code from the authenticator app

maxLength: 16

passkeyobject

A passkey's response, instead of code

2 fields

ceremony_tokenstringrequired

From POST /v1/auth/login/mfa/passkey when signing in, or POST /v1/auth/passkeys/verification when signed in

maxLength: 256

credentialobjectrequired

The PublicKeyCredential from navigator.credentials.get(), as JSON

recovery_codestring

A recovery code, instead of code

maxLength: 32

Responses

errors: application/problem+json

204

No Content

401

Unauthorized

409

Conflict

422

Unprocessable Entity

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Match errors on the problem's code, which stays the same, not on its message.

curl -X DELETE "$API_URL/v1/auth/mfa/totp" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "password": "string", "code": "123456", "passkey": { "ceremony_token": "string", "credential": {} }, "recovery_code": "abcde-fghij" }'

body := strings.NewReader(`{ "password": "string", "code": "123456", "passkey": { "ceremony_token": "string", "credential": {} }, "recovery_code": "abcde-fghij" }`) req, err := http.NewRequestWithContext(ctx, http.MethodDelete, apiURL + "/v1/auth/mfa/totp", body) if err != nil { return err } req.Header.Set("Authorization", "Bearer "+token) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { return err } defer res.Body.Close()

const res = await fetch(`${apiUrl}/v1/auth/mfa/totp`, { method: "DELETE", headers: { Authorization: `Bearer ${token}`, "Content-Type": "application/json", }, body: JSON.stringify({ "password": "string", "code": "123456", "passkey": { "ceremony_token": "string", "credential": {} }, "recovery_code": "abcde-fghij" }), });

{ "code": "string", "status": 422, "title": "Unprocessable Entity", "detail": "string", "errors": [ { "message": "expected length >= 1", "location": "body.name" } ], "request_id": "req_9f86d081884c7d65", "type": "string" }