A newer version is available. For the latest information, see the
current release documentation.
Deletes an existing user
editDeletes an existing user
editDeletes an existing user.
Request
editDELETE /api/v1/users/{user_name}
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the user |
Responses
edit-
200 -
User successfully deleted
-
400 -
-
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
-
The user cannot be deleted. (code:
-
404 -
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 -
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
-
Request example
editcurl -XDELETE https://{{hostname}}/api/v1/users/{user_name} \
-H "Authorization: ApiKey $ECE_API_KEY"