Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tableau Permissions API

Query and set permissions on content items including workbooks, data sources, projects, views, and flows.

Tableau Permissions API is one of 25 APIs that Tableau publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Permissions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, authentication docs, a changelog, a getting-started guide, and 1 JSON Schema.

This API exposes 5 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 3.24.0.

Requests are made against a single base URL, https://{server}/api/{api-version}.

5 operations 3 paths 3 schemas 3 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.24.0
Base URL
https://[server]/api/[api-version]
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Tableau Permissions API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Tableau-Auth (TableauAuth). By default, every request must be authenticated.

  • TableauAuth — The authentication token obtained from the Sign In method. Include this token in the X-Tableau-Auth header of all subsequent requests.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 3 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Permissions 5

Query and set permissions on content items including workbooks, data sources, projects, views, and flows.

GET
/sites/{site-id}/workbooks/{workbook-id}/permissions
Tableau Query Workbook Permissions
queryWorkbookPermissions 2 params → 200
PUT
/sites/{site-id}/workbooks/{workbook-id}/permissions
Tableau Add Workbook Permissions
addWorkbookPermissions 2 params body → 200
GET
/sites/{site-id}/datasources/{datasource-id}/permissions
Tableau Query Data Source Permissions
queryDataSourcePermissions 2 params → 200
PUT
/sites/{site-id}/datasources/{datasource-id}/permissions
Tableau Add Data Source Permissions
addDataSourcePermissions 2 params body → 200
GET
/sites/{site-id}/projects/{project-id}/default-permissions/workbooks
Tableau Query Default Permissions for Workbooks
queryDefaultWorkbookPermissions 2 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are PermissionListResponse (2 properties), Permission (1 property), AddPermissionsRequest (1 property). Each schema is shown below with its type and property counts.

PermissionListResponse
object
2 properties
AddPermissionsRequest
object
1 property
Permission
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tableau-permissions-api-openapi.yml Raw ↑

Other APIs Tableau publishes across the network.

Tableau Metadata API
Tableau Hyper API
Tableau Embedding API
Tableau Document API
Tableau Server Client (Python)
Tableau Extensions API
Tableau Web Data Connector
Tableau Connector SDK
Tableau Analytics Extensions API
Tableau Webhooks
Tableau VizQL Data Service
Tableau Pulse API