Onboard a BLE device - Cisco Sensor Connect for IoT Services: Partner Developer Guide

{"type":"api","title":"Onboard a BLE device","meta":{"id":"/apps/pubhub/media/spaces-connect-for-iot-services/a26650b37d1e4da79f50a788631b154850ad15fd/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"version":"1.1.0","title":"IoT Nova SCIM APIs"},"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"openapi":"3.0.0"},"spec":{"summary":"Onboard a BLE device","operationId":"onboardDevice","tags":["Onboard a BLE device using SCIM"],"description":"The /scim/v2/Devices API is used to onboard a BLE device using SCIM.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"schemas":{"type":"array","description":"A list of URIs indicating the SCIM schema(s) the JSON object conforms to.","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:core:2.0:Device","urn:ietf:params:scim:schemas:extension:ble:2.0:Device","urn:ietf:params:scim:schemas:extension:endpointapps:2.0:Device"]},"deviceDisplayName":{"type":"string","description":"A string that provides a human-readable name for the device.","example":"BLE Heart Monitor"},"adminState":{"type":"boolean","description":"A boolean attribute to indicate if the device is operational. If set to TRUE, it means that this device is intended to be operational.","example":true},"urn:ietf:params:scim:schemas:extension:ble:2.0:Device":{"type":"object","description":"A SCIM schema extension that defines attributes specific to a BLE device.","properties":{"versionSupport":{"type":"array","description":"A multivalued set of strings that specifies the BLE versions supported by the device in the form of an array.","items":{"type":"string"},"example":["5.3"]},"deviceMacAddress":{"type":"string","description":"A string value that represent the MAC address of the device. It is a unique 48-bit value.","example":"30:FB:10:53:C0:B9"},"isRandom":{"type":"boolean","description":"A boolean flag taken from to indicate if the device is using a public MAC address or random MAC address. If FALSE, the device uses a public MAC address and if TRUE, the device uses a random address.","example":true},"mobility":{"type":"boolean","description":"A boolean attribute to enable device mobility. If set to TRUE, the device could be expected to move within a network of APs.","example":true},"pairingMethods":{"type":"array","description":"A multivalued set of strings that specifies the pairing methods associated with the device.","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:extension:pairingNull:2.0:Device"]},"urn:ietf:params:scim:schemas:extension:pairingNull:2.0:Device":{"type":"object","description":"Schema URI to indicate that the device do not require a pairing method.","additionalProperties":false},"urn:ietf:params:scim:schemas:extension:pairingJustWorks:2.0:Device":{"type":"object","description":"Schema URI to indicate the pairingJustWorks extension. Just Works pairing method does not require a key to pair devices.","properties":{"key":{"type":"integer","description":"Not supported or unused","nullable":true}}}},"$$ref":"#/components/schemas/BLEDeviceExtension"},"urn:ietf:params:scim:schemas:extension:endpointAppsExt:2.0:Device":{"type":"object","description":"Schema URI to list the end point applications used to onboard and control the BLE device.","properties":{"onboardingUrl":{"type":"string","description":"The onboarding application that has been used to onboard this device.","format":"url","example":"onboardApplication"},"deviceControlUrl":{"type":"array","description":"The control application that is used to perform control operations on this device.","items":{"type":"string","format":"url"},"example":["controlApplication"]}},"$$ref":"#/components/schemas/EndpointAppsExtension"}},"$$ref":"#/components/schemas/DeviceRequest","required":["schemas","deviceDisplayName","adminState","urn:ietf:params:scim:schemas:extension:ble:2.0:Device","urn:ietf:params:scim:schemas:extension:endpointAppsExt:2.0:Device"]}}}},"parameters":[{"name":"x-api-key","in":"header","description":"Custom HTTP header used to identify and authorize applications.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Device created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"schemas":{"type":"array","description":"A list of URIs indicating the SCIM schema(s) the JSON object conforms to.","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:core:2.0:Device","urn:ietf:params:scim:schemas:extension:ble:2.0:Device","urn:ietf:params:scim:schemas:extension:endpointapps:2.0:Device"]},"deviceDisplayName":{"type":"string","description":"A string that provides a human-readable name for the device.","example":"BLE Heart Monitor"},"adminState":{"type":"boolean","description":"A boolean attribute to indicate if the device is operational. If set to TRUE, it means that this device is intended to be operational.","example":true},"id":{"type":"string","description":"A unique identifier for the SCIM resource","example":"5ae0c228-24c9-433c-9001-5a23f063ffd0","$$ref":"#/components/schemas/DeviceIdProperty"},"urn:ietf:params:scim:schemas:extension:ble:2.0:Device":{"type":"object","description":"A SCIM schema extension that defines attributes specific to a BLE device.","properties":{"versionSupport":{"type":"array","description":"A multivalued set of strings that specifies the BLE versions supported by the device in the form of an array.","items":{"type":"string"},"example":["5.3"]},"deviceMacAddress":{"type":"string","description":"A string value that represent the MAC address of the device. It is a unique 48-bit value.","example":"30:FB:10:53:C0:B9"},"isRandom":{"type":"boolean","description":"A boolean flag taken from to indicate if the device is using a public MAC address or random MAC address. If FALSE, the device uses a public MAC address and if TRUE, the device uses a random address.","example":true},"mobility":{"type":"boolean","description":"A boolean attribute to enable device mobility. If set to TRUE, the device could be expected to move within a network of APs.","example":true},"pairingMethods":{"type":"array","description":"A multivalued set of strings that specifies the pairing methods associated with the device.","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:extension:pairingNull:2.0:Device"]},"urn:ietf:params:scim:schemas:extension:pairingNull:2.0:Device":{"type":"object","description":"Schema URI to indicate that the device do not require a pairing method.","additionalProperties":false},"urn:ietf:params:scim:schemas:extension:pairingJustWorks:2.0:Device":{"type":"object","description":"Schema URI to indicate the pairingJustWorks extension. Just Works pairing method does not require a key to pair devices.","properties":{"key":{"type":"integer","description":"Not supported or unused","nullable":true}}}},"$$ref":"#/components/schemas/BLEDeviceExtension"},"urn:ietf:params:scim:schemas:extension:endpointAppsExt:2.0:Device":{"type":"object","description":"Schema URI to list the end point applications used to onboard and control the BLE device.","properties":{"onboardingUrl":{"type":"string","description":"The onboarding application that has been used to onboard this device.","format":"url","example":"onboardApplication"},"deviceControlUrl":{"type":"array","description":"The control application that is used to perform control operations on this device.","items":{"type":"string","format":"url"},"example":["controlApplication"]}},"$$ref":"#/components/schemas/EndpointAppsExtension"}},"$$ref":"#/components/schemas/DeviceResponse"}}}}},"__originalOperationId":"onboardDevice","method":"post","path":"/scim/v2/Devices"}}