Documentation

Mistake on this page? Email us

Device identity: Device ID and endpoint name

Devices connected to Pelion Device Management have two important pieces of identity information:

  • Device ID: a globally unique ID generated by Device Management. This is the only way to refer to a device when using the APIs. This ID is automatically generated by Device Management services when a device first connects. The Device ID is referenced on the device in the Key and Configuration Manager as mbed.InternalEndpointName.

  • Endpoint name: the name you give to your device in the factory. This needs to be unique within the domain. The Endpoint name is referenced on the device in the Key and Configuration Manager as mbed.EndpointName.

    Tip: If you did not give your device an endpoint name (for example, because you are using a developer certificate rather than a factory process), the system will use the device ID as the endpoint name.

Your web or enterprise application gets the device ID generated by Device Management as a part of the registration message (ep field) when the registration has completed. The same registration message includes the original endpoint name (oep field), so that the web application can map the original endpoint name and the generated device ID. It then uses the device ID when interacting with the device.

Cloud Device ID

Note: Device Management Update requires additional device identifiers. See Device Identifiers for more information.