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.
Updates an existing user
editUpdates an existing user
editUpdates an existing user.
Request
editPATCH /api/v1/users/{user_name}
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the user |
Request body
edit(string) (required) All changes in the specified object are applied to the user according to the JSON Merge Patch processing rules. Omitting existing fields causes the same values to be reapplied. Specifying a null value reverts the field to the default value, or removes the field when no default value exists.
Responses
edit-
200 -
(
User) User successfully updated -
400 -
(
BasicFailedReply) * Some of the provided roles are invalid. (code:user.roles.invalid) * Some of the provided roles are forbidden. (code:user.roles.forbidden) * Trying to set a restricted field. (code:user.restricted_field) * 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.roles.invalid,user.roles.forbidden,user.restricted_field,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
editcurl -XPATCH https://{{hostname}}/api/v1/users/{user_name} \
-H "Authorization: ApiKey $ECE_API_KEY"