Authenticator Accounts

An authenticator account represents a single OTP credential inside an authenticator app. You add accounts by providing an otpauth:// URI (the same URI encoded in QR codes), and then generate one-time passwords on demand.

POST /authenticator/apps/{app_id}/accounts

Add a new OTP account from an otpauth:// URI. The URI encodes the secret key, algorithm, digits, and period. Supports both TOTP and HOTP.

Path parameters

Request body

Request example

JSON

Response (201)

JSON

Error responses

Code examples

cURL

cURL

JavaScript

Python

GET /authenticator/apps/{app_id}/accounts

List all non-deleted accounts in an authenticator app.

Path parameters

Response (200)

JSON

Code examples

cURL

cURL

JavaScript

Python

GET /authenticator/apps/{app_id}/accounts/{account_id}

Get a single account by ID.

Path parameters

Response (200)

Returns the full account object (see Account object below).

Code examples

cURL

cURL

JavaScript

Python

PATCH /authenticator/apps/{app_id}/accounts/{account_id}

Update mutable fields on an account. Only supplied fields are modified.

Path parameters

Request body

Request example

JSON

Response (200)

Returns the updated account object.

Code examples

cURL

cURL

JavaScript

Python

DELETE /authenticator/apps/{app_id}/accounts/{account_id}

Soft-delete an account. Returns 204 No Content on success.

Path parameters

Code examples

cURL

cURL

JavaScript

Python

POST /authenticator/apps/{app_id}/accounts/{account_id}/generate-otp

Generate a one-time password for an account. For TOTP accounts, the code is time-based and valid_for_seconds indicates how long until it expires. For HOTP accounts, the internal counter is incremented atomically.

Path parameters

Response (200)

JSON

Response fields

Error responses

Code examples

cURL

cURL

JavaScript

Python