File tree Expand file tree Collapse file tree 2 files changed +365
-11
lines changed
Expand file tree Collapse file tree 2 files changed +365
-11
lines changed Original file line number Diff line number Diff line change 1212
1313
1414class GroupItem :
15+ """
16+ The GroupItem class contains the attributes for the group resources on
17+ Tableau Server. The GroupItem class defines the information you can request
18+ or query from Tableau Server. The class members correspond to the attributes
19+ of a server request or response payload.
20+
21+ Parameters
22+ ----------
23+ name: str
24+ The name of the group.
25+
26+ domain_name: str
27+ The name of the Active Directory domain ("local" if local authentication is used).
28+
29+ Properties
30+ ----------
31+ users: Pager[UserItem]
32+ The users in the group. Must be populated with a call to `populate_users()`.
33+
34+ id: str
35+ The unique identifier for the group.
36+
37+ minimum_site_role: str
38+ The minimum site role for users in the group. Use the `UserItem.Roles` enum.
39+ Users in the group cannot have their site role set lower than this value.
40+
41+ license_mode: str
42+ The mode defining when to apply licenses for group members. When the
43+ mode is onLogin, a license is granted for each group member when they
44+ login to a site. When the mode is onSync, a license is granted for group
45+ members each time the domain is synced.
46+
47+ Examples
48+ --------
49+ >>> # Create a new group item
50+ >>> newgroup = TSC.GroupItem('My Group')
51+
52+
53+ """
54+
1555 tag_name : str = "group"
1656
1757 class LicenseMode :
You can’t perform that action at this time.
0 commit comments