How to Authenticate

There are two primary ways you can use the Tableau Metadata API:

• Interactively through GraphiQL. GraphiQL is an in-browser query tool. For more information, see Explore the GraphQL schema using GraphiQL.
• Programmatically through the GraphQL endpoint: For this, you need to get an authentication token, as described in the Authenticate using Tableau REST API method.

To access and use the Metadata API in one of the two ways described above, it’s important to know if your Tableau Cloud site or Tableau Server is licensed with Data Management.

• If licensed with Data Management: You can start using the GraphiQL tool immediately or review the section below to learn how to get an authentication token so you can programmatically use the Metadata API.
• If not licensed with Data Management: After the Metadata API has been enabled, review the section below to learn how to get an authentication token so you can programmatically use the Metadata API.

In this section

• Authenticate through Sign In method
  • Sign In using a personal access token
  • Sign In using username and password

Authenticate through Sign In method

The Metadata API requires that you send an authentication token with each query sent. The token lets Tableau Cloud or Tableau Server verify your identity and makes sure that you’re signed in. To get a token, you can call the Sign In method, in one of two ways, using the Tableau REST API versions 3.6 or later.

Sign In using a personal access token

Refer to the personal access token section of the Tableau REST API Help for more information.

Sign In using username and password

Refer to the username and password section of the Tableau REST API Help for more information.

For more information about token expiration, changing the token timeout value, and more, see Using the Authentication Token In Subsequent Calls topic in the Tableau REST API Help.