Tableau Cloud Manager REST API

https://help.tableau.com/current/api/cloud-manager/en-us/
Admin
Tableau Cloud Manager REST API enables centralized administration and configuration of multiple...
Tokens:64,507
Snippets:250
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Tableau REST API Session Header Example

Source: https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens

Example of how to include the authentication token in the request header for subsequent Tableau REST API calls. This token is also short-lived and will expire.

```http
X-Tableau-Auth:HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3
```

--------------------------------

### List Activity Logs for Tenant (GET)

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Fetches a list of paths to tenant activity logs within a specified time period and event type. These paths are used as input for the 'Get activity logs for tenant' method. Supports filtering by time range and event type, with pagination. Available in Tableau Cloud Manager v1 and later. Requires 'tableau:tcm_tenants_logs:read' scope.

```json
{
  "files": [
    {
      "path": "string",
      "size": 0
    }
  ],
  "pageToken": "string"
}
```

--------------------------------

### Get UAT Configuration Details

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Retrieves the details of a specific unified access token (UAT) configuration identified by its `configId`. This GET request requires read access scope and is available for cloud administrators. Successful retrieval returns a 200 status code with the configuration details; otherwise, it may return 404 or 500.

```http
GET /api/v1/uat-configurations/{configId} HTTP/1.1
Host: cloudmanager.tableau.com
Authorization: Bearer <your_access_token>

```

--------------------------------

### Tableau Cloud Manager REST API Session Token Header

Source: https://help.tableau.com/current/api/cloud-manager/en-us/docs/authentication

This example shows the format for including the session token in the header of subsequent requests to the Tableau Cloud Manager REST API. The 'x-tableau-session-token' header is essential for authenticated API interactions after a successful login.

```http
x-tableau-session-token:+iUzQx+s:E9T43sqund-xDGle-9trR7WPLkqCkT_7zks3_dVsV0By_Jji
```

--------------------------------

### Example JSON Response for SAML Admin Logs

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

This JSON structure represents a sample response for SAML admin logs. Each log entry includes a message, a timestamp, the severity level of the log, and the associated site ID. This format is returned by the API when successfully retrieving SAML log entries.

```json
[
  {
    "message": "string",
    "timestamp": 0,
    "logLevel": "string",
    "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1"
  }
]
```

--------------------------------

### Get activity logs for tenant

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Retrieves download URLs for tenant activity logs in a CSV file. Requires tenant ID and a list of file paths obtained from the 'List activity logs for tenant' endpoint.

```APIDOC
## POST /api/v1/tenants/{tenantId}/activitylog

### Description
Gets the download URLs for tenant activity logs in a comma-separated values (CSV) file. The response includes `expiresAt` and an `eTag` for verification.

### Method
POST

### Endpoint
`/api/v1/tenants/{tenantId}/activitylog`

### Parameters
#### Path Parameters
- **tenantId** (string) - Required - The unique identifier of the tenant.

#### Request Body
- **files** (Array of strings) - Required - Activity log file paths. You can get these paths by calling the 'List activity logs for tenant' method.

### Request Example
```json
{
  "files": [
    "string"
  ]
}
```

### Response
#### Success Response (200)
- **files** (Array of objects) - Contains details for each activity log URL.
  - **path** (string) - The path of the activity log.
  - **url** (string) - The download URL for the activity log.
  - **expiresAt** (string) - The time after which the URL will remain valid (ISO 8601 format).
  - **etag** (string) - An MD5 hash of the activity log content for verification.

#### Response Example
```json
{
  "files": [
    {
      "path": "string",
      "url": "string",
      "expiresAt": "2019-08-24T14:15:22Z",
      "etag": "string"
    }
  ]
}
```
```

--------------------------------

### List activity logs for tenant

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Retrieves a list of paths to a tenant's activity logs for a specified time period and event type. These paths can be used with the 'Get activity logs for tenant' endpoint.

