From bd2d6e9c350ea72ea7ba56f509a0d0fa2d81d03c Mon Sep 17 00:00:00 2001 From: Joris Beckers Date: Fri, 7 Dec 2018 22:26:01 +0100 Subject: [PATCH] Add more details for the USERNAME_CLAIM setting --- docs/settings_ref.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/settings_ref.rst b/docs/settings_ref.rst index ae041d4..26e6eb6 100644 --- a/docs/settings_ref.rst +++ b/docs/settings_ref.rst @@ -316,10 +316,13 @@ USERNAME_CLAIM Name of the claim sent in the JWT token from ADFS that contains the username. If the user doesn't exist yet, this field will be used as it's username. +The value of the claim must be a unique value. No 2 users should ever have the same value. + .. warning:: - You shouldn't need to set this value for ADFS or Azure AD. Because ``winaccountname`` maps to the ``sAMAccountName`` - on Active Directory, which is guaranteed to be unique. The same for Azure AD where ``upn`` maps to the - ``UserPrincipleName``, which is unique on Azure AD. + You shouldn't need to set this value for ADFS or Azure AD unless you use custom user models. + Because ``winaccountname`` maps to the ``sAMAccountName`` on Active Directory, which is guaranteed + to be unique. The same for Azure AD where ``upn`` maps to the ``UserPrincipleName``, which is unique + on Azure AD. .. NOTE:: You can find the short name for the claims you configure in the ADFS management console underneath