« Creates a new user Fetch a single user »
Elastic Docs ›Elastic Cloud Enterprise Reference [3.7] ›RESTful API ›API reference ›Users

Deletes an existing user

edit

Deletes an existing user

edit

Deletes an existing user.

Request

edit

DELETE /api/v1/users/{user_name}

Path parameters

edit
Name Type Required Description

user_name

string

Y

Identifier for the user

Responses

edit
200

(EmptyResponse)

User successfully deleted

400

(BasicFailedReply)

  • The user cannot be deleted. (code: user.restricted_deletion)
  • External users cannot be modified. (code: user.cannot_modify_external)
  • Built-in users cannot be modified. (code: user.cannot_modify)

Headers

x-cloud-error-codes (string; allowed values: [user.restricted_deletion, user.cannot_modify_external, user.cannot_modify])
The error codes associated with the response
404

(BasicFailedReply)

User not found. (code: user.not_found)

Headers

x-cloud-error-codes (string; allowed values: [user.not_found])
The error codes associated with the response

Request example

edit
curl -XDELETE https://{{hostname}}/api/v1/users/{user_name} \
-H "Authorization: ApiKey $ECE_API_KEY"
« Creates a new user Fetch a single user »