openapi: 3.2.0
info:
  description: 'Requirements:

    - Create your access token through the UI

    - Get your tenant name: if you access to Sifflet with `https://abcdef.siffletdata.com`, then your tenant would be `abcdef`'
  title: Sifflet Backend Users API
  version: 1.0.0
servers:
- url: https://{tenant}.siffletdata.com/api
  description: Production tenant
  variables:
    tenant:
      description: if you access to Sifflet with `https://abcdef.siffletdata.com`, then your tenant would be `abcdef`
      default: publicdemo
- url: http://localhost:8090
  description: Dev server started in intellij
- url: http://localhost:8091
  description: Dev server started in docker compose
- url: http://localhost:8099
  description: Dev server started with api recorder
tags:
- name: Users
paths:
  /v1/users:
    get:
      operationId: publicGetUsers
      parameters:
      - description: The page number to retrieve. Starts at 0.
        in: query
        name: page
        required: false
        schema:
          minimum: 0
          type: integer
          format: int32
      - description: The number of elements to be returned inside the page.
        in: query
        name: itemsPerPage
        required: false
        schema:
          maximum: 100
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPageDtoPublicUserGetDto'
          description: Users retrieved
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Resource not found
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Get list of users
      tags:
      - Users
    post:
      operationId: publicCreateUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicUserCreateDto'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicUserGetDto'
          description: User created
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Bad request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Conflict
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Create a user
      tags:
      - Users
  /v1/users/{id}:
    delete:
      operationId: publicDeleteUser
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: User deleted
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Resource not found
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Delete a user
      tags:
      - Users
    get:
      operationId: publicGetUser
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicUserGetDto'
          description: User retrieved
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Resource not found
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Get a user by id
      tags:
      - Users
    patch:
      operationId: publicUpdateUser
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicUserUpdateDto'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicUserGetDto'
          description: User updated
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Bad request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Conflict
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Update a user
      tags:
      - Users
  /v1/users/{id}/reset-password:
    post:
      operationId: publicResetUserPassword
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicUserResetPasswordDto'
          description: User password reset
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Resource not found
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Reset a user password
      tags:
      - Users
