Tableau REST API Reference
API docs by Redocly

Tableau Cloud Manager (TCM) REST API Reference (current)

URL: https://{pod_adress_for_tcm-service}.com

The REST API methods for Tableau Cloud Manager (TCM) allow cloud administrators to manage tenants, sites, and users. TCM REST API methods include administrative, authentication, single sign-on, site, tenant, and user methods.

TCM OVERVIEW

Tableau Cloud Manager (TCM) REST API methods are available for Tableau Cloud October 2024. For an overview, see Tableau Cloud Manager REST API Overview.

Administrative Methods

TCM REST API Administrative methods allow cloud administrators to manage tenants, sites, and users in the following ways:

  • List the regions where tenants can be available.
  • Get the count of users categorized by role for each site in a tenant.
  • Get the count of users categorized by role for a specified site.
  • Get the count of users categorized by role for a tenant.
  • Get information about the current REST API session.

List regions

List the regions where a site can be created in a tenant, filtered by the provided criteria

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
query Parameters
pageNumber
integer <int32> >= 0
Default: 0

The number of the page to return values for. A value of 0 means do not page results.

pageSize
integer <int32> >= 0
Default: 100

The number of items returned per page.

latitude
number <double>
Example: latitude=37.7749

The latitude of the region, an value between -90 and +90.

longitude
number <double>
Example: longitude=-122.4194

The longitude of the region, a value between -180 and +180.

visibility
string
Enum: "INTERNAL" "PUBLIC"

If INTERNAL, the region is not visible to users. If PUBLIC the region is visible to users. Default is INTERNAL.

countryCode
string
Example: countryCode=US

The country code in the region definition.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List user data for tenant sites

For each site in the tenant, returns counts of users licensed for different roles.

Permissions: Only tenant administrators can call this method.

Version: Available in Tableau Cloud Manager v1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string <uuid>

The unique identifier of the tenant.

Responses

Response samples

Content type
application/json
{
  • "allSites": [
    ]
}

Get user data for site

For the specified site, returns counts of users licensed for different roles.

Permissions: Only tenant administrators can call this method.

Version: Available in Tableau Cloud Manager v1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string <uuid>

The unique identifier of the tenant.

siteId
required
string <uuid>

The unique identifier of the site.

Responses

Response samples

Content type
application/json
{
  • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  • "userCount": 0,
  • "siteAdminCount": 0,
  • "creators": 0,
  • "explorers": 0,
  • "viewers": 0,
  • "unlicensed": 0
}

Get user data for tenant

For the specified tenant, returns counts of users licensed for different roles.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string <uuid>

The unique identifier of the tenant.

Responses

Response samples

Content type
application/json
{
  • "creators": 0,
  • "explorers": 0,
  • "viewers": 0,
  • "unlicensed": 0
}

Get session information

Returns the user ID and tenant ID associated with the session.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V2, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token

Responses

Response samples

Content type
application/json
{
  • "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  • "userId": "123e4567-e89b-12d3-a456-426614174000",
  • "tenantId": "123e4567-e89b-12d3-a456-426614174000",
  • "sessionType": "USER"
}

Authentication Methods

Tableau Cloud Manager REST API Authentication methods allow cloud administrators to sign in to Tableau Cloud Manager REST API and manage personal access tokens (PATs) in the following ways:

  • Create a personal access token (PAT). Creating a PAT generates a PAT secret that you use in the request body of your sign-in request.
  • List all valid PATs.
  • Revoke a PAT.
  • Sign in to TCM REST API using a PAT and get a session access token, x-tableau-session-token, to use in the header of all subsequent REST calls.

For more information, see TCM REST API Authentication.

Create personal access token

Generate a personal access token (PAT).

A PAT is required to sign in to Tableau Cloud Manager (TCM).

Note: This PAT cannot be used to sign in to Tableau Cloud.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
Request Body schema: application/json
required
tokenName
required
string

Name of the PAT. PAT name must be unique.

absoluteExpiryInDays
integer <int32>

Number of days the PAT is valid for. Default value is 180 days; maximum value is 365 days. For security purposes, we recommend setting a value that is no more than 180 days.

Responses

