Tenants API

Introduction

In B2B SaaS applications, all users are usually grouped into tenants. Each of your business customers is represented as a tenant. The related users and all the data are fully isolated. Please refer to the multi-tenancy feature guide for more information and instructions.

Mutations

createTenant()

You can create a new tenant by setting a name and reference. The API documentation for createTenant() is here (opens in a new tab).

const tenantId = await client.asSuperAdmin().createTenant({ tenant: { 
    name: 'Car Rental',
    reference: "car-rental" 
  } 
});

updateTenant()

The updateTenant() API method works the same way as createTenant(). This API will update the tenant data. Read here (opens in a new tab) for the API documentation.

await roqClient.asSuperAdmin().updateTenant({
  id: "tenant_id_is_here",
  tenant: {
    name: "Truck Rental",
    reference: "truck-rental"
  }
})

Queries

tenants()

Get the tenants data. For the documentation of this API can be found here (opens in a new tab).

const tenantsData = await client.asSuperAdmin().tenants({
  limit: 3
});

tenant()

Retrieve tenant data using its ID. Refer to the tenant() API documentation here (opens in a new tab).

await client.asSuperAdmin().tenant({ 
  id: "tenant_id_is_here"
});