Create an account type

POST

/v2/accountTypes

Create a custom account type with specified permissions.

Usage notes

To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
Use the permission names from the /v2/accountTypes/:accountTypeId/permissions endpoint.

Usage scenarios

Create custom account types to define specific permission sets for your organization’s users.

Create a custom account type with specified permissions. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Use the permission names from the [/v2/accountTypes/:accountTypeId/permissions](https://help.sigmacomputing.com/reference/list-account-type-permissions) endpoint. ### Usage scenarios - Create custom account types to define specific permission sets for your organization's users.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.

namestringRequired

The name of the account type.

descriptionstringRequired

A description of the account type.

permissionslist of stringsRequired

An array of permissions to enable for this account type. Use the permission names from the /v2/accountTypes/:accountTypeId/permissions endpoint.

An array of permissions to enable for this account type. Use the permission names from the [/v2/accountTypes/:accountTypeId/permissions](https://help.sigmacomputing.com/reference/list-account-type-permissions) endpoint.

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).

$	curl -X POST https://api.sigmacomputing.com/v2/accountTypes \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Data Analyst",
>	"description": "Custom account type with permissions tailored for data analysts to view and analyze datasets.",
>	"permissions": [
>	"view_datasets",
>	"create_reports",
>	"export_data"
>	]
>	}'

1	{
2	"accountTypeId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3	"accountTypeName": "Data Analyst",
4	"description": "Custom account type with permissions tailored for data analysts to view and analyze datasets.",
5	"isCustom": true
6	}