Sigma Computing

Sigma Computing Account Types API

The Account Types API from Sigma Computing — 3 operation(s) for account types.

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/accountTypes List account types · List account types #
Ask an LLM
“What account types exist in my Sigma organization?”
“How do I get account type IDs to look up their permissions?”
Tell an agent
List all account types.
List account types, {pageSize} per page.
POST /v2/accountTypes Create a custom account type · Create an account type #
Ask an LLM
“How do I create a custom account type with specific permissions?”
“Who is allowed to create new account types?”
Tell an agent
Create account type {name} described as {description} with permissions {permissions}.
Add a custom role {name} ({description}) granting {permissions}.
DELETE /v2/accountTypes/{accountTypeId} Delete a custom account type · Delete an account type #
Ask an LLM
“Can default Sigma account types be deleted?”
“What happens to users on an account type I delete?”
Tell an agent destructive · confirm first
Delete account type {accountTypeId}.
Delete account type {accountTypeId} and move its users to {reassignToAccountTypeId}.
GET /v2/accountTypes/{accountTypeId}/permissions List an account type's permissions · List account type permissions #
Ask an LLM
“Which feature permissions does an account type grant?”
“How do I compare what two account types are allowed to do?”
Tell an agent
List permissions for account type {accountTypeId}.
Show which features account type {accountTypeId} can use.

Documentation

📖
Documentation
https://help.sigmacomputing.com/docs/get-started-with-sigmas-api
📖
APIReference
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
GettingStarted
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/authentication/sigma-computing-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/rate-limits/sigma-computing-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-account-types-api-openapi.yml

Other Resources

🔗
Examples
https://help.sigmacomputing.com/recipes
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/scopes/sigma-computing-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conventions/sigma-computing-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/errors/sigma-computing-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/data-model/sigma-computing-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/asyncapi/sigma-computing-webhooks.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conformance/sigma-computing-conformance.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/lifecycle/sigma-computing-lifecycle.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sigma-computing:sigma-computing-account-types-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sigma-computing-account-types-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sigma Computing Account Types API
  version: '1.0'
  description: 'Operations tagged accountTypes across 2 of this provider''s published API definitions: sigma-computing-public-rest-api-openapi.json, sigma-computing-rest-api-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sigmacomputing.com
  description: Server for GCP (US) hosted organizations
- url: https://api.sa.gcp.sigmacomputing.com
  description: Server for GCP (KSA) hosted organizations
- url: https://aws-api.sigmacomputing.com
  description: Server for AWS US (West) hosted organizations
- url: https://api.us-a.aws.sigmacomputing.com
  description: Server for AWS US (East) hosted organizations
- url: https://api.ca.aws.sigmacomputing.com
  description: Server for AWS Canada hosted organizations
- url: https://api.eu.aws.sigmacomputing.com
  description: Server for AWS Europe hosted organizations
- url: https://api.au.aws.sigmacomputing.com
  description: Server for AWS Australia and APAC hosted organizations
- url: https://api.uk.aws.sigmacomputing.com
  description: Server for AWS UK hosted organizations
- url: https://api.us.azure.sigmacomputing.com
  description: Server for Azure US hosted organizations
- url: https://api.eu.azure.sigmacomputing.com
  description: Server for Azure Europe hosted organizations
- url: https://api.ca.azure.sigmacomputing.com
  description: Server for Azure Canada hosted organizations
- url: https://api.uk.azure.sigmacomputing.com
  description: Server for Azure United Kingdom hosted organizations
- url: https://api.au.azure.sigmacomputing.com
  description: Server for Azure Australia hosted organizations
