Version 6.6.5 Source

Table Name: tabUser

Represents a User in the system.

Fields

Sr Fieldname Type Label Options
1 sb0_5 Section Break
2 enabled Check Enabled
3 section_break_3 Section Break
4 email Data Email 
Email
5 first_name Data First Name
6 middle_name Data Middle Name (Optional)
7 last_name Data Last Name
8 send_welcome_email Check Send Welcome Email
9 unsubscribed Check Unsubscribed
10 column_break0 Column Break
11 language Select Language 
Loading...
12 time_zone Select Timezone
13 change_password Section Break
14 new_password Password Set New Password
15 send_password_update_notification Check Send Password Update Notification
16 reset_password_key Data Reset Password Key
17 display_settings Section Break
18 user_image Attach User Image

Get your globally recognized avatar from Gravatar.com
19 cb21 Column Break
20 user_image_show Image user_image_show 
user_image
21 email_settings Section Break Email Settings
22 thread_notify Check Send Notifications for Transactions I Follow
23 email_signature Small Text Email Signature
24 background Section Break
25 background_image Attach Background Image
26 background_style Select Background Style 
Fill Screen
Tile
27 short_bio Section Break
28 gender Select Gender 
Male
Female
Other
29 birth_date Date Birth Date
30 location Data Location
31 column_break_22 Column Break
32 bio Small Text Bio
33 sb1 Section Break Roles

Check / Uncheck roles assigned to the User. Click on the Role to find out what permissions that Role has.
34 roles_html HTML Roles HTML
35 user_roles Table Roles Assigned UserRole
36 modules_access Section Break Modules Access

Uncheck modules to hide from user's desktop
37 modules_html HTML Modules HTML
38 block_modules Table Block Modules Block Module
39 sb2 Section Break Defaults

These values will be automatically updated in transactions and also will be useful to restrict permissions for this user on transactions containing these values.
40 defaults Table User Defaults

Enter default value fields (keys) and values. If you add multiple values for a field, the first one will be picked. These defaults are also used to set "match" permission rules. To see list of fields, go to "Customize Form".

 DefaultValue
41 sb3 Section Break Security Settings
42 user_type Select User Type

User Type "System User" can access Desktop. "Website User" can only be logged into the website and portal pages. 

System User
Website User
43 login_after Int Login After

Allow user to login only after this hour (0-24)
44 login_before Int Login Before

Allow user to login only before this hour (0-24)
45 restrict_ip Data Restrict IP

Restrict user from this IP address only. Multiple IP addresses can be added by separating with commas. Also accepts partial IP addresses like (111.111.111)
46 column_break1 Column Break
47 last_login Read Only Last Login
48 last_ip Read Only Last IP
49 last_known_versions Text Last Known Versions

Stores the JSON of last known versions of various installed apps. It is used to show release notes.
50 third_party_authentication Section Break Third Party Authentication
51 fb_username Data Facebook Username
52 fb_userid Data Facebook User ID
53 google_userid Data Google User ID
54 column_break_49 Column Break
55 github_userid Data Github User ID
56 github_username Data Github Username

Controller

frappe.core.doctype.user.user

Class User

Inherits from frappe.model.document.Document

a_system_manager_should_exist (self)

No docs


add_roles (self)

Add roles to user and save


add_system_manager_role (self)

No docs


after_rename (self, olddn, newdn, merge=False)

No docs


append_roles (self)

Add roles to user


autoname (self)

set name as email id


before_rename (self, olddn, newdn, merge=False)

No docs


check_enable_disable (self)

No docs


email_new_password (self, new_password=None)

No docs


ensure_unique_roles (self)

No docs


get_fullname (self)

get firstname space lastname


get_other_system_managers (self)

No docs


on_trash (self)

No docs


on_update (self)

No docs


password_reset_mail (self, link)

No docs


password_update_mail (self, password)

No docs


remove_all_roles_for_guest (self)

No docs


remove_roles (self)

No docs


reset_password (self)

No docs


send_login_mail (self, subject, template, add_args)

send mail with login details


send_password_notifcation (self, new_password)

No docs


send_welcome_mail_to_user (self)

No docs


share_with_self (self)

No docs


update_gravatar (self)

No docs


validate (self)

No docs


validate_email_type (self, email)

No docs


validate_rename (self, olddn, newdn)

No docs


validate_share (self, docshare)

No docs


validate_system_manager_user_type (self)

No docs


frappe.core.doctype.user.user.get_active_users ()

Returns No. of system users who logged in, in the last 3 days


frappe.core.doctype.user.user.get_active_website_users ()

Returns No. of website users who logged in, in the last 3 days


Public API
/api/method/frappe.core.doctype.user.user.get_all_roles

frappe.core.doctype.user.user.get_all_roles (arg=None)

return all roles


Public API
/api/method/frappe.core.doctype.user.user.get_languages

frappe.core.doctype.user.user.get_languages ()

No docs


Public API
/api/method/frappe.core.doctype.user.user.get_perm_info

frappe.core.doctype.user.user.get_perm_info (arg=None)

get permission info


frappe.core.doctype.user.user.get_permission_query_conditions (user)

No docs


frappe.core.doctype.user.user.get_system_users (exclude_users=None)

No docs


frappe.core.doctype.user.user.get_total_users (exclude_users=None)

Returns total no. of system users


Public API
/api/method/frappe.core.doctype.user.user.get_user_roles

frappe.core.doctype.user.user.get_user_roles (arg=None)

get roles for a user


frappe.core.doctype.user.user.get_website_users ()

Returns total no. of website users


frappe.core.doctype.user.user.has_permission (doc, user)

No docs


frappe.core.doctype.user.user.notifify_admin_access_to_system_manager (login_manager=None)

No docs


Public API
/api/method/frappe.core.doctype.user.user.reset_password

frappe.core.doctype.user.user.reset_password (user)

No docs


Public API
/api/method/frappe.core.doctype.user.user.sign_up

frappe.core.doctype.user.user.sign_up (email, full_name)

No docs


Public API
/api/method/frappe.core.doctype.user.user.update_password

frappe.core.doctype.user.user.update_password (new_password, key=None, old_password=None)

No docs


frappe.core.doctype.user.user.user_query (doctype, txt, searchfield, start, page_len, filters)

No docs


Public API
/api/method/frappe.core.doctype.user.user.verify_password

frappe.core.doctype.user.user.verify_password (password)

No docs


Linked In: