Delete a Role

{ deleteRole }

Removes a role from the system.

Method

/API2/access/deleteRole
  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2018.5
  • Can be used by Enterprise Admin users only
  • REST API only via POST actions.
  • Input Parameters

    Name

    roleId

    Type

    string

    Description

    The system role ID

    Output Response

    Successful Result Code

    200

    Response Type

    Description of Response Type

    Generic API response object with success or failure flag and related messages.

    Notes

    This function cannot be undone. Use it carefully.

    Examples