Bootstrap or onboard a device
post
/api/deviceBootstrap
Called from a mobile application. Retrieves mHealth application-specific information to activate the device as part of a mobile application onboarding process. The API expects the accessId and OTP (One-Time-Password) in the HTTP authorization header (Basic Authentication) as username and password.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Security
-
basicAuth: http
Type:
http
Description:IAMS credentials or AccessId/OTP for deviceBootstrap.
Response
Supported Media Types
- */*
200 Response
Successful device bootstrap response.
Root Schema : DeviceConnectionParams
Type:
Show Source
object
-
deviceModelUrn:
array deviceModelUrn
List of device models created in the mHealth Connector Cloud that can be activated for a clinical trial.
-
hardwareId:
string
Virtual device activation ID.
-
iotBaseUrl:
string
IoT hostname.
-
iotDeviceId:
string(uuid)
DeviceId created for the virtual device in the underlying IoT Cloud and used as its identifier.
- iotSharedSecret: string
-
profile:
string
Device provisioning profile data.
-
studyname:
string
Trial or study name.
-
subjectId:
string
Surrogate subject identifier (KEY_UID field) that the client will use in the message stream sent to mHealth Cloud.
Nested Schema : deviceModelUrn
Type:
array
List of device models created in the mHealth Connector Cloud that can be activated for a clinical trial.
Show Source
400 Response
The device is already bootstrapped.
401 Response
Invalid accessId or OTP.
404 Response
Resource does not exist.