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

Sign in and sign out of Tableau Server or Tableau Cloud. You must sign in to obtain an authentication token before calling other methods.

Tableau Authentication 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 Authentication. 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 3 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}.

3 operations 3 paths 3 schemas 3 POST

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 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 — The authentication token obtained from the Sign In method. Include this token in the X-Tableau-Auth header of all subsequent requests.

Paths & Operations 3

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

Authentication 3

Sign in and sign out of Tableau Server or Tableau Cloud. You must sign in to obtain an authentication token before calling other methods.

POST
/auth/signin
Tableau Sign in
signIn body → 200401
POST
/auth/signout
Tableau Sign Out
signOut → 204401
POST
/auth/switchSite
Tableau Switch Site
switchSite body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (1 property), SignInResponse (1 property), SignInRequest (1 property). Each schema is shown below with its type and property counts.

SignInRequest
object
1 property
SignInResponse
object
1 property
ErrorResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tableau-authentication-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