IntenseWebs/pgadmin4
3
0
Fork 0
mirror of https://github.com/pgadmin-org/pgadmin4.git synced 2025-02-25 18:55:31 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add the possibility to configure the OAuth2 claim which is used for the pgAdmin username. #5468

Browse Source 
This feature provides the possibility to configure the Oauth2 claim
which should be used as a username. The key in the config.py is called
'OAUTH2_USERNAME_CLAIM'. If you don't provide a custom key, the email
is used as the username, like before. So it is completely backward
compatible.
This commit is contained in:
Leon Maraite
2022-11-07 09:28:23 +01:00
committed by GitHub
parent c38face9fc
commit 6bc5808c53
4 changed files with 32 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en_US/oauth2.rst
View File

@@ -33,6 +33,8 @@ and modify the values for the following parameters:
"OAUTH2_SCOPE", "Oauth scope, ex: 'openid email profile'. Note that an 'email' claim is required in the resulting profile."
"OAUTH2_ICON", "The Font-awesome icon to be placed on the oauth2 button, ex: fa-github"
"OAUTH2_BUTTON_COLOR", "Oauth2 button color"
"OAUTH2_USERNAME_CLAIM", "The claim which is used for the username. If the value is empty
the email is used as username, but if a value is provided, the claim has to exist. Ex: *oid* (for AzureAD)"
"OAUTH2_AUTO_CREATE_USER", "Set the value to *True* if you want to automatically
create a pgAdmin user corresponding to a successfully authenticated Oauth2 user.
Please note that password is not stored in the pgAdmin database."

3
docs/en_US/release_notes_6_16.rst
View File

@@ -16,7 +16,8 @@ New features
************
| `Issue #1832 <https://github.com/pgadmin-org/pgadmin4/issues/1832>`_ - Added support for storing configurations of pgAdmin in an external database.
| `Issue #5468 <https://github.com/pgadmin-org/pgadmin4/issues/5468>`_ - Add the possibility to configure the Oauth2 claim which is used for the pgAdmin username.
Housekeeping
************