Sigma Computing

Sigma Computing Organizations API

The Organizations API from Sigma Computing — 4 operation(s) for organizations.

GitHub OpenAPI

Operations 7

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

PATCH /v2/organizations/settings Change the organization's timezone · Update organization settings #
Ask an LLM
“How do I set the default timezone for my Sigma organization?”
“Can I update a tenant organization's timezone through impersonation?”
Tell an agent
Set the organization timezone to {timezone}.
Update our org settings so the timezone is {timezone}.
GET /v2/organizations/settings/bulkCopy Check if members can bulk copy table data · Get the bulk copy setting for an organization #
Ask an LLM
“Are members allowed to bulk copy data out of tables?”
“Is bulk copy turned on for this organization?”
Tell an agent
Check whether bulk copy is enabled for the organization.
Tell me if users can bulk copy table data.
PATCH /v2/organizations/settings/bulkCopy Turn bulk copy on or off · Update the bulk copy setting for an organization #
Ask an LLM
“How do I stop members from bulk copying table data?”
“Can an admin re-enable bulk copy for the organization?”
Tell an agent
Set bulk copy for the organization to {enabled}.
Change whether members may bulk copy table data: {enabled}.
GET /v2/organizations/settings/licenseUpgradeRequests Check if users can request license upgrades · Get the license upgrade request setting for an organization #
Ask an LLM
“Can members of my organization request a license upgrade?”
“Is the license upgrade request option enabled?”
Tell an agent
Check whether license upgrade requests are allowed.
Tell me if members can ask for a license upgrade.
PATCH /v2/organizations/settings/licenseUpgradeRequests Allow or block license upgrade requests · Update the license upgrade request setting for an organization #
Ask an LLM
“How do I stop members from requesting license upgrades?”
“Can I let users request a higher license from inside Sigma?”
Tell an agent
Set license upgrade requests to {enabled}.
Change whether members may request license upgrades: {enabled}.
GET /v2/organizations/settings/publicEmbeds Check if public embeds are allowed · Get the public embeds setting for an organization #
Ask an LLM
“Does my organization allow workbooks to be embedded publicly?”
“Is public embedding switched on for this org?”
Tell an agent
Check whether public workbook embeds are allowed.
Tell me the organization's public embeds setting.
PATCH /v2/organizations/settings/publicEmbeds Allow or block public workbook embeds · Update the public embeds setting for an organization #
Ask an LLM
“How do I disable public embedding of workbooks?”
“Can an admin turn public embeds back on?”
Tell an agent
Set public workbook embeds to {enabled}.
Change whether workbooks may be embedded publicly: {enabled}.

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-organizations-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-organizations-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-organizations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sigma Computing Organizations API
  version: '1.0'
  description: 'Operations tagged organizations 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: Organizations
