To administer and manage Orgs, you can use the UI workflows or REST API endpoints. This article describes the REST API operations available for Org provisioning and management.
|
Important
|
The REST API v1 endpoints are deprecated and replaced with the REST API v2 endpoints. Your existing integrations with REST API v1 endpoints will continue to function without disruption until March 2027. ThoughtSpot strongly recommends migrating your integrations to the REST API v2 endpoints. |
Configure your ThoughtSpot instance as a multi-tenant cluster. If the Orgs feature is enabled on your cluster, a Primary Org is created by default, and you will be logged in to the Primary Org context.
If you do not see the Orgs feature enabled on your instance, contact ThoughtSpot Support.
Log in to your application instance as an administrator.
Create Orgs in the Admin page of the UI or via the POST /api/rest/2.0/orgs/create endpoint.
To create and manage Orgs, you must set the Org context to All. To do this, you can switch to the All Orgs tab in the Admin page of UI or pass the Org scope ALL in your API requests to Orgs API endpoints. For more information, see Org management operations.
Create users and map the users to Orgs.
You can create an administrator profile for each Org and let these Org administrators manage users, groups, and role privileges in their respective Orgs.
Note that ThoughtSpot allows provisioning groups only within the context of an Org. You must ensure that ThoughtSpot users are mapped to appropriate Orgs and the groups within these Orgs for user access control and data security.
To create an Org on a multi-tenant ThoughtSpot instance, you need cluster administrator privileges. By default, ThoughtSpot sets the administrator of the Primary Org as a cluster administrator. Only cluster administrators are allowed to perform CRUD operations on Org objects.
For Orgs CRUD operations, use the following REST API v2.0 Org endpoints:
Note the following points about Org names and descriptions:
The Org name must be unique and must not exceed 48 characters. The name can contain only letters (a-z, A-Z), digits (0-9), and hyphens (-). Spaces and other special characters are not supported.
The Org description must not exceed 124 characters.
|
Note
|
|
On a multi-tenant instance, the cluster and Org administrators can create users and associate these users to Orgs and groups within these Orgs. The cluster administrator can perform CRUD operations on Org objects at the All Orgs level and assign users, whereas the Org administrator can create users and groups within the context of their Org workspace.
|
Note
|
For REST API v2 operations, the Org context is determined based on the authentication token used by the user in their API requests. Users must log in to the appropriate Org context from which they want to send API requests. |
| Operation type | REST API v2 endpoints |
|---|---|
Authentication | Basic authentication Token-based authentication These above endpoints also support just-in-time provisioning of users to Orgs and groups. For more information, see REST API v2 authentication. |
User provisioning | To create users and assign users to one or several Orgs, use the To assign an existing user to new Orgs or remove a user from an Org, use the |
Group provisioning | To create a group in an Org, use the |
Fetching Orgs | The REST API v2 endpoints allow you to perform query operations to get Org details:
|