delete_group

Delete a Group.

Description

The requested group name is removed from the application. You cannot delete a group that has users in it. You also cannot delete the "dba" or "guest" group.

Parameters

action
delete_group
group
The name of the group to remove.

Example URL

http://<host>:<port>/<context>/web/user.xql?action=delete_group&group=<value>

Successful Result

This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure.

Failed Result

Accessing this API feature requires the "Manage application" permission, and the function will throw a permission exception if the permission is not available. It is an error if the group name already exists. If SSO is enabled, an error is also generated.