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
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 example

edit
curl -XDELETE https://{{hostname}}/api/v1/users/{user_name} \
-H "Authorization: ApiKey $ECE_API_KEY"