This API provides you with information about all groups present in your account.
Sample Request
API Response Explanation
Field | Description |
|---|---|
code | API Status Code |
message | API Message |
messageCode | For Azuga Internal use |
reason | Reason for the failure |
generatedAt | API generation timestamp in UTC |
groupId | Unique identifier representing the group |
groupName | Name of the group |
newGroupName | Updated name of the group |
adminEmails | Email address of the group administrator |
configName | Configuration assigned to the group |
parentGroupName | Name of the parent group |
description | Short text describing the group |
bgColor | Background color of the label used to identify the group. Accepts color codes in hexadecimal format |
textColor | Text color of the label used to identify the group. Accepts color codes in hexadecimal format |
administrators | For Azuga Internal use |
parentGroupId | For Azuga Internal use |
configId | For Azuga Internal use |
useDefaultConfig | Boolean value representing whether the group is set to default configuration. true = set to default configuration |
useDefaultAdmin | Boolean value representing whether the group is set to default administrator. true = set to default administrator |
useParentDefaultGroup | Boolean value representing whether the group is set to default parent group. true = set to default parent group |
ssodefault | For Azuga Internal use |
webCall | For Azuga Internal use |