{
"opencollection": "1.0.0",
"info": {
"name": "ThoughtSpot Public REST 10.1.0.cl Users API",
"version": "2.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Users",
"type": "folder"
},
"items": [
{
"info": {
"name": "activateUser",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/users/activate",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.7.0.cl or later\n\nActivates a deactivated user account.\n\nRequires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\nTo activate an inactive user account, the API request body must include the following information:\n\n- Username or the GUID of the user acco"
},
{
"info": {
"name": "changeUserPassword",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/users/change-password",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.0.0.cl or later\n\nUpdates the current password of the user.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n"
},
{
"info": {
"name": "createUser",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/users/create",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.0.0.cl or later\n\nCreates a user in ThoughtSpot.\n\nThe API endpoint allows you to configure several user properties such as email address, account status, share notification preferences, and sharing visibility. You can provision the user to [groups](https://docs.thoughtspot.com/cloud/latest/groups-privileges) and [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview). You can also add Liveboard, Answer, and Worksheet objects to the user’s f"
},
{
"info": {
"name": "deactivateUser",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/users/deactivate",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.7.0.cl or later\n\nDeactivates a user account.\n\nRequires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\nTo deactivate a user account, the API request body must include the following information:\n\n- Username or the GUID of the user account\n- Base URL of "
},
{
"info": {
"name": "deleteUser",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/users/:user_identifier/delete",
"params": [
{
"name": "user_identifier",
"value": "",
"type": "path",
"description": "GUID / name of the user"
}
]
},
"docs": "\n Version: 9.0.0.cl or later\n\nDeletes a user from the ThoughtSpot system.\n\nIf you want to remove a user from a specific Org but not from ThoughtSpot, update the group and Org mapping properties of the user object via a POST API call to the [/api/rest/2.0/users/{user_identifier}/update](#/http/api-endpoints/users/update-user) endpoint.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers"
},
{
"info": {
"name": "forceLogoutUsers",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/users/force-logout",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.0.0.cl or later\n\nEnforces logout on current user sessions. \n\nUse this API with caution as it may invalidate active user sessions and force users to re-login. Make sure you specify the usernames or GUIDs. If you pass null values in the API call, all user sessions on your cluster become invalid, and the users are forced to re-login.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://"
},
{
"info": {
"name": "importUsers",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/users/import",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.0.0.cl or later\n\nImports user data from external databases into ThoughtSpot. During the user import operation:\n\n* If the specified users are not available in ThoughtSpot, the users are created and assigned a default password. Defining a `default_password` in the API request is optional.\n* If `delete_unspecified_users` is set to `true`, the users not specified in the API request, excluding the `tsadmin`, `guest`, `system` and `su` users, are delete"
},
{
"info": {
"name": "resetUserPassword",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/users/reset-password",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.0.0.cl or later\n\nResets the password of a user account. Administrators can reset password on behalf of a user.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n"
},
{
"info": {
"name": "searchUsers",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/users/search",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.0.0.cl or later\n\nGets a list of users available on the ThoughtSpot system.\n\nTo get details of a specific user, specify the user GUID or name. You can also filter the API response based on groups, Org ID, user visibility, account status, user type, and user preference settings and favorites.\n\nAvailable to all users. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view all users properties. If [Role-Based Access Control ("
},
{
"info": {
"name": "updateUser",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/users/:user_identifier/update",
"params": [
{
"name": "user_identifier",
"value": "",
"type": "path",
"description": "GUID / name of the user"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.0.0.cl or later\n\nUpdates the properties of a user object.\n\nYou can modify user properties such as username, email, and share notification settings. You can also assign new groups and Orgs, remove the user from a group or Org, reset password, and modify user preferences.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instan"
}
]
}
],
"bundled": true
}