ThoughtSpot administrators can assign granular privileges to users with Role-Based Access Control (RBAC).
|
Important
|
The RBAC feature is turned off by default. To enable this feature on your cluster, contact ThoughtSpot Support. Note that once you enable RBAC, it cannot be disabled. |
A Role is a collection of privileges that determines users' access to ThoughtSpot objects and workflows. Roles can be high-level, like Super Admin, or specific based on your organization’s structure and requirements.
When the RBAC feature is enabled on your instance, administrators can grant granular privileges and thus implement fine-grained access control to ThoughtSpot features, objects, and metadata.
For example, on ThoughtSpot instances with no RBAC, members of the groups with administration privileges can view and administer users, groups, and roles. With RBAC, you can assign granular privileges and restrict application-wide access only to super admin users.
| ThoughtSpot privilege (without RBAC) | ThoughtSpot RBAC Roles |
|---|---|
Can administer ThoughtSpot This privilege grants administration permissions to manage users and groups on instances that do not have the RBAC feature enabled. | RBAC allows multiple Roles with granular privileges for administration control:
For a complete list of Roles and privileges, see Role categories and privileges. |
Administrators can create a Role with a specific set of privileges and assign this Role to a group via UI or REST API calls. Users inherit Role privileges from the groups to which they are assigned. To assign a Role to a user, administrators must assign the Role to a group and ensure that the intended users are added to this group.
|
Note
|
Roles are unique to an Org and can be created only within the context of an Org. |
For more information about Role and Group assignment, see ThoughtSpot Product Documentation.
The RBAC feature groups access privileges under specific categories for granular access control and ease of use. You can create a role with a specific privilege from any role category and assign it to a group.
|
Important
|
All ThoughtSpot instances include a Super Admin role that provides cluster-wide administration privileges by default. The Super admin user can access all data, create and manage users, Orgs, Groups, and Roles. This privilege should only be granted in exceptional circumstances. |
Includes Role privileges that allow administrative access to create and manage ThoughtSpot objects such as users, groups, and Roles.
| Role type | Privilege | Description |
|---|---|---|
Org administration | API: | Applicable to ThoughtSpot instances with Orgs. Users with |
User administration | API: | Allows users to create, edit, and manage users via UI or REST API calls. On clusters with Orgs enabled, this Role allows users to perform CRUD operations only within their Org context. It does not grant access to manage users in the |
Group administration | API: | Allows users to create, edit, and manage groups via UI or REST API calls. |
Role administration | API: | Allows users to create, edit, and manage Roles via UI or REST API calls. |
Authentication administration | API: | Allows users to manage authentication and authorization process for ThoughtSpot users. |
Application administration | API: | Provides access to manage cluster-wide application settings, activation and de-activation of features on an instance. |
System monitoring | API: | Allows users to view system activities and monitor health. |
Billing administration | API: | Allows view access to billing information. |
Trusted authentication control | API: | Allows users with super admin ( |
Tag administration | API: | Allows users to create and edit tags. |
Version control with Git | API: | Allows users to enable version control for a ThoughtSpot instance or Org. |
Analyst studio | API: | Allows users to manage Analyst Studio for ThoughtSpot users. |
API: | Allows access to Analyst Studio features. |
|
Note
|
Analyst Studio is not supported in ThoughtSpot embedded instances. |
The application control role privileges include the following:
| Role type | Privilege | Description | ||
|---|---|---|---|---|
SpotIQ access | API: | Allows access to the SpotIQ feature in ThoughtSpot. | ||
Developer | API: | Allows users to access the following features and workflows:
| ||
Liveboard job administration | API: | Allows users to schedule, edit, and delete Liveboard jobs. | ||
ThoughtSpot Sync | API: | Allows setting up secure pipelines to external business apps and sync data using ThoughtSpot Sync. | ||
Spotter access | API: | Allows access to ThoughtSpot Spotter and natural language query and answer generation. | ||
Spotter administration | API: | Allows a designated Spotter administrator to manage Spotter’s behavior across the organization. This role provides the following capabilities:
| ||
Catalog management | API: | Allows users to create, edit, and manage a data connector catalog. |
The SHAREWITHALL (Can share with all users) Role privilege allows users to share objects with all the users and groups in ThoughtSpot.
The data control privileges include the following:
| Role type | Privilege | Description |
|---|---|---|
Data upload | API: | Allows users to upload data to ThoughtSpot. |
Row-level-security (RLS) bypass | API: | Allows access to the following operations:
|
Custom calendars | API: | Allows creating, editing, and deleting custom Calendars. |
Data Connection | API: | Allows creating, editing, and managing connections to external data warehouses. |
Data objects | API: | Allows users to create, edit, delete, and manage Models, Tables, and Views. |
Custom variables | API: | Allows users to manage formula Variables in the current Org scope. |
The DATADOWNLOADING (Can download Data) Role privilege allows users to download data from objects such as Liveboards and Answers.
| Role type | Privilege | Description |
|---|---|---|
Data download | API: | Allows users to download data from objects such as Liveboards and Answers. |
Download visuals Early Access | API: | Allows users to download data in the PDF or PNG file format. This is an early access feature and is not enabled by default on ThoughtSpot instances. |
Data export Early Access | API: | Allows users to export data in XLSX/CSV format. This is an early access feature and is not enabled by default on ThoughtSpot instances. |
|
Important
|
|
You can create and assign Roles to a group on the Admin page of the UI or by using the REST API v1 and v2 endpoints.
| Operation type | API endpoints |
|---|---|
CRUD operations | To create, edit, and manage Role objects, use the following endpoints:
|
Role assignment to groups |
|
Object query | To get the details of Roles assigned to a group object, use the following API endpoint:
* |
| Operation type | Description |
|---|---|
CRUD operations |
|
Role assignment to groups | To assign a Role to a group object, use one of the following endpoints: |
Object query |
|
The Role privileges function in the same way as group privileges. When RBAC is enabled, the corresponding group privileges are automatically migrated to Role privileges.
For example, if a group has DATADOWNLOADING access, the DATADOWNLOADING Role privilege will be assigned to the group after RBAC is enabled. Similarly, if a group has DATAMANAGEMENT (Can manage data) access, the following Role privileges will be assigned to the group:
Can manage custom calendars (CAN_MANAGE_CUSTOM_CALENDAR)
Can create/edit Connections (CAN_CREATE_OR_EDIT_CONNECTIONS)
Can manage data models (CAN_MANAGE_WORKSHEET_VIEWS_TABLES)
For granular access, you can create a Role with required privileges and assign it to groups.
Every ThoughtSpot instance includes a built-in ALL group. All users are automatically members of this group.
When RBAC is enabled, the ALL group is assigned an ALL role. This role always grants the AUTHORING privilege, which is required for all users
and must remain assigned to the ALL group at all times.
In addition to the ALL role, the ALL group may hold other roles that grant the following privileges:
DATADOWNLOADING — Allows users to download data from answers and Liveboards.
USERDATAUPLOADING — Allows users to upload data from a local file.
These privileges are permitted on the ALL group and may be assigned through additional roles depending on your ThoughtSpot instance’s configuration.
For users who have inherited unexpected elevated privileges, follow the steps listed below to restore privileges.
|
Note
|
The ALL role is a System role. You must contact ThoughtSpot support to retrieve its GUID. |
Before you start, ensure you have:
Administrator privileges on your ThoughtSpot instance.
A valid bearer token for authentication.
Retrieve the GUID of the ALL group
Call the POST /api/rest/2.0/groups/search endpoint and filter by the group name All.
curl -X POST \
--url 'https://{ThoughtSpot-Host}/api/rest/2.0/groups/search' \
-H 'Authorization: Bearer {access-token}'\
-H 'Accept: application/json'\
-H 'Content-Type: application/json' \
--data-raw '{
"record_offset": 0,
"record_size": 10
}'From the response, locate the id field. This is the GUID of the ALL group.
[
{
"id": "<ALL-group-guid>",
"name": "All",
"display_name": "All Group",
"system_group": true,
...
}
]Retrieve the GUID of the ALL role
Contact ThoughtSpot support for retrieving the guid for the ALL role.
Restore the ALL role on the ALL group
Call the POST /api/rest/2.0/groups/{group_identifier}/update endpoint using the ALL group GUID as the path parameter.
Use REPLACE as the operation type.
This replaces the complete list of roles currently assigned to the ALL group
with only the ALL role, removing all unexpected role assignments in a single operation.
curl -X POST \
--url 'https://{ThoughtSpot-Host}/api/rest/2.0/groups/<ALL-group-guid>/update' \
-H 'Authorization: Bearer {access-token}'\
-H 'Accept: application/json'\
-H 'Content-Type: application/json' \
--data-raw '{
"role_identifiers": {
"operation": "REPLACE",
"role_identifiers": [
"<ALL-role-guid>"
]
}
}'A successful response returns an HTTP 204 status with an empty body.