Request samples

Content type
application/json
{
  • "tokenName": "MyTokenName",
  • "absoluteExpiryInDays": 180
}

Response samples

Content type
application/json
{
  • "tokenUUID": "123e4567-e89b-12d3-a456-426614174000",
  • "tokenName": "MyTokenName",
  • "userId": "123e4567-e89b-12d3-a456-426614174000",
  • "tenantId": "123e4567-e89b-12d3-a456-426614174000",
  • "issueInUtc": "2024-07-01T00:00:00Z",
  • "expirationInUtc": "2024-07-31T00:00:00Z",
  • "secret": "string"
}

List personal access tokens

Get all valid personal access tokens (PATs) you have generated for Tableau Cloud Manager (TCM).

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Revoke personal access token

Revoke a personal access token (PAT).

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
header Parameters
tokenUUID
required
string

The token ID of the PAT.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Sign in

Sign in to Tableau Cloud Manager (TCM).

You must use a personal access token (PAT) to sign in. To generate a PAT, go to your TCM account settings or call the Create Personal Access Token method.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Request Body schema: application/json
required
token
required
string

The token secret that is generated when you create a personal access token (PAT).

Responses

Request samples

Content type
application/json
{
  • "token": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type
application/json
{
  • "sessionToken": "123e4567-e89b-12d3-a456-426614174000",
  • "userId": "123e4567-e89b-12d3-a456-426614174000",
  • "tenantId": "123e4567-e89b-12d3-a456-426614174000",
  • "sessionExpiration": "2019-08-24T14:15:22Z"
}

Single Sign-On Methods

Tableau Cloud Manager REST API Single Sign-On methods allow cloud administrators to:

  • Get a list of authentication configurations for the specified tenants, sites, or users.
  • Create or update an OpenID Connect (OIDC) configuration for the specified resource ID.
  • Delete an OIDC configuration for the provided resource ID.
  • Get the OIDC configuration for the provided resource ID.

For more information, see TCM REST API Authentication.

List authentication methods

Gets list of authentification configurations for the specified resource IDs.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
Request Body schema: application/json
required
resourceIds
required
Array of strings

A comma separated list of IDs of a single tenant, multiple site IDs within a tenant and that tenant ID, or multiple sites within the same tenant with no tenant ID. You can get a tenant ID or site ID by calling the Get Tenant or List Sites method.

Important: Providing multiple tenant IDs or site IDs that belong to different tenants can produce unexpected results.

Responses

Request samples

Content type
application/json
{
  • "resourceIds": "123e4567-e89b-12d3-a456-426614174000,123e4567-e89b-12d3-a456-426614174002,123e4567-e89b-12d3-a456-426614174003"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create or update OIDC configuration

Create a new OpenID Connect (OIDC) configuration for Tableau Cloud Manager (TCM) authentication for the specified resource ID. If an OIDC configuration already exists, this method updates the configuration for the specified resource ID.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
resourceId
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

The ID of the tenant whose OIDC configuration is being created or updated. You can get a tenant ID by calling the Get Tenant method.

Request Body schema: application/json
required
enabled
required
boolean

If the authentication configuration is enabled or not.

knownProviderAlias
required
string

Authentication type. For example, Google or Salesforce.

salesforceDomain
string

For Salesforce authentication only. URL of the Salesforce domain. For example login.salesforce.com.

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "knownProviderAlias": "Salesforce",
  • "salesforceDomain": "login.salesforce.com"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "knownProviderAlias": "Salesforce",
  • "salesforceDomain": "login.salesforce.com"
}

Delete OIDC configuration

Deletes the OpenID Connect (OIDC) configuation for the provided resource ID. If the configuration doesn't exist, it fails silently.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
resourceId
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

The ID of the tenant whose OIDC configuration being deleted. You can get a tenant ID by calling the Get Tenant method.

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "knownProviderAlias": "Salesforce",
  • "salesforceDomain": "login.salesforce.com"
}

Get OIDC configuration

Gets the OpenID Connect (OIDC) configuration for the provided resource ID.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
resourceId
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

