Python Tableau UserItem用法及代码示例

Tableau Server Client (TSC)中UserItem的用法。

用法

UserItem(name, site_role, auth_setting=None)

UserItem 类包含 Tableau Server 上视图资源的成员或属性。 UserItem 类定义您可以从 Tableau Server 请求或查询的信息。类成员对应于服务器请求或响应负载的属性。

属性

名字	说明
`auth_setting`	(可选)此属性仅适用于 Tableau Online。用户的新身份验证类型。您可以为此属性分配以下值：`SAML`(用户使用 SAML 登录)或`ServerDefault`(用户使用为服务器设置的身份验证方法登录)。这些值出现在验证选项卡上设置Tableau Online 中的页面 -`SAML`属性值对应单sign-on, 和`ServerDefault`值对应TableauID.
`domain_name`	站点的名称。
`external_auth_user_id`	表示存储在 Tableau 的单个 sign-on (SSO) 系统中的 ID。为 Tableau Online 返回 `externalAuthUserId` 值。对于其他服务器配置，此字段包含 null。
`id`	站点上用户的 ID。
`last_login`	用户上次登录的日期和时间。
`workbooks`	用户拥有的工作簿。您必须运行 populate_workbooks 方法才能将工作簿添加到 `UserItem` 。
`email`	用户的电子邮件地址。
`fullname`	用户的全名。
`name`	用户的名称。创建`UserItem` 实例时需要此属性。
`site_role`	用户在站点上的角色。如果您要创建`UserItem` 实例，则此属性是必需的。有关详细信息，请参阅下面的`User Roles`。
`groups`	用户所属的组。您必须运行 populate_groups 方法将组添加到 `UserItem` 。

用户角色

site_role 属性的可能用户角色如下：

Creator
Explorer
ExplorerCanPublish
ServerAdministrator
SiteAdministratorExplorer
SiteAdministratorCreator
Unlicensed
ReadOnly
Viewer

注意：如果有任何与用户相关的操作site_role导致 400 错误响应(例如：Invalid site role: 'Explorer' is malformed or is not a supported user role in this version of Tableau)，确保你是为您的服务器使用最新的 REST API 版本.

示例

# import tableauserverclient as TSC
# server = TSC.Server('server')

# create a new UserItem object.
  newU = TSC.UserItem('Monty', 'Publisher')

  print(newU.name, newU.site_role)

源文件：models/user_item.py

相关用法

注：本文由纯净天空筛选整理自tableau.github.io大神的英文原创作品 UserItem class。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。