.. index:: pair: Site administration; Users .. _users: Users ---------------- In the *Users* menu of the site administration you can: * search for users * change settings for individual users * suspend and delete users * make users site staff or administrators * check the admin notification settings * add users manually or by CSV .. _user_search: User search ~~~~~~~~~~~~~~~ Site administrators can search for any user on the entire site. You can search for their * first name * last name * display name * username * email address .. note:: The display name is not shown in the user list. That will be a feature of Mahara 1.5. .. figure:: /images/site_admin/user_search.* :alt: User search User search You can combine any search and filter options. However, if you use too many, you may not yield any results. #. Filter the users you wish to display by their initials of the first and / or last name. #. Type the name, display name, username or email address or any partial thereof you wish to search for in the search field. #. Choose the institution from the drop-down menu in which you wish to search for the user. #. Click the *Search* button |search| to start searching. #. View your results. The default order is alphabetically according the the first name. However, you can change the order of the results by clicking on a heading and sort that column in ascending or descending order. #. Click on the username of the user for which you want to :ref:`take further actions `. .. _user_account_settings: User account settings ~~~~~~~~~~~~~~~~~~~~~~~~ On the *Account settings* page of a user in the administration area, you can perform a number of actions to manage the user's account. However, you cannot change personal information about this user, e.g. name, email, from this page. This can only be done in the *Content* area of the user's account. .. figure:: /images/site_admin/user_account_settings.* :alt: User account settings Overview of the user account settings page #. :ref:`Login as this user ` #. :ref:`Change site account settings ` #. Change institution settings #. Suspend and / or delete this user .. _login_as: Login as ^^^^^^^^^^^^^^ As administrator you have the power to log in as any user that you manage ans masquerade as them. If you are a site administrator, you can log in as any user while institution administrators can only perform this action for any user who is in their user management. It is a great function for troubleshooting a user account because you see everything as the user would without having to know his password. .. warning:: This function can easily be misused by an administrator because he can make changes to the user's portfolio and artefacts as well as participate in groups while logged in as that user. Users should be aware of this function and that an administrator can enter their account. Sites should have clear policies around the use of this function so that the privacy of users and their portfolios and collaborative work is protected. Therefore, there should also not be many users within an institution who have administrator rights. .. figure:: /images/site_admin/login_as.* :alt: Login as another user Login as another user #. Click on the user's name to go to his profile page. #. Click on the *Login as* button to become that user. You see a red bar at the top of the browser window telling you that you are masquerading as another user. .. figure:: /images/site_admin/masquerading.* :alt: Stop masquerading as another user Stop masquerading as another user When you want to return to your own account again, click the *Become [your user name] again* link at the top of the browser window. .. _site_account_settings: Change site account settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You can view and change a number of settings for a user's account. .. note:: Depending on the authentication method that is associated with this user, you may not be able to edit all settings. .. figure:: /images/site_admin/site_account_settings.* :alt: Site account settings of a user Site account settings of a user #. **Change username**: Give the user a different username. This field is not available when the account is managed by an external authentication method. #. **Reset password**: Change the password for this user account. This field is not available when the account is managed by an external authentication method. #. **Force password change on next login**: Check this box if the user shall change his password when he next logs in. This field is not available when the account is managed by an external authentication method. #. **Site staff**: Check this box if the user shall be able to create controlled groups. #. **Site administrator**: Check this box if the user shall have full administrative rights. #. **Email**: Check this box to disable the sending of emails for this user. If email is disabled notifications and messages can only be viewed in the internal inbox. Depending on your setup, if emails are bounced back to the sender, then email may be automatically disabled. #. **Account expires**: Choose the date on which the user's login is automatically disabled. The default setting is that the date is not specified. You always see the current date in the greyed out date fields. You can set an automatic account expiry date for all users in the :ref:`account settings of the site configuration `. #. **File quota (MB)**: Change the storage allowance for a user's personal files area. The default value as set in the :ref:`files configuration ` in the plugin administration. #. **Authentication method**: Choose the authentication method that the user uses to log in to Mahara. The authentication methods can be set up in the :ref:`institution administration `. Depending on the authentication method that you have chosen, you may have to provide a *remote username* to allow the user to log in. #. Click the *Save changes* button when you are done editing the settings. .. warning:: When the email address is disabled, users cannot reset their passwords themselves as no email can be sent. .. _user_institution_settings: Change institution settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You can view and change settings regarding a user's membership in institutions. Depending on the :ref:`site settings for institutions `, a user may be added to more than one institution. .. figure:: /images/site_admin/user_institution_settings.* :alt: Institution settings for a user Institution settings for a user #. Choose the institution from the drop-down menu to which you want to add this user. #. Click the *Add User to Institution* button to make him a member of this institution. #. **Membership expires**: If you wish, specify the date when the user will be removed from this institution automatically. If you click the "Not specified" check box, no end date will be set. #. **ID number**: Provide an optional identifier for this user in this institution. This field is not editable by the user. #. **Institution staff**: Check this box if you want to give this user staff rights in this institution. This will allow him to create controlled groups. #. **Institution admin**: Check this box if you want to make this user an administrator of this institution. This will allow him to manage all users in this institution. #. Click the *Update* button to save your changes. #. Click the *Remove user from this institution* button to disassociate this user from this institution. The user will stay in any other institution that he may be in, and he will also keep his account no matter whether he is in an institution or not. .. _suspend_user: Suspend user ^^^^^^^^^^^^^^^^^^ Suspend a user if he does not follow the terms and conditions of the site and behaves inappropriately. Suspended users cannot log in, but all their content is still available. .. figure:: /images/site_admin/suspend.* :alt: Suspend a user Suspend a user #. Provide a reason for your suspension. This is particularly useful when you are not the only administrator and / or need to remember after some time why you suspended this user. #. Click the *Suspend User* button to disallow the user from logging in. When a user has been suspended, the following suspension message appears on his account settings stating the reason for the suspension and giving the administrators the possibility to unsuspend the user by clicking on the *Unsuspend User* button. .. figure:: /images/site_admin/suspension_notice.* :alt: Suspension notice Suspension notice on the account settings page When the user tries to log in, he will see the suspension message and the reason. He can then contact an administrator via the "Contact Us" form for further action. .. figure:: /images/site_admin/suspension_reason.* :alt: Suspended user tries to log in Suspended user tries to log in and gets suspension message .. _delete_user: Delete user ^^^^^^^^^^^^^^ A user can delete his own account from Mahara on his :ref:`account settings ` if he is allowed to by his institution. Site administrators can also delete user accounts at any time. .. figure:: /images/site_admin/delete_user.* :alt: Delete a user account Delete a user account Click the *Delete User* button to delete this user account permanently. This action **cannot** be undone. As this is a permanent action, you see a confirmation pop-up window that you will have to acknowledge. .. warning:: When you delete a user account, **all personal data is wiped from the system**. This applies to everything that is in a user's *Content* and *Portfolio* area. This action cannot be undone. His contributions in groups, e.g. forum messages, uploaded files and pages created in a group, are still available, but are made anonymous by changing the name the "Deleted user" as author where an author is shown. .. note:: If an account was deleted by accident - either by a user or by an administrator - swift action may result in recovery of (most of) the data from a backup file. This requires access to the server's backups and the backend of Mahara. More information is available `on the wiki `_. .. _suspended_users: Suspended users ~~~~~~~~~~~~~~~~~~~~ A list of all suspended users is available in the sub-menu *Suspended users*. Here you can unsuspend or delete them. .. figure:: /images/site_admin/suspended_users.* :alt: List of all suspended users List of all suspended users #. Select the user(s) for which you want to perform the same action. #. Click the *Unsuspend Users* button to reinstate the accounts for all selected users. #. Click the *Delete Users* button to delete all selected users in bulk. **This account cannot be undone and all personal information of these users will be deleted** (see :ref:`delete user `). .. _staff_users: Staff users ~~~~~~~~~~~~~~~ On this page you can choose which users receive site staff rights. Potential staff members - any user on the site - are listed on the left while existing site staff members are listed on the right. .. figure:: /images/site_admin/site_staff.* :alt: Site staff users Give site staff rights #. From the list under **Potential Staff**, select the users you wish to make site staff. You can also select multiple users at once using Ctrl and Shift click. #. If you have too many users on your site and you cannot see / find the user you want, you can search for him in the **Search** box. #. Add the potential staff members to the right-hand side - **Current Staff** - by clicking on the *right-arrow* button |right-arrow|. #. If you want to remove an existing or accidentally added site staff member, you can remove him from the list on the right-hand side by clicking on him. #. Then click on the *left-arrow* button |left-arrow|, and he is removed from the list. #. When you have chosen all members you wish to make site staff, click the *Submit* button. .. _site_admins: Site admins ~~~~~~~~~~~~~ Site administrators have powerful rights on Mahara. They can make far-reaching changes and also :ref:`log in as other users `. Be careful whom you give these rights. One site administrator is needed for each site. The total number of site administrators should be kept small. .. figure:: /images/site_admin/site_admins.* :alt: Site admins Give site admin rights #. From the list under **Potential Admins**, select the users you wish to make site administrators. You can also select multiple users at once using Ctrl and Shift click. #. If you have too many users on your site and you cannot see / find the user you want, you can search for him in the **Search** box. #. Add the potential site admin to the right-hand side - **Current Admins** - by clicking on the *right-arrow* button |right-arrow|. #. If you want to remove an existing or accidentally added site admin, you can remove him from the list on the right-hand side by clicking on him. #. Then click on the *left-arrow* button |left-arrow|, and he is removed from the list. #. When you have chosen all members you wish to make site admins, click the *Submit* button. .. _admin_notifications: Admin notifications ~~~~~~~~~~~~~~~~~~~~~~~ The *Admin Notifications* page lists all users with institution and site admin access on your site. It shows their selected notification preferences for all admin notifications. There should be at least one administrator receiving each type of message generated. Admin notifications are: * Contact us * Objectionable content * Repeat virus upload * Virus flag release .. figure:: /images/site_admin/admin_notifications.* :alt: Admin notifications Overview of the admin notification types .. _add_user: Add user ~~~~~~~~~~~~ You can add users to your site by creation accounts for them manually one by one. .. figure:: /images/site_admin/add_user.* :alt: Add a user Add a user manually #. Click the *Create new user from scratch* radio button if you want to create an empty account. Provide the first name, last name and email address for this user. #. Click the *Upload Leap2A File* radio button if you want to import a user from another Mahara instance or a system that supports the Leap2A standard. Such a user could have :ref:`exported ` his portfolio from another Mahara instance. #. Give the new user a **username**. The username may contain letters, numbers and most common symbols. It must be from 3 to 236 characters in length. Spaces are not allowed. #. Choose a **password** for the account. The password must be at least six characters long and contain at least one digit and two letters. #. Check this box if the new user should have **site staff** rights. #. Check this box if the new user should have **site administrator** rights. #. Review the allocated **file quota**. You may change it here for this user. #. Choose the institution of which the user should be a member. #. Check this box if the new user should have **institution administrator** rights in the chosen institution. #. Click the *Create User* account button. #. The user will receive an email with his account details. .. note:: You can change the settings under **Basic Details** on the :ref:`account settings page `. .. _add_users_csv: Add users by CSV ~~~~~~~~~~~~~~~~~~~~ You can use this function to upload new users in bulk via a csv file (comma-separated file). The first row of your csv file should specify the format of your data. For example, it should look like this: ``username,password,email,firstname,lastname,studentid`` This row **must** include: * username * password * email * firstname * lastname It must also include fields that are :ref:`mandatory ` for all users to fill out and :ref:`any fields locked for the institution ` you are uploading the users for. All other fields are optional. This is the full list of fields that you can add in addition to your csv file upload * **studentid** - Student ID is displayed in the profile * **preferredname** - Display name * **introduction** - Introduction is displayed in the profile * **officialwebsite** - Official web site * **personalwebsite** - Personal web site * **blogaddress** - URL to the blog * **address** - Street address * **town** - Town * **city** - City * **country** - Country * **homenumber** - Home phone number * **businessnumber** - Work phone number * **mobilenumber** - Mobile phone number * **faxnumber** - Fax number * **icqnumber** - ICQ nickname * **msnnumber** - MSN nickname * **aimscreenname** - AIM screen name * **yahoochat** - Yahoo Chat username * **skypeusername** - Skype ID * **jabberusername** - Jabber ID * **occupation** - Occupation is displayed in the profile * **industry** - Industry is displayed in the profile * **maildisabled** - Selection to disable the email address * **remoteuser** - Remote username for external authentication When you have created your csv file, you are ready to upload it. .. figure:: /images/site_admin/add_users_csv.* :alt: Add users by csv file Add users by csv file #. **Institution**: Choose the institution **and** the authentication method for the user accounts that you upload. You cannot change the authentication method later on in bulk, but only for each user individually. #. **CVS file**: You must upload a csv file by clicking on the *Browse* button and then selecting it from the files on your computer. #. **Force password change?** If you select this option, users need to change their password before they can log in for the first time. #. **Email users about their account?** If you select this option, users will receive an email with their account information. This is in particular good for internal accounts. For user accounts that are managed for example by SSO with Moodle or through LDAP, you do not have to select this option because the users should already know their login information. #. Click the *Add Users by CSV* button to upload the users. .. note:: Depending on your server settings and / or the size of your installation, you may not be able to upload all user accounts at once. You may wish to upload them in bunches of 100 instead. .. |search| image:: /images/buttons/search.* .. |right-arrow| image:: /images/buttons/right-arrow.* .. |left-arrow| image:: /images/buttons/left-arrow.*