SIsigmacomputing
Account types

Create an account type

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.
post/v2/accountTypes

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Request body

namestring required

The name of the account type.

descriptionstring required

A description of the account type.

permissionsstring[] required

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 required

The unique identifier of the account type.

accountTypeNamestring required

The name of the account type.

descriptionstring required

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

isCustomboolean required

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

licenseTypestring required

The license type of the account type.

Changes

No recorded changes to this operation across all 1 revision of this API.