Workspaces Model

this document provides an overview of the workspaces model used in the database this schema defines the structure for workspace documents in the database, specifying various fields and their types workspaces model documentation in a table format main schema fields field name type description default index name string the name of the workspace null yes site name string the name of the site for the workspace null no site email string the email address associated with the workspace site null no slug string a url friendly version of the workspace name null no ordering number the display order of the workspace 0 yes workspace type string the type of workspace (e g , "iframe embed"/"jwt full embed") null no tags \[string] an array of tags associated with the workspace \[] no image favicon string the url or path to the workspace's favicon image null no image logo string the url or path to the workspace's logo image null no square logo string the url or path to the workspace's square logo image null no background logo string the url or path to the workspace's background logo image null no layout type string the layout type for the workspace "left navigation" no layout landing page id objectid reference to the landing page in the pages collection null no top bar color string the color code for the top navigation bar "#ffffff" no top bar text color string the color code for the text in the top navigation bar "#000000" no side bar color string the color code for the side navigation bar "#f5f5f5" no side bar text color string the color code for the text in the side navigation bar "#000000" no side bar shade color string the color code for the shade in the side navigation bar "#ffffff" no left nav active text color string the color code for active text in the left navigation "#000000" no highlight color string the color code for highlighted elements "#000000" no background color string the color code for the background "#ffffff" no max width string the maximum width of the workspace content (% or px) "100%" no auto import domo user boolean flag to enable automatic import of domo users false no use global settings boolean flag to use global settings for the workspace false no disabled iframe expansion boolean flag to disable iframe expansion false no use workspace sso boolean flag to use workspace specific sso false no authorized workspaces \[objectid] array of references to authorized workspaces \[] no use workspace smtp boolean flag to use workspace specific smtp settings false no smtp default string the default smtp service "clearsquare" no smtp host string the smtp host address null no smtp user string the smtp username null no smtp email string the smtp email address null no smtp port number the smtp port number null no smtp password string the smtp password null no smtp secure boolean flag to enable secure smtp connection true no smtp self hosted verified boolean verification status for self hosted smtp false no smtp mailgun email string the mailgun email address null no smtp mailgun status string status of mailgun verification null no sso button color string the color code for the sso button "#000000" no sso button text string the text displayed on the sso button "sso login" no sso button text color string the color code for the text on the sso button "#ffffff" no dual signin for user boolean flag to enable dual sign in options for users true no sso logout landing page redirection for user boolean flag to enable redirection to landing page on sso logout false no domo data domodataschema object containing domo related data {page 0, group 0} no disabled sso auto updated boolean flag to disable automatic updates via sso false no disabled dataset auto updated boolean flag to disable automatic updates from datasets false no userids \[userschema] array of user references associated with the workspace \[] no pages \[pagesschema] array of page references associated with the workspace \[] no forms \[formschema] array of form references associated with the workspace \[] no groups \[groupschema] array of group references associated with the workspace \[] no domain string the domain associated with the workspace null no plan id objectid reference to the plan in the plans collection null no billing elegible user id objectid reference to the eligible billing user null no stripe customer id string the stripe customer id for billing purposes null no created by objectid reference to the user who created the workspace null no updated by objectid reference to the user who last updated the workspace null no deleted by objectid reference to the user who deleted the workspace null no deleted at date the timestamp when the workspace was deleted null yes created at date the timestamp of when the workspace was created auto no updated at date the timestamp of the most recent update auto no sub schemas domo data schema field name type description default page number the domo page count 0 group number the domo group count 0 user schema field name type description default id objectid reference to a user id in the users collection null domo user id number the domo user id null metabase user id number the metabase user id null type string the type of user null pages schema field name type description default index page id objectid reference to a page id in the pages collection null yes is global template boolean flag indicating if the page is a global template false no form schema field name type description default index form id objectid reference to a form id in the forms collection null yes group schema field name type description default index group id objectid reference to a group id in the groups collection null yes is template boolean flag indicating if the group is a template false no