Delete Role
HTTP Method | URL | Requires Auth |
---|---|---|
|
|
Permission required:
access-permissions
Roles that have the
protected
value astrue
can't be deleted (such as:admin
,moderator
,user
and so on).You cannot delete roles that are assigned to users. To do that, you must first remove this role from all the users.
Body Parameters
Key | Example Value | Description |
---|---|---|
|
| The ID of an existing role. |
Example Call
Example Response
Success
Error
Any of the following errors can occur on the endpoint.
Authorization: Requires an authentication token for the request to be made.
Invalid RoleId: This occurs when the
roleId
does not exist on your workspace.
Change Log
Version | Description |
---|---|
3.17.0 | Added |
Last updated