Activate a group

Prerequisities

A group must be registered in the Profiles or IAM Service before activating in Trimble IoT.

!!!Note It is recommended to activate group in IAM.

Group creation in PROFILES

Groups provisioned in the Profiles service must be created under the non-identity group (object) category.

• Create a group in the Profiles service.

  Sample request body

  {
    "name": "TestGroup",  //Ensure to choose the name of group adhering to regex `[a-zA-Z0-9:_-]+` - IoT Limitation
    "description": "This is a test group",
    "isIdentityGroup": false,  //Set false to create a non-identity group
    "memberType": "devices"
  }

Group creation in IAM

• Ensure IAM onboarding is complete before proceeding with IoT integration.

• Create a group in IAM before you activate it in Trimble IoT

  curl --location '{IAMBaseUrl}/groups' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: ••••••' \
  --data '{
  "name": "MTW9NVBpA76",
  "description": "this is test group"
  }'

  Save the ‘id’ from the response to be used in subsequent steps

IoT Onboarding

The following onboarding steps must be completed for every group created:

• To onboard group in IoT, submit an onboarding request using the Onboarding Form with the following details:

  • IAM Group Id (id from the previous step)
  • HubName
  • Application Id
  • Region (azure-us)
    • azure-us is the only region supported in Trimble IoT - Azure.

Activate Group in IoT

To activate a group in IoT, refer to the Groups API. PreferredName can be used if the name of group created in profiles does not adhere to regex [a-zA-Z0-9:_-]+