TenantObject

The tenant object.

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

scientistSeats

Number of Scientist 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

defaultHubTemplateId

The default Hub template that should be used for the tenant's hubs - using the Hub template ID

-

string

defaultEmailTemplateId

The default email template that should be used for the tenant's emails - using the Email template ID

-

string

isOrganizationalUnitOn

Switch to enable constrained domain searching for domain admins. Active Directory only.

-

boolean

domainName

The domain entity name that will be used in constrained domain searching. Active Directory only.

-

string

organizationalUnitText

The organizational unit name that will be used in constrained domain searching. Active Directory only.

-

string

defaultPaperType

Setting to choose the default page size for printing

-

PaperType

*Required elements are only used for API parameters

Usages
  • /API2/access/createTenant
  • /API2/access/createTenants
  • /API2/access/updateTenant
  • /API3/access/createTenant
  • /API3/access/createTenants
  • /API3/access/updateTenant