API DocsRESTUser group service

GetUserGroupsForAssets

Retrieves user groups for a list of assets.

GET
/api/v2/user-groups:get-for-assets

Query Parameters

assetIds
Required
array<string>

curl -X GET "<API_URL>/api/v2/user-groups:get-for-assets?assetIds=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "userGroups": [
    {
      "userGroupId": "string",
      "name": "string",
      "roleId": "string",
      "isDefault": true,
      "resources": {
        "assetIds": [
          "string"
        ],
        "allAssets": true
      },
      "userIds": [
        "string"
      ]
    }
  ],
  "roles": [
    {
      "roleId": "string",
      "name": "string",
      "description": "string"
    }
  ]
}

Previous

GetUserGroup GET

Next

ListUserGroups GET