Skip to content

Add device key

Request

Registers a device key in the platform for a specific user and app. Device keys are generated by the client using the relevant cryptography APIs exposed by the browser or mobile platform (Android or iOS). Once registered, the device key cryptographically binds the device to the given user for secure device identification.

Note: The key should be generated using the RSA-PSS algorithm and SHA-256 hash.

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

Security
ClientAccessToken
Path
user_idstringrequired

ID of the user

Bodyapplication/jsonrequired
key_idstringrequired

An identifier for the user's device

display_namestring

Friendly device name, used when displaying a list of the user's devices

custom_dataobject

Custom data stored for this device, such as tags or device data obtained using other tools

push_configobject

Device push notification configuration

public_keystringrequired

Device public key as a base-64 string. This corresponds to the cryptographic key-pair generated by the client

device_idstring

ID of the device to associate with this key

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/device-keys' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "key_id": "string",
    "display_name": "string",
    "custom_data": {},
    "push_config": {
      "device_token": "stringstringstringstringstringst",
      "type": "FCM",
      "bundle_id": "string"
    },
    "public_key": "string",
    "device_id": "string"
  }'

Responses

Device key added