UserLink a device to a user

Link a device to a user

Records a cross-reference between a user and a device aggregate (Matter bridge or 3dEye camera) along with the device's org.

curl -X POST "https://api.spkey.co/users/example_string/AddDevice" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "deviceId": "example_string",
  "deviceType": "matter",
  "orgId": "example_string",
  "name": "John Doe",
  "addedBy": "example_string"
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null"
}
POST
/users/{id}/AddDevice
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
Content-Typestring
Required

The media type of the request body

Options: application/json
deviceTypestring
Required

matter | camera

Options: matter, camera, rtsp-camera
orgIdstring
Required

Organisation the device belongs to

namestring

Friendly label

addedBystring

Actor that performed the link

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Path Parameters

Body

application/json
deviceTypestring
Required

matter | camera

Allowed values:mattercamerartsp-camera
orgIdstring
Required

Organisation the device belongs to

namestring

Friendly label

addedBystring

Actor that performed the link

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventobject,null
Required