Delete

Delete an existing role.

This is only allowed if this role is not used anymore. Use application/view and user/view to find applications and users using a role.

Tokens

This action requires the following tokens:

  • role-delete

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
role Hash   The ID of the role to delete
deletelinked Boolean false If true, all user / application roles with this role will also be deleted. If false and there are still user / application roles, an error will be given.

Output

This action produces no output on success.

Errors

This action can return one of the default status codes, or one of the following status codes on error:

STATUS_ROLE_NOT_FOUND (270)
If the role specified by “ID” can not be found
STATUS_ROLE_STILL_USED (275)