role.delete

Description

object role.delete(array roleids)

This method allows to delete roles.

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 roles to delete.

Return values

(object) Returns an object containing the IDs of the deleted roles under the roleids property.

Examples

Deleting multiple user roles

Delete two user roles.

Request:

{
           "jsonrpc": "2.0",
           "method": "role.delete",
           "params": [
               "4",
               "5"
           ],
           "auth": "3a57200802b24cda67c4e4010b50c065",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "roleids": [
                   "4",
                   "5"
               ]
           },
           "id": 1
       }

Source

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

Documentation