Skip to content

Commit 518d495

Browse files
committed
docs: bulk_add docstring
1 parent 77a17fc commit 518d495

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

tableauserverclient/server/endpoint/users_endpoint.py

+10-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,16 @@ def add_all(self, users: list[UserItem]):
106106
@api(version="3.15")
107107
def bulk_add(self, users: Iterable[UserItem]) -> JobItem:
108108
"""
109-
line format: Username [required], password, display name, license, admin, publish
109+
When adding users in bulk, the server will return a job item that can be used to track the progress of the
110+
operation. This method will return the job item that was created when the users were added.
111+
112+
For each user, name is required, and other fields are optional. If connected to activte directory and
113+
the user name is not unique across domains, then the domain attribute must be populated on
114+
the UserItem.
115+
116+
The user's display name is read from the fullname attribute.
117+
118+
Email is optional, but if provided, it must be a valid email address.
110119
"""
111120
url = f"{self.baseurl}/import"
112121
# Allow for iterators to be passed into the function

0 commit comments

Comments
 (0)