Tufin Workflow Definitions API

Workflow template definitions

OpenAPI Specification

tufin-workflow-definitions-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Tufin SecureChange REST Compliance Workflow Definitions 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: Workflow Definitions
  description: Workflow template definitions
paths:
  /workflow_definitions:
    get:
      operationId: getWorkflowDefinitions
      summary: Get Workflow Definitions
      description: Retrieve all workflow definitions (templates) configured in SecureChange.
      tags:
      - Workflow Definitions
      security:
      - basicAuth: []
      responses:
        '200':
          description: List of workflow definitions
          content:
            application/json:
              schema:
                type: object
                properties:
                  workflow_definitions:
                    type: object
                    properties:
                      workflow_definition:
                        type: array
                        items:
                          $ref: '#/components/schemas/WorkflowDefinition'
components:
  schemas:
    WorkflowDefinition:
      type: object
      description: A workflow template definition in SecureChange
      properties:
        id:
          type: integer
          description: Workflow definition identifier
        name:
          type: string
          description: Workflow definition name
        description:
          type: string
          description: Description of when to use this workflow
        enabled:
          type: boolean
          description: Whether this workflow is available for new tickets
        steps:
          type: array
          items:
            type: object
          description: Workflow step definitions
  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