Core
API v1.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

updateUser #

Updates a user definition.


Query Syntax #

HTTP #

Copied to clipboard!
URL: http://kuzzle:7512/users/<_id>/_update[?refresh=wait_for]
Method: PUT
Body:
Copied to clipboard!
{
  "fullname": "Walter Smith"
}

Other protocols #

Copied to clipboard!
{
  "controller": "security",
  "action": "updateUser",
  "_id": "<kuid>",
  "body": {
    "fullname": "Walter Smith"
  }
}

Arguments #

Optional: #

  • refresh: if set to wait_for, Kuzzle will not respond until the user changes are indexed

Response #

Returns the update user kuid and version number.

Copied to clipboard!
{
  "status": 200,
  "error": null,
  "action": "updateUser",
  "controller": "security",
  "requestId": "<unique request identifier>",
  "result": {
    "_id": "<kuid>",
    "_version": 2
  }
}