Delete Tenant

LLM-friendly URL
POST
https://api.luzmo.com/0.1.0/tenant

A tenant represents one of your customers within your organization. Its identifier is the value you set as tenant (or suborganization ) when you create an embed token for a user of that customer.

Tenants scope tenant-specific fields:

  • A column or formula without tenant assignments is a shared field. Every caller with access to the dataset can see it.

  • A column or formula assigned to one or more tenants is a tenant field. Embed tokens of those tenants can see it; embed tokens of other tenants cannot.

  • Callers without a tenant see every field. These are API tokens of main-organization users and embed tokens created with suborganization and tenant set to null .

Tenant visibility decides which fields a caller can see. The access rights on the dataset decide what the caller can do with the fields it sees. See Custom fields per tenant for a full setup.

Only main-organization users can manage tenants. A main-organization user is a user of your own Luzmo organization, as opposed to an embed user of one of your customers: an organization member who is not in a suborganization.

Delete a tenant. This cannot be undone.

  • The tenant's tenant dataset sources are deleted.

  • Columns that were saved from the tenant's dataset sources are deleted.

  • Other columns and formulas lose their assignment to this tenant but are not deleted. A column or formula without any remaining assignment becomes a shared field and is visible to every tenant.

Request parametersResponse schema
Expand all Reset
id *UUIDrequired

The unique identifier of the entity

Can be executed by:
Organization Member (main organization)
Can be associated to:
Organization
Columns
Formulas
Did this page help you?
Yes No
Language
Shell
Node
Java
.NET
Python
PHP
Install
npm install @luzmo/nodejs-sdk
Example Request 
import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});

await client.delete('tenant', '<tenant_id>');
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "code": 200
}