Documentation of LDAP authentication support. Fixes #5348

This commit is contained in:
Abhilasha Narendra
2020-04-27 20:28:39 +05:30
committed by Akshay Joshi
parent 99d1068f70
commit fbee63085c
9 changed files with 121 additions and 20 deletions

View File

@@ -5,12 +5,12 @@
*******************************
When invoking pgAdmin in desktop mode, a password is randomly generated, and
then ignored. If you install pgAdmin in server mode, you will be prompted for
then ignored. If you install pgAdmin in server mode, you will be prompted for
an administrator email and password for the pgAdmin client.
When you authenticate with pgAdmin, the server definitions associated with that
login role are made available in the tree control. An administrative user can
use the *User Management* dialog to
use the *User Management* dialog to:
* add or delete pgAdmin roles
* assign privileges
@@ -20,11 +20,13 @@ use the *User Management* dialog to
:alt: pgAdmin user management window
:align: center
Use the *Filter by email* search field to find a user; enter a user's email
address to find a user. If the user exists, the *User Management* table will
display the user's current information.
Use the *Search* field to specify a criteria and review a list of users
that matches with the specified criteria. You can enter a value that matches
the following criteria types: *Authentication source*, *Username*, or *Email*.
For example, you can enter *ldap* in the search box and only the records having
*ldap* as authentication source will be displayed in the *User Management* table.
To add a user, click *Add* to add new role.
To add a user, click the Add (+) button at the top right corner.
.. image:: images/add_user.png
:alt: pgAdmin user management window add new user
@@ -32,10 +34,16 @@ To add a user, click *Add* to add new role.
Provide information about the new pgAdmin role in the row:
* Click in the *Email* field, and provide an email address for the user; this
address will be used to recover the password associated with the role should
the password be lost.
* Use the drop-down listbox next to *Role* to select whether a user is an
* Use the drop-down list box next to *Authentication source* field to select the
type of authentication that should be used for the user. If LDAP
authentication is not enabled for pgAdmin, then *Authentication source* field
is disabled.
* Click in the *Username* field, and provide a username for the user. This field
is enabled only if you select *ldap* as authentication source. If you select
*internal* as authentication source, your email address is displayed in the
username field.
* Click in the *Email* field, and provide an email address for the user.
* Use the drop-down list box next to *Role* to select whether a user is an
*Administrator* or a *User*.
* Select *Administrator* if the user will have administrative privileges
@@ -46,8 +54,10 @@ Provide information about the new pgAdmin role in the row:
active; the default is *Yes*. Use this switch to disable account activity
without deleting an account.
* Use the *New password* field to provide the password associated with the user
specified in the *Email* field.
* Re-enter the password in the *Confirm password* field.
specified in the *Email* field. This field is disabled if you select *ldap*
as authentication source since LDAP password is not stored in the pgAdmin database.
* Re-enter the password in the *Confirm password* field. This field is disabled
if you select *ldap* as authentication source.
To discard a user, and revoke access to pgAdmin, click the trash icon to the
left of the row and confirm deletion in the *Delete user?* dialog.
@@ -58,5 +68,3 @@ users, but otherwise have the same capabilities as those with the *User* role.
* Click the *Help* button (?) to access online help.
* Click the *Close* button to save work. You will be prompted to return to the
dialog if your selections cannot be saved.