update #

Updates a tenant's user.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/multi-tenancy/tenant/:tenantId/user/:_id[?refresh=<refresh>]
Method: PUT
Body:

{
  "content": {
    // custom content
  },
  "credentials": {
    // user credentials
  }
}

Other protocols #

{
  "controller": "multi-tenancy/user",
  "action": "update",

  "_id": "<kuid>",
  "tenantId": "<tenant ID>",

  "body": {
    "content": {
      // custom content
    },
    "credentials": {
      // user credentials
    }
  }
}

Arguments #

_id: User kuid
tenantId: Tenant ID

Optional: #

refresh: if set to wait_for, Kuzzle will not respond until documents are indexed

Body properties #

User custom content and credentials like for the security:updateUser API action.

It's not possible to manually set the profileIds or the tenants properties.

Response #

Returns the user who have been updated.

{
  "status": 200,
  "error": null,
  "action": "update",
  "controller": "multi-tenancy/user",
  "requestId": "<unique request identifier>",
  "result": {
    "_id": "<kuid>",
    "content": {
      "profileIds": ["teacher-liia-moderator"],
      "tenants": [
        {
          "group": "teacher",
          "name": "liia",
          "index": "tenant-teacher-liia",
          "profiles": ["moderator"]
        }
      ]
    }
  }
}

Edit this page on Github