Skip to content

Commit 25a86c9

Browse files
committed
docs: bulk_add docstring
1 parent 02adf46 commit 25a86c9

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

tableauserverclient/server/endpoint/users_endpoint.py

+11
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,17 @@ def bulk_add(self, users: Iterable[UserItem]) -> JobItem:
113113
The user's display name is read from the fullname attribute.
114114
115115
Email is optional, but if provided, it must be a valid email address.
116+
117+
If auth_setting is not provided, the default is ServerDefault.
118+
119+
If site_role is not provided, the default is Unlicensed.
120+
121+
Password is optional, and only used if the server is using local
122+
authentication. If using any other authentication method, the password
123+
should not be provided.
124+
125+
Details about administrator level and publishing capability are
126+
inferred from the site_role.
116127
"""
117128
url = f"{self.baseurl}/import"
118129
# Allow for iterators to be passed into the function

0 commit comments

Comments
 (0)