Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions modules/ROOT/pages/authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -772,6 +772,45 @@ curl -X POST \

If the API request is successful, ThoughtSpot returns a 204 status code and ends the user session.

== Configuring authentication settings
To enable or disable authentication at the cluster or Org level, send a request to the `POST /api/rest/2.0/auth/configure` endpoint.

=== Request parameters
[width="100%" cols="1,4"]
[options='header']
|=====
|Parameter|Description
|`auth_type`
|__String__. Type of authentication mechanism to configure. Currently, supports `TRUSTED_AUTH` only.

|`cluster_preferences`
__Optional__
|__Nullable__. `ENABLE` or `DISABLE` authentication for the cluster. When enabled, a new token is generated if one does not exist. When disabled, the existing cluster-level access token is revoked.

|`org_preferences`
__Optional__
|__Nullable__. `ENABLE` or `DISABLE` authentication for a particular Org. When enabled, a new org-level access token is generated if one does not exist. When disabled, the existing org-level access token is revoked.

|`org_identifier`

|=====

== Search authentication settings
To find the authentication configuration for the specified auth type at the cluster or Org level, send a request to the `POST /api/rest/2.0/auth/search` endpoint.

=== Request parameters
[width="100%" cols="1,4"]
[options='header']
|=====
|Parameter|Description
|`auth_type`
|__String__. Type of authentication mechanism to configure. Currently, supports `TRUSTED_AUTH` only.

|`scope`
__Optional__
|__String__. Select `CLUSTER` to retrieve only cluster-level settings, or `ORG` to retrieve only Org-level settings. If no selection is made, both cluster and Org-level settings are retrieved based on user permissions.
|=====

////
==== Response codes

Expand Down
37 changes: 36 additions & 1 deletion modules/ROOT/pages/data-report-v2-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -481,6 +481,41 @@ curl -X POST \
* HTML rendering is not supported for PDF exports of Answers with tables.
====


Contact ThoughtSpot support to enable these additional settings for this API endpoint on your ThoughtSpot instance.

* `personalised_view_identifier` [beta betaBackground]^Beta^ +
Optional parameter to specify the GUID of the personalised view of the Answer object that you want to download.
* `type` [beta betaBackground]^Beta^ +
Used to distinguish between a saved answer and a pinned answer on a Liveboard. Setting this parameter to `PINNED` allows the API to
accept the guid of a pinned Answer directly as the `metadata_identifier`. When
exporting a `PINNED` answer, all Liveboard-level filters, Runtime Filters, and Column
Security Rules (CSR) are automatically applied to the export output.

The `png_options` [beta betaBackground]^Beta^ support the following properties:

[cols="1,1,3"]
|===
|Property |Type |Description

|`x_resolution`
|Number
|Width of the exported PNG in pixels. +
Valid range: `600px` to `3840px`.

|`y_resolution`
|Number
|Height of the exported PNG in pixels. +
Valid range: `600px` to `3840px`.

|`scaling`
|Integer
|Display scale percentage for objects rendered in the image. Adjusts the relative
size of visual elements without cropping the image. +
Valid range: `80%` to `400%`.
|===


[#exportSpotterData]
==== Export data generated from Spotter APIs
To export results generated from Spotter APIs such as `/api/rest/2.0/ai/answer/create`, `/api/rest/2.0/ai/agent/converse/sse`, and `/api/rest/2.0/ai/conversation/{conversation_identifier}/converse`, include the session ID and generation number in the `POST` request body.
Expand All @@ -504,7 +539,7 @@ curl -X POST \

* `session_identifier` refers to session ID returned in the Spotter API response.
* `generation_number` indicates the Answer generation number.
* `file_format` specifies the format of the output. You can export the Spotter-generated data as PNG or CSV file. By default, the API exports this data in PNG file format.
* `file_format` specifies the format of the output. You can export the Spotter-generated data as PNG, CSV, XLSX, or PDF file. By default, the API exports this data in PNG file format.

===== API Response

Expand Down
9 changes: 9 additions & 0 deletions modules/ROOT/pages/rest-api-v2-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,15 @@ ThoughtSpot Software: __10.0.0.sw or later__ a| +++<a href="{{navprefix}}/restV2
a| `POST /api/rest/2.0/auth/token/custom` +
Generates an authentication token with pre-defined RLS rules and filter attributes for a user. a| ThoughtSpot Cloud: __10.4.0.cl or later__ +
ThoughtSpot Software: __10.7.0.sw or later__ a| +++<a href="{{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fget-custom-access-token" id="preview-in-playground">Try it out </a>+++

a| `POST /api/rest/2.0/auth/configure` +
Enables or disables authentication. a| ThoughtSpot Cloud: __26.6.0.cl or later__ +
a| +++<a href="{{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fconfigure-auth-settings" id="preview-in-playground">Try it out </a>+++

a| `POST /api/rest/2.0/auth/search` +
Retrieves the authentication configuration for the specified auth type. a| ThoughtSpot Cloud: __26.6.0.cl or later__ +
a| +++<a href="{{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fsearch-auth-settings" id="preview-in-playground">Try it out </a>+++

|=====
--

Expand Down
29 changes: 29 additions & 0 deletions modules/ROOT/pages/rest-apiv2-changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,35 @@

This changelog lists the features and enhancements introduced in REST API v2.0. For information about new features and enhancements available for embedded analytics, see xref:whats-new.adoc[What's New].

== Version 26.6.0.cl, June 2026
=== New API endpoints
==== Authentication
The following new endpoints allow searching for the authentication configuration at the cluster or Org level, and also allows enabling and disabling the authentication. Currently, only support trusted authentication.

* `POST /api/rest/2.0/auth/configure` +
Enables or disables authentication at cluster or Org level for the specified auth type.
* `POST /api/rest/2.0/auth/search` +
Returns the authentication configuration for the specified auth type at cluster and Org level.

=== Answer report API enhancements [beta betaBackground]^Beta^

The `POST /api/rest/2.0/report/answer` endpoint includes the following new request parameters:

* `personalised_view_identifier` +
Optional parameter to specify the GUID of the personalised view of the Answer object that you want to download.

* `type` +
Specifies the type of Answer to export.

In addition to these parameters, you can also define the following properties for PNG downloads:

* `x_resolution`
* `y_resolution`
* `scaling`

Contact ThoughtSpot support to enable these settings for PNG downloads on your ThoughtSpot instance.
For more information, see xref:data-report-v2-api.adoc#_answer_report_api[Answer report API documentation].

== Version 26.5.0.cl, May 2026

=== Sync connection metadata attributes
Expand Down