Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Delete an existing user API

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

Delete an existing user API

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

Request

DELETE https://{{ControlRoomURL}}/v1/usermanagement/users/<user ID>
Header: X-Authorization <<authentication token>>
All API calls must contain an authentication token in the request header. Use the Authentication API to generate a JSON web token. See Authentication API.

Request Parameters

Parameter Type Required Description
user ID Integer Yes Enter the Id of the user.

Response

200 OK
Note: View the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.
The REST API responds to each request with an HTTP response code. For response codes, see API response codes.

Prerequisites

Ensure you have an admin role or a custom role with Edit Users permission.

  • URL: http://<your_control_room_url>/v1/usermanagement/users/2 <user ID>

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

  • Method: DELETE

Procedure

  1. Add the authentication token to the request header.Add an authentication token to the request header.
  2. In the request header, add an existing user ID you want to delete.
  3. Use the DELETE method. and endpoint URL:<your_control_room_url>/v1/usermanagement/users/2 <user ID>
  4. Send the request.
    Response body:
    {
      "id": 3014,
      "email": "a@a.com",
      "username": "docstest01",
      "domain": null,
      "firstName": null,
      "lastName": null,
      "version": 4,
      "principalId": 3014,
      "deleted": false,
      "roles": [],
      "sysAssignedRoles": [],
      "groupNames": [],
      "permissions": [],
      "licenseFeatures": [],
      "emailVerified": true,
      "passwordSet": false,
      "questionsSet": false,
      "enableAutoLogin": false,
      "disabled": false,
      "clientRegistered": false,
      "description": null,
      "createdBy": 2623,
      "createdOn": "2020-01-31T17:33:16Z",
      "updatedBy": 3215,
      "updatedOn": "2020-03-22T22:51:48Z",
      "publicKey": null,
      "appType": null,
      "routingName": null,
      "appUrl": null
    }
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.
Send Feedback