List User Groups API
User Group Details
By utilizing the following API, an administrator user can retrieve the details of all user groups.
Syntax
For XML Response:
https://[HOST]:[PORT]/AppManager/xml/UsergroupDetails?apikey=[ API Key ]
For JSON Response:
https://[HOST]:[PORT]/AppManager/json/UsergroupDetails?apikey=[ API Key ]
Specific User Group Details
By utilizing the following API, an administrator user can retrieve the details of a specific user group by providing either the user group ID or its name.
For XML Response:
https://[HOST]:[PORT]/AppManager/xml/Usergroup/[userGroupID]?apikey=[ API Key ]
[ OR ]
https://[HOST]:[PORT]/AppManager/xml/Usergroup/[userGroupName]?apikey=[ API Key ]
For JSON Response:
https://[HOST]:[PORT]/AppManager/json/Usergroup/[userGroupID]?apikey=[ API Key ]
[ OR ]
https://[HOST]:[PORT]/AppManager/json/Usergroup/[userGroupName]?apikey=[ API Key ]
Supported HTTP methods: GET
Allowed roles: Administrator
Request Parameters
The parameters involved in executing this API request are:
| Field | Description |
|---|
| userGroupID | ID of the user group whose detail is to be fetched. |
| userGroupName | The name of the user group whose detail is to be fetched. |
| apikey | The key generated using the Generate API Key option in the Settings tab. |
Sample Requests
- https://apm-prod-server:8443/AppManager/xml/UsergroupDetails?apikey=aaaaaabbbbbbccccccddddddeeeeee
- https://apm-prod-server:8443/AppManager/json/Usergroup/1?apikey=aaaaaabbbbbbccccccddddddeeeeee
- https://apm-prod-server:8443/AppManager/xml/Usergroup/testing?apikey=aaaaaabbbbbbccccccddddddeeeeee
