Get authenticator device OTP

GET

/api/devices/{deviceId}/otp

Generate the current one-time password for a saved virtual 2FA authenticator device. Optionally wait for the next TOTP period when the current code is too close to expiry.

Authorizations

ApiKey

Type

API Key (header: X-Api-Key)

Parameters

Path Parameters

deviceId*

Type

string

Required

Format

"uuid"

Query Parameters

min_seconds_until_expire

Minimum number of seconds the generated TOTP code must remain valid. Defaults to 0, which returns the current code immediately.

Type

number

Example10

Minimum

0

Responses

Content-Type

application/json

{

  

"code": "123456",

  

"expires": "2026-05-18T12:00:30.000Z"

}

GET

/api/devices/{deviceId}/otp

Playground

Server

Authorization

ApiKey

Variables

Key

Value

deviceId*

min_seconds_until_expire

Samples

Powered by VitePress OpenAPI