```APIDOC
## GET /api/v1/tenants/{tenantId}/activitylog

### Description
Gets a list of paths to the tenant's activity logs for the specified time period and event type. Use these paths in a request to the 'Get activity logs for tenant' method.

### Method
GET

### Endpoint
`/api/v1/tenants/{tenantId}/activitylog`

### Parameters
#### Path Parameters
- **tenantId** (string) - Required - The unique identifier of the tenant.

#### Query Parameters
- **startTime** (string) - Optional - The start time in UTC of the returned activity log records (ISO 8601 format). Defaults to 24 hours prior to the request time.
- **endTime** (string) - Optional - The end time in UTC of the returned activity log records (ISO 8601 format). Defaults to the request time. Maximum 7-day span.
- **eventType** (string) - Optional - The type of event to filter logs by. Defaults to all types.
- **pageSize** (integer) - Optional - The number of log file paths to return. Defaults to 100.
- **pageToken** (string) - Optional - The token for requesting the next page of file paths.

### Response
#### Success Response (200)
- **files** (Array of objects) - A list of available activity log file paths.
  - **path** (string) - The path to the activity log file.
  - **size** (integer) - The size of the log file.
- **pageToken** (string) - Token for the next page of results.

#### Response Example
```json
{
  "files": [
    {
      "path": "string",
      "size": 0
    }
  ],
  "pageToken": "string"
}
```
```

--------------------------------

### List Activity Logs for Site

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Retrieves a list of activity log file paths for a specified site within a given time period and event type. These paths can be used with the 'Get activity logs for site' endpoint.

```APIDOC
## GET /api/v1/tenants/{tenantId}/sites/{siteId}/activitylogs

### Description
Gets a list of activity log files for the site. The response returns a list of file paths to activity log files for the specified time period and event type.

### Method
GET

### Endpoint
`https://cloudmanager.tableau.com/api/v1/tenants/{tenantId}/sites/{siteId}/activitylogs`

### Parameters
#### Path Parameters
- **tenantId** (string) - Required - The unique identifier of the tenant.
- **siteId** (string) - Required - The unique identifier of the site.

#### Query Parameters
*(Note: Specific query parameters for filtering by time period and event type are not detailed in the provided text, but are implied by the description.)*

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
*(Note: The exact structure of the response for this endpoint is not fully detailed, but it is implied to return file paths that can be used with the 'Get activity logs for site' endpoint.)*

#### Response Example
*(Response example not provided in the source text.)*

#### Error Responses
*(Note: Specific error codes and messages for this endpoint are not detailed in the provided text, but general error handling for API requests would apply.)*
```

--------------------------------

### List Tenant Sites API Endpoint

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

This GET request retrieves details for all sites under a specified tenant. It requires the tenant ID in the path and optionally accepts query parameters for filtering by location, maximum results, and pagination. Permissions are restricted to cloud administrators.

```http
GET /api/v1/tenants/{tenantId}/sites
Host: cloudmanager.tableau.com

# Query Parameters (Optional):
# location: string (e.g., "us-west-2")
# maxResults: integer
# pageToken: string
```

--------------------------------

### Response Sample for Creating UAT Configuration (JSON)

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

This JSON represents a successful response (201 Created) after creating a Unified Access Token (UAT) configuration. It includes details of the newly created configuration, such as its ID, tenant ID, configuration ID, and the parameters that were set during creation. The response confirms the successful registration of the UAT configuration.

```json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "configId": "46ff6d11-d8b2-40d8-9197-dfa33c61cd6c",
  "name": "string",
  "issuer": "string",
  "publicKeyActive": "string",
  "publicKey": "string",
  "jwksUri": "string",
  "usernameClaim": "string",
  "resourceIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "scopes": [
    "tableau:tcm_sites:read",
    "tableau:tcm_sites:update",
    "tableau:sites:read",
    "tableau:sites:update"
  ],
  "enabled": true
}
```

--------------------------------

### Retrieve Activity Logs - API Request

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

This snippet demonstrates how to construct an API request to retrieve activity logs from Tableau Cloud Manager. It shows how to specify query parameters such as startTime, endTime, eventType, pageSize, and pageToken to filter and paginate the results. The base URL and an example of a GET request are implied.

```HTTP
GET https://cloudmanager.tableau.com/api/v1/tenants/{tenantId}/sites/{siteId}/activitylog?startTime=2025-01-01T00:00:00&endTime=2025-01-01T00:00:00&eventType=hist_access_view&pageSize=100&pageToken=fDIwMjQtMDktMDlUMDU6MDA=
```

--------------------------------

### Configure SSO or SAML Authentication

Source: https://help.tableau.com/current/api/cloud-manager/en-us/docs/authentication

Configure Google, OpenID Connect (OIDC), Salesforce, or SAML authentication for your Tableau Cloud Manager tenant.

```APIDOC
## Configure SSO or SAML Authentication

