Core 2.x

updateUser

Updates a user definition.


Query Syntax

HTTP

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

Other protocols

Copied to clipboard!
{
  "controller": "security",
  "action": "updateUser",
  "_id": "<kuid>",
  "body": {
    "fullname": "Walter Smith"
  },
  // Optional
  "refresh": "wait_for",
  "retryOnConflict": 10
}

Arguments

Optional arguments

  • refresh: if set to wait_for, Kuzzle will not respond until the user changes are indexed (default: "wait_for")
  • retryOnConflict: in case of an update conflict in Elasticsearch, the number of retries before aborting the operation (default: 10)

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