The ID of the tenant whose OIDC configuration is being retrieved. You can get a tenant ID by calling the Get Tenant method.

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "knownProviderAlias": "Salesforce",
  • "salesforceDomain": "login.salesforce.com"
}

Site Methods

Tableau Cloud Manager REST API Site methods allow cloud administrators to manage sites in the following ways:

  • Create a site in a tenant.
  • List sites in a tenant.
  • Get site details.
  • Suspend a site in a tenant.
  • Update license limit for a site in a tenant.
  • Create a project in a tenant.
  • Reactivate a suspended site in a tenant.

Create site

Creates a new site under the given tenant. The site name must be unique within the tenant.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string

The unique identifier of the tenant where the site is created.

Request Body schema: application/json
required
name
required
string

The name of the site.

The site name must be between 1 and 80 characters long. The site name must not contain any of the following characters: /, , *, ?, %, :, |, ", <, >, or any control characters. The site name must not start or end with a space. The site name must not contain the following reserved words: 'default', 'system', 'admin', 'administrator', 'all', 'guest', 'public', 'internal', private', 'protected', 'root', 'service', 'services', 'tableau', 'user', 'users', 'web', 'www'.

contentUrl
required
string

The subdomain name of the site's URL. This value is globally unique and can contain only characters that are upper or lower case alphabetic characters, numbers, hyphens (-), or underscores (_). If you provide unsupported special characters, Tableau creates the site content URL by omitting those characters from the string. For example, if you provide the site URL as "test.site", Tableau converts it to "testsite" and returns this new URL in the response.

regionUUID
required
string <uuid>

The Unique ID of Tableau region where the site should be created. Use the List Regions method to get the region IDs.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "contentUrl": "string",
  • "regionUUID": "8cc23c52-0d6e-468d-9156-952d9b566d86"
}

Response samples

Content type
application/json
{
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "siteUUID": "c9e56a0f-ad64-4cef-a0e8-cd7f1d44ab67",
  • "name": "string",
  • "contentUrl": "string",
  • "instance": {
    },
  • "creatorCapacity": 0,
  • "explorerCapacity": 0,
  • "viewerCapacity": 0,
  • "creatorCapacityIsDefaultCloudLimit": true,
  • "explorerCapacityIsDefaultCloudLimit": true,
  • "viewerCapacityIsDefaultCloudLimit": true,
  • "location": "string",
  • "migrationStatus": "NotStarted",
  • "storageQuota": 100000000,
  • "storageUsed": 100000000,
  • "status": "Unknown",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "lastUpdateDateTime": "2019-08-24T14:15:22Z",
  • "suspendedDateTime": "2019-08-24T14:15:22Z",
  • "fromPodSiteAttributes": {
    }
}

List sites

Gets details for all sites under a tenant.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string

The unique identifier for the tenant.

query Parameters
location
string

The unique identifier for the Tableau region of the site.

maxResults
integer <int32>

The maximum number of sites to include in the response. Default is no maximum.

pageToken
string

The next page of results to return, typically the pageToken field of the response body from your previous call to the List sites method.

Responses

Response samples

Content type
application/json
{
  • "sites": [
    ],
  • "pageToken": "string"
}

Get site

Returns site details for the specified site.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string

The unique identifier for the tenant.

siteId
required
string

The LUID for the site.

Responses

Response samples

Content type
application/json
{
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "siteUUID": "c9e56a0f-ad64-4cef-a0e8-cd7f1d44ab67",
  • "name": "string",
  • "contentUrl": "string",
  • "instance": {
    },
  • "creatorCapacity": 0,
  • "explorerCapacity": 0,
  • "viewerCapacity": 0,
  • "creatorCapacityIsDefaultCloudLimit": true,
  • "explorerCapacityIsDefaultCloudLimit": true,
  • "viewerCapacityIsDefaultCloudLimit": true,
  • "location": "string",
  • "migrationStatus": "NotStarted",
  • "storageQuota": 100000000,
  • "storageUsed": 100000000,
  • "status": "Unknown",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "lastUpdateDateTime": "2019-08-24T14:15:22Z",
  • "suspendedDateTime": "2019-08-24T14:15:22Z"
}

Suspend site

