This API provides you with information about all groups present in your account.

📘

Sample Request

https://api.azuga.com/azuga-ws/v1/groups/view.json?groupName=testGroup&groupId=d3200100-101b-11e6-8863-a5656842f582

API Response Explanation

FieldDescription
codeAPI Status Code
messageAPI Message
messageCodeFor Azuga Internal use
reasonReason for the failure
generatedAtAPI generation timestamp in UTC
groupIdUnique identifier representing the group
groupNameName of the group
newGroupNameUpdated name of the group
adminEmailsEmail address of the group administrator
configNameConfiguration assigned to the group
parentGroupNameName of the parent group
descriptionShort text describing the group
bgColorBackground color of the label used to identify the group. Accepts color codes in hexadecimal format
textColorText color of the label used to identify the group. Accepts color codes in hexadecimal format
administratorsFor Azuga Internal use
parentGroupIdFor Azuga Internal use
configIdFor Azuga Internal use
useDefaultConfigBoolean value representing whether the group is set to default configuration.

true = set to default configuration
false = Didn't set to default configuration
useDefaultAdminBoolean value representing whether the group is set to default administrator.

true = set to default administrator
false = Didn't set to default administrator
useParentDefaultGroupBoolean value representing whether the group is set to default parent group.

true = set to default parent group
false = Didn't set to default parent group
ssodefaultFor Azuga Internal use
webCallFor Azuga Internal use
Language
Authorization
Header
Click Try It! to start a request and see the response here!