Skip to content

Create or update a device

Request

Registers a new device for the given user, or updates metadata of an existing one. This requires a client access token of the application, and must be called from the backend.

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

Security
ClientAccessToken
Path
user_idstringrequired

User ID

Bodyapplication/jsonrequired
device_idstringrequired

Unique identifier for the device

display_namestring

Display name for the device

device_typestringrequired

Type of the device

Enum:"mobile""web"
hardware_modelstring

Hardware model of the device

osstring

Operating system of the device

browserstring

Browser used on the device

registered_regionstring

Region from which the device was registered

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/devices' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "device_id": "string",
    "display_name": "string",
    "device_type": "mobile",
    "hardware_model": "string",
    "os": "string",
    "browser": "string",
    "registered_region": "string"
  }'

Responses

Device created or updated

Bodyapplication/json
user_idstringrequired

User identifier

device_idstringrequired

Unique identifier for the device

statusstringrequired

Status of the device

Enum:"active""suspended"
display_namestring

Display name for the device

device_typestringrequired

Type of the device

Enum:"mobile""web"
hardware_modelstring

Hardware model of the device

osstring

Operating system of the device

browserstring

Browser used on the device

registered_ipstring

IP address from which the device was registered

registered_regionstring

Region from which the device was registered

last_authenticatedstring, (date-time)

Timestamp of last successful authentication

last_auth_attemptstring, (date-time)

Timestamp of last authentication attempt

created_atstring, (date-time)required

Timestamp when the device was created

updated_atstring, (date-time)

Timestamp when the device was last updated

Response
{
  "user_id": "string",
  "device_id": "string",
  "status": "active",
  "display_name": "string",
  "device_type": "mobile",
  "hardware_model": "string",
  "os": "string",
  "browser": "string",
  "registered_ip": "string",
  "registered_region": "string",
  "last_authenticated": "2019-08-24T14:15:22Z",
  "last_auth_attempt": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}