Unify and manage your data

Developer resources

Developer resources Contents

About developer resources

Entity Management APIs

Relation Management APIs

Interaction Management APIs

Reference Data Management APIs

Load and Export APIs

Data Integration APIs

Workflow APIs

Get Group by ID

The Get Group by ID API request returns the specific group based on the Group ID, for a customer.

Table 1. Get Group By ID
Request Type	GET
URL	`{oauth_uri}/customers/{customerId}/groups/{groupId}`
Parameters	customerId: Valid Customer ID. groupId: Unique ID of a specific group.
Access	-

Response

JSON Object representing the specific customer group.

Updating User Details

Request

GET {oauth_uri}/customers/TestCustomer/groups/Support
Headers: Authorization: Bearer <Access-Token>           

Response

{
      "groupId": "Support",
      "groupName": "Support",
      "description": "A Group for Support",
      "roles": {
          "L3_Configurator": [
              "jas88zr17"
          ],
          "Read_Access": [
              "jas88zr17"
          ],
          "Customer_Admin": [
              "jas88zr17"
          ],
          "Tenant_Admin": [
              "jas88zr17"
          ],
          "ROLE_ADMIN_TENANT": [
              "jas88zr17"
          ]
      }
  }           