### Description
Configures authentication providers like Google, OIDC, Salesforce, or SAML for your TCM tenant. This endpoint allows you to enable and specify the details for the chosen authentication method.

### Method
PUT

### Endpoint
`/api/v1/resources/{tenant_resource_value}/oidcconfiguration` (for OIDC, Salesforce, Google)
`/api/v1/resources/{tenant_resource_value}/samlconfiguration` (for SAML)

### Parameters
#### Path Parameters
- **tenant_resource_value** (string) - Required - The unique identifier for your tenant.

#### Query Parameters
None

#### Request Body
- **enabled** (boolean) - Required - Whether to enable this authentication configuration.
- **knownProviderAlias** (string) - Optional - Specifies the identity provider (e.g., "Salesforce", "Google"). Only applicable for OIDC configuration.
- **salesforceDomain** (string) - Optional - The Salesforce login domain. Required if `knownProviderAlias` is "Salesforce".
- **clientId** (string) - Required for OIDC - The client ID provided by your OIDC provider.
- **clientSecret** (string) - Required for OIDC - The client secret provided by your OIDC provider.
- **oidcIssuer** (string) - Required for OIDC - The issuer URL of your OIDC provider.
- **samlAssertionConsumerServiceUrl** (string) - Required for SAML - The Assertion Consumer Service (ACS) URL for SAML.
- **samlSignonUrl** (string) - Required for SAML - The SAML Single Sign-On (SSO) URL.
- **samlSigningCertificate** (string) - Required for SAML - The SAML signing certificate.

### Request Example
```json
{
  "enabled": true,
  "knownProviderAlias": "Salesforce",
  "salesforceDomain": "login.salesforce.com"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the configuration was updated.

#### Response Example
```json
{
  "message": "OIDC configuration updated successfully."
}
```
```

--------------------------------

### Create Project

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Creates a new project on a site within a tenant. Projects are containers for Tableau content with inherited permissions.

```APIDOC
## POST /api/v1/tenants/{tenantId}/sites/{siteId}/project

### Description
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.

### Method
POST

### Endpoint
`https://cloudmanager.tableau.com/api/v1/tenants/{tenantId}/sites/{siteId}/project`

### Parameters
#### Path Parameters
- **tenantId** (string) - Required - The unique identifier for the tenant.
- **siteId** (string) - Required - The LUID for the site.

#### Request Body
- **ownerId** (string) - Required - The LUID of the user that owns the project.

### Request Example
```json
{
  "ownerId": "string"
}
```

### Response
#### Success Response (201)
- **project** (object)
  - **name** (string) - The name of the project.
  - **id** (string) - The unique identifier for the project.
  - **description** (string) - The description of the project.
  - **parentProjectId** (string) - The ID of the parent project, if any.
  - **contentPermissions** (string) - The content permission model for the project.
  - **owner** (object)
    - **id** (string) - The ID of the project owner.

#### Response Example
```json
{
  "project": {
    "name": "string",
    "id": "string",
    "description": "string",
    "parentProjectId": "string",
    "contentPermissions": "string",
    "owner": {
      "id": "string"
    }
  }
}
```
```

--------------------------------

### GET /api/v1/users/jobs/{jobId}

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Retrieves the status of a batch user job.

```APIDOC
## GET /api/v1/users/jobs/{jobId}

