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.
Tableau Cloud Manager (TCM) REST API methods are available for Tableau Cloud October 2024. For an overview, see Tableau Cloud Manager REST API Overview.
TCM REST API Administrative methods allow cloud administrators to manage tenants, sites, and users in the following ways:
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.
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 |
countryCode | string Example: countryCode=US The country code in the region definition. |
{- "regions": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "location": {
- "latitude": -90,
- "longitude": -180
}, - "visibility": "INTERNAL",
- "attributes": {
- "property1": "string",
- "property2": "string"
}
}
], - "data": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "location": {
- "latitude": -90,
- "longitude": -180
}, - "visibility": "INTERNAL",
- "attributes": {
- "property1": "string",
- "property2": "string"
}
}
]
}
Accepts the terms and conditions for the specified tenant.
Permissions: Only tenant administrators can call this method.
Version: Available in Tableau Cloud Manager v1, December 2024, and later.
License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.
tenantId required | string The unique identifier for the tenant. |
"string"
Gets the download URLs for the specified tenant activity log paths in a comma separated list of paths to activity logs for a tenant.
Use List tenant activity log paths to find the log file paths you provide. Without an additional license, activity generally takes 2 hours to become available in logs. For more information see, Activity Log.
The response for each log URL includes: expiresAt
which shows the length of time after the response that a returned URL will remain valid; and eTag
that is an MD5 hash of the log content that can be used for tamper proofing and other verification needs.
Version: Available in Tableau Cloud Manager V1, January 2025, and later.
Permissions: Only cloud administrators can call this method.
License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.
tenantId required | string Example: 123e4567-e89b-12d3-a456-426614174000 The unique identifier of the tenant. |
files required | Array of strings The returned list of activity log file paths for the tenant. |
{- "files": [
- "string"
]
}
{- "files": [
- {
- "path": "string",
- "url": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "etag": "string"
}
]
}
Gets a list of the paths to the specified tenant's activity logs for the specified time period and event type.
Use the paths returned by this method in a request to Batch generate tenant activity log download urls to download the activity logs.
Version: Available in Tableau Cloud Manager V1, January 2025, and later.
Permissions: Only cloud administrators can call this method.
License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.
tenantId required | string Example: 123e4567-e89b-12d3-a456-426614174000 The unique identifier of the tenant. |
startTime | string <date-time> Example: startTime=2024-01-01T00:00:00 The start time of the activity log listings returned. If not provided, defaults to 24 hours prior to the time of the request. |
endTime | string <date-time> Example: endTime=2024-01-01T00:00:00 The end time of the activity log listings returned. If not provided, defaults to the time of the request. 7 days is the maximum time span you can specify between start and end times. The request will fail if your end time exceeds that. |
eventType | string Enum: "batch_revoke_personal_access_token" "batch_revoke_session" "create_or_update_oidc_config" "create_or_update_saml_config" "create_personal_access_token" "create_private_connection" "create_site" "create_tenant" "create_user" "delete_oidc_config" "delete_private_connection" "delete_saml_config" "delete_site" "delete_tenant" "delete_user" "get_sites" "get_users" "list_personal_access_tokens" "merge_tenant" "migrate_site" "personal_access_token_login" "reactivate_site" "revoke_personal_access_token" "revoke_session" "site_limits_change" "suspend_site" "tcm_activity_log_access" "update_personal_access_token" "update_private_connection" "update_session" "update_tenant" "update_user" "update_user_site_role" "update_user_tenant_role" "user_login_create_session" Example: eventType=VIEW The type of event to filter returned logs by. If not provided, all types are returned. For information about event types and their attributes see Tableau Cloud Manager Event Types. |
pageSize | integer <int32> Example: pageSize=100 The number of log file paths to return in a response. Default is 100 |
pageToken | string Example: pageToken=fDIwMjQtMDktMDlUMDU6MDA= The token to provide in order to request the next page of file paths. |
{- "files": [
- {
- "path": "string",
- "size": 0
}
], - "pageToken": "string"
}
Lists the Tableau pod locations or regions where a site for the specified tenant can be created.
License: No additional Tableau license is required. For more information, see About Tableau Cloud Manager.
tenantId required | string The unique identifier for the tenant. |
{- "podsData": {
- "pods": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string"
}
]
}, - "regionsData": {
- "regions": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "tags": [
- "RELEASE_PREVIEW"
]
}
]
}
}
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.
tenantId required | string <uuid> The unique identifier of the tenant. |
{- "allSites": [
- {
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "userCount": 0,
- "siteAdminCount": 0,
- "creators": 0,
- "explorers": 0,
- "viewers": 0,
- "unlicensed": 0
}
]
}
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.
tenantId required | string <uuid> The unique identifier of the tenant. |
siteId required | string <uuid> The unique identifier of the site. |
{- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "userCount": 0,
- "siteAdminCount": 0,
- "creators": 0,
- "explorers": 0,
- "viewers": 0,
- "unlicensed": 0
}
For the specified tenant, returns counts of users licensed for different roles.
tenantId required | string <uuid> The unique identifier of the tenant. |
{- "creators": 0,
- "explorers": 0,
- "viewers": 0,
- "unlicensed": 0
}
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.
{- "sessionId": "123e4567-e89b-12d3-a456-426614174000",
- "userId": "123e4567-e89b-12d3-a456-426614174000",
- "tenantId": "123e4567-e89b-12d3-a456-426614174000",
- "sessionType": "USER"
}
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:
x-tableau-session-token
, to use in the header of all subsequent REST calls.For more information, see TCM REST API Authentication.
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.
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. |
{- "tokenName": "MyTokenName",
- "absoluteExpiryInDays": 180
}
{- "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"
}
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.
[- {
- "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"
}
]
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.
tokenUUID required | string The token ID of the PAT. |
{- "message": "string",
- "reason": "string",
- "errorCode": "string"
}
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.
token required | string The token secret that is generated when you create a personal access token (PAT). |
{- "token": "123e4567-e89b-12d3-a456-426614174000"
}
{- "sessionToken": "123e4567-e89b-12d3-a456-426614174000",
- "userId": "123e4567-e89b-12d3-a456-426614174000",
- "tenantId": "123e4567-e89b-12d3-a456-426614174000",
- "sessionExpiration": "2019-08-24T14:15:22Z"
}
Tableau Cloud Manager REST API Single Sign-On methods allow cloud administrators to:
For more information, see TCM REST API Authentication.
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.
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 tenat sites method. Important: Providing multiple tenant IDs or site IDs that belong to different tenants can produce unexpected results. |
requireMultipleIDPs | boolean If true, returns the authentication configurations on the site when the capability for multiple authentication methods is enabled. |
{- "resourceIds": "`[\"123e4567-e89b-12d3-a456-426614174000\",\"123e4567-e89b-12d3-a456-426614174002\",\"123e4567-e89b-12d3-a456-426614174003\"]`",
- "requireMultipleIDPs": true
}
[- {
- "resourceId": "123e4567-e89b-12d3-a456-426614174000",
- "authenticationType": "OIDC",
- "knownProviderAlias": "Salesforce",
- "enabled": true
}
]
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.
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. |
enabled required | boolean If the authentication configuration is enabled or not. |
knownProviderAlias required | string Authentication type. For example, |
salesforceDomain | string For Salesforce authentication only. URL of the Salesforce domain. For example |
{- "enabled": true,
- "knownProviderAlias": "Salesforce",
- "salesforceDomain": "login.salesforce.com"
}
{- "enabled": true,
- "knownProviderAlias": "Salesforce",
- "salesforceDomain": "login.salesforce.com"
}
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.
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. |
{- "enabled": true,
- "knownProviderAlias": "Salesforce",
- "salesforceDomain": "login.salesforce.com"
}
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.
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. |
{- "enabled": true,
- "knownProviderAlias": "Salesforce",
- "salesforceDomain": "login.salesforce.com"
}
Tableau Cloud Manager REST API Site methods allow cloud administrators to manage sites in the following ways:
Creates a new site under the given tenant. The site name must be unique within the tenant.
Note: To describe the site location, specify one of either a regionUUID
or a podUUID
.
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.
tenantId required | string The unique identifier of the tenant where the site is created. |
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 | string <uuid> (Required if no The Unique ID of Tableau region where the site should be created. Provide this or the podUUID. Use the List Locations or List regions method to get the region IDs. |
podUUID | string <uuid> (Required if no The Unique ID of Tableau pod where the site should be created. Provide this or the regionUUID. Use the List Locations method to get the pod IDs. |
{- "name": "string",
- "contentUrl": "string",
- "regionUUID": "8cc23c52-0d6e-468d-9156-952d9b566d86",
- "podUUID": "e2e568b4-35a7-4aa5-8686-107bbf9f050c"
}
{- "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
- "siteUUID": "c9e56a0f-ad64-4cef-a0e8-cd7f1d44ab67",
- "name": "string",
- "contentUrl": "string",
- "instance": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "baseUrl": "string",
- "serverInstanceId": "string",
- "regionUUID": "8cc23c52-0d6e-468d-9156-952d9b566d86",
- "cloudProvider": {
- "name": "string",
- "region": "string"
}
}, - "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": {
- "userQuotaPolicy": {
- "creatorCapacity": 0,
- "explorerCapacity": 0,
- "viewerCapacity": 0
}
}
}
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.
tenantId required | string The unique identifier for the tenant. |
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 |
{- "sites": [
- {
- "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
- "siteUUID": "c9e56a0f-ad64-4cef-a0e8-cd7f1d44ab67",
- "name": "string",
- "contentUrl": "string",
- "instance": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "baseUrl": "string",
- "serverInstanceId": "string",
- "regionUUID": "8cc23c52-0d6e-468d-9156-952d9b566d86",
- "cloudProvider": {
- "name": "string",
- "region": "string"
}
}, - "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"
}
], - "pageToken": "string"
}
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.
tenantId required | string The unique identifier for the tenant. |
siteId required | string The LUID for the site. |
{- "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
- "siteUUID": "c9e56a0f-ad64-4cef-a0e8-cd7f1d44ab67",
- "name": "string",
- "contentUrl": "string",
- "instance": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "baseUrl": "string",
- "serverInstanceId": "string",
- "regionUUID": "8cc23c52-0d6e-468d-9156-952d9b566d86",
- "cloudProvider": {
- "name": "string",
- "region": "string"
}
}, - "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"
}
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.
tenantId required | string The unique identifier for the tenant. |
siteId required | string The LUID for the site. |
"string"
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.
tenantId required | string The unique identifier for the tenant. |
siteId required | string The LUID 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. | |
object (UserQuota) The limit of number of users with licenses for the viewer role for the site. |
{- "creatorCapacity": {
- "isDefaultCloudLimit": true,
- "capacity": 0
}, - "explorerCapacity": {
- "isDefaultCloudLimit": true,
- "capacity": 0
}, - "viewerCapacity": {
- "isDefaultCloudLimit": true,
- "capacity": 0
}
}
{- "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
- "siteUUID": "c9e56a0f-ad64-4cef-a0e8-cd7f1d44ab67",
- "name": "string",
- "contentUrl": "string",
- "instance": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "baseUrl": "string",
- "serverInstanceId": "string",
- "regionUUID": "8cc23c52-0d6e-468d-9156-952d9b566d86",
- "cloudProvider": {
- "name": "string",
- "region": "string"
}
}, - "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"
}
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.
tenantId required | string The unique identifier for the tenant. |
siteId required | string The LUID for the site. |
ownerId required | string The LUID of the user that owns the project. |
{- "ownerId": "string"
}
{- "project": {
- "name": "string",
- "id": "string",
- "description": "string",
- "parentProjectId": "string",
- "contentPermissions": "string",
- "owner": {
- "id": "string"
}
}
}
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.
tenantId required | string The unique identifier for the tenant. |
siteId required | string The LUID for the site. |
{- "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
- "siteUUID": "c9e56a0f-ad64-4cef-a0e8-cd7f1d44ab67",
- "name": "string",
- "contentUrl": "string",
- "instance": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "baseUrl": "string",
- "serverInstanceId": "string",
- "regionUUID": "8cc23c52-0d6e-468d-9156-952d9b566d86",
- "cloudProvider": {
- "name": "string",
- "region": "string"
}
}, - "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"
}
Tableau Cloud Manager REST API Tenant methods allow cloud administrators to manage tenants in the following ways:
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.
tenantName required | string Example: MyTenantName The name of the tenant. Maximum of 80 characters. |
{ }
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.
tenantId required | string Example: 123e4567-e89b-12d3-a456-426614174000 The unique identifier of the tenant. |
{- "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",
- "termsAndConditions": {
- "acceptedTandC": true,
- "acceptedBy": "c9d21af9-656c-4e21-b4ec-9f2224daf95d",
- "acceptedAt": "2019-08-24T14:15:22Z"
}
}
Tableau Cloud Manager REST API User methods allow cloud administrators to manage users in the following ways:
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.
tenantId required | string <uuid> The unique identifier of the tenant. |
userName required | string The unique username of the user. |
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. |
{- "userName": "string",
- "email": "string",
- "language": "DE_DE",
- "locale": "ar_AE",
- "linkRoles": [
- {
- "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
- "linkRole": "LINK_ADMIN",
- "notifyUser": true,
- "idp": "OpenID, TableauIDWithMFA"
}
], - "siteRoles": [
- {
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "siteRole": "SiteAdministratorExplorer",
- "idp": "OpenID",
- "notifyUser": true
}
]
}
{- "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "transactionId": "string",
- "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
}
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.
tenantId required | string <uuid> The unique identifier of the tenant used to filter the response. |
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. |
{- "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "transactionId": "string",
- "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
}
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"
tenantId required | string <uuid> The unique identifier of the tenant. |
siteId | string <uuid> The unique identifier of the site. |
idp | string Enum: "OpenID" "TableauIDWithMFA" The authentication type configured for the tenant. |
file required | string <binary> A
|
{- "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}
Starts a job to delete the specified batch of users from the specified tenant.
To see progress and results, use the returned jobId
in a request to the List status for job method.
Note: If the user owns content in a tenant site, the user will become unlicensed but will not be removed from the tenant or from any sites where they own content. To remove the user from a tenant and shift ownership of their content to another user, you can take the following steps:
mapAssetsTo
query parameter set to use the LUID of the new owner for each site.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.
This method returns an identifier for an asynchronous job. To see progress and results, use List status for job.
tenantId required | string <uuid> The unique identifier of the tenant. |
userIds required | Array of strings <uuid> unique [ items <uuid > ] A comma separated list of user LUIDs to delete. |
{- "userIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
{- "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}
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.
tenantId required | string <uuid> The unique identifier of the tenant. |
userIds required | Array of strings <uuid> unique [ items <uuid > ] Comma separated list of user LUIDs to get details about. |
{- "userIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
{- "users": [
- {
- "linkRoles": [
- {
- "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
- "linkRole": "LINK_ADMIN",
- "linkRoleStatus": "INVITED",
- "idpType": "string"
}
], - "siteRoles": [
- {
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "siteRole": "SiteAdministratorExplorer",
- "idpType": "OpenID"
}
], - "email": "string",
- "userName": "string",
- "displayName": "string",
- "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "userStatus": "ACTIVE",
- "maxSiteRole": "SiteAdministratorExplorer",
- "tcmRoleName": "string",
- "numberOfSiteRoles": 0,
- "lastLoginTime": "2019-08-24T14:15:22Z",
- "language": "DE_DE",
- "locale": "ar_AE"
}
]
}
Starts a job to delete the specified user from the specified tenant.
To see progress and results, use the returned jobId
in a request to the Get batch user job status method. Without an additional license, log files take 2 hours to become available. For more information see, Activity Log.
Note: If the user owns content in a tenant site, the user will become unlicensed but will not be removed from the tenant or from any sites where they own content. To remove the user from a tenant and shift ownership of their content to another user, you can take the following steps:
mapAssetsTo
query parameter set to use the LUID of the new owner for each site.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.
tenantId required | string <uuid> The unique identifier of the tenant. |
userId required | string <uuid> The unique identifier of the user. |
{- "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}
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.
tenantId required | string <uuid> The unique identifier of the tenant. |
userId required | string <uuid> The unique identifier of the user. |
{- "user": {
- "linkRoles": [
- {
- "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
- "linkRole": "LINK_ADMIN",
- "linkRoleStatus": "INVITED",
- "idpType": "string"
}
], - "siteRoles": [
- {
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "siteRole": "SiteAdministratorExplorer",
- "idpType": "OpenID"
}
], - "email": "string",
- "userName": "string",
- "displayName": "string",
- "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "userStatus": "ACTIVE",
- "maxSiteRole": "SiteAdministratorExplorer",
- "tcmRoleName": "string",
- "numberOfSiteRoles": 0,
- "lastLoginTime": "2019-08-24T14:15:22Z",
- "language": "DE_DE",
- "locale": "ar_AE"
}
}
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.
tenantId required | string <uuid> The unique identifier of the tenant. |
userId required | string <uuid> The unique identifier 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 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. |
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 |
{- "language": "DE_DE",
- "locale": "ar_AE",
- "email": "string",
- "linkRoles": [
- {
- "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
- "linkRole": "LINK_ADMIN",
- "notifyUser": true,
- "idp": "OpenID, TableauIDWithMFA",
- "linkOp": "ADD_LINK_ROLE"
}
], - "siteRoles": [
- {
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "siteRole": "SiteAdministratorExplorer",
- "idp": "OpenID",
- "notifyUser": true,
- "siteOp": "ADD_SITE_ROLE"
}
]
}
{- "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}
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.
jobId required | string <uuid> The unique identifier of the job whose details are to be retrieved. |
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 |
{- "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": {
- "property1": "string",
- "property2": "string"
}, - "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": [
- {
- "jobStatus": "NEW",
- "time": "2019-08-24T14:15:22Z"
}
], - "items": [
- {
- "lineNumber": "string",
- "userName": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "siteId": "string",
- "opType": "CREATE_USER_SITE_ROLE",
- "status": "NEW",
- "opCode": "USER_CREATED_WITH_ASSIGNED_ROLE",
- "serverSiteUserId": "string",
- "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
- "linkRole": "LINK_ADMIN",
- "siteRole": "SiteAdministratorExplorer",
- "idp": "OpenID"
}
], - "nextPageToken": "string"
}
userName required | string The username of the user to get resource details for. |
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. |
{- "resources": [
- {
- "name": "string",
- "state": "string",
- "migrationStatus": "NotStarted",
- "uri": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resourceType": "SITE",
- "instanceDomain": "string",
- "parent": {
- "name": "string",
- "uri": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
], - "userName": "string"
}