get #

Retrieves a specific soft tenant from a parent tenant.

This action returns the soft tenant and its metadata based on its unique identifier.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/multi-tenancy/tenant/:tenantId/soft-tenants/:_id
Method: GET

Other protocols #

{
  "controller": "multi-tenancy/soft-tenant",
  "action": "get",

  "tenantId": "teacher-liia",
  "_id": "class-a"
}

Arguments #

• tenantId: (URL Argument) The unique identifier of the parent tenant.
• _id: (URL Argument) The unique identifier of the soft tenant to retrieve.

Response #

Returns the requested soft tenant object:

• id: The unique identifier of the soft tenant.
• name: The name of the soft tenant.
• metadata: The custom metadata object associated with the soft tenant.

{
  "status": 200,
  "error": null,
  "action": "get",
  "controller": "multi-tenancy/soft-tenant",
  "requestId": "<unique request identifier>",
  "result": {
    "id": "class-a",
    "name": "Class A",
    "metadata": {
         "geolocation": {
            "lon":43,
            "lat":7
        }
    }
  }
}