The Group APIs enable you to set or remove a privilege to or from a group or multiple groups.
Add a privilege
Use this API to add a DATADOWNLOADING or USERDATAUPLOADING privilege to the system default ALL_GROUP group. All users in the system are always a part of the ALL_GROUP group. By default, this group does not have either permission.
All the data sources which the ALL_GROUP group has permissions to are downloadable when DATADOWNLOADING is applied.
Resource URL
post /tspublic/v1/group/addprivilege
Request Parameters
| Form Parameter | Data Type | Description |
|---|---|---|
privilege |
string | Specifies a privilege type to add. Valid values are DATADOWNLOADING or USERDATAUPLOADING privilege. |
groupNames |
string | Specifies a group name to add the privilege to. Valid value is ALL_GROUP group. |
Request Example
cURL
curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' --header 'X-Requested-By: ThoughtSpot' -d 'privilege=DATADOWNLOADING&groupNames=ALL_GROUP' 'https://<instance>/callosum/v1/tspublic/v1/group/addprivilege'
Request URL
https://<instance>/callosum/v1/tspublic/v1/group/addprivilege
Response Example
Not applicable
204 - Success
Remove a privilege
Use this API to delete a DATADOWNLOADING or USERDATAUPLOADING privilege from the system default ALL_GROUPgroup.
Resource URL
post /tspublic/v1/group/removeprivilege
Request Parameters
| Form Parameter | Data Type | Description |
|---|---|---|
privilege |
string | Specifies a privilege type to delete. Valid values are DATADOWNLOADING or USERDATAUPLOADING privilege. |
groupNames |
string | Specifies a group name to delete the privilege from. Valid value is ALL_GROUP group. |
Request Example
cURL
curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' --header 'X-Requested-By: ThoughtSpot' -d 'privilege=USERDATAUPLOADING&groupNames=ALL_GROUP' 'https://<instance>/callosum/v1/tspublic/v1/group/removeprivilege'
Request URL
https://<instance>/callosum/v1/tspublic/v1/group/removeprivilege
Response Example
Not applicable
204 - Success