Create a tenant

You can make a POST request to create a single tenant on the Enghouse Interactive platform. The request can include JSON body elments that define the attributes of the new tenant. You'll need MANAGE_TENANT permissions to perform this operation.

Request

Sample request

The request below creates a tenant:

curl -X POST -H "Content-Type: application/json" 
https://api.cxengage.net/v1/tenants -d '{
	"name": "Tenant A",
	"description": "Tenant A",
	"parentId": "57e2f960-3328-11e6-8dd4-c88eee4d9f61"
	"regionId": "c98f5fc0-f91a-11e4-a64e-7f6e9992be1f",
	"adminUserId": "87ec5991-f83b-11e4-87cb-45b2e1245d4b",
	"active": true
}'

Request parameters

The table below lists the parameters you can include in a request:

Parameter Required Type Description
regionId yes UUID The unique identifier of the AWS region in which the tenant resides.
name yes string The name of the tenant. The name can consist of any alphanumeric or special character. The tenant’s name must be unique across all tenants and AWS regions.
description no string A brief description of the tenant.
parentId no UUID If this is a sub-tenant, define the UUID for the parent tenant to have the new tenant created as it's child tenant.
adminUserId no UUID The unique identifier of the user who administers the tenant. The default is the ID of the user who created the tenant.
active no boolean A flag indicating whether or not the tenant is enabled.

Response

Sample response

The request returns JSON structured like the example below:

                    {
    "result": {
        "description": Tenant A,
        "parentIds": [
            "57e2f960-3328-11e6-8dd4-c88eee4d9f61"
        ],
        "timezone": "US/Eastern",
        "regionId": "46d74400-3328-11e6-8dd4-c88eee4d9f61",
        "createdBy": "192338d0-3cc6-11e8-a90c-e5d2e6c2ff0d",
        "parent": {
            "id": "57e2f960-3328-11e6-8dd4-c88eee4d9f61",
            "name": "Platform"
        },
        "defaultIdentityProvider": null,
        "updated": "2018-06-19T18:47:36Z",
        "name": "Tenant A",
        "clientLogLevel": null,
        "adminUserId": "192338d0-3cc6-11e8-a90c-e5d2e6c2ff0d",
        "created": "2018-06-19T18:47:36Z",
        "outboundIntegrationId": null,
        "updatedBy": "192338d0-3cc6-11e8-a90c-e5d2e6c2ff0d",
        "active": true,
        "id": "91675efb-719e-4ca2-b342-e9c1738ece63",
        "capacityRuleId": null,
        "cxengageIdentityProvider": "enabled",
        "childIds": [],
        "parentId": "57e2f960-3328-11e6-8dd4-c88eee4d9f61"
    }
}

Response parameters

The response includes the following parameters:

Parameter Type Description
description string A brief description of the tenant.
parentIds UUID If this is a sub-tenant, an object containing a list of unique identifiers of any parent tenants. If this isn't a sub-tenant, this defaults to the platform ID.
timezone string The location to which the business hours apply. The location is in TZ database format (continent/city - for example, America/New York).
regionId UUID The unique identifier of the AWS region in which the tenant resides.
createdBy UUID The unique identifier of the user who create the tenant.
parent object A JSON object that includes the name and UUID of the parent tenant.
defaultIdentityProvider string The unique identifier of the default identity provider for the tenant.
updated string The date and time (in UTC format) on which the tenant was updated.
name string The name of the tenant. The name can consist of any alphanumeric or special character. The tenant’s name must be unique across all tenants and AWS regions.
clientLogLevel string

This property is used by Enghouse Interactive internal.
adminUserId UUID The unique identifier of the user who administers the tenant. The default is the ID of the user who created the tenant.
created string The date and time (in UTC format) on which the tenant was created.
outboundIntegrationId string The unique identifier of the default outbound gateway.
updatedBy UUID The unique identifier of the user who updated the tenant.
active boolean

A flag indicating whether or not the tenant is enabled. You can create a tenant or sub-tenant but not enable it. The default value is true (enabled).
id UUID The unique identifier of the tenant.
cxengageIdentityProvider boolean

Indicates whether the configured identity provider is:

  • Enabled—Allows users to use their CxEngage username and password to authenticate. This setting can be overwritten for individual users.
  • Disabled—Prevents users from using their CxEngage username and password to authenticate. This setting can be overwritten for individual users.
  • Denied—Prevents all users on the tenant from using their CxEngage username and password to authenticate regardless of their user settings.  
childIds object A JSON object that includes the UUIDs of this tenant's child tenants.
parentId UUID If this is a sub-tenant, the parent tenant’s ID. If this isn't a sub-tenant, this defaults to the platform ID.