From 77aedee79a4432a959ba937e4eac680ed99c7ff9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Kr=C3=BCger=20Svensson?= Date: Thu, 30 Mar 2023 13:55:25 +0200 Subject: [PATCH] docs: add docs for scopes --- docs/settings_ref.rst | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/settings_ref.rst b/docs/settings_ref.rst index f16d215..8d1c011 100644 --- a/docs/settings_ref.rst +++ b/docs/settings_ref.rst @@ -117,7 +117,7 @@ The dictionary can also map extra details to the Django user account using an `Extension of the User model `_ Set a dictionary as value in the CLAIM_MAPPING setting with as key the name User model. You will need to make sure the related field exists before the user authenticates. -This can be done by creating a receiver on the +This can be done by creating a receiver on the `post_save `_ signal that creates the related instance when the ``User`` instance is created. @@ -125,9 +125,9 @@ example .. code-block:: python - 'CLAIM_MAPPING': {'first_name': 'given_name', - 'last_name': 'family_name', - 'email': 'upn', + 'CLAIM_MAPPING': {'first_name': 'given_name', + 'last_name': 'family_name', + 'email': 'upn', 'userprofile': { 'employee_id': 'employeeid' }} @@ -369,6 +369,16 @@ RETRIES The number of time a request to the ADFS server is retried. It allows, in combination with :ref:`timeout_setting` to fine tune the behaviour of the connection to ADFS. + +SCOPES +------ +* **Default**: ``[]`` +* **Type**: ``list`` + +**Only used when you have v2 AzureAD config** + + + SERVER ------ * **Default**: