How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ThoughtSpot Users API

The Users API from ThoughtSpot — 10 operation(s) for users.

ThoughtSpot Users API is one of 29 APIs that ThoughtSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.

This API exposes 10 operations across 10 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, {base-url}.

10 operations 10 paths 20 schemas 10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://my.thoughtspot.cloud/api/rest/2.0
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ThoughtSpot Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 10

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

Users 10
POST
/api/rest/2.0/users/activate
Version: 9.7.0.cl or later Activates a deactivated user account. Requires ADMINISTRATION (Can administer Thoughtspot) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.c…
activateUser body → 200400401403500
POST
/api/rest/2.0/users/change-password
Version: 9.0.0.cl or later Updates the current password of the user. Requires ADMINISTRATION (Can administer ThoughtSpot) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtsp…
changeUserPassword body → 204400401403500
POST
/api/rest/2.0/users/create
Version: 9.0.0.cl or later Creates a user in ThoughtSpot. The API endpoint allows you to configure several user properties such as email address, account status, share notification preferences, and s…
createUser body → 200400401403500
POST
/api/rest/2.0/users/deactivate
Version: 9.7.0.cl or later Deactivates a user account. Requires ADMINISTRATION (Can administer Thoughtspot) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rb…
deactivateUser body → 200400401403500
POST
/api/rest/2.0/users/{user_identifier}/delete
Version: 9.0.0.cl or later Deletes a user from the ThoughtSpot system. If you want to remove a user from a specific Org but not from ThoughtSpot, update the group and Org mapping properties of the us…
deleteUser 1 param → 204400401403500
POST
/api/rest/2.0/users/force-logout
Version: 9.0.0.cl or later Enforces logout on current user sessions. Use this API with caution as it may invalidate active user sessions and force users to re-login. Make sure you specify the usernam…
forceLogoutUsers body → 204400401403500
POST
/api/rest/2.0/users/import
Version: 9.0.0.cl or later Imports user data from external databases into ThoughtSpot. During the user import operation: If the specified users are not available in ThoughtSpot, the users are created…
importUsers body → 200400401403500
POST
/api/rest/2.0/users/reset-password
Version: 9.0.0.cl or later Resets the password of a user account. Administrators can reset password on behalf of a user. Requires ADMINISTRATION (Can administer ThoughtSpot) privilege. If [Role-Based…
resetUserPassword body → 204400401403500
POST
/api/rest/2.0/users/search
Version: 9.0.0.cl or later Gets a list of users available on the ThoughtSpot system. To get details of a specific user, specify the user GUID or name. You can also filter the API response based on gr…
searchUsers body → 200400401403500
POST
/api/rest/2.0/users/{user_identifier}/update
Version: 9.0.0.cl or later Updates the properties of a user object. You can modify user properties such as username, email, and share notification settings. You can also assign new groups and Orgs, r…
updateUser 1 param body → 204400401403500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are User (47 properties), SearchUsersRequest (21 properties), CreateUserRequest (20 properties), UpdateUserRequest (18 properties). Each schema is shown below with its type and property counts.

ImportUserType
object
2 properties 1 required
FavoriteMetadataInput
object
2 properties
ResponseActivationURL
object
The object representation with activation link.
1 property
ForceLogoutUsersRequest
object
1 property
DeactivateUserRequest
object
2 properties 2 required
UpdateUserRequest
object
18 properties
ChangeUserPasswordRequest
object
3 properties 3 required
SearchUsersRequest
object
21 properties
User
object
47 properties 4 required
SortOptions
object
Sort options.
2 properties
ResetUserPasswordRequest
object
2 properties 2 required
ActivateUserRequest
object
4 properties 3 required
ImportUsersRequest
object
4 properties 1 required
CreateUserRequest
object
20 properties 3 required
ImportUsersResponse
object
3 properties
ErrorResponse
object
1 property
Object_ID_And_Name
object
The object representation with ID and Name.
2 properties
FavoriteMetadataItem
object
3 properties 3 required
Org
object
The current Org context of the user.
2 properties 2 required
ImportUser
object
16 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thoughtspot-users-api-openapi.yml Raw ↑

Other APIs ThoughtSpot publishes across the network.

ThoughtSpot AI API
ThoughtSpot Authentication API
ThoughtSpot Collections API
ThoughtSpot Connection Configurations API
ThoughtSpot Connections API
ThoughtSpot Custom Action API
ThoughtSpot Custom Calendars API
ThoughtSpot Data API
ThoughtSpot DBT API
ThoughtSpot Email Customization API
ThoughtSpot Groups API
ThoughtSpot Input Tables API
Where this information came from

This is an independent, third-party profile of ThoughtSpot Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.