AdminMultiTenantData

The tenant object contains all relevant meta-data for the tenant.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

id

The tenant's system ID

-

string

name

The tenant's name

-

string

viewerSeats

The total number of Viewer seats for the tenant

-

integer

int32

usedViewerSeats

The total number of USED Viewer seats for the tenant

-

integer

int32

proSeats

The total number of Professional seats for the tenant

-

integer

int32

usedProSeats

The total number of USED Professional seats for the tenant

-

integer

int32

analystSeats

The total number of Analyst seats for the tenant

-

integer

int32

usedAnalystSeats

The total number of USED Analyst seats for the tenant

-

integer

int32

basicSeats

The total number of Basic seats for the tenant

-

integer

int32

usedBasicSeats

The total number of USED Basic seats for the tenant

-

integer

int32

scientistSeats

The total number of Scientist seats for the tenant

-

integer

int32

usedScientistSeats

The total number of USED Scientist seats for the tenant

-

integer

int32

miscSettings

Miscellaneous settings

-

TenantSettings

pulseKey

The PULSE security key for the tenant

-

string

selectedUserDefaultsId

Sets a specific 'User Default' template for the tenant - using the User Default ID

-

string

isUserDefaultsOverridable

Set whether users can override the tenant's main User Defaults template

-

boolean

defaultThemeId

The default theme that should be applied to all content in the tenant - using the theme ID

-

string

defaultEmailTemplateId

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

-

string

defaultHubTemplateId

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

-

string

defaultAiServer

The id of the default ai server of the tenant

-

string

Usages
  • /API2/access/getAllTenants
  • /API2/access/getTenantByName
  • /API3/access/getAllTenants
  • /API3/access/getTenantByName