Skip to content

docs: docstrings for user item and endpoint #1485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jacalata merged 2 commits into from
Oct 11, 2024
Merged

docs: docstrings for user item and endpoint #1485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a84bcfd
docs: docstrings for user item and endpoint
jorwoods Oct 2, 2024
a50b213
docs: add serverresponseerror details
jorwoods Oct 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions tableauserverclient/models/user_item.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,34 @@


class UserItem:
"""
The UserItem class contains the members or attributes for the view
resources on Tableau Server. The UserItem class defines the information you
can request or query from Tableau Server. The class attributes correspond
to the attributes of a server request or response payload.


Parameters
----------
name: str
The name of the user.

site_role: str
The role of the user on the site.

auth_setting: str
Required attribute for Tableau Cloud. How the user autenticates to the
server.
"""

tag_name: str = "user"

class Roles:
"""
The Roles class contains the possible roles for a user on Tableau
Server.
"""

Interactor = "Interactor"
Publisher = "Publisher"
ServerAdministrator = "ServerAdministrator"
Expand All @@ -43,6 +68,11 @@ class Roles:
SupportUser = "SupportUser"

class Auth:
"""
The Auth class contains the possible authentication settings for a user
on Tableau Cloud.
"""

OpenID = "OpenID"
SAML = "SAML"
TableauIDWithMFA = "TableauIDWithMFA"
Expand Down
Loading