NFnforgeio
access_control
enterprise

Delete a custom role.

Delete a role with the given UID, and it’s permissions. If the role is assigned to a built-in role, the deletion operation will fail, unless force query param is set to true, and in that case all assignments will also be deleted.

You need to have a permission with action roles:delete and scope permissions:type:delegate. permissions:type:delegate scope ensures that users can only delete a custom role with the same, or a subset of permissions which the user has. For example, if a user does not have required permissions for creating users, they won’t be able to delete a custom role which allows to do that.

delete/access-control/roles/{roleUID}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/access-control/roles/{roleUID}
  • Auth
    • HTTP basic
    • or API key in header Authorization

Path parameters

roleUIDstring required

Query parameters

forceboolean
globalboolean

Response

An OKResponse is returned if the request was successful.

messagestring

Changes

No recorded changes to this operation across all 2 revisions of this API.