1
1
.. _user_management :
2
2
3
3
*******************************
4
- `User Management Dialog `:index:
4
+ `User Management `:index:
5
5
*******************************
6
6
7
7
When invoking pgAdmin in desktop mode, a password is randomly generated, and
8
8
then ignored. If you install pgAdmin in server mode, you will be prompted for
9
9
an administrator email and password for the pgAdmin client.
10
10
11
11
When you authenticate with pgAdmin, the server definitions associated with that
12
- login role are made available in the tree control. An administrative user can
13
- use the *User Management * dialog to:
12
+ login role are made available in the tree control.
14
13
15
- * add or delete pgAdmin roles
16
- * assign privileges
17
- * manage the password associated with a role
14
+ Users Tab
15
+ *******************
16
+ An administrative user can use the *Users * tab to:
17
+
18
+ * manage pgAdmin users
19
+ * change users role
20
+ * change password for a user
21
+ * deactivate user
22
+ * unlock a locked user
18
23
19
24
.. image :: images/user.png
20
25
:alt: pgAdmin user management window
@@ -26,42 +31,39 @@ the following criteria types: *Authentication source*, *Username*, or *Email*.
26
31
For example, you can enter *ldap * in the search box and only the records having
27
32
*ldap * as authentication source will be displayed in the *User Management * table.
28
33
29
- To add a user, click the Add (+) button at the top right corner.
34
+ To add a user, click the Add (+) button at the top left corner. It will open a
35
+ dialog where you can fill in details for the new user.
30
36
31
37
.. image :: images/add_user.png
32
38
:alt: pgAdmin user management window add new user
33
39
:align: center
34
40
35
41
Provide information about the new pgAdmin role in the row:
36
42
37
- * Use the drop-down list box next to *Authentication source * field to select the
38
- type of authentication that should be used for the user. If authentication
39
- source is only 'internal' then *Authentication source * field
40
- is disabled. Supported *Authentication source * are internal, ldap, kerberos,
41
- oauth2 and webserver.
42
- * Click in the *Username * field, and provide a username for the user. This field
43
+ * Use the *Authentication source * field to select the type of authentication that
44
+ should be used for the user. If authentication source in the pgAdmin server config
45
+ has 'internal' only then *Authentication source * field will be disabled. Supported
46
+ *Authentication source * are internal, ldap, kerberos, oauth2 and webserver.
47
+ * Use the *Username * field to provide a username for the user. This field
43
48
is enabled only when you select authentication source except *internal *. If you
44
- select *internal * as authentication source, your email address is displayed in the
45
- username field.
46
- * Click in the *Email * field, and provide an email address for the user.
47
- * Use the drop-down list box next to *Role * to select whether a user is an
48
- *Administrator * or a *User *.
49
-
49
+ select *internal * as authentication source, your email address will be taken as
50
+ the username.
51
+ * Use the *Email * field to provide an email address for the user. Email is a
52
+ mandatory field for authentication source *internal *.
53
+ * Use the *Role * field to select whether a user is an *Administrator * or a *User *.
50
54
* Select *Administrator * if the user will have administrative privileges
51
55
within the pgAdmin client.
52
56
* Select *User * to create a non-administrative user account.
53
-
54
- * Move the *Active * switch to the *No * position if the account is not currently
55
- active; the default is *Yes *. Use this switch to disable account activity
56
- without deleting an account.
57
+ * Use the *Active * switch to enable or disable account activity without deleting an
58
+ account; by default it is enabled.
57
59
* Use the *New password * field to provide the password associated with the user
58
60
specified in the *Email * field. This field is disabled if you select any
59
61
authentication source except *internal *.
60
62
* Re-enter the password in the *Confirm password * field. This field is disabled
61
63
if you select *ldap * as authentication source.
62
- * *Locked * switch is disabled by default when set to * False * . It is only enabled
63
- when the user is locked by trying unsuccessful login attempts. Move the switch
64
- to the * False * position if you want to unlock the account.
64
+ * *Locked * switch cannot be changed if is turned off . It can only be changed
65
+ when the user is locked by trying unsuccessful login attempts. Turn off the
66
+ switch if you want to unlock the account.
65
67
66
68
To discard a user, and revoke access to pgAdmin, click the trash icon to the
67
69
left of the row and confirm deletion in the *Delete user? * dialog. If the user
@@ -72,9 +74,8 @@ dialog will appear to change the ownership of a shared server.
72
74
Users with the *Administrator * role are able to add, edit and remove pgAdmin
73
75
users, but otherwise have the same capabilities as those with the *User * role.
74
76
77
+ * Click the *Refresh * button to get latest users list.
75
78
* Click the *Help * button (?) to access online help.
76
- * Click the *Close * button to save work. You will be prompted to return to the
77
- dialog if your selections cannot be saved.
78
79
79
80
80
81
Using 'setup.py' command line script
0 commit comments