Tufin Users API

openapi: 3.1.0
info:
  title: Tufin SecureChange REST Compliance Users API
  description: The Tufin SecureChange REST API automates security policy change workflows, enabling programmatic submission and management of access request tickets, approval workflows, and change implementation across network infrastructure. SecureChange integrates with ITSM platforms including ServiceNow, Jira, and Remedy for end-to-end change automation. Authentication uses HTTP Basic Auth.
  version: R25-2
  contact:
    name: Tufin Support
    url: https://www.tufin.com/support
  license:
    name: Tufin Terms of Use
    url: https://www.tufin.com/terms-of-use
servers:
- url: https://{tos_host}/securechangeworkflow/api/securechange
  description: Tufin SecureChange Server
  variables:
    tos_host:
      description: Hostname or IP address of the TOS server
      default: tufin.example.com
tags:
- name: Users
  description: User and group management
paths:
  /users:
    get:
      operationId: getUsers
      summary: Get Users
      description: Retrieve all users defined in SecureChange.
      tags:
      - Users
      security:
      - basicAuth: []
      parameters:
      - name: name
        in: query
        description: Filter by username
        schema:
          type: string
      responses:
        '200':
          description: List of users
          content:
            application/json:
              schema:
                type: object
                properties:
                  users:
                    type: object
                    properties:
                      user:
                        type: array
                        items:
                          $ref: '#/components/schemas/User'
components:
  schemas:
    User:
      type: object
      description: A SecureChange user
      properties:
        id:
          type: integer
          description: User identifier
        username:
          type: string
          description: Login username
        email:
          type: string
          description: User email address
        first_name:
          type: string
          description: First name
        last_name:
          type: string
          description: Last name
        groups:
          type: array
          items:
            type: string
          description: Groups the user belongs to
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Tufin Orchestration Suite credentials. The authenticated user's TOS permissions apply to all API requests.
externalDocs:
  description: Tufin SecureChange REST API Documentation
  url: https://forum.tufin.com/support/kc/latest/Content/Suite/RESTAPI/12309.htm