Tableau Capabilities

Last updated: October 8, 2024

After this article...

You'll understand the capabilities our Tableau integration provides, and how Lumos interacts with the Tableau API.

View users

The mapping between Tableau user statuses and Lumos user account statuses is below.

Tableau User Status

Lumos Account Status

site role is not Unlicensed

Active

site role is Unlicensed

Suspended

deleted (Tableau no longer returns a user)

Deprovisioned

Tableau API endpoint: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#get_users_on_site

View a user's entitlements

Lumos can retrieve the following user entitlements from Tableau.

  • Role - The user's Tableau site role.

  • Group - The Tableau Groups to which the user belongs.

  • License - The license mapped to the user's Tableau site role. If we cannot discern the license type, it will show as Unknown. A mapping of Tableau values to Lumos values is below.

Lumos Value

Tableau Values

Viewer

Viewer, Viewer With Publish

Creator

Creator, Site Administrator Creator

Explorer

Explorer, Explorer Can Publish, Site Administrator Explorer

Unlicensed

Unlicensed, Unlicensed With Publish

Unknown

Interactor, Publisher, Server Administrator, Guest, Read Only, Support User

Tableau API endpoints:

Role: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#get_users_on_site (we use the siteRole)

Group: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#get_groups_for_a_user

License: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#get_users_on_site (we infer this from the siteRole, as described above)

View a user's last login

In Lumos, the Last Login value represents the last time the user logged into Tableau.

Tableau API endpoint: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site (we use lastLogin from the user)

Suspend a user

AppStore

Offboarding

Access Reviews

License Management

N/A

✅

✅

✅

In Lumos, suspending a Tableau user marks their Account Status as "Suspended".

In Tableau, this action sets the user's site role to Unlicensed.

This action reclaims a license in Tableau.

Tableau API endpoint: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user (we set the user's siteRole to Unlicensed)

Deprovision a user

AppStore

Offboarding

Access Reviews

License Management

N/A

✅

✅

✅

In Lumos, deprovisioning a Tableau user marks their Account Status as "Deprovisioned".

In Tableau, the user is removed from the site. The Tableau user will be deleted if they don't own any assets other than subscriptions. If a user still owns content (assets) on Tableau Server, the user can't be deleted unless ownership of the assets is reassigned. You can't remove a user from the server if they own content on the server. If a user is removed from all sites they're a member of, the user is deleted.

This action reclaims a license in Tableau.

Tableau API endpoint: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site

Tableau API documentation