Skip to content

Commit fd877e5

Browse files
committed
docs: bulk_add docstring
1 parent 277b3ed commit fd877e5

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

0 commit comments

Comments
 (0)