paths:
  /v2/organizations/settings:
    patch:
      summary: Update organization settings
      description: 'Update settings for the organization associated with the API credentials.


        ### Usage notes

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

        - To update settings for a tenant organization, use impersonation to obtain a token for that tenant, then call this endpoint with that token.'
      parameters: []
      operationId: updateOrganizationSettings
      requestBody:
        description: The request body.
        content:
          application/json:
            schema:
              type: object
              properties:
                timezone:
                  type: string
                  description: IANA timezone identifier for the organization (e.g. "America/New_York").
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - organizationId
                  properties:
                    organizationId:
                      type: string
                      description: Unique identifier of the organization
                - type: object
                  properties:
                    timezone:
                      type: string
                      description: Current IANA timezone for the organization
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - Organizations
      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/organizations/settings/bulkCopy:
    get:
      operationId: getBulkCopySetting
      summary: Get the bulk copy setting for an organization
      description: 'Check whether members of the organization can bulk copy data from tables.

        ### Usage notes

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

        - To read or update settings for a tenant organization, use impersonation to obtain a token for that tenant, then call this endpoint with that token.'
      tags:
      - Organizations
      parameters:
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizations_getBulkCopySetting_Response_200'
    patch:
      operationId: updateBulkCopySetting
      summary: Update the bulk copy setting for an organization
      description: 'Set whether members of the organization can bulk copy data from tables.

        ### Usage notes

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

        - To read or update settings for a tenant organization, use impersonation to obtain a token for that tenant, then call this endpoint with that token.'
      tags:
      - Organizations
      parameters:
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizations_updateBulkCopySetting_Response_200'
      requestBody:
        description: The request body.
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Whether the setting is enabled for the organization.
              required:
              - enabled
    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/organizations/settings/licenseUpgradeRequests:
    get:
      operationId: getLicenseUpgradeRequestsSetting
      summary: Get the license upgrade request setting for an organization
      description: 'Check whether members of the organization can request a license upgrade.

        ### Usage notes

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

        - To read or update settings for a tenant organization, use impersonation to obtain a token for that tenant, then call this endpoint with that token.'
      tags:
      - Organizations
      parameters:
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizations_getLicenseUpgradeRequestsSetting_Response_200'
    patch:
      operationId: updateLicenseUpgradeRequestsSetting
      summary: Update the license upgrade request setting for an organization
      description: 'Set whether members of the organization can request a license upgrade.

        ### Usage notes

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

        - To read or update settings for a tenant organization, use impersonation to obtain a token for that tenant, then call this endpoint with that token.'
      tags:
      - Organizations
      parameters:
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizations_updateLicenseUpgradeRequestsSetting_Response_200'
      requestBody:
        description: The request body.
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Whether the setting is enabled for the organization.
              required:
              - enabled
    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/organizations/settings/publicEmbeds:
    get:
      operationId: getPublicEmbedsSetting
      summary: Get the public embeds setting for an organization
      description: 'Check whether the organization allows workbooks to be embedded publicly.

        ### Usage notes

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

        - To read or update settings for a tenant organization, use impersonation to obtain a token for that tenant, then call this endpoint with that token.'
      tags:
      - Organizations
      parameters:
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizations_getPublicEmbedsSetting_Response_200'
    patch:
      operationId: updatePublicEmbedsSetting
      summary: Update the public embeds setting for an organization
      description: 'Set whether the organization allows workbooks to be embedded publicly.

        ### Usage notes

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

        - To read or update settings for a tenant organization, use impersonation to obtain a token for that tenant, then call this endpoint with that token.'
      tags:
      - Organizations
      parameters:
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizations_updatePublicEmbedsSetting_Response_200'
      requestBody:
        description: The request body.
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Whether the setting is enabled for the organization.
              required:
              - enabled
    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:
    organizations_updateLicenseUpgradeRequestsSetting_Response_200:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the setting is enabled for the organization.
      required:
      - enabled
      title: organizations_updateLicenseUpgradeRequestsSetting_Response_200
    organizations_updatePublicEmbedsSetting_Response_200:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the setting is enabled for the organization.
      required:
      - enabled
      title: organizations_updatePublicEmbedsSetting_Response_200
    organizations_updateOrganizationSettings_Response_200:
      type: object
      properties:
        organizationId:
          type: string
          description: Unique identifier of the organization
        timezone:
          type: string
          description: Current IANA timezone for the organization
      required:
      - organizationId
      title: organizations_updateOrganizationSettings_Response_200
    organizations_updateBulkCopySetting_Response_200:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the setting is enabled for the organization.
      required:
      - enabled
      title: organizations_updateBulkCopySetting_Response_200
    organizations_getBulkCopySetting_Response_200:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the setting is enabled for the organization.
      required:
      - enabled
      title: organizations_getBulkCopySetting_Response_200
    organizations_getLicenseUpgradeRequestsSetting_Response_200:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the setting is enabled for the organization.
      required:
      - enabled
      title: organizations_getLicenseUpgradeRequestsSetting_Response_200
    organizations_getPublicEmbedsSetting_Response_200:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the setting is enabled for the organization.
      required:
      - enabled
      title: organizations_getPublicEmbedsSetting_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