tags:
- name: Account Types
paths:
  /v2/accountTypes:
    get:
      summary: List account types
      description: 'Returns a list of all account types available in the organization.


        ### Usage notes

        - Use the **accountTypeId** with the /v2/accountTypes/:accountTypeId/permissions endpoint to retrieve more detailed permissions.

        - To perform this operation, you must use API credentials owned by a user assigned the Admin account type.


        ### Usage scenarios

        - Display available account types in an admin interface.

        - Show an overview of account types for management.'
      parameters:
      - name: pageToken
        schema:
          type: string
          description: Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.
          title: Page token
        in: query
      - name: pageSize
        schema:
          type: integer
          description: Number of results to return per page, with a maximum of 1000. Defaults to 50.
          title: Page size
        in: query
      operationId: listAccountTypes
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - entries
                  properties:
                    entries:
                      type: array
                      items:
                        type: object
                        required:
                        - accountTypeId
                        - accountTypeName
                        - description
                        - isCustom
                        properties:
                          accountTypeId:
                            type: string
                            description: The unique identifier of the account type.
                          accountTypeName:
                            type: string
                            description: The name of the account type.
                          description:
                            type: string
                            description: A human-readable description of the permissions and capabilities provided by this account type.
                          isCustom:
                            type: boolean
                            description: Whether this is a custom account type created by the organization (true) or a default Sigma account type (false).
                      description: Array of results returned by the endpoint
                      title: Result entries
                - type: object
                  properties:
                    nextPageToken:
                      type: string
                      description: 'A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.

                        **Must be treated as an opaque string.**'
                      title: Next page token
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - Account Types
      security:
      - oauth2: []
    post:
      summary: Create an account type
      description: '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.'
      parameters: []
      operationId: createAccountType
      requestBody:
        description: The request body.
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - description
              - permissions
              properties:
                name:
                  type: string
                  description: The name of the account type.
                description:
                  type: string
                  description: A description of the account type.
                permissions:
                  type: array
                  items:
                    type: string
                  description: 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.
      responses:
        '201':
          description: The response body.
          content:
            application/json:
              schema:
                type: object
                required:
                - accountTypeId
                - accountTypeName
                - description
                - isCustom
                properties:
                  accountTypeId:
                    type: string
                    description: The unique identifier of the account type.
                  accountTypeName:
                    type: string
                    description: The name of the account type.
                  description:
                    type: string
                    description: A human-readable description of the permissions and capabilities provided by this account type.
                  isCustom:
                    type: boolean
                    description: Whether this is a custom account type created by the organization (true) or a default Sigma account type (false).
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - Account Types
      security:
      - oauth2: []
    servers:
    - url: https://api.sigmacomputing.com
      description: Server for GCP (US) hosted organizations
    - url: https://api.sa.gcp.sigmacomputing.com
      description: Server for GCP (KSA) hosted organizations
    - url: https://aws-api.sigmacomputing.com
      description: Server for AWS US (West) hosted organizations
    - url: https://api.us-a.aws.sigmacomputing.com
      description: Server for AWS US (East) hosted organizations
    - url: https://api.ca.aws.sigmacomputing.com
      description: Server for AWS Canada hosted organizations
    - url: https://api.eu.aws.sigmacomputing.com
      description: Server for AWS Europe hosted organizations
    - url: https://api.au.aws.sigmacomputing.com
      description: Server for AWS Australia and APAC hosted organizations
    - url: https://api.uk.aws.sigmacomputing.com
      description: Server for AWS UK hosted organizations
    - url: https://api.us.azure.sigmacomputing.com
      description: Server for Azure US hosted organizations
    - url: https://api.eu.azure.sigmacomputing.com
      description: Server for Azure Europe hosted organizations
    - url: https://api.ca.azure.sigmacomputing.com
      description: Server for Azure Canada hosted organizations
    - url: https://api.uk.azure.sigmacomputing.com
      description: Server for Azure United Kingdom hosted organizations
    - url: https://api.au.azure.sigmacomputing.com
      description: Server for Azure Australia hosted organizations
  /v2/accountTypes/{accountTypeId}:
    delete:
      summary: Delete an account type
      description: 'Delete a custom account type and reassign its users to another account type.


        ### Usage notes

        - To perform this operation, you must use API credentials owned by a user assigned the Admin account type.

        - Default Sigma account types cannot be deleted.

        - All users assigned to the deleted account type will be reassigned to the specified **reassignToAccountTypeId**.

        - Retrieve account type IDs by calling the /v2/accountTypes endpoint.


        ### Usage scenarios

        - Remove custom account types that are no longer needed.

        - Consolidate account types by moving users to a different account type before deletion.'
      parameters:
      - name: accountTypeId
        schema:
          type: string
          description: The unique identifier of the account type to delete.
        in: path
        required: true
      - name: reassignToAccountTypeId
        schema:
          type: string
          description: The unique identifier of the account type to reassign users to. Users currently assigned the deleted account type will be reassigned this account type.
        in: query
      operationId: deleteAccountType
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                type: object
                properties: {}
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - Account Types
      security:
      - oauth2: []
    servers:
    - url: https://api.sigmacomputing.com
      description: Server for GCP (US) hosted organizations
    - url: https://api.sa.gcp.sigmacomputing.com
      description: Server for GCP (KSA) hosted organizations
    - url: https://aws-api.sigmacomputing.com
      description: Server for AWS US (West) hosted organizations
    - url: https://api.us-a.aws.sigmacomputing.com
      description: Server for AWS US (East) hosted organizations
    - url: https://api.ca.aws.sigmacomputing.com
      description: Server for AWS Canada hosted organizations
    - url: https://api.eu.aws.sigmacomputing.com
      description: Server for AWS Europe hosted organizations
    - url: https://api.au.aws.sigmacomputing.com
      description: Server for AWS Australia and APAC hosted organizations
    - url: https://api.uk.aws.sigmacomputing.com
      description: Server for AWS UK hosted organizations
    - url: https://api.us.azure.sigmacomputing.com
      description: Server for Azure US hosted organizations
    - url: https://api.eu.azure.sigmacomputing.com
      description: Server for Azure Europe hosted organizations
    - url: https://api.ca.azure.sigmacomputing.com
      description: Server for Azure Canada hosted organizations
    - url: https://api.uk.azure.sigmacomputing.com
      description: Server for Azure United Kingdom hosted organizations
    - url: https://api.au.azure.sigmacomputing.com
      description: Server for Azure Australia hosted organizations
  /v2/accountTypes/{accountTypeId}/permissions:
    get:
      summary: List account type permissions
      description: '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.'
      parameters:
      - name: accountTypeId
        schema:
          type: string
          description: The unique identifier of the account type.
        in: path
        required: true
      operationId: listAccountTypePermissions
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  required:
                  - permission
                  - description
                  properties:
                    permission:
                      type: string
                      description: The permission name. For example, "view-worksheet".
                    description:
                      type: string
                      description: A human-readable description of what this permission allows.
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - Account Types
      security:
      - oauth2: []
    servers:
    - url: https://api.sigmacomputing.com
      description: Server for GCP (US) hosted organizations
    - url: https://api.sa.gcp.sigmacomputing.com
      description: Server for GCP (KSA) hosted organizations
    - url: https://aws-api.sigmacomputing.com
      description: Server for AWS US (West) hosted organizations
    - url: https://api.us-a.aws.sigmacomputing.com
      description: Server for AWS US (East) hosted organizations
    - url: https://api.ca.aws.sigmacomputing.com
      description: Server for AWS Canada hosted organizations
    - url: https://api.eu.aws.sigmacomputing.com
      description: Server for AWS Europe hosted organizations
    - url: https://api.au.aws.sigmacomputing.com
      description: Server for AWS Australia and APAC hosted organizations
    - url: https://api.uk.aws.sigmacomputing.com
      description: Server for AWS UK hosted organizations
    - url: https://api.us.azure.sigmacomputing.com
      description: Server for Azure US hosted organizations
    - url: https://api.eu.azure.sigmacomputing.com
      description: Server for Azure Europe hosted organizations
    - url: https://api.ca.azure.sigmacomputing.com
      description: Server for Azure Canada hosted organizations
    - url: https://api.uk.azure.sigmacomputing.com
      description: Server for Azure United Kingdom hosted organizations
    - url: https://api.au.azure.sigmacomputing.com
      description: Server for Azure Australia hosted organizations
