Skip to main content

Devices

Devices​

The Devices API allows you to generate one-time passwords (OTPs) and virtual security devices, for the purpose of testing authentication systems.

Retrieve one-time password​

POST: /api/devices/otp

Retrieves the one-time password for a given base32-encoded secret.

Body parameters​

sharedSecret: String

The base32-encoded shared secret to generate a one-time password for.

List all devices​

GET: /api/devices

Returns a list of your virtual security devices.

Create a device​

POST: /api/devices

Creates a new virtual security device and returns it.

Body parameters​

name: String

A name for the virtual device.

sharedSecret: String

The base32-encoded shared secret to generate a one-time password for.

Retrieve OTP for an existing device​

GET: /api/devices/:id/otp

Retrieves the current one-time password for an existing virtual security device. Simply supply the unique identifier for the required device.

Path parameters​

id: String

The identifier of the device to be retrieved.

Delete a device​

DELETE: /api/devices/:id

Permanently deletes a device. This operation cannot be undone.

Path parameters​

id: String

The identifier of the device to be deleted.