User

Module: Core

Export API  Coming Soon
74
Total Fields
2
Required Fields
12
Read-only Fields
6
Link Fields
Description

Represents a User in the system.

DocType Properties
  • Is Submittable: No
  • Is Tree: No
  • Track Changes: Yes
  • Custom: No
  • Naming Series: Not set
  • Search By: full_name
Fields (74)
Field Name Label Type Options Properties Default
enabled Enabled Check -
Read-only
1
email Email Data Email
Required
-
first_name First Name Data -
Required
-
middle_name Middle Name Data -
-
last_name Last Name Data -
-
full_name Full Name Data -
Read-only
-
username Username Data -
Unique
-
language Language Link Language
-
time_zone Time Zone Autocomplete -
-
send_welcome_email Send Welcome Email Check -
1
unsubscribed Unsubscribed Check -
Hidden
0
user_image User Image Attach Image -
Hidden
-
role_profile_name Role Profile Link Role Profile
Hidden
-
role_profiles Role Profiles Table MultiSelect User Role Profile
-
roles Roles Assigned Table Has Role
Read-only Hidden
-
module_profile Module Profile Link Module Profile
-
block_modules Block Modules Table Block Module
Hidden
-
home_settings Home Settings Code -
Hidden
-
gender Gender Link Gender
-
birth_date Birth Date Date -
-
interest Interests Small Text -
-
phone Phone Data Phone
-
location Location Data -
-
bio Bio Small Text -
-
mobile_no Mobile No Data Phone
Unique
-
mute_sounds Mute Sounds Check -
0
desk_theme Desk Theme Select
Light Dark Automatic
-
code_editor_type Code Editor Type Select
vscode vim emacs
vscode
banner_image Banner Image Attach Image -
-
search_bar Search Bar Check -
1
notifications Notifications Check -
1
list_sidebar Sidebar Check -
1
bulk_actions Bulk Actions Check -
1
view_switcher View Switcher Check -
1
form_sidebar Sidebar Check -
1
timeline Timeline Check -
1
dashboard Dashboard Check -
1
show_absolute_datetime_in_timeline Show Absolute Datetime in Timeline Check -
0
new_password Set New Password Password -
-
logout_all_sessions Logout From All Devices After Changing Password Check -
1
reset_password_key Reset Password Key Data -
Read-only Hidden
-
last_reset_password_key_generated_on Last Reset Password Key Generated On Datetime -
Read-only Hidden
-
last_password_reset_date Last Password Reset Date Date -
Read-only Hidden
-
redirect_url Redirect URL Small Text -
Hidden
-
document_follow_notify Send Notifications For Documents Followed By Me Check -
0
document_follow_frequency Frequency Select
Hourly Daily Weekly
Daily
follow_created_documents Auto follow documents that you create Check -
0
follow_commented_documents Auto follow documents that you comment on Check -
0
follow_liked_documents Auto follow documents that you Like Check -
0
follow_assigned_documents Auto follow documents that are assigned to you Check -
0
follow_shared_documents Auto follow documents that are shared with you Check -
0
email_signature Email Signature Text Editor -
-
thread_notify Send Notifications For Email Threads Check -
1
send_me_a_copy Send Me A Copy of Outgoing Emails Check -
0
allowed_in_mentions Allowed In Mentions Check -
1
user_emails User Emails Table User Email
-
default_workspace Default Workspace Link Workspace
-
default_app Default App Select -
-
defaults User Defaults Table DefaultValue
Hidden
-
simultaneous_sessions Simultaneous Sessions Int -
2
restrict_ip Restrict IP Small Text -
-
last_ip Last IP Read Only -
Read-only
-
login_after Login After Int -
-
user_type User Type Link User Type
System User
last_active Last Active Datetime -
Read-only
-
login_before Login Before Int -
-
bypass_restrict_ip_check_if_2fa_enabled Bypass Restricted IP Address Check If Two Factor Auth Enabled Check -
0
last_login Last Login Read Only -
Read-only
-
last_known_versions Last Known Versions Text -
Read-only Hidden
-
social_logins Social Logins Table User Social Login
-
api_key API Key Data -
Read-only Unique
-
generate_keys Generate Keys Button -
-
api_secret API Secret Password -
Read-only
-
onboarding_status Onboarding Status Small Text -
Hidden
{}