Provisioning File for Integration
post
/iot/api/v2/provisioner/integration
Get the provisioning file for an integration. The integration id is passed in the request payload
Request
Supported Media Types
- application/json
Root Schema : ProvisioningRequest_create
Type:
Show Source
object
-
connectedDevices(optional):
array connectedDevices
Identifiers for connected devices to be provisioned in this request. Identifiers may be hardware IDs for single devices or registration IDs for devices registered in batches. Any batch registrations included must be in the COMPLETED state.
-
id:
string
Identifier of the entity to get provisioning information. This should activationId for single device, registrationId for a list of devices and integrationId for enterprise integration.
-
passphrase:
string
Passphrase that would be used to encrypt the provisioning attributes
-
transport(optional):
string
Transport used by devices to communicate with the IoT Cloud service. Values are "https"
Nested Schema : connectedDevices
Type:
array
Identifiers for connected devices to be provisioned in this request. Identifiers may be hardware IDs for single devices or registration IDs for devices registered in batches. Any batch registrations included must be in the COMPLETED state.
Show Source
Response
Supported Media Types
- text/plain
200 Response
Successfully processed
Root Schema : ProvisioningRequest_create
Type:
Show Source
object
-
connectedDevices(optional):
array connectedDevices
Identifiers for connected devices to be provisioned in this request. Identifiers may be hardware IDs for single devices or registration IDs for devices registered in batches. Any batch registrations included must be in the COMPLETED state.
-
id:
string
Identifier of the entity to get provisioning information. This should activationId for single device, registrationId for a list of devices and integrationId for enterprise integration.
-
passphrase:
string
Passphrase that would be used to encrypt the provisioning attributes
-
transport(optional):
string
Transport used by devices to communicate with the IoT Cloud service. Values are "https"
Nested Schema : connectedDevices
Type:
array
Identifiers for connected devices to be provisioned in this request. Identifiers may be hardware IDs for single devices or registration IDs for devices registered in batches. Any batch registrations included must be in the COMPLETED state.
Show Source
400 Response
Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
401 Response
Unauthorized. The request requires user authentication.
404 Response
Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.
410 Response
Gone. The request could not be completed because the resource is intentionally unavailable. This code is only allowed in situations where it is expected that resource is intentionally unavailable. The request can only be repeated if the cause for the unavailability changes
Examples
curl -X POST
-u <username>:<password>
-H 'Content-Type: application/json'
https://iotserver/iot/api/v2/provisioner/integration
Example of Request Body
The following example shows the content of the request body in JSON format
{
"passphrase":"changeit",
"id":"775630146890-6436"
}
Complete cURL Example
The following example shows compete cURL comand that can be used to perform described operation
curl -X POST
-u <username>:<password>
-H 'Content-Type: application/json'
-d '{"passphrase":"changeit","id":"775630146890-6436"}'
https://iotserver/iot/api/v2/provisioner/integration
Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https:// myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.