Skip to content

Commit

Permalink
docs: bulk_add docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
jorwoods committed Jun 29, 2024
1 parent e54a43a commit 393e56c
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion tableauserverclient/server/endpoint/users_endpoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 393e56c

Please sign in to comment.