index.md

code	type	title
true	page	updateUserMapping | API | Core

updateUserMapping

Updates the internal user storage mapping.

---

Query Syntax

HTTP

URL: http://kuzzle:7512/users/_mapping
Method: PUT
Body:

{
  "properties": {
    // mapping
  }
}

Other protocols

{
  "controller": "security",
  "action": "updateUserMapping",

  "body": {
    "properties": {
      // mapping
    }
  }
}

---

Body properties

• properties: mapping definition using Elasticsearch mapping format

---

Response

Returns the updated mappings.

{
  "status": 200,
  "error": null,
  "action": "updateUserMapping",
  "controller": "security",
  "requestId": "<unique request identifier>",
  "result": {
    // mappings
  },
}