Sign in
Tenants

Update tenant (full replacement)

Changed on

Updates an existing tenant using PUT semantics (full replacement).

HTTP Method: PUT only (PATCH not supported) Semantics: Send the complete resource representation. All fields should be provided.

Authorization: Requires platform_admin_api role.

Security Note: Changing tenant_type is not allowed for security reasons.

Required fields: name, tenant_type

put/api/tenants/{id}

Request

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

Path parameters

idstring uuid required

Tenant ID

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