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 Sep 19, 2024
1 parent 7abd750 commit 233f194
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions tableauserverclient/server/endpoint/users_endpoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,17 @@ def bulk_add(self, users: Iterable[UserItem]) -> JobItem:
The user's display name is read from the fullname attribute.
Email is optional, but if provided, it must be a valid email address.
If auth_setting is not provided, the default is ServerDefault.
If site_role is not provided, the default is Unlicensed.
Password is optional, and only used if the server is using local
authentication. If using any other authentication method, the password
should not be provided.
Details about administrator level and publishing capability are
inferred from the site_role.
"""
url = f"{self.baseurl}/import"
# Allow for iterators to be passed into the function
Expand Down

0 comments on commit 233f194

Please sign in to comment.