### Description
Retrieves the status of a batch user job. Only cloud administrators can call this method.

### Method
GET

### Endpoint
`/api/v1/users/jobs/{jobId}`

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The unique identifier of the job whose details are to be retrieved.

#### Query Parameters
- **showDetailed** (boolean) - Optional - If true, show the detailed status of each user operation in paginated format. Default is false.
- **pageToken** (string) - Optional - The pageToken used for getting next set of records. Only valid if `showDetailed = true`.

### Response
#### Success Response (200)
- (Response body depends on the job status and `showDetailed` parameter)

#### Response Example
(Example response not provided in the source text)

#### Error Responses
- **400**: Invalid request.
- **403**: User does not have permissions.
- **404**: The job specified could not be found.
- **405**: Method not allowed.
- **500**: Internal error.
```

--------------------------------

### Create Site

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Creates a new site within a specified tenant. The site name must be unique within the tenant. Requires specifying either a `regionUUID` or a `podUUID` for site location.

```APIDOC
## POST /api/v1/tenants/{tenantId}/sites

### Description
Creates a new site under the given tenant. The site name must be unique within the tenant. To describe the site location, specify one of either a `regionUUID` or a `podUUID`.

### Method
POST

### Endpoint
/api/v1/tenants/{tenantId}/sites

### Parameters
#### Path Parameters
- **tenantId** (string) - Required - The unique identifier of the tenant where the site is created.

#### Request Body
- **siteName** (string) - Required - The name of the new site.
- **regionUUID** (string) - Optional - The UUID of the region where the site will be located.
- **podUUID** (string) - Optional - The UUID of the pod where the site will be located.

### Request Example
```json
{
  "siteName": "MyNewSite",
  "regionUUID": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

### Response
#### Success Response (201)
- **siteId** (string) - The ID of the newly created site.
- **siteUrl** (string) - The URL of the newly created site.

#### Response Example
```json
{
  "siteId": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
  "siteUrl": "https://mytenant.us-west-2b.online.tableau.com"
}
```
```

--------------------------------

### Get Tenant User

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Retrieves the detailed information for a specific tenant user.

```APIDOC
## Get Tenant User

Gets the details of a tenant user.

> Permissions: Only cloud administrators can call this method.
> Version: Available in Tableau Cloud Manager v1, June 2024, and later.

##### Authorizations:
_x-tableau-session-token_

##### Path Parameters
tenantId| string <uuid> - Required - The unique identifier of the tenant.
userId| string <uuid> - Required - The unique identifier of the user.

### Method
GET

### Endpoint
/api/v1/tenants/{tenantId}/users/{userId}

### Responses
#### Success Response (200)
- **user** (object) - Contains the user's details.
  - **linkRoles** (array) - List of roles associated with links.
  - **siteRoles** (array) - List of roles associated with sites.
  - **email** (string) - The user's email address.
  - **userName** (string) - The user's username.
  - **displayName** (string) - The user's display name.
  - **tenantId** (string) - The tenant ID.
  - **userId** (string) - The user ID.
  - **userStatus** (string) - The status of the user (e.g., ACTIVE).
  - **maxSiteRole** (string) - The maximum site role assigned to the user.
  - **tcmRoleName** (string) - The Tableau Cloud Manager role name.
  - **numberOfSiteRoles** (integer) - The number of site roles assigned.
  - **lastLoginTime** (string) - The timestamp of the last login.
  - **language** (string) - The user's preferred language.
  - **locale** (string) - The user's preferred locale.

#### Response Example (200)
```json
{
  "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": "f979df110-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"
  }
}
```

#### Error Responses
- **400** Invalid request.
- **401** The user could not be authenticated.
- **403** The user does not have permissions.
- **404** The specified user could not be found.
- **500** Internal error.
```

--------------------------------

### POST /api/v1/tenants/{tenantId}/users/bulk-import

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Imports users in bulk using a .gzip (compressed CSV) file. Users can be imported as tenant users or assigned to a specific site if `siteId` is provided. Cloud administrators can call this method.

