Skip to content

Commit

Permalink
docs: docstrings for group endpoint and item
Browse files Browse the repository at this point in the history
  • Loading branch information
jorwoods committed Oct 24, 2024
1 parent c3ea910 commit ba28330
Show file tree
Hide file tree
Showing 2 changed files with 365 additions and 11 deletions.
40 changes: 40 additions & 0 deletions tableauserverclient/models/group_item.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,46 @@


class GroupItem:
"""
The GroupItem class contains the attributes for the group resources on
Tableau Server. The GroupItem class defines the information you can request
or query from Tableau Server. The class members correspond to the attributes
of a server request or response payload.
Parameters
----------
name: str
The name of the group.
domain_name: str
The name of the Active Directory domain ("local" if local authentication is used).
Properties
----------
users: Pager[UserItem]
The users in the group. Must be populated with a call to `populate_users()`.
id: str
The unique identifier for the group.
minimum_site_role: str
The minimum site role for users in the group. Use the `UserItem.Roles` enum.
Users in the group cannot have their site role set lower than this value.
license_mode: str
The mode defining when to apply licenses for group members. When the
mode is onLogin, a license is granted for each group member when they
login to a site. When the mode is onSync, a license is granted for group
members each time the domain is synced.
Examples
--------
>>> # Create a new group item
>>> newgroup = TSC.GroupItem('My Group')
"""

tag_name: str = "group"

class LicenseMode:
Expand Down
Loading

0 comments on commit ba28330

Please sign in to comment.