roles

Deletes the role.

Changed on

Deletes the role. Users assigned to the role must be moved before it is removed.

<Check title="Required Permissions" icon="key">The user must be an admin or have workspace-manage-config:write permissions.</Check>

post/roles/{roleId}/delete

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/roles/{roleId}/delete
  • Auth: HTTP bearer

Path parameters

roleIdstring uuid required

The id of the role.

Request body

newRoleIdstring uuid nullable

The id of the role to which all users of the old role will be moved. Required if there are users assigned to the role being deleted.

Response

No Content

object required

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostRoleDeleteByRoleId removed and replaced with roles_PostRoleDeleteByRoleId