list #

Lists existing tenants

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/multi-tenancy/tenants[?group=<tenantGroup>]
Method: GET

Other protocols #

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

  "group": "teacher",
}

Arguments #

group: Optional tenant group to filter with

Response #

Returns a tenants array.

{
  "status": 200,
  "error": null,
  "action": "list",
  "controller": "multi-tenancy/tenant",
  "requestId": "<unique request identifier>",
  "result": {
    "tenants": [
      { "group": "teacher", "name": "liia", "index": "tenant-teacher-liia" },
      { "group": "student", "name": "melis", "index": "tenant-student-melis" },
    ]
  }
}

Edit this page on Github