From 59b7ef957e9b83707dfee8bd69ad7590bd0e9e06 Mon Sep 17 00:00:00 2001 From: Antony Denyer Date: Thu, 26 Mar 2020 07:35:09 +0000 Subject: [PATCH] Clarify documentation intent --- docs/scenario/local_user_setup.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/scenario/local_user_setup.rst b/docs/scenario/local_user_setup.rst index 277fb8c..e6413c7 100644 --- a/docs/scenario/local_user_setup.rst +++ b/docs/scenario/local_user_setup.rst @@ -7,11 +7,12 @@ Setup for local user storage .. toctree:: :maxdepth: 4 -By local user storage a +When using local user storage a `User object `_ -get created for every logged in identity. This can be handy when you want to -link objects to this User. If that's not the case please read the -scenario :ref:`remote_user_setup`. +gets created for every logged in identity. This can be handy when you want to +add objects and relationships to the authenticated User. + +However, if you do not wish to store a local copy of a user please read the scenario :ref:`remote_user_setup`. Since **this is the default behaviour for Django Keycloak** you don't have to configure any setting. @@ -25,4 +26,4 @@ available. .. code-block:: python # settings.py - KEYCLOAK_OIDC_PROFILE_MODEL = 'django_keycloak.OpenIdConnectProfile' \ No newline at end of file + KEYCLOAK_OIDC_PROFILE_MODEL = 'django_keycloak.OpenIdConnectProfile'