Activate Groups

Prerequisities

A group must be registered in Profiles or IAM 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 Profiles before you activate it in Trimble IoT.

  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"
  }

• (recommended) Check Group creation status before proceeding to activation in Trimble IoT API to prevent unexpected Forbidden error.

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 the next step

IoT Onboarding (only for groups created in IAM)

Authorization in IoT operates within a group context. Therefore, the following onboarding steps must be completed for every group created in IAM:

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

  • IAM Group Id (from the previous step)
  • Application Id /User Id which need IoT access

Activate Group in IoT

To activate a group in IoT, refer to the Groups API.

Update Group Policy

To enable or disable the open policy of a group, refer to the Update Group Policy API.