Tableau Cloud Manager REST API Overview

Tableau Cloud Manager (TCM) REST API provides cloud administrators a programmatic way to oversee your organization’s Tableau Cloud sites. With TCM REST API, cloud administrators can create and edit sites, manage users, monitor license consumption across multiple sites, and monitor activity, all from a single location. Any changes made within TCM are applied at the top level element, also called a tenant, and then shared across all associated sites, ensuring streamlined administration and governance.

• TCM is separate service from Tableau Cloud, with its own authentication and REST interface.
• TCM enables you to centrally administer and configure multiple Tableau Cloud sites and users in a “tenant” element.
• TCM enables you to create new sites in a tenant.

For more information about TCM, see About Tableau Cloud Manager.

Tenants

• A tenant is a grouping of Tableau Cloud sites that are hosted in a region.
• A cloud administrator is a user with a role, added in TCM, that enables them to manage tenant configuration and content through the TCM UI and TCM REST API.

Sites on a tenant

• A site in a tenant is a typical Tableau Cloud site.
• The behavior of features like workbooks, data sources, users, roles, licenses, permissions, and more, operate in the same way as Tableau Cloud sites that are not in a tenant.
• A site in a tenant can be accessed through the Tableau REST API.
• Existing sites can be migrated to a tenant.

Users in a tenant

• A user, in the context of a site in a TCM tenant, is a typical Tableau Cloud user.
• Once a user is added to a TCM tenant, that user identity can be added to any site within the tenant. An existing Tableau Cloud user can be migrated to a tenant by itself, in a batch, or in the context of migrating a site to a tenant. A tenant user can also be created directly.

TCM REST API methods

The TCM REST API provides methods for managing a tenant and its members in the following categories. Currently, cloud administrator permissions are required for all REST API requests.

• Administrative methods enable you to get information about: the current REST API session; a tenant’s status, region, and globally configured site capabilities; and metrics for the different types of users of a site or tenant.

• Authentication methods enable you to create, view, and revoke personal access tokens (PATs) that authenticate you in the service. Also enables you to configure, view, and delete universal access token (UAT) configurations and its associated JWTs that can authenticate you to TCM REST API and Tableau REST API. You can use the sign in methods to retrieve a session access token that enables REST API requests for the duration of the session.

• Platform Data methods enable you to manage event logs for the tenant and site.

• Single Sign-on methods enable you to create, view and delete authentication configurations for the tenant and site.

• Site methods enable you to create sites and projects, and view, suspend, reactivate and delete sites in a tenant.

• Tenant methods enable you to get information about a tenant and to find out if a tenant name is unique.

• User methods enable you to create, import, delete users; view details of users and the resources related to users; update some of a user’s attributes.