Skip to content

Commit 3b0c157

Browse files
committed
docs: bulk_add docstring
1 parent 0073a75 commit 3b0c157

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

tableauserverclient/server/endpoint/users_endpoint.py

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

0 commit comments

Comments
 (0)