latestOpenAPI 3.0.12026-08-102423137.1 KB

80dd46738839

Device binding

List bound devices

Returns a list of devices that your customers have verified using the device binding process.

get/v1/mfa/devices

Query parameters

page[size]integer

Use this filter to specify the size of each page of results.

page[number]integer

Use this filter to return only the devices on a certain page of the response.

filter[person_id]string

Use this filter to return only devices that belong to a specific person.

filter[include_deleted]string

Boolean value that determines whether or not the API should also return deleted devices. Default value is false.

Response

OK

idstring

The ID of the device.

namestring

The name of the device.

person_idstring

The ID of the person who registered the device.

created_atstring

The date and time when the device was registered.

deleted_atstring

(For deleted devices only) The date and time when the device was deleted.

Example response

[
  {
    "id": "20f892fdc6414320b5b1df612f833edb",
    "name": "Samsung Galaxy S20",
    "person_id": "83caf49280604836bdbb41ba33d8cper",
    "created_at": "2022-06-30T22:19:37Z"
  }
]