update #

Updates a tenant profiles and mappings definition with the current version provided in the templates administration collection.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/multi-tenancy/tenants/:group/:name
Method: PUT

Other protocols #

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

  "group": "teacher",
  "name": "liia"
}

Arguments #

Arguments	Type	Description
`group`	string	Tenant group
`name`	string	Tenant name

Optional #

Property	Type	Description
`options`	object	Additional options

Options #

Customize the default behaviour with the following options:

Property	Type (default)	Description
`updateIndexSettings`	boolean (`false`)	If true, will try to apply the index settings part of the mapping's definition

Response #

Returns an object containing the following properties:

index: name of the updated index
profiles: list of updated profiles
collections: list of updated collections

{
  "status": 200,
  "error": null,
  "action": "update",
  "controller": "multi-tenancy/tenant",
  "requestId": "<unique request identifier>",
  "result": {
    "index": "tenant-teacher-liia",
    "profiles": ["admin", "user", "moderator"],
    "collections": ["articles", "categories"]
  }
}