Sign in
Tenants

Create tenant

Changed on

Creates a new tenant.

Authorization: Requires platform_admin_api role.

Note: Only standard tenant type can be created via API. Platform tenants are created via migrations only.

After creation, three default roles are automatically seeded:

  • tenant_admin - Full administrative access
  • tenant_user - Default role for human users
  • tenant_api - Default role for API keys
post/api/tenants

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/tenants
  • Auth: none required

Request body

enabled_regimesstring[] nullable
idstring uuid
inserted_atstring date-time
metadataobject nullable
namestring required
slugstring nullable
status'active' | 'suspended' | 'inactive'
tenant_type'platform' | 'standard' required
updated_atstring date-time

Example request

{
  "enabled_regimes": [
    ""
  ],
  "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "inserted_at": "2020-04-20T16:20:00Z",
  "metadata": {},
  "name": "",
  "slug": "",
  "status": "active",
  "tenant_type": "platform",
  "updated_at": "2020-04-20T16:20:00Z"
}

Changes