Onboard Operations APIs
The /scim/v2/Devices API is used to onboard a BLE device using SCIM.
SCIM Core Device Schema
| Attributes | Description |
|---|---|
| schemas | The schemas section of the SCIM APIs cover the list of schemas part of the API requests. The supported schemas are Core device schema, BLE device extension schema, and Endpoint application extension schema. |
| deviceDisplayName | The attribute is of string type and provides a human-readable name for a device. |
| adminState | The attribute is of Boolean type and is a mutable attribute. If adminState is set to TRUE, connect, disconnect, and subscribe commands that control app sends to the controller for the devices will be processed by the application. If adminState is set to FALSE, any command coming from the control app for the device will be rejected by the application. |
BLE Device Extension Schema
| Attributes | Description |
|---|---|
| deviceMacAddress | Is a string value that represents a public MAC address assigned by the manufacturer. The following is the regex pattern: ^[0-9A-Fa-f]{2}(:[0-9A-Fa-f]{2}){5}$ |
| isRandom | Is a Boolean flag. If set to FALSE, the device uses a public MAC address. The default value is FALSE. |
| versionSupport | Provides all the BLE versions supported by the device in the form of an array. |
| pairingMethods | Is an array of pairing methods associated with the BLE device. |
Version: 1.2.1
Download OpenAPI Document