Delete a user

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Deletes the specified user account and returns the deletion status.

Endpoints

Request URL

https://{server-hostname}:8383/emsapi/users/{userId}

Scope

Admin.DELETECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

userIdstringMandatory

Unique user identifier. To get user id click here. Get User Id

- Request Body

application/userDeletion.v1+json
array

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request DELETE \
  --url https://appdomain/emsapi/users/{userId} \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/userDeletion.v1+json' \
  --data '{}'
Show full

Sample Request Body

Delete a user with an empty request body object.

Copied!
  {}
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
userCreatedByDCboolean

Indicates whether the user account was created by Endpoint Central.

domainNamestring

Domain name of the deleted user.

userNamestring

Username of the deleted user.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

User deletion succeeds and returns deleted user identity.

Copied!
  {
    "userCreatedByDC": true,
    "domainName": "local",
    "userName": "alex.morgan"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.