Core
API v2.x
2

mDeleteUsers #

Deletes multiple users.


Query Syntax #

HTTP #

Copied to clipboard!
URL: http://kuzzle:7512/users/_mDelete[?refresh=wait_for]
Method: POST
Body:
Copied to clipboard!
{
  "ids": ["kuid1", "kuid2", "..."]
}

Other protocols #

Copied to clipboard!
{
  "controller": "security",
  "action": "mDeleteUsers",
  "body": {
    "ids": ["kuid1", "kuid2", "..."]
  }
}

Arguments #

Optional: #

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

Body properties #

  • ids: an array of user kuids to delete (default: "wait_for")

Response #

Returns an array of successfully deleted users.

Copied to clipboard!
{
  "status": 200,
  "error": null,
  "action": "mDeleteUsers",
  "controller": "security",
  "requestId": "<unique request identifier>",
  "result": [
    "kuid1",
    "kuid2",
    "..."
   ]
  }
}