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. The Device Management services automatically generate this ID when a device first connects. Key and Configuration Manager (KCM) refers to the device ID as mbed.InternalEndpointName.

  • Endpoint name: the name you give to your device in the factory. This needs to be unique within the domain. Key and Configuration Manager refers to the endpoint name 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 the factory process), the system will use the device ID as the endpoint name.

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

Cloud Device ID

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