List account type permissions

GET

/v2/accountTypes/:accountTypeId/permissions

GET

/v2/accountTypes/:accountTypeId/permissions

$ curl https://api.sigmacomputing.com/v2/accountTypes/accountTypeId/permissions \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 [
2   {
3     "permission": "view-worksheet",
4     "description": "Allows the user to view worksheets and their data."
5   },
6   {
7     "permission": "edit-dataset",
8     "description": "Grants the ability to modify datasets and their schema."
9   },
10   {
11     "permission": "manage-users",
12     "description": "Enables management of user accounts and permissions."
13   },
14   {
15     "permission": "create-workbook",
16     "description": "Permits creation of new workbooks and reports."
17   },
18   {
19     "permission": "export-data",
20     "description": "Allows exporting data from Sigma in various formats."
21   }
22 ]

Returns all feature permissions for a specific account type.

Usage notes

Retrieve the accountTypeId by calling the /v2/accountTypes endpoint.
To perform this operation, you must use API credentials owned by a user assigned the Admin account type.

Usage scenarios

Display permission details in an admin interface.
Validate user capabilities based on account type.
Compare permissions across different account types.

Returns all feature permissions for a specific account type. ### Usage notes - Retrieve the **accountTypeId** by calling the [/v2/accountTypes](https://help.sigmacomputing.com/reference/list-account-types) endpoint. - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. ### Usage scenarios - Display permission details in an admin interface. - Validate user capabilities based on account type. - Compare permissions across different account types.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

accountTypeIdstringRequired

Response

The response body.

permissionstring

The permission name. For example, “view-worksheet”.

descriptionstring

A human-readable description of what this permission allows.