Skip to content

Prerequisites

If you already subscribed to the Trimble IoT v2.1 API Product in Trimble Cloud Console, you have access to the Device Bootstrap v1 API.

Follow the below steps to complete the Device Bootstrap prerequisites before moving to Configuring Device Public Key in Bootstrap and Generating Operational Certificate

!!!Note Bootstrap v1 is for devices managed in Profiles. For Devices managed in IAM, refer to Bootstrap v2

Group creation in PROFILES

The device bootstrap API is tied to the device bootstrap client or application. To manage certificates through the device bootstrap API, integrators assign a role to authorize the device bootstrap application. To assign a role, a relationship is established between the device bootstrap application and the device by using the Profiles APIs.

  1. Create a group in Profiles.

    !!!Note 1. Group should be of non-identity type and it’s member type should be “devices” 2. Ensure to choose the name of group adhering to regex [a-zA-Z0-9:_-]+ - IoT Limitation

  2. Activate group in IoT

  3. Create a relation between the group and the device bootstrap application (1). { .annotate }

    1. Application Id : Stage(1) Production(2) { .annotate }

      1. c52b8687-6b7e-4da0-bc9e-39b1e0cb7871
      2. f22b77c0-b925-4ad8-930c-6bf21dae723b
  4. Create a device identity in Profiles (with or without certificates).

    !!!Note In above create device API request use the query parameter in and provide the TRN of the group created earlier in this prerequisite steps.

    ```
    ?in={{grouptrn}}
    ```

Relation to Bootstrap Application

A group allows better management of devices. For granting permission to the Device bootstrap API, create a group relation request in Profiles.

  • For subscribing to the Profiles service, refer to the Profiles Quickstart.
  • For details on the group relation request, refer to the Profiles API documentation.

UUID of the Bootstrap Application

Stage UUIDc52b8687-6b7e-4da0-bc9e-39b1e0cb7871
Prod UUIDf22b77c0-b925-4ad8-930c-6bf21dae723b

Create a Relation between Group and Bootstrap Application

curl --location 'https://cloud.stage.api.trimblecloud.com/tcloud-profiles-stage/1.0/profiles/applications/<Stage/ProdUUID>/relations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <Access Token>' \
--data '{
"targetProfileTrn": "trn:profiles:groups:<group id>",
"relationName": "manages",
"attributes": {
        "role": "admin"
    }
 }'

!!!Note Following parameters are required while creating relationship and this provides necessary persmissions for Bootstrap to generate operational certificate,

* "relationName": "manages"
* "attributes": {
"role": "admin"
}