Skip to content

Commit 3b76175

Browse files
committed
docs: bulk_add docstring
1 parent b63173a commit 3b76175

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

tableauserverclient/server/endpoint/users_endpoint.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,16 @@ def add_all(self, users: list[UserItem]):
366366
@api(version="3.15")
367367
def bulk_add(self, users: Iterable[UserItem]) -> JobItem:
368368
"""
369-
line format: Username [required], password, display name, license, admin, publish
369+
When adding users in bulk, the server will return a job item that can be used to track the progress of the
370+
operation. This method will return the job item that was created when the users were added.
371+
372+
For each user, name is required, and other fields are optional. If connected to activte directory and
373+
the user name is not unique across domains, then the domain attribute must be populated on
374+
the UserItem.
375+
376+
The user's display name is read from the fullname attribute.
377+
378+
Email is optional, but if provided, it must be a valid email address.
370379
"""
371380
url = f"{self.baseurl}/import"
372381
# Allow for iterators to be passed into the function

0 commit comments

Comments
 (0)