You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/sign-in-out.md
+27-15Lines changed: 27 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,20 +23,22 @@ In most cases this is the preferred method because it improves security by avoid
23
23
To sign in to Tableau Server or Tableau Cloud with a personal access token, you'll need the following values:
24
24
25
25
**Tableau Server**
26
-
Name | Description
27
-
:--- | :---
28
-
TOKEN_NAME | The personal access token name (from the My Account settings page)
29
-
TOKEN_VALUE | The personal access token value (from the My Account settings page)
30
-
SITENAME | The Tableau Server site you are authenticating with. For example in the site URL http://MyServer/#/site/MarketingTeam/projects, the site name is MarketingTeam. In the REST API documentation, this field is also referred to as contentUrl. This value can be omitted to connect with the Default site on the server.
31
-
SERVER_URL | The Tableau Server you are authenticating with. If your server has SSL enabled, this should be an HTTPS link.
26
+
27
+
| Name | Description |
28
+
| --- | --- |
29
+
| TOKEN_NAME | The personal access token name (from the My Account settings page) |
30
+
| TOKEN_VALUE | The personal access token value (from the My Account settings page) |
31
+
| SITENAME | The Tableau Server site you are authenticating with. For example in the site URL http://MyServer/#/site/MarketingTeam/projects, the site name is MarketingTeam. In the REST API documentation, this field is also referred to as contentUrl. This value can be omitted to connect with the Default site on the server. |
32
+
| SERVER_URL | The Tableau Server you are authenticating with. If your server has SSL enabled, this should be an HTTPS link. |
32
33
33
34
**Tableau Cloud**
34
-
Name | Description
35
-
:--- | :---
36
-
TOKEN_NAME | The personal access token name (from the My Account settings page)
37
-
TOKEN_VALUE | The personal access token value (from the My Account settings page)
38
-
SITENAME | The Tableau Cloud site you are authenticating with. For example in the site URL https://10ay.online.tableau.com/#/site/umbrellacorp816664/workbooks, the site name is umbrellacorp816664. In the REST API documentation, this field is also referred to as contentUrl. This value is always required when connecting to Tableau Cloud.
39
-
SERVER_URL | The Tableau Cloud instance you are authenticating with. In the example above the server URL would be https://10ay.online.tableau.com. This will always be an an HTTPS link.
35
+
36
+
| Name | Description |
37
+
| --- | --- |
38
+
| TOKEN_NAME | The personal access token name (from the My Account settings page) |
39
+
| TOKEN_VALUE | The personal access token value (from the My Account settings page) |
40
+
| SITENAME | The Tableau Cloud site you are authenticating with. For example in the site URL https://10ay.online.tableau.com/#/site/umbrellacorp816664/workbooks, the site name is umbrellacorp816664. In the REST API documentation, this field is also referred to as contentUrl. This value is always required when connecting to Tableau Cloud. |
41
+
| SERVER_URL | The Tableau Cloud instance you are authenticating with. In the example above the server URL would be https://10ay.online.tableau.com. This will always be an an HTTPS link. |
40
42
41
43
This example illustrates using the above values to sign in with a personal access token, do some operations, and then sign out:
42
44
@@ -82,27 +84,37 @@ server.auth.sign_out()
82
84
83
85
### Sign in with JSON Web Token (JWT)
84
86
85
-
If you have Connected Apps enabled, you can create JSON Web Tokens and use them to authenticate over the REST API. To learn about Connected Apps, read the docs on [Tableau Connected Apps](https://help.tableau.com/current/server/en-us/security_auth.htm#connected-apps)
87
+
If you have Connected Apps enabled, you can create JSON Web Tokens and use them to authenticate over the REST API. To learn about Connected Apps, read the docs on [Tableau Connected Apps](https://help.tableau.com/current/server/en-us/security_auth.htm#connected-apps).
86
88
87
89
To sign in to Tableau Server or Tableau Cloud with a JWT, you'll need to have created a Connected App and generated the token locally (see [instructions to generate a JWT for your Connected App](https://help.tableau.com/current/server/en-us/connected_apps.htm#step-3-configure-the-jwt)):
88
90
91
+
Starting in December 2025 with REST API version 3.27, Tableau Cloud also accepts a Unified Access Token (UAT) as a JWT-based authentication mechanism. UATs are configured via the [Tableau Cloud Manager REST API](https://help.tableau.com/current/api/cloud-manager/en-us/reference/index.html#tag/Authentication-Methods/operation/createUatConfiguration).
92
+
93
+
To learn more about Unified Access Token, read the docs on [Unified Access Tokens](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#sign-in-to-tableau-rest-api).
SITENAME | The same as described for personal access tokens
98
104
SERVER_URL | The same as described for personal access tokens
105
+
isUat | (Tableau Cloud only) Set to `True` when authenticating with a Unified Access Token JWT. Leave it unset (or `False`) when signing in with a Connected App JWT.
99
106
100
107
This example illustrates using the above values to sign in with a JWT, do some operations, and then sign out:
0 commit comments