Skip to main content

Device ID

Data Orchestrator identifies each device with a 128 bit Device ID which has to be unique within its Realm. As a best practice, it is advised to generate such an ID from hardware unique IDs or using dedicated hardware modules, to make it consistent across device reflashes. It is advised to use a cryptographic hash function (such as sha256) when generating it using a software module. Data Orchestrator will use URL encoded base64 (without padding) strings like V_zv6ThCCtXWveQ8mPjsKg in its representation.

Although not required, it is strongly advised to use UUIDs as Data Orchestrator Device IDs. In fact, Data Orchestrator Device ID's specification is 100% compatible with UUIDs Base64 encoded adhering to RFC 7515. In the same fashion, UUIDv5 can be used to generate a deterministic Device ID from any kind of input data.

Data Orchestrator Clients which generate Data Orchestrator Device IDs (such as astartectl or Data Orchestrator Dashboard) will always generate a Device ID out of UUIDv4 (random ID) or UUIDv5 (deterministic ID).

This detail is relevant not only for identifying and querying the device, but also for the Pairing mechanism, as a device's credentials are associated to its Device ID.

Note: currently, Data Orchestrator accepts Device IDs longer than 128 bit, which are then truncated to 128 bit internally. Refrain from using anything which is not a 128-bit Device ID.