```APIDOC
## Batch import users with .gzip

### Description
Import users in bulk using a `.gzip` (compressed CSV) file. If no `siteId` is provided, users are imported as tenant users.

### Method
POST

### Endpoint
`/api/v1/tenants/{tenantId}/users/bulk-import`

### Parameters
#### Path Parameters
- **tenantId** (string <uuid>) - Required - The unique identifier of the tenant.

#### Query Parameters
- **siteId** (string <uuid>) - Optional - The unique identifier of the site.
- **idp** (string) - Optional - Enum: "OpenID" "SAML" "TableauIDWithMFA" - The authentication type configured for the tenant.

#### Request Body
- **file** (string <binary>) - Required - A `.gzip` (compressed CSV) file containing data of users to be imported. The expected columns, in order, are: URI, Username, Password, Display Name, License Level, Administrator Level, Can Publish, Authentication.

### Request Example
```bash
curl -X POST "http://mytenant.cloudmanager.tableau.com/api/v1/tenants/{tenantId}/users/bulk-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=TableauIDWithMFA"
```

### Response
#### Success Response (202)
Success.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Get Tenant Details

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Retrieves details of a specific tenant using its unique identifier.

```APIDOC
## GET /api/v1/tenants/{tenantId}

### Description
Retrieves the details of a specified tenant.

### Method
GET

### Endpoint
https://cloudmanager.tableau.com/api/v1/tenants/{tenantId}

### Parameters
#### Path Parameters
- **tenantId** (string) - Required - The unique identifier of the tenant.

### Response
#### Success Response (200)
- **tenantId** (string) - The unique identifier of the tenant.
- **tenantName** (string) - The name of the tenant.
- **encodeUri** (string) - The encoded URI for the tenant.
- **status** (string) - The status of the tenant.
- **createDateTime** (string) - The date and time when the tenant was created.
- **lastUpdateDateTime** (string) - The date and time when the tenant was last updated.
- **lastDestinationMergedDateTime** (string) - The date and time when the tenant's destination was last merged.
- **termsAndConditions** (object) - Information about the terms and conditions acceptance.
  - **acceptedTandC** (boolean) - Indicates if the terms and conditions were accepted.
  - **acceptedBy** (string) - The identifier of the user who accepted the terms.
  - **acceptedAt** (string) - The date and time when the terms were accepted.

#### Response Example
{
  "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"
  }
}

### Errors
- **404** - A tenant with the specified identifier could not be found.
- **500** - Internal error.
```

--------------------------------

### Create Unified Access Token Configuration (TCM REST API)

Source: https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens

This snippet demonstrates how to create a Unified Access Token (UAT) configuration in the Tableau Cloud Manager (TCM) REST API. It requires details like issuer, JWT public key or JWKS URI, resource IDs, and scopes. The response includes the configuration details and its unique identifiers.

```json
{
  "name": "UAT for FTE Admins",
  "issuer": "https://myidp.okta.com",
  "publicKey": "...",
  "jwksUri": "https://myidp.okta.com/keys",
  "usernameClaim": "email",
  "resourceIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "scopes": [
    "tableau:tcm_sites:read",
    "tableau:tcm_sites:update",
    "tableau:sites:read",
    "tableau:sites:update"
  ],
  "enabled": true
}
```

--------------------------------

### TCM REST API Overview

Source: https://help.tableau.com/current/api/cloud-manager/en-us/index

This section provides an overview of the Tableau Cloud Manager (TCM) REST API, explaining its purpose, key concepts like tenants and sites, and the different categories of available methods.

```APIDOC
## Tableau Cloud Manager (TCM) REST API Overview

### Key Concepts

*   **Tenant:** A grouping of Tableau Cloud sites within a specific region.
*   **Cloud Administrator:** A user with specific roles in TCM, enabling management of tenant configuration and content via the UI and REST API.
*   **Site in a tenant:** A standard Tableau Cloud site, integrated within a TCM tenant.
*   **User in a tenant:** A Tableau Cloud user whose identity can be managed within a TCM tenant and assigned to any site within that tenant.