components:
  schemas:
    ApiProblemSchema:
      type: object
      properties:
        detail:
          type: string
        response:
          type: string
        status:
          type: integer
          format: int32
        title:
          type: string
        type:
          type: string
    PublicUserPermissionAssignmentDto:
      required:
      - domainId
      type: object
      properties:
        domainId:
          type: string
          description: Id of the domain
          format: uuid
        domainRole:
          type: string
          description: Domain role assigned to the principal for accessing the referenced domain
          enum:
          - EDITOR
          - MONITOR_RESPONDER
          - CATALOG_EDITOR
          - VIEWER
      description: Domain access permissions of the user
    PublicUserUpdateDto:
      required:
      - name
      - role
      type: object
      properties:
        authTypes:
          uniqueItems: true
          type: array
          description: Authorized authentication type of the user
          items:
            type: string
            description: Authorized authentication type of the user
            enum:
            - SAML2
            - LOGIN_PASSWORD
        name:
          type: string
          description: Name of the user
        permissions:
          uniqueItems: true
          type: array
          description: Domain access permissions of the user
          items:
            $ref: '#/components/schemas/PublicUserPermissionAssignmentDto'
        role:
          type: string
          description: System role of the user
          enum:
          - ADMIN
          - EDITOR
          - VIEWER
    PublicUserTeamDto:
      required:
      - teamId
      type: object
      properties:
        teamId:
          type: string
          description: Id of the team
          format: uuid
      description: Teams of the user
    PublicUserGetDto:
      required:
      - authTypes
      - email
      - id
      - name
      - permissions
      - role
      - status
      - teams
      type: object
      properties:
        authTypes:
          uniqueItems: true
          type: array
          description: Authorized authentication type of the user
          items:
            type: string
            description: Authorized authentication type of the user
            enum:
            - SAML2
            - LOGIN_PASSWORD
        email:
          type: string
          description: Email of the user
        id:
          type: string
          format: uuid
        name:
          type: string
          description: Name of the user
        permissions:
          uniqueItems: true
          type: array
          description: Domain access permissions of the user
          items:
            $ref: '#/components/schemas/PublicUserPermissionAssignmentDto'
        role:
          type: string
          description: System role of the user
          enum:
          - ADMIN
          - EDITOR
          - VIEWER
        status:
          type: string
          description: Status of the user
          enum:
          - ENABLED
          - DISABLED
        teams:
          uniqueItems: true
          type: array
          description: Teams of the user
          items:
            $ref: '#/components/schemas/PublicUserTeamDto'
    PublicPageDtoPublicUserGetDto:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PublicUserGetDto'
        totalCount:
          type: integer
          format: int64
    PublicUserResetPasswordDto:
      required:
      - password
      type: object
      properties:
        password:
          type: string
    PublicUserCreateDto:
      required:
      - email
      - name
      - role
      type: object
      properties:
        authTypes:
          uniqueItems: true
          type: array
          description: Authorized authentication type of the user
          items:
            type: string
            description: Authorized authentication type of the user
            enum:
            - SAML2
            - LOGIN_PASSWORD
        email:
          type: string
          description: Email of the user
        name:
          type: string
          description: Name of the user
        permissions:
          uniqueItems: true
          type: array
          description: Domain access permissions of the user
          items:
            $ref: '#/components/schemas/PublicUserPermissionAssignmentDto'
        role:
          type: string
          description: System role of the user
          enum:
          - ADMIN
          - EDITOR
          - VIEWER
  securitySchemes:
    JWT:
      bearerFormat: Bearer [token]
      description: JWT authentication with bearer token. [Create your access token through the UI](https://docs.siffletdata.com/docs/generate-an-api-token#create-an-api-token).
      scheme: bearer
      type: http
x-provenance:
  method: searched
  source: https://docs.siffletdata.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.siffletdata.com/reference/decryptrulegroups.md
  - https://docs.siffletdata.com/reference/decryptrulerungroups.md
  - https://docs.siffletdata.com/reference/getallmonitorsascode.md
  - https://docs.siffletdata.com/reference/getallrule.md
  - https://docs.siffletdata.com/reference/getsiffletruledetails.md
  - https://docs.siffletdata.com/reference/getsiffletruleinfo.md
  - https://docs.siffletdata.com/reference/getsiffletruleoverview.md
  - https://docs.siffletdata.com/reference/getsiffletrulerun.md
  - https://docs.siffletdata.com/reference/getsiffletruleruns.md
  - https://docs.siffletdata.com/reference/publiccreatecalendar.md
  - https://docs.siffletdata.com/reference/publiccreatecredentials.md
  - https://docs.siffletdata.com/reference/publiccreatedomain.md
  - https://docs.siffletdata.com/reference/publiccreatenotificationrule.md
  - https://docs.siffletdata.com/reference/publiccreatesource.md
  - https://docs.siffletdata.com/reference/publiccreatesourcev2.md
  - https://docs.siffletdata.com/reference/publiccreateteam.md
  - https://docs.siffletdata.com/reference/publiccreateuser.md
  - https://docs.siffletdata.com/reference/publicdeletecalendar.md
  - https://docs.siffletdata.com/reference/publicdeletecredentials.md
  - https://docs.siffletdata.com/reference/publicdeletedomain.md
  - https://docs.siffletdata.com/reference/publicdeletenotificationrule.md
  - https://docs.siffletdata.com/reference/publicdeletesourcebyid.md
  - https://docs.siffletdata.com/reference/publicdeletesourcev2.md
  - https://docs.siffletdata.com/reference/publicdeleteteam.md
  - https://docs.siffletdata.com/reference/publicdeleteuser.md
  - https://docs.siffletdata.com/reference/publicdeleteworkspace.md
  - https://docs.siffletdata.com/reference/publiceditasset-1.md
  - https://docs.siffletdata.com/reference/publiceditsource.md
  - https://docs.siffletdata.com/reference/publiceditsourcev2.md
  - https://docs.siffletdata.com/reference/publicgetallcredentials.md
  - https://docs.siffletdata.com/reference/publicgetasset-1.md
  - https://docs.siffletdata.com/reference/publicgetassets-1.md
  - https://docs.siffletdata.com/reference/publicgetcalendar.md
  - https://docs.siffletdata.com/reference/publicgetcalendars.md
  - https://docs.siffletdata.com/reference/publicgetcredentials.md
  - https://docs.siffletdata.com/reference/publicgetdomain.md
  - https://docs.siffletdata.com/reference/publicgetdomains.md
  - https://docs.siffletdata.com/reference/publicgetnotificationrule.md
  - https://docs.siffletdata.com/reference/publicgetnotificationrules.md
  - https://docs.siffletdata.com/reference/publicgetsource.md
  - https://docs.siffletdata.com/reference/publicgetsources.md
  - https://docs.siffletdata.com/reference/publicgetsourceschemalist.md
  - https://docs.siffletdata.com/reference/publicgetsourcesv2.md
  - https://docs.siffletdata.com/reference/publicgetsourcev2.md
  - https://docs.siffletdata.com/reference/publicgetteam.md
  - https://docs.siffletdata.com/reference/publicgetteams.md
  - https://docs.siffletdata.com/reference/publicgetuser.md
  - https://docs.siffletdata.com/reference/publicgetusers.md
  - https://docs.siffletdata.com/reference/publicimportexternalcatalog.md
  - https://docs.siffletdata.com/reference/publicresetuserpassword.md
  - https://docs.siffletdata.com/reference/publicrunsourcev2.md
  - https://docs.siffletdata.com/reference/publicrunsubsourcev2.md
  - https://docs.siffletdata.com/reference/publicsourceingestionmanualrun.md
  - https://docs.siffletdata.com/reference/publicsyncassets.md
  - https://docs.siffletdata.com/reference/publictestexistingsourceconnectionv2.md
  - https://docs.siffletdata.com/reference/publictestsourceconnectionv2.md
  - https://docs.siffletdata.com/reference/publictestsubsourceconnectionbyuriv2.md
  - https://docs.siffletdata.com/reference/publictestsubsourceconnectionv2.md
  - https://docs.siffletdata.com/reference/publicupdatecalendar.md
  - https://docs.siffletdata.com/reference/publicupdatecredentials.md
  - https://docs.siffletdata.com/reference/publicupdatedomain.md
  - https://docs.siffletdata.com/reference/publicupdatenotificationrule.md
  - https://docs.siffletdata.com/reference/publicupdateteam.md
  - https://docs.siffletdata.com/reference/publicupdateuser.md
  - https://docs.siffletdata.com/reference/siffletrulemanualrun.md
  - https://docs.siffletdata.com/reference/testsourceconnection.md
  - https://docs.siffletdata.com/reference/uploaddbtmetadatafiles.md
  merge:
    pages: 67
    deduped: 626
    conflicts_kept_first: 0