Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Delete an existing role API

  • Updated: 4/07/2021
    • Automation 360 v.x
    • Manage
    • RPA Workspace
    • API docs

Delete an existing role API

Use the Delete role API to delete an existing role in the Control Room.

Prerequisites

Ensure you have an admin role or a custom role with Manage Roles permission. You can only delete custom roles you cannot delete the system-created roles.

  • URL: http://<your_control_room_url>/v1/usermanagement/roles/2 <role ID>

    Replace the content in the angle brackets with your Control Room URL.

  • Method: DELETE
  • Use the Swagger definition files installed with your Control Room to test the APIs. View the available Swagger APIs at: http://<your_control_room_url>/swagger/
  • You can also use a REST client to complete this task.

Procedure

  1. Add the authentication token to the request header.
  2. Use the DELETE as the endpoint URL:<your_control_room_url>/v1/usermanagement/roles/2 <role ID>
  3. In the request header, add a role ID you want to delete.
  4. Send the request.
    Response body:
    "OK"
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.
Send Feedback