Sigma Computing Members API

openapi: 3.2.0
info:
  title: Sigma Computing Members API
  version: '1.0'
  description: 'Operations tagged members 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: members
paths:
  /v2/members:
    get:
      summary: List members
      description: "\n  **Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request.\n\n  List all users in Sigma.\n\n  ### Usage notes\n  - Filter your results using the `email` query parameter.\n  - If using `email` to filter by email address, you must URL encode the \"@\" character as `%40`.\n  - **[Deprecated]** Using the `search` parameter is deprecated. If using `search` to filter by email address, you must URL encode the \"@\" character as `%40`.\n  - Using `email` and `search` together is not supported.\n  "
      parameters:
      - name: page
        schema:
          type: string
          description: Use to specify further pages using the string returned in the nextPage portion of the response.
          title: Page
        in: query
      - name: limit
        schema:
          type: number
          description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.
          title: Limit
        in: query
      - name: search
        schema:
          type: string
          description: '**[Deprecated]** Use the `email` query parameter instead.'
        in: query
      - name: email
        schema:
          type: string
          description: Filter by email address. You must URL encode the "@" character as `%40`.
        in: query
      - name: includeArchived
        schema:
          type: boolean
        in: query
      - name: includeInactive
        schema:
          type: boolean
        in: query
      operationId: listMembers
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                oneOf:
                - type: array
                  items:
                    allOf:
                    - type: object
                      required:
                      - organizationId
                      - memberId
                      - memberType
                      - firstName
                      - lastName
                      - email
                      - profileImgUrl
                      - createdBy
                      - updatedBy
                      - createdAt
                      - updatedAt
                      - homeFolderId
                      - userKind
                      properties:
                        organizationId:
                          type: string
                        memberId:
                          type: string
                        memberType:
                          type: string
                        firstName:
                          type: string
                        lastName:
                          type: string
                        email:
                          type: string
                        profileImgUrl:
                          type:
                          - string
                          - 'null'
                        createdBy:
                          type: string
                        updatedBy:
                          type: string
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                        homeFolderId:
                          type: string
                          description: ID of the My Documents folder for the user
                        userKind:
                          type: string
                    - type: object
                      properties:
                        isArchived:
                          type: boolean
                          description: Whether a user is deactivated in Sigma.
                        isInactive:
                          type: boolean
                          description: Whether a user is archived by SCIM.
                - type: object
                  required:
                  - entries
                  - nextPage
                  properties:
                    entries:
                      type: array
                      items:
                        allOf:
                        - type: object
                          required:
                          - organizationId
                          - memberId
                          - memberType
                          - firstName
                          - lastName
                          - email
                          - profileImgUrl
                          - createdBy
                          - updatedBy
                          - createdAt
                          - updatedAt
                          - homeFolderId
                          - userKind
                          properties:
                            organizationId:
                              type: string
                            memberId:
                              type: string
                            memberType:
                              type: string
                            firstName:
                              type: string
                            lastName:
                              type: string
                            email:
                              type: string
                            profileImgUrl:
                              type:
                              - string
                              - 'null'
                            createdBy:
                              type: string
                            updatedBy:
                              type: string
                            createdAt:
                              type: string
                              format: date-time
                            updatedAt:
                              type: string
                              format: date-time
                            homeFolderId:
                              type: string
                              description: ID of the My Documents folder for the user
                            userKind:
                              type: string
                        - type: object
                          properties:
                            isArchived:
                              type: boolean
                              description: Whether a user is deactivated in Sigma.
                            isInactive:
                              type: boolean
                              description: Whether a user is archived by SCIM.
                    nextPage:
                      type:
                      - string
                      - 'null'
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - members
      security:
      - oauth2: []
    post:
      summary: Create a member
      description: "Create a user.\n\n  ### Usage notes\n  - Creating a user with this endpoint sends an email invitation to the user. Embed users are not sent email invitations.\n  - Review the account types returned by the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint to understand the format of the **memberType** string.\n  - If **memberType** is omitted, the organization's Invitation default account type (configured in Admin > Account types) is used. If no Invitation default is configured, a built-in default account type is used.\n  - Retrieve the **teamId**(s) by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoints.\n    "
      parameters:
      - name: sendInvite
        schema:
          type: boolean
          description: Whether to send an email invitation for non-embed users. If not included, an email is sent
          title: Send Invite
        in: query
      operationId: createMember
      requestBody:
        description: The request body.
        content:
          application/json:
            schema:
              allOf:
              - type: object
                required:
                - email
                - firstName
                - lastName
                properties:
                  email:
                    type: string
                    format: email
                  firstName:
                    type: string
                  lastName:
                    type: string
              - type: object
                properties:
                  memberType:
                    type: string
                    description: Account type
                  isGuest:
                    type: boolean
                  userKind:
                    type: string
                    enum:
                    - internal
                    - guest
                    - embed
                  addToTeams:
                    type: array
                    items:
                      allOf:
                      - type: object
                        required:
                        - teamId
                        properties:
                          teamId:
                            type: string
                      - type: object
                        properties:
                          isTeamAdmin:
                            type: boolean
                        description: Whether to set the user as an admin for this team.
                    description: Add user to one or more teams.
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - organizationId
                  - memberId
                  - memberType
                  - firstName
                  - lastName
                  - email
                  - profileImgUrl
                  - createdBy
                  - updatedBy
                  - createdAt
                  - updatedAt
                  - homeFolderId
                  - userKind
                  properties:
                    organizationId:
                      type: string
                    memberId:
                      type: string
                    memberType:
                      type: string
                    firstName:
                      type: string
                    lastName:
                      type: string
                    email:
                      type: string
                    profileImgUrl:
                      type:
                      - string
                      - 'null'
                    createdBy:
                      type: string
                    updatedBy:
                      type: string
                    createdAt:
                      type: string
                      format: date-time
                    updatedAt:
                      type: string
                      format: date-time
                    homeFolderId:
                      type: string
                      description: ID of the My Documents folder for the user
                    userKind:
                      type: string
                - type: object
                  properties:
                    isArchived:
                      type: boolean
                      description: Whether a user is deactivated in Sigma.
                    isInactive:
                      type: boolean
                      description: Whether a user is archived by SCIM.
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - members
      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/members/{memberId}:
    get:
      summary: Get member
      description: "Returns a specific user by member ID.\n\n### Usage notes\n- Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n  "
      parameters:
      - name: memberId
        schema:
          type: string
        in: path
        required: true
      operationId: getMember
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - organizationId
                  - memberId
                  - memberType
                  - firstName
                  - lastName
                  - email
                  - profileImgUrl
                  - createdBy
                  - updatedBy
                  - createdAt
                  - updatedAt
                  - homeFolderId
                  - userKind
                  properties:
                    organizationId:
                      type: string
                    memberId:
                      type: string
                    memberType:
                      type: string
                    firstName:
                      type: string
                    lastName:
                      type: string
                    email:
                      type: string
                    profileImgUrl:
                      type:
                      - string
                      - 'null'
                    createdBy:
                      type: string
                    updatedBy:
                      type: string
                    createdAt:
                      type: string
                      format: date-time
                    updatedAt:
                      type: string
                      format: date-time
                    homeFolderId:
                      type: string
                      description: ID of the My Documents folder for the user
                    userKind:
                      type: string
                - type: object
                  properties:
                    isArchived:
                      type: boolean
                      description: Whether a user is deactivated in Sigma.
                    isInactive:
                      type: boolean
                      description: Whether a user is archived by SCIM.
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - members
      security:
      - oauth2: []
    patch:
      summary: Update member
      description: "Update a specific user by memberId.\n\n  ### Usage notes\n  - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n  - Review the account types returned by the same endpoint to understand the format of the **memberType** string.\n  - To deactivate a user and reassign their documents to a specific user, set  `newOwnerId`to the user ID of the desired document owner, and `isArchived` to `True`. For more details, see [Deactivate a user](/docs/deactivate-users).\n    "
      parameters:
      - name: memberId
        schema:
          type: string
        in: path
        required: true
      operationId: updateMember
      requestBody:
        description: The request body.
        content:
          application/json:
            schema:
              type: object
              properties:
                memberType:
                  type: string
                  description: Account type
                firstName:
                  type: string
                lastName:
                  type: string
                profileImgUrl:
                  type:
                  - string
                  - 'null'
                email:
                  type: string
                isArchived:
                  type: boolean
                  description: Whether to deactivate a user in Sigma.
                isInactive:
                  type: boolean
                  description: Whether to archive a user with SCIM.
                userKind:
                  type: string
                  enum:
                  - internal
                  - guest
                  - embed
                newOwnerId:
                  type: string
                archiveDocuments:
                  type: boolean
                  description: Archive a user's documents instead of transferring them. Can only be used if either `isArchived` or `isInactive` is set to `true`. Also archives scheduled exports.
                archiveScheduledExports:
                  type: boolean
                  description: Archive a user's scheduled exports instead of transferring them. Can only be used if either `isArchived` or `isInactive` is set to `true`
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - organizationId
                  - memberId
                  - memberType
                  - firstName
                  - lastName
                  - email
                  - profileImgUrl
                  - createdBy
                  - updatedBy
                  - createdAt
                  - updatedAt
                  - homeFolderId
                  - userKind
                  properties:
                    organizationId:
                      type: string
                    memberId:
                      type: string
                    memberType:
                      type: string
                    firstName:
                      type: string
                    lastName:
                      type: string
                    email:
                      type: string
                    profileImgUrl:
                      type:
                      - string
                      - 'null'
                    createdBy:
                      type: string
                    updatedBy:
                      type: string
                    createdAt:
                      type: string
                      format: date-time
                    updatedAt:
                      type: string
                      format: date-time
                    homeFolderId:
                      type: string
                      description: ID of the My Documents folder for the user
                    userKind:
                      type: string
                - type: object
                  properties:
                    isArchived:
                      type: boolean
                      description: Whether a user is deactivated in Sigma.
                    isInactive:
                      type: boolean
                      description: Whether a user is archived by SCIM.
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - members
      security:
      - oauth2: []
    delete:
      summary: Deactivate member
      description: "Deactivate a specific user by memberId. Users cannot be fully deleted, only deactivated. The deactivated user's documents are reassigned to the user associated with the API client credentials. For more information, see [Deactivate users](/docs/deactivate-users).\n\n### Usage notes\n- Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n- The user is directly marked **archived** by this API. See [Deactivate users](/docs/deactivate-users) for more details on deactivation.\n\n### Usage scenarios\n- **User offboarding**: Manage your user base by efficiently offboarding users after they leave your organization.\n\n### Best practices\n- **Confirm memberId**: Before deactivating a user, make sure the memberId is correct.\n- Do **not** use this for members provisioned through SCIM.\n  "
      parameters:
      - name: memberId
        schema:
          type: string
        in: path
        required: true
      operationId: deleteMember
      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:
      - members
      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/members/{memberId}/files:
    get:
      summary: List member files
      description: "List all documents and folders accessible to a specific user.\n\n  ### Usage notes\n  - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n  - Filter to documents with specific permissions granted on them, or to specific types of documents like workbooks, workbook templates, data models, datasets (deprecated), reports, workspaces, database tables, and others.\n    "
      parameters:
      - name: memberId
        schema:
          type: string
        in: path
        required: true
      - name: name
        schema:
          type: string
        in: query
      - name: permissionFilter
        schema:
          oneOf:
          - type: string
            enum:
            - view
            - explore
            - edit
            description: ''
            title: Workbook Permission
          - type: string
            enum:
            - view
            - explore
            - organize
            - edit
            description: Choose **organize** for Can Contribute permissions or **edit** for Can Manage permissions.
            title: Folder Permission
        in: query
      - name: typeFilters
        schema:
          oneOf:
          - type: array
            items:
              type: string
              enum:
              - workspace
              - folder
              - workbook
              - dataset
              - data-model
              - sql
              - worksheet
              - dashboard
              - template
              - table
              - symlink
              - report
            description: '**Note**: Workspaces are not returned as part of the response. To retrieve a workspace, use the **Single Document Type**.'
            title: Multiple Document Types
          - type: string
            enum:
            - workspace
            - folder
            - workbook
            - dataset
            - data-model
            - sql
            - worksheet
            - dashboard
            - template
            - table
            - symlink
            - report
            description: ''
            title: Single Document Type
        in: query
      - name: page
        schema:
          type: string
        in: query
      - name: limit
        schema:
          type: number
        in: query
      - name: parentId
        schema:
          type: string
          description: Parent folder
        in: query
      - name: directChildFilter
        schema:
          type: boolean
        in: query
      operationId: listAccessibleInodes
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - entries
                  - nextPage
                  properties:
                    entries:
                      type: array
                      items:
                        allOf:
                        - type: object
                          required:
                          - id
                          - urlId
                          - name
                          - type
                          - parentId
                          - parentUrlId
                          - permission
                          - path
                          - badge
                          - isArchived
                          properties:
                            id:
                              type: string
                            urlId:
                              type: string
                            name:
                              type: string
                            type:
                              type: string
                              enum:
                              - workspace
                              - folder
                              - workbook
                              - dataset
                              - data-model
                              - sql
                              - worksheet
                              - dashboard
                              - template
                              - table
                              - symlink
                              - report
                            parentId:
                              type: string
                            parentUrlId:
                              type: string
                            permission:
                              type: string
                              enum:
                              - create
                              - annotate
                              - organize
                              - explore
                              - view
                              - edit
                              - apply
                            path:
                              type: string
                            badge:
                              type:
                              - string
                              - 'null'
                            isArchived:
                              type: boolean
                        - type: object
                          properties:
                            description:
                              type: string
                            ownerId:
                              type:
                              - string
                              - 'null'
                            parentSourceUrlId:
                              type: string
                              description: For a document deployed to a tenant organization, the `urlId` of the source document in the parent organization. Only present when the document was deployed from a parent organization. The source document can be a workbook, template, data model, dataset, or report.
                              title: Parent Source URL ID
                        - type: object
                          required:
                          - createdBy
                          - updatedBy
                          - createdAt
                          - updatedAt
                          properties:
                            createdBy:
                              type: string
                              description: The identifier of the user who created this object.
                            updatedBy:
                              type: string
                              description: The identifier of the user or process that last updated this object.
                            createdAt:
                              type: string
                              format: date-time
                              description: When the object was created.
                            updatedAt:
                              type: string
                              format: date-time
                              description: When the object was last updated.
                      description: Array of results returned by the endpoint
                    nextPage:
                      type:
                      - string
                      - 'null'
                      descripti

# --- truncated at 32 KB (524 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-members-api-openapi.yml