Associate Tenant

LLM-friendly URL

POST

https://api.luzmo.com/0.1.0/tenant

API call form

Examples

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.

Assign a column or formula to a tenant with the Columns or Formulas role. You can also assign it from the other side, with the Tenants role on Associate Column or Associate Formula .

Assigning a shared column or formula to a tenant turns it into a tenant field: embed tokens of other tenants no longer see it. A field can be assigned to several tenants.

To assign several fields at once, send an assignments array instead of id and resource . All entries are applied in one transaction: if one entry fails, none is applied, and the error message starts with Assignment <position> for tenant <tenant id> and <role> <resource id> failed: . Assigning a field that is already assigned to the tenant succeeds.

You need to be a main-organization user with modify rights on the dataset of the column or formula.

Request parameters

Response schema

Can be executed by:

Organization Member (main organization)

Dataset Modifier

(For: Columns)

Organization Member (main organization)

Dataset Modifier

(For: Formulas)

Can be associated to:

Organization

Columns

Formulas

Did this page help you?

Yes

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'
});

const response = await client.associate('tenant',
  '<tenant_id>',
  { role: 'Columns', id: '<column_id>' }
);

Example Response

200

400

500

{
  "id": "508eb8ae-24f6-4f6e-a0cc-c050258af89e",
  "identifier": "suborg",
  "name": {
    "en": "Suborg"
  },
  "created_at": "2026-09-29T10:55:02.237Z",
  "updated_at": "2026-09-29T10:55:10.387Z",
  "organization_id": "25344a26-7bf4-4707-9d07-e6cd07319dca"
}