Skip to content

How to use tenant management service API.

Tenant Management Service API - Create Tenant

Endpoint: /tenant


This API endpoint is used to create a new tenant in the tenant management service.


No parameters are required for this API.

Request Body:

The request body should contain the following JSON payload:

  "id": "string",
  "created": "2023-07-07T10:45:39.793Z",
  "name": "string",
  "install_key": "string",
  "email": "string",
  "license_id": "string"
  • id (string): The unique identifier for the tenant.
  • created (string): The timestamp indicating the creation time of the tenant.
  • name (string): The name of the tenant.
  • install_key (string): The installation token for the tenant.
  • email (string): The email associated with the tenant.
  • license_id (string): The license ID for the tenant.


200 - Successful Response

The API call is successful.

422 - Validation Error

Occurs when there is a validation error in the request payload.

  "detail": [
      "loc": [
      "msg": "string",
      "type": "string"