### TCM REST API Method Categories

The TCM REST API offers methods for managing tenants and their members, categorized as follows:

*   **Administrative Methods:** Retrieve information about the current REST API session, tenant status, region, site capabilities, user metrics, and activity logs.
*   **Authentication Methods:** Manage personal access tokens (PATs), configure, view, and delete universal access token (UAT) configurations and JWTs. Includes sign-in methods to obtain session access tokens.
*   **Single Sign-on Methods:** Create, view, and delete authentication configurations for tenants and sites.
*   **Site Methods:** Create, view, suspend, reactivate, and delete sites and projects within a tenant.
*   **Tenant Methods:** Retrieve information about a tenant and check for the uniqueness of a tenant name.
*   **User Methods:** Create, import, delete users, view user details and related resources, and update user attributes.

**Note:** Cloud administrator permissions are currently required for all TCM REST API requests.
```

--------------------------------

### Get Tenant

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Retrieves the tenant record for a specified tenant ID. This operation is restricted to cloud administrators.

```APIDOC
## GET /api/v1/tenants/{tenantId}

### Description
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.
> Access scope: `tableau:tcm_tenants:read`.

### Method
GET

### Endpoint
`https://cloudmanager.tableau.com/api/v1/tenants/{tenantId}`

### Parameters
#### Path Parameters
- **tenantId** (string, uuid) - Required - The unique identifier of the tenant. Example: `123e4567-e89b-12d3-a456-426614174000`.

### Response
#### Success Response (200)
- **tenantId** (string) - The unique identifier for the tenant.
- **siteUUID** (string) - The unique identifier for the primary site of the tenant.
- **name** (string) - The name of the tenant.
- **contentUrl** (string) - The content URL of the tenant's primary site.
- **instance** (object) - Details about the Tableau Cloud instance.
- **creatorCapacity** (integer) - The default creator capacity for sites in this tenant.
- **explorerCapacity** (integer) - The default explorer capacity for sites in this tenant.
- **viewerCapacity** (integer) - The default viewer capacity for sites in this tenant.
- **creatorCapacityIsDefaultCloudLimit** (boolean) - Indicates if creator capacity uses the default cloud limit.
- **explorerCapacityIsDefaultCloudLimit** (boolean) - Indicates if explorer capacity uses the default cloud limit.
- **viewerCapacityIsDefaultCloudLimit** (boolean) - Indicates if viewer capacity uses the default cloud limit.
- **location** (string) - The geographic location associated with the tenant.
- **migrationStatus** (string) - The migration status of the tenant.
- **storageQuota** (integer) - The default storage quota for sites in this tenant in bytes.
- **storageUsed** (integer) - The total storage used by all sites in this tenant in bytes.
- **status** (string) - The status of the tenant.
- **createDateTime** (string) - The date and time the tenant was created.
- **lastUpdateDateTime** (string) - The date and time the tenant was last updated.
- **suspendedDateTime** (string) - The date and time the tenant was suspended.

#### Response Example
```json
{
  "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"
}
```
```

--------------------------------

### GET /api/v1/users/{userName}

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Retrieves information about a specific user, optionally filtered by resource type or authentication details.

```APIDOC
## GET /api/v1/users/{userName}

### Description
Gets information about the user. Only cloud administrators can call this method.

### Method
GET

### Endpoint
/api/v1/users/{userName}

### Parameters
#### Path Parameters
- **userName** (string) - Required - The username of the user to get resource details for.

#### Query Parameters
- **resourceId** (string) - Optional - The unique identifier of a site or tenant optionally used to filter results.
- **resourceType** (string) - Optional - Enum: "SITE" "TENANT" - The type of resource optionally used to filter results.
- **authType** (string) - Optional - Enum: "OpenID" "SAML" "TableauIDWithMFA" "DEFAULT" - The type of user authentication optionally used to filter results.
- **authUserId** (string) - Optional - The unique identifier of the user optionally used to filter results.

