API Docs
Users Model
4min
model documentation this document provides an overview of the users model used in a the database this schema defines the structure for user documents in the database, specifying various fields, and their types i'll convert the users model documentation into a table format similar to what i did for the workspaces model users model documentation main schema fields field name type description default index name string the name of the user no email string the email address of the user (unique, lowercase) yes password string the hashed password of the user no image string a url or path to the user's profile image no type string the role or type of user no active status boolean indicates whether the user is currently active no creation type string specifies how the user was created (e g , "manual input") no api updated at date timestamp of the last api update made for this user no last login date the date and time of the user's last login no login timezone string the timezone of the user's last login no last activity time date the timestamp of the user's last recorded activity no last activity timezone string the timezone of the user's last activity no is domo updated boolean a flag indicating if the user's data is updated in domo no disabled sso auto updated boolean flag to disable automatic updates via sso no disabled dataset auto updated boolean flag to disable automatic updates from datasets no custom fields \[customfieldschema] an array of custom fields associated with the user no created by objectid reference to the user who created this user entry no updated by objectid reference to the user who last updated this entry no deactivated at date the timestamp when the user was deactivated no created at date the timestamp of when the user was created auto no updated at date the timestamp of the most recent update to the user's data auto no sub schema custom field schema field name type description default index custom field id objectid reference to a custom field defined in the user custom fields collection no value string the value for the custom field no note some default values are marked with " " as they were not specified in the original documentation