Delete an existing user

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

Prerequisites

Edit Users
Users who have edit users permissions can delete an existing user.
JSON Web Token (JWT)
All Control Room APIs require a JSON Web Token (JWT) to access the APIs. Generate an authentication token using the Authentication API. See Enterprise 11 Authentication API.
  • URL: http://<your_control_room_url>/v1/usermanagement/users/{ID}

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

  • Method: DELETE

Procedure

  1. Add an authentication token to the request header.
    Use the Authentication API to generate a JSON Web Token. See Enterprise 11 Authentication API.
  2. Select DELETE as the method.
  3. In the request header, add an existing user ID you want to delete.
    DELETE http://<your_control_room_url>/v1/usermanagement/users/15
  4. Send the request.
    • In Swagger, click Execute.
    • In a REST client, click SEND.
    Response body:
    {
  "id": 15,
  "email": "aa@aa.com",
  "username": "docbotusermd4",
  "domain": "ActiveDirectory (LDAP)",
  "firstName": "AAMHD4",
  "lastName": "AAMHD5",
  "version": 0,
  "principalId": 15,
  "deleted": false,
  "roles": [],
  "sysAssignedRoles": [],
  "groupNames": [],
  "permissions": [],
  "licenseFeatures": [],
  "emailVerified": true,
  "passwordSet": false,
  "questionsSet": false,
  "enableAutoLogin": true,
  "disabled": false,
  "clientRegistered": false,
  "description": "Created a user for running bots",
  "createdBy": 1,
  "createdOn": "2019-11-18T20:48:04Z",
  "updatedBy": 1,
  "updatedOn": "2019-11-18T20:48:04Z",
  "publicKey": null,
  "appType": null,
  "routingName": null,
  "appUrl": null
}
Note: You can also run REST requests from a command terminal. The following is a curl request example. This example is formatted for readability. Replace the text inside the angle brackets, <authentication_token>, with your authentication token.
curl -X DELETE "http://<your_control_room_url>/v1/usermanagement/users/15" 
-H "accept: application/json" 
-H "X-Authorization: <authentication_token>" 
-H "Content-Type: application/json" -d "{15}"