create #

Creates a new tenant.

Profiles and collections from provided template files will be created.

---

Query Syntax #

HTTP #

Copied to clipboard!

URL: http://kuzzle:7512/_/multi-tenancy/tenants
Method: POST

Other protocols #

Copied to clipboard!

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

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

---

Arguments #

• group: Tenant group
• name: Tenant name

---

Response #

Returns an object containing the following properties:

• index: name of the created index
• profiles: list of created profiles
• collections: list of created collections

Copied to clipboard!

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

---