Suspends a site. Suspended sites are not accessible to users. Suspended sites can be reactivated.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string

The unique identifier for the tenant.

siteId
required
string

The LUID for the site.

Responses

Response samples

Content type
application/json
"string"

Update license limit for site

Updates license/role limit for a site.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string

The unique identifier for the tenant.

siteId
required
string

The LUID for the site.

Request Body schema: application/json
required
object (UserQuota)

The limit of number of users with licenses for the viewer role for the site.

object (UserQuota)

The limit of number of users with licenses for the viewer role for the site.

object (UserQuota)

The limit of number of users with licenses for the viewer role for the site.

Responses

Request samples

Content type
application/json
{
  • "creatorCapacity": {
    },
  • "explorerCapacity": {
    },
  • "viewerCapacity": {
    }
}

Response samples

Content type
application/json
{
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "siteUUID": "c9e56a0f-ad64-4cef-a0e8-cd7f1d44ab67",
  • "name": "string",
  • "contentUrl": "string",
  • "instance": {
    },
  • "creatorCapacity": 0,
  • "explorerCapacity": 0,
  • "viewerCapacity": 0,
  • "creatorCapacityIsDefaultCloudLimit": true,
  • "explorerCapacityIsDefaultCloudLimit": true,
  • "viewerCapacityIsDefaultCloudLimit": true,
  • "location": "string",
  • "migrationStatus": "NotStarted",
  • "storageQuota": 100000000,
  • "storageUsed": 100000000,
  • "status": "Unknown",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "lastUpdateDateTime": "2019-08-24T14:15:22Z",
  • "suspendedDateTime": "2019-08-24T14:15:22Z"
}

Create project

Creates a new project on a site in a tenant. A project is a container for workbooks, data sources, and other Tableau content that all inherit the permissions set for the Project.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string

The unique identifier for the tenant.

siteId
required
string

The LUID for the site.

Request Body schema: application/json
required
ownerId
required
string

The LUID of the user that owns the project.

Responses

Request samples

Content type
application/json
{
  • "ownerId": "string"
}

Response samples

Content type
application/json
{
  • "project": {
    }
}

Reactivate suspended site

Reactivates a suspended site. Reactivated sites are accessible to users

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string

The unique identifier for the tenant.

siteId
required
string

The LUID for the site.

Responses

Response samples

Content type
application/json
{
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "siteUUID": "c9e56a0f-ad64-4cef-a0e8-cd7f1d44ab67",
  • "name": "string",
  • "contentUrl": "string",
  • "instance": {
    },
  • "creatorCapacity": 0,
  • "explorerCapacity": 0,
  • "viewerCapacity": 0,
  • "creatorCapacityIsDefaultCloudLimit": true,
  • "explorerCapacityIsDefaultCloudLimit": true,
  • "viewerCapacityIsDefaultCloudLimit": true,
  • "location": "string",
  • "migrationStatus": "NotStarted",
  • "storageQuota": 100000000,
  • "storageUsed": 100000000,
  • "status": "Unknown",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "lastUpdateDateTime": "2019-08-24T14:15:22Z",
  • "suspendedDateTime": "2019-08-24T14:15:22Z"
}

Tenant Methods

Tableau Cloud Manager REST API Tenant methods allow cloud administrators to manage tenants in the following ways:

  • Get the details of a specified tenant.
  • Find out if a tenant name is unique in the TCM environment.

Get tenant uniqueness

Checks if the tenant name and resulting encode URI are unique.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantName
required
string
Example: MyTenantName

The name of the tenant. Maximum of 80 characters.

Responses

Response samples

Content type
application/json
{ }

Get tenant

Returns the tenant record for the specified tenant ID.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager V1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

The unique identifier of the tenant.

Responses

Response samples

Content type
application/json
{
  • "tenantId": "123e4567-e89b-12d3-a456-426614174000",
  • "tenantName": "Abc",
  • "encodeUri": "string",
  • "status": "Unknown",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "lastUpdateDateTime": "2019-08-24T14:15:22Z",
  • "lastDestinationMergedDateTime": "2019-08-24T14:15:22Z"
}

User Methods