### Responses
#### Success Response (200)
- **userName** (string) - The username of the user.
- **resources** (array) - A list of resources associated with the user.
  - **name** (string) - The name of the resource.
  - **state** (string) - The state of the resource.
  - **migrationStatus** (string) - The migration status of the resource.
  - **uri** (string) - The URI of the resource.
  - **email** (string) - The email address associated with the resource.
  - **id** (string) - The unique identifier of the resource.
  - **resourceType** (string) - The type of the resource (e.g., "SITE").
  - **instanceDomain** (string) - The domain of the resource instance.
  - **parent** (object) - Information about the parent resource.
    - **name** (string) - The name of the parent resource.
    - **uri** (string) - The URI of the parent resource.
    - **id** (string) - The ID of the parent resource.

#### Response Example
```json
{
  "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"
}
```
```

--------------------------------

### GET /api/v1/regions

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Lists the regions where a site can be created in a tenant, filtered by provided criteria. This endpoint is accessible only to cloud administrators.

```APIDOC
## GET /api/v1/regions

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

### Method
GET

### Endpoint
/api/v1/regions

### Parameters
#### Query Parameters
- **pageNumber** (integer) - Optional - The number of the page to return values for. A value of 0 means do not page results. Default: 0
- **pageSize** (integer) - Optional - The number of items returned per page. Default: 100
- **latitude** (number) - Optional - The latitude of the region, a value between -90 and +90.
- **longitude** (number) - Optional - The longitude of the region, a value between -180 and +180.
- **visibility** (string) - Optional - Enum: "INTERNAL", "PUBLIC". If `INTERNAL`, the region is not visible to users. If `PUBLIC` the region is visible to users. Default: "INTERNAL"
- **countryCode** (string) - Optional - The country code in the region definition.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **regions** (array) - A list of region objects.
  - **uuid** (string) - The unique identifier for the region.
  - **name** (string) - The name of the region.
  - **location** (object) - Geographic coordinates of the region.
    - **latitude** (number) - Latitude value.
    - **longitude** (number) - Longitude value.
  - **visibility** (string) - Visibility status of the region (INTERNAL or PUBLIC).
  - **attributes** (object) - Additional attributes for the region.
    - **property1** (string) - Example attribute.
    - **property2** (string) - Example attribute.
- **data** (array) - Similar to regions, potentially for different use cases or data structures.
  - **uuid** (string) - The unique identifier for the data entry.
  - **name** (string) - The name of the data entry.
  - **location** (object) - Geographic coordinates.
    - **latitude** (number) - Latitude value.
    - **longitude** (number) - Longitude value.
  - **visibility** (string) - Visibility status.
  - **attributes** (object) - Additional attributes.
    - **property1** (string) - Example attribute.
    - **property2** (string) - Example attribute.

#### Response Example
```json
{
  "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"
      }
    }
  ]
}
```
```

--------------------------------

### GET /api/v1/uat-configurations/{configId}

Source: https://help.tableau.com/current/api/cloud-manager/en-us/reference/index

Retrieves the details of a specific unified access token (UAT) configuration. This endpoint is accessible only to cloud administrators.

```APIDOC
## GET /api/v1/uat-configurations/{configId}

### Description
Gets the specified unified access token (UAT) configuration. Only cloud administrators can call this method.

### Method
GET

### Endpoint
https://cloudmanager.tableau.com/api/v1/uat-configurations/{configId}

### Parameters
#### Path Parameters
- **configId** (string <uuid>) - Required - The unique identifier of the unified access token (UAT) configuration. You can get the `configId` by calling the List unified access token configurations method.

