api/tenants

This file contains the readily available functions which interact with the ITSLanguage role API.

Tenants can be managed using the REST API. Only users with administrative powers can perform these calls.

Source:
See:

Members

(inner, constant) url :string

Source:

The URL for the tenant handler(s).

Type:
  • string

Methods

(static) create(tenant) → {Promise}

Source:

Create a new tenant.

Parameters:
Name Type Description
tenant Object

The tenant to create.

Properties
Name Type Attributes Description
id string <optional>

A unique identifier. If none is given, one is generated.
name Array

The name of the tenant.
Returns:
  • The user creation promise.
Type
Promise

(static) getAll() → {Promise}

Source:

Get all tenants.

Returns:
  • The promise for the tenants.
Type
Promise

(static) getById(id) → {Promise}

Source:

Get a tenant by its ID.

Parameters:
Name Type Description
id string

The Id of the desired tenant.
Returns:
  • The promise for the tenant.
Type
Promise