It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Deletes an existing useredit
Deletes an existing user.
Requestedit
DELETE /api/v1/users/{user_name}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the user |
Responsesedit
-
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
-
-
449
-
(
BasicFailedReply
) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac.elevated_permissions_required
]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XDELETE https://{{hostname}}/api/v1/users/{user_name} \ -H "Authorization: ApiKey $ECE_API_KEY"