Claiming

Device Claiming lets an end user securely associate a deployed device with their account. For a full explanation of the claiming workflow, see Claiming Devices.

See Getting Connected for credential types and connection details.

Claiming Request

The device initiates claiming by sending a POST request:

Credential type	URL
Access Token	`coap(s)://THINGSBOARD_HOST:5683/api/v1/$ACCESS_TOKEN/claim`
X.509 Certificate	`coaps://THINGSBOARD_HOST/api/v1/claim`

{"secretKey": "mySecret", "durationMs": 60000}

Access Token:

coap-client -v 6 -m POST -t "application/json" -e '{"secretKey":"mySecret","durationMs":60000}' "coap://$THINGSBOARD_HOST:5683/api/v1/$ACCESS_TOKEN/claim"

X.509 Certificate:

coap-client-openssl -v 6 -c cert.pem -j key.pem -m POST -t "application/json" -e '{"secretKey":"mySecret","durationMs":60000}' "coaps://$THINGSBOARD_HOST/api/v1/claim"

Field	Required	Description
`secretKey`	No	Secret used to authorize the claim. Defaults to an empty string if omitted.
`durationMs`	No	Time window in milliseconds during which the device can be claimed. Defaults to the system value of `SECURITY_CLAIM_DURATION`.

When the device profile payload type is set to Protobuf, encode the payload using the same fixed schema as MQTT. See MQTT Claiming for the Protobuf schema.

Once the claiming window is open, the end user enters the secret key in the ThingsBoard UI to complete the association.