Tableau Cloud Manager REST API Overview

Things to know about Tableau Cloud Manager (TCM)

• 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 their users in a “tenant” element.

• TCM enables you to create new sites in a tenant.

  For more information, 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 REST API.

Sites in 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 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 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 session; a tenant’s status, region, and globally configured site capabilities; metrics for the different types of users of a site or tenant.

• Authentication Methods enable you to create, view, and revoke personal access tokens (PAT) that authenticate you in the service. You can use the sign in method to retrieve a session access token that enables REST requests for the duration of the session.

• Single Sign On Methods enable you to create, view and delete OIDC configurations for a site or globally for all of a tenant’s sites.

• 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.