Skip to navigation
Sigma REST APIAccount types

Create an account type

View as Markdown

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.
  • licenseType depends on the permissions enabled for the account type.

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.

Response

The newly created account type.
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.