usergroup.delete

Description

object usergroup.delete(array userGroupIds)

This method allows to delete user groups.

Deprovisioned users group (the user group specified for disabled_usrgrpid in Authentication) cannot be deleted.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(array) IDs of the user groups to delete.

Return values

(object) Returns an object containing the IDs of the deleted user groups under the usrgrpids property.

Examples

Deleting multiple user groups

Delete two user groups.

Request:

{
           "jsonrpc": "2.0",
           "method": "usergroup.delete",
           "params": [
               "20",
               "21"
           ],
           "id": 1
       }
Copy
✔ Copied

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "usrgrpids": [
                   "20",
                   "21"
               ]
           },
           "id": 1
       }
Copy
✔ Copied

Source

CUserGroup::delete() in ui/include/classes/api/services/CUserGroup.php.

To toggle search highlight, press Ctrl+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press Ctrl+Enter to send it to the editors.