Sisense Users API

openapi: 3.2.0
info:
  title: Sisense REST Authentication Users API
  description: The Sisense REST API provides programmatic access to the Sisense business intelligence platform, enabling management of dashboards, data models (Elasticubes and live models), users, groups, data security rules, and builds. The API uses Bearer token authentication obtained via the login endpoint or User Profiles settings. Endpoints follow RESTful conventions with standard HTTP methods for CRUD operations.
  version: v1
  contact:
    name: Sisense Support
    url: https://support.sisense.com/
  termsOfService: https://www.sisense.com/legal/terms-of-service/
  license:
    name: Commercial
    url: https://www.sisense.com/legal/terms-of-service/
servers:
- url: https://{host}/api/v1
  description: Sisense Instance REST API v1
  variables:
    host:
      description: Your Sisense instance hostname
      default: your-instance.sisense.com
security:
- bearerAuth: []
tags:
- name: Users
  description: Manage Sisense users and user settings
paths:
  /users:
    get:
      operationId: listUsers
      summary: List Users
      description: Returns a list of users in the Sisense system.
      tags:
      - Users
      parameters:
      - name: fields
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      - name: skip
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Users retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
        '401':
          description: Unauthorized
    post:
      operationId: createUser
      summary: Create User
      description: Creates a new user in Sisense.
      tags:
      - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserRequest'
      responses:
        '200':
          description: User created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '401':
          description: Unauthorized
  /users/{id}:
    get:
      operationId: getUser
      summary: Get User
      description: Returns a specific user by ID.
      tags:
      - Users
      parameters:
      - name: id
        in: path
        required: true
        description: User identifier
        schema:
          type: string
      responses:
        '200':
          description: User retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: User not found
    patch:
      operationId: updateUser
      summary: Update User
      description: Updates specific fields of a user.
      tags:
      - Users
      parameters:
      - name: id
        in: path
        required: true
        description: User identifier
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: User updated successfully
        '404':
          description: User not found
    delete:
      operationId: deleteUser
      summary: Delete User
      description: Deletes a user from Sisense.
      tags:
      - Users
      parameters:
      - name: id
        in: path
        required: true
        description: User identifier
        schema:
          type: string
      responses:
        '200':
          description: User deleted successfully
        '404':
          description: User not found
components:
  schemas:
    User:
      type: object
      properties:
        _id:
          type: string
          description: User unique identifier
        email:
          type: string
          description: User email address
        firstName:
          type: string
          description: User first name
        lastName:
          type: string
          description: User last name
        userName:
          type: string
          description: Username for login
        role:
          type: string
          description: User role (viewer, designer, analyst, dataDesigner, admin)
        groups:
          type: array
          description: Groups the user belongs to
          items:
            type: string
        active:
          type: boolean
          description: Whether the user account is active
        created:
          type: string
          format: date-time
        lastLogin:
          type: string
          format: date-time
    CreateUserRequest:
      type: object
      required:
      - email
      - role
      properties:
        email:
          type: string
          description: User email address
        firstName:
          type: string
          description: User first name
        lastName:
          type: string
          description: User last name
        role:
          type: string
          description: User role assignment
        groups:
          type: array
          items:
            type: string
          description: Groups to assign the user to
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token obtained from POST /api/v1/authentication/login
externalDocs:
  description: Sisense REST API Documentation
  url: https://developer.sisense.com/guides/restApi/