1557 lines
No EOL
39 KiB
HTML
1557 lines
No EOL
39 KiB
HTML
<!-- title: User -->
|
|
|
|
|
|
|
|
|
|
|
|
<div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 6.x.x</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/frappe/core/doctype/user"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<p><b>Table Name:</b> <code>tabUser</code></p>
|
|
|
|
|
|
Represents a User in the system.
|
|
|
|
<h3>Fields</h3>
|
|
|
|
<table class="table table-bordered" style="table-layout: fixed;">
|
|
<thead>
|
|
<tr>
|
|
<th style="width: 5%">Sr</th>
|
|
<th style="width: 25%">Fieldname</th>
|
|
<th style="width: 20%">Type</th>
|
|
<th style="width: 25%">Label</th>
|
|
<th style="width: 25%">Options</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr class="info">
|
|
<td>1</td>
|
|
<td ><code>sb0_5</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>2</td>
|
|
<td ><code>enabled</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Enabled
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>3</td>
|
|
<td ><code>section_break_3</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>4</td>
|
|
<td class="danger" title="Mandatory"><code>email</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Email
|
|
|
|
</td>
|
|
<td>
|
|
<pre>Email</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>5</td>
|
|
<td class="danger" title="Mandatory"><code>first_name</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
First Name
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>6</td>
|
|
<td ><code>middle_name</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Middle Name (Optional)
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>7</td>
|
|
<td ><code>last_name</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Last Name
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>8</td>
|
|
<td ><code>send_welcome_email</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Send Welcome Email
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>9</td>
|
|
<td ><code>unsubscribed</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td class="text-muted" title="Hidden">
|
|
Unsubscribed
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>10</td>
|
|
<td ><code>column_break0</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>11</td>
|
|
<td ><code>language</code></td>
|
|
<td >
|
|
Select</td>
|
|
<td >
|
|
Language
|
|
|
|
</td>
|
|
<td>
|
|
<pre>Loading...</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>12</td>
|
|
<td ><code>time_zone</code></td>
|
|
<td >
|
|
Select</td>
|
|
<td >
|
|
Timezone
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>13</td>
|
|
<td ><code>user_image</code></td>
|
|
<td >
|
|
Attach Image</td>
|
|
<td >
|
|
User Image
|
|
<p class="text-muted small">
|
|
Get your globally recognized avatar from Gravatar.com</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>14</td>
|
|
<td ><code>short_bio</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
More Information
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>15</td>
|
|
<td ><code>gender</code></td>
|
|
<td >
|
|
Select</td>
|
|
<td >
|
|
Gender
|
|
|
|
</td>
|
|
<td>
|
|
<pre>
|
|
Male
|
|
Female
|
|
Other</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>16</td>
|
|
<td ><code>birth_date</code></td>
|
|
<td >
|
|
Date</td>
|
|
<td >
|
|
Birth Date
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>17</td>
|
|
<td ><code>location</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Location
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>18</td>
|
|
<td ><code>column_break_22</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>19</td>
|
|
<td ><code>bio</code></td>
|
|
<td >
|
|
Small Text</td>
|
|
<td >
|
|
Bio
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>20</td>
|
|
<td ><code>mute_sounds</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Mute Sounds
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>21</td>
|
|
<td ><code>change_password</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Change Password
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>22</td>
|
|
<td ><code>new_password</code></td>
|
|
<td >
|
|
Password</td>
|
|
<td >
|
|
Set New Password
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>23</td>
|
|
<td ><code>send_password_update_notification</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Send Password Update Notification
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>24</td>
|
|
<td ><code>reset_password_key</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td class="text-muted" title="Hidden">
|
|
Reset Password Key
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>25</td>
|
|
<td ><code>email_settings</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Email Settings
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>26</td>
|
|
<td ><code>thread_notify</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Send Notifications for Transactions I Follow
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>27</td>
|
|
<td ><code>email_signature</code></td>
|
|
<td >
|
|
Small Text</td>
|
|
<td >
|
|
Email Signature
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>28</td>
|
|
<td ><code>background</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Desktop Background
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>29</td>
|
|
<td ><code>background_image</code></td>
|
|
<td >
|
|
Attach</td>
|
|
<td >
|
|
Background Image
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>30</td>
|
|
<td ><code>background_style</code></td>
|
|
<td >
|
|
Select</td>
|
|
<td >
|
|
Background Style
|
|
|
|
</td>
|
|
<td>
|
|
<pre>Fill Screen
|
|
Tile</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>31</td>
|
|
<td ><code>sb1</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Roles
|
|
<p class="text-muted small">
|
|
Check / Uncheck roles assigned to the User. Click on the Role to find out what permissions that Role has.</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>32</td>
|
|
<td ><code>roles_html</code></td>
|
|
<td >
|
|
HTML</td>
|
|
<td >
|
|
Roles HTML
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>33</td>
|
|
<td ><code>user_roles</code></td>
|
|
<td >
|
|
Table</td>
|
|
<td class="text-muted" title="Hidden">
|
|
Roles Assigned
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/core/userrole">UserRole</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>34</td>
|
|
<td ><code>modules_access</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Modules Access
|
|
<p class="text-muted small">
|
|
Uncheck modules to hide from user's desktop</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>35</td>
|
|
<td ><code>modules_html</code></td>
|
|
<td >
|
|
HTML</td>
|
|
<td >
|
|
Modules HTML
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>36</td>
|
|
<td ><code>block_modules</code></td>
|
|
<td >
|
|
Table</td>
|
|
<td class="text-muted" title="Hidden">
|
|
Block Modules
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/core/block_module">Block Module</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>37</td>
|
|
<td ><code>sb2</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td class="text-muted" title="Hidden">
|
|
Defaults
|
|
<p class="text-muted small">
|
|
These values will be automatically updated in transactions and also will be useful to restrict permissions for this user on transactions containing these values.</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>38</td>
|
|
<td ><code>defaults</code></td>
|
|
<td >
|
|
Table</td>
|
|
<td class="text-muted" title="Hidden">
|
|
User Defaults
|
|
<p class="text-muted small">
|
|
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".</p>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/core/defaultvalue">DefaultValue</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>39</td>
|
|
<td ><code>sb3</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Security Settings
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>40</td>
|
|
<td class="danger" title="Mandatory"><code>user_type</code></td>
|
|
<td >
|
|
Select</td>
|
|
<td >
|
|
User Type
|
|
<p class="text-muted small">
|
|
User Type "System User" can access Desktop. "Website User" can only be logged into the website and portal pages. </p>
|
|
</td>
|
|
<td>
|
|
<pre>System User
|
|
Website User</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>41</td>
|
|
<td ><code>login_after</code></td>
|
|
<td >
|
|
Int</td>
|
|
<td >
|
|
Login After
|
|
<p class="text-muted small">
|
|
Allow user to login only after this hour (0-24)</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>42</td>
|
|
<td ><code>login_before</code></td>
|
|
<td >
|
|
Int</td>
|
|
<td >
|
|
Login Before
|
|
<p class="text-muted small">
|
|
Allow user to login only before this hour (0-24)</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>43</td>
|
|
<td ><code>restrict_ip</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Restrict IP
|
|
<p class="text-muted small">
|
|
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)</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>44</td>
|
|
<td ><code>column_break1</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>45</td>
|
|
<td ><code>last_login</code></td>
|
|
<td >
|
|
Read Only</td>
|
|
<td >
|
|
Last Login
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>46</td>
|
|
<td ><code>last_ip</code></td>
|
|
<td >
|
|
Read Only</td>
|
|
<td >
|
|
Last IP
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>47</td>
|
|
<td ><code>last_active</code></td>
|
|
<td >
|
|
Datetime</td>
|
|
<td >
|
|
Last Active
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>48</td>
|
|
<td ><code>last_known_versions</code></td>
|
|
<td >
|
|
Text</td>
|
|
<td class="text-muted" title="Hidden">
|
|
Last Known Versions
|
|
<p class="text-muted small">
|
|
Stores the JSON of last known versions of various installed apps. It is used to show release notes.</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>49</td>
|
|
<td ><code>third_party_authentication</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Third Party Authentication
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>50</td>
|
|
<td ><code>fb_username</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Facebook Username
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>51</td>
|
|
<td ><code>fb_userid</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Facebook User ID
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>52</td>
|
|
<td ><code>google_userid</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Google User ID
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>53</td>
|
|
<td ><code>column_break_49</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>54</td>
|
|
<td ><code>github_userid</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Github User ID
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>55</td>
|
|
<td ><code>github_username</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Github Username
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<hr>
|
|
<h3>Controller</h3>
|
|
<h4>frappe.core.doctype.user.user</h4>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 style="font-weight: normal;">Class <b>User</b></h3>
|
|
|
|
<p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>
|
|
|
|
<div class="docs-attr-desc"><p></p>
|
|
</div>
|
|
<div style="padding-left: 30px;">
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="a_system_manager_should_exist" href="#a_system_manager_should_exist" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>a_system_manager_should_exist</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="add_roles" href="#add_roles" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>add_roles</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Add roles to user and save</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="add_system_manager_role" href="#add_system_manager_role" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>add_system_manager_role</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="after_rename" href="#after_rename" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>after_rename</b>
|
|
<i class="text-muted">(self, olddn, newdn, merge=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="append_roles" href="#append_roles" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>append_roles</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Add roles to user</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="autoname" href="#autoname" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>autoname</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>set name as email id</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="before_rename" href="#before_rename" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>before_rename</b>
|
|
<i class="text-muted">(self, olddn, newdn, merge=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="check_enable_disable" href="#check_enable_disable" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>check_enable_disable</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="email_new_password" href="#email_new_password" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>email_new_password</b>
|
|
<i class="text-muted">(self, new_password=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="ensure_unique_roles" href="#ensure_unique_roles" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>ensure_unique_roles</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="get_fullname" href="#get_fullname" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_fullname</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>get first<em>name space last</em>name</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="get_other_system_managers" href="#get_other_system_managers" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_other_system_managers</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="on_trash" href="#on_trash" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>on_trash</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="on_update" href="#on_update" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>on_update</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="password_reset_mail" href="#password_reset_mail" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>password_reset_mail</b>
|
|
<i class="text-muted">(self, link)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="password_update_mail" href="#password_update_mail" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>password_update_mail</b>
|
|
<i class="text-muted">(self, password)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="remove_all_roles_for_guest" href="#remove_all_roles_for_guest" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>remove_all_roles_for_guest</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="remove_roles" href="#remove_roles" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>remove_roles</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="reset_password" href="#reset_password" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>reset_password</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="send_login_mail" href="#send_login_mail" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>send_login_mail</b>
|
|
<i class="text-muted">(self, subject, template, add_args)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>send mail with login details</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="send_password_notifcation" href="#send_password_notifcation" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>send_password_notifcation</b>
|
|
<i class="text-muted">(self, new_password)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="send_welcome_mail_to_user" href="#send_welcome_mail_to_user" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>send_welcome_mail_to_user</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="share_with_self" href="#share_with_self" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>share_with_self</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="update_gravatar" href="#update_gravatar" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>update_gravatar</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="validate" href="#validate" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="validate_email_type" href="#validate_email_type" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate_email_type</b>
|
|
<i class="text-muted">(self, email)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="validate_rename" href="#validate_rename" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate_rename</b>
|
|
<i class="text-muted">(self, olddn, newdn)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="validate_share" href="#validate_share" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate_share</b>
|
|
<i class="text-muted">(self, docshare)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="validate_system_manager_user_type" href="#validate_system_manager_user_type" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate_system_manager_user_type</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.get_active_users" href="#frappe.core.doctype.user.user.get_active_users" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>get_active_users</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns No. of system users who logged in, in the last 3 days</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.get_active_website_users" href="#frappe.core.doctype.user.user.get_active_website_users" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>get_active_website_users</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns No. of website users who logged in, in the last 3 days</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.core.doctype.user.user.get_all_roles</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.get_all_roles" href="#frappe.core.doctype.user.user.get_all_roles" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>get_all_roles</b>
|
|
<i class="text-muted">(arg=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>return all roles</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.core.doctype.user.user.get_languages</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.get_languages" href="#frappe.core.doctype.user.user.get_languages" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>get_languages</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.core.doctype.user.user.get_perm_info</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.get_perm_info" href="#frappe.core.doctype.user.user.get_perm_info" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>get_perm_info</b>
|
|
<i class="text-muted">(arg=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>get permission info</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.get_permission_query_conditions" href="#frappe.core.doctype.user.user.get_permission_query_conditions" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>get_permission_query_conditions</b>
|
|
<i class="text-muted">(user)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.get_system_users" href="#frappe.core.doctype.user.user.get_system_users" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>get_system_users</b>
|
|
<i class="text-muted">(exclude_users=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.get_total_users" href="#frappe.core.doctype.user.user.get_total_users" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>get_total_users</b>
|
|
<i class="text-muted">(exclude_users=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns total no. of system users</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.core.doctype.user.user.get_user_roles</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.get_user_roles" href="#frappe.core.doctype.user.user.get_user_roles" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>get_user_roles</b>
|
|
<i class="text-muted">(arg=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>get roles for a user</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.get_website_users" href="#frappe.core.doctype.user.user.get_website_users" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>get_website_users</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns total no. of website users</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.has_permission" href="#frappe.core.doctype.user.user.has_permission" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>has_permission</b>
|
|
<i class="text-muted">(doc, user)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.notifify_admin_access_to_system_manager" href="#frappe.core.doctype.user.user.notifify_admin_access_to_system_manager" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>notifify_admin_access_to_system_manager</b>
|
|
<i class="text-muted">(login_manager=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.core.doctype.user.user.reset_password</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.reset_password" href="#frappe.core.doctype.user.user.reset_password" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>reset_password</b>
|
|
<i class="text-muted">(user)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.core.doctype.user.user.sign_up</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.sign_up" href="#frappe.core.doctype.user.user.sign_up" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>sign_up</b>
|
|
<i class="text-muted">(email, full_name)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.core.doctype.user.user.update_password</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.update_password" href="#frappe.core.doctype.user.user.update_password" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>update_password</b>
|
|
<i class="text-muted">(new_password, key=None, old_password=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.user_query" href="#frappe.core.doctype.user.user.user_query" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>user_query</b>
|
|
<i class="text-muted">(doctype, txt, searchfield, start, page_len, filters)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.core.doctype.user.user.verify_password</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.core.doctype.user.user.verify_password" href="#frappe.core.doctype.user.user.verify_password" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.core.doctype.user.user.<b>verify_password</b>
|
|
<i class="text-muted">(password)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Linked In:</h4>
|
|
<ul>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/website/blogger">Blogger</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/core/communication">Communication</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/core/docshare">DocShare</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/email/standard_reply">Standard Reply</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/desk/todo">ToDo</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
<!-- autodoc -->
|
|
<!-- jinja -->
|
|
<!-- static --> |