Tableau Cloud Manager REST API User methods allow cloud administrators to manage users in the following ways:

  • Get the details of a specified user.
  • Add a user to a tenant.
  • List all users in a tenant, or get the details of a specified batch.
  • Import a batch of users specified in a .gzip file.
  • Delete a user or a specified batch of users from a tenant.
  • Update the role and language preference for a user in a tenant.
  • Get the sites and tenants that a user is a member of.

Add tenant user

Creates a new user in the tenant.

Permissions: Only tenant administrators can call this method.

Version: Available in Tableau Cloud Manager v1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string <uuid>

The unique identifier of the tenant.

Request Body schema: application/json
required
userName
required
string

The unique username of the user.

email
string

The email address of the user.

language
string
Enum: "DE_DE" "EN_GB" "EN_US" "ES_ES" "FR_CA" "FR_FR" "IT_IT" "JA_JP" "KO_KR" "PT_BR" "SV_SE" "TH_TH" "ZH_CN" "ZH_TW"

The language of the user.

locale
string
Enum: "ar_AE" "ar_BH" "ar_DZ" "ar_EG" "ar_IQ" "ar_JO" "ar_KW" "ar_LB" "ar_LY" "ar_MA" "ar_OM" "ar_QA" "ar_SA" "ar_SD" "ar_SY" "ar_TN" "ar_YE" "be_BY" "bg_BG" "ca_ES" "cs_CZ" "da_DK" "de_AT" "de_CH" "de_DE" "de_LU" "el_CY" "el_GR" "en_AU" "en_CA" "en_GB" "en_IE" "en_IN" "en_MT" "en_NZ" "en_PH" "en_SG" "en_US" "en_ZA" "es_AR" "es_BO" "es_CL" "es_CO" "es_CR" "es_DO" "es_EC" "es_ES" "es_GT" "es_HN" "es_MX" "es_NI" "es_PA" "es_PE" "es_PR" "es_PY" "es_SV" "es_US" "es_UY" "es_VE" "et_EE" "fi_FI" "fr_BE" "fr_CA" "fr_CH" "fr_FR" "fr_LU" "hi_IN" "hr_HR" "hu_HU" "in_ID" "is_IS" "it_CH" "it_IT" "iw_IL" "ja_JP" "ko_KR" "lt_LT" "lv_LV" "mk_MK" "ms_MY" "mt_MT" "nl_BE" "nl_NL" "no_NO" "pl_PL" "pt_BR" "pt_PT" "ro_RO" "ru_RU" "sk_SK" "sl_SI" "sq_AL" "sr_BA" "sr_ME" "sr_RS" "sv_SE" "th_TH" "tr_TR" "uk_UA" "vi_VN" "zh_CN" "zh_HK" "zh_SG" "zh_TW"

The locale of the user.

Array of objects (UserLinkRoleDTO)

The tenant roles for the user.

Array of objects (UserSiteRoleDTO)

The site roles of the user.

Responses

Request samples

Content type
application/json
{
  • "userName": "string",
  • "email": "string",
  • "language": "DE_DE",
  • "locale": "ar_AE",
  • "linkRoles": [
    ],
  • "siteRoles": [
    ]
}

Response samples

Content type
application/json
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "transactionId": "string",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
}

List tenant users

Gets a list of tenant users and their details.

Permissions: Only tenant administrators can call this method.

Version: Available in Tableau Cloud Manager v1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Responses can be filtered by email, userId, tcmRoleName, maxSiteRole, userName and paginated using pageToken, and maxResults. Multiple filters can be applied with ampersand-separated expressions, for example:

 {{tcmBaseUrl}}/api/v1/tenants/:tenantId/users?maxSiteRole=SiteAdministratorCreator&excludeRoles=true

If excludeRoles=true is set, the curtailed responses will be faster.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string <uuid>

The unique identifier of the tenant used to filter the response.

query Parameters
email
string
Example: email=xyz@tableau.com

The email address of a user used to filter the response.

userId
string <uuid>
Example: userId=83e34e72-5c71-4858-93b5-945a144e6e70

The unique identifier of a user used to filter responses.

tcmRoleName
string
Enum: "TCM_ADMIN" "NULL"

