API Reference Guide - TenantInfo Object
Overview
Tenancy refers to the full capabilities of a single VIDIZMO Portal that can be tied to a specific domain. VIDIZMO offers single as well as multiple tenancy to allow organizations to segregate users and content to cater to their various extended business use-cases.
A tenant ID in VIDIZMO is a unique identifier for the Portal in which content resides. Every entity in VIDIZMO is closely coupled with the tenant it is associated with - where in some cases a user maybe associated with multiple tenants.
Here we shall be looking at TenantInfo Object in detail to understand the various properties it contains in VIDIZMO REST API Reference.
TenantInfo Object
{
"id": , //this is a unique identifier of the tenant
"organizationName": , //this is the title of the organization
"adminEmailAddress": , //this is the email-address of the creator of the Portal
"addedBy": {...},//this is a userprofile Object for the user who created the portal
"updatedBy": {...},//this is a userprofile Object for the user who updated the portal
"isActive": , //this bit is true when the tenant is active
"tenantName": , //this is the name of the tenant
"subDomainUrl": , //this is the unique domain URL on which the portal has been mapped to
"isSSLEnable": , //this decides whether or not SSL has been enabled on this portal
"isFeatured": , //this decides whether or not this portal has been marked as featured in the Account
"tenantProductPackage": {...},//this contains information about the product package that your portal belongs to
"tenantDetails": {//this object contains settings and configurations of various aspects of portal branding, security, content ingestion and management policy, third-party apps integrations, etc
"tenantBranding": {...},//this object contains settings related to Portal's branding
"tenantSSO": {...}, //this object contains settings related to SSO settings in a Portal
"apps": [...],//this contains an array of various apps settings that have been set up for your Portal
"tenantMembershipSettings": {...}, //this object contains the settings related to user-joining policies, data protection compliance, content moderation, etc
"tenantDemographics": {...}, //this object contains settings related to the location of the portal set in Organization settings
"tenantGeneralSettings": {...}, //this object contains settings related to the various content-related policies, such as when to purge content, whether to allow SEO indexing of the content, etc
"privateLocationRestriction": {...}, //this object contains settings related to the private locations set up in portal
"publicLocationRestriction": {...}, //this object contains settings related to the public locations set up in portal
"domainRestriction": {...}, //this object contains settings related to which domains you wish to whitelist/blacklist for content embedding
"consentForms": [...]//this is an array that includes Data Protection Agreements or other Consent Forms that you may configure for taking consent from an end-user before they continue using your portal
},
"description": ,//this is the portal's description
"channelMenu": {...}, //this object contains the menu items that you can showcase on your portal's homepage on the top menu-bar
"configurableTerm": [...], //this object contains an array of the various terms in the portal that you may set your own organizational alias for
"anonymousUserPermissions": {...}, //this object contains settings related to the policy of anonymous users such as whether to allow them to view comments, share media, etc
"ssoMessage": [...], //this is an array that contains custom messages configured for every SSO provider to show with corresponding SSO provider on login page
"downloadMessage": , //this is the message you may set to be shown to an end-user when they proceed with downloading any content from your portal
"defaultCulture": //this is the default portal language that helps you determine which language shall the portal load in for the first time for a user
}
Note: Anonymous User Access is not available in VIDIZMO Digital Evidence Management (DEMS) product package.