Filter devices

Request

Filters and lists devices within the application. This requires a client access token of the application, and must be called from the backend.

Required permissions: apps:read, [appId]:read, devices:read.

Security

ClientAccessToken

Query

device_idstring

Filter by device ID

user_idstring

Filter by user ID

statusstring

Filter by device status

Enum:"active""suspended"

device_typestring

Filter by device type

Enum:"mobile""web"

last_auth_attemptstring, (date-time)

Filter devices with last auth attempt at or after this date

last_authenticatedstring, (date-time)

Filter devices with last authenticated at or after this date

order_bystring

Field to order by

Default:"created_at"

Enum:"device_status""created_at"

orderstring

Sort direction

Default:"desc"

Enum:"asc""desc"

page_offsetnumber

Number of records to skip

Default:0

page_sizenumber, [ 1 .. 100 ]

Number of records to return (1–100)

Default:100

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/devices?device_id=string&user_id=string&status=active&device_type=mobile&last_auth_attempt=2019-08-24T14%3A15%3A22Z&last_authenticated=2019-08-24T14%3A15%3A22Z&order_by=device_status&order=asc&page_offset=0&page_size=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Filtered list of devices

Bodyapplication/json

resultArray of objectsrequired

total_countnumberrequired

Total number of matching devices

Response

{
  "result": [
    { … }
  ],
  "total_count": 0
}