The tenant role used to filter the response.

maxSiteRole
string
Enum: "SiteAdministratorExplorer" "SupportUser" "ExplorerCanPublish" "Explorer" "Unlicensed" "Viewer" "Creator" "SiteAdministratorCreator"

The site role with the highest permissions used to filter the response.

userName
string

The name of a user used to filter the response.

pageToken
string [ 0 .. 1000 ] characters

The token used to get the next page of results.

maxResults
integer <int32>
Example: maxResults=100

The maximum number of results per page. Default maximum is 100.

excludeRoles
boolean

If true, site and tenant role information is not returned, only return user details. Default is false.

Responses

Response samples

Content type
application/json
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "transactionId": "string",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
}

Batch import users with .gzip

Import users in bulk using a .gzip (compressed CSV) file.

Permissions: Only cloud administrators can call this method.

Version: Available in Tableau Cloud Manager v1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

If no siteId is provided, users are imported as tenant users.

.An example of a multipart form data request is as follows:


curl -X POST "http://myserver/api/v1/tenants/{tenantId}/bulk/users/import" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "file=@/path/to/file.csv.gz" -F "siteId="d9103a00-d7e5-433f-a0c3-debb7d4f7741" -F "idp="DEFAULT""
Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string <uuid>

The unique identifier of the tenant.

query Parameters
siteId
string <uuid>

The unique identifier of the site.

idp
string
Enum: "OpenID" "TableauIDWithMFA"

The authentication type configured for the tenant.

Request Body schema: multipart/form-data
required
file
required
string <binary>

A .gzip (compressed CSV) file containing data of users to be imported. A correctly formatted file has no header row. The expected columns are:

  • URI (for the tenant or site)

  • Username

  • Password

  • Display Name

  • License Level (Explorer, Creator, Viewer, or Unlicensed)

  • Administrator Level (Cloud, Site, or None)

  • Can Publish (TRUE or FALSE)

  • Authentication (OpenID, SAML, TableauIDWithMFA, or DEFAULT)

Responses

Response samples

Content type
application/json
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

Batch delete tenant users

Deletes a batch of users specified in a comma separated list of user IDs.

Permissions: Only tenant administrators can call this method.

Version: Available in Tableau Cloud Manager v1, June 2024, and later.

License: No additional Tableau license is required. For more information, see Acquire a Tableau Cloud Manager Account.

This method returns an identifier for an asynchronous job. To see progress and results, use Get batch user job status.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string <uuid>

The unique identifier of the tenant.

Request Body schema: application/json
required
userIds
required
Array of strings <uuid> unique [ items <uuid > ]

A comma separated list of user LUIDs to delete.

Responses

Request samples