### Responses
#### Success Response (200)
- **id** (string) - The unique identifier for the UAT configuration.
- **tenantId** (string) - The ID of the tenant associated with the configuration.
- **configId** (string) - The configuration ID.
- **name** (string) - The name of the UAT configuration.
- **issuer** (string) - The issuer of the JSON Web Token (JWT).
- **publicKeyActive** (string) - Indicates if the public key is active.
- **publicKey** (string) - The public key used to verify the JWT.
- **jwksUri** (string) - The URI of the JWKS endpoint.
- **usernameClaim** (string) - The username claim that maps to the Tableau username.
- **resourceIds** (Array of strings <uuid>) - The tenant ID, or tenant and site IDs associated with the tenant.
- **scopes** (Array of strings <scope>) - The access scopes defined in the JWT.
- **enabled** (boolean) - Indicates if the UAT configuration is enabled.

#### Response Example (200)
```json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "configId": "46ff6d11-d8b2-40d8-9197-dfa33c61cd6c",
  "name": "string",
  "issuer": "string",
  "publicKeyActive": "string",
  "publicKey": "string",
  "jwksUri": "string",
  "usernameClaim": "string",
  "resourceIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "scopes": [
    "tableau:tcm_sites:read",
    "tableau:tcm_sites:update",
    "tableau:sites:read",
    "tableau:sites:update"
  ],
  "enabled": true
}
```

#### Error Response (404)
Unified access token (UAT) configuration not found.

#### Error Response (500)
Internal error.
```

--------------------------------

### Create Unified Access Token Configuration

Source: https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens

Configures a Unified Access Token (UAT) in the Tableau Cloud Manager REST API. This endpoint requires your tenant name in the URI.

```APIDOC
## POST /api/v1/uat-configurations

### Description
Creates a Unified Access Token (UAT) configuration for the Tableau Cloud Manager REST API.

### Method
POST

### Endpoint
`https://<tenant-name>.cloudmanager.tableau.com/api/v1/uat-configurations`

### Parameters
#### Request Body
- **name** (string) - Required - A descriptive name for the UAT configuration.
- **issuer** (string) - Required - The `issuer` in the UAT configuration, must match the `iss` in the JWT.
- **publicKey** (string) - Optional - The public key for verifying the JWT.
- **jwksUri** (string) - Optional - The JWKS URI for fetching public keys.
- **usernameClaim** (string) - Optional - The claim in the JWT that contains the username.
- **resourceIds** (array of strings) - Required - An array of IDs (tenant ID, site IDs) for which the UAT will be enabled.
- **scopes** (array of strings) - Optional - The scopes to grant to the UAT.
- **enabled** (boolean) - Optional - Whether the UAT configuration is enabled.

### Request Example
```json
{
  "name": "UAT for FTE Admins",
  "issuer": "https://myidp.okta.com",
  "publicKey": "...",
  "jwksUri": "https://myidp.okta.com/keys",
  "usernameClaim": "email",
  "resourceIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "scopes": [
    "tableau:tcm_sites:read",
    "tableau:tcm_sites:update",
    "tableau:sites:read",
    "tableau:sites:update"
  ],
  "enabled": true
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the UAT configuration.
- **tenantId** (string) - The ID of the tenant.
- **configId** (string) - The configuration ID.
- **name** (string) - The name of the UAT configuration.
- **issuer** (string) - The issuer of the JWT.
- **publicKeyActive** (string) - The active public key.
- **publicKey** (string) - The public key.
- **jwksUri** (string) - The JWKS URI.
- **usernameClaim** (string) - The username claim from the JWT.
- **resourceIds** (array of strings) - The resource IDs associated with the UAT.
- **scopes** (array of strings) - The scopes granted to the UAT.
- **enabled** (boolean) - Indicates if the UAT configuration is enabled.

#### Response Example
```json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "configId": "46ff6d11-d8b2-40d8-9197-dfa33c61cd6c",
  "name": "UAT for FTE Admins",
  "issuer": "https://myidp.okta.com",
  "publicKeyActive": "...",
  "publicKey": "...",
  "jwksUri": "https://myidp.okta.com/keys",
  "usernameClaim": "email",
  "resourceIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "scopes": [
    "tableau:tcm_sites:read",
    "tableau:tcm_sites:update",
    "tableau:sites:read",
    "tableau:sites:update"
  ],
  "enabled": true
}
```
```
Tokens:
Raw