From 76c9fe45d43e32b4f081519b7cf4bd2f257222d4 Mon Sep 17 00:00:00 2001 From: anhefti Date: Wed, 18 Mar 2020 15:39:26 +0100 Subject: [PATCH] docu --- docs/useraccount.rst | 57 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 56 insertions(+), 1 deletion(-) diff --git a/docs/useraccount.rst b/docs/useraccount.rst index 4c318cd6..ac98c9e7 100644 --- a/docs/useraccount.rst +++ b/docs/useraccount.rst @@ -82,8 +82,63 @@ Exam as a supporter yet, the "Exam Administration" and "Monitoring" sections are **Create new user-account** +As a user with user-account write privileges (SEB Server administrator and institutional administrator) one can create new user-account for +others. This must usually be done if a particular user is not able to register itself for whatever reason or if internal policies prefere +this kind of registration. A a user with with user-account write privileges you can create a new user-account as follows; + +- Login to SEB Server application with your own account an click the "User Account" section on the left side menu. +- Use the "Add User Account" action from the action pane on the right hand-side to create a new user-account. +- Enter all mandatory account data within the form and use the "Register" action to confirm. +- If there is missing or wrong data, the registration form will highlight the concerned input fields with a red border and information text just below the field. +- If everything is accepted the user-account is created and the application shows the user-account form in view mode. +- Now the administrator can give the created user credentials directly to the user with the advice to immediately change the password. + **Modify user-account** +As a user with user-account write privileges (SEB Server administrator and institutional administrator) one can modify user-accounts of others +while all other users can only modify its own account settings. + +- Login to SEB Server application with your own account an click the "User Account" section on the left side menu. +- As a user with user-account write privileges one will see the list of all available user-accounts. Find the user-account that must be modified + by using the filter above and double-click on the respective list entry to open the user-account form in view mode +- Without user-account write privileges, a user will just see its own user-account form in view mode. +- Use the "Edit User Account" action from the action pain on the right to change to edit mode. Apply all needed modifications and + save the user-account by using the "Save User Account" action from the action pane. +- If there is missing or wrong data, the registration form will highlight the concerned input fields with a red border and information text just below the field. +- If everything is accepted the user-account is created and the application shows the user-account form in view mode. + **Change password** -**Activate / Deactivate user-account \ No newline at end of file +As a user with user-account write privileges (SEB Server administrator and institutional administrator) one can change the password also for others +while all other users can only modify change its own password. The current password must be known to change the password. + +- Login to SEB Server application with your own account an click the "User Account" section on the left side menu. +- As a user with user-account write privileges one will see the list of all available user-accounts. Find the user-account that must be modified + by using the filter above and double-click on the respective list entry to open the user-account form in view mode +- Without user-account write privileges, a user will just see its own user-account form in view mode. +- Use the "Change Password" action on the right action pane to open the change password form. +- No you must fist give the correct old password and the new password then with confirmation. +- Use the "Save New Password action form the right action pane to save the new password settings. +- If you are changing your own password and everything is correct, the application will automatically log you out and prompt you to sign in with the new password. +- If you are changing the password of another user-account the application and everything is correct, the application + direct you back to the user-account form in view mode and show a confirmation message. + +.. image:: images/account/change_password.png + :align: center + :target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/account/change_password.png + +**Activate / Deactivate user-account + +Users with user-account write privileges (SEB Server administrator and institutional administrator) are able to activate/deactivate +user-accounts of others. A inactive user-account prevent a user to sign-in. There are several different ways or places where the status +of a user-account can be changed + +- On the list view while one list entry is selected, by using the "Activate User Account" or "Deactivate User Account" action from + the action pain at the right side. There will be automatically appear the proper action in relation to the selected list entry and whether + it is already active or inactive. +- In the user-account form in view mode by using the "Activate User Account" or "Deactivate User Account" action from + the action pain at the right side. There will be automatically appear the proper action in relation to the current user-account. +- If one creates a new user-account there is the possibility to create and activate the user-account by using the "Activate User Account" + action from the action pain on the right side. +- The same situation appears for inactive user-accounts in edit mode. +