Turn on the authenticator app

POST /v1/auth/mfa/totp/confirm

Send a code from the authenticator app. Returns 10 recovery codes, shown once, verifies this session with a second factor and signs out other devices.

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

codestring

A code from the authenticator app

maxLength: 16

Responses

errors: application/problem+json

200

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.

Send a request

Server

Bearer token

Body

The request goes from your browser straight to this server; nothing passes through this site. The API must allow this site's origin for CORS.

Requestexample

curl -X POST "$API_URL/v1/auth/mfa/totp/confirm" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "123456"
}'

body := strings.NewReader(`{
  "code": "123456"
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost,
	apiURL + "/v1/auth/mfa/totp/confirm", 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/confirm`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "code": "123456"
  }),
});
const data = await res.json();

Responseexample

{
  "recovery_codes": [
    "string"
  ]
}

{
  "code": "string",
  "status": 401,
  "title": "Unauthorized",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 409,
  "title": "Conflict",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

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

{
  "code": "string",
  "status": 429,
  "title": "Too Many Requests",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}