From bd00337776acb5bf4246cfa3c0cb923d44656941 Mon Sep 17 00:00:00 2001
From: Mateusz Mandera <mateusz.mandera@zulip.com>
Date: Mon, 15 Apr 2024 02:54:24 +0200
Subject: [PATCH] docs: Document new create_guests_without_streams SCIM option.

Documents the little functionality added in
c9ca4e68e525c8e5d4e1019e45b7a3105b21e41e.
---
 docs/production/scim.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/docs/production/scim.md b/docs/production/scim.md
index 29ccd9ffb6..a264a70bf5 100644
--- a/docs/production/scim.md
+++ b/docs/production/scim.md
@@ -48,3 +48,23 @@ The Zulip server-side configuration is straightforward:
    Use the value `Bearer <secret token>` using the `bearer_token` you've generated
    earlier as the `API token` that the SCIM IdP will ask for when configuring
    authentication details.
+
+## Additional options
+
+- To enable the creation of guest accounts without automatically subscribing them to any initial streams,
+  add `"create_guests_without_streams": True` to your client's config dict in `SCIM_CONFIG`.
+  This option is particularly useful for organizations that prefer to manually invite new guest users
+  to the appropriate streams.
+
+  Example configuration with the additional option:
+
+  ```
+  SCIM_CONFIG = {
+     "subdomain": {
+        "bearer_token": "<secret token>",
+        "scim_client_name": "okta",
+        "name_formatted_included": False,
+        "create_guests_without_streams": True,
+     }
+  }
+  ```