NewTenantObject

The tenant object for creating new tenants.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

id

The tenant ID. If provided, the GUID will be used. Otherwise, the function will auto-create it.

-

string

name

The tenant's name

Y

string

viewerSeats

Number of Viewer seat licenses to allocate to the tenant

Y

integer

int32

proSeats

Number of Professional seat licenses to allocate to the tenant

Y

integer

int32

basicSeats

Number of Basic seat licenses to allocate to the tenant

-

integer

int32

analystSeats

Number of Analyst seat licenses to allocate to the tenant

-

integer

int32

showGroupFolder

Boolean flag to show a tenant's group folders

-

boolean

allowWebhookChannels

Boolean flag to Allow end users to create webhook channels

-

boolean

firstWorkday

First workday

-

FirstWorkday

defaultThemeId

Default theme id

-

string

defaultAiServer

Default AI server

-

string

selectedUserDefaultsId

User defaults

-

string

isUserDefaultsOverridable

Boolean flag to show - User defaults override

-

boolean

homepageTemplate

Homepage Hotbox Template

-

string

adminTemplate

Admin Hotbox Template

-

string

embedTemplate

Embed Hotbox Template

-

string

*Required elements are only used for API parameters

Usages
  • /API2/access/createTenant
  • /API2/access/createTenants