entrouvert
/
authentic2-auth-fc
Archived
17
0
Fork 0
Code Issues Pull Requests Releases Activity

documentation update (#20860)

This commit is contained in:
Paul Marillonnet 2017-12-21 15:42:15 +01:00 committed by Benjamin Dauvergne
parent 298c7faca7
commit 9340dcff1a
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README
View File

@ -3,7 +3,7 @@ authentic2-auth-fc
==================
Authentic2 plugin to authenticate against *France Connect* the french
citizen and entreprise SSO.
citizen and enterprise SSO.
Installation
============
@ -20,17 +20,17 @@ Define the needed parameters::
A2_FC_CLIENT_SECRET = 'secret assigned by DISIC'
A2_FC_VERIFY_CERTIFICATE = False # True for production
A2_FC_CREATE = True set the plugin in provisionning mode. If a sub is unknown,
a user is created instead of asking authentication.
A2_FC_CREATE = True sets the plugin in provisioning mode. If a sub is unknown,
a user is created instead of asking for authentication.
When the create mode is enabled, the link for unlinking is hidden on the
profile frontend. This is due to the not yet implemented need of asking
the user credentiels when unlinking a user created without any other credential
that the authentication delegation. Unlinking meaning, loosing access to this
When the create mode is enabled, the link for account unlinking is hidden on
the profile frontend. This is due to the not yet implemented need for asking
the user credentials when unlinking a user created without any other credential
than the authentication delegation. Unlinking meaning, loosing access to this
account at the end of the current session. To enable unlinking when create is
unabled use A2_FC_ENABLE_UNLINK_WHEN_CREATE = True.
enabled use A2_FC_ENABLE_UNLINK_WHEN_CREATE = True.
A2_FC_LOGOUT_WHEN_UNLINK = True is using to trigger a logout toward the OP
A2_FC_LOGOUT_WHEN_UNLINK = True is used to trigger a logout toward the OP
after unlinking.
Platforms
@ -47,7 +47,7 @@ the default endpoints URL in your `local_settings.py` file::
Data Providers
==============
You can define data provider endpoints with the following dictionnary :
You can define data provider endpoints with the following dictionary :
A2_FC_FD_LIST = {
'revenu_fiscal_de_reference': [
@ -64,7 +64,7 @@ scopes in the `fd_scopes` get parameter :
fc/callback/?next=%2F&fd_scopes=revenu_fiscal_de_reference scolarite
The data received is recorded in the session with a dictionnary named `fc-data`
The data received is recorded in the session with a dictionary named `fc-data`
with scopes as keys and lists of data as values. A data is a tuple
FD name and data content.
@ -78,9 +78,9 @@ Attribute mapping
=================
You can map France Connect attributes to Authentic2 attributes through the
setting A2_FC_USER_INFO_MAPPINGS. A2_FC_USER_INFO_MAPPINGS is a dictionnary
whose keys are authentic2's attribute names and value can be France Connect
attribute names or dictionnary with the following keys:
setting A2_FC_USER_INFO_MAPPINGS. A2_FC_USER_INFO_MAPPINGS is a dictionary
whose keys are authentic2's attribute names and values can be France Connect
attribute names or dictionary with the following keys:
- `value` : a static value which will be assigned to the authentic2 attribute,
can be any Python value,
@ -90,12 +90,12 @@ attribute names or dictionnary with the following keys:
communes to their name,
- @insee-countries@ : translate the value using mapping from INSEE code of
countries to their name,
- @simple@ : lookup the value using the dictionnary in @translation_simple@.
- `compute`: compute a value using a known function, only known function for now
is @today@ which returns @datetime.date.today()@.
- @simple@ : lookup the value using the dictionary in @translation_simple@.
- `compute`: compute a value using a known function, the only known function
for now is @today@ which returns @datetime.date.today()@.
- `verified`: set the verified flag on the value.
Exemple:
Example:
A2_FC_USER_INFO_MAPPINGS = {
'first_name': 'given_name',