Delete Usergroup API


By utilizing the following API, an administrator user can delete one or more user groups.

Syntax

For XML Response:

https://[HOST]:[PORT]/AppManager/xml/Usergroup/delete?apikey=[ API Key ] &usergroupName= [ Group Name ]
https://[HOST]:[PORT]/AppManager/xml/Usergroup/delete?apikey=[ API Key ] &usergroupId=[ Group Id ]

For JSON Response:

https://[HOST]:[PORT]/AppManager/json/Usergroup/delete?apikey=[ API Key ] &usergroupName= [ Group Name ]
https://[HOST]:[PORT]/AppManager/json/Usergroup/delete?apikey=[ API Key ] &usergroupId=[ Group Id ]

Supported HTTP methods: POST

Allowed roles: Administrator

Request Parameters

The parameters involved in executing this API request are:

FieldDescription
apikey The key generated using the Generate API Key option in the Settings tab.
usergroupId The ID of the user group which is to be deleted.
usergroupName The name of the user group which is to be deleted.

Example Request

https://apm-prod-server:8443/AppManager/xml/Usergroup/delete?apikey=aaaaaabbbbbbccccccddddddeeeeee&usergroupName=sample

https://apm-prod-server:8443/AppManager/xml/Usergroup/delete?apikey=aaaaaabbbbbbccccccddddddeeeeee&usergroupId=1,2