From 9841bb9522cd81e234344f20b837f18273b8961e Mon Sep 17 00:00:00 2001
From: Mateusz Mandera <mateusz.mandera@zulip.com>
Date: Sat, 3 Aug 2024 21:35:59 +0200
Subject: [PATCH] docs: Add note to SOCIAL_AUTH_SYNC_CUSTOM_ATTRS_DICT in
 settings.py.

---
 zproject/prod_settings_template.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/zproject/prod_settings_template.py b/zproject/prod_settings_template.py
index 53bd333b87..85a8e515e1 100644
--- a/zproject/prod_settings_template.py
+++ b/zproject/prod_settings_template.py
@@ -508,6 +508,9 @@ SOCIAL_AUTH_SAML_SUPPORT_CONTACT = {
     "emailAddress": ZULIP_ADMINISTRATOR,
 }
 
+## Note: Any additional SAML attributes that'll be used here must be
+## listed in the "extra_attrs" field in the SOCIAL_AUTH_SAML_ENABLED_IDPS
+## configuration for your IdP.
 # SOCIAL_AUTH_SYNC_CUSTOM_ATTRS_DICT = {
 #    "example_org": {
 #        "saml": {