FluxbaseTenant

FluxbaseTenant provides multi-tenant management functionality

Example

// List tenants I have access to
const { data } = await client.tenant.listMine()

// Get tenant details
const { data } = await client.tenant.get('tenant-id')

// Create a tenant (instance admin only)
const { data } = await client.tenant.create({
  slug: 'acme-corp',
  name: 'Acme Corporation'
})

// Assign admin to tenant (tenant admin only)
await client.tenant.assignAdmin('tenant-id', {
  user_id: 'user-id'
})

Constructors

Constructor

new FluxbaseTenant(fetch): FluxbaseTenant

Parameters

Parameter	Type
fetch	FluxbaseFetch

Returns

FluxbaseTenant

Methods

assignAdmin()

assignAdmin(tenantId, options): Promise<FluxbaseResponse<TenantAdminAssignment>>

Assign an admin to a tenant (tenant admin only)

Parameters

Parameter	Type	Description
tenantId	string	Tenant ID
options	AssignAdminOptions	Admin assignment options

Returns

Promise<FluxbaseResponse<TenantAdminAssignment>>

Promise with created assignment or error

Example

const { data, error } = await client.tenant.assignAdmin('tenant-id', {
  user_id: 'user-id'
})

---

create()

create(options): Promise<FluxbaseResponse<Tenant>>

Create a new tenant (instance admin only)

This creates a new isolated database for the tenant.

Parameters

Parameter	Type	Description
options	CreateTenantOptions	Tenant creation options

Returns

Promise<FluxbaseResponse<Tenant>>

Promise with created tenant or error

Example

const { data, error } = await client.tenant.create({
  slug: 'acme-corp',
  name: 'Acme Corporation',
  metadata: { plan: 'enterprise' }
})

---

delete()

delete(id): Promise<FluxbaseResponse<void>>

Delete a tenant (instance admin only)

This permanently deletes the tenant’s database and all its data. Cannot delete the default tenant.

Parameters

Parameter	Type	Description
id	string	Tenant ID

Returns

Promise<FluxbaseResponse<void>>

Promise that resolves when deleted

Example

const { error } = await client.tenant.delete('tenant-id')

---

get()

get(id): Promise<FluxbaseResponse<Tenant>>

Get a tenant by ID

Parameters

Parameter	Type	Description
id	string	Tenant ID

Returns

Promise<FluxbaseResponse<Tenant>>

Promise with tenant details or error

Example

const { data, error } = await client.tenant.get('tenant-id')

---

list()

list(): Promise<FluxbaseResponse<Tenant[]>>

List all tenants (instance admin only)

Returns

Promise<FluxbaseResponse<Tenant[]>>

Promise with tenants list or error

Example

const { data, error } = await client.tenant.list()

---

listAdmins()

listAdmins(tenantId): Promise<FluxbaseResponse<TenantAdminAssignment[]>>

List admins of a tenant

Parameters

Parameter	Type	Description
tenantId	string	Tenant ID

Returns

Promise<FluxbaseResponse<TenantAdminAssignment[]>>

Promise with admin list or error

Example

const { data, error } = await client.tenant.listAdmins('tenant-id')
// data: [{ id: '...', tenant_id: '...', user_id: '...', email: 'admin@example.com' }]

---

listMine()

listMine(): Promise<FluxbaseResponse<TenantWithRole[]>>

List tenants the current user has access to

Returns

Promise<FluxbaseResponse<TenantWithRole[]>>

Promise with tenants and user’s role in each

Example

const { data, error } = await client.tenant.listMine()
// data: [{ id: '...', slug: 'acme', name: 'Acme', my_role: 'tenant_admin', status: 'active' }]

---

migrate()

migrate(id): Promise<FluxbaseResponse<{ status: string; }>>

Migrate a tenant database to the latest schema (instance admin only)

Parameters

Parameter	Type	Description
id	string	Tenant ID

Returns

Promise<FluxbaseResponse<{ status: string; }>>

Promise with migration status or error

Example

const { data, error } = await client.tenant.migrate('tenant-id')
// data: { status: 'migrated' }

---

removeAdmin()

removeAdmin(tenantId, userId): Promise<FluxbaseResponse<void>>

Remove an admin from a tenant (tenant admin only)

Parameters

Parameter	Type	Description
tenantId	string	Tenant ID
userId	string	User ID

Returns

Promise<FluxbaseResponse<void>>

Promise that resolves when removed

Example

const { error } = await client.tenant.removeAdmin('tenant-id', 'user-id')

---

update()

update(id, options): Promise<FluxbaseResponse<Tenant>>

Update a tenant (tenant admin only)

Parameters

Parameter	Type	Description
id	string	Tenant ID
options	UpdateTenantOptions	Update options

Returns

Promise<FluxbaseResponse<Tenant>>

Promise with updated tenant or error

Example

const { data, error } = await client.tenant.update('tenant-id', {
  name: 'New Name'
})