Sigma REST APIAccount types

Update account type permissions

View as Markdown
Add or remove permissions on a custom account type. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - To read or update permissions for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token. - Retrieve the **accountTypeId** by calling the [/v2/accountTypes](https://help.sigmacomputing.com/reference/list-account-types) endpoint. - For **add** and **remove**, use the permission names from the response of the [/v2/accountTypes/:accountTypeId/permissions](https://help.sigmacomputing.com/reference/list-account-type-permissions). - A permission cannot appear in both **add** and **remove**. - You cannot modify the permissions of the Admin account type. - **licenseType** depends on the permissions enabled for the account type. - **permissions** is the account type's full permission set after applying this update. ### Usage scenarios - Enable or disable specific permissions for a custom account type.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

accountTypeIdstringRequired
The unique identifier of the account type.

Request

The request body.
addlist of stringsOptional
Permissions to turn on for this account type.
removelist of stringsOptional
Permissions to turn off for this account type.

Response

The response body.
accountTypeIdstring
The unique identifier of the account type.
accountTypeNamestring
The name of the account type.
descriptionstring

A human-readable description of the permissions and capabilities provided by this account type.

isCustomboolean

Whether this is a custom account type created by the organization (true) or a default Sigma account type (false).

licenseTypestring
The license type of the account type.
permissionslist of objects
The account type's full set of permissions after applying this update.