Skip to content

Provision

Device provisioning and management APIs.

These APIs provide devices with the necessary provisioning APIs to manage communications with a device cloud.


GetCerts

Provision a device with MQTT certificates.

After a device has been claimed for management by a user into a device cloud, the device can call "getCerts" to request provisioning of MQTT certificates to secure communications.

This call returns the certificate, private key and communications endpoint to use for secure MQTT communications with the device cloud.

Endpoint

1
POST /provision/getCerts

Authorized Role

1
device

JSON Body Fields

Field Type Required Notes
id string yes Device claim ID

Response

MQTT certificate and endpoints for device communications.

Field Type Notes
accountId string Manager Account ID
cert string X.509 certificate
endpoint string MQTT host endpoint for communciations
key string X.509 certificate key
port number MQTT TCP/IP port number
thing string AWS IoT Core thing name for the device

GetCreds

Get IAM credentials

Get IAM credentials for use in the device.

This will create temprorary IAM credentials based on the configured Cloud.deviceRole (default IotoDeviceRole). These credentials can be used with appropriate AWS SDK or Ioto AWS Sigv4 APIs.

Endpoint

1
POST /provision/getCreds

Authorized Role

1
device

Response

A set of AWS IAM credentials that can be used with AWS APIs.

Field Type Notes
accessKeyId string
secretAccessKey string
sessionToken string
expires date
region string