From 393e56ce03cc3cb42597662d4f8b1e45086dba08 Mon Sep 17 00:00:00 2001
From: Jordan Woods <13803242+jorwoods@users.noreply.github.com>
Date: Fri, 28 Jun 2024 22:07:29 -0500
Subject: [PATCH] docs: bulk_add docstring

---
 tableauserverclient/server/endpoint/users_endpoint.py | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/tableauserverclient/server/endpoint/users_endpoint.py b/tableauserverclient/server/endpoint/users_endpoint.py
index d85d1a65..5a876e9d 100644
--- a/tableauserverclient/server/endpoint/users_endpoint.py
+++ b/tableauserverclient/server/endpoint/users_endpoint.py
@@ -103,7 +103,16 @@ def add_all(self, users: List[UserItem]):
     @api(version="3.15")
     def bulk_add(self, users: Iterable[UserItem]) -> JobItem:
         """
-        line format: Username [required], password, display name, license, admin, publish
+        When adding users in bulk, the server will return a job item that can be used to track the progress of the
+        operation. This method will return the job item that was created when the users were added.
+
+        For each user, name is required, and other fields are optional. If connected to activte directory and
+        the user name is not unique across domains, then the domain attribute must be populated on
+        the UserItem.
+
+        The user's display name is read from the fullname attribute.
+
+        Email is optional, but if provided, it must be a valid email address.
         """
         url = f"{self.baseurl}/import"
         # Allow for iterators to be passed into the function