Content type
application/json
{
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

Batch get tenant users

Lists the details of a batch of users specified in a comma separated list of user IDs.

Permissions: Only tenant administrators can call this method.

Version: Available in Tableau Cloud Manager v1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string <uuid>

The unique identifier of the tenant.

Request Body schema: application/json
required
userIds
required
Array of strings <uuid> unique [ items <uuid > ]

Comma separated list of user LUIDs to get details about.

Responses

Request samples

Content type
application/json
{
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Delete user

Deletes the specified user from the specified tenant.

Permissions: Only tenant administrators can call this method.

Version: Available in Tableau Cloud Manager v1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string <uuid>

The unique identifier of the tenant.

userId
required
string <uuid>

The unique identifier of the user.

Responses

Response samples

Content type
application/json
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

Get tenant user

Gets the details of a tenant user.

Permissions: Only tenant administrators can call this method.

Version: Available in Tableau Cloud Manager v1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string <uuid>

The unique identifier of the tenant.

userId
required
string <uuid>

The unique identifier of the user.

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}

Update role and language for tenant user

Updates the tenant role, site role, language, and/or locale for a tenant user.

Permissions: Only tenant administrators can call this method.

Version: Available in Tableau Cloud Manager v1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
tenantId
required
string <uuid>

The unique identifier of the tenant.

userId
required
string <uuid>

The unique identifier of the user.

Request Body schema: application/json
required
language
string
Enum: "DE_DE" "EN_GB" "EN_US" "ES_ES" "FR_CA" "FR_FR" "IT_IT" "JA_JP" "KO_KR" "PT_BR" "SV_SE" "TH_TH" "ZH_CN" "ZH_TW"

The new language to apply to the user.

locale
string
Enum: "ar_AE" "ar_BH" "ar_DZ" "ar_EG" "ar_IQ" "ar_JO" "ar_KW" "ar_LB" "ar_LY" "ar_MA" "ar_OM" "ar_QA" "ar_SA" "ar_SD" "ar_SY" "ar_TN" "ar_YE" "be_BY" "bg_BG" "ca_ES" "cs_CZ" "da_DK" "de_AT" "de_CH" "de_DE" "de_LU" "el_CY" "el_GR" "en_AU" "en_CA" "en_GB" "en_IE" "en_IN" "en_MT" "en_NZ" "en_PH" "en_SG" "en_US" "en_ZA" "es_AR" "es_BO" "es_CL" "es_CO" "es_CR" "es_DO" "es_EC" "es_ES" "es_GT" "es_HN" "es_MX" "es_NI" "es_PA" "es_PE" "es_PR" "es_PY" "es_SV" "es_US" "es_UY" "es_VE" "et_EE" "fi_FI" "fr_BE" "fr_CA" "fr_CH" "fr_FR" "fr_LU" "hi_IN" "hr_HR" "hu_HU" "in_ID" "is_IS" "it_CH" "it_IT" "iw_IL" "ja_JP" "ko_KR" "lt_LT" "lv_LV" "mk_MK" "ms_MY" "mt_MT" "nl_BE" "nl_NL" "no_NO" "pl_PL" "pt_BR" "pt_PT" "ro_RO" "ru_RU" "sk_SK" "sl_SI" "sq_AL" "sr_BA" "sr_ME" "sr_RS" "sv_SE" "th_TH" "tr_TR" "uk_UA" "vi_VN" "zh_CN" "zh_HK" "zh_SG" "zh_TW"

The new locale to apply to the user.

email
string

Email address of the user to be updated.

Array of objects (PatchUserLinkRoleDTO)

The tenant roles of the user.

Array of objects (PatchUserSiteRoleDTO)

Site role of the user

Responses

Request samples

Content type
application/json
{
  • "language": "DE_DE",
  • "locale": "ar_AE",
  • "email": "string",
  • "linkRoles": [
    ],
  • "siteRoles": [
    ]
}

Response samples

Content type
application/json
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

List status for user job

Get the status of a batch user job.

Permissions: Only tenant administrators can call this method.

Version: Available in Tableau Cloud Manager v1, June 2024, and later.

License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.

Authorizations:
x-tableau-session-token
path Parameters
jobId
required
string <uuid>

The unique identifier of the job whose details are to be retrieved.

query Parameters
showDetailed
boolean
Example: showDetailed=true

If true, show the detailed status of each user operation in paginated format. Default is false.

pageToken
string [ 0 .. 1000 ] characters

The pageToken used for getting next set of records. Only valid if showDetailed = true.

Responses

Response samples

Content type
application/json
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "operation": "BULK_USER_IMPORT",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "ownerRole": "UNAUTHENTICATED",
  • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  • "triggerSource": "string",
  • "bulkOpAttributes": {
    },
  • "status": "NEW",
  • "expectedOpsCount": 0,
  • "successfulOpsCount": 0,
  • "failedOpsCount": 0,
  • "skippedLinesCount": 0,
  • "submitTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "statusChangeHistory": [
    ],
  • "items": [
    ],
  • "nextPageToken": "string"
}

Get resources of user

Authorizations:
x-tableau-session-token
path Parameters
userName
required
string

The username of the user to get resource details for.

query Parameters
resourceId
string <uuid>

The unique identifier of a site or tenant optionally used to filter results.

resourceType
string
Enum: "SITE" "TENANT"

The type of resource optionally used to filter results.

authType
string
Enum: "OpenID" "SAML" "TableauIDWithMFA" "DEFAULT"

The type of user authentication optionally used to filter results.

authUserId
string

The unique identifier of the user optionally used to filter results.

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "userName": "string"
}