components:
  responses:
    ApiError:
      description: Sigma API Error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              requestId:
                type: string
  schemas:
    V2AccountTypesGetResponsesContentApplicationJsonSchemaEntriesItems:
      type: object
      properties:
        accountTypeId:
          type: string
          description: The unique identifier of the account type.
        accountTypeName:
          type: string
          description: The name of the account type.
        description:
          type: string
          description: A human-readable description of the permissions and capabilities provided by this account type.
        isCustom:
          type: boolean
          description: Whether this is a custom account type created by the organization (true) or a default Sigma account type (false).
      required:
      - accountTypeId
      - accountTypeName
      - description
      - isCustom
      title: V2AccountTypesGetResponsesContentApplicationJsonSchemaEntriesItems
    accountTypes_createAccountType_Response_201:
      type: object
      properties:
        accountTypeId:
          type: string
          description: The unique identifier of the account type.
        accountTypeName:
          type: string
          description: The name of the account type.
        description:
          type: string
          description: A human-readable description of the permissions and capabilities provided by this account type.
        isCustom:
          type: boolean
          description: Whether this is a custom account type created by the organization (true) or a default Sigma account type (false).
      required:
      - accountTypeId
      - accountTypeName
      - description
      - isCustom
      title: accountTypes_createAccountType_Response_201
    V2AccountTypesAccountTypeIdPermissionsGetResponsesContentApplicationJsonSchemaItems:
      type: object
      properties:
        permission:
          type: string
          description: The permission name. For example, "view-worksheet".
        description:
          type: string
          description: A human-readable description of what this permission allows.
      required:
      - permission
      - description
      title: V2AccountTypesAccountTypeIdPermissionsGetResponsesContentApplicationJsonSchemaItems
    accountTypes_listAccountTypes_Response_200:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/V2AccountTypesGetResponsesContentApplicationJsonSchemaEntriesItems'
          description: Array of results returned by the endpoint
        nextPageToken:
          type: string
          description: 'A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.

            **Must be treated as an opaque string.**'
      required:
      - entries
      title: accountTypes_listAccountTypes_Response_200
    accountTypes_deleteAccountType_Response_200:
      type: object
      properties: {}
      title: accountTypes_deleteAccountType_Response_200
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /v2/auth/token
          refreshUrl: /v2/auth/token
          scopes: {}
    OAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 authentication
x-refined-from:
- sigma-computing-public-rest-api-openapi.json
- sigma-computing-rest-api-openapi.yaml