Managing tenants

Operations with tenants are located under the /tenants endpoint in the API.

The API represents a tenant as a JSON object.

JSON object structure of a tenant

Name	Value type	Description
id	UUID string	The universally unique identifier (UUID) of the tenant. This UUID is used for accessing the tenant via the API.
ancestral_access	true or false	Specifies if higher-level administrators can manage the tenant.
brand_id	number	API v1 ID of the tenant’s brand.
brand_uuid	UUID string	The UUID of the tenant’s brand. If the tenant has branding active – it will contain a brand UUID generated for this tenant, otherwise it will contain UUID of the brand of higher-level tenant.
contact	contact object	The legal contact information of the organization.
customer_id	string	An internal value.
customer_type	string	An internal value.
default_idp_id	UUID string	An internal value.
enabled	true or false	Specifies if the tenant is enabled or disabled.
has_children	true or false	Specifies if the tenant has child tenants.
internal_tag	string	Any value that must be no longer than 256 characters. The platform does not use this value. A third-party application can use the value for its own purposes.
kind	string	The tenant type. The value can be partner, folder, customer, or unit. Set to unit for personal tenants.
language	string	The default language of notifications, reports, and the software that is used within the tenant. For the list of supported values, see below.
name	string	The tenant name.
owner_id	UUID string	Set to user account UUID if it is a personal tenant. Otherwise set to null.
parent_id	UUID string	The UUID of a tenant where this tenant is created.
update_lock	object	An internal value.
version	number	The revision number of the tenant. Each update of the tenant increases this number.

Tenant contact object structure

Name	Value type	Description
email	string	An email address that will be used for account activation and service notifications.
address1	string	Address line 1.
address2	string	Address line 2.
country	string	Organization’s country.
state	string	Organization’s state.
zipcode	string	Organization’s zip code.
city	string	Organization’s city.
phone	string	Organization’s phone number.
firstname	string	The first name of the organization’s representative.
lastname	string	The last name of the organization’s representative.

Supported language values

• bg - Bulgarian

• cs - Czech

• da - Danish

• de - German

• en, en-US - English

• es - Spanish

• es-419 - Spanish (Latin America)

• fi - Finnish

• fr - French

• id - Indonesian

• it - Italian

• hu - Hungarian

• ja - Japan

• ko - Korean

• ms - Malay

• nb - Norwegian

• nl - Dutch

• pl - Polish

• pt - Portuguese

• pt-BR - Portuguese (Brazil)

• ru - Russian

• sr - Serbian

• sv - Swedish

• tr - Turkish

• zh - Chinese

• zh-TW - Chinese (Traditional)

Sample JSON object of a tenant

{
    "ancestral_access": true,
    "brand_id": 3579,
    "brand_uuid": "14dc11ca-2b16-43bb-8ba4-2a3545c214a0",
    "contact": {
        "address1": "366 5th Ave",
        "address2": null,
        "city": null,
        "country": null,
        "email": "foo.bar@example.com",
        "firstname": "",
        "lastname": "",
        "phone": "1-541-754-3010",
        "state": null,
        "zipcode": null
    },
    "customer_id": null,
    "customer_type": "default",
    "default_idp_id": "11111111-1111-1111-1111-111111111111",
    "enabled": true,
    "has_children": false,
    "id": "0fcd4a69-8a40-4de8-b711-d9c83dc000f7",
    "internal_tag": "some.unique.tag.value",
    "kind": "customer",
    "language": "en",
    "name": "Foobar",
    "owner_id": null,
    "parent_id": "ede9f834-70b3-476c-83d9-736f9f8c7dae",
    "update_lock": {
        "enabled": false,
        "owner_id": null
    },
    "version": 1
}

What you can do with tenants

Operation	Methods and endpoints used
Create a tenant	POST /tenants
Fetch information about an individual tenant	GET /tenants/{tenant_id}
Fetch information about tenants	GET /tenants
Fetch information about child tenants	GET /tenants/{tenant_id}/children
Fetching the production start date of a tenant	GET /tenants/{tenant_id}/pricing
Switch a customer tenant to production mode	GET /tenants/{tenant_id}/pricing PUT /tenants/{tenant_id}/pricing
Modify tenant properties	GET /tenants/{tenant_id} PUT /tenants/{tenant_id}
Move a tenant to another tenant	GET /tenants/{tenant_id} PUT /tenants/{tenant_id}
Limit access to a tenant for higher-level administrators	GET /tenants/{tenant_id} PUT /tenants/{tenant_id}
Disable a tenant	GET /tenants/{tenant_id} PUT /tenants/{tenant_id}
Delete a tenant	GET /tenants/{tenant_id} PUT /tenants/{tenant_id} DELETE /tenants/{tenant_id}