API Docs

Workspaces Model

7min

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
﻿

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

Field Name	Type	Description	Default
page	Number	The Domo page count	0
group	Number	The Domo group count	0

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

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

Field Name	Type	Description	Default	Index
form_id	ObjectId	Reference to a form ID in the forms collection	null	Yes

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

Assign Users to Workspaces (and Groups)

Untitled