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 Desktop Authentication API

Sign in and sign out operations.

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

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 3.22.

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

2 operations 2 paths 2 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.22
Base URL
https://tableau-server/api/3.22
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Tableau Desktop Authentication 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 — Authentication token returned by the Sign In endpoint.

Paths & Operations 2

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

Authentication 2

Sign in and sign out operations.

POST
/auth/signin
Sign In
signIn body → 200
POST
/auth/signout
Sign Out
signOut → 204

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

Request
object
Generic Tableau REST API request envelope (tsRequest).
Response
object
Generic Tableau REST API response envelope (tsResponse).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tableau-desktop-authentication-api-openapi.yml Raw ↑

Other APIs Tableau Desktop publishes across the network.

Tableau Extensions API
Tableau Hyper API
Tableau Embedding API
Tableau Metadata API
Tableau Server Client (Python)
Tableau Desktop Data Sources API
Tableau Desktop Projects API
Tableau Desktop Server API
Tableau Desktop Sites API
Tableau Desktop Users API
Tableau Desktop Workbooks API