Skip to content

Commit 9479057

Browse files
committed
docs: bulk_add docstring
1 parent 24db31f commit 9479057

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

0 commit comments

Comments
 (0)