tenants.md

Tenants

Overview

The resources responsible for installing and managing tenants

Available Resources

Resource Usage

1. netField.tenants.create(params, [callback])

2. netField.tenants.update(tenantId, params, [callback])

3. netField.tenants.get(tenantId, [callback])

4. netField.tenants.getAll(page, limit, sortBy, sortOrder, [callback])

5. netField.tenants.delete(tenantId, [callback])

createTenant

Create tenant's root organization

/**
* @param {object} params
* @param {function} callback optional
*/
netField.tenants.create(params, [callback])

updateTenant

Update tenant by the tenant's Id

/**
 * @param {number} tenantId
 * @param {object} params
 * @param {function} callback optional
*/
netField.tenants.update(tenantId, params, [callback])

getTenant

Get a tenant by tenant Id

/**
 * @param {number} tenantId
 * @param {function} callback optional
*/
netField.tenants.get(tenantId, [callback])

getTenants

Get All tenat organizations

/**
 * @param {any} options optional
 * @param {function} callback optional
*/
netField.tenants.getAll([options], [callback])

deleteTenant

Delete tenant by root tenant Id

/**
 * @param {number} tenantId
 * @param {function} callback optional
 */
netField.tenants.delete(tenantId, [callback])