Updated Site Roles in REST API 3.0 and Later
Starting with the 2018.1 release of Tableau Server and Tableau Cloud, available site roles have changed significantly to support the user-based Creator, Explorer and Viewer licenses. These changes affect the values sent to or returned from the following methods in REST API 3.0 and later:
- Add User to Group
- Add User to Site
- Create Group
- Get Users in Group
- Get Users on Site
- Update Group
- Update User
Changes for the userQuota licensing attribute
In REST API versions 2.8 and earlier, the userQuota attribute was used with the following methods to get the number of licensed users:
In REST API 3.0 and later, userQuota is the sum of licensed site users with Creator, Explorer, or Viewer roles. An administrator can get the userQuota value using the Update Site, Query Site, and Query Sites methods. Administrators of on premise servers can also set the userQuota value using the Create Site or Update Site methods.
- tierCreatorCapacity: Used to get or set the number of users with a Creator license.
- tierExplorerCapacity: Used to get or set the number of users with an Explorer license.
- tierViewerCapacity: Used to get or set the number of users with a Viewer license.
For REST API versions 3.7 and higher, specific quotas can be set for each role instead of setting a userQuota value. As with previous REST API versions, online admins can get the values of userQuota or tiered capacities, and on premise server admins can set the values.
To set specific quotas for each role on an on premise server, a Create Site or Update Site request should omit userQuota (set it to null), and provide a numerical value for for each of the tiered capacity attributes:
- tierCreatorCapacity: Used to get or set the number of users with a Creator license.
- tierExplorerCapacity: Used to get or set the number of users with an Explorer license.
- tierViewerCapacity: Used to get or set the number of users with a Viewer license.
Changes to legacy site roles
As part of the introduction of new user-based license types, several legacy site roles have been renamed, as follows:
| Legacy Site role name (v10.5) | REST API site role string (v10.5) | Site role name | REST API site role string |
|---|---|---|---|
| Interactor | Interactor
|
Explorer | Explorer
|
| Publisher | Publisher
|
Explorer (Can Publish) | ExplorerCanPublish
|
| Site Administrator | SiteAdministrator
|
Site Administrator Explorer | SiteAdministratorExplorer
|
The following site roles were introduced in version 2018.1:
| Site role name | REST API site role string |
|---|---|
| Viewer | Viewer
|
| Creator | Creator
|
| Site Administrator Creator | SiteAdministratorCreator
|
The following site legacy site role names are unchanged:
| Site role name | REST API site role string |
|---|---|
| Server Administrator | ServerAdministrator
|
| Unlicensed | Unlicensed
|
To learn more about licensing, see Licensing Overview. To learn more about site roles, see Set Users' Site Roles.