Skip to content

Commit 233f194

Browse files
committed
docs: bulk_add docstring
1 parent 7abd750 commit 233f194

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
@@ -116,6 +116,17 @@ def bulk_add(self, users: Iterable[UserItem]) -> JobItem:
116116
The user's display name is read from the fullname attribute.
117117
118118
Email is optional, but if provided, it must be a valid email address.
119+
120+
If auth_setting is not provided, the default is ServerDefault.
121+
122+
If site_role is not provided, the default is Unlicensed.
123+
124+
Password is optional, and only used if the server is using local
125+
authentication. If using any other authentication method, the password
126+
should not be provided.
127+
128+
Details about administrator level and publishing capability are
129+
inferred from the site_role.
119130
"""
120131
url = f"{self.baseurl}/import"
121132
# Allow for iterators to be passed into the function

0 commit comments

Comments
 (0)