From 7ae0bd57d7038d967f07e501aad44ba03d9557be Mon Sep 17 00:00:00 2001 From: Michael Elrom Date: Tue, 15 Sep 2026 10:44:20 -0400 Subject: [PATCH 1/3] feat(tufin): add SecureTrack, SecureChange, and SecureApp Integration Models and Studio Projects Adds Integration Models and Studio Projects for Tufin's three REST APIs, built from the vendor's official per-version Swagger 1.2 documentation (forum.tufin.com, R25-2) and converted to curated OpenAPI 3.0 specs: - SecureTrack: device inventory, security rule search, policy/sub-policy listing, policy browser, network object and service/port CRUD, NAT policy listing, and config revisions (66 of 275 upstream operations). - SecureChange: ticket CRUD and full lifecycle actions, saved queries, request search/cancel, workflow listing, and target-device lookup (70 of 101 upstream operations). - SecureApp: application, connection, interface, server, and local/global service CRUD (56 of 104 upstream operations). Each product ships a full dated spec alongside the curated -latest spec, plus a companion Studio Project with one atomic workflow per curated operation, organized into folders by resource category and wired to the product's -latest Integration Model. All six specs and three projects were live-imported against a running Itential Platform instance. --- README.md | 1 + .../OpenAPIs/tufin_secureapp-25.2.json | 22103 ++++++++++++ .../OpenAPIs/tufin_secureapp-latest.json | 4425 +++ Tufin/SecureApp/README.md | 76 + .../Tufin SecureApp.project.json | 6262 ++++ .../OpenAPIs/tufin_securechange-25.2.json | 23096 +++++++++++++ .../OpenAPIs/tufin_securechange-latest.json | 9339 +++++ Tufin/SecureChange/README.md | 78 + .../Tufin SecureChange.project.json | 8412 +++++ .../OpenAPIs/tufin_securetrack-25.2.json | 28328 ++++++++++++++++ .../OpenAPIs/tufin_securetrack-latest.json | 5995 ++++ Tufin/SecureTrack/README.md | 80 + .../Tufin SecureTrack.project.json | 8068 +++++ 13 files changed, 116263 insertions(+) create mode 100644 Tufin/SecureApp/OpenAPIs/tufin_secureapp-25.2.json create mode 100644 Tufin/SecureApp/OpenAPIs/tufin_secureapp-latest.json create mode 100644 Tufin/SecureApp/README.md create mode 100644 Tufin/SecureApp/Studio Projects/Tufin SecureApp.project.json create mode 100644 Tufin/SecureChange/OpenAPIs/tufin_securechange-25.2.json create mode 100644 Tufin/SecureChange/OpenAPIs/tufin_securechange-latest.json create mode 100644 Tufin/SecureChange/README.md create mode 100644 Tufin/SecureChange/Studio Projects/Tufin SecureChange.project.json create mode 100644 Tufin/SecureTrack/OpenAPIs/tufin_securetrack-25.2.json create mode 100644 Tufin/SecureTrack/OpenAPIs/tufin_securetrack-latest.json create mode 100644 Tufin/SecureTrack/README.md create mode 100644 Tufin/SecureTrack/Studio Projects/Tufin SecureTrack.project.json diff --git a/README.md b/README.md index 321a8a7..c0bfcc7 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,7 @@ Assets are organized by vendor and product. Each folder may contain one or more | **Slack** | Messaging | | **SolarWinds** | Orion NPM | | **Sonatype** | Nexus | +| **Tufin** | SecureApp · SecureChange · SecureTrack | | **Twilio** | Communications APIs | | **Versa** | Director | | **VMware** | NSX · vSphere vCenter | diff --git a/Tufin/SecureApp/OpenAPIs/tufin_secureapp-25.2.json b/Tufin/SecureApp/OpenAPIs/tufin_secureapp-25.2.json new file mode 100644 index 0000000..d4400f0 --- /dev/null +++ b/Tufin/SecureApp/OpenAPIs/tufin_secureapp-25.2.json @@ -0,0 +1,22103 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Tufin SecureApp", + "description": "Tufin SecureApp application connectivity and application-centric policy management REST API.", + "version": "25.2" + }, + "servers": [ + { + "url": "https://{host}/securechangeworkflow/api", + "variables": { + "host": { + "default": "tufin.example.com" + } + } + } + ], + "security": [ + { + "basicAuth": [] + } + ], + "components": { + "securitySchemes": { + "basicAuth": { + "type": "http", + "scheme": "basic" + } + }, + "schemas": { + "ApplicationAccessRequestListDTO": { + "type": "object", + "properties": { + "application_access_request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationAccessRequestDTO" + }, + "description": "The application access requests" + } + } + }, + "ApplicationAccessRequestDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "action": { + "type": "string", + "description": "The action ,for GET api its - OPENED, DENIED, WAITING_TICKET, IN_TICKET, CONFIRMED, IMMEDIATE_CONFIRM, IMMEDIATE_DENIED" + }, + "server_group_name": { + "type": "string", + "description": "The server group name" + }, + "server_ip": { + "type": "string", + "description": "The server ip" + }, + "server_group_id": { + "type": "string", + "description": "The server group ID" + } + }, + "required": [ + "server_ip", + "server_group_id" + ] + }, + "any_service": { + "type": "object", + "properties": { + "min_protocol": { + "type": "integer", + "format": "int32" + }, + "max_protocol": { + "type": "integer", + "format": "int32" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "networkObjectVirtualServerDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name" + }, + "type": { + "type": "string", + "description": "The type" + }, + "port": { + "type": "string", + "description": "The port that the virtual server is forwarding (Any is shown as \"-1\")" + }, + "protocol": { + "type": "string", + "description": "The protocol that the virtual server is forwarding" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID" + }, + "netmask": { + "type": "string", + "description": "The netmask for the virtual server VIP address" + }, + "f5_device_name": { + "type": "string", + "description": "The name of the device" + }, + "virtual_ip": { + "type": "string", + "description": "The virtual IP address of the device" + }, + "pool_member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PoolMemberDTO" + }, + "description": "The server group members that are associated with the virtual server" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "multi_network_object": { + "type": "object", + "properties": { + "network_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectDTO" + }, + "description": "The list of network objects" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "network_object", + "name", + "read_only" + ] + }, + "RuleMetaDataDTO": { + "type": "object", + "properties": { + "last_modified": { + "type": "string" + }, + "application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SaApplicationDTO" + } + }, + "permissiveness_level": { + "$ref": "#/components/schemas/PermissivenessLevel" + }, + "violation": { + "type": "array", + "items": { + "type": "string" + } + }, + "last_hit": { + "type": "string" + }, + "shadowed_status": { + "$ref": "#/components/schemas/ShadowedStatus" + }, + "tech_owner": { + "type": "string" + }, + "ticket_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "rule_description": { + "type": "string" + }, + "expiration": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LocalDateTime" + } + }, + "legacy_rule": { + "type": "boolean" + }, + "stealth_rule": { + "type": "boolean" + }, + "business_owner": { + "type": "array", + "items": { + "type": "string" + } + }, + "rule_certification": { + "$ref": "#/components/schemas/RuleCertificationDTO" + } + } + }, + "ServerDecommissionRequestDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + }, + "order": { + "type": "string", + "description": "The order" + }, + "designer_result": { + "$ref": "#/components/schemas/DesignerDTO" + }, + "targets": { + "$ref": "#/components/schemas/multi_target" + }, + "verifier_result": { + "$ref": "#/components/schemas/verifier_results" + }, + "servers": { + "$ref": "#/components/schemas/MultiServerDTO" + }, + "impact_analysis_result": { + "$ref": "#/components/schemas/ImpactAnalysisDTO" + }, + "domain": { + "type": "string", + "description": "the name of the source domain" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "targets", + "servers", + "name", + "read_only" + ] + }, + "http_www.tufin.com_sc_policy_transport_service": { + "type": "object", + "properties": { + "port": { + "$ref": "#/components/schemas/RangeDTO" + }, + "protocol": { + "$ref": "#/components/schemas/Protocol" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "additional_parameter_group": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/additional_parameter" + } + }, + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RDVerifierError": { + "type": "object" + }, + "DomainDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the domain" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the domain" + }, + "description": { + "type": "string", + "description": "The description of the domain" + } + }, + "required": [ + "name", + "id", + "description" + ] + }, + "reply_comment": { + "type": "object", + "properties": { + "original_comment_id": { + "type": "integer", + "format": "int64", + "description": "The request comment id" + }, + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "LocalDate": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "format": "int32" + } + } + }, + "multi_text_field": { + "type": "object", + "properties": { + "text_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/text_field" + }, + "description": "The list of text fields" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "text_field", + "name", + "read_only" + ] + }, + "approve_reject": { + "type": "object", + "properties": { + "approved": { + "type": "string", + "description": "The approval or rejectionof the ticket" + }, + "reason": { + "type": "string", + "description": "The reason for approval or rejection" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "approved", + "reason", + "name", + "read_only" + ] + }, + "CommitResultsDTO": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/CommitReportStatus" + }, + "report": { + "$ref": "#/components/schemas/commit_commit_result_link" + } + } + }, + "TicketExternalDataDTO": { + "type": "object", + "properties": { + "request_id": { + "type": "string", + "description": "The request ID" + }, + "requester": { + "type": "string", + "description": "The requester" + } + } + }, + "RedesignStatusEnumDTO": { + "type": "object" + }, + "http_www.tufin.com_sc_policy_network_object_group": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "ConnectionFullResourcesListDTO": { + "type": "object", + "properties": { + "connection_extended": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionFullResourcesDTO" + }, + "description": "List of connections" + } + } + }, + "OpmRuleDTO": { + "type": "object", + "properties": { + "uid": { + "type": "string", + "description": "rule uid" + } + } + }, + "rule_decommission_verifier_result_link": { + "type": "object" + }, + "RelatedRulesBindingDTO": { + "type": "object", + "properties": { + "related_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedRuleContainerDTO" + } + } + } + }, + "PermissivenessLevel": { + "type": "object" + }, + "RuleCertificationStatus": { + "type": "object" + }, + "RoleDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the role" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the role" + }, + "role_link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "description": { + "type": "string", + "description": "The description of the role" + } + }, + "required": [ + "name", + "id" + ] + }, + "additional_parameter_nat_pool": { + "type": "object", + "properties": { + "nat_pool_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "account_ref": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The account ref name" + }, + "id": { + "type": "string", + "description": "The account ref ID" + }, + "cloud_vendor": { + "type": "string", + "description": "The account ref cloud vendor" + } + } + }, + "single_application": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "TicketDTO": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "The priority of the request" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the ticket" + }, + "status": { + "type": "string", + "description": "The status of the ticket" + }, + "application_details": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "comments": { + "$ref": "#/components/schemas/TicketCommentListDTO" + }, + "expiration_date": { + "type": "string", + "description": "Request is valid until this date" + }, + "subject": { + "type": "string", + "description": "The subject of the ticket" + }, + "referenced_ticket": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "requester": { + "type": "string", + "description": "The name of the requester" + }, + "create_date": { + "type": "string", + "format": "date-time", + "description": "The ticket creation date" + }, + "update_date": { + "type": "string", + "format": "date-time", + "description": "The ticket last update date" + }, + "close_date": { + "type": "string", + "format": "date-time", + "description": "The ticket close date" + }, + "notification_group": { + "$ref": "#/components/schemas/group" + }, + "sla_status": { + "type": "string", + "description": "The Tickets current SLA status" + }, + "sla_outcome": { + "type": "string", + "description": "The outcome of the SLA" + }, + "sla_tracking_state": { + "type": "string", + "description": "The Tickets current SLA tracking state" + }, + "steps": { + "$ref": "#/components/schemas/TicketStagesListDTO" + }, + "business_duration": { + "type": "integer", + "format": "int64", + "description": "The ticket business duration" + }, + "expiration_field_name": { + "type": "string", + "description": "The Request is required until" + }, + "expiration_status": { + "$ref": "#/components/schemas/ExpirationStatusDTO" + }, + "external_data": { + "$ref": "#/components/schemas/TicketExternalDataDTO" + }, + "current_step": { + "$ref": "#/components/schemas/TicketCurrentStageReferenceDTO" + }, + "workflow": { + "$ref": "#/components/schemas/WorkflowReferenceDTO" + }, + "domain_name": { + "type": "string", + "description": "The domain in which the ticket is posted" + }, + "requester_id": { + "type": "integer", + "format": "int64", + "description": "The user id which the ticket is created on behalf of (used for 'on-behalf' feature)" + }, + "application_changes": { + "$ref": "#/components/schemas/TicketApplicationChangeListDTO" + }, + "completion_details": { + "$ref": "#/components/schemas/CompletionDetailsDTO" + } + }, + "required": [ + "priority", + "subject", + "workflow", + "domain_name" + ] + }, + "multi_target": { + "type": "object", + "properties": { + "target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TargetDTO" + }, + "description": "The list of target objects" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "target", + "name", + "read_only" + ] + }, + "sa_network_object": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the network object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "RelatedRulesAccessRequestDTO": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedRulesDeviceDTO" + } + }, + "AR": { + "type": "integer", + "format": "int32" + } + } + }, + "http_www.tufin.com_sc_policy_subnet_network_object": { + "type": "object", + "properties": { + "ip": { + "type": "string" + }, + "netmask": { + "type": "string" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "labels": { + "type": "object", + "properties": { + "label": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The labels for the traffic flow" + } + } + }, + "TicketStageDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The step name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The step ID" + }, + "tasks": { + "$ref": "#/components/schemas/TicketTaskListDTO" + }, + "skipped": { + "type": "boolean", + "description": "whether the task was skipped" + }, + "redone": { + "type": "boolean", + "description": "whether the task was redone" + }, + "business_duration": { + "type": "integer", + "format": "int64", + "description": "The step business duration" + } + }, + "required": [ + "tasks" + ] + }, + "SubPolicyDTO": { + "type": "object", + "properties": { + "sub_policy_uid": { + "$ref": "#/components/schemas/UUID" + }, + "sub_policy_rule": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The rules related to the subpolicy" + }, + "sub_policy_name": { + "type": "string", + "description": "The name of the Inline Layer subpolicy" + } + }, + "required": [ + "sub_policy_uid", + "sub_policy_rule", + "sub_policy_name" + ] + }, + "DesignerBindingSuggestionsDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "binding_uid": { + "type": "string" + }, + "binding_name": { + "type": "string" + }, + "instruction": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerInstructionDTO" + }, + "description": "List of instructions" + } + } + }, + "MultiDestinationDTO": { + "type": "object", + "properties": { + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DestinationDTO" + }, + "description": "The destinations" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "destination", + "name", + "read_only" + ] + }, + "device_network_object": { + "type": "object", + "properties": { + "network_object": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_policy_network_object" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "Device Id" + }, + "status": { + "$ref": "#/components/schemas/StatusDTO" + } + }, + "required": [ + "device_id", + "status" + ] + }, + "multiple_selection": { + "type": "object", + "properties": { + "options": { + "$ref": "#/components/schemas/OptionItemListDTO" + }, + "selected_options": { + "$ref": "#/components/schemas/SelectedOptionItemListDTO" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "options", + "selected_options", + "name", + "read_only" + ] + }, + "single_service": { + "type": "object", + "properties": { + "port": { + "type": "string" + }, + "protocol": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "group_member_network_object": { + "type": "object", + "properties": { + "group_member": { + "$ref": "#/components/schemas/single_network_object" + }, + "group_member_path": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "transport_service": { + "type": "object", + "properties": { + "protocol": { + "type": "string", + "format": "int16" + }, + "max_port": { + "type": "integer", + "format": "int32" + }, + "min_port": { + "type": "integer", + "format": "int32" + }, + "cp_inspect_streaming_name": { + "type": "string" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "CompletionDetailsDTO": { + "type": "object", + "properties": { + "stepId": { + "type": "integer", + "format": "int64", + "description": "The completion step id " + } + } + }, + "RedesignStatusDTO": { + "type": "object" + }, + "text_area": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The text" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "text", + "name", + "read_only" + ] + }, + "ZoneType": { + "type": "object" + }, + "PartyDTOType": { + "type": "object" + }, + "SelectedOptionItemListDTO": { + "type": "object", + "properties": { + "selected_option": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptionItemDTO" + }, + "description": "The selected option" + } + }, + "required": [ + "selected_option" + ] + }, + "rule_recertification": { + "type": "object", + "properties": { + "rule_recertification_info": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rule_recertification_info" + } + }, + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_RuleOperationDeviceDTO" + }, + "description": "List of devices" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "device", + "name", + "read_only" + ] + }, + "ObjectReferenceUIDDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the referenced object" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + } + } + }, + "device_service_object": { + "type": "object", + "properties": { + "service_object": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_policy_service_object" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "Device Id" + }, + "status": { + "$ref": "#/components/schemas/StatusDTO" + } + }, + "required": [ + "device_id", + "status" + ] + }, + "Logger": { + "type": "object" + }, + "ConnectionChangeDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type of the change" + }, + "object_name": { + "type": "string", + "description": "the name of the changed object" + }, + "description": { + "type": "string", + "description": "the description of the change" + } + } + }, + "network_object_cell_modifications": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "network_object_cell_modification": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object_cell_modification" + } + } + } + }, + "group_member_service_object": { + "type": "object", + "properties": { + "group_member": { + "$ref": "#/components/schemas/single_service_object" + }, + "group_member_path": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "dip_nat_info": { + "type": "object", + "properties": { + "shift_from": { + "type": "string" + }, + "interface_name": { + "type": "string" + } + } + }, + "RequiredReason": { + "type": "object", + "properties": { + "key": { + "$ref": "#/components/schemas/RequiredReasonKeyDTO" + }, + "description": { + "type": "string", + "description": "The description of the required reason" + } + } + }, + "DurationFieldType": { + "type": "object" + }, + "checkbox": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The checkbox" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "value", + "name", + "read_only" + ] + }, + "Protocol": { + "type": "object" + }, + "host_network_object_with_interfaces": { + "type": "object", + "properties": { + "interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceForNetworkObjectDTO" + } + }, + "ip": { + "type": "string" + }, + "subnet_mask": { + "type": "string" + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "manager": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The input for email address of requester's manager. " + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "text", + "name", + "read_only" + ] + }, + "IpType": { + "type": "object", + "properties": { + "ipv6": { + "type": "boolean" + }, + "ipv4": { + "type": "boolean" + } + } + }, + "MembersListDTO": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartyDTO" + }, + "description": "The list of members" + }, + "partial_list": { + "type": "boolean", + "description": "Partial list; true if only a partial list is returned" + } + } + }, + "OpmDeviceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "device name" + }, + "item": { + "type": "array", + "items": { + "type": "string" + }, + "description": "device identifier path" + }, + "api_v1_Id": { + "type": "integer", + "format": "int32", + "description": "device api v1 id" + } + } + }, + "related_rules_related_rules_link": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/LinkDTO" + } + } + }, + "Referenced": { + "type": "object", + "properties": { + "xmlValue": { + "type": "string" + } + } + }, + "application_group": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "ObjectReferenceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the referenced object" + }, + "id": { + "type": "string", + "description": "ID" + }, + "type": { + "type": "string", + "description": "The type of the referenced object" + }, + "display_name": { + "type": "string", + "description": "The display name of the referenced object" + }, + "management_domain": { + "type": "string", + "description": "The management domain from which the referenced object comes from" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the referenced object" + }, + "ip": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FQDNIpDTO" + } + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of references to a DM_INLINE group members" + } + }, + "required": [ + "id" + ] + }, + "VerifierDeviceDTO": { + "type": "object", + "properties": { + "time": { + "$ref": "#/components/schemas/LocalTime" + }, + "date": { + "$ref": "#/components/schemas/LocalDate" + }, + "verifier_warning": { + "type": "string", + "description": "verifier warning" + }, + "verifier_error": { + "type": "string", + "description": "verifier error message" + }, + "verifier_error_code": { + "type": "string", + "description": "verifier error code" + }, + "verifier_binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifierBindingDTO" + }, + "description": "verifier bindings" + }, + "vendor": { + "type": "string", + "description": "vendor" + }, + "verification_status": { + "type": "string", + "description": "verification status" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "ID of management" + }, + "management_name": { + "type": "string", + "description": "name of management" + }, + "device_type": { + "$ref": "#/components/schemas/CpType" + }, + "revision_id": { + "type": "integer", + "format": "int32", + "description": "revision id" + }, + "vendor_type": { + "$ref": "#/components/schemas/VendorTypeDTO" + }, + "revision_number": { + "type": "integer", + "format": "int32", + "description": "revision number" + }, + "administrator": { + "type": "string", + "description": "name of administrator that made the change" + }, + "changed_on": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "management_ip": { + "type": "string", + "description": "ip of management" + }, + "received_on": { + "$ref": "#/components/schemas/LocalDateTime" + } + }, + "required": [ + "management_id", + "revision_id" + ] + }, + "VerifierOpmTargetDTO": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ResultDTO" + }, + "error": { + "$ref": "#/components/schemas/ErrorDTO" + }, + "requested_target": { + "type": "array", + "items": { + "type": "string" + }, + "description": "verifier opm requested target" + } + } + }, + "access_request_verifer_result_expanded": { + "type": "object", + "properties": { + "verifier_target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifierDeviceDTO" + }, + "description": "The targets verified" + }, + "verifier_opm_target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifierOpmTargetDTO" + }, + "description": "The opm targets verified" + }, + "topology_image_link": { + "$ref": "#/components/schemas/LinkDTO" + } + } + }, + "RelatedRulesResultDTO": { + "type": "object" + }, + "Map_String_String": { + "type": "object", + "properties": { + "entry": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Entry_String_String" + } + } + }, + "required": [ + "entry" + ] + }, + "multi_server_decommission_request": { + "type": "object", + "properties": { + "server_decommission_request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerDecommissionRequestDTO" + }, + "description": "The server decommission request" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "server_decommission_request", + "name", + "read_only" + ] + }, + "sa_service": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the service" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "TicketStagesListDTO": { + "type": "object", + "properties": { + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketStageDTO" + }, + "description": "The list of steps" + } + }, + "required": [ + "step" + ] + }, + "vip_nat_info": { + "type": "object", + "properties": { + "vip_mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VipMappingDTO" + } + }, + "interface_name": { + "type": "string" + } + } + }, + "additional_parameter_log_forwarding": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "check_point_nat_info": { + "type": "object", + "properties": { + "nat_type": { + "$ref": "#/components/schemas/NatType" + }, + "mapped_to_ip": { + "type": "string" + }, + "interface_name": { + "type": "string" + } + } + }, + "http_www.tufin.com_sc_subnet_network_object": { + "type": "object", + "properties": { + "mask": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "clone_server_policy_request": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + }, + "designer_result": { + "$ref": "#/components/schemas/DesignerDTO" + }, + "verifier_result": { + "$ref": "#/components/schemas/VerifierDTO" + }, + "from_server": { + "$ref": "#/components/schemas/NetworkObjectDTO" + }, + "to_servers": { + "$ref": "#/components/schemas/MultiServerDTO" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "from_server", + "to_servers", + "name", + "read_only" + ] + }, + "multi_hyperlink": { + "type": "object", + "properties": { + "hyperlink": { + "type": "array", + "items": { + "$ref": "#/components/schemas/hyperlink" + }, + "description": "The hyperlinks" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "hyperlink", + "name", + "read_only" + ] + }, + "ExternalRiskAnalysisResultDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The external risk's comment" + }, + "severity": { + "$ref": "#/components/schemas/RiskAnalysisSeverity" + }, + "status": { + "type": "string", + "description": "The external risk's status" + }, + "score": { + "type": "number", + "format": "double", + "description": "The external risk's score" + }, + "detailed_report_url": { + "type": "string", + "description": "The detailed_report_url of external risk" + } + }, + "required": [ + "comment", + "severity", + "status", + "score", + "detailed_report_url" + ] + }, + "RestrictedCellDTO": { + "type": "object", + "properties": { + "violatingServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "violatingApplications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInViolationDTO" + } + }, + "flow_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "flow_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "requirementServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "flow": { + "$ref": "#/components/schemas/FlowType" + }, + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + } + } + }, + "Comparator": { + "type": "object" + }, + "DeviceUserDTO": { + "type": "object", + "properties": { + "typeOnDevice": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "VipMappingDTO": { + "type": "object", + "properties": { + "mapped_to_ip": { + "type": "string" + }, + "virtual_port": { + "type": "string" + }, + "mapped_to_service": { + "$ref": "#/components/schemas/service" + } + } + }, + "VpnCommunityDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "internet_network_object": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RequiredReasonKeyDTO": { + "type": "object" + }, + "http_www.tufin.com_sc_policy_host_network_object": { + "type": "object", + "properties": { + "ip": { + "type": "string" + }, + "netmask": { + "type": "string" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "hostNetworkObjectDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the object" + }, + "ip": { + "type": "string", + "description": "The IP of the object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "PoolMemberDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the server group member" + }, + "ip": { + "type": "string", + "description": "The IP address of the server group member" + }, + "netmask": { + "type": "string", + "description": "The netmask for the IP address of the server group member" + } + } + }, + "clone_server_policy_verifer_result_expanded": { + "type": "object", + "properties": { + "cannot_compute_reason": { + "type": "string", + "description": "cannot compute reason error message" + }, + "verifier_target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerCloneVerificationDeviceDTO" + }, + "description": "The targets verified" + } + } + }, + "designer_link_result_link": { + "type": "object" + }, + "ResultDTO": { + "type": "object", + "properties": { + "version": { + "$ref": "#/components/schemas/VersionDTO" + }, + "device": { + "$ref": "#/components/schemas/OpmDeviceDTO" + }, + "combined_policy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "verifier combined policies result" + } + } + }, + "hyperlink": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "The Url" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "url", + "name", + "read_only" + ] + }, + "LinkDTO": { + "type": "object", + "properties": { + "@href": { + "type": "string", + "description": "The location of the referenced object" + } + }, + "required": [ + "@href" + ] + }, + "url_category": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "comment": { + "type": "string" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int32" + }, + "overrides": { + "type": "boolean" + }, + "overridden": { + "type": "boolean" + }, + "urls": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "unmatched_private_address_violation": { + "type": "object", + "properties": { + "violation_source_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The violating source network objects" + }, + "violation_destination_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The violating destination network objects" + }, + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "unmatched_private_address_violation_Applications": { + "type": "object", + "properties": { + "source_in_violation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "destination_in_violation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "TicketApplicationChangeListDTO": { + "type": "object", + "properties": { + "application_change": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketApplicationChangeDTO" + }, + "description": "The application changes list" + } + }, + "required": [ + "application_change" + ] + }, + "ServerGroupChange": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type of the change" + }, + "affected_connections": { + "type": "string", + "description": "affected connections" + }, + "object_name": { + "type": "string", + "description": "the name of the changed object" + }, + "description": { + "type": "string", + "description": "the description of the change" + } + } + }, + "CombinedPolicyDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "combined policy name" + }, + "result": { + "$ref": "#/components/schemas/CombinedPolicyResultDTO" + }, + "verification_status": { + "type": "string", + "description": "verification status" + } + } + }, + "GroupMemberNetworkObjectDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + }, + "status": { + "type": "string", + "description": "Group member's status" + }, + "object_updated_status": { + "type": "string", + "description": "Object status" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "status", + "name", + "read_only" + ] + }, + "users": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of users" + } + } + }, + "VerifierBindingDTO": { + "type": "object", + "properties": { + "implementing_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "description": "implementing rules for specific device binding" + }, + "violating_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "description": "violating rules for specific device binding" + }, + "verifier_warning": { + "type": "string", + "description": "warning" + }, + "verified": { + "type": "boolean", + "description": "whether binding is verified" + }, + "percent_implemented": { + "type": "number", + "format": "double", + "description": "implementation percent" + }, + "implementation_percentage_threshold": { + "type": "number", + "format": "double", + "description": "original threshold percent" + }, + "verifier_error": { + "type": "string", + "description": "verifier error message" + }, + "handled_by_implicit_cleanup_rule": { + "$ref": "#/components/schemas/RuleTrafficHandling" + }, + "verifier_error_code": { + "type": "string", + "description": "verifier error code" + }, + "binding": { + "$ref": "#/components/schemas/Binding_DTO" + } + } + }, + "networkObjectGroupDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type" + }, + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The members" + }, + "type_on_device": { + "type": "string", + "description": "type_on_device" + }, + "access_allowed": { + "type": "boolean", + "description": "access allowed" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "member", + "access_allowed", + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "http_www.tufin.com_sc_interface_ip": { + "type": "object", + "properties": { + "visibility": { + "type": "string", + "description": "Interface visibility" + }, + "ip": { + "type": "string", + "description": "interface Ip" + }, + "primary": { + "type": "boolean", + "description": "Indication if interface is primary" + } + }, + "required": [ + "visibility", + "ip", + "primary" + ] + }, + "security_zone_matrix_violation": { + "type": "object", + "properties": { + "security_zone_matrix": { + "$ref": "#/components/schemas/security_zone_matrix" + }, + "matrix_cell_violation": { + "$ref": "#/components/schemas/MatrixCellDTO" + }, + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "InterfaceIpDTO": { + "type": "object", + "properties": { + "visibility": { + "type": "string", + "description": "Object visibility" + }, + "ip": { + "type": "string", + "description": "Object IP" + }, + "subnet_mask": { + "type": "string", + "description": "Object subnet mask" + }, + "precedence": { + "type": "string", + "description": "Object precedence" + }, + "vendor_attachment_policy": { + "type": "string" + } + }, + "required": [ + "visibility", + "ip", + "subnet_mask", + "precedence" + ] + }, + "single_service_object": { + "type": "object", + "properties": { + "uid": { + "type": "string" + }, + "management_id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + } + } + }, + "network_object_cell_modification": { + "type": "object", + "properties": { + "device_network_object": { + "$ref": "#/components/schemas/device_network_object" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "action": { + "$ref": "#/components/schemas/Action" + } + }, + "required": [ + "device_network_object", + "action" + ] + }, + "TargetDTO": { + "type": "object", + "properties": { + "external_uid": { + "type": "string", + "description": "The external uid" + }, + "external_parent_uid": { + "type": "string", + "description": "The external parent uid" + }, + "tenant_id": { + "type": "string", + "description": "The tenant id" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "SlimRuleDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "rule name" + }, + "comment": { + "type": "string", + "description": "rule comment" + }, + "option": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleOption" + }, + "description": "options" + }, + "is_disabled": { + "type": "boolean", + "description": "is disabled" + }, + "uid": { + "type": "string", + "description": "rule uid" + }, + "action": { + "$ref": "#/components/schemas/RuleAction" + }, + "ruleNumber": { + "type": "integer", + "format": "int64", + "description": "rule number" + }, + "displayRuleNumber": { + "type": "string", + "description": "display_rule_number" + }, + "sourceNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "source networks" + }, + "destinationNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "destination networks" + }, + "destinationServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "destination services" + }, + "sourceServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "source services" + }, + "applications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + }, + "description": "application" + }, + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUserDTO" + }, + "description": "users" + }, + "additional_parameter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/additional_parameter" + }, + "description": "additional parameters" + }, + "url_category": { + "type": "array", + "items": { + "$ref": "#/components/schemas/url_category" + }, + "description": "url categories" + }, + "install_on": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "install on" + }, + "time": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TimeDTO" + }, + "description": "time" + }, + "community": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VpnCommunityDTO" + }, + "description": "communities" + }, + "track": { + "$ref": "#/components/schemas/RuleTrackDTO" + }, + "sub_policy": { + "$ref": "#/components/schemas/SubPolicyDTO" + }, + "rule_location": { + "type": "string", + "description": "rule_location" + }, + "negatedDestination": { + "type": "boolean", + "description": "The destination is negated" + }, + "negatedDestinationService": { + "type": "boolean", + "description": "The destination service is negated" + }, + "negatedSource": { + "type": "boolean", + "description": "The source is negated" + }, + "negatedSourceService": { + "type": "boolean", + "description": "The source service is negated" + }, + "from_zone": { + "type": "string", + "description": "from_zone" + }, + "to_zone": { + "type": "string", + "description": "to_zone" + } + } + }, + "http_www.tufin.com_sc_policy_host_network_object_with_interfaces": { + "type": "object", + "properties": { + "ip": { + "type": "string" + }, + "netmask": { + "type": "string" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "LocalDateTime": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "format": "int32" + } + } + }, + "compliance_policies": { + "type": "object", + "properties": { + "compliance_policy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CompliancePolicyDTO" + }, + "description": "The compliance policy for the risk" + } + } + }, + "decertify": { + "type": "object", + "properties": { + "binding__uid": { + "type": "string" + }, + "rule_uid": { + "type": "string" + }, + "update_status": { + "type": "string" + }, + "business_owner": { + "type": "string" + }, + "business_owner_email": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "binding__uid", + "rule_uid", + "update_status" + ] + }, + "modify_rule_modification": { + "type": "object", + "properties": { + "source_modifications": { + "$ref": "#/components/schemas/network_object_cell_modifications" + }, + "destination_modifications": { + "$ref": "#/components/schemas/network_object_cell_modifications" + }, + "service_modifications": { + "$ref": "#/components/schemas/service_object_cell_modifications" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "Rule modification ID" + }, + "rule_key": { + "$ref": "#/components/schemas/rule_key" + } + }, + "required": [ + "rule_key" + ] + }, + "OptionItemDTO": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Option value" + }, + "errorMsg": { + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "TicketCommentDTO": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "ViolationDTO": { + "type": "object", + "properties": { + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "ExpirationStatusDTO": { + "type": "object" + }, + "FQDNIpDTO": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "ipType": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "subnetMask": { + "type": "string" + } + } + }, + "OptionItemListDTO": { + "type": "object", + "properties": { + "option": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptionItemDTO" + }, + "description": "The option" + } + }, + "required": [ + "option" + ] + }, + "ServerCloneVerificationBindingDTO": { + "type": "object", + "properties": { + "rule_implemented": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerCloneVerificationSlimRuleDTO" + }, + "description": "implementing rules for specific device binding" + }, + "rule_not_implemented": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerCloneVerificationNotImplementedSlimRuleDTO" + }, + "description": "not implementing rules for specific device binding" + }, + "binding": { + "$ref": "#/components/schemas/Binding_DTO" + } + } + }, + "ServerCloneVerificationNotImplementedSlimRuleDTO": { + "type": "object", + "properties": { + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "rule's not implemented ip list" + }, + "object_name": { + "type": "array", + "items": { + "type": "string" + }, + "description": "overridden and overriding object name list" + }, + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "from_server": { + "$ref": "#/components/schemas/MarkedNetworkObjectsDTO" + }, + "to_servers": { + "$ref": "#/components/schemas/MarkedNetworkObjectsDTO" + } + } + }, + "ldap_entity": { + "type": "object", + "properties": { + "ldap_id": { + "type": "string" + }, + "ldap_dn": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "ServerDTO": { + "type": "object", + "properties": { + "host_name": { + "type": "string", + "description": "host name" + }, + "region": { + "type": "string", + "description": "region" + }, + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The external resource reference ips" + }, + "cidr": { + "type": "string", + "format": "int16", + "description": "cidr" + }, + "netmask": { + "type": "string", + "description": "netmask" + }, + "ip_address": { + "type": "string", + "description": "ip address" + }, + "range_first_ip": { + "type": "string", + "description": "min ip" + }, + "range_last_ip": { + "type": "string", + "description": "max ip" + }, + "nat_ip_address": { + "type": "string", + "description": "nat ip address" + }, + "dns_ip_addresses": { + "$ref": "#/components/schemas/MultiDnsIpAddressDTO" + }, + "nat_netmask": { + "type": "string", + "description": "nat netmask" + }, + "nat_cidr": { + "type": "string", + "format": "int16", + "description": "nat cidr" + }, + "resource_ref": { + "$ref": "#/components/schemas/resource_ref" + }, + "account_ref": { + "$ref": "#/components/schemas/account_ref" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "userObjectDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the user object" + }, + "ip": { + "type": "string", + "description": "The IP of the user object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "additional_parameter_security_profile": { + "type": "object", + "properties": { + "security_profile_category": { + "type": "string" + }, + "description": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "MultiSourceDTO": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SourceDTO" + }, + "description": "The sources" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "source", + "name", + "read_only" + ] + }, + "change_group_zone_object_scope": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Zone name" + }, + "is_global": { + "type": "boolean", + "description": "Is a global zone" + } + }, + "required": [ + "name", + "is_global" + ] + }, + "NetworkObjectInViolationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "RDVerificationRulesDTO": { + "type": "object", + "properties": { + "rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "description": "rules" + }, + "status": { + "type": "string" + } + } + }, + "ConnectionFullResourcesDTO": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of source's objects" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of destination's objects" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_service" + }, + "description": "List of service's objects" + }, + "status": { + "type": "string", + "description": "The status" + }, + "external": { + "type": "boolean", + "description": "is external" + }, + "connection_to_application": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "uid": { + "type": "string", + "description": "The UID" + }, + "applicationId": { + "type": "string" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The opened tickets" + } + }, + "required": [ + "name" + ] + }, + "service_object_cell_modification": { + "type": "object", + "properties": { + "device_service_object": { + "$ref": "#/components/schemas/device_service_object" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "action": { + "$ref": "#/components/schemas/Action" + } + }, + "required": [ + "device_service_object", + "action" + ] + }, + "AdminDomainDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "verifier_results": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "server decommission tool result status" + }, + "partial_result": { + "type": "boolean", + "description": "server decommission tool result is partial because ticket's rules quota was exceeded" + }, + "cannotComputeReason": { + "type": "string", + "description": "reason why server decommission tool could not compute" + }, + "result": { + "$ref": "#/components/schemas/DecommissionResultDTO" + } + } + }, + "VersionDTO": { + "type": "object", + "properties": { + "timestamp": { + "type": "string", + "description": "version timestamp" + } + } + }, + "ServiceChange": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type of the change" + }, + "affected_connections": { + "type": "string", + "description": "affected connections" + }, + "object_name": { + "type": "string", + "description": "the name of the changed object" + }, + "description": { + "type": "string", + "description": "the description of the change" + } + } + }, + "RDVerifierDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message" + }, + "status": { + "type": "string", + "description": "The status (whether it is verified or not)" + }, + "result": { + "$ref": "#/components/schemas/VerifierResultDTO" + }, + "reason": { + "$ref": "#/components/schemas/void" + } + } + }, + "icmp_service": { + "type": "object", + "properties": { + "min_icmp_type": { + "type": "integer", + "format": "int32" + }, + "max_icmp_type": { + "type": "integer", + "format": "int32" + }, + "icmp_code": { + "type": "integer", + "format": "int32" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RequestedTargetDTO": { + "type": "object", + "properties": { + "device": { + "$ref": "#/components/schemas/OpmDeviceDTO" + } + } + }, + "HostNetworkObjectWithInterfacesDTO": { + "type": "object", + "properties": { + "interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_interface_for_network_object" + }, + "description": "List of interfaces" + }, + "type": { + "type": "string", + "description": "The type of the object" + }, + "ip": { + "type": "string", + "description": "The IP of the object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "interface", + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "service_group": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service" + } + }, + "cisco_group_type": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "http_www.tufin.com_sc_any_service": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "service_object_cell_modifications": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "service_object_cell_modification": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service_object_cell_modification" + } + } + } + }, + "http_www.tufin.com_sc_url_category": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "PolicyZoneDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ZoneType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "global": { + "type": "boolean" + }, + "address_book": { + "type": "string" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "zone_name_in_parent": { + "type": "string" + } + } + }, + "vmInstanceDTO": { + "type": "object", + "properties": { + "host_name": { + "type": "string", + "description": "VM Instance host name" + }, + "status": { + "type": "string", + "description": "VM Instance state" + }, + "device_info": { + "$ref": "#/components/schemas/sa_device" + }, + "ip": { + "type": "string", + "description": "The IP of the object" + }, + "security_group": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CloudSecurityGroupDTO" + }, + "description": "List of security groups" + }, + "instance_type": { + "type": "string", + "description": "VM Instance type" + }, + "availability_zone": { + "type": "string", + "description": "VM Instance availability zone" + }, + "tags": { + "type": "string", + "format": "map", + "description": "VM Instance tags" + }, + "vendor": { + "type": "string", + "description": "VM Instance vendor" + }, + "instance_id": { + "type": "string", + "description": "VM Instance ID" + }, + "interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_interface_for_network_object" + }, + "description": "List of interfaces" + }, + "type": { + "type": "string", + "description": "The type of the object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "host_name", + "status", + "device_info", + "security_group", + "instance_type", + "availability_zone", + "tags", + "vendor", + "instance_id", + "interface", + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "TicketCommentListDTO": { + "type": "object", + "properties": { + "comment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketCommentDTO" + }, + "description": "The comment" + } + } + }, + "service": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "ItemDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "item name" + } + } + }, + "provisioning_provisioning_result_link": { + "type": "object" + }, + "TicketTaskFieldDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "ApplicationConnectionListDTO": { + "type": "object", + "properties": { + "connection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionDTO" + } + } + } + }, + "MarkedObjectsDTO": { + "type": "object", + "properties": { + "uid": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GroupMemberNetworkObjectListDTO": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GroupMemberNetworkObjectDTO" + }, + "description": "The members to change or add to the selected group" + } + }, + "required": [ + "member" + ] + }, + "time": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The time" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "value", + "name", + "read_only" + ] + }, + "range_network_object": { + "type": "object", + "properties": { + "max_ip": { + "type": "string" + }, + "min_ip": { + "type": "string" + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "applications": { + "type": "object", + "properties": { + "application": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The applications" + } + } + }, + "http_www.tufin.com_sc_policy_network_object": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "ApplicationDTO": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RiskDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message" + }, + "status": { + "type": "string", + "description": "The risk's status" + }, + "external_risk_analysis": { + "$ref": "#/components/schemas/ExternalRiskAnalysisResultDTO" + }, + "security_policy_violations": { + "$ref": "#/components/schemas/SecurityPolicyViolationDTO" + }, + "compliance_policies": { + "$ref": "#/components/schemas/compliance_policies" + }, + "compliance_and_usp_status": { + "type": "string" + }, + "reason": { + "type": "string", + "description": "The reason for the risk" + } + } + }, + "request_comment": { + "type": "object", + "properties": { + "task_id": { + "type": "integer", + "format": "int64", + "description": "The task id" + }, + "from_user_id": { + "type": "integer", + "format": "int64", + "description": "The responder user id" + }, + "replied": { + "type": "boolean", + "description": "The replied status" + }, + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "access_request_verifier_result_link": { + "type": "object" + }, + "ConnectionDTO": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of source's objects ref" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of destination's objects ref" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of service's objects ref" + }, + "status": { + "type": "string", + "description": "The status" + }, + "external": { + "type": "boolean", + "description": "is external" + }, + "connection_to_application": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "uid": { + "type": "string", + "description": "The UID" + }, + "applicationId": { + "type": "string" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The opened tickets" + } + }, + "required": [ + "name" + ] + }, + "ServiceDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "port": { + "type": "string", + "description": "port" + }, + "protocol": { + "type": "string", + "description": "protocol" + }, + "application_name": { + "type": "string", + "description": "application name" + }, + "non_default_ports": { + "type": "boolean", + "description": "The application identity includes non-default services" + }, + "predefined_name": { + "type": "string", + "description": "predefined name" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceDTO" + }, + "description": "application services" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "single_network_object": { + "type": "object", + "properties": { + "uid": { + "type": "string" + }, + "management_id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + } + } + }, + "multi_service": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceDTO" + }, + "description": "The services" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "service", + "name", + "read_only" + ] + }, + "UnlicensedDevicesForAutomationDTO": { + "type": "object", + "properties": { + "unlicensed_device_for_automation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "unlicensed devices for automation" + } + } + }, + "NetworkObjectDTO": { + "type": "object", + "properties": { + "host_name": { + "type": "string", + "description": "host name" + }, + "region": { + "type": "string", + "description": "region" + }, + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The external resource reference ips" + }, + "cidr": { + "type": "string", + "format": "int16", + "description": "cidr" + }, + "netmask": { + "type": "string", + "description": "netmask" + }, + "ip_address": { + "type": "string", + "description": "ip address" + }, + "range_first_ip": { + "type": "string", + "description": "min ip" + }, + "range_last_ip": { + "type": "string", + "description": "max ip" + }, + "nat_ip_address": { + "type": "string", + "description": "nat ip address" + }, + "dns_ip_addresses": { + "$ref": "#/components/schemas/MultiDnsIpAddressDTO" + }, + "nat_netmask": { + "type": "string", + "description": "nat netmask" + }, + "nat_cidr": { + "type": "string", + "format": "int16", + "description": "nat cidr" + }, + "resource_ref": { + "$ref": "#/components/schemas/resource_ref" + }, + "account_ref": { + "$ref": "#/components/schemas/account_ref" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "rangeNetworkObjectDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type" + }, + "last_ip": { + "type": "string", + "description": "Max ip" + }, + "first_ip": { + "type": "string", + "description": "Min ip" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "confirm_comment": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "RuleTrafficHandling": { + "type": "object" + }, + "rpc_service": { + "type": "object", + "properties": { + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "rule_key": { + "type": "object", + "properties": { + "binding_uid": { + "type": "string", + "description": "Rule binding UID" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "Rule device ID" + }, + "rule_uid": { + "type": "string", + "description": "Rule UID" + } + }, + "required": [ + "binding_uid", + "device_id", + "rule_uid" + ] + }, + "access_request_designer_result_expanded": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "redesign_status": { + "$ref": "#/components/schemas/RedesignStatusDTO" + }, + "device_suggestion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerDeviceSuggestionsDTO" + }, + "description": "List of devices to change" + }, + "error_description": { + "type": "string", + "description": "error description" + } + } + }, + "drop_down_list": { + "type": "object", + "properties": { + "options": { + "$ref": "#/components/schemas/OptionItemListDTO" + }, + "selection": { + "type": "string", + "description": "The selected options" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "options", + "selection", + "name", + "read_only" + ] + }, + "ip_network_object": { + "type": "object", + "properties": { + "mask": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "additional_parameter_tag": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RelatedRulesDeviceDTO": { + "type": "object", + "properties": { + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedRulesBindingDTO" + } + }, + "management_id": { + "type": "integer", + "format": "int32" + } + } + }, + "host_network_object": { + "type": "object", + "properties": { + "ip": { + "type": "string" + }, + "subnet_mask": { + "type": "string" + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "JavaLangAccess": { + "type": "object" + }, + "install_on_network_object": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "LocalTime": { + "type": "object" + }, + "ServiceInViolationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "http_www.tufin.com_sc_policy_service_group": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "InterfaceIpListDTO": { + "type": "object", + "properties": { + "interface_ip": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceIpDTO" + }, + "description": "Interface IPs" + } + }, + "required": [ + "interface_ip" + ] + }, + "CombinedPolicyResultDTO": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/ErrorDTO" + }, + "implementing": { + "$ref": "#/components/schemas/CombinedPolicyRulesResultDTO" + }, + "violating": { + "$ref": "#/components/schemas/CombinedPolicyRulesResultDTO" + } + } + }, + "RuleTrackDTO": { + "type": "object", + "properties": { + "track_level": { + "$ref": "#/components/schemas/RuleTrackLevel" + }, + "track_interval": { + "type": "integer", + "format": "int32" + } + } + }, + "reassign_comment": { + "type": "object", + "properties": { + "task_id": { + "type": "integer", + "format": "int64", + "description": "The task id" + }, + "assignee_id": { + "type": "integer", + "format": "int64", + "description": "The assignee id" + }, + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "additional_parameter": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "multi_group_change": { + "type": "object", + "properties": { + "group_change": { + "type": "array", + "items": { + "$ref": "#/components/schemas/group_change" + }, + "description": "The groups to modify" + }, + "designer_result": { + "$ref": "#/components/schemas/DesignerDTO" + }, + "implementation_status": { + "type": "string", + "description": "The implementation status" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "group_change", + "implementation_status", + "name", + "read_only" + ] + }, + "ServerCloneVerificationSlimRuleDTO": { + "type": "object", + "properties": { + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "from_server": { + "$ref": "#/components/schemas/MarkedNetworkObjectsDTO" + }, + "to_servers": { + "$ref": "#/components/schemas/MarkedNetworkObjectsDTO" + } + } + }, + "PermissionDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the permission" + }, + "value": { + "type": "boolean", + "description": "The permission setting" + }, + "key": { + "type": "string", + "description": "The Enum that represents the permission" + } + }, + "required": [ + "name", + "value" + ] + }, + "ServerCloneVerificationDeviceDTO": { + "type": "object", + "properties": { + "verifier_binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerCloneVerificationBindingDTO" + }, + "description": "verifier bindings" + }, + "vendor": { + "type": "string", + "description": "vendor" + }, + "verification_status": { + "type": "string", + "description": "verification status" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "ID of management" + }, + "management_name": { + "type": "string", + "description": "name of management" + }, + "device_type": { + "$ref": "#/components/schemas/CpType" + }, + "revision_id": { + "type": "integer", + "format": "int32", + "description": "revision id" + }, + "vendor_type": { + "$ref": "#/components/schemas/VendorTypeDTO" + }, + "revision_number": { + "type": "integer", + "format": "int32", + "description": "revision number" + }, + "administrator": { + "type": "string", + "description": "name of administrator that made the change" + }, + "changed_on": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "management_ip": { + "type": "string", + "description": "ip of management" + }, + "received_on": { + "$ref": "#/components/schemas/LocalDateTime" + } + }, + "required": [ + "management_id", + "revision_id" + ] + }, + "DesignerDTO": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "partial_result": { + "type": "boolean" + }, + "cannot_compute_reason": { + "type": "string" + }, + "warning_massage": { + "type": "string" + }, + "result": { + "$ref": "#/components/schemas/DesignerResultDTO" + }, + "opm_result": { + "$ref": "#/components/schemas/DesignerResultDTO" + }, + "opm_provisioning_result": { + "$ref": "#/components/schemas/DesignerResultDTO" + } + } + }, + "related_rules_related_rules_expanded": { + "type": "object", + "properties": { + "access_request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedRulesAccessRequestDTO" + } + } + } + }, + "reopen_comment": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "serviceGroupDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type" + }, + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of references to the service group members" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "type", + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "CloudSecurityGroupDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of security group" + }, + "uid": { + "type": "string", + "description": "UID of the security group" + } + }, + "required": [ + "uid" + ] + }, + "DesignerPersistedCommandDTO": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "push status" + }, + "order": { + "type": "integer", + "format": "int32" + }, + "command": { + "type": "string" + }, + "failure_reason": { + "type": "string", + "description": "in case that push failed" + } + } + }, + "http_www.tufin.com_sc_policy_range_network_object": { + "type": "object", + "properties": { + "max_ip": { + "type": "string" + }, + "min_ip": { + "type": "string" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "subnetNetworkObjectDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type" + }, + "prefix": { + "type": "string", + "description": "The prefix" + }, + "ip": { + "type": "string", + "description": "The ip" + }, + "netmask": { + "type": "string", + "description": "The netmask" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "fortigate_nat_info": { + "type": "object", + "properties": { + "port_forwarding_type": { + "type": "string", + "description": "port_forwarding_type" + }, + "src_filter": { + "type": "string", + "description": "src_filter" + }, + "src_interface_filter": { + "type": "string", + "description": "src_interface_filter" + }, + "Interface": { + "type": "string", + "description": "Interface" + }, + "mapped-ip": { + "type": "string", + "description": "mapped-ip" + }, + "mapped-ip-max": { + "type": "string", + "description": "mapped-ip-max" + }, + "external-port": { + "type": "string", + "description": "external-port" + }, + "mapped-port": { + "type": "string", + "description": "mapped-port" + }, + "forti_vip": { + "type": "boolean", + "description": "forti_vip" + }, + "interface_name": { + "type": "string" + } + } + }, + "behind_interface_nat": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "http_www.tufin.com_sc_interface_for_network_object": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Interface name" + }, + "interface_ip": { + "type": "array", + "items": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_interface_ip" + }, + "description": "List of interface ips" + } + }, + "required": [ + "name", + "interface_ip" + ] + }, + "TicketCurrentStageReferenceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The current step name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The current step id" + } + } + }, + "VerifierDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message" + }, + "status": { + "type": "string", + "description": "The status (whether it is verified or not)" + }, + "result": { + "$ref": "#/components/schemas/VerifierResultDTO" + }, + "reason": { + "$ref": "#/components/schemas/void" + } + } + }, + "RolesListDTO": { + "type": "object", + "properties": { + "role": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RoleDTO" + }, + "description": "The list of roles of the user" + } + }, + "required": [ + "role" + ] + }, + "RuleAction": { + "type": "object" + }, + "TicketTaskListDTO": { + "type": "object", + "properties": { + "task": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketTaskDTO" + }, + "description": "The list of tasks" + } + }, + "required": [ + "task" + ] + }, + "ImpactAnalysisDTO": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "server decommission tool result status" + }, + "partial_result": { + "type": "boolean", + "description": "server decommission tool result is partial because ticket's rules quota was exceeded" + }, + "cannotComputeReason": { + "type": "string", + "description": "reason why server decommission tool could not compute" + }, + "result": { + "$ref": "#/components/schemas/DecommissionResultDTO" + } + } + }, + "group_change": { + "type": "object", + "properties": { + "members": { + "$ref": "#/components/schemas/GroupMemberNetworkObjectListDTO" + }, + "zone": { + "$ref": "#/components/schemas/change_group_zone_object_scope" + }, + "address_book": { + "$ref": "#/components/schemas/AddressBookDTO" + }, + "failure_reason": { + "type": "string", + "description": "The failure reason" + }, + "change_action": { + "type": "string", + "description": "The group action" + }, + "change_implementation_status": { + "type": "string", + "description": "The status of the change request" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "members", + "zone", + "address_book", + "failure_reason", + "change_action", + "name", + "read_only" + ] + }, + "MembersOfListDTO": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartyDTO" + }, + "description": "The group to which the user belongs" + } + } + }, + "ComplianceRuleListDTO": { + "type": "object", + "properties": { + "compliance_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ComplianceRuleDTO" + }, + "description": "The list of compliance policy rules" + } + } + }, + "CommitReportStatus": { + "type": "object" + }, + "TimeDTO": { + "type": "object", + "properties": { + "month": { + "type": "string" + }, + "days": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "comments": { + "type": "string" + }, + "end_period": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "start_period": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "month_days": { + "type": "string" + }, + "time_interval_from1": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_from2": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_from3": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_to1": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_to2": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_to3": { + "$ref": "#/components/schemas/LocalTime" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "MarkedNetworkObjectsDTO": { + "type": "object", + "properties": { + "uid": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "commit_commit_result_link": { + "type": "object" + }, + "ServerChange": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type of the change" + }, + "affected_connections": { + "type": "string", + "description": "affected connections" + }, + "object_name": { + "type": "string", + "description": "the name of the changed object" + }, + "description": { + "type": "string", + "description": "the description of the change" + } + } + }, + "subnet_network_object": { + "type": "object", + "properties": { + "ip": { + "type": "string" + }, + "subnet_mask": { + "type": "string" + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RDVerifierBindingDTO": { + "type": "object", + "properties": { + "binding_name": { + "type": "string", + "description": "binding name" + }, + "binding_uid": { + "type": "string", + "description": "binding uid" + }, + "implemented_rules": { + "$ref": "#/components/schemas/RDVerificationRulesDTO" + }, + "violated_rules_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RDVerificationRulesDTO" + }, + "description": "violated rules lists" + } + } + }, + "RuleOption": { + "type": "object" + }, + "DesignerInstructionDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "content": { + "type": "string" + }, + "error_message": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "status": { + "type": "string" + }, + "rule_uid": { + "type": "string" + }, + "warning_message": { + "type": "string" + }, + "tag": { + "type": "array", + "items": { + "type": "string" + } + }, + "instruction_type": { + "type": "string" + }, + "rule_order": { + "type": "string" + }, + "rule_placement": { + "type": "string" + }, + "implementation_failure_reason": { + "type": "string" + }, + "requested_network_object_name": { + "type": "string" + }, + "requested_service_object_name": { + "type": "string" + }, + "rule_name": { + "type": "string" + }, + "original_shadowed_rule_num": { + "type": "integer", + "format": "int64" + }, + "original_shadowed_rule_name": { + "type": "string" + }, + "security_group": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityGroupDTO" + } + }, + "application_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + } + }, + "display_rule_order": { + "type": "string" + }, + "log_forwarding_profile": { + "type": "string" + }, + "source_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "destination_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "service_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service" + } + }, + "modified_object_name": { + "type": "string" + }, + "order": { + "type": "array", + "items": { + "type": "string" + } + }, + "modified_object_uid": { + "type": "string" + }, + "change_action": { + "type": "string" + }, + "before_global": { + "type": "boolean" + }, + "security_profile_group": { + "type": "string" + }, + "implementing_access_request": { + "type": "string" + }, + "url_category_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/url_category" + } + }, + "device_added_network_object": { + "$ref": "#/components/schemas/network_object" + }, + "device_added_service_object": { + "$ref": "#/components/schemas/service" + }, + "device_removed_network_object": { + "$ref": "#/components/schemas/network_object" + }, + "device_removed_service_object": { + "$ref": "#/components/schemas/service" + }, + "before_section": { + "type": "boolean" + }, + "device_modified_network_object": { + "$ref": "#/components/schemas/network_object" + }, + "device_modified_service_object": { + "$ref": "#/components/schemas/service" + }, + "modified_field": { + "type": "array", + "items": { + "type": "string" + } + }, + "device_added_user_object": { + "$ref": "#/components/schemas/DeviceUserDTO" + }, + "requested_user_object_name": { + "type": "string" + }, + "user_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUserDTO" + } + } + } + }, + "security_zone_matrix": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "RiskAnalysisSeverity": { + "type": "object" + }, + "rule_modification_field": { + "type": "object", + "properties": { + "designer_result": { + "$ref": "#/components/schemas/DesignerDTO" + }, + "rule_modification": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rule_modification" + }, + "description": "List of rule modifications" + }, + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_RuleOperationDeviceDTO" + }, + "description": "List of devices" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "device", + "name", + "read_only" + ] + }, + "reject_comment": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "VerifierResultDTO": { + "type": "object" + }, + "BaseServiceDTO": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RedesignNotRequiredStatus": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/RedesignStatusEnumDTO" + } + } + }, + "multi_text_area": { + "type": "object", + "properties": { + "text_area": { + "type": "array", + "items": { + "$ref": "#/components/schemas/text_area" + }, + "description": "The text area" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "text_area", + "name", + "read_only" + ] + }, + "http_www.tufin.com_sc_any_network_object": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "clone_server_policy_verifier_result_link": { + "type": "object" + }, + "any_network_object": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RangeDTO": { + "type": "object", + "properties": { + "from": { + "type": "integer", + "format": "int32" + }, + "to": { + "type": "integer", + "format": "int32" + } + } + }, + "AddressBookDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Address book name" + } + }, + "required": [ + "name" + ] + }, + "SecurityPolicyViolationSeverity": { + "type": "object" + }, + "basicNetworkObjectDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the network object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "restricted_cell_violation": { + "type": "object", + "properties": { + "not_allowed_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "not_allowed_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInViolationDTO" + } + }, + "allowed_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "allowed_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInViolationDTO" + } + }, + "flow_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "flow_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "flow": { + "$ref": "#/components/schemas/FlowType" + }, + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + } + } + }, + "SecurityGroupDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Security group name" + }, + "uid": { + "type": "string", + "description": "Security group uid" + } + }, + "required": [ + "name", + "uid" + ] + }, + "MultiServerDTO": { + "type": "object", + "properties": { + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerDTO" + }, + "description": "The servers" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "server", + "name", + "read_only" + ] + }, + "RuleTrackLevel": { + "type": "object", + "properties": { + "displayName": { + "type": "string" + } + } + }, + "text_field": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The text field" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "text", + "name", + "read_only" + ] + }, + "FlowType": { + "type": "object" + }, + "domain_network_object": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "fqdnIps": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "WorkflowReferenceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The workflow name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The workflow ID" + }, + "uses_topology": { + "type": "boolean", + "description": "When the value is true, the Access Request tools in the workflow use Topology. When the value is false, the Access Request tools in the workflow do not use Topology." + } + }, + "required": [ + "name" + ] + }, + "ip_service": { + "type": "object", + "properties": { + "min_protocol": { + "type": "integer", + "format": "int32" + }, + "max_protocol": { + "type": "integer", + "format": "int32" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "date": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The date" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "value", + "name", + "read_only" + ] + }, + "SaApplicationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "owner": { + "type": "string" + }, + "domain_id": { + "type": "integer", + "format": "int32" + } + } + }, + "VerifierResultLinkDTO": { + "type": "object" + }, + "PartyDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the user" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyDTOType" + }, + "display_name": { + "type": "string", + "description": "The display name of the user" + }, + "email": { + "type": "string", + "description": "The email of the user" + }, + "ldapDn": { + "type": "string", + "description": "The LDAP DN of the user" + }, + "ldap_configuration": { + "$ref": "#/components/schemas/LdapConfigurationDTO" + }, + "roles": { + "$ref": "#/components/schemas/RolesListDTO" + }, + "authentication_method": { + "type": "string", + "description": "The method of authentication for the user" + }, + "origin_type": { + "type": "string", + "description": "The origin type of the user, 'Local' is available to GET only" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member_of": { + "$ref": "#/components/schemas/MembersOfListDTO" + }, + "domains": { + "$ref": "#/components/schemas/DomainsListDTO" + } + }, + "required": [ + "name" + ] + }, + "http_www.tufin.com_sc_range_network_object": { + "type": "object", + "properties": { + "max_ip": { + "type": "string" + }, + "min_ip": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "certify": { + "type": "object", + "properties": { + "certification_expiration_date": { + "type": "string" + }, + "binding__uid": { + "type": "string" + }, + "rule_uid": { + "type": "string" + }, + "update_status": { + "type": "string" + }, + "business_owner": { + "type": "string" + }, + "business_owner_email": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "certification_expiration_date", + "binding__uid", + "rule_uid", + "update_status" + ] + }, + "MultiDnsIpAddressDTO": { + "type": "object", + "properties": { + "ip_address": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of dns ip address" + } + } + }, + "network_object_group": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "exclusion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "application_default_service": { + "type": "object", + "properties": { + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "rule_recertification_info": { + "type": "object", + "properties": { + "binding__uid": { + "type": "string" + }, + "rule_uid": { + "type": "string" + }, + "update_status": { + "type": "string" + }, + "business_owner": { + "type": "string" + }, + "business_owner_email": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "binding__uid", + "rule_uid", + "update_status" + ] + }, + "sa_device": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Device name" + }, + "id": { + "type": "integer", + "format": "int32", + "description": "Device ID" + }, + "region": { + "type": "string", + "description": "Device region" + } + }, + "required": [ + "name", + "id", + "region" + ] + }, + "localuser": { + "type": "object", + "properties": { + "password": { + "type": "string", + "description": "The user's password" + }, + "email": { + "type": "string", + "description": "The email of the user" + }, + "firstName": { + "type": "string", + "description": "First name" + }, + "lastName": { + "type": "string", + "description": "Last name" + }, + "ldapConfiguration": { + "$ref": "#/components/schemas/LdapConfigurationDTO" + }, + "originType": { + "type": "string", + "description": "The origin type of the user, 'Local' is available to GET only" + }, + "default_authentication": { + "type": "boolean", + "description": "The default authentication" + }, + "phone": { + "type": "string", + "description": "Phone" + }, + "notes": { + "type": "string", + "description": "Notes" + }, + "name": { + "type": "string", + "description": "The login name of the user" + }, + "out_of_office_from": { + "type": "string", + "description": "Out of office from" + }, + "out_of_office_until": { + "type": "string", + "description": "Out of office until" + }, + "send_email": { + "type": "boolean", + "description": "Send email to the user" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyDTOType" + }, + "display_name": { + "type": "string", + "description": "The display name of the user" + }, + "ldapDn": { + "type": "string", + "description": "The LDAP DN of the user" + }, + "roles": { + "$ref": "#/components/schemas/RolesListDTO" + }, + "authentication_method": { + "type": "string", + "description": "The method of authentication for the user" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member_of": { + "$ref": "#/components/schemas/MembersOfListDTO" + }, + "domains": { + "$ref": "#/components/schemas/DomainsListDTO" + } + }, + "required": [ + "password", + "name" + ] + }, + "DomainsListDTO": { + "type": "object", + "properties": { + "domain": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DomainDTO" + }, + "description": "The list of domains" + } + }, + "required": [ + "domain" + ] + }, + "SourceDTO": { + "type": "object", + "properties": { + "ldap_entity_id": { + "type": "string", + "description": "ldap group Id" + }, + "ldap_entity_dn": { + "type": "string", + "description": "ldap group dn" + }, + "ldap_entity_name": { + "type": "string", + "description": "ldap group name" + }, + "host_name": { + "type": "string", + "description": "host name" + }, + "region": { + "type": "string", + "description": "region" + }, + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The external resource reference ips" + }, + "cidr": { + "type": "string", + "format": "int16", + "description": "cidr" + }, + "netmask": { + "type": "string", + "description": "netmask" + }, + "ip_address": { + "type": "string", + "description": "ip address" + }, + "range_first_ip": { + "type": "string", + "description": "min ip" + }, + "range_last_ip": { + "type": "string", + "description": "max ip" + }, + "nat_ip_address": { + "type": "string", + "description": "nat ip address" + }, + "dns_ip_addresses": { + "$ref": "#/components/schemas/MultiDnsIpAddressDTO" + }, + "nat_netmask": { + "type": "string", + "description": "nat netmask" + }, + "nat_cidr": { + "type": "string", + "format": "int16", + "description": "nat cidr" + }, + "resource_ref": { + "$ref": "#/components/schemas/resource_ref" + }, + "account_ref": { + "$ref": "#/components/schemas/account_ref" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "http_www.tufin.com_sc_policy_service_object": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "ApplicationInViolationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "NatInfoDTO": { + "type": "object", + "properties": { + "interface_name": { + "type": "string" + } + } + }, + "any_application": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "TicketApplicationChangeDTO": { + "type": "object" + }, + "MatrixCellDTO": { + "type": "object", + "properties": { + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + } + } + }, + "CommentOriginDTO": { + "type": "object" + }, + "InterfaceForNetworkObjectDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name of interface" + }, + "anti_spoof_disabled": { + "type": "boolean", + "description": "Anti spoof disabled indicator" + }, + "interface_ips": { + "$ref": "#/components/schemas/InterfaceIpListDTO" + } + }, + "required": [ + "name", + "anti_spoof_disabled", + "interface_ips" + ] + }, + "DesignerResultDTO": { + "type": "object" + }, + "UUID": { + "type": "object" + }, + "port_service": { + "type": "object", + "properties": { + "port": { + "type": "integer", + "format": "int32" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "GroupPermissionDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the permission" + }, + "value": { + "type": "boolean", + "description": "The permission setting" + } + } + }, + "group": { + "type": "object", + "properties": { + "members": { + "$ref": "#/components/schemas/MembersListDTO" + }, + "groupPermissions": { + "$ref": "#/components/schemas/GroupPermissionsListDTO" + }, + "description": { + "type": "string", + "description": "Description of the group" + }, + "name": { + "type": "string", + "description": "The name of the user" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyDTOType" + }, + "display_name": { + "type": "string", + "description": "The display name of the user" + }, + "email": { + "type": "string", + "description": "The email of the user" + }, + "ldapDn": { + "type": "string", + "description": "The LDAP DN of the user" + }, + "ldap_configuration": { + "$ref": "#/components/schemas/LdapConfigurationDTO" + }, + "roles": { + "$ref": "#/components/schemas/RolesListDTO" + }, + "authentication_method": { + "type": "string", + "description": "The method of authentication for the user" + }, + "origin_type": { + "type": "string", + "description": "The origin type of the user, 'Local' is available to GET only" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member_of": { + "$ref": "#/components/schemas/MembersOfListDTO" + }, + "domains": { + "$ref": "#/components/schemas/DomainsListDTO" + } + }, + "required": [ + "name" + ] + }, + "http_www.tufin.com_sc_policy_ip_service": { + "type": "object", + "properties": { + "protocol": { + "$ref": "#/components/schemas/RangeDTO" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "DestinationDTO": { + "type": "object", + "properties": { + "url_category_name": { + "type": "string", + "description": "urlCategoryName" + }, + "host_name": { + "type": "string", + "description": "host name" + }, + "region": { + "type": "string", + "description": "region" + }, + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The external resource reference ips" + }, + "cidr": { + "type": "string", + "format": "int16", + "description": "cidr" + }, + "netmask": { + "type": "string", + "description": "netmask" + }, + "ip_address": { + "type": "string", + "description": "ip address" + }, + "range_first_ip": { + "type": "string", + "description": "min ip" + }, + "range_last_ip": { + "type": "string", + "description": "max ip" + }, + "nat_ip_address": { + "type": "string", + "description": "nat ip address" + }, + "dns_ip_addresses": { + "$ref": "#/components/schemas/MultiDnsIpAddressDTO" + }, + "nat_netmask": { + "type": "string", + "description": "nat netmask" + }, + "nat_cidr": { + "type": "string", + "format": "int16", + "description": "nat cidr" + }, + "resource_ref": { + "$ref": "#/components/schemas/resource_ref" + }, + "account_ref": { + "$ref": "#/components/schemas/account_ref" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "internetNetworkObjectDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the network object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "blocked_only_matrix_cell_violation": { + "type": "object", + "properties": { + "not_blocked_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "not_blocked_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInViolationDTO" + } + }, + "blocked_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "flow_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "flow_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "flow": { + "$ref": "#/components/schemas/FlowType" + }, + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + } + } + }, + "additional_parameter_central_nat": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "cloud_slim_rule": { + "type": "object", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "priority" + }, + "ip_type": { + "type": "string", + "description": "ip type" + }, + "name": { + "type": "string", + "description": "rule name" + }, + "comment": { + "type": "string", + "description": "rule comment" + }, + "option": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleOption" + }, + "description": "options" + }, + "is_disabled": { + "type": "boolean", + "description": "is disabled" + }, + "uid": { + "type": "string", + "description": "rule uid" + }, + "action": { + "$ref": "#/components/schemas/RuleAction" + }, + "ruleNumber": { + "type": "integer", + "format": "int64", + "description": "rule number" + }, + "displayRuleNumber": { + "type": "string", + "description": "display_rule_number" + }, + "sourceNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "source networks" + }, + "destinationNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "destination networks" + }, + "destinationServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "destination services" + }, + "sourceServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "source services" + }, + "applications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + }, + "description": "application" + }, + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUserDTO" + }, + "description": "users" + }, + "additional_parameter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/additional_parameter" + }, + "description": "additional parameters" + }, + "url_category": { + "type": "array", + "items": { + "$ref": "#/components/schemas/url_category" + }, + "description": "url categories" + }, + "install_on": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "install on" + }, + "time": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TimeDTO" + }, + "description": "time" + }, + "community": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VpnCommunityDTO" + }, + "description": "communities" + }, + "track": { + "$ref": "#/components/schemas/RuleTrackDTO" + }, + "sub_policy": { + "$ref": "#/components/schemas/SubPolicyDTO" + }, + "rule_location": { + "type": "string", + "description": "rule_location" + }, + "negatedDestination": { + "type": "boolean", + "description": "The destination is negated" + }, + "negatedDestinationService": { + "type": "boolean", + "description": "The destination service is negated" + }, + "negatedSource": { + "type": "boolean", + "description": "The source is negated" + }, + "negatedSourceService": { + "type": "boolean", + "description": "The source service is negated" + }, + "from_zone": { + "type": "string", + "description": "from_zone" + }, + "to_zone": { + "type": "string", + "description": "to_zone" + } + } + }, + "RedesignRequiredStatus": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/RedesignStatusEnumDTO" + }, + "reason": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of required reasons" + } + } + }, + "http_www.tufin.com_sc_policy_icmp_service": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/RangeDTO" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "multi_access_request": { + "type": "object", + "properties": { + "designer_result": { + "$ref": "#/components/schemas/DesignerDTO" + }, + "designer_verifier_advanced_option": { + "type": "string", + "description": "The access request rule customization option" + }, + "access_request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRuleDTO" + }, + "description": "The access request" + }, + "related_rules_result": { + "$ref": "#/components/schemas/RelatedRulesResultDTO" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "designer_result", + "access_request", + "name", + "read_only" + ] + }, + "http_www.tufin.com_sc_slim_rule_with_metadata": { + "type": "object", + "properties": { + "rule_metadata": { + "$ref": "#/components/schemas/RuleMetaDataDTO" + }, + "name": { + "type": "string", + "description": "rule name" + }, + "comment": { + "type": "string", + "description": "rule comment" + }, + "option": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleOption" + }, + "description": "options" + }, + "is_disabled": { + "type": "boolean", + "description": "is disabled" + }, + "uid": { + "type": "string", + "description": "rule uid" + }, + "action": { + "$ref": "#/components/schemas/RuleAction" + }, + "ruleNumber": { + "type": "integer", + "format": "int64", + "description": "rule number" + }, + "displayRuleNumber": { + "type": "string", + "description": "display_rule_number" + }, + "sourceNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "source networks" + }, + "destinationNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "destination networks" + }, + "destinationServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "destination services" + }, + "sourceServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "source services" + }, + "applications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + }, + "description": "application" + }, + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUserDTO" + }, + "description": "users" + }, + "additional_parameter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/additional_parameter" + }, + "description": "additional parameters" + }, + "url_category": { + "type": "array", + "items": { + "$ref": "#/components/schemas/url_category" + }, + "description": "url categories" + }, + "install_on": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "install on" + }, + "time": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TimeDTO" + }, + "description": "time" + }, + "community": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VpnCommunityDTO" + }, + "description": "communities" + }, + "track": { + "$ref": "#/components/schemas/RuleTrackDTO" + }, + "sub_policy": { + "$ref": "#/components/schemas/SubPolicyDTO" + }, + "rule_location": { + "type": "string", + "description": "rule_location" + }, + "negatedDestination": { + "type": "boolean", + "description": "The destination is negated" + }, + "negatedDestinationService": { + "type": "boolean", + "description": "The destination service is negated" + }, + "negatedSource": { + "type": "boolean", + "description": "The source is negated" + }, + "negatedSourceService": { + "type": "boolean", + "description": "The source service is negated" + }, + "from_zone": { + "type": "string", + "description": "from_zone" + }, + "to_zone": { + "type": "string", + "description": "to_zone" + } + } + }, + "designer_result_link": { + "type": "object" + }, + "additional_parameter_direction": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RelatedRuleContainerDTO": { + "type": "object", + "properties": { + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "ignore": { + "type": "boolean" + }, + "intersecting_objects": { + "$ref": "#/components/schemas/MarkedObjectsDTO" + } + } + }, + "CompliancePolicyDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The compliance policy name" + }, + "type": { + "type": "string", + "description": "The compliance policy type" + }, + "compliance_rules": { + "$ref": "#/components/schemas/ComplianceRuleListDTO" + } + } + }, + "mip_nat_info": { + "type": "object", + "properties": { + "mapped_to_ip": { + "type": "string" + }, + "virtual_router": { + "type": "string" + }, + "interface_name": { + "type": "string" + } + } + }, + "ErrorDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "error message" + }, + "code": { + "type": "string", + "description": "error code" + } + } + }, + "DeviceUserGroupDTO": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUserDTO" + } + }, + "typeOnDevice": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "rule_decommission_verifier_result_expanded": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RDVerifierDeviceDTO" + }, + "description": "The targets verified" + } + } + }, + "identity_awareness_object": { + "type": "object", + "properties": { + "network_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/identity_awareness_user" + } + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "NatType": { + "type": "object" + }, + "rule_modification": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "Rule modification ID" + }, + "rule_key": { + "$ref": "#/components/schemas/rule_key" + } + }, + "required": [ + "rule_key" + ] + }, + "TicketTaskDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The task name" + }, + "fields": { + "$ref": "#/components/schemas/TicketTaskFieldListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task ID" + }, + "status": { + "type": "string", + "description": "The task status" + }, + "unlicensed_devices_for_automation": { + "$ref": "#/components/schemas/UnlicensedDevicesForAutomationDTO" + }, + "pending_reason": { + "type": "string", + "description": "The task pending reason" + }, + "assignee_id": { + "type": "integer", + "format": "int64", + "description": "The assignee ID" + }, + "task_business_duration": { + "type": "integer", + "format": "int64", + "description": "The task business duration" + }, + "assignee": { + "type": "string", + "description": "The task assignee" + }, + "is_assigner": { + "type": "boolean", + "description": "Indicates whether the handler is the assigner" + }, + "assignee_participant_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the participant the assignee is based on" + }, + "pending_reason_description": { + "type": "string", + "description": "The task pending reason description" + }, + "potential_handlers": { + "$ref": "#/components/schemas/PartyListDTO" + } + }, + "required": [ + "fields", + "id", + "status", + "assignee" + ] + }, + "AccessRuleDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + }, + "labels": { + "$ref": "#/components/schemas/labels" + }, + "order": { + "type": "string", + "description": "The order" + }, + "action": { + "type": "string", + "description": "The action" + }, + "applications": { + "$ref": "#/components/schemas/applications" + }, + "users": { + "$ref": "#/components/schemas/users" + }, + "targets": { + "$ref": "#/components/schemas/multi_target" + }, + "uuid": { + "$ref": "#/components/schemas/UUID" + }, + "source_domain": { + "type": "string", + "description": "For SecureChange, The name of the source domain. For SecureApp, The name of the source customer. mandatory if interconnected domain mode is enabled" + }, + "destination_domain": { + "type": "string", + "description": "For SecureChange, The name of the destination domain. For SecureApp, The name of the destination customer. mandatory if interconnected domain mode is enabled" + }, + "sources": { + "$ref": "#/components/schemas/MultiSourceDTO" + }, + "destinations": { + "$ref": "#/components/schemas/MultiDestinationDTO" + }, + "use_topology": { + "type": "boolean" + }, + "verifier_result": { + "$ref": "#/components/schemas/VerifierDTO" + }, + "risk_analysis_result": { + "$ref": "#/components/schemas/RiskDTO" + }, + "services": { + "$ref": "#/components/schemas/multi_service" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "action", + "targets", + "source_domain", + "destination_domain", + "sources", + "destinations", + "services", + "name", + "read_only" + ] + }, + "CombinedPolicyRulesResultDTO": { + "type": "object", + "properties": { + "rule": { + "type": "array", + "items": { + "type": "string" + }, + "description": "rules" + }, + "implicit_cleanup": { + "type": "boolean", + "description": "implicit cleanup" + } + } + }, + "PermissionListDTO": { + "type": "object", + "properties": { + "permission": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PermissionDTO" + }, + "description": "The list of permissions" + } + }, + "required": [ + "permission" + ] + }, + "RuleCertificationDTO": { + "type": "object", + "properties": { + "certification_id": { + "type": "integer", + "format": "int64" + }, + "certification_date": { + "$ref": "#/components/schemas/Optional" + }, + "certification_status": { + "$ref": "#/components/schemas/RuleCertificationStatus" + }, + "certification_expiration_date": { + "$ref": "#/components/schemas/Optional" + } + } + }, + "ShadowedStatus": { + "type": "object" + }, + "alias": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "exclusion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "PartyListDTO": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartyDTO" + }, + "description": "The list of users" + } + }, + "required": [ + "user" + ] + }, + "Chronology": { + "type": "object" + }, + "network_object": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "designer_designer_result_link": { + "type": "object" + }, + "blocked_cell_violation": { + "type": "object", + "properties": { + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + } + } + }, + "PushStatusReasonDTO": { + "type": "object" + }, + "ComplianceRuleDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The compliance rule name" + }, + "number": { + "type": "string", + "description": "The compliance rule number" + } + } + }, + "rule_decommission": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "The action" + }, + "designer_result": { + "$ref": "#/components/schemas/DesignerDTO" + }, + "verifier_result": { + "$ref": "#/components/schemas/RDVerifierDTO" + }, + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_RuleOperationDeviceDTO" + }, + "description": "List of devices" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "action", + "designer_result", + "verifier_result", + "device", + "name", + "read_only" + ] + }, + "cloud_security_group": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "exclusion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "singleServiceDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type" + }, + "protocol": { + "type": "string", + "format": "int16", + "description": "The protocol number, for IP service: protocol is not specified." + }, + "min": { + "type": "integer", + "format": "int32", + "description": "For IP, TCP and UDP Services: the minimum port number, ICMP Service: the ICMP type number." + }, + "max": { + "type": "integer", + "format": "int32", + "description": "For IP, TCP and UDP Services: the maximum port number." + }, + "timeout": { + "type": "string", + "description": "The timeout value for the service in seconds" + }, + "application_identity_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Layer7ApplicationServiceDTO" + }, + "description": "The application identity services" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "TicketTaskFieldListDTO": { + "type": "object", + "properties": { + "field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketTaskFieldDTO" + }, + "description": "The field parameter" + } + }, + "required": [ + "field" + ] + }, + "DesignerDeviceSuggestionsDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "management_id": { + "type": "integer", + "format": "int64" + }, + "management_name": { + "type": "string" + }, + "redesign_status": { + "$ref": "#/components/schemas/RedesignStatusDTO" + }, + "vendor_name": { + "type": "string" + }, + "offline_device": { + "type": "boolean", + "description": "is offline device" + }, + "device_software_version": { + "type": "string" + }, + "push_status_reason": { + "$ref": "#/components/schemas/PushStatusReasonDTO" + }, + "change_id": { + "type": "string" + }, + "revision_number": { + "type": "integer", + "format": "int32" + }, + "ancestor_management_id": { + "type": "integer", + "format": "int32" + }, + "ancestor_management_name": { + "type": "string" + }, + "ancestor_management_revision_id": { + "type": "integer", + "format": "int32" + }, + "new_revision_arrived": { + "type": "boolean", + "description": "is new revision arrived" + }, + "push_status": { + "type": "string" + }, + "push_request_id": { + "type": "integer", + "format": "int64" + }, + "designer_command": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerPersistedCommandDTO" + } + }, + "binding_suggestion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerBindingSuggestionsDTO" + } + }, + "commit_results": { + "$ref": "#/components/schemas/CommitResultsDTO" + } + } + }, + "SecurityPolicyViolationDTO": { + "type": "object", + "properties": { + "security_policy_violation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ViolationDTO" + } + } + } + }, + "RDVerifierDeviceDTO": { + "type": "object", + "properties": { + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RDVerifierBindingDTO" + }, + "description": "bindings" + }, + "verifierError": { + "$ref": "#/components/schemas/RDVerifierError" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "ID of management" + }, + "management_name": { + "type": "string", + "description": "name of management" + }, + "device_type": { + "$ref": "#/components/schemas/CpType" + }, + "revision_id": { + "type": "integer", + "format": "int32", + "description": "revision id" + }, + "vendor_type": { + "$ref": "#/components/schemas/VendorTypeDTO" + }, + "revision_number": { + "type": "integer", + "format": "int32", + "description": "revision number" + }, + "administrator": { + "type": "string", + "description": "name of administrator that made the change" + }, + "changed_on": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "management_ip": { + "type": "string", + "description": "ip of management" + }, + "received_on": { + "$ref": "#/components/schemas/LocalDateTime" + } + }, + "required": [ + "management_id", + "revision_id" + ] + }, + "identity_awareness_user": { + "type": "object", + "properties": { + "dn": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "redo_comment": { + "type": "object", + "properties": { + "redo_stage_id": { + "type": "integer", + "format": "int64", + "description": "The stage to which the redo was applied" + }, + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "GroupPermissionsListDTO": { + "type": "object", + "properties": { + "groupPermission": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GroupPermissionDTO" + }, + "description": "The list of permissions for this group" + } + } + }, + "resource_ref": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The resource ref name" + }, + "id": { + "type": "string", + "description": "The resource ref ID" + }, + "type": { + "type": "string", + "description": "The resource ref type" + } + } + }, + "Entry_String_String": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + }, + "userObjectGroupDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type" + }, + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of references to the user group members" + }, + "ip": { + "type": "string", + "description": "The IP of the user object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "user": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The login name of the user" + }, + "first_name": { + "type": "string", + "description": "First name" + }, + "last_name": { + "type": "string", + "description": "Last name" + }, + "out_of_office_from": { + "type": "string", + "description": "Out of office from" + }, + "out_of_office_until": { + "type": "string", + "description": "Out of office until" + }, + "phone": { + "type": "string", + "description": "Phone" + }, + "notes": { + "type": "string", + "description": "Notes" + }, + "send_email": { + "type": "boolean", + "description": "Send email to the user" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyDTOType" + }, + "display_name": { + "type": "string", + "description": "The display name of the user" + }, + "email": { + "type": "string", + "description": "The email of the user" + }, + "ldapDn": { + "type": "string", + "description": "The LDAP DN of the user" + }, + "ldap_configuration": { + "$ref": "#/components/schemas/LdapConfigurationDTO" + }, + "roles": { + "$ref": "#/components/schemas/RolesListDTO" + }, + "authentication_method": { + "type": "string", + "description": "The method of authentication for the user" + }, + "origin_type": { + "type": "string", + "description": "The origin type of the user, 'Local' is available to GET only" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member_of": { + "$ref": "#/components/schemas/MembersOfListDTO" + }, + "domains": { + "$ref": "#/components/schemas/DomainsListDTO" + } + }, + "required": [ + "name" + ] + }, + "LdapConfigurationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the LDAP server" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the LDAP server" + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port of the LDAP server" + }, + "server": { + "type": "string", + "description": "The server (host) of the LDAP server" + }, + "trust_any_certificate": { + "type": "boolean", + "description": "Should the LDAP server trust any certificate" + }, + "ldap_vendor": { + "type": "string", + "description": "The vendor of the LDAP server" + }, + "base_dn": { + "type": "string", + "description": "The base dn of the LDAP server" + }, + "user_dn": { + "type": "string", + "description": "The user dn of the LDAP server" + }, + "connect_using_ssl": { + "type": "boolean", + "description": "Should the LDAP server connect using SSL" + }, + "connect_timeout": { + "type": "integer", + "format": "int32", + "description": "The timeout for connecting the LDAP server" + } + }, + "required": [ + "name", + "id", + "port", + "server", + "trust_any_certificate", + "ldap_vendor", + "base_dn", + "user_dn", + "connect_using_ssl", + "connect_timeout" + ] + }, + "Layer7ApplicationServiceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the predefined service" + }, + "protocol": { + "type": "string", + "format": "int16", + "description": "The port number, for IP service: protocol is not specified" + }, + "min": { + "type": "integer", + "format": "int32", + "description": "For IP, TCP and UDP Services: the minimum port number, ICMP Service: the ICMP type number" + }, + "max": { + "type": "integer", + "format": "int32", + "description": "For IP, TCP and UDP Services: the maximum port number" + } + } + }, + "Layer7ApplicationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application identity" + }, + "id": { + "type": "string", + "description": "The id of the application identity" + }, + "application_identity_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Layer7ApplicationServiceDTO" + }, + "description": "The application identity services" + } + } + }, + "Layer7ApplicationListDTO": { + "type": "object" + }, + "ApplicationInterfaceListDTO": { + "type": "object", + "properties": { + "application_interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInterfaceDTO" + }, + "description": "List of application interfaces" + } + } + }, + "ApplicationInterfaceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application interface" + }, + "id": { + "type": "string", + "description": "The ID of the application interface" + }, + "comment": { + "type": "string", + "description": "The comment of the application interface" + }, + "uid": { + "type": "string", + "description": "The uid of the application interface" + }, + "application_id": { + "type": "string", + "description": "The application ID of the application interface" + }, + "interface_connections": { + "$ref": "#/components/schemas/ConnectionInterfaceListDTO" + }, + "is_published": { + "type": "boolean", + "description": "The current is_published status" + } + }, + "required": [ + "name" + ] + }, + "ConnectionListDTO": { + "type": "object", + "properties": { + "connection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionDTO" + }, + "description": "List of connections" + } + } + }, + "ConnectionInterfaceDTO": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of source's objects ref" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of destination's objects ref" + }, + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The servers in the interface connection that connected to the interface" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of service's objects ref" + }, + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "uid": { + "type": "string", + "description": "The UID" + }, + "applicationId": { + "type": "string" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The opened tickets" + } + }, + "required": [ + "name" + ] + }, + "ApplicationInterfaceInstanceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the connection to application" + }, + "id": { + "type": "string", + "description": "The ID of the connection to application" + }, + "comment": { + "type": "string", + "description": "The comment of the connection to application" + }, + "uid": { + "type": "string", + "description": "The Uid of the connection to application" + }, + "application_id": { + "type": "string", + "description": "The application ID of the connection to application" + }, + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The servers of the connection to application that connected to the application interface" + }, + "connections": { + "$ref": "#/components/schemas/ConnectionListDTO" + }, + "application_interface_id": { + "type": "string", + "description": "The application interface ID of the connection to application" + } + }, + "required": [ + "name" + ] + }, + "ConnectionInterfaceListDTO": { + "type": "object", + "properties": { + "interface_connection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionInterfaceDTO" + }, + "description": "List of interface connections" + } + } + }, + "ApplicationInterfaceInstanceListDTO": { + "type": "object", + "properties": { + "connection_to_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInterfaceInstanceDTO" + }, + "description": "List of connections to application" + } + } + }, + "InterfaceInstanceMappingDTO": { + "type": "object", + "properties": { + "source_connection_to_application": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "target_application_interface": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + }, + "InterfaceInstanceMappingListDTO": { + "type": "object", + "properties": { + "connection_to_application_mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceInstanceMappingDTO" + }, + "description": "The Interface Instance mapping" + } + } + }, + "ServerMappingDTO": { + "type": "object", + "properties": { + "source_network_object": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "target_network_object": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "required": [ + "source_network_object" + ] + }, + "ServerMappingListDTO": { + "type": "object", + "properties": { + "server_mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerMappingDTO" + }, + "description": "The servers mapping" + } + } + }, + "ApplicationPackInstanceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the connection to application pack" + }, + "id": { + "type": "string", + "description": "The ID of the connection to application pack" + }, + "comment": { + "type": "string", + "description": "The comment of the connection to application pack" + }, + "application": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "application_pack": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date the connection to application pack was created" + }, + "modified": { + "type": "string", + "format": "date-time", + "description": "The date the last change was made" + }, + "connection_to_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The connections to applications of the connection to application pack" + }, + "tag_servers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagToConnectedServersDTO" + }, + "description": "The tags and their servers of the connection to application pack" + } + } + }, + "TagToConnectedServersDTO": { + "type": "object", + "properties": { + "tag": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The servers associated with tag " + } + } + }, + "ApplicationPackInstanceListDTO": { + "type": "object", + "properties": { + "connection_to_application_pack": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationPackInstanceDTO" + }, + "description": "The list of connection to application packs and their details" + } + } + }, + "InterfaceTagMappingListDTO": { + "type": "object", + "properties": { + "application_interface_tag": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceTagMappingDTO" + } + } + } + }, + "ApplicationPackListDTO": { + "type": "object", + "properties": { + "application_pack": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationPackDTO" + }, + "description": "The list of application packs and their details" + } + } + }, + "ApplicationPackDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application pack" + }, + "id": { + "type": "string", + "description": "The ID of the application pack" + }, + "owner": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "comment": { + "type": "string", + "description": "The comment of the application pack" + }, + "tag": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The tags of the application pack" + }, + "decommissioned": { + "type": "boolean", + "description": "Is the application pack decommissioned" + }, + "editors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The editors of the application pack" + }, + "viewers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The viewers of the application pack" + }, + "openTickets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The open tickets of the application pack" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date the application pack was created" + }, + "is_published": { + "type": "boolean", + "description": "The current is_published status" + }, + "application_interface_tag": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceTagMappingDTO" + }, + "description": "All application interfaces under this application pack with there tags" + }, + "modified": { + "type": "string", + "format": "date-time", + "description": "The date the last change was made" + } + }, + "required": [ + "name", + "id", + "owner" + ] + }, + "TagListDTO": { + "type": "object", + "properties": { + "tag": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagDTO" + } + } + } + }, + "TagDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tag" + }, + "id": { + "type": "string", + "description": "The ID of the tag" + } + }, + "required": [ + "name", + "id" + ] + }, + "InterfaceTagMappingDTO": { + "type": "object", + "properties": { + "tag": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "application_interface": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + }, + "AccessRuleListDTO": { + "type": "object", + "properties": { + "access_request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRuleDTO" + } + } + } + }, + "NetworkObjectListDTO": { + "type": "object", + "properties": { + "network_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of network objects" + } + }, + "required": [ + "network_object" + ] + }, + "ServiceListDTO": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_service" + }, + "description": "List of services" + } + } + }, + "UserObjectListDTO": { + "type": "object", + "properties": { + "user": { + "$ref": "#/components/schemas/void" + } + } + }, + "security_matrix_violation": { + "type": "object", + "properties": { + "security_zone_matrix": { + "type": "string", + "description": "security zone matrix" + }, + "matrix_cell_violation": { + "$ref": "#/components/schemas/matrix_cell" + }, + "security_zone_matrix_type": { + "type": "string", + "description": "security zone matrix type" + }, + "security_zone_matrix_domain": { + "type": "string", + "description": "security zone matrix Domain" + }, + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "HistoryApplicationDetailsDTO": { + "type": "object", + "properties": { + "ticket": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "previous_owner": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "new_owner": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "editor": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "removed_editors" + }, + "viewer": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "removed_viewers" + } + } + }, + "sa_application": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application" + }, + "id": { + "type": "string", + "description": "The ID of the application" + }, + "owner": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "comment": { + "type": "string", + "description": "The comment of the application" + }, + "status": { + "type": "string", + "description": "The status of the application" + }, + "vendor": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The vendors that are associated with servers contained in the application" + }, + "customer": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "connection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The connections of the application" + }, + "connection_to_application_pack": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The connections to application pack of the application" + }, + "decommissioned": { + "type": "boolean", + "description": "Is the application decommissioned" + }, + "editors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The editors of the application" + }, + "viewers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The viewers of the application" + }, + "openTickets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The open tickets of the application" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date the application was created" + }, + "modified": { + "type": "string", + "format": "date-time", + "description": "The date the last change was made" + } + }, + "required": [ + "name", + "id", + "owner" + ] + }, + "HistoryConnectionBaseSnapshotDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of source's network objects" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of destination's network objects" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_service" + }, + "description": "List of services" + } + }, + "required": [ + "name" + ] + }, + "HistoryDeviceObjectDetailsDTO": { + "type": "object", + "properties": { + "previous": { + "$ref": "#/components/schemas/sa_device_object" + }, + "new": { + "$ref": "#/components/schemas/sa_device_object" + }, + "addedObjects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "removedObjects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + } + }, + "HistoryApplicationPackInstanceDetailsDTO": { + "type": "object", + "properties": { + "previous": { + "$ref": "#/components/schemas/BasePropertiesDTO" + }, + "new": { + "$ref": "#/components/schemas/BasePropertiesDTO" + } + } + }, + "SASecurityPolicyViolationDTO": { + "type": "object", + "properties": { + "security_policy_violation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SAViolationDTO" + } + } + } + }, + "HistoryListDTO": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the specific list of history records, by the current filter" + }, + "total": { + "type": "integer", + "format": "int32", + "description": "The total number of the records in the history" + }, + "history_record": { + "type": "array", + "items": { + "$ref": "#/components/schemas/HistoryDTO" + }, + "description": "List of history records" + } + } + }, + "HistoryConnectionInterfaceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of source's network objects" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of destination's network objects" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_service" + }, + "description": "List of services" + } + }, + "required": [ + "name" + ] + }, + "sa_device_object": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "type": { + "type": "string", + "description": "The type of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "SAViolationDTO": { + "type": "object", + "properties": { + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "HistoryDetailsDTO": { + "type": "object" + }, + "blocked_cell": { + "type": "object", + "properties": { + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "from_zone_domain": { + "type": "string" + }, + "to_zone_domain": { + "type": "string" + } + } + }, + "restricted_cell": { + "type": "object", + "properties": { + "not_allowed_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "allowed_service": { + "type": "array", + "items": { + "type": "string" + } + }, + "flow_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "flow_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "flow": { + "$ref": "#/components/schemas/FlowType" + }, + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "from_zone_domain": { + "type": "string" + }, + "to_zone_domain": { + "type": "string" + } + } + }, + "HistoryConnectionDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of source's network objects" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of destination's network objects" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_service" + }, + "description": "List of services" + } + }, + "required": [ + "name" + ] + }, + "matrix_cell": { + "type": "object", + "properties": { + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "from_zone_domain": { + "type": "string" + }, + "to_zone_domain": { + "type": "string" + } + } + }, + "HistoryNetworkObjectDetailsDTO": { + "type": "object", + "properties": { + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "servers removed" + }, + "previous": { + "$ref": "#/components/schemas/sa_device_object" + }, + "new": { + "$ref": "#/components/schemas/sa_device_object" + } + } + }, + "BasePropertiesDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name" + }, + "comment": { + "type": "string", + "description": "comment" + } + } + }, + "block_only_cell": { + "type": "object", + "properties": { + "not_blocked_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "blocked_service": { + "type": "array", + "items": { + "type": "string" + } + }, + "flow_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "flow_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "flow": { + "$ref": "#/components/schemas/FlowType" + }, + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "from_zone_domain": { + "type": "string" + }, + "to_zone_domain": { + "type": "string" + } + } + }, + "HistoryServiceDetailsDTO": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "services removed" + }, + "previous": { + "$ref": "#/components/schemas/sa_device_object" + }, + "new": { + "$ref": "#/components/schemas/sa_device_object" + } + } + }, + "ApplicationToDomainListDTO": { + "type": "object", + "properties": { + "move_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationToDomainDTO" + }, + "description": "List of customers and applications to move" + } + } + }, + "HistoryDTO": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "The date the change was made" + }, + "object_name": { + "type": "string", + "description": "new server name - for request to access application with group" + }, + "user": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "type": { + "type": "string", + "description": "Either a group, network object or subnet" + }, + "modified_object": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "change_description": { + "type": "string", + "description": "Description of the change made" + }, + "change_details": { + "$ref": "#/components/schemas/HistoryDetailsDTO" + } + } + }, + "HistoryApplicationInterfaceInstanceDetailsDTO": { + "type": "object", + "properties": { + "previous": { + "$ref": "#/components/schemas/BasePropertiesDTO" + }, + "new": { + "$ref": "#/components/schemas/BasePropertiesDTO" + } + } + }, + "ComplianceResultListDTO": { + "type": "object", + "properties": { + "compliance_violations_result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ComplianceResultDTO" + }, + "description": "compliance violations results" + } + } + }, + "HistoryDeviceObjectDTO": { + "type": "object", + "properties": { + "snapshot": { + "$ref": "#/components/schemas/sa_device_object" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "The date the change was made" + }, + "object_name": { + "type": "string", + "description": "new server name - for request to access application with group" + }, + "user": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "type": { + "type": "string", + "description": "Either a group, network object or subnet" + }, + "modified_object": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "change_description": { + "type": "string", + "description": "Description of the change made" + }, + "change_details": { + "$ref": "#/components/schemas/HistoryDetailsDTO" + } + } + }, + "HistoryConnectionDetailsDTO": { + "type": "object", + "properties": { + "previous": { + "$ref": "#/components/schemas/BasePropertiesDTO" + }, + "new": { + "$ref": "#/components/schemas/BasePropertiesDTO" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "sources removed" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "destinations removed" + }, + "service": { + "$ref": "#/components/schemas/void" + } + } + }, + "ApplicationToDomainDTO": { + "type": "object", + "properties": { + "customer": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "application": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + }, + "HistoryBaseConnectionDTO": { + "type": "object", + "properties": { + "snapshot": { + "$ref": "#/components/schemas/HistoryConnectionBaseSnapshotDTO" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "The date the change was made" + }, + "object_name": { + "type": "string", + "description": "new server name - for request to access application with group" + }, + "user": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "type": { + "type": "string", + "description": "Either a group, network object or subnet" + }, + "modified_object": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "change_description": { + "type": "string", + "description": "Description of the change made" + }, + "change_details": { + "$ref": "#/components/schemas/HistoryDetailsDTO" + } + } + }, + "ComplianceResultDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "cannot compute risk reason" + }, + "status": { + "type": "string", + "description": "risk status" + }, + "security_policy_violations": { + "$ref": "#/components/schemas/SASecurityPolicyViolationDTO" + }, + "connection": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + }, + "HistoryApplicationInterfaceDetailsDTO": { + "type": "object", + "properties": { + "previous": { + "$ref": "#/components/schemas/BasePropertiesDTO" + }, + "new": { + "$ref": "#/components/schemas/BasePropertiesDTO" + } + } + }, + "ApplicationListDTO": { + "type": "object", + "properties": { + "application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_application" + }, + "description": "The list of applications and their details" + } + } + }, + "WorkflowDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "WorkflowDTO_Requests": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The workflow name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The workflow ID" + }, + "type": { + "type": "string", + "description": "The workflow type" + } + } + }, + "WorkflowDTO_Triggers": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "parent_workflow_id": { + "type": "integer", + "format": "int64" + } + } + }, + "UnifiedSecurityPolicyDTO": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/Status" + } + } + }, + "radius_protocol": { + "type": "object" + }, + "rule_decommission_workflow": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "Status": { + "type": "object" + }, + "LabelConditionOperator": { + "type": "object" + }, + "ApplicationConditionOperator": { + "type": "object" + }, + "SLAStatus": { + "type": "object" + }, + "WorkflowStepConfigurationDTO": { + "type": "object" + }, + "decommission_request_configuration": { + "type": "object", + "properties": { + "designer": { + "$ref": "#/components/schemas/DesignerModeCfgDTO" + }, + "impact_analysis": { + "type": "boolean" + }, + "verifier": { + "type": "boolean" + }, + "type": { + "type": "string" + } + } + }, + "auto_step": { + "type": "object", + "properties": { + "field_type": { + "type": "string" + }, + "assign_handler": { + "type": "boolean" + }, + "run_designer": { + "type": "boolean" + }, + "run_verifier": { + "type": "boolean" + }, + "run_risk_analysis": { + "type": "boolean" + }, + "run_suggest_target": { + "type": "boolean" + }, + "update_policy": { + "type": "boolean" + }, + "commit_policy_changes": { + "type": "boolean" + }, + "update_metadata": { + "type": "boolean" + } + } + }, + "WorkflowTaskRiskConditionDTO": { + "type": "object", + "properties": { + "risk_status": { + "$ref": "#/components/schemas/RiskStatusCondition" + }, + "operator": { + "$ref": "#/components/schemas/RiskConditionOperator" + }, + "type": { + "type": "string" + } + } + }, + "VerificationNameCondition": { + "type": "object" + }, + "WorkflowTaskRiskSeverityConditionDTO": { + "type": "object", + "properties": { + "operator": { + "$ref": "#/components/schemas/RiskSeverityConditionOperator" + }, + "risk_severity": { + "$ref": "#/components/schemas/RiskSeverityCondition" + }, + "type": { + "type": "string" + } + } + }, + "access_request_workflow": { + "type": "object", + "properties": { + "designer_verifier_advanced_option": { + "type": "string" + }, + "use_topology": { + "type": "boolean" + }, + "disable_rule_suggestion": { + "type": "boolean" + }, + "risk_analysis": { + "$ref": "#/components/schemas/RiskAnalysisDTO" + }, + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "WorkflowTaskApplicationConditionDTO": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "operator": { + "$ref": "#/components/schemas/ApplicationConditionOperator" + }, + "type": { + "type": "string" + } + } + }, + "AssignmentDTO": { + "type": "object" + }, + "radius_type": { + "type": "object" + }, + "self_assign": { + "type": "object" + }, + "WorkflowStepDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "order": { + "type": "integer", + "format": "int32" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "default_task": { + "$ref": "#/components/schemas/task" + }, + "is_active": { + "type": "boolean" + }, + "is_dynamic": { + "type": "boolean" + }, + "assignment": { + "$ref": "#/components/schemas/AssignmentDTO" + }, + "is_request_priority_enabled": { + "type": "boolean" + }, + "is_request_attachment_enabled": { + "type": "boolean" + }, + "is_request_group_notification_enabled": { + "type": "boolean" + }, + "is_step_by_script": { + "type": "boolean" + }, + "step_by_script_path": { + "type": "string" + }, + "is_auto": { + "type": "boolean" + }, + "is_skip": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "configuration": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepConfigurationDTO" + } + } + } + }, + "DesignerModeCfgDTO": { + "type": "object", + "properties": { + "designer_commit": { + "type": "boolean" + }, + "designer_implement": { + "type": "boolean" + }, + "designer_design": { + "type": "boolean" + } + } + }, + "multiple_selection_configuration": { + "type": "object", + "properties": { + "options": { + "$ref": "#/components/schemas/OptionItemListDTO" + }, + "type": { + "type": "string" + } + } + }, + "radiusConfigurationDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "$ref": "#/components/schemas/radius_type" + }, + "port": { + "type": "integer", + "format": "int32" + }, + "protocol": { + "$ref": "#/components/schemas/radius_protocol" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "server": { + "type": "string" + } + } + }, + "ChangeAuditListDTO": { + "type": "object", + "properties": { + "change_audit": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChangeAuditDTO" + }, + "description": "The list of records from change audit table" + } + } + }, + "OptionsOrder": { + "type": "object" + }, + "expiration_configuration": { + "type": "object", + "properties": { + "default_expiration_period": { + "type": "integer", + "format": "int32" + }, + "days_to_notify": { + "type": "integer", + "format": "int32" + }, + "recipient": { + "type": "array", + "items": { + "$ref": "#/components/schemas/local" + } + }, + "should_notify": { + "type": "boolean" + }, + "type": { + "type": "string" + } + } + }, + "ExternalRiskAnalysisDTO": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/Status" + }, + "script_path": { + "type": "string" + }, + "custom_title": { + "$ref": "#/components/schemas/CustomTitleDTO" + } + } + }, + "rule_recertification_workflow": { + "type": "object", + "properties": { + "rule_recertification_configuration": { + "$ref": "#/components/schemas/RuleRecertificationConfigurationDTO" + }, + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "SlaConditionOperator": { + "type": "object" + }, + "local": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "PriorityValues": { + "type": "object", + "properties": { + "tagName": { + "type": "string" + } + } + }, + "scripted_assignment": { + "type": "object", + "properties": { + "script_path": { + "type": "string" + } + } + }, + "clone_server_policy_configuration": { + "type": "object", + "properties": { + "read_only": { + "type": "boolean" + }, + "designer": { + "$ref": "#/components/schemas/DesignerModeCfgDTO" + }, + "verifier": { + "type": "boolean" + }, + "type": { + "type": "string" + } + } + }, + "CertificationDecisionPermissionDTO": { + "type": "object", + "properties": { + "read_only_expiration_duration": { + "type": "boolean" + } + } + }, + "RuleRecertificationConfigurationDTO": { + "type": "object", + "properties": { + "certification_decision": { + "$ref": "#/components/schemas/CertificationDecisionDTO" + } + } + }, + "task": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "participant": { + "type": "array", + "items": { + "$ref": "#/components/schemas/local" + } + }, + "is_default": { + "type": "boolean" + } + } + }, + "VerificationConditionOperator": { + "type": "object" + }, + "rule_modification_workflow": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "PriorityConditionOperator": { + "type": "object" + }, + "CertificationDurationDTO": { + "type": "object", + "properties": { + "default_days": { + "type": "integer", + "format": "int32" + }, + "maximum_days": { + "type": "integer", + "format": "int32" + } + } + }, + "RiskStatusCondition": { + "type": "object" + }, + "WorkflowFieldConfigurationDTO": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + }, + "AuditableDTO": { + "type": "object" + }, + "clone_server_policy_workflow": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "CalendarDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The defined calendar name" + }, + "uid": { + "type": "string" + }, + "from_hour": { + "type": "string" + }, + "to_hour": { + "type": "string" + }, + "working_days": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DayOfWeek" + } + }, + "non_businessDays": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NonBusinessDayDTO" + } + } + } + }, + "modify_group_workflow": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "WorkflowFieldDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "configuration": { + "$ref": "#/components/schemas/WorkflowFieldConfigurationDTO" + }, + "field_value": { + "$ref": "#/components/schemas/TicketTaskFieldDTO" + }, + "tooltip": { + "type": "string" + }, + "mandatory": { + "type": "boolean" + }, + "multiple": { + "type": "boolean" + } + } + }, + "RiskSeverityConditionOperator": { + "type": "object" + }, + "modify_group_configuration": { + "type": "object", + "properties": { + "designer": { + "$ref": "#/components/schemas/DesignerModeCfgDTO" + }, + "type": { + "type": "string" + } + } + }, + "rule_decommission_configuration": { + "type": "object", + "properties": { + "read_only": { + "type": "boolean" + }, + "verifier": { + "type": "boolean" + }, + "designer": { + "$ref": "#/components/schemas/DesignerModeCfgDTO" + }, + "type": { + "type": "string" + } + } + }, + "access_request_modify_group_workflow": { + "type": "object", + "properties": { + "designer_verifier_advanced_option": { + "type": "string" + }, + "use_topology": { + "type": "boolean" + }, + "disable_rule_suggestion": { + "type": "boolean" + }, + "risk_analysis": { + "$ref": "#/components/schemas/RiskAnalysisDTO" + }, + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "RiskConditionOperator": { + "type": "object" + }, + "server_decommission_workflow": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "ChangeContainerDTO": { + "type": "object" + }, + "dynamic_assignment_task": { + "type": "object", + "properties": { + "condition": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowTaskConditionDTO" + } + }, + "assignment": { + "$ref": "#/components/schemas/AssignmentDTO" + }, + "condition_connector": { + "type": "string" + }, + "name": { + "type": "string" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "participant": { + "type": "array", + "items": { + "$ref": "#/components/schemas/local" + } + }, + "is_default": { + "type": "boolean" + } + } + }, + "ChangeAuditDTO": { + "type": "object", + "properties": { + "user_name": { + "type": "string", + "description": "The user name" + }, + "before_change": { + "$ref": "#/components/schemas/ChangeContainerDTO" + }, + "after_change": { + "$ref": "#/components/schemas/ChangeContainerDTO" + }, + "diff": { + "type": "string", + "description": "The diff, added with showChanges=true" + }, + "change_date_time": { + "type": "string", + "format": "date-time", + "description": "The change date and time with offset" + }, + "changed_entity_type": { + "type": "string", + "description": "The entity type" + }, + "changed_entity_id": { + "type": "integer", + "format": "int64", + "description": "The entity id" + }, + "changed_entity_name": { + "type": "string", + "description": "The entity name" + } + } + }, + "auto_assignment": { + "type": "object", + "properties": { + "prefer_previous_handler": { + "type": "boolean" + } + } + }, + "RadiusType": { + "type": "object" + }, + "manager_assignment": { + "type": "object", + "properties": { + "default_manager": { + "$ref": "#/components/schemas/local" + } + } + }, + "DayOfWeek": { + "type": "object" + }, + "RiskAnalysisDTO": { + "type": "object", + "properties": { + "external_risk_analysis": { + "$ref": "#/components/schemas/ExternalRiskAnalysisDTO" + }, + "unified_security_policy": { + "$ref": "#/components/schemas/UnifiedSecurityPolicyDTO" + } + } + }, + "option_field_configuration": { + "type": "object", + "properties": { + "options": { + "$ref": "#/components/schemas/OptionItemListDTO" + }, + "order": { + "$ref": "#/components/schemas/OptionsOrder" + }, + "type": { + "type": "string" + } + } + }, + "WorkflowSkipStepConfigurationDTO": { + "type": "object", + "properties": { + "condition": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowTaskConditionDTO" + } + }, + "condition_connector": { + "type": "string" + } + } + }, + "WorkflowTaskVerificationConditionDTO": { + "type": "object", + "properties": { + "verification_status": { + "$ref": "#/components/schemas/VerificationNameCondition" + }, + "operator": { + "$ref": "#/components/schemas/VerificationConditionOperator" + }, + "type": { + "type": "string" + } + } + }, + "WorkflowTaskPriorityConditionDTO": { + "type": "object", + "properties": { + "operator": { + "$ref": "#/components/schemas/PriorityConditionOperator" + }, + "priority_values": { + "$ref": "#/components/schemas/PriorityValues" + }, + "type": { + "type": "string" + } + } + }, + "access_request_configuration": { + "type": "object", + "properties": { + "read_only": { + "type": "boolean" + }, + "designer": { + "$ref": "#/components/schemas/DesignerModeCfgDTO" + }, + "risk_analysis": { + "type": "boolean" + }, + "security_zones": { + "type": "boolean" + }, + "verify_against": { + "type": "string" + }, + "view_targets": { + "type": "boolean" + }, + "source_destination_and_service_values": { + "type": "string" + }, + "allow_objects": { + "type": "boolean" + }, + "allow_access_request_import": { + "type": "boolean" + }, + "show_users_palo_alto": { + "type": "boolean" + }, + "notify_risk_disregard": { + "type": "boolean" + }, + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/local" + } + }, + "verifier": { + "type": "boolean" + }, + "auto_verifier": { + "type": "boolean" + }, + "block_if_not_verified": { + "type": "boolean" + }, + "tools_threshold": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + } + } + }, + "manual_assignment": { + "type": "object", + "properties": { + "assigner": { + "$ref": "#/components/schemas/local" + } + } + }, + "RiskSeverityCondition": { + "type": "object" + }, + "NonBusinessDayDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "from_date": { + "type": "string" + }, + "to_date": { + "type": "string" + } + } + }, + "WorkflowTaskConditionDTO": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + }, + "CertificationDecisionDTO": { + "type": "object", + "properties": { + "certification_duration": { + "$ref": "#/components/schemas/CertificationDurationDTO" + }, + "use_participant_email_as_certification_owner_email": { + "type": "boolean" + } + } + }, + "rule_modification_configuration": { + "type": "object", + "properties": { + "read_only": { + "type": "boolean" + }, + "designer": { + "$ref": "#/components/schemas/DesignerModeCfgDTO" + }, + "type": { + "type": "string" + } + } + }, + "ldap": { + "type": "object", + "properties": { + "ldapConfigurationName": { + "type": "string" + }, + "ldapConfigurationId": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "CustomTitleDTO": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/Status" + } + } + }, + "WorkflowTaskScriptedConditionDTO": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "boolean_value": { + "type": "boolean" + }, + "type": { + "type": "string" + } + } + }, + "rule_recertification_configuration": { + "type": "object", + "properties": { + "read_only": { + "type": "boolean" + }, + "certification_decision": { + "$ref": "#/components/schemas/CertificationDecisionPermissionDTO" + }, + "update_metadata": { + "type": "boolean" + }, + "type": { + "type": "string" + } + } + }, + "dynamic_assignment": { + "type": "object", + "properties": { + "task": { + "type": "array", + "items": { + "$ref": "#/components/schemas/dynamic_assignment_task" + } + } + } + }, + "RadiusProtocol": { + "type": "object" + }, + "WorkflowTaskLabelConditionDTO": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "operator": { + "$ref": "#/components/schemas/LabelConditionOperator" + }, + "type": { + "type": "string" + } + } + }, + "WorkflowTaskSlaStatusConditionDTO": { + "type": "object", + "properties": { + "sla_status": { + "$ref": "#/components/schemas/SLAStatus" + }, + "operator": { + "$ref": "#/components/schemas/SlaConditionOperator" + }, + "type": { + "type": "string" + } + } + }, + "CloudServerAutoAssociationRuleDTO": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Tag key to be auto associate by." + }, + "enabled": { + "type": "boolean", + "description": "Indication to disable/enable rule" + } + } + }, + "VMInstanceListDTO": { + "type": "object", + "properties": { + "vm_instance": { + "type": "array", + "items": { + "$ref": "#/components/schemas/vmInstanceDTO" + }, + "description": "List of cloud servers" + } + } + }, + "DeviceToUidsDTO": { + "type": "object", + "properties": { + "device_id": { + "type": "integer", + "format": "int32", + "description": "The ID of the device" + }, + "uid": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The UIDs of the cloud servers" + } + }, + "required": [ + "device_id", + "uid" + ] + }, + "DeviceToUidsListDTO": { + "type": "object", + "properties": { + "device_to_uids": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceToUidsDTO" + }, + "description": "List of device IDs and cloud server UIDs" + } + }, + "required": [ + "device_to_uids" + ] + }, + "CustomerDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the customer" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the customer" + }, + "status": { + "type": "string", + "description": "The status of the customer" + }, + "usage_mode": { + "type": "string", + "description": "The usage mode of the customer" + }, + "description": { + "type": "string", + "description": "The description of the customer" + } + }, + "required": [ + "name", + "id", + "usage_mode" + ] + }, + "CustomerListDTO": { + "type": "object", + "properties": { + "customer": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerDTO" + }, + "description": "The list of customers" + } + } + }, + "MarketplaceAppsListDTO": { + "type": "object", + "properties": { + "extension": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MarketplaceAppDTO" + }, + "description": "The list of extensions" + } + } + }, + "MarketplaceAppDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The extension name" + }, + "appId": { + "type": "string", + "description": "The extension id" + }, + "version": { + "type": "string", + "description": "The extension version" + }, + "url": { + "type": "string", + "description": "The product page for the extension" + }, + "installed": { + "type": "boolean", + "description": "The extension is installed" + }, + "description": { + "type": "string", + "description": "The extension description" + } + }, + "required": [ + "name", + "appId", + "version", + "url", + "installed", + "description" + ] + }, + "ExternalProviderResourceDTO": { + "type": "object", + "properties": { + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The resource reference ips" + }, + "resource_ref": { + "$ref": "#/components/schemas/resource_ref" + }, + "account_ref": { + "$ref": "#/components/schemas/account_ref" + } + } + }, + "ExternalProviderResourceListDTO": { + "type": "object", + "properties": { + "external_resource": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalProviderResourceDTO" + } + } + } + }, + "F5VirtualServerListDTO": { + "type": "object", + "properties": { + "f5_virtual_server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/F5VirtualServerDTO" + }, + "description": "The list of virtual servers and their details" + } + } + }, + "F5VirtualServerDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the virtual server in SecureTrack" + }, + "port": { + "type": "string", + "description": "The port that the virtual server is forwarding (Any is shown as \"-1\")" + }, + "protocol": { + "type": "string", + "description": "The protocol that the virtual server is forwarding" + }, + "uid": { + "type": "string", + "description": "The UID of the virtual server" + }, + "netmask": { + "type": "string", + "description": "The netmask for the virtual server VIP address" + }, + "virtual_ip": { + "type": "string", + "description": "The virtual IP address of the device" + }, + "pool_member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PoolMemberDTO" + }, + "description": "The server group members that are associated with the virtual server" + }, + "f5_device": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + }, + "zone_based_binding": { + "type": "object", + "properties": { + "zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "zones" + }, + "incoming_zone": { + "type": "string", + "description": "incoming zone" + }, + "outgoing_zone": { + "type": "string", + "description": "outgoing zone" + }, + "policy_map": { + "type": "string", + "description": "policy map" + } + } + }, + "GlobalLocation": { + "type": "object" + }, + "DesignerGroupChangeDTO": { + "type": "object", + "properties": { + "designer_change_networks_changed_in_group": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "designer_change_services_changed_in_group": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service" + } + }, + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "ImpactedRuleDTO": { + "type": "object", + "properties": { + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DecommissionedServerDTO" + }, + "description": "decommissioned servers that impact specific rule" + } + } + }, + "DesignerRuleChangeDTO": { + "type": "object", + "properties": { + "servicesChangedInRule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service" + } + }, + "changedRule": { + "$ref": "#/components/schemas/RuleDTO" + }, + "applicationAddedInRule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + } + }, + "destinationNetworkObjectsChangedInRule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "sourceNetworkObjectsChangedInRule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "DesignerDeviceChangeDTO": { + "type": "object", + "properties": { + "requestedNetworkObjectName": { + "type": "string" + }, + "changedNetworkObject": { + "$ref": "#/components/schemas/network_object" + }, + "changedService": { + "$ref": "#/components/schemas/service" + }, + "requestedServiceName": { + "type": "string" + }, + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "policy_block_binding": { + "type": "object", + "properties": { + "policy_block_name": { + "type": "string", + "description": "policy block name" + } + } + }, + "ImpactedDeviceDTO": { + "type": "object", + "properties": { + "impactedRulesCount": { + "type": "integer", + "format": "int32", + "description": "number of impacted rules for this device" + }, + "impacted_binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImpactedBindingDTO" + }, + "description": "impacted device bindings" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "ID of management" + }, + "management_name": { + "type": "string", + "description": "name of management" + }, + "device_type": { + "$ref": "#/components/schemas/CpType" + }, + "revision_id": { + "type": "integer", + "format": "int32", + "description": "revision id" + }, + "vendor_type": { + "$ref": "#/components/schemas/VendorTypeDTO" + }, + "revision_number": { + "type": "integer", + "format": "int32", + "description": "revision number" + }, + "administrator": { + "type": "string", + "description": "name of administrator that made the change" + }, + "changed_on": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "management_ip": { + "type": "string", + "description": "ip of management" + }, + "received_on": { + "$ref": "#/components/schemas/LocalDateTime" + } + }, + "required": [ + "management_id", + "revision_id" + ] + }, + "DesignerNotPossibleChangeDTO": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "DesignerRuleReplaceDTO": { + "type": "object", + "properties": { + "requestedRuleName": { + "type": "string" + }, + "requestedRuleComments": { + "type": "string" + }, + "replacementRule": { + "$ref": "#/components/schemas/RuleDTO" + }, + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "policy__binding": { + "type": "object", + "properties": { + "policy_name": { + "type": "string", + "description": "policy name" + }, + "installed_on_module": { + "type": "array", + "items": { + "type": "string" + }, + "description": "modules that this policy has been installed on" + } + } + }, + "HostInterfaceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "hostName": { + "type": "string" + }, + "interface_ips": { + "$ref": "#/components/schemas/InterfaceIpListDTO" + }, + "hostDisplayName": { + "type": "string" + } + } + }, + "result_expanded": { + "type": "object", + "properties": { + "impacted_device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImpactedDeviceDTO" + } + } + } + }, + "zone__binding": { + "type": "object", + "properties": { + "from_zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "names of from-zones" + }, + "to_zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "names of to-zones" + } + } + }, + "DesignerChangeGeneralDTO": { + "type": "object", + "properties": { + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "acl__binding": { + "type": "object", + "properties": { + "acl_name": { + "type": "string", + "description": "acl name" + }, + "incoming_interface_name": { + "type": "array", + "items": { + "type": "string" + }, + "description": "name of incoming interface" + }, + "outgoing_interface_name": { + "type": "array", + "items": { + "type": "string" + }, + "description": "name of outgoing interface" + } + } + }, + "DesignerSolutionDTO": { + "type": "object", + "properties": { + "binding_uid": { + "type": "string" + }, + "basedOnVersionId": { + "type": "integer", + "format": "int32" + }, + "binding_name": { + "type": "string" + }, + "designerChangesDTO": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerChangeGeneralDTO" + } + } + } + }, + "DesignerBindingChangeDTO": { + "type": "object", + "properties": { + "requestedRuleName": { + "type": "string" + }, + "changedRule": { + "$ref": "#/components/schemas/RuleDTO" + }, + "requestedRuleComments": { + "type": "string" + }, + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "directional__security__group__binding": { + "type": "object", + "properties": { + "direction": { + "type": "string", + "description": "direction" + }, + "enforcedOn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/HostInterfaceDTO" + }, + "description": "enforcedOn" + }, + "group_name": { + "type": "string", + "description": "group name" + } + } + }, + "Binding_DTO": { + "type": "object" + }, + "DecommissionedServerDTO": { + "type": "object", + "properties": { + "ip_address": { + "type": "array", + "items": { + "type": "string" + }, + "description": "decommissioned server IP addresses" + }, + "uuid": { + "type": "string", + "description": "uuid of server" + } + } + }, + "zone__with__policy__binding": { + "type": "object", + "properties": { + "policy_name": { + "type": "string" + } + } + }, + "RuleDTO": { + "type": "object", + "properties": { + "location": { + "$ref": "#/components/schemas/GlobalLocation" + }, + "line_number": { + "type": "integer", + "format": "int32" + }, + "global": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "textual_rep": { + "type": "string" + }, + "pv1_global": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingDTO" + } + }, + "order": { + "type": "integer", + "format": "int64" + }, + "disabled": { + "type": "boolean" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "cp_uid": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "security__group__binding": { + "type": "object", + "properties": { + "group_name": { + "type": "string", + "description": "group name" + } + } + }, + "DesignerSolutionPerTargetDTO": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "cp_type": { + "type": "string" + }, + "device_name": { + "type": "string" + }, + "vendor": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int32" + }, + "designerSolutionDTOs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerSolutionDTO" + } + }, + "globalChangeDTOs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerChangeGeneralDTO" + } + } + } + }, + "designer_results": { + "type": "object", + "properties": { + "solutionPerTarget": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerSolutionPerTargetDTO" + } + } + } + }, + "DesignerFullyImplementedChangeDTO": { + "type": "object", + "properties": { + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "non_existing_binding": { + "type": "object", + "properties": { + "incoming_interface_name": { + "type": "array", + "items": { + "type": "string" + }, + "description": "incoming interface name" + }, + "outgoing_interface_name": { + "type": "array", + "items": { + "type": "string" + }, + "description": "outgoing interface name" + } + } + }, + "ImpactedBindingDTO": { + "type": "object", + "properties": { + "binding": { + "$ref": "#/components/schemas/Binding_DTO" + }, + "impacted_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImpactedRuleDTO" + }, + "description": "rules impacted for specific device binding" + } + } + }, + "FieldFilterDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The field name to filter by" + }, + "value": { + "type": "string", + "description": "The field value to filter by" + } + } + }, + "QueryTypeDTO": { + "type": "object" + }, + "DetailedQueryFiltersDTO": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/FieldFilterDTO" + }, + "group": { + "type": "string", + "description": "The group to filter by" + }, + "domainId": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The domain IDs to filter by" + }, + "ticketId": { + "type": "integer", + "format": "int64", + "description": "The ticket ID filter by" + }, + "subject": { + "type": "string", + "description": "The subject to filter by" + }, + "requester": { + "type": "string", + "description": "The requester to filter by" + }, + "currentStepName": { + "type": "string", + "description": "The current step name to filter by" + }, + "ticketStatus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The ticket statuses to filter by" + }, + "priority": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The priorities to filter by" + }, + "taskStatus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The task statuses to filter by" + }, + "slaStatus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The sla statuses to filter by" + }, + "slaOutcome": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The sla outcomes to filter by" + }, + "slaTrackingState": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The sla tracking state to filter by" + }, + "assignedTo": { + "type": "string", + "description": "The 'assigned to' to filter by" + }, + "expiration": { + "$ref": "#/components/schemas/ExpirationFilterDTO" + } + } + }, + "QueryDTO": { + "type": "object" + }, + "SLATrackingStateDTO": { + "type": "object" + }, + "SLAOutcomeDTO": { + "type": "object" + }, + "QueryDTOList": { + "type": "object", + "properties": { + "query": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryDTO" + } + } + } + }, + "SLAStatusDTO": { + "type": "object" + }, + "FreeTextQuery": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The query name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The query ID" + }, + "type": { + "$ref": "#/components/schemas/QueryTypeDTO" + }, + "createDate": { + "type": "string", + "format": "date-time", + "description": "The date the query was created" + }, + "updateDate": { + "type": "string", + "format": "date-time", + "description": "The date the query was updated" + }, + "searchText": { + "type": "string", + "description": "The search text" + }, + "lastUsed": { + "type": "string", + "format": "date-time", + "description": "Last time the query was used" + }, + "description": { + "type": "string", + "description": "The query description" + } + }, + "required": [ + "name", + "searchText" + ] + }, + "DetailedQuery": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The query name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The query ID" + }, + "type": { + "$ref": "#/components/schemas/QueryTypeDTO" + }, + "filters": { + "$ref": "#/components/schemas/DetailedQueryFiltersDTO" + }, + "createDate": { + "type": "string", + "format": "date-time", + "description": "The date the query was created" + }, + "updateDate": { + "type": "string", + "format": "date-time", + "description": "The date the query was updated" + }, + "lastUsed": { + "type": "string", + "format": "date-time", + "description": "Last time the query was used" + }, + "description": { + "type": "string", + "description": "The query description" + } + }, + "required": [ + "name", + "filters" + ] + }, + "TaskStatusSearchEnumDTO": { + "type": "object" + }, + "ExpirationFilterDTO": { + "type": "object", + "properties": { + "fromDate": { + "type": "string", + "format": "date-time", + "description": "The expiration from date to filter by" + }, + "toDate": { + "type": "string", + "format": "date-time", + "description": "The expiration to date to filter by" + } + } + }, + "Group": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the group" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the group" + }, + "type": { + "$ref": "#/components/schemas/PartyTypeDTO" + }, + "membership": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AbstractGroupSearchDTO" + }, + "description": "The groups to which the user is a member" + } + } + }, + "PartyTypeDTO": { + "type": "object" + }, + "User": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the user" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyTypeDTO" + }, + "membership": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AbstractGroupSearchDTO" + }, + "description": "The groups to which the user is a member" + } + } + }, + "LocalGroup": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the group" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the group" + }, + "type": { + "$ref": "#/components/schemas/PartyTypeDTO" + }, + "membership": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AbstractGroupSearchDTO" + }, + "description": "The groups to which the user is a member" + } + } + }, + "CurrentStage": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the step" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the stage" + }, + "order": { + "type": "integer", + "format": "int32", + "description": "The order of the step" + }, + "task": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketTask" + }, + "description": "The list of tasks" + } + } + }, + "TicketTask": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the task" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the task" + }, + "handler": { + "$ref": "#/components/schemas/PartySearchDTO" + }, + "participant": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartySearchDTO" + }, + "description": "The list of potential handlers" + }, + "status": { + "$ref": "#/components/schemas/TicketTaskStatus" + }, + "task_business_duration": { + "type": "string", + "description": "The business duration of the task" + }, + "assigned_group": { + "$ref": "#/components/schemas/AbstractGroupSearchDTO" + }, + "unread_comments": { + "type": "boolean", + "description": "Whether the task comments have been read" + } + } + }, + "TicketDraftRequestSearchDTO": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "The priority of the ticket " + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The id of the request" + }, + "type": { + "type": "string", + "description": "The type of the request" + }, + "subject": { + "type": "string", + "description": "The subject of the request " + }, + "requester": { + "$ref": "#/components/schemas/AbstractUserRequestDTO" + }, + "update_date": { + "type": "string", + "format": "date-time", + "description": "The update date of the request " + }, + "workflow": { + "$ref": "#/components/schemas/WorkflowDTO_Requests" + }, + "ticket_draft_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the draft ticket " + }, + "domain": { + "$ref": "#/components/schemas/Domain" + } + }, + "required": [ + "priority", + "id", + "type", + "subject", + "requester", + "workflow", + "ticket_draft_id", + "domain" + ] + }, + "RequiredAttentionTypeDTO": { + "type": "object" + }, + "TicketTaskStatus": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/TaskStatusSearchEnumDTO" + }, + "reason": { + "type": "string", + "description": "The task status reason" + } + } + }, + "AbstractUserRequestDTO": { + "type": "object" + }, + "RequestsSearchListDTO": { + "type": "object", + "properties": { + "request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestSearchDTO" + }, + "description": " The list of requests" + } + } + }, + "TicketRequestSearchDTO": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "The priority of the ticket " + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The id of the request " + }, + "type": { + "type": "string", + "description": "The type of the request" + }, + "status": { + "type": "string", + "description": "The status of the ticket " + }, + "ticket_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the ticket " + }, + "subject": { + "type": "string", + "description": "The subject of the request " + }, + "requester": { + "$ref": "#/components/schemas/AbstractUserRequestDTO" + }, + "create_date": { + "type": "string", + "format": "date-time", + "description": "The create date of the request " + }, + "update_date": { + "type": "string", + "format": "date-time", + "description": "The update date of the request " + }, + "current_step": { + "$ref": "#/components/schemas/CurrentStage" + }, + "workflow": { + "$ref": "#/components/schemas/WorkflowDTO_Requests" + }, + "required_attention": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequiredAttentionDTO" + }, + "description": "The required attentions of the ticket " + }, + "application_details": { + "$ref": "#/components/schemas/ApplicationDetails" + }, + "completion_ticket_details": { + "$ref": "#/components/schemas/CompletionTicketDetailsDTO" + }, + "domain": { + "$ref": "#/components/schemas/Domain" + } + }, + "required": [ + "priority", + "type", + "requester", + "current_step", + "workflow", + "required_attention", + "completion_ticket_details", + "domain" + ] + }, + "CompletionTicketDetailsDTO": { + "type": "object", + "properties": { + "user": { + "$ref": "#/components/schemas/AbstractUserRequestDTO" + }, + "last_active_step": { + "$ref": "#/components/schemas/CurrentStage" + } + } + }, + "ApplicationDetails": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the application" + }, + "domain": { + "$ref": "#/components/schemas/Domain" + } + } + }, + "RequiredAttentionDTO": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/RequiredAttentionTypeDTO" + } + } + }, + "PartySearchDTO": { + "type": "object" + }, + "LocalUser": { + "type": "object", + "properties": { + "user": { + "type": "string", + "description": "The name of the user" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyTypeDTO" + }, + "first_name": { + "type": "string", + "description": "The first name of the user" + }, + "last_name": { + "type": "string", + "description": "The last name of the user" + }, + "membership": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AbstractGroupSearchDTO" + }, + "description": "The groups to which the user is a member" + } + } + }, + "AbstractGroupSearchDTO": { + "type": "object" + }, + "RequestSearchDTO": { + "type": "object" + }, + "Domain": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the domain" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the domain" + } + } + }, + "prov": { + "type": "object", + "properties": { + "status": { + "type": "string" + } + } + }, + "DeviceIdsListDTO": { + "type": "object", + "properties": { + "id": { + "type": "array", + "items": { + "type": "integer" + } + }, + "v2_id": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "sc_device": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The device name" + }, + "id": { + "type": "integer", + "format": "int32", + "description": "The device ID" + }, + "device_type": { + "type": "string", + "description": "The device type" + }, + "ip": { + "type": "string", + "description": "The device IP" + }, + "vendor": { + "type": "string", + "description": "The device vendor" + }, + "external_uid": { + "type": "string", + "description": "The external uid" + }, + "external_parent_uid": { + "type": "string", + "description": "The external parent uid" + }, + "tenant_id": { + "type": "string", + "description": "The tenant id" + }, + "v2_id": { + "type": "string", + "description": "The device v2 ID" + }, + "domain": { + "$ref": "#/components/schemas/DomainDTO" + }, + "system_id": { + "type": "string", + "description": "The device system ID" + } + }, + "required": [ + "name", + "id", + "device_type", + "ip", + "vendor", + "v2_id", + "domain", + "system_id" + ] + }, + "scw-devices": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/ScwLicenseType" + }, + "status": { + "type": "string" + } + } + }, + "DeviceListDTO": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sc_device" + } + } + } + }, + "ScwLicenseType": { + "type": "object" + }, + "LicenseDTO": { + "type": "object", + "properties": { + "status": { + "type": "string" + } + } + }, + "SecureTrackSettingsDTO": { + "type": "object", + "properties": { + "internal_IP_of_secureChange_server": { + "type": "string", + "description": "The internal IP of SecureChange server" + }, + "check_connection_interval": { + "type": "integer", + "format": "int32", + "description": "Connection check interval (in seconds)" + }, + "show_link_to_secureTrack": { + "type": "string", + "description": "Is show link to SecureTrack enabled" + }, + "host": { + "$ref": "#/components/schemas/HostDTO" + } + }, + "required": [ + "host" + ] + }, + "HostDTO": { + "type": "object", + "properties": { + "password": { + "type": "string", + "description": "The SecureTrack administrator password" + }, + "user_name": { + "type": "string", + "description": "The SecureTrack administrator username:" + } + }, + "required": [ + "password", + "user_name" + ] + }, + "SecureTrackConnectivityDTO": { + "type": "object", + "properties": { + "connected": { + "type": "boolean", + "description": "Is SecureChange connected to SecureTrack and SecureTrack connected to SecureChange" + }, + "connection_message": { + "type": "string", + "description": "Connection to SecureTrack message" + }, + "connection_code": { + "type": "string", + "description": "Connection to SecureTrack code" + } + } + }, + "remoteHost": { + "type": "object", + "properties": { + "IP_or_hostname": { + "type": "string", + "description": "The SecureTrack server: IP or hostname " + }, + "password": { + "type": "string", + "description": "The SecureTrack administrator password" + }, + "user_name": { + "type": "string", + "description": "The SecureTrack administrator username:" + } + }, + "required": [ + "IP_or_hostname", + "password", + "user_name" + ] + }, + "localHost": { + "type": "object", + "properties": { + "password": { + "type": "string", + "description": "The SecureTrack administrator password" + }, + "user_name": { + "type": "string", + "description": "The SecureTrack administrator username:" + } + }, + "required": [ + "password", + "user_name" + ] + }, + "IntegrationWithSecureTrackDTO": { + "type": "object", + "properties": { + "secureTrack_settings": { + "$ref": "#/components/schemas/SecureTrackSettingsDTO" + }, + "connection_to_secureTrack": { + "$ref": "#/components/schemas/SecureTrackConnectivityDTO" + } + } + }, + "GroupChangeDTO": { + "type": "object", + "properties": { + "member_ids_to_add": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The member IDs to add to the group" + }, + "member_ids_to_remove": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The member IDs to remove from the group" + } + } + }, + "CreateGroupDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the group" + }, + "email": { + "type": "string", + "description": "The email of the group" + }, + "description": { + "type": "string", + "description": "The description of the group" + } + }, + "required": [ + "name" + ] + }, + "LdapPartyDTO": { + "type": "object", + "properties": { + "ldap_dn": { + "type": "string", + "description": "The LDAP dn of the imported user / group" + }, + "ldap_configuration_name": { + "type": "string", + "description": "The LDAP configuration name" + } + }, + "required": [ + "ldap_dn", + "ldap_configuration_name" + ] + }, + "TicketHistoryDTO": { + "type": "object", + "properties": { + "task_name": { + "type": "string", + "description": "The task name" + }, + "step_name": { + "type": "string", + "description": "The step name" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "date" + }, + "performed_by": { + "type": "string", + "description": "performed by" + }, + "description": { + "type": "string", + "description": "description" + } + }, + "required": [ + "task_name", + "step_name", + "date", + "performed_by", + "description" + ] + }, + "DesignerUpdateDeviceHistoryDTO": { + "type": "object", + "properties": { + "vendor_name": { + "type": "string", + "description": "vendor name" + }, + "device_name": { + "type": "string", + "description": "device name" + }, + "push_command_result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PushCommandResultDTO" + }, + "description": "push command results" + }, + "task_name": { + "type": "string", + "description": "The task name" + }, + "step_name": { + "type": "string", + "description": "The step name" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "date" + }, + "performed_by": { + "type": "string", + "description": "performed by" + }, + "description": { + "type": "string", + "description": "description" + } + }, + "required": [ + "task_name", + "step_name", + "date", + "performed_by", + "description" + ] + }, + "task_assignment_data": { + "type": "object", + "properties": { + "assignee_id": { + "type": "string", + "description": "the internal id of the assignee" + }, + "assignee_name": { + "type": "string", + "description": "the name of the assignee" + }, + "participant_id": { + "type": "string", + "description": "the internal id of the assignee party" + }, + "participant_name": { + "type": "string", + "description": "the name of the assignee party" + } + }, + "required": [ + "assignee_id", + "assignee_name", + "participant_id", + "participant_name" + ] + }, + "TicketHistoryListDTO": { + "type": "object", + "properties": { + "ticket_id": { + "type": "integer", + "format": "int64", + "description": "The ticket ID" + }, + "ticket_history_activity": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketHistoryDTO" + }, + "description": "The ticket history" + } + }, + "required": [ + "ticket_id", + "ticket_history_activity" + ] + }, + "TicketEvent": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "the type of the event" + }, + "timestamp": { + "type": "string", + "description": "the timestamp of the event" + }, + "domain_id": { + "type": "string", + "description": "the id of the domain" + }, + "ticket_id": { + "type": "string", + "description": "the id of the ticket" + }, + "task_id": { + "type": "string", + "description": "the internal id of the task" + }, + "workflow_type": { + "type": "string", + "description": "workflow type" + }, + "business_duration": { + "type": "integer", + "format": "int64", + "description": "the business duration" + }, + "sla_status": { + "type": "string", + "description": "the sla status" + }, + "workflow_name": { + "type": "string", + "description": "the name of the workflow" + }, + "task_name": { + "type": "string", + "description": "the name of the task" + }, + "parent_workflow_id": { + "type": "string", + "description": "the internal id of the parent workflow" + }, + "step_id": { + "type": "string", + "description": "the internal id of the step" + }, + "step_name": { + "type": "string", + "description": "the name of the step" + }, + "assignment_type": { + "type": "string", + "description": "the type of the assignment. possible types are: assigner, self assigned and reassign group" + }, + "task_assigned_data": { + "$ref": "#/components/schemas/task_assignment_data" + }, + "initiated_by": { + "type": "string", + "description": "initiated by" + }, + "potential_participants": { + "type": "array", + "items": { + "type": "string" + }, + "description": "the potential participants from the workflow" + }, + "error_automation_tool": { + "$ref": "#/components/schemas/error_automation_tool" + } + }, + "required": [ + "type", + "timestamp", + "domain_id", + "ticket_id", + "workflow_name", + "parent_workflow_id" + ] + }, + "CommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + } + }, + "required": [ + "comment" + ] + }, + "error_automation_tool": { + "type": "object", + "properties": { + "error_tool": { + "type": "string", + "description": "the automation tool that failed" + }, + "error_reason": { + "type": "array", + "items": { + "type": "string" + }, + "description": "the reason for the error" + } + } + }, + "Companion": { + "type": "object" + }, + "RejectCommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + } + }, + "required": [ + "comment" + ] + }, + "TicketEventsCreateHistoryStatusDTO": { + "type": "object", + "properties": { + "run_status": { + "$ref": "#/components/schemas/HistoryStatus" + }, + "oldest_event_time": { + "type": "string", + "description": "Oldest event time" + } + }, + "required": [ + "run_status" + ] + }, + "PushCommandResultDTO": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "status" + }, + "order": { + "type": "integer", + "format": "int32", + "description": "order" + }, + "command": { + "type": "string", + "description": "command" + }, + "failure_reason": { + "type": "string", + "description": "failure reason" + } + } + }, + "HistoryStatus": { + "type": "object" + }, + "TicketEventsCreateHistoryRequestDTO": { + "type": "object", + "properties": { + "from": { + "type": "string", + "description": "from date. Date format expected: yyyy-MM-dd" + } + }, + "required": [ + "from" + ] + }, + "ReassignTaskCommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + } + }, + "required": [ + "comment" + ] + }, + "potential_participant": { + "type": "object", + "properties": { + "participant_id": { + "type": "string", + "description": "the internal id of the participant" + }, + "participant_name": { + "type": "string", + "description": "the name of the participant" + } + }, + "required": [ + "participant_id", + "participant_name" + ] + }, + "RedoStepCommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + } + }, + "required": [ + "comment" + ] + }, + "TicketEventListDTO": { + "type": "object", + "properties": { + "ticket_event": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketEvent" + }, + "description": "The ticket event list" + }, + "countOfElemnt": { + "type": "integer", + "format": "int32" + }, + "totalElement": { + "type": "integer", + "format": "int64" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of items that can be retrieved" + } + }, + "required": [ + "ticket_event", + "count", + "total" + ] + }, + "ConfirmCommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string" + } + }, + "required": [ + "comment" + ] + }, + "InstructionStatus": { + "type": "object" + }, + "CoveredByField": { + "type": "object", + "properties": { + "order": { + "type": "integer", + "format": "int32", + "description": "Order" + }, + "type": { + "type": "string", + "description": "Field type" + } + }, + "required": [ + "order", + "type" + ] + }, + "RootDevice": { + "type": "object", + "properties": { + "api_v1_id": { + "type": "integer", + "format": "int32", + "description": "API v1 ID" + } + }, + "required": [ + "api_v1_id" + ] + }, + "tags": { + "type": "object", + "properties": { + "values": { + "type": "array", + "items": { + "type": "string" + } + }, + "new_value": { + "type": "string" + } + } + }, + "AccessRequestsSecurityZonesDTO": { + "type": "object", + "properties": { + "access_request_security_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRequestSecurityZoneDTO" + }, + "description": "The list of access request security zone" + } + }, + "required": [ + "access_request_security_zone" + ] + }, + "AccessRequestSecurityZoneDTO": { + "type": "object", + "properties": { + "security_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityZoneDTO" + }, + "description": "The security zones of the destination" + }, + "access_request": { + "$ref": "#/components/schemas/AccessRequestDTO" + } + } + }, + "user_name": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "object_name": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "CommitDeviceResultDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "policy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommitPolicyResultDTO" + } + }, + "status": { + "$ref": "#/components/schemas/CommitStatusDTO" + }, + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "warning": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ChangedEntity": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name" + }, + "type": { + "type": "string", + "description": "The entity type" + }, + "uid": { + "type": "string", + "description": "UID" + }, + "new_entity_uid": { + "type": "string", + "description": "The new entity UID" + } + }, + "required": [ + "type" + ] + }, + "user_replace": { + "type": "object", + "properties": { + "old_value": { + "type": "string" + }, + "new_value": { + "type": "string" + } + } + }, + "rule_order": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "TicketListDTO": { + "type": "object", + "properties": { + "next": { + "$ref": "#/components/schemas/LinkDTO" + }, + "previous": { + "$ref": "#/components/schemas/LinkDTO" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketDTO" + }, + "description": "The list of tickets" + } + }, + "required": [ + "next", + "previous", + "ticket" + ] + }, + "rule_placement": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "DesignerResults": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The designer results ID" + }, + "status": { + "type": "string", + "description": "Result Status" + }, + "root_device": { + "$ref": "#/components/schemas/Device" + }, + "new_revision_status": { + "type": "string", + "description": "Revision status" + }, + "total_devices_results": { + "type": "integer", + "format": "int32", + "description": "Total devices results count per system ID" + }, + "device_results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceResults" + }, + "description": "Designer results for a device" + }, + "system_id": { + "type": "string", + "description": "The designer results system ID" + } + }, + "required": [ + "id", + "status", + "root_device", + "new_revision_status", + "total_devices_results", + "device_results", + "system_id" + ] + }, + "CombinedPolicy": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name" + }, + "uid": { + "type": "string", + "description": "UID" + } + }, + "required": [ + "name", + "uid" + ] + }, + "rule_name": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "security_groups": { + "type": "object", + "properties": { + "values": { + "type": "array", + "items": { + "type": "string" + } + }, + "new_value": { + "type": "string" + } + } + }, + "InstructionStatusResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Errors" + } + }, + "required": [ + "id", + "errors" + ] + }, + "DeviceProvisioningStatus": { + "type": "object" + }, + "ReplaceInstructionResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Status" + }, + "instructions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InstructionStatusResult" + }, + "description": "Instructions" + } + }, + "required": [ + "status", + "instructions" + ] + }, + "BusinessDurationRequestDTO": { + "type": "object", + "properties": { + "from": { + "type": "string", + "description": "the creation date of the affected tickets. Default value if not set is 2 years ago. Date format expected: yyyy-MM-dd. Value is limited for up to 2 years ago." + } + }, + "required": [ + "from" + ] + }, + "TicketPropertiesDTO": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "The priority of the ticket (use 'Critical, High, Normal, Low')" + }, + "expiration_date": { + "type": "string", + "description": "The expiration date of the ticket (use yyyy-mm-dd for update and empty value for NONE)" + }, + "referenced_ticket": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "notification_group": { + "$ref": "#/components/schemas/group" + } + } + }, + "CommitPolicyResultDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "fw_result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommitTargetResultDTO" + } + }, + "status": { + "$ref": "#/components/schemas/CommitStatusDTO" + }, + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "warning": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Field": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Field type" + } + }, + "required": [ + "type" + ] + }, + "ZoneDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the zone" + }, + "id": { + "type": "string", + "description": "The ID of the zone" + } + } + }, + "ProvisioningStatus": { + "type": "object" + }, + "comment": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "DeviceResults": { + "type": "object", + "properties": { + "device": { + "$ref": "#/components/schemas/Device" + }, + "new_revision_status": { + "type": "string", + "description": "Revision status" + }, + "policy_suggestions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicySuggestions" + }, + "description": "Policy suggestions" + } + }, + "required": [ + "device", + "new_revision_status", + "policy_suggestions" + ] + }, + "Instruction": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Instruction ID" + }, + "change_type": { + "type": "string", + "description": "Type of instruction change" + }, + "changed_entity": { + "$ref": "#/components/schemas/ChangedEntity" + }, + "relation_changes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelationChange" + }, + "description": "Relation changes" + }, + "customization_type": { + "type": "string", + "description": "Type of customization" + } + }, + "required": [ + "id", + "change_type", + "changed_entity", + "relation_changes" + ] + }, + "SystemResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Result status" + }, + "redesign_status": { + "$ref": "#/components/schemas/RedesignStatusDTO" + }, + "root_device": { + "$ref": "#/components/schemas/RootDevice" + }, + "system_name": { + "type": "string", + "description": "System name" + }, + "href": { + "$ref": "#/components/schemas/LinkDTO" + }, + "system_id": { + "type": "string", + "description": "System ID" + } + }, + "required": [ + "status", + "redesign_status", + "root_device", + "system_name", + "href", + "system_id" + ] + }, + "CommitReportDTO": { + "type": "object", + "properties": { + "endTime": { + "type": "string" + }, + "duration": { + "type": "string" + }, + "vendorName": { + "type": "string" + }, + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommitDeviceResultDTO" + } + }, + "ticketId": { + "type": "integer", + "format": "int64" + }, + "managmentName": { + "type": "string" + }, + "notRunReason": { + "type": "string" + }, + "startTime": { + "type": "string" + } + } + }, + "ResultDetails": { + "type": "object", + "properties": { + "instructions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Instruction" + }, + "description": "Instructions" + }, + "covered_by_fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CoveredByField" + }, + "description": "Covered by fields" + }, + "nat_on_path": { + "type": "boolean", + "description": "Set to true to get the NAT on path" + } + }, + "required": [ + "instructions", + "covered_by_fields", + "nat_on_path" + ] + }, + "Instructions": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ResultDetails" + }, + "status": { + "type": "string", + "description": "Status" + }, + "access_request": { + "$ref": "#/components/schemas/Field" + }, + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "required": [ + "status", + "access_request" + ] + }, + "EmbeddedEntity": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Entity type" + } + }, + "required": [ + "type" + ] + }, + "ProvisioningInstructionDTO": { + "type": "object", + "properties": { + "error_message": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/InstructionStatus" + }, + "instruction_id": { + "type": "string" + } + } + }, + "track_level": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "DeviceProvisioningResultDTO": { + "type": "object", + "properties": { + "device_id": { + "type": "string" + }, + "device_provisioning_status": { + "$ref": "#/components/schemas/DeviceProvisioningStatus" + }, + "provisioning_instruction_status": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProvisioningInstructionDTO" + } + } + } + }, + "ProvisioningResultListDTO": { + "type": "object", + "properties": { + "provisioning_link": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LinkDTO" + }, + "description": "The provisioning result links list" + } + }, + "required": [ + "provisioning_link" + ] + }, + "CommitTargetResultDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/CommitStatusDTO" + }, + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "warning": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "change": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "SecurityZoneDTO": { + "type": "object", + "properties": { + "any": { + "type": "boolean", + "description": "The security zone is all" + }, + "zone": { + "$ref": "#/components/schemas/ZoneDTO" + }, + "network_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectDTO" + }, + "description": "The list of network objects " + } + } + }, + "RelationChange": { + "type": "object", + "properties": { + "entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EntityReference" + }, + "description": "Entities" + }, + "relation_change_Type": { + "type": "string", + "description": "Change type" + }, + "relation": { + "type": "string", + "description": "Relation" + }, + "predefined_value": { + "type": "string", + "description": "Predefined value" + }, + "embedded_entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EmbeddedEntity" + }, + "description": "Embedded entities" + } + }, + "required": [ + "entities", + "relation_change_Type", + "relation", + "embedded_entities" + ] + }, + "SystemResultListDTO": { + "type": "object", + "properties": { + "system_result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemResult" + }, + "description": "The system result list" + } + }, + "required": [ + "system_result" + ] + }, + "DesignerCommandsDTO": { + "type": "object", + "properties": { + "command": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AccessRequestDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the access request" + }, + "order": { + "type": "string", + "description": "The order of the access request" + } + } + }, + "Device": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The device name" + }, + "uid": { + "type": "string", + "description": "The device UID" + }, + "v1_id": { + "type": "string", + "description": "The device V1 ID" + } + }, + "required": [ + "name", + "uid", + "v1_id" + ] + }, + "ProvisioningSystemResult": { + "type": "object", + "properties": { + "error_message": { + "type": "string" + }, + "provisioning_status": { + "$ref": "#/components/schemas/ProvisioningStatus" + }, + "device_provisioning_results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceProvisioningResultDTO" + } + }, + "redesigned_after_provisioning": { + "type": "boolean" + }, + "system_id": { + "type": "string" + } + } + }, + "PolicySuggestions": { + "type": "object", + "properties": { + "combined_policy": { + "$ref": "#/components/schemas/CombinedPolicy" + }, + "access_request_instructions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Instructions" + }, + "description": "The access request instructions" + } + }, + "required": [ + "access_request_instructions" + ] + }, + "EntityReference": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name" + }, + "type": { + "type": "string", + "description": "Entity type" + }, + "uid": { + "type": "string", + "description": "UID" + }, + "new_entity_uid": { + "type": "string", + "description": "The new entity UID" + } + }, + "required": [ + "name", + "type" + ] + }, + "log_forwarding_profile": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "object_replace": { + "type": "object", + "properties": { + "old_value": { + "type": "string" + }, + "new_value": { + "type": "string" + } + } + }, + "Error": { + "type": "object", + "properties": { + "error_code": { + "type": "string", + "description": "Error code" + } + }, + "required": [ + "error_code" + ] + }, + "security_profile_group": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "TriggerDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "workflow": { + "$ref": "#/components/schemas/WorkflowDTO_Triggers" + }, + "event": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Event" + } + } + } + }, + "Event": { + "type": "object" + }, + "WorkflowTriggerDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "executer": { + "$ref": "#/components/schemas/ExecuterDTO" + }, + "trigger": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TriggerDTO" + } + } + } + }, + "WorkflowTriggersDTO": { + "type": "object", + "properties": { + "workflow_trigger": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowTriggerDTO" + } + } + } + }, + "ScriptDTO": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "arguments": { + "type": "string" + } + } + }, + "ExecuterDTO": { + "type": "object" + }, + "BasicWorkflowInfoListDTO": { + "type": "object", + "properties": { + "workflow": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BasicWorkflowInfoDTO" + } + } + } + }, + "BasicWorkflowInfoDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "Action": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "BindingDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "CommitStatusDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "CpType": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "DecommissionResultDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "Optional": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "Origin": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "StatusDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "VendorTypeDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "attachment": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "http_www.tufin.com_sc_RuleOperationDeviceDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "void": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + } + } + }, + "paths": { + "/securechangeworkflow/api/secureapp/cloud_console/servers/": { + "get": { + "tags": [ + "Cloud Console" + ], + "operationId": "getCloudServers", + "summary": "Retrieve cloud server listing from SecureTrack", + "parameters": [ + { + "name": "customer_id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Customer ID to be filtered by." + }, + { + "name": "vendor", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "Vendor to be filtered by." + }, + { + "name": "search_string", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "Search text." + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Returning matching result starting from this element in the array (0-based)." + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Total number of matching servers to return." + } + ], + "responses": { + "403": { + "description": "Access is denied" + }, + "503": { + "description": "Not connected to SecureTrack." + }, + "500": { + "description": "An error occurred in SecureTrack while trying to search for cloud servers." + }, + "400": { + "description": "Customer with ID was decommissioned." + }, + "200": { + "description": "Retrieve cloud server listing from SecureTrack", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/VMInstanceListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Cloud Console" + ], + "operationId": "addCloudServers", + "summary": "Associate cloud servers from SecureTrack with an application", + "parameters": [ + { + "name": "application_id", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/DeviceToUidsListDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Servers were imported to SecureApp." + }, + "403": { + "description": "The AWS instance with UID and device ID has already been imported to application NAME. You cannot import the same instance multiple times." + }, + "400": { + "description": "You cannot associate servers with this application, because the application has been decommissioned." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "503": { + "description": "Not connected to SecureTrack." + }, + "500": { + "description": "An error occurred in SecureTrack while trying to add cloud servers." + } + } + } + }, + "/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule": { + "put": { + "tags": [ + "Cloud Console" + ], + "operationId": "saveAutoAssociationRule", + "summary": "Auto associate cloud servers from SecureTrack with an application", + "description": "When auto-associate is enabled, user must enter key value", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CloudServerAutoAssociationRuleDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Auto association rule is saved." + }, + "400": { + "description": "Enabled rule requires key value." + }, + "403": { + "description": "Access is denied" + }, + "503": { + "description": "Not connected to SecureTrack." + }, + "500": { + "description": "An error occurred in SecureTrack while trying to search for cloud servers." + } + } + } + }, + "/securechangeworkflow/api/secureapp/customers/": { + "get": { + "tags": [ + "Customers" + ], + "operationId": "getCustomers", + "summary": "List all customers", + "parameters": [ + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the customer" + } + ], + "responses": { + "400": { + "description": "Not available in single-customer mode." + }, + "404": { + "description": "There are no customers with the name NAME." + }, + "200": { + "description": "List all customers", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CustomerListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/customers/import": { + "put": { + "tags": [ + "Customers" + ], + "operationId": "importCustomers", + "summary": "import customers", + "description": "Only users with 'Create new applications' and 'View all applications' permissions can run this API.", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CustomerListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "There are some id's that doesn't exist." + }, + "403": { + "description": "Access is denied" + }, + "503": { + "description": "Not connected to SecureTrack." + }, + "200": { + "description": "import customers" + } + } + } + }, + "/securechangeworkflow/api/secureapp/customers/imported": { + "get": { + "tags": [ + "Customers" + ], + "operationId": "getImported", + "summary": "List all imported customers", + "responses": { + "400": { + "description": "Not available in single-customer mode." + }, + "403": { + "description": "Access is denied" + }, + "200": { + "description": "List all imported customers", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CustomerListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/customers/not_imported": { + "get": { + "tags": [ + "Customers" + ], + "operationId": "getNotImported", + "summary": "List all non-imported customers", + "description": "Only users with 'Create new applications' and 'View all applications' permissions can run this API.", + "responses": { + "400": { + "description": "Not available in single-customer mode." + }, + "403": { + "description": "Access is denied" + }, + "503": { + "description": "Not connected to SecureTrack." + }, + "200": { + "description": "List all non-imported customers", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CustomerListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/customers/{customer_id}": { + "get": { + "tags": [ + "Customers" + ], + "operationId": "getCustomer", + "summary": "Fetches customer by ID", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the customer" + } + ], + "responses": { + "400": { + "description": "Customer with id ID was not found." + }, + "200": { + "description": "Fetches customer by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CustomerDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Customers" + ], + "operationId": "updateCustomer", + "summary": "Update a customer", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the customer" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerDTO" + } + } + } + }, + "responses": { + "400": { + "description": "You cannot delete this customer because there are connection changes pending a ticket in another customer.You must decommission this customer first, and then delete it." + }, + "403": { + "description": "Access is denied" + }, + "500": { + "description": "This customer is not imported." + }, + "200": { + "description": "Update a customer" + } + } + } + }, + "/securechangeworkflow/api/secureapp/customers/{customer_id}/applications": { + "get": { + "tags": [ + "Customers" + ], + "operationId": "getApplications_2", + "summary": "Retrieve existing applications for specific domain", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the customer" + } + ], + "responses": { + "400": { + "description": "Customer with id ID was not found." + }, + "403": { + "description": "Access is denied" + }, + "200": { + "description": "Retrieve existing applications for specific domain", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers": { + "get": { + "tags": [ + "Load Balancers" + ], + "operationId": "getVirtualServers", + "summary": "Fetches virtual servers from SecureTrack", + "description": "Find virtual servers matching a given IP address.\nYou can search for the virtual server itself of any of its members.", + "parameters": [ + { + "name": "ip", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "ip" + }, + { + "name": "domainId", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "The unique identifier of a domain" + } + ], + "responses": { + "400": { + "description": "There is no domain with the specified ID." + }, + "403": { + "description": "Access is denied" + }, + "503": { + "description": "Not connected to SecureTrack." + }, + "200": { + "description": "Fetches virtual servers from SecureTrack", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/F5VirtualServerListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/application_identities": { + "get": { + "tags": [ + "Application Identities" + ], + "operationId": "getL7Applications", + "summary": "Fetches application identities", + "description": "Fetches the list of pre-defined application identities (like facebook) that can be used in a connection.", + "parameters": [ + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the service" + } + ], + "responses": { + "404": { + "description": "There are no application identities with the name NAME." + }, + "403": { + "description": "Access is denied." + }, + "200": { + "description": "Fetches application identities", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Layer7ApplicationListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "getApplications", + "summary": "List all applications", + "parameters": [ + { + "name": "userId", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Applications by user ID, if not given the default is logged in user id" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the application" + }, + { + "name": "app_permissions", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Filter applications by the given permissions (separated with commas):\napp_owner - returns applications where the user is the owner\napp_editor - returns applications where the user has been explicitly added as an editor\napp_viewer - returns applications where the user has been explicitly added as a viewer\napp_adminonly - returns applications where the user only has editor access because user has \"edit all applications\" permission, and does not include applications where this user is either the app_owner, app_editor, or app_viewer" + } + ], + "responses": { + "400": { + "description": "Invalid app_permissions value: 'appPermissions'." + }, + "403": { + "description": "You can't use the parameter 'userId' because you don't have 'View all applications' permission." + }, + "404": { + "description": "User with ID 'userId' was not found." + }, + "200": { + "description": "List all applications", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Applications" + ], + "operationId": "addApplications", + "summary": "Create new applications", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "There is an editor without an ID or name." + }, + "403": { + "description": "Access is denied" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no editor with the name NAME." + }, + "200": { + "description": "Create new applications" + } + } + }, + "put": { + "tags": [ + "Applications" + ], + "operationId": "modifyApplications", + "summary": "Update applications", + "description": "This API can be used to delete or decommission an application.\nTo decommission an application, send true in decommissioned tag.", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "User cannot be both an editor and a viewer of the application." + }, + "403": { + "description": "You do not have permissions to decommission this application." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Update applications" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/migrate/{sourceApplicationId},{targetApplicationId}": { + "put": { + "tags": [ + "Application Migration" + ], + "operationId": "migrateApplication", + "summary": "Copy application servers and connections to another application.", + "description": "This API can be used to:\n1. Create applications based on a blueprint (template).\n2. Copy applications between environments (dev, test, prod).\n3. Migrate applications between data-centers.\n\nBefore migrating make sure to map servers and connections to applications (if any exist).\nThis migration uses the configuration specified in the other API calls.", + "parameters": [ + { + "name": "sourceApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the source application" + }, + { + "name": "targetApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the target application" + } + ], + "responses": { + "200": { + "description": "Application was migrated." + }, + "400": { + "description": "The source application has no connections to migrate." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "409": { + "description": "You cannot migrate the application because one of the interfaces in the original application has been changed and has not been published." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/migrate/{sourceApplicationId},{targetApplicationId}/connections_to_applications_mapping": { + "get": { + "tags": [ + "Application Migration" + ], + "operationId": "getInterfaceInstanceMapping", + "summary": "Retrieve connection to application mappings for source and target applications", + "parameters": [ + { + "name": "sourceApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the source application" + }, + { + "name": "targetApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the target application" + } + ], + "responses": { + "400": { + "description": "Cannot get mappings between application to itself." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Retrieve connection to application mappings for source and target applications", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/InterfaceInstanceMappingListDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Application Migration" + ], + "operationId": "modifyInterfaceInstanceMapping", + "summary": "Update connection to application mappings for source and target applications", + "description": "Use id=-1 for target_application_interface if new mapping is \"Not Needed\".\nIf the source is specified and the target is empty, the mapping that is currently configured will be deleted.", + "parameters": [ + { + "name": "sourceApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the source application" + }, + { + "name": "targetApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the target application" + } + ], + "requestBody": { + "required": false, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/InterfaceInstanceMappingListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Connection to application mappings were modified." + }, + "400": { + "description": "Application interface ID must be in the same customer as the target application." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "There is no application with the specified ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/migrate/{sourceApplicationId},{targetApplicationId}/servers_mapping": { + "get": { + "tags": [ + "Application Migration" + ], + "operationId": "getServersMapping", + "summary": "Retrieve server mappings for source and target applications", + "parameters": [ + { + "name": "sourceApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the source application" + }, + { + "name": "targetApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the target application" + }, + { + "name": "search_servers_type", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Search server type" + } + ], + "responses": { + "400": { + "description": "Cannot get mappings between application to itself." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "You do not have permissions to edit this application." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Retrieve server mappings for source and target applications", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServerMappingListDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Application Migration" + ], + "operationId": "modifyServersMapping", + "summary": "Update server mappings for source and target applications", + "description": "Use id=-1 for target_network_object if new mapping is \"Not Needed\".\nIf the source is specified and the target is empty, the mapping that is currently configured will be deleted.", + "parameters": [ + { + "name": "sourceApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the source application" + }, + { + "name": "targetApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the target application" + } + ], + "requestBody": { + "required": false, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServerMappingListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Server mappings were modified." + }, + "400": { + "description": "Target network object ID must be in the same customer as the target application." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "Server with ID was not found." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/move_applications": { + "put": { + "tags": [ + "Applications" + ], + "operationId": "moveApplications", + "summary": "Move applications to another customer", + "requestBody": { + "required": false, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationToDomainListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Applications were moved successfully." + }, + "400": { + "description": "There are no applications to move." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "getApplication", + "summary": "Retrieve an existing application by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application to retrieve" + } + ], + "responses": { + "400": { + "description": "The application was already deleted." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Retrieve an existing application by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/sa_application" + } + } + } + } + } + }, + "put": { + "tags": [ + "Applications" + ], + "operationId": "modifyApplication", + "summary": "Change an application", + "description": "This API can be used to delete or decommission an application.\nTo decommission an application, send true in decommissioned tag.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application to change" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/sa_application" + } + } + } + }, + "responses": { + "400": { + "description": "User cannot be both an editor and a viewer of the application." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Change an application" + } + } + }, + "delete": { + "tags": [ + "Applications" + ], + "operationId": "deleteApplication", + "summary": "Delete an application", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application to delete" + } + ], + "responses": { + "400": { + "description": "You cannot delete application NAME because there are connection changes pending a ticket in other application." + }, + "403": { + "description": "Access is denied" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "200": { + "description": "Delete an application" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/access_requests": { + "get": { + "tags": [ + "Application Pending Changes" + ], + "operationId": "getAccessRequestsForCreateTicket", + "summary": "Retrieve existing access rules", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "responses": { + "400": { + "description": "Application with ID ID was not found." + }, + "403": { + "description": "You do not have permissions to edit this application." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "200": { + "description": "Retrieve existing access rules", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/AccessRuleListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/application_access_requests": { + "get": { + "tags": [ + "Access Portal" + ], + "operationId": "getApplicationAccessRequests", + "summary": "Retrieve existing application access requests", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "responses": { + "400": { + "description": "The application was already deleted." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Retrieve existing application access requests", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationAccessRequestListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Access Portal" + ], + "operationId": "addApplicationAccessRequest", + "summary": "Create application access request", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationAccessRequestDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Application access request was submitted." + }, + "400": { + "description": "Invalid ip" + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + } + } + }, + "put": { + "tags": [ + "Access Portal" + ], + "operationId": "modifyRequestsStatus", + "summary": "Update application access requests", + "description": "Use this API to approve or reject application access requests", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationAccessRequestListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Application access requests were updated." + }, + "400": { + "description": "The Server group is lock for discovery" + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/application_access_requests/{requestId}": { + "get": { + "tags": [ + "Access Portal" + ], + "operationId": "getApplicationAccessRequest", + "summary": "Retrieve an existing application access request by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "requestId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application access request" + } + ], + "responses": { + "400": { + "description": "The application was already deleted." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Access request with id ID was not found in application with id ID" + }, + "200": { + "description": "Retrieve an existing application access request by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationAccessRequestDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Access Portal" + ], + "operationId": "modifyRequestStatus", + "summary": "Update an application access request", + "description": "Use this API to approve or reject application access requests", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "requestId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application access request" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationAccessRequestDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Application access request was updated." + }, + "400": { + "description": "The Server group is lock for discovery" + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/application_interfaces": { + "get": { + "tags": [ + "Application Interfaces" + ], + "operationId": "getApplicationInterfaces", + "summary": "Retrieve existing application interfaces", + "description": "To improve response time, set 'calculateIsPublished = false' to avoid calculating 'is_published'.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the application interface" + }, + { + "name": "calculateIsPublished", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Should calculate is_published value" + } + ], + "responses": { + "400": { + "description": "There is no application with the specified ID." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There are no application interfaces with the name NAME." + }, + "200": { + "description": "Retrieve existing application interfaces", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Interfaces" + ], + "operationId": "addApplicationInterface", + "summary": "Create application interface", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Application interface was created." + }, + "400": { + "description": "You cannot add to application NAME because it was decommissioned." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found for application with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/application_interfaces/{applicationInterfaceId}": { + "get": { + "tags": [ + "Application Interfaces" + ], + "operationId": "getApplicationInterface", + "summary": "Retrieve an existing application interface by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found for application with ID." + }, + "200": { + "description": "Retrieve an existing application interface by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Application Interfaces" + ], + "operationId": "modifyApplicationInterface", + "summary": "Update an application interface", + "description": "Update the application interface properties. If is_published is set to true, the application interface is published for use by other users.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of The application interface" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Application interface was modified." + }, + "400": { + "description": "Name cannot be empty." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found for application with ID." + } + } + }, + "delete": { + "tags": [ + "Application Interfaces" + ], + "operationId": "deleteApplicationInterface", + "summary": "Delete application interface", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + } + ], + "responses": { + "200": { + "description": "Application interface was deleted." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found for application with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/application_interfaces/{applicationInterfaceId}/interface_connections": { + "get": { + "tags": [ + "Application Interfaces" + ], + "operationId": "getConnectionInterfaces", + "summary": "Retrieve existing interface connections", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the interface connection" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found for application with ID." + }, + "200": { + "description": "Retrieve existing interface connections", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionInterfaceListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Interfaces" + ], + "operationId": "addConnectionInterfaces", + "summary": "Create interface connections", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionInterfaceListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Interface connections were created." + }, + "201": { + "description": "Interface connection was created." + }, + "400": { + "description": "Reference to service ID is invalid." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found for application with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/application_interfaces/{applicationInterfaceId}/interface_connections/{connectionInterfaceId}": { + "get": { + "tags": [ + "Application Interfaces" + ], + "operationId": "getConnectionInterface", + "summary": "Retrieve an existing interface connection by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + }, + { + "name": "connectionInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the interface connection" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection interface with ID was not found for application interface with ID." + }, + "200": { + "description": "Retrieve an existing interface connection by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionInterfaceDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Application Interfaces" + ], + "operationId": "modifyConnectionInterface", + "summary": "Update an interface connection", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + }, + { + "name": "connectionInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the interface connection" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionInterfaceDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Interface connection was modified." + }, + "400": { + "description": "Reference to service ID is invalid." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection interface with ID was not found for application interface with ID." + } + } + }, + "delete": { + "tags": [ + "Application Interfaces" + ], + "operationId": "deleteConnectionInterface", + "summary": "Delete interface connection", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + }, + { + "name": "connectionInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the interface connection" + } + ], + "responses": { + "200": { + "description": "Interface connection was deleted." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection interface with ID was not found for application interface with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/compliance_violations": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "getSPComplianceViolations", + "summary": "Retrieve security policy violations from SecureTrack", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "Security policy compliance check is not available because a security policy has not been defined." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "503": { + "description": "Timeout occurred while waiting for response from SecureTrack." + }, + "500": { + "description": "An error occurred in SecureTrack when running the security compliance check." + }, + "200": { + "description": "Retrieve security policy violations from SecureTrack", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ComplianceResultListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/connections": { + "get": { + "tags": [ + "Application Connections" + ], + "operationId": "getConnections", + "summary": "Retrieve existing connections", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the connection" + } + ], + "responses": { + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "404": { + "description": "There are no connections with the name NAME." + }, + "200": { + "description": "Retrieve existing connections", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationConnectionListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Connections" + ], + "operationId": "addConnections", + "summary": "Create connections", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationConnectionListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Connections were created." + }, + "201": { + "description": "Connection was created." + }, + "400": { + "description": "Connections can only include objects within the same customer." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + } + } + }, + "put": { + "tags": [ + "Application Connections" + ], + "operationId": "modifyConnections", + "summary": "Update connections", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationConnectionListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Connections were modified." + }, + "400": { + "description": "You cannot modify this connection using the Update connection API function. To modify the connection, use the Update connection to application API function." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "Connection with ID was not found for application with ID." + }, + "406": { + "description": " This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/connections/{connectionId}": { + "get": { + "tags": [ + "Application Connections" + ], + "operationId": "getConnection", + "summary": "Retrieve an existing connection by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "connectionId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection" + } + ], + "responses": { + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "404": { + "description": "Connection with ID was not found for application with ID." + }, + "200": { + "description": "Retrieve an existing connection by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Application Connections" + ], + "operationId": "modifyConnection", + "summary": "Update a connection", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "connectionId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Connection was modified." + }, + "400": { + "description": "You cannot modify this connection using the Update connection API function. To modify the connection, use the Update connection to application API function." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "Connection with ID was not found for application with ID." + } + } + }, + "delete": { + "tags": [ + "Application Connections" + ], + "operationId": "deleteConnection", + "summary": "Delete connection", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "connectionId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection" + } + ], + "responses": { + "200": { + "description": "Connection was deleted." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "Connection with ID was not found for application with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/connections_extended": { + "get": { + "tags": [ + "Application Connections" + ], + "operationId": "getConnectionFullResources", + "summary": "Retrieve existing connections, with extended resources information", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the connection" + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Return results starting only from the specified index; 0-based index; default value = 0" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Return the specified number of results. Returns all results if no value specified" + } + ], + "responses": { + "400": { + "description": "Count value must be greater than 0." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "Access is denied." + }, + "404": { + "description": "There are no connections with the name NAME." + }, + "200": { + "description": "Retrieve existing connections, with extended resources information", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionFullResourcesListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/connections_to_applications": { + "get": { + "tags": [ + "Application Interfaces" + ], + "operationId": "getApplicationInterfaceInstances", + "summary": "Retrieve existing connections to application", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the connection to application" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection interface with ID was not found for application interface with ID." + }, + "200": { + "description": "Retrieve existing connections to application", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceInstanceListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Interfaces" + ], + "operationId": "addApplicationInterfaceInstance", + "summary": "Create connection to application", + "description": "Create a connection from this application to an application interface.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceInstanceDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Connection to application was created." + }, + "400": { + "description": "You cannot add Internet to connection to application." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/connections_to_applications/{connectionToApplicationId}": { + "get": { + "tags": [ + "Application Interfaces" + ], + "operationId": "getApplicationInterfaceInstance", + "summary": "Retrieve an existing connection to application by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "connectionToApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection to application" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection to application with ID was not found for application interface with ID." + }, + "200": { + "description": "Retrieve an existing connection to application by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceInstanceDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Application Interfaces" + ], + "operationId": "modifyApplicationInterfaceInstance", + "summary": "Update a connection to application", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "connectionToApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection to application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceInstanceDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Connection to application was modified." + }, + "400": { + "description": "You cannot add Internet to connection to application." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection to application with ID was not found for application interface with ID." + } + } + }, + "delete": { + "tags": [ + "Application Interfaces" + ], + "operationId": "deleteApplicationInterfaceInstance", + "summary": "Delete connection to application", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "connectionToApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection to application" + } + ], + "responses": { + "200": { + "description": "Connection to application was deleted." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection to application with ID was not found for application interface with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/history": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "getApplicationHistory", + "summary": "Retrieve application history", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "start_date", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "States starting date to fetch history since. Date format expected: yyyy-mm-dd" + }, + { + "name": "end_date", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Get history until this date. Date format expected: yyyy-mm-dd" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "History list length" + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Offset the count starting point" + }, + { + "name": "type", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "States the history type to fetch" + }, + { + "name": "user", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The username of the user made the changes" + }, + { + "name": "showMembers", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Whether or not to show group members of server/service groups" + } + ], + "responses": { + "400": { + "description": "User not found" + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Retrieve application history", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/HistoryListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/network_objects": { + "get": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "getServers_2", + "summary": "Retrieve existing servers", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the server" + }, + { + "name": "ip", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The ip of the server" + }, + { + "name": "show_cloned_servers", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "400": { + "description": "Parameter typeOnDevice is not valid." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There are no servers with the typeOnDevice TYPEONDEVICE " + }, + "200": { + "description": "Retrieve existing servers", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/NetworkObjectListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "addServers", + "summary": "Create servers", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/NetworkObjectListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "The type_on_device value is not valid " + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Virtual server was not found in SecureTrack." + }, + "503": { + "description": "Not connected to SecureTrack." + }, + "200": { + "description": "Create servers" + } + } + }, + "put": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "modifyServers", + "summary": "Update servers", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/NetworkObjectListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Server with ID was not found in application with ID." + }, + "503": { + "description": "Not connected to SecureTrack." + }, + "200": { + "description": "Update servers" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/network_objects/{serverId}": { + "delete": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "deleteServer", + "summary": "Delete server", + "description": "To decommission a serer use force=true.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "serverId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the server" + }, + { + "name": "force", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Force delete" + } + ], + "responses": { + "400": { + "description": "Cannot delete a predefined object." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Server with ID was not found in application with ID." + }, + "200": { + "description": "Delete server" + } + } + }, + "get": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "getServer_2", + "summary": "Retrieve an existing server by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "serverId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the server" + } + ], + "responses": { + "400": { + "description": "The application was already deleted." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Server with ID was not found in application with ID." + }, + "200": { + "description": "Retrieve an existing server by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/sa_network_object" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/network_objects/{serverId}/impact_analysis_csv": { + "get": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "exportDependencies", + "summary": "Export Server Impact Analysis to a CSV file.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "serverId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "Server with ID was not found." + }, + "403": { + "description": "You do not have permissions to edit this application." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Export Server Impact Analysis to a CSV file." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/network_objects/{serverId}/members": { + "get": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "getServerMembers", + "summary": "If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "serverId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "Server with ID is not of type group" + }, + "403": { + "description": "No available licenses. Ask your SecureApp administrator for assistance" + }, + "404": { + "description": "Server with ID was not found" + }, + "200": { + "description": "If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/services": { + "get": { + "tags": [ + "Application Services (local)" + ], + "operationId": "getServices_2", + "summary": "Retrieve existing services", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the service" + }, + { + "name": "show_cloned_services", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "400": { + "description": "The application was already deleted." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "404": { + "description": "There are no services with the name NAME." + }, + "200": { + "description": "Retrieve existing services", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServiceListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Services (local)" + ], + "operationId": "addServices_2", + "summary": "Create services", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServiceListDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Service was created." + }, + "200": { + "description": "Services were created." + }, + "400": { + "description": "Can not have application identity in group" + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "There is no application with the specified ID." + } + } + }, + "put": { + "tags": [ + "Application Services (local)" + ], + "operationId": "modifyServices_2", + "summary": "Update services", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServiceListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Services were modified." + }, + "400": { + "description": "Application identity cannot be a member of a group." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "Service with ID <ID> was not found." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/services/{serviceId}": { + "get": { + "tags": [ + "Application Services (local)" + ], + "operationId": "getService_2", + "summary": "Retrieve an existing service by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "serviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the service" + } + ], + "responses": { + "400": { + "description": "The application was already deleted." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "404": { + "description": "Service with ID was not found." + }, + "200": { + "description": "Retrieve an existing service by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/sa_service" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Application Services (local)" + ], + "operationId": "deleteService", + "summary": "Delete service", + "description": "Use force=true to delete a service with decommission.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "serviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the service" + }, + { + "name": "force", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Force delete" + } + ], + "responses": { + "400": { + "description": "Cannot delete a predefined object." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "Service with ID <SERVICE_ID> was not found in application with id <APPLICATION_ID>" + }, + "200": { + "description": "Delete service" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{application_id}/connection_to_application_packs/": { + "get": { + "tags": [ + "Application Packs" + ], + "operationId": "getApplicationPackInstances", + "summary": "Retrieve a list of all connection to application pack by application ID.", + "parameters": [ + { + "name": "application_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of application" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the connection to application pack" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "404": { + "description": "There are no connection to application pack with the NAME in application with ID." + }, + "200": { + "description": "Retrieve a list of all connection to application pack by application ID.", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationPackInstanceListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Packs" + ], + "operationId": "addApplicationPackInstances", + "summary": "Create new connection to application packs", + "parameters": [ + { + "name": "application_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationPackInstanceListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "You cannot add Internet to connection to application pack." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "Tag with NAME was not found." + }, + "200": { + "description": "Create new connection to application packs" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{application_id}/connection_to_application_packs/{connection_to_application_pack_id}": { + "get": { + "tags": [ + "Application Packs" + ], + "operationId": "getApplicationPackInstance", + "summary": "Retrieve an existing connection to application pack by ID.", + "parameters": [ + { + "name": "application_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of application" + }, + { + "name": "connection_to_application_pack_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection to application pack" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "404": { + "description": "There is no connection to application pack with the specified ID." + }, + "400": { + "description": "Application with ID doesn't own a connection to application pack with ID." + }, + "200": { + "description": "Retrieve an existing connection to application pack by ID.", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationPackInstanceDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Application Packs" + ], + "operationId": "modifyApplicationPackInstance", + "summary": "Update an application pack", + "parameters": [ + { + "name": "application_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of application" + }, + { + "name": "connection_to_application_pack_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection to application pack to update" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationPackInstanceDTO" + } + } + } + }, + "responses": { + "400": { + "description": "You cannot add Internet to connection to application pack." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "200": { + "description": "Update an application pack" + } + } + }, + "delete": { + "tags": [ + "Application Packs" + ], + "operationId": "deleteApplicationPackInstance", + "summary": "Delete a connection to application pack", + "parameters": [ + { + "name": "application_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of application" + }, + { + "name": "connection_to_application_pack_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection to application pack to delete" + } + ], + "responses": { + "400": { + "description": "The connection to application pack was already deleted." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "200": { + "description": "Delete a connection to application pack" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{application_id}/connections/{connection_id}/repair": { + "post": { + "tags": [ + "Application Connections" + ], + "operationId": "repairConnection", + "summary": "Create a ticket to repair a connection", + "parameters": [ + { + "name": "application_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The application ID" + }, + { + "name": "connection_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The connection ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Ticket was created." + }, + "400": { + "description": "You cannot change the value of a field because it is read-only." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection with ID was not found for application with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{application_id}/history/export_pdf": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "exportApplicationHistory", + "summary": "Export application history to PDF", + "parameters": [ + { + "name": "application_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "start_date", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "States starting date to fetch history since. Date format expected: yyyy-mm-dd" + }, + { + "name": "end_date", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Get history until this date. Date format expected: yyyy-mm-dd" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "History max rows" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "400": { + "description": "Start date must be before End date" + }, + "200": { + "description": "Export application history to PDF" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{application_id}/impact_analysis_csv": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "exportImpactAnalysisToCsv", + "summary": "Export Impact Analysis to a CSV file.", + "description": "To prevent a CSV injection attack when exporting Impact Analysis to a CSV file, if a special character ( = - + @ ) appears at the beginning of any field, a single quote (') is added before the character.", + "parameters": [ + { + "name": "application_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "responses": { + "403": { + "description": "You do not have permissions to edit this application." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Export Impact Analysis to a CSV file." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{application_id}/move_server": { + "post": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "moveServer", + "summary": "Move server", + "parameters": [ + { + "name": "application_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "server_id", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the server" + }, + { + "name": "target_application_id", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the target application" + } + ], + "responses": { + "400": { + "description": "Group/Server cannot be moved because it or at least one of its group members is used in these connections with another external resource: CONNECTION_NAME" + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Move server" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/customers/{customer_id}/application_packs/": { + "get": { + "tags": [ + "Application Packs" + ], + "operationId": "getApplicationPacks", + "summary": "List all application packs", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of customer" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the application pack" + } + ], + "responses": { + "403": { + "description": "Access is denied" + }, + "404": { + "description": "There are no application packs with the NAME in customer with ID." + }, + "200": { + "description": "List all application packs", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationPackListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Packs" + ], + "operationId": "addApplicationPacks", + "summary": "Create new application packs", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of customer" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationPackListDTO" + } + } + } + }, + "responses": { + "403": { + "description": "You do not have permission to access application that contains the interface ID" + }, + "400": { + "description": "Customer NAME was decommissioned." + }, + "404": { + "description": "Customer with ID was not found." + }, + "200": { + "description": "Create new application packs" + } + } + }, + "put": { + "tags": [ + "Application Packs" + ], + "operationId": "modifyApplicationPacks", + "summary": "Update application packs", + "description": "Update the application packs properties. If is_published is set to true, the application pack is published for use by other users.", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of customer" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationPackListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Application pack with ID is not ready for publish, or has no changes from the last publish." + }, + "403": { + "description": "You do not have permissions to change the editors and viewers of application pack ID." + }, + "404": { + "description": "There are no application packs with the NAME in customer with ID." + }, + "200": { + "description": "Update application packs" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/customers/{customer_id}/application_packs/{application_pack_id}": { + "get": { + "tags": [ + "Application Packs" + ], + "operationId": "getApplicationPack", + "summary": "Retrieve an existing application pack by ID", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of customer" + }, + { + "name": "application_pack_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application pack to retrieve" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application pack with ID" + }, + "404": { + "description": "Application pack with ID was not found for customer with ID." + }, + "200": { + "description": "Retrieve an existing application pack by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationPackDTO" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Application Packs" + ], + "operationId": "deleteApplicationPack", + "summary": "Delete application pack", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of customer" + }, + { + "name": "application_pack_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application pack to change" + } + ], + "responses": { + "200": { + "description": "Application pack wes deleted." + }, + "403": { + "description": "You do not have permissions to delete this application pack." + }, + "400": { + "description": "Application Pack ID cannot be deleted. It is in use by applications IDs." + } + } + }, + "put": { + "tags": [ + "Application Packs" + ], + "operationId": "modifyApplicationPack", + "summary": "Update an application pack", + "description": "Update the application pack properties. If is_published is set to true, the application pack is published for use by other users.", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of customer" + }, + { + "name": "application_pack_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application pack to change" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationPackDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Application pack with ID is not ready for publish, or has no changes from the last publish." + }, + "403": { + "description": "You do not have permissions to change the editors and viewers of application pack ID." + }, + "404": { + "description": "There are no application packs with the NAME in customer with ID." + }, + "200": { + "description": "Update an application pack" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/customers/{customer_id}/application_packs/{application_pack_id}/application_interfaces": { + "put": { + "tags": [ + "Application Packs" + ], + "operationId": "updateInterfaceTagMapping", + "summary": "Update application interfaces and tag mapping", + "description": "Add application interfaces to application pack, and map a tag to the application interface. If a tag is not specified for the interface, the tag will be set to \"No Tag\".", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of customer" + }, + { + "name": "application_pack_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application pack to change" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/InterfaceTagMappingListDTO" + } + } + } + }, + "responses": { + "403": { + "description": "You do not have permission to access application that contains the interface ID" + }, + "404": { + "description": "There are no application packs with the NAME in customer with ID." + }, + "400": { + "description": "Empty interface ID is not valid." + }, + "200": { + "description": "Update application interfaces and tag mapping" + } + } + }, + "delete": { + "tags": [ + "Application Packs" + ], + "operationId": "removeApplicationInterface", + "summary": "Remove application interfaces from application pack", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of customer" + }, + { + "name": "application_pack_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application pack to change" + }, + { + "name": "application_interface_id", + "in": "query", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "IDs of application interfaces to remove" + } + ], + "responses": { + "200": { + "description": "Application Interface was deleted." + }, + "403": { + "description": "You do not have permissions to edit this application pack." + }, + "404": { + "description": "Application interface ID was not found in application pack ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/customers/{customer_id}/application_packs/{application_pack_id}/tags": { + "put": { + "tags": [ + "Application Packs" + ], + "operationId": "modifyTags", + "summary": "Modify tags of an application pack", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of customer" + }, + { + "name": "application_pack_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application pack to change" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TagListDTO" + } + } + } + }, + "responses": { + "403": { + "description": "You do not have permissions to edit this application pack." + }, + "404": { + "description": "There is no application pack with the ID in customer with ID." + }, + "400": { + "description": "Updated Tag ID doesn't exist on application pack ID." + }, + "200": { + "description": "Modify tags of an application pack" + } + } + }, + "delete": { + "tags": [ + "Application Packs" + ], + "operationId": "removeTags", + "summary": "Delete tags from application pack", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of customer" + }, + { + "name": "application_pack_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application pack to change" + }, + { + "name": "tag_id", + "in": "query", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "IDs of tags to remove" + } + ], + "responses": { + "200": { + "description": "Tags were deleted." + }, + "403": { + "description": "You do not have permissions to edit this application pack." + }, + "404": { + "description": "Removed tag ID can't be empty." + } + } + }, + "get": { + "tags": [ + "Application Packs" + ], + "operationId": "getTags", + "summary": "List all application pack tags", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of customer" + }, + { + "name": "application_pack_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application pack" + } + ], + "responses": { + "403": { + "description": "Access is denied" + }, + "404": { + "description": "There is no application pack with the ID." + }, + "200": { + "description": "List all application pack tags", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TagListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Packs" + ], + "operationId": "createTags", + "summary": "Create new Tag under an application pack ", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of customer" + }, + { + "name": "application_pack_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application pack" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TagListDTO" + } + } + } + }, + "responses": { + "403": { + "description": "Access is denied" + }, + "404": { + "description": "There is no application pack with the ID in customer with ID." + }, + "400": { + "description": "Tag with NAME already exists in application pack ID." + }, + "200": { + "description": "Create new Tag under an application pack " + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/customers/{customer_id}/application_packs/{application_pack_id}/tags/{tag_id}": { + "get": { + "tags": [ + "Application Packs" + ], + "operationId": "getTag", + "summary": "Get tag by ID", + "parameters": [ + { + "name": "customer_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of customer" + }, + { + "name": "application_pack_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application pack" + }, + { + "name": "tag_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of a tag" + } + ], + "responses": { + "403": { + "description": "Access is denied" + }, + "404": { + "description": "Application Pack with ID doesn't own a tag with ID." + }, + "200": { + "description": "Get tag by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TagDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/import_applications/download_template": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "downloadEmptyExcel", + "summary": "Download a Microsoft Excel spreadsheet from your SecureApp server where you can enter the details of your servers, server groups, and connections", + "responses": { + "400": { + "description": "Cannot create import application excel" + }, + "403": { + "description": "Access is denied" + }, + "200": { + "description": "Download a Microsoft Excel spreadsheet from your SecureApp server where you can enter the details of your servers, server groups, and connections" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/import_applications/upload": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "openUploadForm", + "summary": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections", + "responses": { + "400": { + "description": "Failed to create upload form." + }, + "403": { + "description": "Access is denied" + }, + "200": { + "description": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections" + } + } + }, + "post": { + "tags": [ + "Applications" + ], + "operationId": "uploadExcel", + "summary": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections", + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + } + }, + "responses": { + "400": { + "description": "Failed to create upload form." + }, + "403": { + "description": "Access is denied" + }, + "200": { + "description": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/network_objects": { + "get": { + "tags": [ + "Application Servers (across all applications)" + ], + "operationId": "getServers", + "summary": "Fetches servers", + "parameters": [ + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the servers" + }, + { + "name": "ip", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The ip of the servers" + }, + { + "name": "show_cloned_servers", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "400": { + "description": "Parameter typeOnDevice is not valid." + }, + "403": { + "description": "Access is denied" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There are no servers with the typeOnDevice TYPEONDEVICE " + }, + "200": { + "description": "Fetches servers", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/NetworkObjectListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/network_objects/{serverId}": { + "get": { + "tags": [ + "Application Servers (across all applications)" + ], + "operationId": "getServer", + "summary": "Fetches server by ID", + "parameters": [ + { + "name": "serverId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the server" + }, + { + "name": "show_cloned_servers", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "400": { + "description": "The application was already deleted." + }, + "403": { + "description": "You do not have permission to access application that contains the server ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "200": { + "description": "Fetches server by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/sa_network_object" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/server_lookup": { + "get": { + "tags": [ + "Application Servers (across all applications)" + ], + "operationId": "serverLookup", + "summary": "Server Lookup", + "description": "Default value is text=ANY", + "parameters": [ + { + "name": "parameter", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "Server Lookup search parameter" + }, + { + "name": "text", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Search by text location" + }, + { + "name": "subnet", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Search by traffic type" + }, + { + "name": "exact_match", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Search text by exact match" + }, + { + "name": "application_id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The application ID" + } + ], + "responses": { + "400": { + "description": "The ip=|INPUT| should be in the correct form" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "Access is denied" + }, + "200": { + "description": "Server Lookup", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/NetworkObjectListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/services": { + "get": { + "tags": [ + "Application Services (global)" + ], + "operationId": "getServices", + "summary": "Fetches services", + "parameters": [ + { + "name": "globals_only", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "get only globals" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the service" + }, + { + "name": "show_cloned_services", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "404": { + "description": "There are no services with the name NAME." + }, + "403": { + "description": "Access is denied." + }, + "200": { + "description": "Fetches services", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServiceListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Services (global)" + ], + "operationId": "addServices", + "summary": "Create global services", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServiceListDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Service was created." + }, + "200": { + "description": "Services were created." + }, + "400": { + "description": "Application identity cannot be a member of a group." + }, + "404": { + "description": "Service with ID <ID> was not found." + }, + "403": { + "description": "Access is denied." + } + } + }, + "delete": { + "tags": [ + "Application Services (global)" + ], + "operationId": "deleteUnusedNonPredefinedServiceByName", + "summary": "Delete unused and non predefined global service by name", + "parameters": [ + { + "name": "name", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the service" + } + ], + "responses": { + "200": { + "description": "Service was deleted." + }, + "404": { + "description": "There are no services with the name NAME." + }, + "400": { + "description": "Cannot delete a predefined object." + }, + "403": { + "description": "Access is denied." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/services/": { + "put": { + "tags": [ + "Application Services (global)" + ], + "operationId": "modifyServices", + "summary": "Modify unused and non predefined global services", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServiceListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Services were modified." + }, + "400": { + "description": "Application identity cannot be a member of a group." + }, + "404": { + "description": "Service with ID <ID> was not found." + }, + "403": { + "description": "Access is denied." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/services/{serviceId}": { + "get": { + "tags": [ + "Application Services (global)" + ], + "operationId": "getService", + "summary": "Fetches service by ID", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the service" + } + ], + "responses": { + "404": { + "description": "Service with ID <ID> was not found." + }, + "403": { + "description": "Access is denied." + }, + "200": { + "description": "Fetches service by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/sa_service" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Application Services (global)" + ], + "operationId": "deleteUnusedNonPredefinedService", + "summary": "Delete unused and non predefined global service", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the service" + } + ], + "responses": { + "200": { + "description": "Service was deleted." + }, + "404": { + "description": "Global Service with ID was not found." + }, + "400": { + "description": "You cannot delete a predefined object." + }, + "403": { + "description": "Access is denied." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/users": { + "get": { + "tags": [ + "Application Users" + ], + "operationId": "getUsers", + "summary": "Fetches users", + "parameters": [ + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the user" + } + ], + "responses": { + "404": { + "description": "There are no users with the name NAME." + }, + "403": { + "description": "Access is denied." + }, + "200": { + "description": "Fetches users", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/UserObjectListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Users" + ], + "operationId": "addUsers", + "summary": "Create users", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/UserObjectListDTO" + } + } + } + }, + "responses": { + "201": { + "description": "User was created." + }, + "200": { + "description": "Users were created." + }, + "400": { + "description": "Invalid ip" + }, + "404": { + "description": "User with id <ID> was not found." + }, + "403": { + "description": "Access is denied." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/users/{userId}": { + "delete": { + "tags": [ + "Application Users" + ], + "operationId": "deleteUnusedUser", + "summary": "Delete unused user", + "parameters": [ + { + "name": "userId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the user" + } + ], + "responses": { + "200": { + "description": "User was deleted." + }, + "404": { + "description": "User with ID <ID> was not found." + }, + "400": { + "description": "Cannot delete an object that is being referenced by other objects." + }, + "403": { + "description": "Access is denied." + } + } + }, + "get": { + "tags": [ + "Application Users" + ], + "operationId": "getUser", + "summary": "Fetches user by ID", + "parameters": [ + { + "name": "userId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the user" + } + ], + "responses": { + "404": { + "description": "User with ID <ID> was not found." + }, + "403": { + "description": "Access is denied." + }, + "200": { + "description": "Fetches user by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/userObjectDTO" + } + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/Tufin/SecureApp/OpenAPIs/tufin_secureapp-latest.json b/Tufin/SecureApp/OpenAPIs/tufin_secureapp-latest.json new file mode 100644 index 0000000..af42c32 --- /dev/null +++ b/Tufin/SecureApp/OpenAPIs/tufin_secureapp-latest.json @@ -0,0 +1,4425 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Tufin SecureApp", + "description": "Tufin SecureApp application connectivity and application-centric policy management REST API.", + "version": "latest", + "x-vendor-api-version": "25.2", + "x-itential-curated": "Trimmed to 56 of 104 upstream operations covering application CRUD, application connection CRUD (including repair), application interfaces, per-application servers, and local/global application services. See the repo README for the full scope and the full spec." + }, + "servers": [ + { + "url": "https://{host}/securechangeworkflow/api", + "variables": { + "host": { + "default": "tufin.example.com" + } + } + } + ], + "security": [ + { + "basicAuth": [] + } + ], + "components": { + "securitySchemes": { + "basicAuth": { + "type": "http", + "scheme": "basic" + } + }, + "schemas": { + "DomainDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the domain" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the domain" + }, + "description": { + "type": "string", + "description": "The description of the domain" + } + }, + "required": [ + "name", + "id", + "description" + ] + }, + "TicketExternalDataDTO": { + "type": "object", + "properties": { + "request_id": { + "type": "string", + "description": "The request ID" + }, + "requester": { + "type": "string", + "description": "The requester" + } + } + }, + "ConnectionFullResourcesListDTO": { + "type": "object", + "properties": { + "connection_extended": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionFullResourcesDTO" + }, + "description": "List of connections" + } + } + }, + "RoleDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the role" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the role" + }, + "role_link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "description": { + "type": "string", + "description": "The description of the role" + } + }, + "required": [ + "name", + "id" + ] + }, + "TicketDTO": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "The priority of the request" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the ticket" + }, + "status": { + "type": "string", + "description": "The status of the ticket" + }, + "application_details": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "comments": { + "$ref": "#/components/schemas/TicketCommentListDTO" + }, + "expiration_date": { + "type": "string", + "description": "Request is valid until this date" + }, + "subject": { + "type": "string", + "description": "The subject of the ticket" + }, + "referenced_ticket": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "requester": { + "type": "string", + "description": "The name of the requester" + }, + "create_date": { + "type": "string", + "format": "date-time", + "description": "The ticket creation date" + }, + "update_date": { + "type": "string", + "format": "date-time", + "description": "The ticket last update date" + }, + "close_date": { + "type": "string", + "format": "date-time", + "description": "The ticket close date" + }, + "notification_group": { + "$ref": "#/components/schemas/group" + }, + "sla_status": { + "type": "string", + "description": "The Tickets current SLA status" + }, + "sla_outcome": { + "type": "string", + "description": "The outcome of the SLA" + }, + "sla_tracking_state": { + "type": "string", + "description": "The Tickets current SLA tracking state" + }, + "steps": { + "$ref": "#/components/schemas/TicketStagesListDTO" + }, + "business_duration": { + "type": "integer", + "format": "int64", + "description": "The ticket business duration" + }, + "expiration_field_name": { + "type": "string", + "description": "The Request is required until" + }, + "expiration_status": { + "$ref": "#/components/schemas/ExpirationStatusDTO" + }, + "external_data": { + "$ref": "#/components/schemas/TicketExternalDataDTO" + }, + "current_step": { + "$ref": "#/components/schemas/TicketCurrentStageReferenceDTO" + }, + "workflow": { + "$ref": "#/components/schemas/WorkflowReferenceDTO" + }, + "domain_name": { + "type": "string", + "description": "The domain in which the ticket is posted" + }, + "requester_id": { + "type": "integer", + "format": "int64", + "description": "The user id which the ticket is created on behalf of (used for 'on-behalf' feature)" + }, + "application_changes": { + "$ref": "#/components/schemas/TicketApplicationChangeListDTO" + }, + "completion_details": { + "$ref": "#/components/schemas/CompletionDetailsDTO" + } + }, + "required": [ + "priority", + "subject", + "workflow", + "domain_name" + ] + }, + "sa_network_object": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the network object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "TicketStageDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The step name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The step ID" + }, + "tasks": { + "$ref": "#/components/schemas/TicketTaskListDTO" + }, + "skipped": { + "type": "boolean", + "description": "whether the task was skipped" + }, + "redone": { + "type": "boolean", + "description": "whether the task was redone" + }, + "business_duration": { + "type": "integer", + "format": "int64", + "description": "The step business duration" + } + }, + "required": [ + "tasks" + ] + }, + "CompletionDetailsDTO": { + "type": "object", + "properties": { + "stepId": { + "type": "integer", + "format": "int64", + "description": "The completion step id " + } + } + }, + "PartyDTOType": { + "type": "object" + }, + "ObjectReferenceUIDDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the referenced object" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + } + } + }, + "MembersListDTO": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartyDTO" + }, + "description": "The list of members" + }, + "partial_list": { + "type": "boolean", + "description": "Partial list; true if only a partial list is returned" + } + } + }, + "ObjectReferenceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the referenced object" + }, + "id": { + "type": "string", + "description": "ID" + }, + "type": { + "type": "string", + "description": "The type of the referenced object" + }, + "display_name": { + "type": "string", + "description": "The display name of the referenced object" + }, + "management_domain": { + "type": "string", + "description": "The management domain from which the referenced object comes from" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the referenced object" + }, + "ip": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FQDNIpDTO" + } + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of references to a DM_INLINE group members" + } + }, + "required": [ + "id" + ] + }, + "sa_service": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the service" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "TicketStagesListDTO": { + "type": "object", + "properties": { + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketStageDTO" + }, + "description": "The list of steps" + } + }, + "required": [ + "step" + ] + }, + "LinkDTO": { + "type": "object", + "properties": { + "@href": { + "type": "string", + "description": "The location of the referenced object" + } + }, + "required": [ + "@href" + ] + }, + "TicketApplicationChangeListDTO": { + "type": "object", + "properties": { + "application_change": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketApplicationChangeDTO" + }, + "description": "The application changes list" + } + }, + "required": [ + "application_change" + ] + }, + "TicketCommentDTO": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "ExpirationStatusDTO": { + "type": "object" + }, + "FQDNIpDTO": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "ipType": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "subnetMask": { + "type": "string" + } + } + }, + "ConnectionFullResourcesDTO": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of source's objects" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of destination's objects" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_service" + }, + "description": "List of service's objects" + }, + "status": { + "type": "string", + "description": "The status" + }, + "external": { + "type": "boolean", + "description": "is external" + }, + "connection_to_application": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "uid": { + "type": "string", + "description": "The UID" + }, + "applicationId": { + "type": "string" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The opened tickets" + } + }, + "required": [ + "name" + ] + }, + "TicketCommentListDTO": { + "type": "object", + "properties": { + "comment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketCommentDTO" + }, + "description": "The comment" + } + } + }, + "TicketTaskFieldDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "ApplicationConnectionListDTO": { + "type": "object", + "properties": { + "connection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionDTO" + } + } + } + }, + "ConnectionDTO": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of source's objects ref" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of destination's objects ref" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of service's objects ref" + }, + "status": { + "type": "string", + "description": "The status" + }, + "external": { + "type": "boolean", + "description": "is external" + }, + "connection_to_application": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "uid": { + "type": "string", + "description": "The UID" + }, + "applicationId": { + "type": "string" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The opened tickets" + } + }, + "required": [ + "name" + ] + }, + "UnlicensedDevicesForAutomationDTO": { + "type": "object", + "properties": { + "unlicensed_device_for_automation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "unlicensed devices for automation" + } + } + }, + "PermissionDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the permission" + }, + "value": { + "type": "boolean", + "description": "The permission setting" + }, + "key": { + "type": "string", + "description": "The Enum that represents the permission" + } + }, + "required": [ + "name", + "value" + ] + }, + "TicketCurrentStageReferenceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The current step name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The current step id" + } + } + }, + "RolesListDTO": { + "type": "object", + "properties": { + "role": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RoleDTO" + }, + "description": "The list of roles of the user" + } + }, + "required": [ + "role" + ] + }, + "TicketTaskListDTO": { + "type": "object", + "properties": { + "task": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketTaskDTO" + }, + "description": "The list of tasks" + } + }, + "required": [ + "task" + ] + }, + "MembersOfListDTO": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartyDTO" + }, + "description": "The group to which the user belongs" + } + } + }, + "SecurityPolicyViolationSeverity": { + "type": "object" + }, + "WorkflowReferenceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The workflow name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The workflow ID" + }, + "uses_topology": { + "type": "boolean", + "description": "When the value is true, the Access Request tools in the workflow use Topology. When the value is false, the Access Request tools in the workflow do not use Topology." + } + }, + "required": [ + "name" + ] + }, + "PartyDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the user" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyDTOType" + }, + "display_name": { + "type": "string", + "description": "The display name of the user" + }, + "email": { + "type": "string", + "description": "The email of the user" + }, + "ldapDn": { + "type": "string", + "description": "The LDAP DN of the user" + }, + "ldap_configuration": { + "$ref": "#/components/schemas/LdapConfigurationDTO" + }, + "roles": { + "$ref": "#/components/schemas/RolesListDTO" + }, + "authentication_method": { + "type": "string", + "description": "The method of authentication for the user" + }, + "origin_type": { + "type": "string", + "description": "The origin type of the user, 'Local' is available to GET only" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member_of": { + "$ref": "#/components/schemas/MembersOfListDTO" + }, + "domains": { + "$ref": "#/components/schemas/DomainsListDTO" + } + }, + "required": [ + "name" + ] + }, + "DomainsListDTO": { + "type": "object", + "properties": { + "domain": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DomainDTO" + }, + "description": "The list of domains" + } + }, + "required": [ + "domain" + ] + }, + "TicketApplicationChangeDTO": { + "type": "object" + }, + "CommentOriginDTO": { + "type": "object" + }, + "UUID": { + "type": "object" + }, + "GroupPermissionDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the permission" + }, + "value": { + "type": "boolean", + "description": "The permission setting" + } + } + }, + "group": { + "type": "object", + "properties": { + "members": { + "$ref": "#/components/schemas/MembersListDTO" + }, + "groupPermissions": { + "$ref": "#/components/schemas/GroupPermissionsListDTO" + }, + "description": { + "type": "string", + "description": "Description of the group" + }, + "name": { + "type": "string", + "description": "The name of the user" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyDTOType" + }, + "display_name": { + "type": "string", + "description": "The display name of the user" + }, + "email": { + "type": "string", + "description": "The email of the user" + }, + "ldapDn": { + "type": "string", + "description": "The LDAP DN of the user" + }, + "ldap_configuration": { + "$ref": "#/components/schemas/LdapConfigurationDTO" + }, + "roles": { + "$ref": "#/components/schemas/RolesListDTO" + }, + "authentication_method": { + "type": "string", + "description": "The method of authentication for the user" + }, + "origin_type": { + "type": "string", + "description": "The origin type of the user, 'Local' is available to GET only" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member_of": { + "$ref": "#/components/schemas/MembersOfListDTO" + }, + "domains": { + "$ref": "#/components/schemas/DomainsListDTO" + } + }, + "required": [ + "name" + ] + }, + "TicketTaskDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The task name" + }, + "fields": { + "$ref": "#/components/schemas/TicketTaskFieldListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task ID" + }, + "status": { + "type": "string", + "description": "The task status" + }, + "unlicensed_devices_for_automation": { + "$ref": "#/components/schemas/UnlicensedDevicesForAutomationDTO" + }, + "pending_reason": { + "type": "string", + "description": "The task pending reason" + }, + "assignee_id": { + "type": "integer", + "format": "int64", + "description": "The assignee ID" + }, + "task_business_duration": { + "type": "integer", + "format": "int64", + "description": "The task business duration" + }, + "assignee": { + "type": "string", + "description": "The task assignee" + }, + "is_assigner": { + "type": "boolean", + "description": "Indicates whether the handler is the assigner" + }, + "assignee_participant_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the participant the assignee is based on" + }, + "pending_reason_description": { + "type": "string", + "description": "The task pending reason description" + }, + "potential_handlers": { + "$ref": "#/components/schemas/PartyListDTO" + } + }, + "required": [ + "fields", + "id", + "status", + "assignee" + ] + }, + "PermissionListDTO": { + "type": "object", + "properties": { + "permission": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PermissionDTO" + }, + "description": "The list of permissions" + } + }, + "required": [ + "permission" + ] + }, + "PartyListDTO": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartyDTO" + }, + "description": "The list of users" + } + }, + "required": [ + "user" + ] + }, + "TicketTaskFieldListDTO": { + "type": "object", + "properties": { + "field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketTaskFieldDTO" + }, + "description": "The field parameter" + } + }, + "required": [ + "field" + ] + }, + "GroupPermissionsListDTO": { + "type": "object", + "properties": { + "groupPermission": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GroupPermissionDTO" + }, + "description": "The list of permissions for this group" + } + } + }, + "LdapConfigurationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the LDAP server" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the LDAP server" + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port of the LDAP server" + }, + "server": { + "type": "string", + "description": "The server (host) of the LDAP server" + }, + "trust_any_certificate": { + "type": "boolean", + "description": "Should the LDAP server trust any certificate" + }, + "ldap_vendor": { + "type": "string", + "description": "The vendor of the LDAP server" + }, + "base_dn": { + "type": "string", + "description": "The base dn of the LDAP server" + }, + "user_dn": { + "type": "string", + "description": "The user dn of the LDAP server" + }, + "connect_using_ssl": { + "type": "boolean", + "description": "Should the LDAP server connect using SSL" + }, + "connect_timeout": { + "type": "integer", + "format": "int32", + "description": "The timeout for connecting the LDAP server" + } + }, + "required": [ + "name", + "id", + "port", + "server", + "trust_any_certificate", + "ldap_vendor", + "base_dn", + "user_dn", + "connect_using_ssl", + "connect_timeout" + ] + }, + "ApplicationInterfaceListDTO": { + "type": "object", + "properties": { + "application_interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInterfaceDTO" + }, + "description": "List of application interfaces" + } + } + }, + "ApplicationInterfaceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application interface" + }, + "id": { + "type": "string", + "description": "The ID of the application interface" + }, + "comment": { + "type": "string", + "description": "The comment of the application interface" + }, + "uid": { + "type": "string", + "description": "The uid of the application interface" + }, + "application_id": { + "type": "string", + "description": "The application ID of the application interface" + }, + "interface_connections": { + "$ref": "#/components/schemas/ConnectionInterfaceListDTO" + }, + "is_published": { + "type": "boolean", + "description": "The current is_published status" + } + }, + "required": [ + "name" + ] + }, + "ConnectionListDTO": { + "type": "object", + "properties": { + "connection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionDTO" + }, + "description": "List of connections" + } + } + }, + "ConnectionInterfaceDTO": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of source's objects ref" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of destination's objects ref" + }, + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The servers in the interface connection that connected to the interface" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of service's objects ref" + }, + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "uid": { + "type": "string", + "description": "The UID" + }, + "applicationId": { + "type": "string" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The opened tickets" + } + }, + "required": [ + "name" + ] + }, + "ApplicationInterfaceInstanceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the connection to application" + }, + "id": { + "type": "string", + "description": "The ID of the connection to application" + }, + "comment": { + "type": "string", + "description": "The comment of the connection to application" + }, + "uid": { + "type": "string", + "description": "The Uid of the connection to application" + }, + "application_id": { + "type": "string", + "description": "The application ID of the connection to application" + }, + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The servers of the connection to application that connected to the application interface" + }, + "connections": { + "$ref": "#/components/schemas/ConnectionListDTO" + }, + "application_interface_id": { + "type": "string", + "description": "The application interface ID of the connection to application" + } + }, + "required": [ + "name" + ] + }, + "ConnectionInterfaceListDTO": { + "type": "object", + "properties": { + "interface_connection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionInterfaceDTO" + }, + "description": "List of interface connections" + } + } + }, + "ApplicationInterfaceInstanceListDTO": { + "type": "object", + "properties": { + "connection_to_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInterfaceInstanceDTO" + }, + "description": "List of connections to application" + } + } + }, + "NetworkObjectListDTO": { + "type": "object", + "properties": { + "network_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of network objects" + } + }, + "required": [ + "network_object" + ] + }, + "ServiceListDTO": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_service" + }, + "description": "List of services" + } + } + }, + "sa_application": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application" + }, + "id": { + "type": "string", + "description": "The ID of the application" + }, + "owner": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "comment": { + "type": "string", + "description": "The comment of the application" + }, + "status": { + "type": "string", + "description": "The status of the application" + }, + "vendor": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The vendors that are associated with servers contained in the application" + }, + "customer": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "connection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The connections of the application" + }, + "connection_to_application_pack": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The connections to application pack of the application" + }, + "decommissioned": { + "type": "boolean", + "description": "Is the application decommissioned" + }, + "editors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The editors of the application" + }, + "viewers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The viewers of the application" + }, + "openTickets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The open tickets of the application" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date the application was created" + }, + "modified": { + "type": "string", + "format": "date-time", + "description": "The date the last change was made" + } + }, + "required": [ + "name", + "id", + "owner" + ] + }, + "SASecurityPolicyViolationDTO": { + "type": "object", + "properties": { + "security_policy_violation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SAViolationDTO" + } + } + } + }, + "HistoryListDTO": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the specific list of history records, by the current filter" + }, + "total": { + "type": "integer", + "format": "int32", + "description": "The total number of the records in the history" + }, + "history_record": { + "type": "array", + "items": { + "$ref": "#/components/schemas/HistoryDTO" + }, + "description": "List of history records" + } + } + }, + "SAViolationDTO": { + "type": "object", + "properties": { + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "HistoryDetailsDTO": { + "type": "object" + }, + "ApplicationToDomainListDTO": { + "type": "object", + "properties": { + "move_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationToDomainDTO" + }, + "description": "List of customers and applications to move" + } + } + }, + "HistoryDTO": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "The date the change was made" + }, + "object_name": { + "type": "string", + "description": "new server name - for request to access application with group" + }, + "user": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "type": { + "type": "string", + "description": "Either a group, network object or subnet" + }, + "modified_object": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "change_description": { + "type": "string", + "description": "Description of the change made" + }, + "change_details": { + "$ref": "#/components/schemas/HistoryDetailsDTO" + } + } + }, + "ComplianceResultListDTO": { + "type": "object", + "properties": { + "compliance_violations_result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ComplianceResultDTO" + }, + "description": "compliance violations results" + } + } + }, + "ApplicationToDomainDTO": { + "type": "object", + "properties": { + "customer": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "application": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + }, + "ComplianceResultDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "cannot compute risk reason" + }, + "status": { + "type": "string", + "description": "risk status" + }, + "security_policy_violations": { + "$ref": "#/components/schemas/SASecurityPolicyViolationDTO" + }, + "connection": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + }, + "ApplicationListDTO": { + "type": "object", + "properties": { + "application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_application" + }, + "description": "The list of applications and their details" + } + } + }, + "attachment": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + } + } + }, + "paths": { + "/securechangeworkflow/api/secureapp/repository/applications/": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "getApplications", + "summary": "List all applications", + "parameters": [ + { + "name": "userId", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Applications by user ID, if not given the default is logged in user id" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the application" + }, + { + "name": "app_permissions", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Filter applications by the given permissions (separated with commas):\napp_owner - returns applications where the user is the owner\napp_editor - returns applications where the user has been explicitly added as an editor\napp_viewer - returns applications where the user has been explicitly added as a viewer\napp_adminonly - returns applications where the user only has editor access because user has \"edit all applications\" permission, and does not include applications where this user is either the app_owner, app_editor, or app_viewer" + } + ], + "responses": { + "400": { + "description": "Invalid app_permissions value: 'appPermissions'." + }, + "403": { + "description": "You can't use the parameter 'userId' because you don't have 'View all applications' permission." + }, + "404": { + "description": "User with ID 'userId' was not found." + }, + "200": { + "description": "List all applications", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Applications" + ], + "operationId": "addApplications", + "summary": "Create new applications", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "There is an editor without an ID or name." + }, + "403": { + "description": "Access is denied" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no editor with the name NAME." + }, + "200": { + "description": "Create new applications" + } + } + }, + "put": { + "tags": [ + "Applications" + ], + "operationId": "modifyApplications", + "summary": "Update applications", + "description": "This API can be used to delete or decommission an application.\nTo decommission an application, send true in decommissioned tag.", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "User cannot be both an editor and a viewer of the application." + }, + "403": { + "description": "You do not have permissions to decommission this application." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Update applications" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/move_applications": { + "put": { + "tags": [ + "Applications" + ], + "operationId": "moveApplications", + "summary": "Move applications to another customer", + "requestBody": { + "required": false, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationToDomainListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Applications were moved successfully." + }, + "400": { + "description": "There are no applications to move." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "getApplication", + "summary": "Retrieve an existing application by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application to retrieve" + } + ], + "responses": { + "400": { + "description": "The application was already deleted." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Retrieve an existing application by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/sa_application" + } + } + } + } + } + }, + "put": { + "tags": [ + "Applications" + ], + "operationId": "modifyApplication", + "summary": "Change an application", + "description": "This API can be used to delete or decommission an application.\nTo decommission an application, send true in decommissioned tag.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of an application to change" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/sa_application" + } + } + } + }, + "responses": { + "400": { + "description": "User cannot be both an editor and a viewer of the application." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Change an application" + } + } + }, + "delete": { + "tags": [ + "Applications" + ], + "operationId": "deleteApplication", + "summary": "Delete an application", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application to delete" + } + ], + "responses": { + "400": { + "description": "You cannot delete application NAME because there are connection changes pending a ticket in other application." + }, + "403": { + "description": "Access is denied" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "200": { + "description": "Delete an application" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/application_interfaces": { + "get": { + "tags": [ + "Application Interfaces" + ], + "operationId": "getApplicationInterfaces", + "summary": "Retrieve existing application interfaces", + "description": "To improve response time, set 'calculateIsPublished = false' to avoid calculating 'is_published'.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the application interface" + }, + { + "name": "calculateIsPublished", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Should calculate is_published value" + } + ], + "responses": { + "400": { + "description": "There is no application with the specified ID." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There are no application interfaces with the name NAME." + }, + "200": { + "description": "Retrieve existing application interfaces", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Interfaces" + ], + "operationId": "addApplicationInterface", + "summary": "Create application interface", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Application interface was created." + }, + "400": { + "description": "You cannot add to application NAME because it was decommissioned." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found for application with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/application_interfaces/{applicationInterfaceId}": { + "get": { + "tags": [ + "Application Interfaces" + ], + "operationId": "getApplicationInterface", + "summary": "Retrieve an existing application interface by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found for application with ID." + }, + "200": { + "description": "Retrieve an existing application interface by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Application Interfaces" + ], + "operationId": "modifyApplicationInterface", + "summary": "Update an application interface", + "description": "Update the application interface properties. If is_published is set to true, the application interface is published for use by other users.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of The application interface" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Application interface was modified." + }, + "400": { + "description": "Name cannot be empty." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found for application with ID." + } + } + }, + "delete": { + "tags": [ + "Application Interfaces" + ], + "operationId": "deleteApplicationInterface", + "summary": "Delete application interface", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + } + ], + "responses": { + "200": { + "description": "Application interface was deleted." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found for application with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/application_interfaces/{applicationInterfaceId}/interface_connections": { + "get": { + "tags": [ + "Application Interfaces" + ], + "operationId": "getConnectionInterfaces", + "summary": "Retrieve existing interface connections", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the interface connection" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found for application with ID." + }, + "200": { + "description": "Retrieve existing interface connections", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionInterfaceListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Interfaces" + ], + "operationId": "addConnectionInterfaces", + "summary": "Create interface connections", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionInterfaceListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Interface connections were created." + }, + "201": { + "description": "Interface connection was created." + }, + "400": { + "description": "Reference to service ID is invalid." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found for application with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/application_interfaces/{applicationInterfaceId}/interface_connections/{connectionInterfaceId}": { + "get": { + "tags": [ + "Application Interfaces" + ], + "operationId": "getConnectionInterface", + "summary": "Retrieve an existing interface connection by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + }, + { + "name": "connectionInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the interface connection" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection interface with ID was not found for application interface with ID." + }, + "200": { + "description": "Retrieve an existing interface connection by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionInterfaceDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Application Interfaces" + ], + "operationId": "modifyConnectionInterface", + "summary": "Update an interface connection", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + }, + { + "name": "connectionInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the interface connection" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionInterfaceDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Interface connection was modified." + }, + "400": { + "description": "Reference to service ID is invalid." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection interface with ID was not found for application interface with ID." + } + } + }, + "delete": { + "tags": [ + "Application Interfaces" + ], + "operationId": "deleteConnectionInterface", + "summary": "Delete interface connection", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "applicationInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application interface" + }, + { + "name": "connectionInterfaceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the interface connection" + } + ], + "responses": { + "200": { + "description": "Interface connection was deleted." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection interface with ID was not found for application interface with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/compliance_violations": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "getSPComplianceViolations", + "summary": "Retrieve security policy violations from SecureTrack", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "Security policy compliance check is not available because a security policy has not been defined." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "503": { + "description": "Timeout occurred while waiting for response from SecureTrack." + }, + "500": { + "description": "An error occurred in SecureTrack when running the security compliance check." + }, + "200": { + "description": "Retrieve security policy violations from SecureTrack", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ComplianceResultListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/connections": { + "get": { + "tags": [ + "Application Connections" + ], + "operationId": "getConnections", + "summary": "Retrieve existing connections", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the connection" + } + ], + "responses": { + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "404": { + "description": "There are no connections with the name NAME." + }, + "200": { + "description": "Retrieve existing connections", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationConnectionListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Connections" + ], + "operationId": "addConnections", + "summary": "Create connections", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationConnectionListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Connections were created." + }, + "201": { + "description": "Connection was created." + }, + "400": { + "description": "Connections can only include objects within the same customer." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + } + } + }, + "put": { + "tags": [ + "Application Connections" + ], + "operationId": "modifyConnections", + "summary": "Update connections", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationConnectionListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Connections were modified." + }, + "400": { + "description": "You cannot modify this connection using the Update connection API function. To modify the connection, use the Update connection to application API function." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "Connection with ID was not found for application with ID." + }, + "406": { + "description": " This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/connections/{connectionId}": { + "get": { + "tags": [ + "Application Connections" + ], + "operationId": "getConnection", + "summary": "Retrieve an existing connection by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "connectionId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection" + } + ], + "responses": { + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "404": { + "description": "Connection with ID was not found for application with ID." + }, + "200": { + "description": "Retrieve an existing connection by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Application Connections" + ], + "operationId": "modifyConnection", + "summary": "Update a connection", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "connectionId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Connection was modified." + }, + "400": { + "description": "You cannot modify this connection using the Update connection API function. To modify the connection, use the Update connection to application API function." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "Connection with ID was not found for application with ID." + } + } + }, + "delete": { + "tags": [ + "Application Connections" + ], + "operationId": "deleteConnection", + "summary": "Delete connection", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "connectionId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection" + } + ], + "responses": { + "200": { + "description": "Connection was deleted." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "Connection with ID was not found for application with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/connections_extended": { + "get": { + "tags": [ + "Application Connections" + ], + "operationId": "getConnectionFullResources", + "summary": "Retrieve existing connections, with extended resources information", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the connection" + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Return results starting only from the specified index; 0-based index; default value = 0" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Return the specified number of results. Returns all results if no value specified" + } + ], + "responses": { + "400": { + "description": "Count value must be greater than 0." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "403": { + "description": "Access is denied." + }, + "404": { + "description": "There are no connections with the name NAME." + }, + "200": { + "description": "Retrieve existing connections, with extended resources information", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ConnectionFullResourcesListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/connections_to_applications": { + "get": { + "tags": [ + "Application Interfaces" + ], + "operationId": "getApplicationInterfaceInstances", + "summary": "Retrieve existing connections to application", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the connection to application" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection interface with ID was not found for application interface with ID." + }, + "200": { + "description": "Retrieve existing connections to application", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceInstanceListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Interfaces" + ], + "operationId": "addApplicationInterfaceInstance", + "summary": "Create connection to application", + "description": "Create a connection from this application to an application interface.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceInstanceDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Connection to application was created." + }, + "400": { + "description": "You cannot add Internet to connection to application." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Application interface with ID was not found." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/connections_to_applications/{connectionToApplicationId}": { + "get": { + "tags": [ + "Application Interfaces" + ], + "operationId": "getApplicationInterfaceInstance", + "summary": "Retrieve an existing connection to application by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "connectionToApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection to application" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection to application with ID was not found for application interface with ID." + }, + "200": { + "description": "Retrieve an existing connection to application by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceInstanceDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Application Interfaces" + ], + "operationId": "modifyApplicationInterfaceInstance", + "summary": "Update a connection to application", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "connectionToApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection to application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ApplicationInterfaceInstanceDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Connection to application was modified." + }, + "400": { + "description": "You cannot add Internet to connection to application." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection to application with ID was not found for application interface with ID." + } + } + }, + "delete": { + "tags": [ + "Application Interfaces" + ], + "operationId": "deleteApplicationInterfaceInstance", + "summary": "Delete connection to application", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "connectionToApplicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the connection to application" + } + ], + "responses": { + "200": { + "description": "Connection to application was deleted." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection to application with ID was not found for application interface with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/history": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "getApplicationHistory", + "summary": "Retrieve application history", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "start_date", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "States starting date to fetch history since. Date format expected: yyyy-mm-dd" + }, + { + "name": "end_date", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Get history until this date. Date format expected: yyyy-mm-dd" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "History list length" + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Offset the count starting point" + }, + { + "name": "type", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "States the history type to fetch" + }, + { + "name": "user", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The username of the user made the changes" + }, + { + "name": "showMembers", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Whether or not to show group members of server/service groups" + } + ], + "responses": { + "400": { + "description": "User not found" + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Retrieve application history", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/HistoryListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/network_objects": { + "get": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "getServers_2", + "summary": "Retrieve existing servers", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the server" + }, + { + "name": "ip", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The ip of the server" + }, + { + "name": "show_cloned_servers", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "400": { + "description": "Parameter typeOnDevice is not valid." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There are no servers with the typeOnDevice TYPEONDEVICE " + }, + "200": { + "description": "Retrieve existing servers", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/NetworkObjectListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "addServers", + "summary": "Create servers", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/NetworkObjectListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "The type_on_device value is not valid " + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Virtual server was not found in SecureTrack." + }, + "503": { + "description": "Not connected to SecureTrack." + }, + "200": { + "description": "Create servers" + } + } + }, + "put": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "modifyServers", + "summary": "Update servers", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/NetworkObjectListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Server with ID was not found in application with ID." + }, + "503": { + "description": "Not connected to SecureTrack." + }, + "200": { + "description": "Update servers" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/network_objects/{serverId}": { + "delete": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "deleteServer", + "summary": "Delete server", + "description": "To decommission a serer use force=true.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "serverId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the server" + }, + { + "name": "force", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Force delete" + } + ], + "responses": { + "400": { + "description": "Cannot delete a predefined object." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Server with ID was not found in application with ID." + }, + "200": { + "description": "Delete server" + } + } + }, + "get": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "getServer_2", + "summary": "Retrieve an existing server by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "serverId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the server" + } + ], + "responses": { + "400": { + "description": "The application was already deleted." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Server with ID was not found in application with ID." + }, + "200": { + "description": "Retrieve an existing server by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/sa_network_object" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/network_objects/{serverId}/impact_analysis_csv": { + "get": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "exportDependencies", + "summary": "Export Server Impact Analysis to a CSV file.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "serverId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "Server with ID was not found." + }, + "403": { + "description": "You do not have permissions to edit this application." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Export Server Impact Analysis to a CSV file." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/network_objects/{serverId}/members": { + "get": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "getServerMembers", + "summary": "If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "serverId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "Server with ID is not of type group" + }, + "403": { + "description": "No available licenses. Ask your SecureApp administrator for assistance" + }, + "404": { + "description": "Server with ID was not found" + }, + "200": { + "description": "If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/services": { + "get": { + "tags": [ + "Application Services (local)" + ], + "operationId": "getServices_2", + "summary": "Retrieve existing services", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the service" + }, + { + "name": "show_cloned_services", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "400": { + "description": "The application was already deleted." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "404": { + "description": "There are no services with the name NAME." + }, + "200": { + "description": "Retrieve existing services", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServiceListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Services (local)" + ], + "operationId": "addServices_2", + "summary": "Create services", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServiceListDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Service was created." + }, + "200": { + "description": "Services were created." + }, + "400": { + "description": "Can not have application identity in group" + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "There is no application with the specified ID." + } + } + }, + "put": { + "tags": [ + "Application Services (local)" + ], + "operationId": "modifyServices_2", + "summary": "Update services", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServiceListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Services were modified." + }, + "400": { + "description": "Application identity cannot be a member of a group." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "Service with ID <ID> was not found." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{applicationId}/services/{serviceId}": { + "get": { + "tags": [ + "Application Services (local)" + ], + "operationId": "getService_2", + "summary": "Retrieve an existing service by ID", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "serviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the service" + } + ], + "responses": { + "400": { + "description": "The application was already deleted." + }, + "403": { + "description": "You do not have permission to access application with ID" + }, + "404": { + "description": "Service with ID was not found." + }, + "200": { + "description": "Retrieve an existing service by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/sa_service" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Application Services (local)" + ], + "operationId": "deleteService", + "summary": "Delete service", + "description": "Use force=true to delete a service with decommission.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "serviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the service" + }, + { + "name": "force", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Force delete" + } + ], + "responses": { + "400": { + "description": "Cannot delete a predefined object." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "404": { + "description": "Service with ID <SERVICE_ID> was not found in application with id <APPLICATION_ID>" + }, + "200": { + "description": "Delete service" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{application_id}/connections/{connection_id}/repair": { + "post": { + "tags": [ + "Application Connections" + ], + "operationId": "repairConnection", + "summary": "Create a ticket to repair a connection", + "parameters": [ + { + "name": "application_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The application ID" + }, + { + "name": "connection_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The connection ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Ticket was created." + }, + "400": { + "description": "You cannot change the value of a field because it is read-only." + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "Connection with ID was not found for application with ID." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{application_id}/history/export_pdf": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "exportApplicationHistory", + "summary": "Export application history to PDF", + "parameters": [ + { + "name": "application_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "start_date", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "States starting date to fetch history since. Date format expected: yyyy-mm-dd" + }, + { + "name": "end_date", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Get history until this date. Date format expected: yyyy-mm-dd" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "History max rows" + } + ], + "responses": { + "403": { + "description": "You do not have permission to access application with ID" + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "400": { + "description": "Start date must be before End date" + }, + "200": { + "description": "Export application history to PDF" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{application_id}/impact_analysis_csv": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "exportImpactAnalysisToCsv", + "summary": "Export Impact Analysis to a CSV file.", + "description": "To prevent a CSV injection attack when exporting Impact Analysis to a CSV file, if a special character ( = - + @ ) appears at the beginning of any field, a single quote (') is added before the character.", + "parameters": [ + { + "name": "application_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + } + ], + "responses": { + "403": { + "description": "You do not have permissions to edit this application." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Export Impact Analysis to a CSV file." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/applications/{application_id}/move_server": { + "post": { + "tags": [ + "Application Servers (by application)" + ], + "operationId": "moveServer", + "summary": "Move server", + "parameters": [ + { + "name": "application_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the application" + }, + { + "name": "server_id", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the server" + }, + { + "name": "target_application_id", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The unique identifier of the target application" + } + ], + "responses": { + "400": { + "description": "Group/Server cannot be moved because it or at least one of its group members is used in these connections with another external resource: CONNECTION_NAME" + }, + "403": { + "description": "This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." + }, + "401": { + "description": "No available licenses. Ask your SecureApp administrator for assistance." + }, + "404": { + "description": "There is no application with the specified ID." + }, + "200": { + "description": "Move server" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/import_applications/download_template": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "downloadEmptyExcel", + "summary": "Download a Microsoft Excel spreadsheet from your SecureApp server where you can enter the details of your servers, server groups, and connections", + "responses": { + "400": { + "description": "Cannot create import application excel" + }, + "403": { + "description": "Access is denied" + }, + "200": { + "description": "Download a Microsoft Excel spreadsheet from your SecureApp server where you can enter the details of your servers, server groups, and connections" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/import_applications/upload": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "openUploadForm", + "summary": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections", + "responses": { + "400": { + "description": "Failed to create upload form." + }, + "403": { + "description": "Access is denied" + }, + "200": { + "description": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections" + } + } + }, + "post": { + "tags": [ + "Applications" + ], + "operationId": "uploadExcel", + "summary": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections", + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + } + }, + "responses": { + "400": { + "description": "Failed to create upload form." + }, + "403": { + "description": "Access is denied" + }, + "200": { + "description": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections" + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/services": { + "get": { + "tags": [ + "Application Services (global)" + ], + "operationId": "getServices", + "summary": "Fetches services", + "parameters": [ + { + "name": "globals_only", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "get only globals" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the service" + }, + { + "name": "show_cloned_services", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "404": { + "description": "There are no services with the name NAME." + }, + "403": { + "description": "Access is denied." + }, + "200": { + "description": "Fetches services", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServiceListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Application Services (global)" + ], + "operationId": "addServices", + "summary": "Create global services", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServiceListDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Service was created." + }, + "200": { + "description": "Services were created." + }, + "400": { + "description": "Application identity cannot be a member of a group." + }, + "404": { + "description": "Service with ID <ID> was not found." + }, + "403": { + "description": "Access is denied." + } + } + }, + "delete": { + "tags": [ + "Application Services (global)" + ], + "operationId": "deleteUnusedNonPredefinedServiceByName", + "summary": "Delete unused and non predefined global service by name", + "parameters": [ + { + "name": "name", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the service" + } + ], + "responses": { + "200": { + "description": "Service was deleted." + }, + "404": { + "description": "There are no services with the name NAME." + }, + "400": { + "description": "Cannot delete a predefined object." + }, + "403": { + "description": "Access is denied." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/services/": { + "put": { + "tags": [ + "Application Services (global)" + ], + "operationId": "modifyServices", + "summary": "Modify unused and non predefined global services", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ServiceListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Services were modified." + }, + "400": { + "description": "Application identity cannot be a member of a group." + }, + "404": { + "description": "Service with ID <ID> was not found." + }, + "403": { + "description": "Access is denied." + } + } + } + }, + "/securechangeworkflow/api/secureapp/repository/services/{serviceId}": { + "get": { + "tags": [ + "Application Services (global)" + ], + "operationId": "getService", + "summary": "Fetches service by ID", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the service" + } + ], + "responses": { + "404": { + "description": "Service with ID <ID> was not found." + }, + "403": { + "description": "Access is denied." + }, + "200": { + "description": "Fetches service by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/sa_service" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Application Services (global)" + ], + "operationId": "deleteUnusedNonPredefinedService", + "summary": "Delete unused and non predefined global service", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the service" + } + ], + "responses": { + "200": { + "description": "Service was deleted." + }, + "404": { + "description": "Global Service with ID was not found." + }, + "400": { + "description": "You cannot delete a predefined object." + }, + "403": { + "description": "Access is denied." + } + } + } + } + } +} \ No newline at end of file diff --git a/Tufin/SecureApp/README.md b/Tufin/SecureApp/README.md new file mode 100644 index 0000000..e384412 --- /dev/null +++ b/Tufin/SecureApp/README.md @@ -0,0 +1,76 @@ +# Tufin SecureApp + +Tufin SecureApp is the application-centric network security management component of the Tufin Orchestration Suite. It models business applications as collections of servers, connections, and services, and maps that application connectivity to the underlying network security policy — through a REST API authenticated with HTTP Basic auth against a Tufin user account. + +## Table of Contents + +- [Contents](#contents) +- [Requirements](#requirements) +- [Integration Configuration](#integration-configuration) +- [OpenAPIs](#openapis) + - [`tufin_secureapp-latest.json`](#tufin_secureapp-latestjson) + - [`tufin_secureapp-25.2.json`](#tufin_secureapp-252json) +- [Studio Projects](#studio-projects) + - [Tufin SecureApp Project](#tufin-secureapp-project) + +## Contents + +| Asset | Description | +|---|---| +| [OpenAPIs/](./OpenAPIs/) | SecureApp REST API OpenAPI specs — curated `-latest` plus the full dated spec | +| [Studio Projects/](./Studio%20Projects/) | Itential Platform project containing all 56 curated workflows in 6 folders | + +## Requirements + +| Requirement | Version | +|---|---| +| Itential Platform | P6+ | +| Tufin SecureApp | R25-2 (25.2) | +| `Tufin SecureApp:latest` Integration Model | Import from `OpenAPIs/tufin_secureapp-latest.json` | + +## Integration Configuration + +Create an Itential Platform integration instance from the `Tufin SecureApp:latest` Integration Model, authenticated with a Tufin user's HTTP Basic credentials, pointed at your SecureApp management server (`https:///securechangeworkflow/api`, the same server that hosts SecureChange). The Studio Project's workflows are wired to an integration instance named **`Tufin SecureApp`** via `adapter_id` — if your instance uses a different name, update `adapter_id` in each workflow task after importing. + +## OpenAPIs + +| Spec | Version | Operations | Description | +|---|---|---|---| +| [`tufin_secureapp-latest.json`](./OpenAPIs/tufin_secureapp-latest.json) | latest (curated) | 56 | Trimmed from the full 104-operation upstream spec — see breakdown below | +| [`tufin_secureapp-25.2.json`](./OpenAPIs/tufin_secureapp-25.2.json) | 25.2 | 104 | Full spec for SecureApp R25-2 (104 operations) | + +### `tufin_secureapp-latest.json` + +Actively-maintained spec (`x-vendor-api-version: 25.2`). Trimmed from the full 104-operation upstream spec down to 56 operations covering common automation CRUD. + +Resources included, by category: + +- **Applications**: application CRUD, history, and bulk import +- **Application Connections**: connection CRUD, extended listing, and repair +- **Application Interfaces**: interface CRUD +- **Application Servers (by application)**: per-application server CRUD, move, and impact analysis +- **Application Services (local)**: application-scoped service CRUD +- **Application Services (global)**: global service CRUD + +Excluded as deep admin/config plumbing or niche: application packs (bulk export/import), customers, application migration, access portal, application users, cloud console, the cross-application server registry (duplicate of the per-application server listing), load balancers, application identities, and application pending changes. + +### `tufin_secureapp-25.2.json` + +Full spec for SecureApp R25-2 (104 operations) — the vendor's complete published API surface, converted from its native Swagger 1.2 documentation format to OpenAPI 3.0. See `tufin_secureapp-latest.json` above for the curated subset if you just need common CRUD automation. + +## Studio Projects + +### Tufin SecureApp Project + +Backed by the **Tufin SecureApp** REST API via the `Tufin SecureApp:latest` Integration Model. The project contains **56 workflows** — one atomic workflow per curated operation — organized into **6 folders** matching the OpenAPI resource categories above. + +| Folder | Workflows | +|---|---| +| Applications | 14 | +| Application Interfaces | 15 | +| Application Connections | 8 | +| Application Servers (by application) | 8 | +| Application Services (global) | 6 | +| Application Services (local) | 5 | + +Each workflow accepts a JSON object of the source operation's path/query parameters (and, for write operations, a `spec` object holding the request body) when run manually or called as a child workflow, and returns the full HTTP response envelope (`{ok, url, status, headers, text, body}`) from the adapter task. diff --git a/Tufin/SecureApp/Studio Projects/Tufin SecureApp.project.json b/Tufin/SecureApp/Studio Projects/Tufin SecureApp.project.json new file mode 100644 index 0000000..340a53f --- /dev/null +++ b/Tufin/SecureApp/Studio Projects/Tufin SecureApp.project.json @@ -0,0 +1,6262 @@ +{ + "_id": "e9f763a162f14223a13d9499", + "name": "Tufin SecureApp", + "description": "Application, application connection, application interface, per-application server, and local/global application service CRUD against Tufin SecureApp.", + "components": [ + { + "iid": 0, + "reference": "5c7d2fab-622e-41cd-84fe-395f89a004be", + "type": "workflow", + "folder": "/Application Connections", + "document": { + "name": "Retrieve existing connections", + "description": "Retrieve existing connections", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1": { + "name": "getConnections", + "canvasName": "getConnections", + "summary": "Retrieve existing connections", + "description": "Retrieve existing connections", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "name": "$var.job.name" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1": { + "type": "standard", + "state": "success" + } + }, + "1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "name": { + "type": "string", + "description": "The name of the connection" + } + }, + "required": [ + "applicationId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 1, + "reference": "332810f9-6ed4-4082-a0b7-f69a4637b7af", + "type": "workflow", + "folder": "/Application Connections", + "document": { + "name": "Create connections", + "description": "Create connections", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2": { + "name": "addConnections", + "canvasName": "addConnections", + "summary": "Create connections", + "description": "Create connections", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2": { + "type": "standard", + "state": "success" + } + }, + "2": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 2, + "reference": "52ee5253-7485-4188-be6b-58fa36584a49", + "type": "workflow", + "folder": "/Application Connections", + "document": { + "name": "Update connections", + "description": "Update connections", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "3": { + "name": "modifyConnections", + "canvasName": "modifyConnections", + "summary": "Update connections", + "description": "Update connections", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "3": { + "type": "standard", + "state": "success" + } + }, + "3": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 3, + "reference": "af306ca8-04d4-4534-b9bb-2428c8326945", + "type": "workflow", + "folder": "/Application Connections", + "document": { + "name": "Delete connection", + "description": "Delete connection", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "4": { + "name": "deleteConnection", + "canvasName": "deleteConnection", + "summary": "Delete connection", + "description": "Delete connection", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "connectionId": "$var.job.connectionId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "4": { + "type": "standard", + "state": "success" + } + }, + "4": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "connectionId": { + "type": "integer", + "description": "The unique identifier of the connection" + } + }, + "required": [ + "applicationId", + "connectionId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 4, + "reference": "b1380aed-b15b-4eb4-86ae-1da5695334ef", + "type": "workflow", + "folder": "/Application Connections", + "document": { + "name": "Retrieve an existing connection by ID", + "description": "Retrieve an existing connection by ID", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "5": { + "name": "getConnection", + "canvasName": "getConnection", + "summary": "Retrieve an existing connection by ID", + "description": "Retrieve an existing connection by ID", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "connectionId": "$var.job.connectionId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "5": { + "type": "standard", + "state": "success" + } + }, + "5": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "connectionId": { + "type": "integer", + "description": "The unique identifier of the connection" + } + }, + "required": [ + "applicationId", + "connectionId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 5, + "reference": "0633fb97-7e41-48d7-90f7-0056a6740f33", + "type": "workflow", + "folder": "/Application Connections", + "document": { + "name": "Update a connection", + "description": "Update a connection", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "6": { + "name": "modifyConnection", + "canvasName": "modifyConnection", + "summary": "Update a connection", + "description": "Update a connection", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "connectionId": "$var.job.connectionId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "6": { + "type": "standard", + "state": "success" + } + }, + "6": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "connectionId": { + "type": "integer", + "description": "The unique identifier of the connection" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "connectionId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 6, + "reference": "2e475623-413d-4bf4-8f9d-d54f79d99685", + "type": "workflow", + "folder": "/Application Connections", + "document": { + "name": "Retrieve existing connections, with extended resources information", + "description": "Retrieve existing connections, with extended resources information", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "7": { + "name": "getConnectionFullResources", + "canvasName": "getConnectionFullResources", + "summary": "Retrieve existing connections, with extended resources information", + "description": "Retrieve existing connections, with extended resources information", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "name": "$var.job.name", + "start": "$var.job.start", + "count": "$var.job.count" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "7": { + "type": "standard", + "state": "success" + } + }, + "7": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "name": { + "type": "string", + "description": "The name of the connection" + }, + "start": { + "type": "integer", + "description": "Return results starting only from the specified index; 0-based index; default value = 0" + }, + "count": { + "type": "integer", + "description": "Return the specified number of results. Returns all results if no value specified" + } + }, + "required": [ + "applicationId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 7, + "reference": "6351f9a2-9707-4987-8ab5-8a3bb89f1215", + "type": "workflow", + "folder": "/Application Connections", + "document": { + "name": "Create a ticket to repair a connection", + "description": "Create a ticket to repair a connection", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "8": { + "name": "repairConnection", + "canvasName": "repairConnection", + "summary": "Create a ticket to repair a connection", + "description": "Create a ticket to repair a connection", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "application_id": "$var.job.application_id", + "connection_id": "$var.job.connection_id", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "8": { + "type": "standard", + "state": "success" + } + }, + "8": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "application_id": { + "type": "integer", + "description": "The application ID" + }, + "connection_id": { + "type": "integer", + "description": "The connection ID" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "application_id", + "connection_id", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 8, + "reference": "e2b855d6-4f60-469e-9f28-36485b67ef9a", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Retrieve existing application interfaces", + "description": "To improve response time, set 'calculateIsPublished = false' to avoid calculating 'is_published'.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "9": { + "name": "getApplicationInterfaces", + "canvasName": "getApplicationInterfaces", + "summary": "Retrieve existing application interfaces", + "description": "To improve response time, set 'calculateIsPublished = false' to avoid calculating 'is_published'.", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "name": "$var.job.name", + "calculateIsPublished": "$var.job.calculateIsPublished" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "9": { + "type": "standard", + "state": "success" + } + }, + "9": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "name": { + "type": "string", + "description": "The name of the application interface" + }, + "calculateIsPublished": { + "type": "boolean", + "description": "Should calculate is_published value" + } + }, + "required": [ + "applicationId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 9, + "reference": "238fcec7-ea4c-4078-9abe-ff1f2b8e3eb5", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Create application interface", + "description": "Create application interface", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a": { + "name": "addApplicationInterface", + "canvasName": "addApplicationInterface", + "summary": "Create application interface", + "description": "Create application interface", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a": { + "type": "standard", + "state": "success" + } + }, + "a": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 10, + "reference": "ee3d74a7-fe6a-4853-a36a-2193c4bb3e37", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Delete application interface", + "description": "Delete application interface", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "b": { + "name": "deleteApplicationInterface", + "canvasName": "deleteApplicationInterface", + "summary": "Delete application interface", + "description": "Delete application interface", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "applicationInterfaceId": "$var.job.applicationInterfaceId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "b": { + "type": "standard", + "state": "success" + } + }, + "b": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "applicationInterfaceId": { + "type": "integer", + "description": "The unique identifier of the application interface" + } + }, + "required": [ + "applicationId", + "applicationInterfaceId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 11, + "reference": "f0c30f3d-57d8-4199-93a4-b0ea476605af", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Retrieve an existing application interface by ID", + "description": "Retrieve an existing application interface by ID", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "c": { + "name": "getApplicationInterface", + "canvasName": "getApplicationInterface", + "summary": "Retrieve an existing application interface by ID", + "description": "Retrieve an existing application interface by ID", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "applicationInterfaceId": "$var.job.applicationInterfaceId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "c": { + "type": "standard", + "state": "success" + } + }, + "c": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "applicationInterfaceId": { + "type": "integer", + "description": "The unique identifier of the application interface" + } + }, + "required": [ + "applicationId", + "applicationInterfaceId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 12, + "reference": "0225252c-5125-4e73-9771-67398f7a2707", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Update an application interface", + "description": "Update the application interface properties. If is_published is set to true, the application interface is published for use by other users.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "d": { + "name": "modifyApplicationInterface", + "canvasName": "modifyApplicationInterface", + "summary": "Update an application interface", + "description": "Update the application interface properties. If is_published is set to true, the application interface is published for use by other users.", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "applicationInterfaceId": "$var.job.applicationInterfaceId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "d": { + "type": "standard", + "state": "success" + } + }, + "d": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "applicationInterfaceId": { + "type": "integer", + "description": "The unique identifier of The application interface" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "applicationInterfaceId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 13, + "reference": "44c09b42-c3ed-4110-9e19-f2bdd5fbc243", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Retrieve existing interface connections", + "description": "Retrieve existing interface connections", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "e": { + "name": "getConnectionInterfaces", + "canvasName": "getConnectionInterfaces", + "summary": "Retrieve existing interface connections", + "description": "Retrieve existing interface connections", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "applicationInterfaceId": "$var.job.applicationInterfaceId", + "name": "$var.job.name" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "e": { + "type": "standard", + "state": "success" + } + }, + "e": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "applicationInterfaceId": { + "type": "integer", + "description": "The unique identifier of the application interface" + }, + "name": { + "type": "string", + "description": "The name of the interface connection" + } + }, + "required": [ + "applicationId", + "applicationInterfaceId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 14, + "reference": "a2bbdad4-d73e-4442-b91d-a88b87fe51d9", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Create interface connections", + "description": "Create interface connections", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "f": { + "name": "addConnectionInterfaces", + "canvasName": "addConnectionInterfaces", + "summary": "Create interface connections", + "description": "Create interface connections", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "applicationInterfaceId": "$var.job.applicationInterfaceId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "f": { + "type": "standard", + "state": "success" + } + }, + "f": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "applicationInterfaceId": { + "type": "integer", + "description": "The unique identifier of the application interface" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "applicationInterfaceId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 15, + "reference": "236df857-ea96-4b07-ba8b-8899af44eef6", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Delete interface connection", + "description": "Delete interface connection", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "10": { + "name": "deleteConnectionInterface", + "canvasName": "deleteConnectionInterface", + "summary": "Delete interface connection", + "description": "Delete interface connection", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "applicationInterfaceId": "$var.job.applicationInterfaceId", + "connectionInterfaceId": "$var.job.connectionInterfaceId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "10": { + "type": "standard", + "state": "success" + } + }, + "10": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "applicationInterfaceId": { + "type": "integer", + "description": "The unique identifier of the application interface" + }, + "connectionInterfaceId": { + "type": "integer", + "description": "The unique identifier of the interface connection" + } + }, + "required": [ + "applicationId", + "applicationInterfaceId", + "connectionInterfaceId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 16, + "reference": "6664caf5-449b-4243-a5f9-b9d0906e4029", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Retrieve an existing interface connection by ID", + "description": "Retrieve an existing interface connection by ID", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "11": { + "name": "getConnectionInterface", + "canvasName": "getConnectionInterface", + "summary": "Retrieve an existing interface connection by ID", + "description": "Retrieve an existing interface connection by ID", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "applicationInterfaceId": "$var.job.applicationInterfaceId", + "connectionInterfaceId": "$var.job.connectionInterfaceId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "11": { + "type": "standard", + "state": "success" + } + }, + "11": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "applicationInterfaceId": { + "type": "integer", + "description": "The unique identifier of the application interface" + }, + "connectionInterfaceId": { + "type": "integer", + "description": "The unique identifier of the interface connection" + } + }, + "required": [ + "applicationId", + "applicationInterfaceId", + "connectionInterfaceId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 17, + "reference": "68579b21-50ad-411a-b4a9-ed36d93dd537", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Update an interface connection", + "description": "Update an interface connection", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "12": { + "name": "modifyConnectionInterface", + "canvasName": "modifyConnectionInterface", + "summary": "Update an interface connection", + "description": "Update an interface connection", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "applicationInterfaceId": "$var.job.applicationInterfaceId", + "connectionInterfaceId": "$var.job.connectionInterfaceId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "12": { + "type": "standard", + "state": "success" + } + }, + "12": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "applicationInterfaceId": { + "type": "integer", + "description": "The unique identifier of the application interface" + }, + "connectionInterfaceId": { + "type": "integer", + "description": "The unique identifier of the interface connection" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "applicationInterfaceId", + "connectionInterfaceId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 18, + "reference": "bb2f628c-888f-4821-b303-00b560a73b41", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Retrieve existing connections to application", + "description": "Retrieve existing connections to application", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "13": { + "name": "getApplicationInterfaceInstances", + "canvasName": "getApplicationInterfaceInstances", + "summary": "Retrieve existing connections to application", + "description": "Retrieve existing connections to application", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "name": "$var.job.name" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "13": { + "type": "standard", + "state": "success" + } + }, + "13": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "name": { + "type": "string", + "description": "The name of the connection to application" + } + }, + "required": [ + "applicationId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 19, + "reference": "352ffc97-9ed4-47f9-9edb-47a1ef04d3a3", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Create connection to application", + "description": "Create a connection from this application to an application interface.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "14": { + "name": "addApplicationInterfaceInstance", + "canvasName": "addApplicationInterfaceInstance", + "summary": "Create connection to application", + "description": "Create a connection from this application to an application interface.", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "14": { + "type": "standard", + "state": "success" + } + }, + "14": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 20, + "reference": "e1db7c88-7ed6-4ae8-ace4-e1a3b68e2a91", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Delete connection to application", + "description": "Delete connection to application", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "15": { + "name": "deleteApplicationInterfaceInstance", + "canvasName": "deleteApplicationInterfaceInstance", + "summary": "Delete connection to application", + "description": "Delete connection to application", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "connectionToApplicationId": "$var.job.connectionToApplicationId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "15": { + "type": "standard", + "state": "success" + } + }, + "15": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "connectionToApplicationId": { + "type": "integer", + "description": "The unique identifier of the connection to application" + } + }, + "required": [ + "applicationId", + "connectionToApplicationId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 21, + "reference": "9c044d45-9815-45d6-b135-7f69207c50f6", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Retrieve an existing connection to application by ID", + "description": "Retrieve an existing connection to application by ID", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "16": { + "name": "getApplicationInterfaceInstance", + "canvasName": "getApplicationInterfaceInstance", + "summary": "Retrieve an existing connection to application by ID", + "description": "Retrieve an existing connection to application by ID", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "connectionToApplicationId": "$var.job.connectionToApplicationId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "16": { + "type": "standard", + "state": "success" + } + }, + "16": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "connectionToApplicationId": { + "type": "integer", + "description": "The unique identifier of the connection to application" + } + }, + "required": [ + "applicationId", + "connectionToApplicationId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 22, + "reference": "ea6f5927-25d8-4cde-8375-b91b516ffdb2", + "type": "workflow", + "folder": "/Application Interfaces", + "document": { + "name": "Update a connection to application", + "description": "Update a connection to application", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "17": { + "name": "modifyApplicationInterfaceInstance", + "canvasName": "modifyApplicationInterfaceInstance", + "summary": "Update a connection to application", + "description": "Update a connection to application", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "connectionToApplicationId": "$var.job.connectionToApplicationId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "17": { + "type": "standard", + "state": "success" + } + }, + "17": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "connectionToApplicationId": { + "type": "integer", + "description": "The unique identifier of the connection to application" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "connectionToApplicationId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 23, + "reference": "ff0470e1-ef5a-4547-be9e-73307a5b2bbb", + "type": "workflow", + "folder": "/Application Servers (by application)", + "document": { + "name": "Retrieve existing servers", + "description": "Retrieve existing servers", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "18": { + "name": "getServers_2", + "canvasName": "getServers_2", + "summary": "Retrieve existing servers", + "description": "Retrieve existing servers", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "name": "$var.job.name", + "ip": "$var.job.ip", + "show_cloned_servers": "$var.job.show_cloned_servers" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "18": { + "type": "standard", + "state": "success" + } + }, + "18": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "name": { + "type": "string", + "description": "The name of the server" + }, + "ip": { + "type": "string", + "description": "The ip of the server" + }, + "show_cloned_servers": { + "type": "boolean" + } + }, + "required": [ + "applicationId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 24, + "reference": "ea6e50db-a6fc-443c-aa1d-e9b2692c0a9d", + "type": "workflow", + "folder": "/Application Servers (by application)", + "document": { + "name": "Create servers", + "description": "Create servers", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "19": { + "name": "addServers", + "canvasName": "addServers", + "summary": "Create servers", + "description": "Create servers", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "19": { + "type": "standard", + "state": "success" + } + }, + "19": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 25, + "reference": "8573a4d8-b477-44d6-9676-4ca883d7bcc6", + "type": "workflow", + "folder": "/Application Servers (by application)", + "document": { + "name": "Update servers", + "description": "Update servers", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1a": { + "name": "modifyServers", + "canvasName": "modifyServers", + "summary": "Update servers", + "description": "Update servers", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1a": { + "type": "standard", + "state": "success" + } + }, + "1a": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 26, + "reference": "669466e7-413d-4238-bcd4-633b686fcd06", + "type": "workflow", + "folder": "/Application Servers (by application)", + "document": { + "name": "Delete server", + "description": "To decommission a serer use force=true.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1b": { + "name": "deleteServer", + "canvasName": "deleteServer", + "summary": "Delete server", + "description": "To decommission a serer use force=true.", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "serverId": "$var.job.serverId", + "force": "$var.job.force" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1b": { + "type": "standard", + "state": "success" + } + }, + "1b": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "serverId": { + "type": "integer", + "description": "The unique identifier of the server" + }, + "force": { + "type": "boolean", + "description": "Force delete" + } + }, + "required": [ + "applicationId", + "serverId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 27, + "reference": "ec6ea3a5-da39-4573-a6d4-8af43b198dea", + "type": "workflow", + "folder": "/Application Servers (by application)", + "document": { + "name": "Retrieve an existing server by ID", + "description": "Retrieve an existing server by ID", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1c": { + "name": "getServer_2", + "canvasName": "getServer_2", + "summary": "Retrieve an existing server by ID", + "description": "Retrieve an existing server by ID", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "serverId": "$var.job.serverId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1c": { + "type": "standard", + "state": "success" + } + }, + "1c": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "serverId": { + "type": "integer", + "description": "The unique identifier of the server" + } + }, + "required": [ + "applicationId", + "serverId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 28, + "reference": "e8da66a2-39f4-40c2-9d51-7cc7de79e79c", + "type": "workflow", + "folder": "/Application Servers (by application)", + "document": { + "name": "Export Server Impact Analysis to a CSV file.", + "description": "Export Server Impact Analysis to a CSV file.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1d": { + "name": "exportDependencies", + "canvasName": "exportDependencies", + "summary": "Export Server Impact Analysis to a CSV file.", + "description": "Export Server Impact Analysis to a CSV file.", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "serverId": "$var.job.serverId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1d": { + "type": "standard", + "state": "success" + } + }, + "1d": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer" + }, + "serverId": { + "type": "integer" + } + }, + "required": [ + "applicationId", + "serverId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 29, + "reference": "f99879c5-45da-4fd0-865a-cf40cb253858", + "type": "workflow", + "folder": "/Application Servers (by application)", + "document": { + "name": "getServerMembers", + "description": "If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1e": { + "name": "getServerMembers", + "canvasName": "getServerMembers", + "summary": "If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.", + "description": "If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "serverId": "$var.job.serverId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1e": { + "type": "standard", + "state": "success" + } + }, + "1e": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer" + }, + "serverId": { + "type": "integer" + } + }, + "required": [ + "applicationId", + "serverId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 30, + "reference": "3326a067-ce58-4574-b7dc-ee3a76cc1bd6", + "type": "workflow", + "folder": "/Application Servers (by application)", + "document": { + "name": "Move server", + "description": "Move server", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1f": { + "name": "moveServer", + "canvasName": "moveServer", + "summary": "Move server", + "description": "Move server", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "application_id": "$var.job.application_id", + "server_id": "$var.job.server_id", + "target_application_id": "$var.job.target_application_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1f": { + "type": "standard", + "state": "success" + } + }, + "1f": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "application_id": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "server_id": { + "type": "integer", + "description": "The unique identifier of the server" + }, + "target_application_id": { + "type": "integer", + "description": "The unique identifier of the target application" + } + }, + "required": [ + "application_id", + "server_id", + "target_application_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 31, + "reference": "2469f427-1391-4029-9a90-c5c86fffb66a", + "type": "workflow", + "folder": "/Application Services (global)", + "document": { + "name": "Delete unused and non predefined global service by name", + "description": "Delete unused and non predefined global service by name", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "20": { + "name": "deleteUnusedNonPredefinedServiceByName", + "canvasName": "deleteUnusedNonPredefinedServiceByName", + "summary": "Delete unused and non predefined global service by name", + "description": "Delete unused and non predefined global service by name", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "name": "$var.job.name" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "20": { + "type": "standard", + "state": "success" + } + }, + "20": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the service" + } + }, + "required": [ + "name" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 32, + "reference": "caf17335-e69b-46f1-a25b-4c900ad79757", + "type": "workflow", + "folder": "/Application Services (global)", + "document": { + "name": "Fetches services", + "description": "Fetches services", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "21": { + "name": "getServices", + "canvasName": "getServices", + "summary": "Fetches services", + "description": "Fetches services", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "globals_only": "$var.job.globals_only", + "name": "$var.job.name", + "show_cloned_services": "$var.job.show_cloned_services" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "21": { + "type": "standard", + "state": "success" + } + }, + "21": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "globals_only": { + "type": "boolean", + "description": "get only globals" + }, + "name": { + "type": "string", + "description": "The name of the service" + }, + "show_cloned_services": { + "type": "boolean" + } + } + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 33, + "reference": "e8bcab7c-cf6d-431a-84d0-3db0a331862b", + "type": "workflow", + "folder": "/Application Services (global)", + "document": { + "name": "Create global services", + "description": "Create global services", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "22": { + "name": "addServices", + "canvasName": "addServices", + "summary": "Create global services", + "description": "Create global services", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "22": { + "type": "standard", + "state": "success" + } + }, + "22": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 34, + "reference": "c8bb108a-ebee-4e95-beac-02941f342ecc", + "type": "workflow", + "folder": "/Application Services (global)", + "document": { + "name": "Modify unused and non predefined global services", + "description": "Modify unused and non predefined global services", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "23": { + "name": "modifyServices", + "canvasName": "modifyServices", + "summary": "Modify unused and non predefined global services", + "description": "Modify unused and non predefined global services", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "23": { + "type": "standard", + "state": "success" + } + }, + "23": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 35, + "reference": "e857883d-4fde-4f8e-b0bb-db401bf82403", + "type": "workflow", + "folder": "/Application Services (global)", + "document": { + "name": "Delete unused and non predefined global service", + "description": "Delete unused and non predefined global service", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "24": { + "name": "deleteUnusedNonPredefinedService", + "canvasName": "deleteUnusedNonPredefinedService", + "summary": "Delete unused and non predefined global service", + "description": "Delete unused and non predefined global service", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "serviceId": "$var.job.serviceId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "24": { + "type": "standard", + "state": "success" + } + }, + "24": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "serviceId": { + "type": "integer", + "description": "The ID of the service" + } + }, + "required": [ + "serviceId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 36, + "reference": "d98dd6c1-42aa-4628-a9cc-819655c3e535", + "type": "workflow", + "folder": "/Application Services (global)", + "document": { + "name": "Fetches service by ID", + "description": "Fetches service by ID", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "25": { + "name": "getService", + "canvasName": "getService", + "summary": "Fetches service by ID", + "description": "Fetches service by ID", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "serviceId": "$var.job.serviceId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "25": { + "type": "standard", + "state": "success" + } + }, + "25": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "serviceId": { + "type": "integer", + "description": "The ID of the service" + } + }, + "required": [ + "serviceId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 37, + "reference": "d9476940-3b4c-4df0-a9f1-b62cb8361a25", + "type": "workflow", + "folder": "/Application Services (local)", + "document": { + "name": "Retrieve existing services", + "description": "Retrieve existing services", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "26": { + "name": "getServices_2", + "canvasName": "getServices_2", + "summary": "Retrieve existing services", + "description": "Retrieve existing services", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "name": "$var.job.name", + "show_cloned_services": "$var.job.show_cloned_services" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "26": { + "type": "standard", + "state": "success" + } + }, + "26": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "name": { + "type": "string", + "description": "The name of the service" + }, + "show_cloned_services": { + "type": "boolean" + } + }, + "required": [ + "applicationId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 38, + "reference": "3cd4ee23-3605-4483-a45f-ee0b7691d01a", + "type": "workflow", + "folder": "/Application Services (local)", + "document": { + "name": "Create services", + "description": "Create services", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "27": { + "name": "addServices_2", + "canvasName": "addServices_2", + "summary": "Create services", + "description": "Create services", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "27": { + "type": "standard", + "state": "success" + } + }, + "27": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 39, + "reference": "b7939197-390c-486d-8a03-c79766c43228", + "type": "workflow", + "folder": "/Application Services (local)", + "document": { + "name": "Update services", + "description": "Update services", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "28": { + "name": "modifyServices_2", + "canvasName": "modifyServices_2", + "summary": "Update services", + "description": "Update services", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "28": { + "type": "standard", + "state": "success" + } + }, + "28": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 40, + "reference": "8ae17635-de02-47b2-af9a-0e0accde25f2", + "type": "workflow", + "folder": "/Application Services (local)", + "document": { + "name": "Delete service", + "description": "Use force=true to delete a service with decommission.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "29": { + "name": "deleteService", + "canvasName": "deleteService", + "summary": "Delete service", + "description": "Use force=true to delete a service with decommission.", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "serviceId": "$var.job.serviceId", + "force": "$var.job.force" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "29": { + "type": "standard", + "state": "success" + } + }, + "29": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "serviceId": { + "type": "integer", + "description": "The unique identifier of the service" + }, + "force": { + "type": "boolean", + "description": "Force delete" + } + }, + "required": [ + "applicationId", + "serviceId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 41, + "reference": "39d3b0af-05c0-426a-b45c-7b0b2df7c135", + "type": "workflow", + "folder": "/Application Services (local)", + "document": { + "name": "Retrieve an existing service by ID", + "description": "Retrieve an existing service by ID", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2a": { + "name": "getService_2", + "canvasName": "getService_2", + "summary": "Retrieve an existing service by ID", + "description": "Retrieve an existing service by ID", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "serviceId": "$var.job.serviceId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2a": { + "type": "standard", + "state": "success" + } + }, + "2a": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "serviceId": { + "type": "integer", + "description": "The unique identifier of the service" + } + }, + "required": [ + "applicationId", + "serviceId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 42, + "reference": "0fc9fd91-515c-4d2c-8c26-d266816e45cc", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "List all applications", + "description": "List all applications", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2b": { + "name": "getApplications", + "canvasName": "getApplications", + "summary": "List all applications", + "description": "List all applications", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "userId": "$var.job.userId", + "name": "$var.job.name", + "app_permissions": "$var.job.app_permissions" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2b": { + "type": "standard", + "state": "success" + } + }, + "2b": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "userId": { + "type": "integer", + "description": "Applications by user ID, if not given the default is logged in user id" + }, + "name": { + "type": "string", + "description": "The name of the application" + }, + "app_permissions": { + "type": "string", + "description": "Filter applications by the given permissions (separated with commas):\napp_owner - returns applications where the user is the owner\napp_editor - returns applications where the user has been explicitly added as an editor\napp_viewer - returns applications where the user has been explicitly added as a viewer\napp_adminonly - returns applications where the user only has editor access because user has \"edit all applications\" permission, and does not include applications where this user is either the app_owner, app_editor, or app_viewer" + } + } + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 43, + "reference": "3f2e4e81-04af-4201-ae1c-fc86d8a1cdde", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "Create new applications", + "description": "Create new applications", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2c": { + "name": "addApplications", + "canvasName": "addApplications", + "summary": "Create new applications", + "description": "Create new applications", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2c": { + "type": "standard", + "state": "success" + } + }, + "2c": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 44, + "reference": "74ed4a08-36b2-4e39-83a4-03c93ead44da", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "Update applications", + "description": "This API can be used to delete or decommission an application.\nTo decommission an application, send true in decommissioned tag.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2d": { + "name": "modifyApplications", + "canvasName": "modifyApplications", + "summary": "Update applications", + "description": "This API can be used to delete or decommission an application.\nTo decommission an application, send true in decommissioned tag.", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2d": { + "type": "standard", + "state": "success" + } + }, + "2d": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 45, + "reference": "fc3b9f4b-f303-489a-8e82-bd1af50727a1", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "Move applications to another customer", + "description": "Move applications to another customer", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2e": { + "name": "moveApplications", + "canvasName": "moveApplications", + "summary": "Move applications to another customer", + "description": "Move applications to another customer", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2e": { + "type": "standard", + "state": "success" + } + }, + "2e": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "type": "object", + "description": "Request body payload." + } + } + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 46, + "reference": "e357f65b-70da-4236-ae1f-15a9d35be44a", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "Delete an application", + "description": "Delete an application", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2f": { + "name": "deleteApplication", + "canvasName": "deleteApplication", + "summary": "Delete an application", + "description": "Delete an application", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2f": { + "type": "standard", + "state": "success" + } + }, + "2f": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application to delete" + } + }, + "required": [ + "applicationId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 47, + "reference": "7ece6cba-cbba-4d1d-b9e7-66dc7f2200d7", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "Retrieve an existing application by ID", + "description": "Retrieve an existing application by ID", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "30": { + "name": "getApplication", + "canvasName": "getApplication", + "summary": "Retrieve an existing application by ID", + "description": "Retrieve an existing application by ID", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "30": { + "type": "standard", + "state": "success" + } + }, + "30": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of an application to retrieve" + } + }, + "required": [ + "applicationId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 48, + "reference": "3b92d1c8-62b0-46a8-ad11-2085e23f6d4c", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "Change an application", + "description": "This API can be used to delete or decommission an application.\nTo decommission an application, send true in decommissioned tag.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "31": { + "name": "modifyApplication", + "canvasName": "modifyApplication", + "summary": "Change an application", + "description": "This API can be used to delete or decommission an application.\nTo decommission an application, send true in decommissioned tag.", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "31": { + "type": "standard", + "state": "success" + } + }, + "31": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of an application to change" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "applicationId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 49, + "reference": "7fb3cd3b-d5b8-43ec-a917-1ac92a85ed53", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "Retrieve security policy violations from SecureTrack", + "description": "Retrieve security policy violations from SecureTrack", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "32": { + "name": "getSPComplianceViolations", + "canvasName": "getSPComplianceViolations", + "summary": "Retrieve security policy violations from SecureTrack", + "description": "Retrieve security policy violations from SecureTrack", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "32": { + "type": "standard", + "state": "success" + } + }, + "32": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer" + } + }, + "required": [ + "applicationId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 50, + "reference": "8a5c15a5-6b93-4e85-856c-ea87ef9cb5fe", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "Retrieve application history", + "description": "Retrieve application history", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "33": { + "name": "getApplicationHistory", + "canvasName": "getApplicationHistory", + "summary": "Retrieve application history", + "description": "Retrieve application history", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "applicationId": "$var.job.applicationId", + "start_date": "$var.job.start_date", + "end_date": "$var.job.end_date", + "count": "$var.job.count", + "start": "$var.job.start", + "type": "$var.job.type", + "user": "$var.job.user", + "showMembers": "$var.job.showMembers" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "33": { + "type": "standard", + "state": "success" + } + }, + "33": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "start_date": { + "type": "string", + "description": "States starting date to fetch history since. Date format expected: yyyy-mm-dd" + }, + "end_date": { + "type": "string", + "description": "Get history until this date. Date format expected: yyyy-mm-dd" + }, + "count": { + "type": "string", + "description": "History list length" + }, + "start": { + "type": "string", + "description": "Offset the count starting point" + }, + "type": { + "type": "string", + "description": "States the history type to fetch" + }, + "user": { + "type": "string", + "description": "The username of the user made the changes" + }, + "showMembers": { + "type": "boolean", + "description": "Whether or not to show group members of server/service groups" + } + }, + "required": [ + "applicationId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 51, + "reference": "b34777a8-db0d-46db-85d8-035d5d288298", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "Export application history to PDF", + "description": "Export application history to PDF", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "34": { + "name": "exportApplicationHistory", + "canvasName": "exportApplicationHistory", + "summary": "Export application history to PDF", + "description": "Export application history to PDF", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "application_id": "$var.job.application_id", + "start_date": "$var.job.start_date", + "end_date": "$var.job.end_date", + "count": "$var.job.count" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "34": { + "type": "standard", + "state": "success" + } + }, + "34": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "application_id": { + "type": "integer", + "description": "The unique identifier of the application" + }, + "start_date": { + "type": "string", + "description": "States starting date to fetch history since. Date format expected: yyyy-mm-dd" + }, + "end_date": { + "type": "string", + "description": "Get history until this date. Date format expected: yyyy-mm-dd" + }, + "count": { + "type": "integer", + "description": "History max rows" + } + }, + "required": [ + "application_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 52, + "reference": "351edec7-76ed-455e-be54-c475878c0030", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "Export Impact Analysis to a CSV file.", + "description": "To prevent a CSV injection attack when exporting Impact Analysis to a CSV file, if a special character ( = - + @ ) appears at the beginning of any field, a single quote (') is added before the character.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "35": { + "name": "exportImpactAnalysisToCsv", + "canvasName": "exportImpactAnalysisToCsv", + "summary": "Export Impact Analysis to a CSV file.", + "description": "To prevent a CSV injection attack when exporting Impact Analysis to a CSV file, if a special character ( = - + @ ) appears at the beginning of any field, a single quote (') is added before the character.", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "application_id": "$var.job.application_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "35": { + "type": "standard", + "state": "success" + } + }, + "35": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "application_id": { + "type": "integer", + "description": "The unique identifier of the application" + } + }, + "required": [ + "application_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 53, + "reference": "66cd8303-4327-4d24-ab86-383254307c20", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "downloadEmptyExcel", + "description": "Download a Microsoft Excel spreadsheet from your SecureApp server where you can enter the details of your servers, server groups, and connections", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "36": { + "name": "downloadEmptyExcel", + "canvasName": "downloadEmptyExcel", + "summary": "Download a Microsoft Excel spreadsheet from your SecureApp server where you can enter the details of your servers, server groups, and connections", + "description": "Download a Microsoft Excel spreadsheet from your SecureApp server where you can enter the details of your servers, server groups, and connections", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "36": { + "type": "standard", + "state": "success" + } + }, + "36": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": {} + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 54, + "reference": "d539b39f-f874-4242-a58f-bcadb0e1505a", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "openUploadForm", + "description": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "37": { + "name": "openUploadForm", + "canvasName": "openUploadForm", + "summary": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections", + "description": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "37": { + "type": "standard", + "state": "success" + } + }, + "37": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": {} + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 55, + "reference": "ee9a1bf5-6982-420e-843a-ef000cc36913", + "type": "workflow", + "folder": "/Applications", + "document": { + "name": "uploadExcel", + "description": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "38": { + "name": "uploadExcel", + "canvasName": "uploadExcel", + "summary": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections", + "description": "Import the spreadsheet into SecureApp to create the specified servers, server groups, and connections", + "location": "Adapter", + "locationType": "Tufin SecureApp:latest", + "app": "Tufin SecureApp:latest", + "type": "automatic", + "displayName": "Tufin SecureApp", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureApp", + "bodyContentType": "multipart/form-data", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "38": { + "type": "standard", + "state": "success" + } + }, + "38": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + } + ], + "folders": [ + { + "nodeType": "folder", + "name": "Application Connections", + "children": [ + { + "iid": 0, + "nodeType": "component" + }, + { + "iid": 1, + "nodeType": "component" + }, + { + "iid": 2, + "nodeType": "component" + }, + { + "iid": 3, + "nodeType": "component" + }, + { + "iid": 4, + "nodeType": "component" + }, + { + "iid": 5, + "nodeType": "component" + }, + { + "iid": 6, + "nodeType": "component" + }, + { + "iid": 7, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "Application Interfaces", + "children": [ + { + "iid": 8, + "nodeType": "component" + }, + { + "iid": 9, + "nodeType": "component" + }, + { + "iid": 10, + "nodeType": "component" + }, + { + "iid": 11, + "nodeType": "component" + }, + { + "iid": 12, + "nodeType": "component" + }, + { + "iid": 13, + "nodeType": "component" + }, + { + "iid": 14, + "nodeType": "component" + }, + { + "iid": 15, + "nodeType": "component" + }, + { + "iid": 16, + "nodeType": "component" + }, + { + "iid": 17, + "nodeType": "component" + }, + { + "iid": 18, + "nodeType": "component" + }, + { + "iid": 19, + "nodeType": "component" + }, + { + "iid": 20, + "nodeType": "component" + }, + { + "iid": 21, + "nodeType": "component" + }, + { + "iid": 22, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "Application Servers (by application)", + "children": [ + { + "iid": 23, + "nodeType": "component" + }, + { + "iid": 24, + "nodeType": "component" + }, + { + "iid": 25, + "nodeType": "component" + }, + { + "iid": 26, + "nodeType": "component" + }, + { + "iid": 27, + "nodeType": "component" + }, + { + "iid": 28, + "nodeType": "component" + }, + { + "iid": 29, + "nodeType": "component" + }, + { + "iid": 30, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "Application Services (global)", + "children": [ + { + "iid": 31, + "nodeType": "component" + }, + { + "iid": 32, + "nodeType": "component" + }, + { + "iid": 33, + "nodeType": "component" + }, + { + "iid": 34, + "nodeType": "component" + }, + { + "iid": 35, + "nodeType": "component" + }, + { + "iid": 36, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "Application Services (local)", + "children": [ + { + "iid": 37, + "nodeType": "component" + }, + { + "iid": 38, + "nodeType": "component" + }, + { + "iid": 39, + "nodeType": "component" + }, + { + "iid": 40, + "nodeType": "component" + }, + { + "iid": 41, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "Applications", + "children": [ + { + "iid": 42, + "nodeType": "component" + }, + { + "iid": 43, + "nodeType": "component" + }, + { + "iid": 44, + "nodeType": "component" + }, + { + "iid": 45, + "nodeType": "component" + }, + { + "iid": 46, + "nodeType": "component" + }, + { + "iid": 47, + "nodeType": "component" + }, + { + "iid": 48, + "nodeType": "component" + }, + { + "iid": 49, + "nodeType": "component" + }, + { + "iid": 50, + "nodeType": "component" + }, + { + "iid": 51, + "nodeType": "component" + }, + { + "iid": 52, + "nodeType": "component" + }, + { + "iid": 53, + "nodeType": "component" + }, + { + "iid": 54, + "nodeType": "component" + }, + { + "iid": 55, + "nodeType": "component" + } + ] + } + ], + "createdBy": { + "provenance": "LDAP", + "username": "admin@itential", + "_id": "dfd1aac7ad36497ba805a4d5" + }, + "lastUpdatedBy": { + "provenance": "LDAP", + "username": "admin@itential", + "_id": "47459cf42be745ec9e074632" + }, + "created": "2026-09-15T00:00:00.000Z", + "lastUpdated": "2026-09-15T00:00:00.000Z", + "iid": 56, + "thumbnail": "", + "backgroundColor": "", + "referencedComponentHashes": [] +} \ No newline at end of file diff --git a/Tufin/SecureChange/OpenAPIs/tufin_securechange-25.2.json b/Tufin/SecureChange/OpenAPIs/tufin_securechange-25.2.json new file mode 100644 index 0000000..cac865e --- /dev/null +++ b/Tufin/SecureChange/OpenAPIs/tufin_securechange-25.2.json @@ -0,0 +1,23096 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Tufin SecureChange", + "description": "Tufin SecureChange network security change automation and workflow REST API.", + "version": "25.2" + }, + "servers": [ + { + "url": "https://{host}/securechangeworkflow/api", + "variables": { + "host": { + "default": "tufin.example.com" + } + } + } + ], + "security": [ + { + "basicAuth": [] + } + ], + "components": { + "securitySchemes": { + "basicAuth": { + "type": "http", + "scheme": "basic" + } + }, + "schemas": { + "ApplicationAccessRequestListDTO": { + "type": "object", + "properties": { + "application_access_request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationAccessRequestDTO" + }, + "description": "The application access requests" + } + } + }, + "ApplicationAccessRequestDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "action": { + "type": "string", + "description": "The action ,for GET api its - OPENED, DENIED, WAITING_TICKET, IN_TICKET, CONFIRMED, IMMEDIATE_CONFIRM, IMMEDIATE_DENIED" + }, + "server_group_name": { + "type": "string", + "description": "The server group name" + }, + "server_ip": { + "type": "string", + "description": "The server ip" + }, + "server_group_id": { + "type": "string", + "description": "The server group ID" + } + }, + "required": [ + "server_ip", + "server_group_id" + ] + }, + "any_service": { + "type": "object", + "properties": { + "min_protocol": { + "type": "integer", + "format": "int32" + }, + "max_protocol": { + "type": "integer", + "format": "int32" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "networkObjectVirtualServerDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name" + }, + "type": { + "type": "string", + "description": "The type" + }, + "port": { + "type": "string", + "description": "The port that the virtual server is forwarding (Any is shown as \"-1\")" + }, + "protocol": { + "type": "string", + "description": "The protocol that the virtual server is forwarding" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID" + }, + "netmask": { + "type": "string", + "description": "The netmask for the virtual server VIP address" + }, + "f5_device_name": { + "type": "string", + "description": "The name of the device" + }, + "virtual_ip": { + "type": "string", + "description": "The virtual IP address of the device" + }, + "pool_member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PoolMemberDTO" + }, + "description": "The server group members that are associated with the virtual server" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "multi_network_object": { + "type": "object", + "properties": { + "network_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectDTO" + }, + "description": "The list of network objects" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "network_object", + "name", + "read_only" + ] + }, + "RuleMetaDataDTO": { + "type": "object", + "properties": { + "last_modified": { + "type": "string" + }, + "application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SaApplicationDTO" + } + }, + "permissiveness_level": { + "$ref": "#/components/schemas/PermissivenessLevel" + }, + "violation": { + "type": "array", + "items": { + "type": "string" + } + }, + "last_hit": { + "type": "string" + }, + "shadowed_status": { + "$ref": "#/components/schemas/ShadowedStatus" + }, + "tech_owner": { + "type": "string" + }, + "ticket_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "rule_description": { + "type": "string" + }, + "expiration": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LocalDateTime" + } + }, + "legacy_rule": { + "type": "boolean" + }, + "stealth_rule": { + "type": "boolean" + }, + "business_owner": { + "type": "array", + "items": { + "type": "string" + } + }, + "rule_certification": { + "$ref": "#/components/schemas/RuleCertificationDTO" + } + } + }, + "ServerDecommissionRequestDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + }, + "order": { + "type": "string", + "description": "The order" + }, + "designer_result": { + "$ref": "#/components/schemas/DesignerDTO" + }, + "targets": { + "$ref": "#/components/schemas/multi_target" + }, + "verifier_result": { + "$ref": "#/components/schemas/verifier_results" + }, + "servers": { + "$ref": "#/components/schemas/MultiServerDTO" + }, + "impact_analysis_result": { + "$ref": "#/components/schemas/ImpactAnalysisDTO" + }, + "domain": { + "type": "string", + "description": "the name of the source domain" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "targets", + "servers", + "name", + "read_only" + ] + }, + "http_www.tufin.com_sc_policy_transport_service": { + "type": "object", + "properties": { + "port": { + "$ref": "#/components/schemas/RangeDTO" + }, + "protocol": { + "$ref": "#/components/schemas/Protocol" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "additional_parameter_group": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/additional_parameter" + } + }, + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RDVerifierError": { + "type": "object" + }, + "DomainDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the domain" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the domain" + }, + "description": { + "type": "string", + "description": "The description of the domain" + } + }, + "required": [ + "name", + "id", + "description" + ] + }, + "reply_comment": { + "type": "object", + "properties": { + "original_comment_id": { + "type": "integer", + "format": "int64", + "description": "The request comment id" + }, + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "LocalDate": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "format": "int32" + } + } + }, + "multi_text_field": { + "type": "object", + "properties": { + "text_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/text_field" + }, + "description": "The list of text fields" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "text_field", + "name", + "read_only" + ] + }, + "approve_reject": { + "type": "object", + "properties": { + "approved": { + "type": "string", + "description": "The approval or rejectionof the ticket" + }, + "reason": { + "type": "string", + "description": "The reason for approval or rejection" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "approved", + "reason", + "name", + "read_only" + ] + }, + "CommitResultsDTO": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/CommitReportStatus" + }, + "report": { + "$ref": "#/components/schemas/commit_commit_result_link" + } + } + }, + "TicketExternalDataDTO": { + "type": "object", + "properties": { + "request_id": { + "type": "string", + "description": "The request ID" + }, + "requester": { + "type": "string", + "description": "The requester" + } + } + }, + "RedesignStatusEnumDTO": { + "type": "object" + }, + "http_www.tufin.com_sc_policy_network_object_group": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "ConnectionFullResourcesListDTO": { + "type": "object", + "properties": { + "connection_extended": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionFullResourcesDTO" + }, + "description": "List of connections" + } + } + }, + "OpmRuleDTO": { + "type": "object", + "properties": { + "uid": { + "type": "string", + "description": "rule uid" + } + } + }, + "rule_decommission_verifier_result_link": { + "type": "object" + }, + "RelatedRulesBindingDTO": { + "type": "object", + "properties": { + "related_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedRuleContainerDTO" + } + } + } + }, + "PermissivenessLevel": { + "type": "object" + }, + "RuleCertificationStatus": { + "type": "object" + }, + "RoleDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the role" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the role" + }, + "role_link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "description": { + "type": "string", + "description": "The description of the role" + } + }, + "required": [ + "name", + "id" + ] + }, + "additional_parameter_nat_pool": { + "type": "object", + "properties": { + "nat_pool_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "account_ref": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The account ref name" + }, + "id": { + "type": "string", + "description": "The account ref ID" + }, + "cloud_vendor": { + "type": "string", + "description": "The account ref cloud vendor" + } + } + }, + "single_application": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "TicketDTO": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "The priority of the request" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the ticket" + }, + "status": { + "type": "string", + "description": "The status of the ticket" + }, + "application_details": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "comments": { + "$ref": "#/components/schemas/TicketCommentListDTO" + }, + "expiration_date": { + "type": "string", + "description": "Request is valid until this date" + }, + "subject": { + "type": "string", + "description": "The subject of the ticket" + }, + "referenced_ticket": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "requester": { + "type": "string", + "description": "The name of the requester" + }, + "create_date": { + "type": "string", + "format": "date-time", + "description": "The ticket creation date" + }, + "update_date": { + "type": "string", + "format": "date-time", + "description": "The ticket last update date" + }, + "close_date": { + "type": "string", + "format": "date-time", + "description": "The ticket close date" + }, + "notification_group": { + "$ref": "#/components/schemas/group" + }, + "sla_status": { + "type": "string", + "description": "The Tickets current SLA status" + }, + "sla_outcome": { + "type": "string", + "description": "The outcome of the SLA" + }, + "sla_tracking_state": { + "type": "string", + "description": "The Tickets current SLA tracking state" + }, + "steps": { + "$ref": "#/components/schemas/TicketStagesListDTO" + }, + "business_duration": { + "type": "integer", + "format": "int64", + "description": "The ticket business duration" + }, + "expiration_field_name": { + "type": "string", + "description": "The Request is required until" + }, + "expiration_status": { + "$ref": "#/components/schemas/ExpirationStatusDTO" + }, + "external_data": { + "$ref": "#/components/schemas/TicketExternalDataDTO" + }, + "current_step": { + "$ref": "#/components/schemas/TicketCurrentStageReferenceDTO" + }, + "workflow": { + "$ref": "#/components/schemas/WorkflowReferenceDTO" + }, + "domain_name": { + "type": "string", + "description": "The domain in which the ticket is posted" + }, + "requester_id": { + "type": "integer", + "format": "int64", + "description": "The user id which the ticket is created on behalf of (used for 'on-behalf' feature)" + }, + "application_changes": { + "$ref": "#/components/schemas/TicketApplicationChangeListDTO" + }, + "completion_details": { + "$ref": "#/components/schemas/CompletionDetailsDTO" + } + }, + "required": [ + "priority", + "subject", + "workflow", + "domain_name" + ] + }, + "multi_target": { + "type": "object", + "properties": { + "target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TargetDTO" + }, + "description": "The list of target objects" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "target", + "name", + "read_only" + ] + }, + "sa_network_object": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the network object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "RelatedRulesAccessRequestDTO": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedRulesDeviceDTO" + } + }, + "AR": { + "type": "integer", + "format": "int32" + } + } + }, + "http_www.tufin.com_sc_policy_subnet_network_object": { + "type": "object", + "properties": { + "ip": { + "type": "string" + }, + "netmask": { + "type": "string" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "labels": { + "type": "object", + "properties": { + "label": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The labels for the traffic flow" + } + } + }, + "TicketStageDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The step name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The step ID" + }, + "tasks": { + "$ref": "#/components/schemas/TicketTaskListDTO" + }, + "skipped": { + "type": "boolean", + "description": "whether the task was skipped" + }, + "redone": { + "type": "boolean", + "description": "whether the task was redone" + }, + "business_duration": { + "type": "integer", + "format": "int64", + "description": "The step business duration" + } + }, + "required": [ + "tasks" + ] + }, + "SubPolicyDTO": { + "type": "object", + "properties": { + "sub_policy_uid": { + "$ref": "#/components/schemas/UUID" + }, + "sub_policy_rule": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The rules related to the subpolicy" + }, + "sub_policy_name": { + "type": "string", + "description": "The name of the Inline Layer subpolicy" + } + }, + "required": [ + "sub_policy_uid", + "sub_policy_rule", + "sub_policy_name" + ] + }, + "DesignerBindingSuggestionsDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "binding_uid": { + "type": "string" + }, + "binding_name": { + "type": "string" + }, + "instruction": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerInstructionDTO" + }, + "description": "List of instructions" + } + } + }, + "MultiDestinationDTO": { + "type": "object", + "properties": { + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DestinationDTO" + }, + "description": "The destinations" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "destination", + "name", + "read_only" + ] + }, + "device_network_object": { + "type": "object", + "properties": { + "network_object": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_policy_network_object" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "Device Id" + }, + "status": { + "$ref": "#/components/schemas/StatusDTO" + } + }, + "required": [ + "device_id", + "status" + ] + }, + "multiple_selection": { + "type": "object", + "properties": { + "options": { + "$ref": "#/components/schemas/OptionItemListDTO" + }, + "selected_options": { + "$ref": "#/components/schemas/SelectedOptionItemListDTO" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "options", + "selected_options", + "name", + "read_only" + ] + }, + "single_service": { + "type": "object", + "properties": { + "port": { + "type": "string" + }, + "protocol": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "group_member_network_object": { + "type": "object", + "properties": { + "group_member": { + "$ref": "#/components/schemas/single_network_object" + }, + "group_member_path": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "transport_service": { + "type": "object", + "properties": { + "protocol": { + "type": "string", + "format": "int16" + }, + "max_port": { + "type": "integer", + "format": "int32" + }, + "min_port": { + "type": "integer", + "format": "int32" + }, + "cp_inspect_streaming_name": { + "type": "string" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "CompletionDetailsDTO": { + "type": "object", + "properties": { + "stepId": { + "type": "integer", + "format": "int64", + "description": "The completion step id " + } + } + }, + "RedesignStatusDTO": { + "type": "object" + }, + "text_area": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The text" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "text", + "name", + "read_only" + ] + }, + "ZoneType": { + "type": "object" + }, + "PartyDTOType": { + "type": "object" + }, + "SelectedOptionItemListDTO": { + "type": "object", + "properties": { + "selected_option": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptionItemDTO" + }, + "description": "The selected option" + } + }, + "required": [ + "selected_option" + ] + }, + "rule_recertification": { + "type": "object", + "properties": { + "rule_recertification_info": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rule_recertification_info" + } + }, + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_RuleOperationDeviceDTO" + }, + "description": "List of devices" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "device", + "name", + "read_only" + ] + }, + "ObjectReferenceUIDDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the referenced object" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + } + } + }, + "device_service_object": { + "type": "object", + "properties": { + "service_object": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_policy_service_object" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "Device Id" + }, + "status": { + "$ref": "#/components/schemas/StatusDTO" + } + }, + "required": [ + "device_id", + "status" + ] + }, + "Logger": { + "type": "object" + }, + "ConnectionChangeDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type of the change" + }, + "object_name": { + "type": "string", + "description": "the name of the changed object" + }, + "description": { + "type": "string", + "description": "the description of the change" + } + } + }, + "network_object_cell_modifications": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "network_object_cell_modification": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object_cell_modification" + } + } + } + }, + "group_member_service_object": { + "type": "object", + "properties": { + "group_member": { + "$ref": "#/components/schemas/single_service_object" + }, + "group_member_path": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "dip_nat_info": { + "type": "object", + "properties": { + "shift_from": { + "type": "string" + }, + "interface_name": { + "type": "string" + } + } + }, + "RequiredReason": { + "type": "object", + "properties": { + "key": { + "$ref": "#/components/schemas/RequiredReasonKeyDTO" + }, + "description": { + "type": "string", + "description": "The description of the required reason" + } + } + }, + "DurationFieldType": { + "type": "object" + }, + "checkbox": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The checkbox" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "value", + "name", + "read_only" + ] + }, + "Protocol": { + "type": "object" + }, + "host_network_object_with_interfaces": { + "type": "object", + "properties": { + "interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceForNetworkObjectDTO" + } + }, + "ip": { + "type": "string" + }, + "subnet_mask": { + "type": "string" + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "manager": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The input for email address of requester's manager. " + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "text", + "name", + "read_only" + ] + }, + "IpType": { + "type": "object", + "properties": { + "ipv6": { + "type": "boolean" + }, + "ipv4": { + "type": "boolean" + } + } + }, + "MembersListDTO": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartyDTO" + }, + "description": "The list of members" + }, + "partial_list": { + "type": "boolean", + "description": "Partial list; true if only a partial list is returned" + } + } + }, + "OpmDeviceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "device name" + }, + "item": { + "type": "array", + "items": { + "type": "string" + }, + "description": "device identifier path" + }, + "api_v1_Id": { + "type": "integer", + "format": "int32", + "description": "device api v1 id" + } + } + }, + "related_rules_related_rules_link": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/LinkDTO" + } + } + }, + "Referenced": { + "type": "object", + "properties": { + "xmlValue": { + "type": "string" + } + } + }, + "application_group": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "ObjectReferenceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the referenced object" + }, + "id": { + "type": "string", + "description": "ID" + }, + "type": { + "type": "string", + "description": "The type of the referenced object" + }, + "display_name": { + "type": "string", + "description": "The display name of the referenced object" + }, + "management_domain": { + "type": "string", + "description": "The management domain from which the referenced object comes from" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the referenced object" + }, + "ip": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FQDNIpDTO" + } + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of references to a DM_INLINE group members" + } + }, + "required": [ + "id" + ] + }, + "VerifierDeviceDTO": { + "type": "object", + "properties": { + "time": { + "$ref": "#/components/schemas/LocalTime" + }, + "date": { + "$ref": "#/components/schemas/LocalDate" + }, + "verifier_warning": { + "type": "string", + "description": "verifier warning" + }, + "verifier_error": { + "type": "string", + "description": "verifier error message" + }, + "verifier_error_code": { + "type": "string", + "description": "verifier error code" + }, + "verifier_binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifierBindingDTO" + }, + "description": "verifier bindings" + }, + "vendor": { + "type": "string", + "description": "vendor" + }, + "verification_status": { + "type": "string", + "description": "verification status" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "ID of management" + }, + "management_name": { + "type": "string", + "description": "name of management" + }, + "device_type": { + "$ref": "#/components/schemas/CpType" + }, + "revision_id": { + "type": "integer", + "format": "int32", + "description": "revision id" + }, + "vendor_type": { + "$ref": "#/components/schemas/VendorTypeDTO" + }, + "revision_number": { + "type": "integer", + "format": "int32", + "description": "revision number" + }, + "administrator": { + "type": "string", + "description": "name of administrator that made the change" + }, + "changed_on": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "management_ip": { + "type": "string", + "description": "ip of management" + }, + "received_on": { + "$ref": "#/components/schemas/LocalDateTime" + } + }, + "required": [ + "management_id", + "revision_id" + ] + }, + "VerifierOpmTargetDTO": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ResultDTO" + }, + "error": { + "$ref": "#/components/schemas/ErrorDTO" + }, + "requested_target": { + "type": "array", + "items": { + "type": "string" + }, + "description": "verifier opm requested target" + } + } + }, + "access_request_verifer_result_expanded": { + "type": "object", + "properties": { + "verifier_target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifierDeviceDTO" + }, + "description": "The targets verified" + }, + "verifier_opm_target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifierOpmTargetDTO" + }, + "description": "The opm targets verified" + }, + "topology_image_link": { + "$ref": "#/components/schemas/LinkDTO" + } + } + }, + "RelatedRulesResultDTO": { + "type": "object" + }, + "Map_String_String": { + "type": "object", + "properties": { + "entry": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Entry_String_String" + } + } + }, + "required": [ + "entry" + ] + }, + "multi_server_decommission_request": { + "type": "object", + "properties": { + "server_decommission_request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerDecommissionRequestDTO" + }, + "description": "The server decommission request" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "server_decommission_request", + "name", + "read_only" + ] + }, + "sa_service": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the service" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "TicketStagesListDTO": { + "type": "object", + "properties": { + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketStageDTO" + }, + "description": "The list of steps" + } + }, + "required": [ + "step" + ] + }, + "vip_nat_info": { + "type": "object", + "properties": { + "vip_mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VipMappingDTO" + } + }, + "interface_name": { + "type": "string" + } + } + }, + "additional_parameter_log_forwarding": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "check_point_nat_info": { + "type": "object", + "properties": { + "nat_type": { + "$ref": "#/components/schemas/NatType" + }, + "mapped_to_ip": { + "type": "string" + }, + "interface_name": { + "type": "string" + } + } + }, + "http_www.tufin.com_sc_subnet_network_object": { + "type": "object", + "properties": { + "mask": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "clone_server_policy_request": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + }, + "designer_result": { + "$ref": "#/components/schemas/DesignerDTO" + }, + "verifier_result": { + "$ref": "#/components/schemas/VerifierDTO" + }, + "from_server": { + "$ref": "#/components/schemas/NetworkObjectDTO" + }, + "to_servers": { + "$ref": "#/components/schemas/MultiServerDTO" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "from_server", + "to_servers", + "name", + "read_only" + ] + }, + "multi_hyperlink": { + "type": "object", + "properties": { + "hyperlink": { + "type": "array", + "items": { + "$ref": "#/components/schemas/hyperlink" + }, + "description": "The hyperlinks" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "hyperlink", + "name", + "read_only" + ] + }, + "ExternalRiskAnalysisResultDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The external risk's comment" + }, + "severity": { + "$ref": "#/components/schemas/RiskAnalysisSeverity" + }, + "status": { + "type": "string", + "description": "The external risk's status" + }, + "score": { + "type": "number", + "format": "double", + "description": "The external risk's score" + }, + "detailed_report_url": { + "type": "string", + "description": "The detailed_report_url of external risk" + } + }, + "required": [ + "comment", + "severity", + "status", + "score", + "detailed_report_url" + ] + }, + "RestrictedCellDTO": { + "type": "object", + "properties": { + "violatingServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "violatingApplications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInViolationDTO" + } + }, + "flow_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "flow_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "requirementServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "flow": { + "$ref": "#/components/schemas/FlowType" + }, + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + } + } + }, + "Comparator": { + "type": "object" + }, + "DeviceUserDTO": { + "type": "object", + "properties": { + "typeOnDevice": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "VipMappingDTO": { + "type": "object", + "properties": { + "mapped_to_ip": { + "type": "string" + }, + "virtual_port": { + "type": "string" + }, + "mapped_to_service": { + "$ref": "#/components/schemas/service" + } + } + }, + "VpnCommunityDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "internet_network_object": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RequiredReasonKeyDTO": { + "type": "object" + }, + "http_www.tufin.com_sc_policy_host_network_object": { + "type": "object", + "properties": { + "ip": { + "type": "string" + }, + "netmask": { + "type": "string" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "hostNetworkObjectDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the object" + }, + "ip": { + "type": "string", + "description": "The IP of the object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "PoolMemberDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the server group member" + }, + "ip": { + "type": "string", + "description": "The IP address of the server group member" + }, + "netmask": { + "type": "string", + "description": "The netmask for the IP address of the server group member" + } + } + }, + "clone_server_policy_verifer_result_expanded": { + "type": "object", + "properties": { + "cannot_compute_reason": { + "type": "string", + "description": "cannot compute reason error message" + }, + "verifier_target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerCloneVerificationDeviceDTO" + }, + "description": "The targets verified" + } + } + }, + "designer_link_result_link": { + "type": "object" + }, + "ResultDTO": { + "type": "object", + "properties": { + "version": { + "$ref": "#/components/schemas/VersionDTO" + }, + "device": { + "$ref": "#/components/schemas/OpmDeviceDTO" + }, + "combined_policy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "verifier combined policies result" + } + } + }, + "hyperlink": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "The Url" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "url", + "name", + "read_only" + ] + }, + "LinkDTO": { + "type": "object", + "properties": { + "@href": { + "type": "string", + "description": "The location of the referenced object" + } + }, + "required": [ + "@href" + ] + }, + "url_category": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "comment": { + "type": "string" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int32" + }, + "overrides": { + "type": "boolean" + }, + "overridden": { + "type": "boolean" + }, + "urls": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "unmatched_private_address_violation": { + "type": "object", + "properties": { + "violation_source_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The violating source network objects" + }, + "violation_destination_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The violating destination network objects" + }, + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "unmatched_private_address_violation_Applications": { + "type": "object", + "properties": { + "source_in_violation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "destination_in_violation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "TicketApplicationChangeListDTO": { + "type": "object", + "properties": { + "application_change": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketApplicationChangeDTO" + }, + "description": "The application changes list" + } + }, + "required": [ + "application_change" + ] + }, + "ServerGroupChange": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type of the change" + }, + "affected_connections": { + "type": "string", + "description": "affected connections" + }, + "object_name": { + "type": "string", + "description": "the name of the changed object" + }, + "description": { + "type": "string", + "description": "the description of the change" + } + } + }, + "CombinedPolicyDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "combined policy name" + }, + "result": { + "$ref": "#/components/schemas/CombinedPolicyResultDTO" + }, + "verification_status": { + "type": "string", + "description": "verification status" + } + } + }, + "GroupMemberNetworkObjectDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + }, + "status": { + "type": "string", + "description": "Group member's status" + }, + "object_updated_status": { + "type": "string", + "description": "Object status" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "status", + "name", + "read_only" + ] + }, + "users": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of users" + } + } + }, + "VerifierBindingDTO": { + "type": "object", + "properties": { + "implementing_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "description": "implementing rules for specific device binding" + }, + "violating_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "description": "violating rules for specific device binding" + }, + "verifier_warning": { + "type": "string", + "description": "warning" + }, + "verified": { + "type": "boolean", + "description": "whether binding is verified" + }, + "percent_implemented": { + "type": "number", + "format": "double", + "description": "implementation percent" + }, + "implementation_percentage_threshold": { + "type": "number", + "format": "double", + "description": "original threshold percent" + }, + "verifier_error": { + "type": "string", + "description": "verifier error message" + }, + "handled_by_implicit_cleanup_rule": { + "$ref": "#/components/schemas/RuleTrafficHandling" + }, + "verifier_error_code": { + "type": "string", + "description": "verifier error code" + }, + "binding": { + "$ref": "#/components/schemas/Binding_DTO" + } + } + }, + "networkObjectGroupDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type" + }, + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The members" + }, + "type_on_device": { + "type": "string", + "description": "type_on_device" + }, + "access_allowed": { + "type": "boolean", + "description": "access allowed" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "member", + "access_allowed", + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "http_www.tufin.com_sc_interface_ip": { + "type": "object", + "properties": { + "visibility": { + "type": "string", + "description": "Interface visibility" + }, + "ip": { + "type": "string", + "description": "interface Ip" + }, + "primary": { + "type": "boolean", + "description": "Indication if interface is primary" + } + }, + "required": [ + "visibility", + "ip", + "primary" + ] + }, + "security_zone_matrix_violation": { + "type": "object", + "properties": { + "security_zone_matrix": { + "$ref": "#/components/schemas/security_zone_matrix" + }, + "matrix_cell_violation": { + "$ref": "#/components/schemas/MatrixCellDTO" + }, + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "InterfaceIpDTO": { + "type": "object", + "properties": { + "visibility": { + "type": "string", + "description": "Object visibility" + }, + "ip": { + "type": "string", + "description": "Object IP" + }, + "subnet_mask": { + "type": "string", + "description": "Object subnet mask" + }, + "precedence": { + "type": "string", + "description": "Object precedence" + }, + "vendor_attachment_policy": { + "type": "string" + } + }, + "required": [ + "visibility", + "ip", + "subnet_mask", + "precedence" + ] + }, + "single_service_object": { + "type": "object", + "properties": { + "uid": { + "type": "string" + }, + "management_id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + } + } + }, + "network_object_cell_modification": { + "type": "object", + "properties": { + "device_network_object": { + "$ref": "#/components/schemas/device_network_object" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "action": { + "$ref": "#/components/schemas/Action" + } + }, + "required": [ + "device_network_object", + "action" + ] + }, + "TargetDTO": { + "type": "object", + "properties": { + "external_uid": { + "type": "string", + "description": "The external uid" + }, + "external_parent_uid": { + "type": "string", + "description": "The external parent uid" + }, + "tenant_id": { + "type": "string", + "description": "The tenant id" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "SlimRuleDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "rule name" + }, + "comment": { + "type": "string", + "description": "rule comment" + }, + "option": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleOption" + }, + "description": "options" + }, + "is_disabled": { + "type": "boolean", + "description": "is disabled" + }, + "uid": { + "type": "string", + "description": "rule uid" + }, + "action": { + "$ref": "#/components/schemas/RuleAction" + }, + "ruleNumber": { + "type": "integer", + "format": "int64", + "description": "rule number" + }, + "displayRuleNumber": { + "type": "string", + "description": "display_rule_number" + }, + "sourceNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "source networks" + }, + "destinationNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "destination networks" + }, + "destinationServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "destination services" + }, + "sourceServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "source services" + }, + "applications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + }, + "description": "application" + }, + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUserDTO" + }, + "description": "users" + }, + "additional_parameter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/additional_parameter" + }, + "description": "additional parameters" + }, + "url_category": { + "type": "array", + "items": { + "$ref": "#/components/schemas/url_category" + }, + "description": "url categories" + }, + "install_on": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "install on" + }, + "time": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TimeDTO" + }, + "description": "time" + }, + "community": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VpnCommunityDTO" + }, + "description": "communities" + }, + "track": { + "$ref": "#/components/schemas/RuleTrackDTO" + }, + "sub_policy": { + "$ref": "#/components/schemas/SubPolicyDTO" + }, + "rule_location": { + "type": "string", + "description": "rule_location" + }, + "negatedDestination": { + "type": "boolean", + "description": "The destination is negated" + }, + "negatedDestinationService": { + "type": "boolean", + "description": "The destination service is negated" + }, + "negatedSource": { + "type": "boolean", + "description": "The source is negated" + }, + "negatedSourceService": { + "type": "boolean", + "description": "The source service is negated" + }, + "from_zone": { + "type": "string", + "description": "from_zone" + }, + "to_zone": { + "type": "string", + "description": "to_zone" + } + } + }, + "http_www.tufin.com_sc_policy_host_network_object_with_interfaces": { + "type": "object", + "properties": { + "ip": { + "type": "string" + }, + "netmask": { + "type": "string" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "LocalDateTime": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "format": "int32" + } + } + }, + "compliance_policies": { + "type": "object", + "properties": { + "compliance_policy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CompliancePolicyDTO" + }, + "description": "The compliance policy for the risk" + } + } + }, + "decertify": { + "type": "object", + "properties": { + "binding__uid": { + "type": "string" + }, + "rule_uid": { + "type": "string" + }, + "update_status": { + "type": "string" + }, + "business_owner": { + "type": "string" + }, + "business_owner_email": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "binding__uid", + "rule_uid", + "update_status" + ] + }, + "modify_rule_modification": { + "type": "object", + "properties": { + "source_modifications": { + "$ref": "#/components/schemas/network_object_cell_modifications" + }, + "destination_modifications": { + "$ref": "#/components/schemas/network_object_cell_modifications" + }, + "service_modifications": { + "$ref": "#/components/schemas/service_object_cell_modifications" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "Rule modification ID" + }, + "rule_key": { + "$ref": "#/components/schemas/rule_key" + } + }, + "required": [ + "rule_key" + ] + }, + "OptionItemDTO": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Option value" + }, + "errorMsg": { + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "TicketCommentDTO": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "ViolationDTO": { + "type": "object", + "properties": { + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "ExpirationStatusDTO": { + "type": "object" + }, + "FQDNIpDTO": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "ipType": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "subnetMask": { + "type": "string" + } + } + }, + "OptionItemListDTO": { + "type": "object", + "properties": { + "option": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptionItemDTO" + }, + "description": "The option" + } + }, + "required": [ + "option" + ] + }, + "ServerCloneVerificationBindingDTO": { + "type": "object", + "properties": { + "rule_implemented": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerCloneVerificationSlimRuleDTO" + }, + "description": "implementing rules for specific device binding" + }, + "rule_not_implemented": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerCloneVerificationNotImplementedSlimRuleDTO" + }, + "description": "not implementing rules for specific device binding" + }, + "binding": { + "$ref": "#/components/schemas/Binding_DTO" + } + } + }, + "ServerCloneVerificationNotImplementedSlimRuleDTO": { + "type": "object", + "properties": { + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "rule's not implemented ip list" + }, + "object_name": { + "type": "array", + "items": { + "type": "string" + }, + "description": "overridden and overriding object name list" + }, + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "from_server": { + "$ref": "#/components/schemas/MarkedNetworkObjectsDTO" + }, + "to_servers": { + "$ref": "#/components/schemas/MarkedNetworkObjectsDTO" + } + } + }, + "ldap_entity": { + "type": "object", + "properties": { + "ldap_id": { + "type": "string" + }, + "ldap_dn": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "ServerDTO": { + "type": "object", + "properties": { + "host_name": { + "type": "string", + "description": "host name" + }, + "region": { + "type": "string", + "description": "region" + }, + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The external resource reference ips" + }, + "cidr": { + "type": "string", + "format": "int16", + "description": "cidr" + }, + "netmask": { + "type": "string", + "description": "netmask" + }, + "ip_address": { + "type": "string", + "description": "ip address" + }, + "range_first_ip": { + "type": "string", + "description": "min ip" + }, + "range_last_ip": { + "type": "string", + "description": "max ip" + }, + "nat_ip_address": { + "type": "string", + "description": "nat ip address" + }, + "dns_ip_addresses": { + "$ref": "#/components/schemas/MultiDnsIpAddressDTO" + }, + "nat_netmask": { + "type": "string", + "description": "nat netmask" + }, + "nat_cidr": { + "type": "string", + "format": "int16", + "description": "nat cidr" + }, + "resource_ref": { + "$ref": "#/components/schemas/resource_ref" + }, + "account_ref": { + "$ref": "#/components/schemas/account_ref" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "userObjectDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the user object" + }, + "ip": { + "type": "string", + "description": "The IP of the user object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "additional_parameter_security_profile": { + "type": "object", + "properties": { + "security_profile_category": { + "type": "string" + }, + "description": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "MultiSourceDTO": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SourceDTO" + }, + "description": "The sources" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "source", + "name", + "read_only" + ] + }, + "change_group_zone_object_scope": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Zone name" + }, + "is_global": { + "type": "boolean", + "description": "Is a global zone" + } + }, + "required": [ + "name", + "is_global" + ] + }, + "NetworkObjectInViolationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "RDVerificationRulesDTO": { + "type": "object", + "properties": { + "rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "description": "rules" + }, + "status": { + "type": "string" + } + } + }, + "ConnectionFullResourcesDTO": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of source's objects" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of destination's objects" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_service" + }, + "description": "List of service's objects" + }, + "status": { + "type": "string", + "description": "The status" + }, + "external": { + "type": "boolean", + "description": "is external" + }, + "connection_to_application": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "uid": { + "type": "string", + "description": "The UID" + }, + "applicationId": { + "type": "string" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The opened tickets" + } + }, + "required": [ + "name" + ] + }, + "service_object_cell_modification": { + "type": "object", + "properties": { + "device_service_object": { + "$ref": "#/components/schemas/device_service_object" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "action": { + "$ref": "#/components/schemas/Action" + } + }, + "required": [ + "device_service_object", + "action" + ] + }, + "AdminDomainDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "verifier_results": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "server decommission tool result status" + }, + "partial_result": { + "type": "boolean", + "description": "server decommission tool result is partial because ticket's rules quota was exceeded" + }, + "cannotComputeReason": { + "type": "string", + "description": "reason why server decommission tool could not compute" + }, + "result": { + "$ref": "#/components/schemas/DecommissionResultDTO" + } + } + }, + "VersionDTO": { + "type": "object", + "properties": { + "timestamp": { + "type": "string", + "description": "version timestamp" + } + } + }, + "ServiceChange": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type of the change" + }, + "affected_connections": { + "type": "string", + "description": "affected connections" + }, + "object_name": { + "type": "string", + "description": "the name of the changed object" + }, + "description": { + "type": "string", + "description": "the description of the change" + } + } + }, + "RDVerifierDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message" + }, + "status": { + "type": "string", + "description": "The status (whether it is verified or not)" + }, + "result": { + "$ref": "#/components/schemas/VerifierResultDTO" + }, + "reason": { + "$ref": "#/components/schemas/void" + } + } + }, + "icmp_service": { + "type": "object", + "properties": { + "min_icmp_type": { + "type": "integer", + "format": "int32" + }, + "max_icmp_type": { + "type": "integer", + "format": "int32" + }, + "icmp_code": { + "type": "integer", + "format": "int32" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RequestedTargetDTO": { + "type": "object", + "properties": { + "device": { + "$ref": "#/components/schemas/OpmDeviceDTO" + } + } + }, + "HostNetworkObjectWithInterfacesDTO": { + "type": "object", + "properties": { + "interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_interface_for_network_object" + }, + "description": "List of interfaces" + }, + "type": { + "type": "string", + "description": "The type of the object" + }, + "ip": { + "type": "string", + "description": "The IP of the object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "interface", + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "service_group": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service" + } + }, + "cisco_group_type": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "http_www.tufin.com_sc_any_service": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "service_object_cell_modifications": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "service_object_cell_modification": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service_object_cell_modification" + } + } + } + }, + "http_www.tufin.com_sc_url_category": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "PolicyZoneDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ZoneType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "global": { + "type": "boolean" + }, + "address_book": { + "type": "string" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "zone_name_in_parent": { + "type": "string" + } + } + }, + "vmInstanceDTO": { + "type": "object", + "properties": { + "host_name": { + "type": "string", + "description": "VM Instance host name" + }, + "status": { + "type": "string", + "description": "VM Instance state" + }, + "device_info": { + "$ref": "#/components/schemas/sa_device" + }, + "ip": { + "type": "string", + "description": "The IP of the object" + }, + "security_group": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CloudSecurityGroupDTO" + }, + "description": "List of security groups" + }, + "instance_type": { + "type": "string", + "description": "VM Instance type" + }, + "availability_zone": { + "type": "string", + "description": "VM Instance availability zone" + }, + "tags": { + "type": "string", + "format": "map", + "description": "VM Instance tags" + }, + "vendor": { + "type": "string", + "description": "VM Instance vendor" + }, + "instance_id": { + "type": "string", + "description": "VM Instance ID" + }, + "interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_interface_for_network_object" + }, + "description": "List of interfaces" + }, + "type": { + "type": "string", + "description": "The type of the object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "host_name", + "status", + "device_info", + "security_group", + "instance_type", + "availability_zone", + "tags", + "vendor", + "instance_id", + "interface", + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "TicketCommentListDTO": { + "type": "object", + "properties": { + "comment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketCommentDTO" + }, + "description": "The comment" + } + } + }, + "service": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "ItemDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "item name" + } + } + }, + "provisioning_provisioning_result_link": { + "type": "object" + }, + "TicketTaskFieldDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "ApplicationConnectionListDTO": { + "type": "object", + "properties": { + "connection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionDTO" + } + } + } + }, + "MarkedObjectsDTO": { + "type": "object", + "properties": { + "uid": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GroupMemberNetworkObjectListDTO": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GroupMemberNetworkObjectDTO" + }, + "description": "The members to change or add to the selected group" + } + }, + "required": [ + "member" + ] + }, + "time": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The time" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "value", + "name", + "read_only" + ] + }, + "range_network_object": { + "type": "object", + "properties": { + "max_ip": { + "type": "string" + }, + "min_ip": { + "type": "string" + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "applications": { + "type": "object", + "properties": { + "application": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The applications" + } + } + }, + "http_www.tufin.com_sc_policy_network_object": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "ApplicationDTO": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RiskDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message" + }, + "status": { + "type": "string", + "description": "The risk's status" + }, + "external_risk_analysis": { + "$ref": "#/components/schemas/ExternalRiskAnalysisResultDTO" + }, + "security_policy_violations": { + "$ref": "#/components/schemas/SecurityPolicyViolationDTO" + }, + "compliance_policies": { + "$ref": "#/components/schemas/compliance_policies" + }, + "compliance_and_usp_status": { + "type": "string" + }, + "reason": { + "type": "string", + "description": "The reason for the risk" + } + } + }, + "request_comment": { + "type": "object", + "properties": { + "task_id": { + "type": "integer", + "format": "int64", + "description": "The task id" + }, + "from_user_id": { + "type": "integer", + "format": "int64", + "description": "The responder user id" + }, + "replied": { + "type": "boolean", + "description": "The replied status" + }, + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "access_request_verifier_result_link": { + "type": "object" + }, + "ConnectionDTO": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of source's objects ref" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of destination's objects ref" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of service's objects ref" + }, + "status": { + "type": "string", + "description": "The status" + }, + "external": { + "type": "boolean", + "description": "is external" + }, + "connection_to_application": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "uid": { + "type": "string", + "description": "The UID" + }, + "applicationId": { + "type": "string" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The opened tickets" + } + }, + "required": [ + "name" + ] + }, + "ServiceDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "port": { + "type": "string", + "description": "port" + }, + "protocol": { + "type": "string", + "description": "protocol" + }, + "application_name": { + "type": "string", + "description": "application name" + }, + "non_default_ports": { + "type": "boolean", + "description": "The application identity includes non-default services" + }, + "predefined_name": { + "type": "string", + "description": "predefined name" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceDTO" + }, + "description": "application services" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "single_network_object": { + "type": "object", + "properties": { + "uid": { + "type": "string" + }, + "management_id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + } + } + }, + "multi_service": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceDTO" + }, + "description": "The services" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "service", + "name", + "read_only" + ] + }, + "UnlicensedDevicesForAutomationDTO": { + "type": "object", + "properties": { + "unlicensed_device_for_automation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "unlicensed devices for automation" + } + } + }, + "NetworkObjectDTO": { + "type": "object", + "properties": { + "host_name": { + "type": "string", + "description": "host name" + }, + "region": { + "type": "string", + "description": "region" + }, + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The external resource reference ips" + }, + "cidr": { + "type": "string", + "format": "int16", + "description": "cidr" + }, + "netmask": { + "type": "string", + "description": "netmask" + }, + "ip_address": { + "type": "string", + "description": "ip address" + }, + "range_first_ip": { + "type": "string", + "description": "min ip" + }, + "range_last_ip": { + "type": "string", + "description": "max ip" + }, + "nat_ip_address": { + "type": "string", + "description": "nat ip address" + }, + "dns_ip_addresses": { + "$ref": "#/components/schemas/MultiDnsIpAddressDTO" + }, + "nat_netmask": { + "type": "string", + "description": "nat netmask" + }, + "nat_cidr": { + "type": "string", + "format": "int16", + "description": "nat cidr" + }, + "resource_ref": { + "$ref": "#/components/schemas/resource_ref" + }, + "account_ref": { + "$ref": "#/components/schemas/account_ref" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "rangeNetworkObjectDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type" + }, + "last_ip": { + "type": "string", + "description": "Max ip" + }, + "first_ip": { + "type": "string", + "description": "Min ip" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "confirm_comment": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "RuleTrafficHandling": { + "type": "object" + }, + "rpc_service": { + "type": "object", + "properties": { + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "rule_key": { + "type": "object", + "properties": { + "binding_uid": { + "type": "string", + "description": "Rule binding UID" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "Rule device ID" + }, + "rule_uid": { + "type": "string", + "description": "Rule UID" + } + }, + "required": [ + "binding_uid", + "device_id", + "rule_uid" + ] + }, + "access_request_designer_result_expanded": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "redesign_status": { + "$ref": "#/components/schemas/RedesignStatusDTO" + }, + "device_suggestion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerDeviceSuggestionsDTO" + }, + "description": "List of devices to change" + }, + "error_description": { + "type": "string", + "description": "error description" + } + } + }, + "drop_down_list": { + "type": "object", + "properties": { + "options": { + "$ref": "#/components/schemas/OptionItemListDTO" + }, + "selection": { + "type": "string", + "description": "The selected options" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "options", + "selection", + "name", + "read_only" + ] + }, + "ip_network_object": { + "type": "object", + "properties": { + "mask": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "additional_parameter_tag": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RelatedRulesDeviceDTO": { + "type": "object", + "properties": { + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedRulesBindingDTO" + } + }, + "management_id": { + "type": "integer", + "format": "int32" + } + } + }, + "host_network_object": { + "type": "object", + "properties": { + "ip": { + "type": "string" + }, + "subnet_mask": { + "type": "string" + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "JavaLangAccess": { + "type": "object" + }, + "install_on_network_object": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "LocalTime": { + "type": "object" + }, + "ServiceInViolationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "http_www.tufin.com_sc_policy_service_group": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "InterfaceIpListDTO": { + "type": "object", + "properties": { + "interface_ip": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceIpDTO" + }, + "description": "Interface IPs" + } + }, + "required": [ + "interface_ip" + ] + }, + "CombinedPolicyResultDTO": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/ErrorDTO" + }, + "implementing": { + "$ref": "#/components/schemas/CombinedPolicyRulesResultDTO" + }, + "violating": { + "$ref": "#/components/schemas/CombinedPolicyRulesResultDTO" + } + } + }, + "RuleTrackDTO": { + "type": "object", + "properties": { + "track_level": { + "$ref": "#/components/schemas/RuleTrackLevel" + }, + "track_interval": { + "type": "integer", + "format": "int32" + } + } + }, + "reassign_comment": { + "type": "object", + "properties": { + "task_id": { + "type": "integer", + "format": "int64", + "description": "The task id" + }, + "assignee_id": { + "type": "integer", + "format": "int64", + "description": "The assignee id" + }, + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "additional_parameter": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "multi_group_change": { + "type": "object", + "properties": { + "group_change": { + "type": "array", + "items": { + "$ref": "#/components/schemas/group_change" + }, + "description": "The groups to modify" + }, + "designer_result": { + "$ref": "#/components/schemas/DesignerDTO" + }, + "implementation_status": { + "type": "string", + "description": "The implementation status" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "group_change", + "implementation_status", + "name", + "read_only" + ] + }, + "ServerCloneVerificationSlimRuleDTO": { + "type": "object", + "properties": { + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "from_server": { + "$ref": "#/components/schemas/MarkedNetworkObjectsDTO" + }, + "to_servers": { + "$ref": "#/components/schemas/MarkedNetworkObjectsDTO" + } + } + }, + "PermissionDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the permission" + }, + "value": { + "type": "boolean", + "description": "The permission setting" + }, + "key": { + "type": "string", + "description": "The Enum that represents the permission" + } + }, + "required": [ + "name", + "value" + ] + }, + "ServerCloneVerificationDeviceDTO": { + "type": "object", + "properties": { + "verifier_binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerCloneVerificationBindingDTO" + }, + "description": "verifier bindings" + }, + "vendor": { + "type": "string", + "description": "vendor" + }, + "verification_status": { + "type": "string", + "description": "verification status" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "ID of management" + }, + "management_name": { + "type": "string", + "description": "name of management" + }, + "device_type": { + "$ref": "#/components/schemas/CpType" + }, + "revision_id": { + "type": "integer", + "format": "int32", + "description": "revision id" + }, + "vendor_type": { + "$ref": "#/components/schemas/VendorTypeDTO" + }, + "revision_number": { + "type": "integer", + "format": "int32", + "description": "revision number" + }, + "administrator": { + "type": "string", + "description": "name of administrator that made the change" + }, + "changed_on": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "management_ip": { + "type": "string", + "description": "ip of management" + }, + "received_on": { + "$ref": "#/components/schemas/LocalDateTime" + } + }, + "required": [ + "management_id", + "revision_id" + ] + }, + "DesignerDTO": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "partial_result": { + "type": "boolean" + }, + "cannot_compute_reason": { + "type": "string" + }, + "warning_massage": { + "type": "string" + }, + "result": { + "$ref": "#/components/schemas/DesignerResultDTO" + }, + "opm_result": { + "$ref": "#/components/schemas/DesignerResultDTO" + }, + "opm_provisioning_result": { + "$ref": "#/components/schemas/DesignerResultDTO" + } + } + }, + "related_rules_related_rules_expanded": { + "type": "object", + "properties": { + "access_request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedRulesAccessRequestDTO" + } + } + } + }, + "reopen_comment": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "serviceGroupDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type" + }, + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of references to the service group members" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "type", + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "CloudSecurityGroupDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of security group" + }, + "uid": { + "type": "string", + "description": "UID of the security group" + } + }, + "required": [ + "uid" + ] + }, + "DesignerPersistedCommandDTO": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "push status" + }, + "order": { + "type": "integer", + "format": "int32" + }, + "command": { + "type": "string" + }, + "failure_reason": { + "type": "string", + "description": "in case that push failed" + } + } + }, + "http_www.tufin.com_sc_policy_range_network_object": { + "type": "object", + "properties": { + "max_ip": { + "type": "string" + }, + "min_ip": { + "type": "string" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "subnetNetworkObjectDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type" + }, + "prefix": { + "type": "string", + "description": "The prefix" + }, + "ip": { + "type": "string", + "description": "The ip" + }, + "netmask": { + "type": "string", + "description": "The netmask" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "fortigate_nat_info": { + "type": "object", + "properties": { + "port_forwarding_type": { + "type": "string", + "description": "port_forwarding_type" + }, + "src_filter": { + "type": "string", + "description": "src_filter" + }, + "src_interface_filter": { + "type": "string", + "description": "src_interface_filter" + }, + "Interface": { + "type": "string", + "description": "Interface" + }, + "mapped-ip": { + "type": "string", + "description": "mapped-ip" + }, + "mapped-ip-max": { + "type": "string", + "description": "mapped-ip-max" + }, + "external-port": { + "type": "string", + "description": "external-port" + }, + "mapped-port": { + "type": "string", + "description": "mapped-port" + }, + "forti_vip": { + "type": "boolean", + "description": "forti_vip" + }, + "interface_name": { + "type": "string" + } + } + }, + "behind_interface_nat": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "http_www.tufin.com_sc_interface_for_network_object": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Interface name" + }, + "interface_ip": { + "type": "array", + "items": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_interface_ip" + }, + "description": "List of interface ips" + } + }, + "required": [ + "name", + "interface_ip" + ] + }, + "TicketCurrentStageReferenceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The current step name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The current step id" + } + } + }, + "VerifierDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message" + }, + "status": { + "type": "string", + "description": "The status (whether it is verified or not)" + }, + "result": { + "$ref": "#/components/schemas/VerifierResultDTO" + }, + "reason": { + "$ref": "#/components/schemas/void" + } + } + }, + "RolesListDTO": { + "type": "object", + "properties": { + "role": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RoleDTO" + }, + "description": "The list of roles of the user" + } + }, + "required": [ + "role" + ] + }, + "RuleAction": { + "type": "object" + }, + "TicketTaskListDTO": { + "type": "object", + "properties": { + "task": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketTaskDTO" + }, + "description": "The list of tasks" + } + }, + "required": [ + "task" + ] + }, + "ImpactAnalysisDTO": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "server decommission tool result status" + }, + "partial_result": { + "type": "boolean", + "description": "server decommission tool result is partial because ticket's rules quota was exceeded" + }, + "cannotComputeReason": { + "type": "string", + "description": "reason why server decommission tool could not compute" + }, + "result": { + "$ref": "#/components/schemas/DecommissionResultDTO" + } + } + }, + "group_change": { + "type": "object", + "properties": { + "members": { + "$ref": "#/components/schemas/GroupMemberNetworkObjectListDTO" + }, + "zone": { + "$ref": "#/components/schemas/change_group_zone_object_scope" + }, + "address_book": { + "$ref": "#/components/schemas/AddressBookDTO" + }, + "failure_reason": { + "type": "string", + "description": "The failure reason" + }, + "change_action": { + "type": "string", + "description": "The group action" + }, + "change_implementation_status": { + "type": "string", + "description": "The status of the change request" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "members", + "zone", + "address_book", + "failure_reason", + "change_action", + "name", + "read_only" + ] + }, + "MembersOfListDTO": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartyDTO" + }, + "description": "The group to which the user belongs" + } + } + }, + "ComplianceRuleListDTO": { + "type": "object", + "properties": { + "compliance_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ComplianceRuleDTO" + }, + "description": "The list of compliance policy rules" + } + } + }, + "CommitReportStatus": { + "type": "object" + }, + "TimeDTO": { + "type": "object", + "properties": { + "month": { + "type": "string" + }, + "days": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "comments": { + "type": "string" + }, + "end_period": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "start_period": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "month_days": { + "type": "string" + }, + "time_interval_from1": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_from2": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_from3": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_to1": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_to2": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_to3": { + "$ref": "#/components/schemas/LocalTime" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "MarkedNetworkObjectsDTO": { + "type": "object", + "properties": { + "uid": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "commit_commit_result_link": { + "type": "object" + }, + "ServerChange": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type of the change" + }, + "affected_connections": { + "type": "string", + "description": "affected connections" + }, + "object_name": { + "type": "string", + "description": "the name of the changed object" + }, + "description": { + "type": "string", + "description": "the description of the change" + } + } + }, + "subnet_network_object": { + "type": "object", + "properties": { + "ip": { + "type": "string" + }, + "subnet_mask": { + "type": "string" + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RDVerifierBindingDTO": { + "type": "object", + "properties": { + "binding_name": { + "type": "string", + "description": "binding name" + }, + "binding_uid": { + "type": "string", + "description": "binding uid" + }, + "implemented_rules": { + "$ref": "#/components/schemas/RDVerificationRulesDTO" + }, + "violated_rules_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RDVerificationRulesDTO" + }, + "description": "violated rules lists" + } + } + }, + "RuleOption": { + "type": "object" + }, + "DesignerInstructionDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "content": { + "type": "string" + }, + "error_message": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "status": { + "type": "string" + }, + "rule_uid": { + "type": "string" + }, + "warning_message": { + "type": "string" + }, + "tag": { + "type": "array", + "items": { + "type": "string" + } + }, + "instruction_type": { + "type": "string" + }, + "rule_order": { + "type": "string" + }, + "rule_placement": { + "type": "string" + }, + "implementation_failure_reason": { + "type": "string" + }, + "requested_network_object_name": { + "type": "string" + }, + "requested_service_object_name": { + "type": "string" + }, + "rule_name": { + "type": "string" + }, + "original_shadowed_rule_num": { + "type": "integer", + "format": "int64" + }, + "original_shadowed_rule_name": { + "type": "string" + }, + "security_group": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityGroupDTO" + } + }, + "application_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + } + }, + "display_rule_order": { + "type": "string" + }, + "log_forwarding_profile": { + "type": "string" + }, + "source_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "destination_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "service_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service" + } + }, + "modified_object_name": { + "type": "string" + }, + "order": { + "type": "array", + "items": { + "type": "string" + } + }, + "modified_object_uid": { + "type": "string" + }, + "change_action": { + "type": "string" + }, + "before_global": { + "type": "boolean" + }, + "security_profile_group": { + "type": "string" + }, + "implementing_access_request": { + "type": "string" + }, + "url_category_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/url_category" + } + }, + "device_added_network_object": { + "$ref": "#/components/schemas/network_object" + }, + "device_added_service_object": { + "$ref": "#/components/schemas/service" + }, + "device_removed_network_object": { + "$ref": "#/components/schemas/network_object" + }, + "device_removed_service_object": { + "$ref": "#/components/schemas/service" + }, + "before_section": { + "type": "boolean" + }, + "device_modified_network_object": { + "$ref": "#/components/schemas/network_object" + }, + "device_modified_service_object": { + "$ref": "#/components/schemas/service" + }, + "modified_field": { + "type": "array", + "items": { + "type": "string" + } + }, + "device_added_user_object": { + "$ref": "#/components/schemas/DeviceUserDTO" + }, + "requested_user_object_name": { + "type": "string" + }, + "user_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUserDTO" + } + } + } + }, + "security_zone_matrix": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "RiskAnalysisSeverity": { + "type": "object" + }, + "rule_modification_field": { + "type": "object", + "properties": { + "designer_result": { + "$ref": "#/components/schemas/DesignerDTO" + }, + "rule_modification": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rule_modification" + }, + "description": "List of rule modifications" + }, + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_RuleOperationDeviceDTO" + }, + "description": "List of devices" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "device", + "name", + "read_only" + ] + }, + "reject_comment": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "VerifierResultDTO": { + "type": "object" + }, + "BaseServiceDTO": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RedesignNotRequiredStatus": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/RedesignStatusEnumDTO" + } + } + }, + "multi_text_area": { + "type": "object", + "properties": { + "text_area": { + "type": "array", + "items": { + "$ref": "#/components/schemas/text_area" + }, + "description": "The text area" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "text_area", + "name", + "read_only" + ] + }, + "http_www.tufin.com_sc_any_network_object": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "clone_server_policy_verifier_result_link": { + "type": "object" + }, + "any_network_object": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RangeDTO": { + "type": "object", + "properties": { + "from": { + "type": "integer", + "format": "int32" + }, + "to": { + "type": "integer", + "format": "int32" + } + } + }, + "AddressBookDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Address book name" + } + }, + "required": [ + "name" + ] + }, + "SecurityPolicyViolationSeverity": { + "type": "object" + }, + "basicNetworkObjectDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the network object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "restricted_cell_violation": { + "type": "object", + "properties": { + "not_allowed_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "not_allowed_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInViolationDTO" + } + }, + "allowed_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "allowed_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInViolationDTO" + } + }, + "flow_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "flow_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "flow": { + "$ref": "#/components/schemas/FlowType" + }, + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + } + } + }, + "SecurityGroupDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Security group name" + }, + "uid": { + "type": "string", + "description": "Security group uid" + } + }, + "required": [ + "name", + "uid" + ] + }, + "MultiServerDTO": { + "type": "object", + "properties": { + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerDTO" + }, + "description": "The servers" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "server", + "name", + "read_only" + ] + }, + "RuleTrackLevel": { + "type": "object", + "properties": { + "displayName": { + "type": "string" + } + } + }, + "text_field": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The text field" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "text", + "name", + "read_only" + ] + }, + "FlowType": { + "type": "object" + }, + "domain_network_object": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "fqdnIps": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "WorkflowReferenceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The workflow name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The workflow ID" + }, + "uses_topology": { + "type": "boolean", + "description": "When the value is true, the Access Request tools in the workflow use Topology. When the value is false, the Access Request tools in the workflow do not use Topology." + } + }, + "required": [ + "name" + ] + }, + "ip_service": { + "type": "object", + "properties": { + "min_protocol": { + "type": "integer", + "format": "int32" + }, + "max_protocol": { + "type": "integer", + "format": "int32" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "date": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The date" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "value", + "name", + "read_only" + ] + }, + "SaApplicationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "owner": { + "type": "string" + }, + "domain_id": { + "type": "integer", + "format": "int32" + } + } + }, + "VerifierResultLinkDTO": { + "type": "object" + }, + "PartyDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the user" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyDTOType" + }, + "display_name": { + "type": "string", + "description": "The display name of the user" + }, + "email": { + "type": "string", + "description": "The email of the user" + }, + "ldapDn": { + "type": "string", + "description": "The LDAP DN of the user" + }, + "ldap_configuration": { + "$ref": "#/components/schemas/LdapConfigurationDTO" + }, + "roles": { + "$ref": "#/components/schemas/RolesListDTO" + }, + "authentication_method": { + "type": "string", + "description": "The method of authentication for the user" + }, + "origin_type": { + "type": "string", + "description": "The origin type of the user, 'Local' is available to GET only" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member_of": { + "$ref": "#/components/schemas/MembersOfListDTO" + }, + "domains": { + "$ref": "#/components/schemas/DomainsListDTO" + } + }, + "required": [ + "name" + ] + }, + "http_www.tufin.com_sc_range_network_object": { + "type": "object", + "properties": { + "max_ip": { + "type": "string" + }, + "min_ip": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "certify": { + "type": "object", + "properties": { + "certification_expiration_date": { + "type": "string" + }, + "binding__uid": { + "type": "string" + }, + "rule_uid": { + "type": "string" + }, + "update_status": { + "type": "string" + }, + "business_owner": { + "type": "string" + }, + "business_owner_email": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "certification_expiration_date", + "binding__uid", + "rule_uid", + "update_status" + ] + }, + "MultiDnsIpAddressDTO": { + "type": "object", + "properties": { + "ip_address": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of dns ip address" + } + } + }, + "network_object_group": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "exclusion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "application_default_service": { + "type": "object", + "properties": { + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "rule_recertification_info": { + "type": "object", + "properties": { + "binding__uid": { + "type": "string" + }, + "rule_uid": { + "type": "string" + }, + "update_status": { + "type": "string" + }, + "business_owner": { + "type": "string" + }, + "business_owner_email": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "binding__uid", + "rule_uid", + "update_status" + ] + }, + "sa_device": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Device name" + }, + "id": { + "type": "integer", + "format": "int32", + "description": "Device ID" + }, + "region": { + "type": "string", + "description": "Device region" + } + }, + "required": [ + "name", + "id", + "region" + ] + }, + "localuser": { + "type": "object", + "properties": { + "password": { + "type": "string", + "description": "The user's password" + }, + "email": { + "type": "string", + "description": "The email of the user" + }, + "firstName": { + "type": "string", + "description": "First name" + }, + "lastName": { + "type": "string", + "description": "Last name" + }, + "ldapConfiguration": { + "$ref": "#/components/schemas/LdapConfigurationDTO" + }, + "originType": { + "type": "string", + "description": "The origin type of the user, 'Local' is available to GET only" + }, + "default_authentication": { + "type": "boolean", + "description": "The default authentication" + }, + "phone": { + "type": "string", + "description": "Phone" + }, + "notes": { + "type": "string", + "description": "Notes" + }, + "name": { + "type": "string", + "description": "The login name of the user" + }, + "out_of_office_from": { + "type": "string", + "description": "Out of office from" + }, + "out_of_office_until": { + "type": "string", + "description": "Out of office until" + }, + "send_email": { + "type": "boolean", + "description": "Send email to the user" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyDTOType" + }, + "display_name": { + "type": "string", + "description": "The display name of the user" + }, + "ldapDn": { + "type": "string", + "description": "The LDAP DN of the user" + }, + "roles": { + "$ref": "#/components/schemas/RolesListDTO" + }, + "authentication_method": { + "type": "string", + "description": "The method of authentication for the user" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member_of": { + "$ref": "#/components/schemas/MembersOfListDTO" + }, + "domains": { + "$ref": "#/components/schemas/DomainsListDTO" + } + }, + "required": [ + "password", + "name" + ] + }, + "DomainsListDTO": { + "type": "object", + "properties": { + "domain": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DomainDTO" + }, + "description": "The list of domains" + } + }, + "required": [ + "domain" + ] + }, + "SourceDTO": { + "type": "object", + "properties": { + "ldap_entity_id": { + "type": "string", + "description": "ldap group Id" + }, + "ldap_entity_dn": { + "type": "string", + "description": "ldap group dn" + }, + "ldap_entity_name": { + "type": "string", + "description": "ldap group name" + }, + "host_name": { + "type": "string", + "description": "host name" + }, + "region": { + "type": "string", + "description": "region" + }, + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The external resource reference ips" + }, + "cidr": { + "type": "string", + "format": "int16", + "description": "cidr" + }, + "netmask": { + "type": "string", + "description": "netmask" + }, + "ip_address": { + "type": "string", + "description": "ip address" + }, + "range_first_ip": { + "type": "string", + "description": "min ip" + }, + "range_last_ip": { + "type": "string", + "description": "max ip" + }, + "nat_ip_address": { + "type": "string", + "description": "nat ip address" + }, + "dns_ip_addresses": { + "$ref": "#/components/schemas/MultiDnsIpAddressDTO" + }, + "nat_netmask": { + "type": "string", + "description": "nat netmask" + }, + "nat_cidr": { + "type": "string", + "format": "int16", + "description": "nat cidr" + }, + "resource_ref": { + "$ref": "#/components/schemas/resource_ref" + }, + "account_ref": { + "$ref": "#/components/schemas/account_ref" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "http_www.tufin.com_sc_policy_service_object": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "ApplicationInViolationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "NatInfoDTO": { + "type": "object", + "properties": { + "interface_name": { + "type": "string" + } + } + }, + "any_application": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "TicketApplicationChangeDTO": { + "type": "object" + }, + "MatrixCellDTO": { + "type": "object", + "properties": { + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + } + } + }, + "CommentOriginDTO": { + "type": "object" + }, + "InterfaceForNetworkObjectDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name of interface" + }, + "anti_spoof_disabled": { + "type": "boolean", + "description": "Anti spoof disabled indicator" + }, + "interface_ips": { + "$ref": "#/components/schemas/InterfaceIpListDTO" + } + }, + "required": [ + "name", + "anti_spoof_disabled", + "interface_ips" + ] + }, + "DesignerResultDTO": { + "type": "object" + }, + "UUID": { + "type": "object" + }, + "port_service": { + "type": "object", + "properties": { + "port": { + "type": "integer", + "format": "int32" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + }, + "match_for_any": { + "type": "boolean" + }, + "min_value_source": { + "type": "integer", + "format": "int32" + }, + "max_value_source": { + "type": "integer", + "format": "int32" + }, + "cp_prototype_name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "GroupPermissionDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the permission" + }, + "value": { + "type": "boolean", + "description": "The permission setting" + } + } + }, + "group": { + "type": "object", + "properties": { + "members": { + "$ref": "#/components/schemas/MembersListDTO" + }, + "groupPermissions": { + "$ref": "#/components/schemas/GroupPermissionsListDTO" + }, + "description": { + "type": "string", + "description": "Description of the group" + }, + "name": { + "type": "string", + "description": "The name of the user" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyDTOType" + }, + "display_name": { + "type": "string", + "description": "The display name of the user" + }, + "email": { + "type": "string", + "description": "The email of the user" + }, + "ldapDn": { + "type": "string", + "description": "The LDAP DN of the user" + }, + "ldap_configuration": { + "$ref": "#/components/schemas/LdapConfigurationDTO" + }, + "roles": { + "$ref": "#/components/schemas/RolesListDTO" + }, + "authentication_method": { + "type": "string", + "description": "The method of authentication for the user" + }, + "origin_type": { + "type": "string", + "description": "The origin type of the user, 'Local' is available to GET only" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member_of": { + "$ref": "#/components/schemas/MembersOfListDTO" + }, + "domains": { + "$ref": "#/components/schemas/DomainsListDTO" + } + }, + "required": [ + "name" + ] + }, + "http_www.tufin.com_sc_policy_ip_service": { + "type": "object", + "properties": { + "protocol": { + "$ref": "#/components/schemas/RangeDTO" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "DestinationDTO": { + "type": "object", + "properties": { + "url_category_name": { + "type": "string", + "description": "urlCategoryName" + }, + "host_name": { + "type": "string", + "description": "host name" + }, + "region": { + "type": "string", + "description": "region" + }, + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The external resource reference ips" + }, + "cidr": { + "type": "string", + "format": "int16", + "description": "cidr" + }, + "netmask": { + "type": "string", + "description": "netmask" + }, + "ip_address": { + "type": "string", + "description": "ip address" + }, + "range_first_ip": { + "type": "string", + "description": "min ip" + }, + "range_last_ip": { + "type": "string", + "description": "max ip" + }, + "nat_ip_address": { + "type": "string", + "description": "nat ip address" + }, + "dns_ip_addresses": { + "$ref": "#/components/schemas/MultiDnsIpAddressDTO" + }, + "nat_netmask": { + "type": "string", + "description": "nat netmask" + }, + "nat_cidr": { + "type": "string", + "format": "int16", + "description": "nat cidr" + }, + "resource_ref": { + "$ref": "#/components/schemas/resource_ref" + }, + "account_ref": { + "$ref": "#/components/schemas/account_ref" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "internetNetworkObjectDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the network object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "blocked_only_matrix_cell_violation": { + "type": "object", + "properties": { + "not_blocked_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "not_blocked_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInViolationDTO" + } + }, + "blocked_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "flow_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "flow_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "flow": { + "$ref": "#/components/schemas/FlowType" + }, + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + } + } + }, + "additional_parameter_central_nat": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "cloud_slim_rule": { + "type": "object", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "priority" + }, + "ip_type": { + "type": "string", + "description": "ip type" + }, + "name": { + "type": "string", + "description": "rule name" + }, + "comment": { + "type": "string", + "description": "rule comment" + }, + "option": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleOption" + }, + "description": "options" + }, + "is_disabled": { + "type": "boolean", + "description": "is disabled" + }, + "uid": { + "type": "string", + "description": "rule uid" + }, + "action": { + "$ref": "#/components/schemas/RuleAction" + }, + "ruleNumber": { + "type": "integer", + "format": "int64", + "description": "rule number" + }, + "displayRuleNumber": { + "type": "string", + "description": "display_rule_number" + }, + "sourceNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "source networks" + }, + "destinationNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "destination networks" + }, + "destinationServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "destination services" + }, + "sourceServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "source services" + }, + "applications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + }, + "description": "application" + }, + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUserDTO" + }, + "description": "users" + }, + "additional_parameter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/additional_parameter" + }, + "description": "additional parameters" + }, + "url_category": { + "type": "array", + "items": { + "$ref": "#/components/schemas/url_category" + }, + "description": "url categories" + }, + "install_on": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "install on" + }, + "time": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TimeDTO" + }, + "description": "time" + }, + "community": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VpnCommunityDTO" + }, + "description": "communities" + }, + "track": { + "$ref": "#/components/schemas/RuleTrackDTO" + }, + "sub_policy": { + "$ref": "#/components/schemas/SubPolicyDTO" + }, + "rule_location": { + "type": "string", + "description": "rule_location" + }, + "negatedDestination": { + "type": "boolean", + "description": "The destination is negated" + }, + "negatedDestinationService": { + "type": "boolean", + "description": "The destination service is negated" + }, + "negatedSource": { + "type": "boolean", + "description": "The source is negated" + }, + "negatedSourceService": { + "type": "boolean", + "description": "The source service is negated" + }, + "from_zone": { + "type": "string", + "description": "from_zone" + }, + "to_zone": { + "type": "string", + "description": "to_zone" + } + } + }, + "RedesignRequiredStatus": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/RedesignStatusEnumDTO" + }, + "reason": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of required reasons" + } + } + }, + "http_www.tufin.com_sc_policy_icmp_service": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/RangeDTO" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "comment": { + "type": "string" + } + } + }, + "multi_access_request": { + "type": "object", + "properties": { + "designer_result": { + "$ref": "#/components/schemas/DesignerDTO" + }, + "designer_verifier_advanced_option": { + "type": "string", + "description": "The access request rule customization option" + }, + "access_request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRuleDTO" + }, + "description": "The access request" + }, + "related_rules_result": { + "$ref": "#/components/schemas/RelatedRulesResultDTO" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "designer_result", + "access_request", + "name", + "read_only" + ] + }, + "http_www.tufin.com_sc_slim_rule_with_metadata": { + "type": "object", + "properties": { + "rule_metadata": { + "$ref": "#/components/schemas/RuleMetaDataDTO" + }, + "name": { + "type": "string", + "description": "rule name" + }, + "comment": { + "type": "string", + "description": "rule comment" + }, + "option": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleOption" + }, + "description": "options" + }, + "is_disabled": { + "type": "boolean", + "description": "is disabled" + }, + "uid": { + "type": "string", + "description": "rule uid" + }, + "action": { + "$ref": "#/components/schemas/RuleAction" + }, + "ruleNumber": { + "type": "integer", + "format": "int64", + "description": "rule number" + }, + "displayRuleNumber": { + "type": "string", + "description": "display_rule_number" + }, + "sourceNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "source networks" + }, + "destinationNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "destination networks" + }, + "destinationServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "destination services" + }, + "sourceServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "source services" + }, + "applications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + }, + "description": "application" + }, + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUserDTO" + }, + "description": "users" + }, + "additional_parameter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/additional_parameter" + }, + "description": "additional parameters" + }, + "url_category": { + "type": "array", + "items": { + "$ref": "#/components/schemas/url_category" + }, + "description": "url categories" + }, + "install_on": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "install on" + }, + "time": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TimeDTO" + }, + "description": "time" + }, + "community": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VpnCommunityDTO" + }, + "description": "communities" + }, + "track": { + "$ref": "#/components/schemas/RuleTrackDTO" + }, + "sub_policy": { + "$ref": "#/components/schemas/SubPolicyDTO" + }, + "rule_location": { + "type": "string", + "description": "rule_location" + }, + "negatedDestination": { + "type": "boolean", + "description": "The destination is negated" + }, + "negatedDestinationService": { + "type": "boolean", + "description": "The destination service is negated" + }, + "negatedSource": { + "type": "boolean", + "description": "The source is negated" + }, + "negatedSourceService": { + "type": "boolean", + "description": "The source service is negated" + }, + "from_zone": { + "type": "string", + "description": "from_zone" + }, + "to_zone": { + "type": "string", + "description": "to_zone" + } + } + }, + "designer_result_link": { + "type": "object" + }, + "additional_parameter_direction": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RelatedRuleContainerDTO": { + "type": "object", + "properties": { + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "ignore": { + "type": "boolean" + }, + "intersecting_objects": { + "$ref": "#/components/schemas/MarkedObjectsDTO" + } + } + }, + "CompliancePolicyDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The compliance policy name" + }, + "type": { + "type": "string", + "description": "The compliance policy type" + }, + "compliance_rules": { + "$ref": "#/components/schemas/ComplianceRuleListDTO" + } + } + }, + "mip_nat_info": { + "type": "object", + "properties": { + "mapped_to_ip": { + "type": "string" + }, + "virtual_router": { + "type": "string" + }, + "interface_name": { + "type": "string" + } + } + }, + "ErrorDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "error message" + }, + "code": { + "type": "string", + "description": "error code" + } + } + }, + "DeviceUserGroupDTO": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUserDTO" + } + }, + "typeOnDevice": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "rule_decommission_verifier_result_expanded": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RDVerifierDeviceDTO" + }, + "description": "The targets verified" + } + } + }, + "identity_awareness_object": { + "type": "object", + "properties": { + "network_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/identity_awareness_user" + } + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "NatType": { + "type": "object" + }, + "rule_modification": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "Rule modification ID" + }, + "rule_key": { + "$ref": "#/components/schemas/rule_key" + } + }, + "required": [ + "rule_key" + ] + }, + "TicketTaskDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The task name" + }, + "fields": { + "$ref": "#/components/schemas/TicketTaskFieldListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task ID" + }, + "status": { + "type": "string", + "description": "The task status" + }, + "unlicensed_devices_for_automation": { + "$ref": "#/components/schemas/UnlicensedDevicesForAutomationDTO" + }, + "pending_reason": { + "type": "string", + "description": "The task pending reason" + }, + "assignee_id": { + "type": "integer", + "format": "int64", + "description": "The assignee ID" + }, + "task_business_duration": { + "type": "integer", + "format": "int64", + "description": "The task business duration" + }, + "assignee": { + "type": "string", + "description": "The task assignee" + }, + "is_assigner": { + "type": "boolean", + "description": "Indicates whether the handler is the assigner" + }, + "assignee_participant_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the participant the assignee is based on" + }, + "pending_reason_description": { + "type": "string", + "description": "The task pending reason description" + }, + "potential_handlers": { + "$ref": "#/components/schemas/PartyListDTO" + } + }, + "required": [ + "fields", + "id", + "status", + "assignee" + ] + }, + "AccessRuleDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + }, + "labels": { + "$ref": "#/components/schemas/labels" + }, + "order": { + "type": "string", + "description": "The order" + }, + "action": { + "type": "string", + "description": "The action" + }, + "applications": { + "$ref": "#/components/schemas/applications" + }, + "users": { + "$ref": "#/components/schemas/users" + }, + "targets": { + "$ref": "#/components/schemas/multi_target" + }, + "uuid": { + "$ref": "#/components/schemas/UUID" + }, + "source_domain": { + "type": "string", + "description": "For SecureChange, The name of the source domain. For SecureApp, The name of the source customer. mandatory if interconnected domain mode is enabled" + }, + "destination_domain": { + "type": "string", + "description": "For SecureChange, The name of the destination domain. For SecureApp, The name of the destination customer. mandatory if interconnected domain mode is enabled" + }, + "sources": { + "$ref": "#/components/schemas/MultiSourceDTO" + }, + "destinations": { + "$ref": "#/components/schemas/MultiDestinationDTO" + }, + "use_topology": { + "type": "boolean" + }, + "verifier_result": { + "$ref": "#/components/schemas/VerifierDTO" + }, + "risk_analysis_result": { + "$ref": "#/components/schemas/RiskDTO" + }, + "services": { + "$ref": "#/components/schemas/multi_service" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "action", + "targets", + "source_domain", + "destination_domain", + "sources", + "destinations", + "services", + "name", + "read_only" + ] + }, + "CombinedPolicyRulesResultDTO": { + "type": "object", + "properties": { + "rule": { + "type": "array", + "items": { + "type": "string" + }, + "description": "rules" + }, + "implicit_cleanup": { + "type": "boolean", + "description": "implicit cleanup" + } + } + }, + "PermissionListDTO": { + "type": "object", + "properties": { + "permission": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PermissionDTO" + }, + "description": "The list of permissions" + } + }, + "required": [ + "permission" + ] + }, + "RuleCertificationDTO": { + "type": "object", + "properties": { + "certification_id": { + "type": "integer", + "format": "int64" + }, + "certification_date": { + "$ref": "#/components/schemas/Optional" + }, + "certification_status": { + "$ref": "#/components/schemas/RuleCertificationStatus" + }, + "certification_expiration_date": { + "$ref": "#/components/schemas/Optional" + } + } + }, + "ShadowedStatus": { + "type": "object" + }, + "alias": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "exclusion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "PartyListDTO": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartyDTO" + }, + "description": "The list of users" + } + }, + "required": [ + "user" + ] + }, + "Chronology": { + "type": "object" + }, + "network_object": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "designer_designer_result_link": { + "type": "object" + }, + "blocked_cell_violation": { + "type": "object", + "properties": { + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + } + } + } + }, + "PushStatusReasonDTO": { + "type": "object" + }, + "ComplianceRuleDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The compliance rule name" + }, + "number": { + "type": "string", + "description": "The compliance rule number" + } + } + }, + "rule_decommission": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "The action" + }, + "designer_result": { + "$ref": "#/components/schemas/DesignerDTO" + }, + "verifier_result": { + "$ref": "#/components/schemas/RDVerifierDTO" + }, + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/http_www.tufin.com_sc_RuleOperationDeviceDTO" + }, + "description": "List of devices" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "action", + "designer_result", + "verifier_result", + "device", + "name", + "read_only" + ] + }, + "cloud_security_group": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "exclusion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "singleServiceDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type" + }, + "protocol": { + "type": "string", + "format": "int16", + "description": "The protocol number, for IP service: protocol is not specified." + }, + "min": { + "type": "integer", + "format": "int32", + "description": "For IP, TCP and UDP Services: the minimum port number, ICMP Service: the ICMP type number." + }, + "max": { + "type": "integer", + "format": "int32", + "description": "For IP, TCP and UDP Services: the maximum port number." + }, + "timeout": { + "type": "string", + "description": "The timeout value for the service in seconds" + }, + "application_identity_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Layer7ApplicationServiceDTO" + }, + "description": "The application identity services" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "TicketTaskFieldListDTO": { + "type": "object", + "properties": { + "field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketTaskFieldDTO" + }, + "description": "The field parameter" + } + }, + "required": [ + "field" + ] + }, + "DesignerDeviceSuggestionsDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "management_id": { + "type": "integer", + "format": "int64" + }, + "management_name": { + "type": "string" + }, + "redesign_status": { + "$ref": "#/components/schemas/RedesignStatusDTO" + }, + "vendor_name": { + "type": "string" + }, + "offline_device": { + "type": "boolean", + "description": "is offline device" + }, + "device_software_version": { + "type": "string" + }, + "push_status_reason": { + "$ref": "#/components/schemas/PushStatusReasonDTO" + }, + "change_id": { + "type": "string" + }, + "revision_number": { + "type": "integer", + "format": "int32" + }, + "ancestor_management_id": { + "type": "integer", + "format": "int32" + }, + "ancestor_management_name": { + "type": "string" + }, + "ancestor_management_revision_id": { + "type": "integer", + "format": "int32" + }, + "new_revision_arrived": { + "type": "boolean", + "description": "is new revision arrived" + }, + "push_status": { + "type": "string" + }, + "push_request_id": { + "type": "integer", + "format": "int64" + }, + "designer_command": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerPersistedCommandDTO" + } + }, + "binding_suggestion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerBindingSuggestionsDTO" + } + }, + "commit_results": { + "$ref": "#/components/schemas/CommitResultsDTO" + } + } + }, + "SecurityPolicyViolationDTO": { + "type": "object", + "properties": { + "security_policy_violation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ViolationDTO" + } + } + } + }, + "RDVerifierDeviceDTO": { + "type": "object", + "properties": { + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RDVerifierBindingDTO" + }, + "description": "bindings" + }, + "verifierError": { + "$ref": "#/components/schemas/RDVerifierError" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "ID of management" + }, + "management_name": { + "type": "string", + "description": "name of management" + }, + "device_type": { + "$ref": "#/components/schemas/CpType" + }, + "revision_id": { + "type": "integer", + "format": "int32", + "description": "revision id" + }, + "vendor_type": { + "$ref": "#/components/schemas/VendorTypeDTO" + }, + "revision_number": { + "type": "integer", + "format": "int32", + "description": "revision number" + }, + "administrator": { + "type": "string", + "description": "name of administrator that made the change" + }, + "changed_on": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "management_ip": { + "type": "string", + "description": "ip of management" + }, + "received_on": { + "$ref": "#/components/schemas/LocalDateTime" + } + }, + "required": [ + "management_id", + "revision_id" + ] + }, + "identity_awareness_user": { + "type": "object", + "properties": { + "dn": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "redo_comment": { + "type": "object", + "properties": { + "redo_stage_id": { + "type": "integer", + "format": "int64", + "description": "The stage to which the redo was applied" + }, + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "GroupPermissionsListDTO": { + "type": "object", + "properties": { + "groupPermission": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GroupPermissionDTO" + }, + "description": "The list of permissions for this group" + } + } + }, + "resource_ref": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The resource ref name" + }, + "id": { + "type": "string", + "description": "The resource ref ID" + }, + "type": { + "type": "string", + "description": "The resource ref type" + } + } + }, + "Entry_String_String": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + }, + "userObjectGroupDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type" + }, + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of references to the user group members" + }, + "ip": { + "type": "string", + "description": "The IP of the user object" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "user": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The login name of the user" + }, + "first_name": { + "type": "string", + "description": "First name" + }, + "last_name": { + "type": "string", + "description": "Last name" + }, + "out_of_office_from": { + "type": "string", + "description": "Out of office from" + }, + "out_of_office_until": { + "type": "string", + "description": "Out of office until" + }, + "phone": { + "type": "string", + "description": "Phone" + }, + "notes": { + "type": "string", + "description": "Notes" + }, + "send_email": { + "type": "boolean", + "description": "Send email to the user" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyDTOType" + }, + "display_name": { + "type": "string", + "description": "The display name of the user" + }, + "email": { + "type": "string", + "description": "The email of the user" + }, + "ldapDn": { + "type": "string", + "description": "The LDAP DN of the user" + }, + "ldap_configuration": { + "$ref": "#/components/schemas/LdapConfigurationDTO" + }, + "roles": { + "$ref": "#/components/schemas/RolesListDTO" + }, + "authentication_method": { + "type": "string", + "description": "The method of authentication for the user" + }, + "origin_type": { + "type": "string", + "description": "The origin type of the user, 'Local' is available to GET only" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member_of": { + "$ref": "#/components/schemas/MembersOfListDTO" + }, + "domains": { + "$ref": "#/components/schemas/DomainsListDTO" + } + }, + "required": [ + "name" + ] + }, + "LdapConfigurationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the LDAP server" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the LDAP server" + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port of the LDAP server" + }, + "server": { + "type": "string", + "description": "The server (host) of the LDAP server" + }, + "trust_any_certificate": { + "type": "boolean", + "description": "Should the LDAP server trust any certificate" + }, + "ldap_vendor": { + "type": "string", + "description": "The vendor of the LDAP server" + }, + "base_dn": { + "type": "string", + "description": "The base dn of the LDAP server" + }, + "user_dn": { + "type": "string", + "description": "The user dn of the LDAP server" + }, + "connect_using_ssl": { + "type": "boolean", + "description": "Should the LDAP server connect using SSL" + }, + "connect_timeout": { + "type": "integer", + "format": "int32", + "description": "The timeout for connecting the LDAP server" + } + }, + "required": [ + "name", + "id", + "port", + "server", + "trust_any_certificate", + "ldap_vendor", + "base_dn", + "user_dn", + "connect_using_ssl", + "connect_timeout" + ] + }, + "Layer7ApplicationServiceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the predefined service" + }, + "protocol": { + "type": "string", + "format": "int16", + "description": "The port number, for IP service: protocol is not specified" + }, + "min": { + "type": "integer", + "format": "int32", + "description": "For IP, TCP and UDP Services: the minimum port number, ICMP Service: the ICMP type number" + }, + "max": { + "type": "integer", + "format": "int32", + "description": "For IP, TCP and UDP Services: the maximum port number" + } + } + }, + "Layer7ApplicationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application identity" + }, + "id": { + "type": "string", + "description": "The id of the application identity" + }, + "application_identity_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Layer7ApplicationServiceDTO" + }, + "description": "The application identity services" + } + } + }, + "Layer7ApplicationListDTO": { + "type": "object" + }, + "ApplicationInterfaceListDTO": { + "type": "object", + "properties": { + "application_interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInterfaceDTO" + }, + "description": "List of application interfaces" + } + } + }, + "ApplicationInterfaceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application interface" + }, + "id": { + "type": "string", + "description": "The ID of the application interface" + }, + "comment": { + "type": "string", + "description": "The comment of the application interface" + }, + "uid": { + "type": "string", + "description": "The uid of the application interface" + }, + "application_id": { + "type": "string", + "description": "The application ID of the application interface" + }, + "interface_connections": { + "$ref": "#/components/schemas/ConnectionInterfaceListDTO" + }, + "is_published": { + "type": "boolean", + "description": "The current is_published status" + } + }, + "required": [ + "name" + ] + }, + "ConnectionListDTO": { + "type": "object", + "properties": { + "connection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionDTO" + }, + "description": "List of connections" + } + } + }, + "ConnectionInterfaceDTO": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of source's objects ref" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of destination's objects ref" + }, + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The servers in the interface connection that connected to the interface" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of service's objects ref" + }, + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "uid": { + "type": "string", + "description": "The UID" + }, + "applicationId": { + "type": "string" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The opened tickets" + } + }, + "required": [ + "name" + ] + }, + "ApplicationInterfaceInstanceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the connection to application" + }, + "id": { + "type": "string", + "description": "The ID of the connection to application" + }, + "comment": { + "type": "string", + "description": "The comment of the connection to application" + }, + "uid": { + "type": "string", + "description": "The Uid of the connection to application" + }, + "application_id": { + "type": "string", + "description": "The application ID of the connection to application" + }, + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The servers of the connection to application that connected to the application interface" + }, + "connections": { + "$ref": "#/components/schemas/ConnectionListDTO" + }, + "application_interface_id": { + "type": "string", + "description": "The application interface ID of the connection to application" + } + }, + "required": [ + "name" + ] + }, + "ConnectionInterfaceListDTO": { + "type": "object", + "properties": { + "interface_connection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionInterfaceDTO" + }, + "description": "List of interface connections" + } + } + }, + "ApplicationInterfaceInstanceListDTO": { + "type": "object", + "properties": { + "connection_to_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationInterfaceInstanceDTO" + }, + "description": "List of connections to application" + } + } + }, + "InterfaceInstanceMappingDTO": { + "type": "object", + "properties": { + "source_connection_to_application": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "target_application_interface": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + }, + "InterfaceInstanceMappingListDTO": { + "type": "object", + "properties": { + "connection_to_application_mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceInstanceMappingDTO" + }, + "description": "The Interface Instance mapping" + } + } + }, + "ServerMappingDTO": { + "type": "object", + "properties": { + "source_network_object": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "target_network_object": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "required": [ + "source_network_object" + ] + }, + "ServerMappingListDTO": { + "type": "object", + "properties": { + "server_mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerMappingDTO" + }, + "description": "The servers mapping" + } + } + }, + "ApplicationPackInstanceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the connection to application pack" + }, + "id": { + "type": "string", + "description": "The ID of the connection to application pack" + }, + "comment": { + "type": "string", + "description": "The comment of the connection to application pack" + }, + "application": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "application_pack": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date the connection to application pack was created" + }, + "modified": { + "type": "string", + "format": "date-time", + "description": "The date the last change was made" + }, + "connection_to_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The connections to applications of the connection to application pack" + }, + "tag_servers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagToConnectedServersDTO" + }, + "description": "The tags and their servers of the connection to application pack" + } + } + }, + "TagToConnectedServersDTO": { + "type": "object", + "properties": { + "tag": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The servers associated with tag " + } + } + }, + "ApplicationPackInstanceListDTO": { + "type": "object", + "properties": { + "connection_to_application_pack": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationPackInstanceDTO" + }, + "description": "The list of connection to application packs and their details" + } + } + }, + "InterfaceTagMappingListDTO": { + "type": "object", + "properties": { + "application_interface_tag": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceTagMappingDTO" + } + } + } + }, + "ApplicationPackListDTO": { + "type": "object", + "properties": { + "application_pack": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationPackDTO" + }, + "description": "The list of application packs and their details" + } + } + }, + "ApplicationPackDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application pack" + }, + "id": { + "type": "string", + "description": "The ID of the application pack" + }, + "owner": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "comment": { + "type": "string", + "description": "The comment of the application pack" + }, + "tag": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The tags of the application pack" + }, + "decommissioned": { + "type": "boolean", + "description": "Is the application pack decommissioned" + }, + "editors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The editors of the application pack" + }, + "viewers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The viewers of the application pack" + }, + "openTickets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The open tickets of the application pack" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date the application pack was created" + }, + "is_published": { + "type": "boolean", + "description": "The current is_published status" + }, + "application_interface_tag": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceTagMappingDTO" + }, + "description": "All application interfaces under this application pack with there tags" + }, + "modified": { + "type": "string", + "format": "date-time", + "description": "The date the last change was made" + } + }, + "required": [ + "name", + "id", + "owner" + ] + }, + "TagListDTO": { + "type": "object", + "properties": { + "tag": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagDTO" + } + } + } + }, + "TagDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tag" + }, + "id": { + "type": "string", + "description": "The ID of the tag" + } + }, + "required": [ + "name", + "id" + ] + }, + "InterfaceTagMappingDTO": { + "type": "object", + "properties": { + "tag": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "application_interface": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + }, + "AccessRuleListDTO": { + "type": "object", + "properties": { + "access_request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRuleDTO" + } + } + } + }, + "NetworkObjectListDTO": { + "type": "object", + "properties": { + "network_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of network objects" + } + }, + "required": [ + "network_object" + ] + }, + "ServiceListDTO": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_service" + }, + "description": "List of services" + } + } + }, + "UserObjectListDTO": { + "type": "object", + "properties": { + "user": { + "$ref": "#/components/schemas/void" + } + } + }, + "security_matrix_violation": { + "type": "object", + "properties": { + "security_zone_matrix": { + "type": "string", + "description": "security zone matrix" + }, + "matrix_cell_violation": { + "$ref": "#/components/schemas/matrix_cell" + }, + "security_zone_matrix_type": { + "type": "string", + "description": "security zone matrix type" + }, + "security_zone_matrix_domain": { + "type": "string", + "description": "security zone matrix Domain" + }, + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "HistoryApplicationDetailsDTO": { + "type": "object", + "properties": { + "ticket": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "previous_owner": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "new_owner": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "editor": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "removed_editors" + }, + "viewer": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "removed_viewers" + } + } + }, + "sa_application": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application" + }, + "id": { + "type": "string", + "description": "The ID of the application" + }, + "owner": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "comment": { + "type": "string", + "description": "The comment of the application" + }, + "status": { + "type": "string", + "description": "The status of the application" + }, + "vendor": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The vendors that are associated with servers contained in the application" + }, + "customer": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "connection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The connections of the application" + }, + "connection_to_application_pack": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The connections to application pack of the application" + }, + "decommissioned": { + "type": "boolean", + "description": "Is the application decommissioned" + }, + "editors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The editors of the application" + }, + "viewers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The viewers of the application" + }, + "openTickets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The open tickets of the application" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date the application was created" + }, + "modified": { + "type": "string", + "format": "date-time", + "description": "The date the last change was made" + } + }, + "required": [ + "name", + "id", + "owner" + ] + }, + "HistoryConnectionBaseSnapshotDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of source's network objects" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of destination's network objects" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_service" + }, + "description": "List of services" + } + }, + "required": [ + "name" + ] + }, + "HistoryDeviceObjectDetailsDTO": { + "type": "object", + "properties": { + "previous": { + "$ref": "#/components/schemas/sa_device_object" + }, + "new": { + "$ref": "#/components/schemas/sa_device_object" + }, + "addedObjects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "removedObjects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + } + }, + "HistoryApplicationPackInstanceDetailsDTO": { + "type": "object", + "properties": { + "previous": { + "$ref": "#/components/schemas/BasePropertiesDTO" + }, + "new": { + "$ref": "#/components/schemas/BasePropertiesDTO" + } + } + }, + "SASecurityPolicyViolationDTO": { + "type": "object", + "properties": { + "security_policy_violation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SAViolationDTO" + } + } + } + }, + "HistoryListDTO": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the specific list of history records, by the current filter" + }, + "total": { + "type": "integer", + "format": "int32", + "description": "The total number of the records in the history" + }, + "history_record": { + "type": "array", + "items": { + "$ref": "#/components/schemas/HistoryDTO" + }, + "description": "List of history records" + } + } + }, + "HistoryConnectionInterfaceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of source's network objects" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of destination's network objects" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_service" + }, + "description": "List of services" + } + }, + "required": [ + "name" + ] + }, + "sa_device_object": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the object" + }, + "type": { + "type": "string", + "description": "The type of the object" + }, + "display_name": { + "type": "string", + "description": "The display name of the object" + }, + "comment": { + "type": "string", + "description": "The comment of the object" + }, + "global": { + "type": "boolean", + "description": "Is a global object" + }, + "uid": { + "type": "string", + "description": "The UID of the object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID for object" + }, + "original_instance_id": { + "type": "integer", + "format": "int64", + "description": "ID for the original instance of this object, if this connection is based on a published interface" + }, + "cloned": { + "type": "boolean", + "description": "Indicates whether it is a cloned Object" + } + }, + "required": [ + "name", + "id", + "global", + "uid", + "application_id", + "original_instance_id" + ] + }, + "SAViolationDTO": { + "type": "object", + "properties": { + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "HistoryDetailsDTO": { + "type": "object" + }, + "blocked_cell": { + "type": "object", + "properties": { + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "from_zone_domain": { + "type": "string" + }, + "to_zone_domain": { + "type": "string" + } + } + }, + "restricted_cell": { + "type": "object", + "properties": { + "not_allowed_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "allowed_service": { + "type": "array", + "items": { + "type": "string" + } + }, + "flow_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "flow_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "flow": { + "$ref": "#/components/schemas/FlowType" + }, + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "from_zone_domain": { + "type": "string" + }, + "to_zone_domain": { + "type": "string" + } + } + }, + "HistoryConnectionDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name" + }, + "id": { + "type": "string", + "description": "The ID" + }, + "comment": { + "type": "string", + "description": "The comment" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of source's network objects" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_network_object" + }, + "description": "List of destination's network objects" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_service" + }, + "description": "List of services" + } + }, + "required": [ + "name" + ] + }, + "matrix_cell": { + "type": "object", + "properties": { + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "from_zone_domain": { + "type": "string" + }, + "to_zone_domain": { + "type": "string" + } + } + }, + "HistoryNetworkObjectDetailsDTO": { + "type": "object", + "properties": { + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "servers removed" + }, + "previous": { + "$ref": "#/components/schemas/sa_device_object" + }, + "new": { + "$ref": "#/components/schemas/sa_device_object" + } + } + }, + "BasePropertiesDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name" + }, + "comment": { + "type": "string", + "description": "comment" + } + } + }, + "block_only_cell": { + "type": "object", + "properties": { + "not_blocked_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "blocked_service": { + "type": "array", + "items": { + "type": "string" + } + }, + "flow_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "flow_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "flow": { + "$ref": "#/components/schemas/FlowType" + }, + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "from_zone_domain": { + "type": "string" + }, + "to_zone_domain": { + "type": "string" + } + } + }, + "HistoryServiceDetailsDTO": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "services removed" + }, + "previous": { + "$ref": "#/components/schemas/sa_device_object" + }, + "new": { + "$ref": "#/components/schemas/sa_device_object" + } + } + }, + "ApplicationToDomainListDTO": { + "type": "object", + "properties": { + "move_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationToDomainDTO" + }, + "description": "List of customers and applications to move" + } + } + }, + "HistoryDTO": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "The date the change was made" + }, + "object_name": { + "type": "string", + "description": "new server name - for request to access application with group" + }, + "user": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "type": { + "type": "string", + "description": "Either a group, network object or subnet" + }, + "modified_object": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "change_description": { + "type": "string", + "description": "Description of the change made" + }, + "change_details": { + "$ref": "#/components/schemas/HistoryDetailsDTO" + } + } + }, + "HistoryApplicationInterfaceInstanceDetailsDTO": { + "type": "object", + "properties": { + "previous": { + "$ref": "#/components/schemas/BasePropertiesDTO" + }, + "new": { + "$ref": "#/components/schemas/BasePropertiesDTO" + } + } + }, + "ComplianceResultListDTO": { + "type": "object", + "properties": { + "compliance_violations_result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ComplianceResultDTO" + }, + "description": "compliance violations results" + } + } + }, + "HistoryDeviceObjectDTO": { + "type": "object", + "properties": { + "snapshot": { + "$ref": "#/components/schemas/sa_device_object" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "The date the change was made" + }, + "object_name": { + "type": "string", + "description": "new server name - for request to access application with group" + }, + "user": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "type": { + "type": "string", + "description": "Either a group, network object or subnet" + }, + "modified_object": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "change_description": { + "type": "string", + "description": "Description of the change made" + }, + "change_details": { + "$ref": "#/components/schemas/HistoryDetailsDTO" + } + } + }, + "HistoryConnectionDetailsDTO": { + "type": "object", + "properties": { + "previous": { + "$ref": "#/components/schemas/BasePropertiesDTO" + }, + "new": { + "$ref": "#/components/schemas/BasePropertiesDTO" + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "sources removed" + }, + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "destinations removed" + }, + "service": { + "$ref": "#/components/schemas/void" + } + } + }, + "ApplicationToDomainDTO": { + "type": "object", + "properties": { + "customer": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "application": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + }, + "HistoryBaseConnectionDTO": { + "type": "object", + "properties": { + "snapshot": { + "$ref": "#/components/schemas/HistoryConnectionBaseSnapshotDTO" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "The date the change was made" + }, + "object_name": { + "type": "string", + "description": "new server name - for request to access application with group" + }, + "user": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "type": { + "type": "string", + "description": "Either a group, network object or subnet" + }, + "modified_object": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "change_description": { + "type": "string", + "description": "Description of the change made" + }, + "change_details": { + "$ref": "#/components/schemas/HistoryDetailsDTO" + } + } + }, + "ComplianceResultDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "cannot compute risk reason" + }, + "status": { + "type": "string", + "description": "risk status" + }, + "security_policy_violations": { + "$ref": "#/components/schemas/SASecurityPolicyViolationDTO" + }, + "connection": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + }, + "HistoryApplicationInterfaceDetailsDTO": { + "type": "object", + "properties": { + "previous": { + "$ref": "#/components/schemas/BasePropertiesDTO" + }, + "new": { + "$ref": "#/components/schemas/BasePropertiesDTO" + } + } + }, + "ApplicationListDTO": { + "type": "object", + "properties": { + "application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sa_application" + }, + "description": "The list of applications and their details" + } + } + }, + "WorkflowDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "WorkflowDTO_Requests": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The workflow name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The workflow ID" + }, + "type": { + "type": "string", + "description": "The workflow type" + } + } + }, + "WorkflowDTO_Triggers": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "parent_workflow_id": { + "type": "integer", + "format": "int64" + } + } + }, + "UnifiedSecurityPolicyDTO": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/Status" + } + } + }, + "radius_protocol": { + "type": "object" + }, + "rule_decommission_workflow": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "Status": { + "type": "object" + }, + "LabelConditionOperator": { + "type": "object" + }, + "ApplicationConditionOperator": { + "type": "object" + }, + "SLAStatus": { + "type": "object" + }, + "WorkflowStepConfigurationDTO": { + "type": "object" + }, + "decommission_request_configuration": { + "type": "object", + "properties": { + "designer": { + "$ref": "#/components/schemas/DesignerModeCfgDTO" + }, + "impact_analysis": { + "type": "boolean" + }, + "verifier": { + "type": "boolean" + }, + "type": { + "type": "string" + } + } + }, + "auto_step": { + "type": "object", + "properties": { + "field_type": { + "type": "string" + }, + "assign_handler": { + "type": "boolean" + }, + "run_designer": { + "type": "boolean" + }, + "run_verifier": { + "type": "boolean" + }, + "run_risk_analysis": { + "type": "boolean" + }, + "run_suggest_target": { + "type": "boolean" + }, + "update_policy": { + "type": "boolean" + }, + "commit_policy_changes": { + "type": "boolean" + }, + "update_metadata": { + "type": "boolean" + } + } + }, + "WorkflowTaskRiskConditionDTO": { + "type": "object", + "properties": { + "risk_status": { + "$ref": "#/components/schemas/RiskStatusCondition" + }, + "operator": { + "$ref": "#/components/schemas/RiskConditionOperator" + }, + "type": { + "type": "string" + } + } + }, + "VerificationNameCondition": { + "type": "object" + }, + "WorkflowTaskRiskSeverityConditionDTO": { + "type": "object", + "properties": { + "operator": { + "$ref": "#/components/schemas/RiskSeverityConditionOperator" + }, + "risk_severity": { + "$ref": "#/components/schemas/RiskSeverityCondition" + }, + "type": { + "type": "string" + } + } + }, + "access_request_workflow": { + "type": "object", + "properties": { + "designer_verifier_advanced_option": { + "type": "string" + }, + "use_topology": { + "type": "boolean" + }, + "disable_rule_suggestion": { + "type": "boolean" + }, + "risk_analysis": { + "$ref": "#/components/schemas/RiskAnalysisDTO" + }, + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "WorkflowTaskApplicationConditionDTO": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "operator": { + "$ref": "#/components/schemas/ApplicationConditionOperator" + }, + "type": { + "type": "string" + } + } + }, + "AssignmentDTO": { + "type": "object" + }, + "radius_type": { + "type": "object" + }, + "self_assign": { + "type": "object" + }, + "WorkflowStepDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "order": { + "type": "integer", + "format": "int32" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "default_task": { + "$ref": "#/components/schemas/task" + }, + "is_active": { + "type": "boolean" + }, + "is_dynamic": { + "type": "boolean" + }, + "assignment": { + "$ref": "#/components/schemas/AssignmentDTO" + }, + "is_request_priority_enabled": { + "type": "boolean" + }, + "is_request_attachment_enabled": { + "type": "boolean" + }, + "is_request_group_notification_enabled": { + "type": "boolean" + }, + "is_step_by_script": { + "type": "boolean" + }, + "step_by_script_path": { + "type": "string" + }, + "is_auto": { + "type": "boolean" + }, + "is_skip": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "configuration": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepConfigurationDTO" + } + } + } + }, + "DesignerModeCfgDTO": { + "type": "object", + "properties": { + "designer_commit": { + "type": "boolean" + }, + "designer_implement": { + "type": "boolean" + }, + "designer_design": { + "type": "boolean" + } + } + }, + "multiple_selection_configuration": { + "type": "object", + "properties": { + "options": { + "$ref": "#/components/schemas/OptionItemListDTO" + }, + "type": { + "type": "string" + } + } + }, + "radiusConfigurationDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "$ref": "#/components/schemas/radius_type" + }, + "port": { + "type": "integer", + "format": "int32" + }, + "protocol": { + "$ref": "#/components/schemas/radius_protocol" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "server": { + "type": "string" + } + } + }, + "ChangeAuditListDTO": { + "type": "object", + "properties": { + "change_audit": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChangeAuditDTO" + }, + "description": "The list of records from change audit table" + } + } + }, + "OptionsOrder": { + "type": "object" + }, + "expiration_configuration": { + "type": "object", + "properties": { + "default_expiration_period": { + "type": "integer", + "format": "int32" + }, + "days_to_notify": { + "type": "integer", + "format": "int32" + }, + "recipient": { + "type": "array", + "items": { + "$ref": "#/components/schemas/local" + } + }, + "should_notify": { + "type": "boolean" + }, + "type": { + "type": "string" + } + } + }, + "ExternalRiskAnalysisDTO": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/Status" + }, + "script_path": { + "type": "string" + }, + "custom_title": { + "$ref": "#/components/schemas/CustomTitleDTO" + } + } + }, + "rule_recertification_workflow": { + "type": "object", + "properties": { + "rule_recertification_configuration": { + "$ref": "#/components/schemas/RuleRecertificationConfigurationDTO" + }, + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "SlaConditionOperator": { + "type": "object" + }, + "local": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "PriorityValues": { + "type": "object", + "properties": { + "tagName": { + "type": "string" + } + } + }, + "scripted_assignment": { + "type": "object", + "properties": { + "script_path": { + "type": "string" + } + } + }, + "clone_server_policy_configuration": { + "type": "object", + "properties": { + "read_only": { + "type": "boolean" + }, + "designer": { + "$ref": "#/components/schemas/DesignerModeCfgDTO" + }, + "verifier": { + "type": "boolean" + }, + "type": { + "type": "string" + } + } + }, + "CertificationDecisionPermissionDTO": { + "type": "object", + "properties": { + "read_only_expiration_duration": { + "type": "boolean" + } + } + }, + "RuleRecertificationConfigurationDTO": { + "type": "object", + "properties": { + "certification_decision": { + "$ref": "#/components/schemas/CertificationDecisionDTO" + } + } + }, + "task": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "participant": { + "type": "array", + "items": { + "$ref": "#/components/schemas/local" + } + }, + "is_default": { + "type": "boolean" + } + } + }, + "VerificationConditionOperator": { + "type": "object" + }, + "rule_modification_workflow": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "PriorityConditionOperator": { + "type": "object" + }, + "CertificationDurationDTO": { + "type": "object", + "properties": { + "default_days": { + "type": "integer", + "format": "int32" + }, + "maximum_days": { + "type": "integer", + "format": "int32" + } + } + }, + "RiskStatusCondition": { + "type": "object" + }, + "WorkflowFieldConfigurationDTO": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + }, + "AuditableDTO": { + "type": "object" + }, + "clone_server_policy_workflow": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "CalendarDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The defined calendar name" + }, + "uid": { + "type": "string" + }, + "from_hour": { + "type": "string" + }, + "to_hour": { + "type": "string" + }, + "working_days": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DayOfWeek" + } + }, + "non_businessDays": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NonBusinessDayDTO" + } + } + } + }, + "modify_group_workflow": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "WorkflowFieldDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "configuration": { + "$ref": "#/components/schemas/WorkflowFieldConfigurationDTO" + }, + "field_value": { + "$ref": "#/components/schemas/TicketTaskFieldDTO" + }, + "tooltip": { + "type": "string" + }, + "mandatory": { + "type": "boolean" + }, + "multiple": { + "type": "boolean" + } + } + }, + "RiskSeverityConditionOperator": { + "type": "object" + }, + "modify_group_configuration": { + "type": "object", + "properties": { + "designer": { + "$ref": "#/components/schemas/DesignerModeCfgDTO" + }, + "type": { + "type": "string" + } + } + }, + "rule_decommission_configuration": { + "type": "object", + "properties": { + "read_only": { + "type": "boolean" + }, + "verifier": { + "type": "boolean" + }, + "designer": { + "$ref": "#/components/schemas/DesignerModeCfgDTO" + }, + "type": { + "type": "string" + } + } + }, + "access_request_modify_group_workflow": { + "type": "object", + "properties": { + "designer_verifier_advanced_option": { + "type": "string" + }, + "use_topology": { + "type": "boolean" + }, + "disable_rule_suggestion": { + "type": "boolean" + }, + "risk_analysis": { + "$ref": "#/components/schemas/RiskAnalysisDTO" + }, + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "RiskConditionOperator": { + "type": "object" + }, + "server_decommission_workflow": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "calendar": { + "$ref": "#/components/schemas/CalendarDTO" + }, + "invalidity_reason": { + "type": "string" + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStepDTO" + } + }, + "reopen_step_name": { + "type": "string" + }, + "close_implemented": { + "type": "boolean" + }, + "reference_ticket_enabled": { + "type": "boolean" + }, + "global_field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowFieldDTO" + } + }, + "is_active": { + "type": "boolean" + }, + "is_valid": { + "type": "boolean" + }, + "allow_requester_confirmation": { + "type": "boolean" + }, + "time_unit_auto_confirm": { + "type": "string" + }, + "time_to_auto_confirm": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + } + } + }, + "ChangeContainerDTO": { + "type": "object" + }, + "dynamic_assignment_task": { + "type": "object", + "properties": { + "condition": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowTaskConditionDTO" + } + }, + "assignment": { + "$ref": "#/components/schemas/AssignmentDTO" + }, + "condition_connector": { + "type": "string" + }, + "name": { + "type": "string" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "participant": { + "type": "array", + "items": { + "$ref": "#/components/schemas/local" + } + }, + "is_default": { + "type": "boolean" + } + } + }, + "ChangeAuditDTO": { + "type": "object", + "properties": { + "user_name": { + "type": "string", + "description": "The user name" + }, + "before_change": { + "$ref": "#/components/schemas/ChangeContainerDTO" + }, + "after_change": { + "$ref": "#/components/schemas/ChangeContainerDTO" + }, + "diff": { + "type": "string", + "description": "The diff, added with showChanges=true" + }, + "change_date_time": { + "type": "string", + "format": "date-time", + "description": "The change date and time with offset" + }, + "changed_entity_type": { + "type": "string", + "description": "The entity type" + }, + "changed_entity_id": { + "type": "integer", + "format": "int64", + "description": "The entity id" + }, + "changed_entity_name": { + "type": "string", + "description": "The entity name" + } + } + }, + "auto_assignment": { + "type": "object", + "properties": { + "prefer_previous_handler": { + "type": "boolean" + } + } + }, + "RadiusType": { + "type": "object" + }, + "manager_assignment": { + "type": "object", + "properties": { + "default_manager": { + "$ref": "#/components/schemas/local" + } + } + }, + "DayOfWeek": { + "type": "object" + }, + "RiskAnalysisDTO": { + "type": "object", + "properties": { + "external_risk_analysis": { + "$ref": "#/components/schemas/ExternalRiskAnalysisDTO" + }, + "unified_security_policy": { + "$ref": "#/components/schemas/UnifiedSecurityPolicyDTO" + } + } + }, + "option_field_configuration": { + "type": "object", + "properties": { + "options": { + "$ref": "#/components/schemas/OptionItemListDTO" + }, + "order": { + "$ref": "#/components/schemas/OptionsOrder" + }, + "type": { + "type": "string" + } + } + }, + "WorkflowSkipStepConfigurationDTO": { + "type": "object", + "properties": { + "condition": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowTaskConditionDTO" + } + }, + "condition_connector": { + "type": "string" + } + } + }, + "WorkflowTaskVerificationConditionDTO": { + "type": "object", + "properties": { + "verification_status": { + "$ref": "#/components/schemas/VerificationNameCondition" + }, + "operator": { + "$ref": "#/components/schemas/VerificationConditionOperator" + }, + "type": { + "type": "string" + } + } + }, + "WorkflowTaskPriorityConditionDTO": { + "type": "object", + "properties": { + "operator": { + "$ref": "#/components/schemas/PriorityConditionOperator" + }, + "priority_values": { + "$ref": "#/components/schemas/PriorityValues" + }, + "type": { + "type": "string" + } + } + }, + "access_request_configuration": { + "type": "object", + "properties": { + "read_only": { + "type": "boolean" + }, + "designer": { + "$ref": "#/components/schemas/DesignerModeCfgDTO" + }, + "risk_analysis": { + "type": "boolean" + }, + "security_zones": { + "type": "boolean" + }, + "verify_against": { + "type": "string" + }, + "view_targets": { + "type": "boolean" + }, + "source_destination_and_service_values": { + "type": "string" + }, + "allow_objects": { + "type": "boolean" + }, + "allow_access_request_import": { + "type": "boolean" + }, + "show_users_palo_alto": { + "type": "boolean" + }, + "notify_risk_disregard": { + "type": "boolean" + }, + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/local" + } + }, + "verifier": { + "type": "boolean" + }, + "auto_verifier": { + "type": "boolean" + }, + "block_if_not_verified": { + "type": "boolean" + }, + "tools_threshold": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + } + } + }, + "manual_assignment": { + "type": "object", + "properties": { + "assigner": { + "$ref": "#/components/schemas/local" + } + } + }, + "RiskSeverityCondition": { + "type": "object" + }, + "NonBusinessDayDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "from_date": { + "type": "string" + }, + "to_date": { + "type": "string" + } + } + }, + "WorkflowTaskConditionDTO": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + }, + "CertificationDecisionDTO": { + "type": "object", + "properties": { + "certification_duration": { + "$ref": "#/components/schemas/CertificationDurationDTO" + }, + "use_participant_email_as_certification_owner_email": { + "type": "boolean" + } + } + }, + "rule_modification_configuration": { + "type": "object", + "properties": { + "read_only": { + "type": "boolean" + }, + "designer": { + "$ref": "#/components/schemas/DesignerModeCfgDTO" + }, + "type": { + "type": "string" + } + } + }, + "ldap": { + "type": "object", + "properties": { + "ldapConfigurationName": { + "type": "string" + }, + "ldapConfigurationId": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "CustomTitleDTO": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/Status" + } + } + }, + "WorkflowTaskScriptedConditionDTO": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "boolean_value": { + "type": "boolean" + }, + "type": { + "type": "string" + } + } + }, + "rule_recertification_configuration": { + "type": "object", + "properties": { + "read_only": { + "type": "boolean" + }, + "certification_decision": { + "$ref": "#/components/schemas/CertificationDecisionPermissionDTO" + }, + "update_metadata": { + "type": "boolean" + }, + "type": { + "type": "string" + } + } + }, + "dynamic_assignment": { + "type": "object", + "properties": { + "task": { + "type": "array", + "items": { + "$ref": "#/components/schemas/dynamic_assignment_task" + } + } + } + }, + "RadiusProtocol": { + "type": "object" + }, + "WorkflowTaskLabelConditionDTO": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "operator": { + "$ref": "#/components/schemas/LabelConditionOperator" + }, + "type": { + "type": "string" + } + } + }, + "WorkflowTaskSlaStatusConditionDTO": { + "type": "object", + "properties": { + "sla_status": { + "$ref": "#/components/schemas/SLAStatus" + }, + "operator": { + "$ref": "#/components/schemas/SlaConditionOperator" + }, + "type": { + "type": "string" + } + } + }, + "CloudServerAutoAssociationRuleDTO": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Tag key to be auto associate by." + }, + "enabled": { + "type": "boolean", + "description": "Indication to disable/enable rule" + } + } + }, + "VMInstanceListDTO": { + "type": "object", + "properties": { + "vm_instance": { + "type": "array", + "items": { + "$ref": "#/components/schemas/vmInstanceDTO" + }, + "description": "List of cloud servers" + } + } + }, + "DeviceToUidsDTO": { + "type": "object", + "properties": { + "device_id": { + "type": "integer", + "format": "int32", + "description": "The ID of the device" + }, + "uid": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The UIDs of the cloud servers" + } + }, + "required": [ + "device_id", + "uid" + ] + }, + "DeviceToUidsListDTO": { + "type": "object", + "properties": { + "device_to_uids": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceToUidsDTO" + }, + "description": "List of device IDs and cloud server UIDs" + } + }, + "required": [ + "device_to_uids" + ] + }, + "CustomerDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the customer" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the customer" + }, + "status": { + "type": "string", + "description": "The status of the customer" + }, + "usage_mode": { + "type": "string", + "description": "The usage mode of the customer" + }, + "description": { + "type": "string", + "description": "The description of the customer" + } + }, + "required": [ + "name", + "id", + "usage_mode" + ] + }, + "CustomerListDTO": { + "type": "object", + "properties": { + "customer": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerDTO" + }, + "description": "The list of customers" + } + } + }, + "MarketplaceAppsListDTO": { + "type": "object", + "properties": { + "extension": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MarketplaceAppDTO" + }, + "description": "The list of extensions" + } + } + }, + "MarketplaceAppDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The extension name" + }, + "appId": { + "type": "string", + "description": "The extension id" + }, + "version": { + "type": "string", + "description": "The extension version" + }, + "url": { + "type": "string", + "description": "The product page for the extension" + }, + "installed": { + "type": "boolean", + "description": "The extension is installed" + }, + "description": { + "type": "string", + "description": "The extension description" + } + }, + "required": [ + "name", + "appId", + "version", + "url", + "installed", + "description" + ] + }, + "ExternalProviderResourceDTO": { + "type": "object", + "properties": { + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The resource reference ips" + }, + "resource_ref": { + "$ref": "#/components/schemas/resource_ref" + }, + "account_ref": { + "$ref": "#/components/schemas/account_ref" + } + } + }, + "ExternalProviderResourceListDTO": { + "type": "object", + "properties": { + "external_resource": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalProviderResourceDTO" + } + } + } + }, + "F5VirtualServerListDTO": { + "type": "object", + "properties": { + "f5_virtual_server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/F5VirtualServerDTO" + }, + "description": "The list of virtual servers and their details" + } + } + }, + "F5VirtualServerDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the virtual server in SecureTrack" + }, + "port": { + "type": "string", + "description": "The port that the virtual server is forwarding (Any is shown as \"-1\")" + }, + "protocol": { + "type": "string", + "description": "The protocol that the virtual server is forwarding" + }, + "uid": { + "type": "string", + "description": "The UID of the virtual server" + }, + "netmask": { + "type": "string", + "description": "The netmask for the virtual server VIP address" + }, + "virtual_ip": { + "type": "string", + "description": "The virtual IP address of the device" + }, + "pool_member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PoolMemberDTO" + }, + "description": "The server group members that are associated with the virtual server" + }, + "f5_device": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + } + }, + "zone_based_binding": { + "type": "object", + "properties": { + "zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "zones" + }, + "incoming_zone": { + "type": "string", + "description": "incoming zone" + }, + "outgoing_zone": { + "type": "string", + "description": "outgoing zone" + }, + "policy_map": { + "type": "string", + "description": "policy map" + } + } + }, + "GlobalLocation": { + "type": "object" + }, + "DesignerGroupChangeDTO": { + "type": "object", + "properties": { + "designer_change_networks_changed_in_group": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "designer_change_services_changed_in_group": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service" + } + }, + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "ImpactedRuleDTO": { + "type": "object", + "properties": { + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "server": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DecommissionedServerDTO" + }, + "description": "decommissioned servers that impact specific rule" + } + } + }, + "DesignerRuleChangeDTO": { + "type": "object", + "properties": { + "servicesChangedInRule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service" + } + }, + "changedRule": { + "$ref": "#/components/schemas/RuleDTO" + }, + "applicationAddedInRule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + } + }, + "destinationNetworkObjectsChangedInRule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "sourceNetworkObjectsChangedInRule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "DesignerDeviceChangeDTO": { + "type": "object", + "properties": { + "requestedNetworkObjectName": { + "type": "string" + }, + "changedNetworkObject": { + "$ref": "#/components/schemas/network_object" + }, + "changedService": { + "$ref": "#/components/schemas/service" + }, + "requestedServiceName": { + "type": "string" + }, + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "policy_block_binding": { + "type": "object", + "properties": { + "policy_block_name": { + "type": "string", + "description": "policy block name" + } + } + }, + "ImpactedDeviceDTO": { + "type": "object", + "properties": { + "impactedRulesCount": { + "type": "integer", + "format": "int32", + "description": "number of impacted rules for this device" + }, + "impacted_binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImpactedBindingDTO" + }, + "description": "impacted device bindings" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "ID of management" + }, + "management_name": { + "type": "string", + "description": "name of management" + }, + "device_type": { + "$ref": "#/components/schemas/CpType" + }, + "revision_id": { + "type": "integer", + "format": "int32", + "description": "revision id" + }, + "vendor_type": { + "$ref": "#/components/schemas/VendorTypeDTO" + }, + "revision_number": { + "type": "integer", + "format": "int32", + "description": "revision number" + }, + "administrator": { + "type": "string", + "description": "name of administrator that made the change" + }, + "changed_on": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "management_ip": { + "type": "string", + "description": "ip of management" + }, + "received_on": { + "$ref": "#/components/schemas/LocalDateTime" + } + }, + "required": [ + "management_id", + "revision_id" + ] + }, + "DesignerNotPossibleChangeDTO": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "DesignerRuleReplaceDTO": { + "type": "object", + "properties": { + "requestedRuleName": { + "type": "string" + }, + "requestedRuleComments": { + "type": "string" + }, + "replacementRule": { + "$ref": "#/components/schemas/RuleDTO" + }, + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "policy__binding": { + "type": "object", + "properties": { + "policy_name": { + "type": "string", + "description": "policy name" + }, + "installed_on_module": { + "type": "array", + "items": { + "type": "string" + }, + "description": "modules that this policy has been installed on" + } + } + }, + "HostInterfaceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "hostName": { + "type": "string" + }, + "interface_ips": { + "$ref": "#/components/schemas/InterfaceIpListDTO" + }, + "hostDisplayName": { + "type": "string" + } + } + }, + "result_expanded": { + "type": "object", + "properties": { + "impacted_device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImpactedDeviceDTO" + } + } + } + }, + "zone__binding": { + "type": "object", + "properties": { + "from_zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "names of from-zones" + }, + "to_zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "names of to-zones" + } + } + }, + "DesignerChangeGeneralDTO": { + "type": "object", + "properties": { + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "acl__binding": { + "type": "object", + "properties": { + "acl_name": { + "type": "string", + "description": "acl name" + }, + "incoming_interface_name": { + "type": "array", + "items": { + "type": "string" + }, + "description": "name of incoming interface" + }, + "outgoing_interface_name": { + "type": "array", + "items": { + "type": "string" + }, + "description": "name of outgoing interface" + } + } + }, + "DesignerSolutionDTO": { + "type": "object", + "properties": { + "binding_uid": { + "type": "string" + }, + "basedOnVersionId": { + "type": "integer", + "format": "int32" + }, + "binding_name": { + "type": "string" + }, + "designerChangesDTO": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerChangeGeneralDTO" + } + } + } + }, + "DesignerBindingChangeDTO": { + "type": "object", + "properties": { + "requestedRuleName": { + "type": "string" + }, + "changedRule": { + "$ref": "#/components/schemas/RuleDTO" + }, + "requestedRuleComments": { + "type": "string" + }, + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "directional__security__group__binding": { + "type": "object", + "properties": { + "direction": { + "type": "string", + "description": "direction" + }, + "enforcedOn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/HostInterfaceDTO" + }, + "description": "enforcedOn" + }, + "group_name": { + "type": "string", + "description": "group name" + } + } + }, + "Binding_DTO": { + "type": "object" + }, + "DecommissionedServerDTO": { + "type": "object", + "properties": { + "ip_address": { + "type": "array", + "items": { + "type": "string" + }, + "description": "decommissioned server IP addresses" + }, + "uuid": { + "type": "string", + "description": "uuid of server" + } + } + }, + "zone__with__policy__binding": { + "type": "object", + "properties": { + "policy_name": { + "type": "string" + } + } + }, + "RuleDTO": { + "type": "object", + "properties": { + "location": { + "$ref": "#/components/schemas/GlobalLocation" + }, + "line_number": { + "type": "integer", + "format": "int32" + }, + "global": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "textual_rep": { + "type": "string" + }, + "pv1_global": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingDTO" + } + }, + "order": { + "type": "integer", + "format": "int64" + }, + "disabled": { + "type": "boolean" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "cp_uid": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "security__group__binding": { + "type": "object", + "properties": { + "group_name": { + "type": "string", + "description": "group name" + } + } + }, + "DesignerSolutionPerTargetDTO": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "cp_type": { + "type": "string" + }, + "device_name": { + "type": "string" + }, + "vendor": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int32" + }, + "designerSolutionDTOs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerSolutionDTO" + } + }, + "globalChangeDTOs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerChangeGeneralDTO" + } + } + } + }, + "designer_results": { + "type": "object", + "properties": { + "solutionPerTarget": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerSolutionPerTargetDTO" + } + } + } + }, + "DesignerFullyImplementedChangeDTO": { + "type": "object", + "properties": { + "modifiedObjectName": { + "type": "string" + }, + "modifiedObjectUid": { + "type": "string" + }, + "changeAction": { + "type": "string" + }, + "aaaaImplicitChange": { + "type": "boolean" + }, + "designer_change_description": { + "type": "string" + } + } + }, + "non_existing_binding": { + "type": "object", + "properties": { + "incoming_interface_name": { + "type": "array", + "items": { + "type": "string" + }, + "description": "incoming interface name" + }, + "outgoing_interface_name": { + "type": "array", + "items": { + "type": "string" + }, + "description": "outgoing interface name" + } + } + }, + "ImpactedBindingDTO": { + "type": "object", + "properties": { + "binding": { + "$ref": "#/components/schemas/Binding_DTO" + }, + "impacted_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImpactedRuleDTO" + }, + "description": "rules impacted for specific device binding" + } + } + }, + "FieldFilterDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The field name to filter by" + }, + "value": { + "type": "string", + "description": "The field value to filter by" + } + } + }, + "QueryTypeDTO": { + "type": "object" + }, + "DetailedQueryFiltersDTO": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/FieldFilterDTO" + }, + "group": { + "type": "string", + "description": "The group to filter by" + }, + "domainId": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The domain IDs to filter by" + }, + "ticketId": { + "type": "integer", + "format": "int64", + "description": "The ticket ID filter by" + }, + "subject": { + "type": "string", + "description": "The subject to filter by" + }, + "requester": { + "type": "string", + "description": "The requester to filter by" + }, + "currentStepName": { + "type": "string", + "description": "The current step name to filter by" + }, + "ticketStatus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The ticket statuses to filter by" + }, + "priority": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The priorities to filter by" + }, + "taskStatus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The task statuses to filter by" + }, + "slaStatus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The sla statuses to filter by" + }, + "slaOutcome": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The sla outcomes to filter by" + }, + "slaTrackingState": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The sla tracking state to filter by" + }, + "assignedTo": { + "type": "string", + "description": "The 'assigned to' to filter by" + }, + "expiration": { + "$ref": "#/components/schemas/ExpirationFilterDTO" + } + } + }, + "QueryDTO": { + "type": "object" + }, + "SLATrackingStateDTO": { + "type": "object" + }, + "SLAOutcomeDTO": { + "type": "object" + }, + "QueryDTOList": { + "type": "object", + "properties": { + "query": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryDTO" + } + } + } + }, + "SLAStatusDTO": { + "type": "object" + }, + "FreeTextQuery": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The query name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The query ID" + }, + "type": { + "$ref": "#/components/schemas/QueryTypeDTO" + }, + "createDate": { + "type": "string", + "format": "date-time", + "description": "The date the query was created" + }, + "updateDate": { + "type": "string", + "format": "date-time", + "description": "The date the query was updated" + }, + "searchText": { + "type": "string", + "description": "The search text" + }, + "lastUsed": { + "type": "string", + "format": "date-time", + "description": "Last time the query was used" + }, + "description": { + "type": "string", + "description": "The query description" + } + }, + "required": [ + "name", + "searchText" + ] + }, + "DetailedQuery": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The query name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The query ID" + }, + "type": { + "$ref": "#/components/schemas/QueryTypeDTO" + }, + "filters": { + "$ref": "#/components/schemas/DetailedQueryFiltersDTO" + }, + "createDate": { + "type": "string", + "format": "date-time", + "description": "The date the query was created" + }, + "updateDate": { + "type": "string", + "format": "date-time", + "description": "The date the query was updated" + }, + "lastUsed": { + "type": "string", + "format": "date-time", + "description": "Last time the query was used" + }, + "description": { + "type": "string", + "description": "The query description" + } + }, + "required": [ + "name", + "filters" + ] + }, + "TaskStatusSearchEnumDTO": { + "type": "object" + }, + "ExpirationFilterDTO": { + "type": "object", + "properties": { + "fromDate": { + "type": "string", + "format": "date-time", + "description": "The expiration from date to filter by" + }, + "toDate": { + "type": "string", + "format": "date-time", + "description": "The expiration to date to filter by" + } + } + }, + "Group": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the group" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the group" + }, + "type": { + "$ref": "#/components/schemas/PartyTypeDTO" + }, + "membership": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AbstractGroupSearchDTO" + }, + "description": "The groups to which the user is a member" + } + } + }, + "PartyTypeDTO": { + "type": "object" + }, + "User": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the user" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyTypeDTO" + }, + "membership": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AbstractGroupSearchDTO" + }, + "description": "The groups to which the user is a member" + } + } + }, + "LocalGroup": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the group" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the group" + }, + "type": { + "$ref": "#/components/schemas/PartyTypeDTO" + }, + "membership": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AbstractGroupSearchDTO" + }, + "description": "The groups to which the user is a member" + } + } + }, + "CurrentStage": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the step" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the stage" + }, + "order": { + "type": "integer", + "format": "int32", + "description": "The order of the step" + }, + "task": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketTask" + }, + "description": "The list of tasks" + } + } + }, + "TicketTask": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the task" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the task" + }, + "handler": { + "$ref": "#/components/schemas/PartySearchDTO" + }, + "participant": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartySearchDTO" + }, + "description": "The list of potential handlers" + }, + "status": { + "$ref": "#/components/schemas/TicketTaskStatus" + }, + "task_business_duration": { + "type": "string", + "description": "The business duration of the task" + }, + "assigned_group": { + "$ref": "#/components/schemas/AbstractGroupSearchDTO" + }, + "unread_comments": { + "type": "boolean", + "description": "Whether the task comments have been read" + } + } + }, + "TicketDraftRequestSearchDTO": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "The priority of the ticket " + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The id of the request" + }, + "type": { + "type": "string", + "description": "The type of the request" + }, + "subject": { + "type": "string", + "description": "The subject of the request " + }, + "requester": { + "$ref": "#/components/schemas/AbstractUserRequestDTO" + }, + "update_date": { + "type": "string", + "format": "date-time", + "description": "The update date of the request " + }, + "workflow": { + "$ref": "#/components/schemas/WorkflowDTO_Requests" + }, + "ticket_draft_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the draft ticket " + }, + "domain": { + "$ref": "#/components/schemas/Domain" + } + }, + "required": [ + "priority", + "id", + "type", + "subject", + "requester", + "workflow", + "ticket_draft_id", + "domain" + ] + }, + "RequiredAttentionTypeDTO": { + "type": "object" + }, + "TicketTaskStatus": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/TaskStatusSearchEnumDTO" + }, + "reason": { + "type": "string", + "description": "The task status reason" + } + } + }, + "AbstractUserRequestDTO": { + "type": "object" + }, + "RequestsSearchListDTO": { + "type": "object", + "properties": { + "request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestSearchDTO" + }, + "description": " The list of requests" + } + } + }, + "TicketRequestSearchDTO": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "The priority of the ticket " + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The id of the request " + }, + "type": { + "type": "string", + "description": "The type of the request" + }, + "status": { + "type": "string", + "description": "The status of the ticket " + }, + "ticket_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the ticket " + }, + "subject": { + "type": "string", + "description": "The subject of the request " + }, + "requester": { + "$ref": "#/components/schemas/AbstractUserRequestDTO" + }, + "create_date": { + "type": "string", + "format": "date-time", + "description": "The create date of the request " + }, + "update_date": { + "type": "string", + "format": "date-time", + "description": "The update date of the request " + }, + "current_step": { + "$ref": "#/components/schemas/CurrentStage" + }, + "workflow": { + "$ref": "#/components/schemas/WorkflowDTO_Requests" + }, + "required_attention": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequiredAttentionDTO" + }, + "description": "The required attentions of the ticket " + }, + "application_details": { + "$ref": "#/components/schemas/ApplicationDetails" + }, + "completion_ticket_details": { + "$ref": "#/components/schemas/CompletionTicketDetailsDTO" + }, + "domain": { + "$ref": "#/components/schemas/Domain" + } + }, + "required": [ + "priority", + "type", + "requester", + "current_step", + "workflow", + "required_attention", + "completion_ticket_details", + "domain" + ] + }, + "CompletionTicketDetailsDTO": { + "type": "object", + "properties": { + "user": { + "$ref": "#/components/schemas/AbstractUserRequestDTO" + }, + "last_active_step": { + "$ref": "#/components/schemas/CurrentStage" + } + } + }, + "ApplicationDetails": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the application" + }, + "domain": { + "$ref": "#/components/schemas/Domain" + } + } + }, + "RequiredAttentionDTO": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/RequiredAttentionTypeDTO" + } + } + }, + "PartySearchDTO": { + "type": "object" + }, + "LocalUser": { + "type": "object", + "properties": { + "user": { + "type": "string", + "description": "The name of the user" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyTypeDTO" + }, + "first_name": { + "type": "string", + "description": "The first name of the user" + }, + "last_name": { + "type": "string", + "description": "The last name of the user" + }, + "membership": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AbstractGroupSearchDTO" + }, + "description": "The groups to which the user is a member" + } + } + }, + "AbstractGroupSearchDTO": { + "type": "object" + }, + "RequestSearchDTO": { + "type": "object" + }, + "Domain": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the domain" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the domain" + } + } + }, + "prov": { + "type": "object", + "properties": { + "status": { + "type": "string" + } + } + }, + "DeviceIdsListDTO": { + "type": "object", + "properties": { + "id": { + "type": "array", + "items": { + "type": "integer" + } + }, + "v2_id": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "sc_device": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The device name" + }, + "id": { + "type": "integer", + "format": "int32", + "description": "The device ID" + }, + "device_type": { + "type": "string", + "description": "The device type" + }, + "ip": { + "type": "string", + "description": "The device IP" + }, + "vendor": { + "type": "string", + "description": "The device vendor" + }, + "external_uid": { + "type": "string", + "description": "The external uid" + }, + "external_parent_uid": { + "type": "string", + "description": "The external parent uid" + }, + "tenant_id": { + "type": "string", + "description": "The tenant id" + }, + "v2_id": { + "type": "string", + "description": "The device v2 ID" + }, + "domain": { + "$ref": "#/components/schemas/DomainDTO" + }, + "system_id": { + "type": "string", + "description": "The device system ID" + } + }, + "required": [ + "name", + "id", + "device_type", + "ip", + "vendor", + "v2_id", + "domain", + "system_id" + ] + }, + "scw-devices": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/ScwLicenseType" + }, + "status": { + "type": "string" + } + } + }, + "DeviceListDTO": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sc_device" + } + } + } + }, + "ScwLicenseType": { + "type": "object" + }, + "LicenseDTO": { + "type": "object", + "properties": { + "status": { + "type": "string" + } + } + }, + "SecureTrackSettingsDTO": { + "type": "object", + "properties": { + "internal_IP_of_secureChange_server": { + "type": "string", + "description": "The internal IP of SecureChange server" + }, + "check_connection_interval": { + "type": "integer", + "format": "int32", + "description": "Connection check interval (in seconds)" + }, + "show_link_to_secureTrack": { + "type": "string", + "description": "Is show link to SecureTrack enabled" + }, + "host": { + "$ref": "#/components/schemas/HostDTO" + } + }, + "required": [ + "host" + ] + }, + "HostDTO": { + "type": "object", + "properties": { + "password": { + "type": "string", + "description": "The SecureTrack administrator password" + }, + "user_name": { + "type": "string", + "description": "The SecureTrack administrator username:" + } + }, + "required": [ + "password", + "user_name" + ] + }, + "SecureTrackConnectivityDTO": { + "type": "object", + "properties": { + "connected": { + "type": "boolean", + "description": "Is SecureChange connected to SecureTrack and SecureTrack connected to SecureChange" + }, + "connection_message": { + "type": "string", + "description": "Connection to SecureTrack message" + }, + "connection_code": { + "type": "string", + "description": "Connection to SecureTrack code" + } + } + }, + "remoteHost": { + "type": "object", + "properties": { + "IP_or_hostname": { + "type": "string", + "description": "The SecureTrack server: IP or hostname " + }, + "password": { + "type": "string", + "description": "The SecureTrack administrator password" + }, + "user_name": { + "type": "string", + "description": "The SecureTrack administrator username:" + } + }, + "required": [ + "IP_or_hostname", + "password", + "user_name" + ] + }, + "localHost": { + "type": "object", + "properties": { + "password": { + "type": "string", + "description": "The SecureTrack administrator password" + }, + "user_name": { + "type": "string", + "description": "The SecureTrack administrator username:" + } + }, + "required": [ + "password", + "user_name" + ] + }, + "IntegrationWithSecureTrackDTO": { + "type": "object", + "properties": { + "secureTrack_settings": { + "$ref": "#/components/schemas/SecureTrackSettingsDTO" + }, + "connection_to_secureTrack": { + "$ref": "#/components/schemas/SecureTrackConnectivityDTO" + } + } + }, + "GroupChangeDTO": { + "type": "object", + "properties": { + "member_ids_to_add": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The member IDs to add to the group" + }, + "member_ids_to_remove": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The member IDs to remove from the group" + } + } + }, + "CreateGroupDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the group" + }, + "email": { + "type": "string", + "description": "The email of the group" + }, + "description": { + "type": "string", + "description": "The description of the group" + } + }, + "required": [ + "name" + ] + }, + "LdapPartyDTO": { + "type": "object", + "properties": { + "ldap_dn": { + "type": "string", + "description": "The LDAP dn of the imported user / group" + }, + "ldap_configuration_name": { + "type": "string", + "description": "The LDAP configuration name" + } + }, + "required": [ + "ldap_dn", + "ldap_configuration_name" + ] + }, + "TicketHistoryDTO": { + "type": "object", + "properties": { + "task_name": { + "type": "string", + "description": "The task name" + }, + "step_name": { + "type": "string", + "description": "The step name" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "date" + }, + "performed_by": { + "type": "string", + "description": "performed by" + }, + "description": { + "type": "string", + "description": "description" + } + }, + "required": [ + "task_name", + "step_name", + "date", + "performed_by", + "description" + ] + }, + "DesignerUpdateDeviceHistoryDTO": { + "type": "object", + "properties": { + "vendor_name": { + "type": "string", + "description": "vendor name" + }, + "device_name": { + "type": "string", + "description": "device name" + }, + "push_command_result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PushCommandResultDTO" + }, + "description": "push command results" + }, + "task_name": { + "type": "string", + "description": "The task name" + }, + "step_name": { + "type": "string", + "description": "The step name" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "date" + }, + "performed_by": { + "type": "string", + "description": "performed by" + }, + "description": { + "type": "string", + "description": "description" + } + }, + "required": [ + "task_name", + "step_name", + "date", + "performed_by", + "description" + ] + }, + "task_assignment_data": { + "type": "object", + "properties": { + "assignee_id": { + "type": "string", + "description": "the internal id of the assignee" + }, + "assignee_name": { + "type": "string", + "description": "the name of the assignee" + }, + "participant_id": { + "type": "string", + "description": "the internal id of the assignee party" + }, + "participant_name": { + "type": "string", + "description": "the name of the assignee party" + } + }, + "required": [ + "assignee_id", + "assignee_name", + "participant_id", + "participant_name" + ] + }, + "TicketHistoryListDTO": { + "type": "object", + "properties": { + "ticket_id": { + "type": "integer", + "format": "int64", + "description": "The ticket ID" + }, + "ticket_history_activity": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketHistoryDTO" + }, + "description": "The ticket history" + } + }, + "required": [ + "ticket_id", + "ticket_history_activity" + ] + }, + "TicketEvent": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "the type of the event" + }, + "timestamp": { + "type": "string", + "description": "the timestamp of the event" + }, + "domain_id": { + "type": "string", + "description": "the id of the domain" + }, + "ticket_id": { + "type": "string", + "description": "the id of the ticket" + }, + "task_id": { + "type": "string", + "description": "the internal id of the task" + }, + "workflow_type": { + "type": "string", + "description": "workflow type" + }, + "business_duration": { + "type": "integer", + "format": "int64", + "description": "the business duration" + }, + "sla_status": { + "type": "string", + "description": "the sla status" + }, + "workflow_name": { + "type": "string", + "description": "the name of the workflow" + }, + "task_name": { + "type": "string", + "description": "the name of the task" + }, + "parent_workflow_id": { + "type": "string", + "description": "the internal id of the parent workflow" + }, + "step_id": { + "type": "string", + "description": "the internal id of the step" + }, + "step_name": { + "type": "string", + "description": "the name of the step" + }, + "assignment_type": { + "type": "string", + "description": "the type of the assignment. possible types are: assigner, self assigned and reassign group" + }, + "task_assigned_data": { + "$ref": "#/components/schemas/task_assignment_data" + }, + "initiated_by": { + "type": "string", + "description": "initiated by" + }, + "potential_participants": { + "type": "array", + "items": { + "type": "string" + }, + "description": "the potential participants from the workflow" + }, + "error_automation_tool": { + "$ref": "#/components/schemas/error_automation_tool" + } + }, + "required": [ + "type", + "timestamp", + "domain_id", + "ticket_id", + "workflow_name", + "parent_workflow_id" + ] + }, + "CommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + } + }, + "required": [ + "comment" + ] + }, + "error_automation_tool": { + "type": "object", + "properties": { + "error_tool": { + "type": "string", + "description": "the automation tool that failed" + }, + "error_reason": { + "type": "array", + "items": { + "type": "string" + }, + "description": "the reason for the error" + } + } + }, + "Companion": { + "type": "object" + }, + "RejectCommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + } + }, + "required": [ + "comment" + ] + }, + "TicketEventsCreateHistoryStatusDTO": { + "type": "object", + "properties": { + "run_status": { + "$ref": "#/components/schemas/HistoryStatus" + }, + "oldest_event_time": { + "type": "string", + "description": "Oldest event time" + } + }, + "required": [ + "run_status" + ] + }, + "PushCommandResultDTO": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "status" + }, + "order": { + "type": "integer", + "format": "int32", + "description": "order" + }, + "command": { + "type": "string", + "description": "command" + }, + "failure_reason": { + "type": "string", + "description": "failure reason" + } + } + }, + "HistoryStatus": { + "type": "object" + }, + "TicketEventsCreateHistoryRequestDTO": { + "type": "object", + "properties": { + "from": { + "type": "string", + "description": "from date. Date format expected: yyyy-MM-dd" + } + }, + "required": [ + "from" + ] + }, + "ReassignTaskCommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + } + }, + "required": [ + "comment" + ] + }, + "potential_participant": { + "type": "object", + "properties": { + "participant_id": { + "type": "string", + "description": "the internal id of the participant" + }, + "participant_name": { + "type": "string", + "description": "the name of the participant" + } + }, + "required": [ + "participant_id", + "participant_name" + ] + }, + "RedoStepCommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + } + }, + "required": [ + "comment" + ] + }, + "TicketEventListDTO": { + "type": "object", + "properties": { + "ticket_event": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketEvent" + }, + "description": "The ticket event list" + }, + "countOfElemnt": { + "type": "integer", + "format": "int32" + }, + "totalElement": { + "type": "integer", + "format": "int64" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of items that can be retrieved" + } + }, + "required": [ + "ticket_event", + "count", + "total" + ] + }, + "ConfirmCommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string" + } + }, + "required": [ + "comment" + ] + }, + "InstructionStatus": { + "type": "object" + }, + "CoveredByField": { + "type": "object", + "properties": { + "order": { + "type": "integer", + "format": "int32", + "description": "Order" + }, + "type": { + "type": "string", + "description": "Field type" + } + }, + "required": [ + "order", + "type" + ] + }, + "RootDevice": { + "type": "object", + "properties": { + "api_v1_id": { + "type": "integer", + "format": "int32", + "description": "API v1 ID" + } + }, + "required": [ + "api_v1_id" + ] + }, + "tags": { + "type": "object", + "properties": { + "values": { + "type": "array", + "items": { + "type": "string" + } + }, + "new_value": { + "type": "string" + } + } + }, + "AccessRequestsSecurityZonesDTO": { + "type": "object", + "properties": { + "access_request_security_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRequestSecurityZoneDTO" + }, + "description": "The list of access request security zone" + } + }, + "required": [ + "access_request_security_zone" + ] + }, + "AccessRequestSecurityZoneDTO": { + "type": "object", + "properties": { + "security_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityZoneDTO" + }, + "description": "The security zones of the destination" + }, + "access_request": { + "$ref": "#/components/schemas/AccessRequestDTO" + } + } + }, + "user_name": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "object_name": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "CommitDeviceResultDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "policy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommitPolicyResultDTO" + } + }, + "status": { + "$ref": "#/components/schemas/CommitStatusDTO" + }, + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "warning": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ChangedEntity": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name" + }, + "type": { + "type": "string", + "description": "The entity type" + }, + "uid": { + "type": "string", + "description": "UID" + }, + "new_entity_uid": { + "type": "string", + "description": "The new entity UID" + } + }, + "required": [ + "type" + ] + }, + "user_replace": { + "type": "object", + "properties": { + "old_value": { + "type": "string" + }, + "new_value": { + "type": "string" + } + } + }, + "rule_order": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "TicketListDTO": { + "type": "object", + "properties": { + "next": { + "$ref": "#/components/schemas/LinkDTO" + }, + "previous": { + "$ref": "#/components/schemas/LinkDTO" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketDTO" + }, + "description": "The list of tickets" + } + }, + "required": [ + "next", + "previous", + "ticket" + ] + }, + "rule_placement": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "DesignerResults": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The designer results ID" + }, + "status": { + "type": "string", + "description": "Result Status" + }, + "root_device": { + "$ref": "#/components/schemas/Device" + }, + "new_revision_status": { + "type": "string", + "description": "Revision status" + }, + "total_devices_results": { + "type": "integer", + "format": "int32", + "description": "Total devices results count per system ID" + }, + "device_results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceResults" + }, + "description": "Designer results for a device" + }, + "system_id": { + "type": "string", + "description": "The designer results system ID" + } + }, + "required": [ + "id", + "status", + "root_device", + "new_revision_status", + "total_devices_results", + "device_results", + "system_id" + ] + }, + "CombinedPolicy": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name" + }, + "uid": { + "type": "string", + "description": "UID" + } + }, + "required": [ + "name", + "uid" + ] + }, + "rule_name": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "security_groups": { + "type": "object", + "properties": { + "values": { + "type": "array", + "items": { + "type": "string" + } + }, + "new_value": { + "type": "string" + } + } + }, + "InstructionStatusResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Errors" + } + }, + "required": [ + "id", + "errors" + ] + }, + "DeviceProvisioningStatus": { + "type": "object" + }, + "ReplaceInstructionResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Status" + }, + "instructions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InstructionStatusResult" + }, + "description": "Instructions" + } + }, + "required": [ + "status", + "instructions" + ] + }, + "BusinessDurationRequestDTO": { + "type": "object", + "properties": { + "from": { + "type": "string", + "description": "the creation date of the affected tickets. Default value if not set is 2 years ago. Date format expected: yyyy-MM-dd. Value is limited for up to 2 years ago." + } + }, + "required": [ + "from" + ] + }, + "TicketPropertiesDTO": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "The priority of the ticket (use 'Critical, High, Normal, Low')" + }, + "expiration_date": { + "type": "string", + "description": "The expiration date of the ticket (use yyyy-mm-dd for update and empty value for NONE)" + }, + "referenced_ticket": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "notification_group": { + "$ref": "#/components/schemas/group" + } + } + }, + "CommitPolicyResultDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "fw_result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommitTargetResultDTO" + } + }, + "status": { + "$ref": "#/components/schemas/CommitStatusDTO" + }, + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "warning": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Field": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Field type" + } + }, + "required": [ + "type" + ] + }, + "ZoneDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the zone" + }, + "id": { + "type": "string", + "description": "The ID of the zone" + } + } + }, + "ProvisioningStatus": { + "type": "object" + }, + "comment": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "DeviceResults": { + "type": "object", + "properties": { + "device": { + "$ref": "#/components/schemas/Device" + }, + "new_revision_status": { + "type": "string", + "description": "Revision status" + }, + "policy_suggestions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicySuggestions" + }, + "description": "Policy suggestions" + } + }, + "required": [ + "device", + "new_revision_status", + "policy_suggestions" + ] + }, + "Instruction": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Instruction ID" + }, + "change_type": { + "type": "string", + "description": "Type of instruction change" + }, + "changed_entity": { + "$ref": "#/components/schemas/ChangedEntity" + }, + "relation_changes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelationChange" + }, + "description": "Relation changes" + }, + "customization_type": { + "type": "string", + "description": "Type of customization" + } + }, + "required": [ + "id", + "change_type", + "changed_entity", + "relation_changes" + ] + }, + "SystemResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Result status" + }, + "redesign_status": { + "$ref": "#/components/schemas/RedesignStatusDTO" + }, + "root_device": { + "$ref": "#/components/schemas/RootDevice" + }, + "system_name": { + "type": "string", + "description": "System name" + }, + "href": { + "$ref": "#/components/schemas/LinkDTO" + }, + "system_id": { + "type": "string", + "description": "System ID" + } + }, + "required": [ + "status", + "redesign_status", + "root_device", + "system_name", + "href", + "system_id" + ] + }, + "CommitReportDTO": { + "type": "object", + "properties": { + "endTime": { + "type": "string" + }, + "duration": { + "type": "string" + }, + "vendorName": { + "type": "string" + }, + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommitDeviceResultDTO" + } + }, + "ticketId": { + "type": "integer", + "format": "int64" + }, + "managmentName": { + "type": "string" + }, + "notRunReason": { + "type": "string" + }, + "startTime": { + "type": "string" + } + } + }, + "ResultDetails": { + "type": "object", + "properties": { + "instructions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Instruction" + }, + "description": "Instructions" + }, + "covered_by_fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CoveredByField" + }, + "description": "Covered by fields" + }, + "nat_on_path": { + "type": "boolean", + "description": "Set to true to get the NAT on path" + } + }, + "required": [ + "instructions", + "covered_by_fields", + "nat_on_path" + ] + }, + "Instructions": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ResultDetails" + }, + "status": { + "type": "string", + "description": "Status" + }, + "access_request": { + "$ref": "#/components/schemas/Field" + }, + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "required": [ + "status", + "access_request" + ] + }, + "EmbeddedEntity": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Entity type" + } + }, + "required": [ + "type" + ] + }, + "ProvisioningInstructionDTO": { + "type": "object", + "properties": { + "error_message": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/InstructionStatus" + }, + "instruction_id": { + "type": "string" + } + } + }, + "track_level": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "DeviceProvisioningResultDTO": { + "type": "object", + "properties": { + "device_id": { + "type": "string" + }, + "device_provisioning_status": { + "$ref": "#/components/schemas/DeviceProvisioningStatus" + }, + "provisioning_instruction_status": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProvisioningInstructionDTO" + } + } + } + }, + "ProvisioningResultListDTO": { + "type": "object", + "properties": { + "provisioning_link": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LinkDTO" + }, + "description": "The provisioning result links list" + } + }, + "required": [ + "provisioning_link" + ] + }, + "CommitTargetResultDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/CommitStatusDTO" + }, + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "warning": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "change": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "SecurityZoneDTO": { + "type": "object", + "properties": { + "any": { + "type": "boolean", + "description": "The security zone is all" + }, + "zone": { + "$ref": "#/components/schemas/ZoneDTO" + }, + "network_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectDTO" + }, + "description": "The list of network objects " + } + } + }, + "RelationChange": { + "type": "object", + "properties": { + "entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EntityReference" + }, + "description": "Entities" + }, + "relation_change_Type": { + "type": "string", + "description": "Change type" + }, + "relation": { + "type": "string", + "description": "Relation" + }, + "predefined_value": { + "type": "string", + "description": "Predefined value" + }, + "embedded_entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EmbeddedEntity" + }, + "description": "Embedded entities" + } + }, + "required": [ + "entities", + "relation_change_Type", + "relation", + "embedded_entities" + ] + }, + "SystemResultListDTO": { + "type": "object", + "properties": { + "system_result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemResult" + }, + "description": "The system result list" + } + }, + "required": [ + "system_result" + ] + }, + "DesignerCommandsDTO": { + "type": "object", + "properties": { + "command": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AccessRequestDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the access request" + }, + "order": { + "type": "string", + "description": "The order of the access request" + } + } + }, + "Device": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The device name" + }, + "uid": { + "type": "string", + "description": "The device UID" + }, + "v1_id": { + "type": "string", + "description": "The device V1 ID" + } + }, + "required": [ + "name", + "uid", + "v1_id" + ] + }, + "ProvisioningSystemResult": { + "type": "object", + "properties": { + "error_message": { + "type": "string" + }, + "provisioning_status": { + "$ref": "#/components/schemas/ProvisioningStatus" + }, + "device_provisioning_results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceProvisioningResultDTO" + } + }, + "redesigned_after_provisioning": { + "type": "boolean" + }, + "system_id": { + "type": "string" + } + } + }, + "PolicySuggestions": { + "type": "object", + "properties": { + "combined_policy": { + "$ref": "#/components/schemas/CombinedPolicy" + }, + "access_request_instructions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Instructions" + }, + "description": "The access request instructions" + } + }, + "required": [ + "access_request_instructions" + ] + }, + "EntityReference": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name" + }, + "type": { + "type": "string", + "description": "Entity type" + }, + "uid": { + "type": "string", + "description": "UID" + }, + "new_entity_uid": { + "type": "string", + "description": "The new entity UID" + } + }, + "required": [ + "name", + "type" + ] + }, + "log_forwarding_profile": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "object_replace": { + "type": "object", + "properties": { + "old_value": { + "type": "string" + }, + "new_value": { + "type": "string" + } + } + }, + "Error": { + "type": "object", + "properties": { + "error_code": { + "type": "string", + "description": "Error code" + } + }, + "required": [ + "error_code" + ] + }, + "security_profile_group": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "TriggerDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "workflow": { + "$ref": "#/components/schemas/WorkflowDTO_Triggers" + }, + "event": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Event" + } + } + } + }, + "Event": { + "type": "object" + }, + "WorkflowTriggerDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "executer": { + "$ref": "#/components/schemas/ExecuterDTO" + }, + "trigger": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TriggerDTO" + } + } + } + }, + "WorkflowTriggersDTO": { + "type": "object", + "properties": { + "workflow_trigger": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowTriggerDTO" + } + } + } + }, + "ScriptDTO": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "arguments": { + "type": "string" + } + } + }, + "ExecuterDTO": { + "type": "object" + }, + "BasicWorkflowInfoListDTO": { + "type": "object", + "properties": { + "workflow": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BasicWorkflowInfoDTO" + } + } + } + }, + "BasicWorkflowInfoDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "Action": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "BindingDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "CommitStatusDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "CpType": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "DecommissionResultDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "Optional": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "Origin": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "StatusDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "VendorTypeDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "attachment": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "http_www.tufin.com_sc_RuleOperationDeviceDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "void": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + } + } + }, + "paths": { + "/securechangeworkflow/api/securechange/attachments/": { + "post": { + "tags": [ + "Attachments" + ], + "operationId": "addAttachment", + "summary": "Upload a file to attach to a ticket", + "description": "Uploads a file to the server. Use the returned UUID to link this file to a ticket comment via the 'Add a new comment to a ticket' API.\nThis operation requires permission to create or handle tickets.\nMaximum size of a file attachment: 10 MB.\nRequests must set the 'multipart/form-data' content type header and include a form field named 'attachment' containing the file content.", + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + } + }, + "responses": { + "201": { + "description": "File attachment was uploaded successfully" + }, + "400": { + "description": "File name: <FILE NAME> contains the following invalid characters: <CHARACTERS>. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters: + - _ # @ . : / = ! ^ ( ) ," + }, + "403": { + "description": "Access is denied" + }, + "413": { + "description": "Request Entity Too Large" + } + } + } + }, + "/securechangeworkflow/api/securechange/attachments/{uid}": { + "get": { + "tags": [ + "Attachments" + ], + "operationId": "getFileAttachment", + "summary": "Download an attached file", + "description": "Only users who have access to the containing ticket can download the attached file.\nIf a file is not yet attached to a ticket, only the user who uploaded the file can download it.\nThe name of the downloaded file is returned in the Filename field of the content-disposition header.\nThe file content is returned in the response body.", + "parameters": [ + { + "name": "uid", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "File attachment uuid" + } + ], + "responses": { + "200": { + "description": "File attachment was fetched successfully" + }, + "400": { + "description": "Invalid UUID string: <UUID>" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "You do not have permission to download this attachment. Contact your administrator for assistance" + }, + "404": { + "description": "There is no attachment with uuid: <UUID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/change_audit/": { + "get": { + "tags": [ + "Change Audit" + ], + "operationId": "getAllChangesAudits", + "summary": "List all available records from change audit table", + "parameters": [ + { + "name": "show_changes", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Display the values before and after the change" + }, + { + "name": "from_date", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Display the records from after the specified date" + }, + { + "name": "to_date", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Display the records from before the specified date" + }, + { + "name": "type", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Display the records of the changed entities belonging to the specified type" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Display the records of the changed entities with the specified name" + }, + { + "name": "id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Display the records of the changed entities with the specified ID" + }, + { + "name": "user", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Display the records of the changes that were done by an admin with the specified user name" + } + ], + "responses": { + "200": { + "description": "List all available records from change audit table", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ChangeAuditListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/devices/": { + "get": { + "tags": [ + "SecureChange Devices" + ], + "operationId": "getDevices", + "summary": "Get details of target devices", + "parameters": [ + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "device name or part of a name" + }, + { + "name": "show_targets", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "show_targets true: Returns the details of devices that can be selected as a target in Access Request tickets
show_targets false: Returns the details of devices with objects that can be used in tickets" + } + ], + "responses": { + "404": { + "description": "Devices not found" + }, + "200": { + "description": "Get details of target devices", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/DeviceListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/devices/excluded": { + "get": { + "tags": [ + "SecureChange Devices" + ], + "operationId": "getExcludedDevices", + "summary": "Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange", + "description": "For example on this Panorama hierarchy:\nDG1 - Excluded\n  DG1.1\n    FW1\n    FW2\n    FW3\n\nCalling this API with false value will return only DG1's id.\nCalling this API with true value will return DG1, FW1, FW2, FW3 id's.", + "parameters": [ + { + "name": "show_all", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "When set to true - Displays the specified devices and all their child firewalls in the hierarchy, which will be excluded implicitly.
When set to false - Displays only the devices which were explicitly excluded.
Default value is false.
" + } + ], + "responses": { + "200": { + "description": "Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/DeviceIdsListDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "SecureChange Devices" + ], + "operationId": "putExcludedDevices", + "summary": "Update the whole list of excluded devices in SecureChange", + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeviceIdsListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Update the whole list of excluded devices in SecureChange" + } + } + } + }, + "/securechangeworkflow/api/securechange/devices/suggest_target": { + "post": { + "tags": [ + "SecureChange Devices" + ], + "operationId": "suggestTarget", + "summary": "Get suggested targets for a given access request", + "description": "Returns a list of suggested targets for a given access request, based on topology calculations.", + "parameters": [ + { + "name": "domain_name", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "Domain Name" + }, + { + "name": "workflow_name", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "Workflow Name" + } + ], + "requestBody": { + "required": false, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/AccessRuleDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Targets returned successfully", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/multi_target" + } + } + } + }, + "400": { + "description": "User does not have permissions to domain or domain does not exist" + }, + "403": { + "description": "Access is denied" + } + } + } + }, + "/securechangeworkflow/api/securechange/domains/": { + "get": { + "tags": [ + "Domains" + ], + "operationId": "getDomains", + "summary": "List all domains", + "parameters": [ + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The name of the domain" + } + ], + "responses": { + "404": { + "description": "There are no domains with the name NAME." + }, + "200": { + "description": "List all domains", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/DomainsListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/domains/synchronize": { + "put": { + "tags": [ + "Domains" + ], + "operationId": "synchronize", + "summary": "synchronize domains", + "description": "Retrieves all the domains lists in ST , for use by SC. If a domain was deleted in ST, then it will be removed from SC", + "responses": { + "500": { + "description": "Multi-Domain mode is disabled in SecureChange. Unable to synchronize with SecureTrack domains" + }, + "200": { + "description": "synchronize domains" + } + } + } + }, + "/securechangeworkflow/api/securechange/domains/{domainId}": { + "get": { + "tags": [ + "Domains" + ], + "operationId": "getDomain", + "summary": "Fetches domain by ID", + "parameters": [ + { + "name": "domainId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the domain" + } + ], + "responses": { + "400": { + "description": "Domain with id ID was not found." + }, + "200": { + "description": "Fetches domain by ID", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/DomainDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/extensions/": { + "get": { + "tags": [ + "Extensions" + ], + "operationId": "getAllMarketplaceApps", + "summary": "List of all extensions ", + "description": "Returns the list of all Tufin Extensions and their status in this deployment.", + "responses": { + "401": { + "description": "Unauthorized" + }, + "200": { + "description": "List of all extensions ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/MarketplaceAppsListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/externalprovider/resources": { + "get": { + "tags": [ + "External Provider" + ], + "operationId": "getResources", + "summary": "Returns a detailed list of the external network resources available to SeucreChange from external provider (SecureCloud or alternate)", + "parameters": [ + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Filter by name (substring, case insensitive) " + }, + { + "name": "uid", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Filter by resource ref ID (exact match, case sensitive) " + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Limit number of results (default is 100)" + } + ], + "responses": { + "403": { + "description": "User has no permissions to view SecureCloud/Alternate provider resources" + }, + "404": { + "description": "SecureCloud/Alternate provider disabled. Contact your administrator for assistance." + }, + "400": { + "description": "name and uid parameters cannot be used in same query." + }, + "200": { + "description": "Returns a detailed list of the external network resources available to SeucreChange from external provider (SecureCloud or alternate)", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ExternalProviderResourceListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/integration_with_secureTrack/": { + "get": { + "tags": [ + "System Configuration" + ], + "operationId": "getIntegrationWithSecureTrack", + "summary": "Retrieve the SecureTrack connection settings and status", + "responses": { + "200": { + "description": "Retrieve the SecureTrack connection settings and status", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/IntegrationWithSecureTrackDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "System Configuration" + ], + "operationId": "modifySecureTrackSettings", + "summary": "Modify the SecureTrack connection settings and test the connection status", + "parameters": [ + { + "name": "testOnly", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Test the connection status using the specified settings. The new settings are not saved. The default value is false" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SecureTrackSettingsDTO" + } + } + } + }, + "responses": { + "400": { + "description": "show_link_to_secureTrack is invalid. It must be 'true', 'false' or empty." + }, + "200": { + "description": "Modify the SecureTrack connection settings and test the connection status", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/SecureTrackConnectivityDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/queries/": { + "post": { + "tags": [ + "Queries" + ], + "operationId": "createQuery", + "summary": "Create new query", + "description": "The query syntax should follow the rules in: (Free search syntax rules)", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/QueryDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Access is denied" + }, + "400": { + "description": "Invalid filter: <FILTER_NAME> syntax" + } + } + }, + "get": { + "tags": [ + "Queries" + ], + "operationId": "getSavedQueries", + "summary": "Returns the queries details", + "description": "Returns a list of queries saved by the current user.\nReturns only basic information about each query.", + "responses": { + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "200": { + "description": "Returns the queries details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueryDTOList" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/queries/{id}": { + "get": { + "tags": [ + "Queries" + ], + "operationId": "getQuery", + "summary": "Returns the query's details", + "description": "Returns a specific query saved by the current user.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Query ID" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/QueryDTO" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Access is denied" + }, + "400": { + "description": "The query ID does not exist, or you do not have the required permissions" + } + } + }, + "put": { + "tags": [ + "Queries" + ], + "operationId": "updateQuery", + "summary": "Update an existing query", + "description": "The query syntax should follow the rules in: (Free search syntax rules)", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Query ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/QueryDTO" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Access is denied" + }, + "400": { + "description": "Invalid filter: <FILTER_NAME> syntax" + } + } + }, + "delete": { + "tags": [ + "Queries" + ], + "operationId": "deleteQuery", + "summary": "Delete query", + "description": "Delete a query created by the current user", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Query ID" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Access is denied" + }, + "400": { + "description": "The query ID does not exist, or you do not have the required permissions" + } + } + } + }, + "/securechangeworkflow/api/securechange/requests/search": { + "get": { + "tags": [ + "Requests" + ], + "operationId": "searchRequests", + "summary": "Returns the list of requests by search parameters.", + "description": "The API returns both tickets and ticket drafts.\r\nPass an OR value to the logicalOperator parameter to use a logical OR relationship between search parameters. Default value: AND.(Search syntax details)" + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Offset the count starting point" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Tickets list max length (max value is 1000)" + }, + { + "name": "ids_only", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Set to true to get only the tickets' ID" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "206": { + "description": "Partial Content" + }, + "400": { + "description": "Illegal count value entered. Max value is 1000" + }, + "403": { + "description": "Access is denied." + }, + "404": { + "description": "No entity found for query" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/lifecycle_events/": { + "get": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "searchEvents", + "summary": "Return lifecycle events", + "description": "Returns a list of ticket lifecycle events in descending order, according to the event timestamp.\nLimited to a maximum of five concurrent calls.\nBy default, This API only returns events that have occurred on R24-1 and later.\nIf your desired timeframe includes events that occurred in previous versions, you must first run POST historical_events to assemble the data for those events.", + "parameters": [ + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Offset the count starting point" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Limit number of results (default is 1000)" + }, + { + "name": "get_total", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Set to true to get the total number of items that can be retrieved" + }, + { + "name": "type", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Search by type of the event." + }, + { + "name": "assignee_name", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Search by assignee name." + }, + { + "name": "assignee_id", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Search by internal assignee id." + }, + { + "name": "participant_name", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Search by participant users names, Only events of type TASK_ASSIGNED are returned for this filter" + }, + { + "name": "participant_id", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Search by internal participant id." + }, + { + "name": "ticket_id", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Search by ticket id." + }, + { + "name": "workflow_name", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Search by workflow name." + }, + { + "name": "parent_workflow_id", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Search by parent workflow id." + }, + { + "name": "step_name", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Search by step name." + }, + { + "name": "step_id", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Search by step id." + }, + { + "name": "date_from", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Search for records from this date. Date format expected: yyyy-mm-dd" + }, + { + "name": "date_to", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Search for records until this date. Date format expected: yyyy-mm-dd" + }, + { + "name": "business_duration_exceeds_hours", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Search by business duration" + }, + { + "name": "sla_status", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Search by sla status" + }, + { + "name": "workflow_type", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Search by workflow type" + } + ], + "responses": { + "400": { + "description": "Invalid date. Permitted date format is: yyyy-MM-dd (ex. '2020-11-20')" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Access is denied" + }, + "500": { + "description": "Reached max concurrent attempts" + }, + "200": { + "description": "Return lifecycle events", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TicketEventListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/lifecycle_events/historical_events": { + "post": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "createEventsFromHistory", + "summary": "Include historical event data in lifecycle queries", + "description": "Assembles data from events that occurred before R24-1, allowing these events to be included in GET lifecycle_events.\nThis action can take some time. Once you call this API, you cannot call it again until the first action has finished.\nYou can check the action progress by calling GET historical_events_status.\nSupported events: [TICKET_CREATION].", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketEventsCreateHistoryRequestDTO" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted" + }, + "400": { + "description": "Invalid date. Permitted date format is: yyyy-MM-dd (ex. '2020-11-20')" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Access is denied" + }, + "500": { + "description": "Already in progress" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/lifecycle_events/historical_events_status": { + "get": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "getTicketEventHistoryStatusIfRunning", + "summary": "Monitor status of ongoing historical event assembly
", + "description": "Returns the status of an ongoing historical event assembly, initiated by calling POST historical_events.\nThe field ?oldest_event_time? shows the last event successfully added to the lifecycle events repository, use this field to track the action's progress.\nEvents are migrated from newest to oldest, within the specified timeframe.", + "responses": { + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Access is denied" + }, + "200": { + "description": "Monitor status of ongoing historical event assembly
", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketEventsCreateHistoryStatusDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/search": { + "get": { + "tags": [ + "Search" + ], + "operationId": "searchTickets", + "summary": "DEPRECATED - Returns a list of tickets by search parameters", + "description": "If the query is successful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.\nIf the query is successful but there is indexing in progress then the return code will be 206 and the results will hold only the indexed tickets.\nIf you set 'ids_only' to true, the result includes tickets' ID without any other ticket data.", + "parameters": [ + { + "name": "id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "subject", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The subject of the ticket" + }, + { + "name": "requester", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The requester of the ticket" + }, + { + "name": "group", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The group handling the ticket" + }, + { + "name": "assigned_to", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The user name of the person assigned to the ticket" + }, + { + "name": "priority", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The priority of the ticket" + }, + { + "name": "status", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The status of the ticket" + }, + { + "name": "sla_status", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The SLA status of the ticket" + }, + { + "name": "field_name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Field name to search by" + }, + { + "name": "field_value", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Field value to search by" + }, + { + "name": "current_step", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Current step name" + }, + { + "name": "expiration_date_from", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Search requests with expiration date from this date" + }, + { + "name": "expiration_date_to", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Search requests with expiration date until this date" + }, + { + "name": "domain_name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The Domain of the ticket" + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Offset the count starting point" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Ticket list length" + }, + { + "name": "ids_only", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Set to true to get only the tickets' ID" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "206": { + "description": "Partial Content" + }, + "403": { + "description": "Access is denied." + }, + "400": { + "description": "Cannot find specified domain <DOMAIN_NAME>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/search_by/details": { + "get": { + "tags": [ + "Search" + ], + "operationId": "searchTicketsByDetails", + "summary": "Returns a list of tickets by search parameters", + "description": "If the query is successful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.\nIf the query is successful but there is indexing in progress then the return code will be 206 and the results will hold only the indexed tickets.\nIf you set 'ids_only' to true, the result includes tickets' ID without any other ticket data.\nIf you set 'count' to 0, all tickets found will be returned, which may lead to performance issues.\n\n This API is different version of /securechange/tickets/search API.\n The output format in this version has changed compared to previous version.\n Results containing just one element will now be returned as a single element array rather than an object.", + "parameters": [ + { + "name": "id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "subject", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The subject of the ticket" + }, + { + "name": "requester", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The requester of the ticket" + }, + { + "name": "group", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The group handling the ticket" + }, + { + "name": "assigned_to", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The user name of the person assigned to the ticket" + }, + { + "name": "priority", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The priority of the ticket" + }, + { + "name": "ticket_status", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The status of the ticket" + }, + { + "name": "task_status", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The status of the task" + }, + { + "name": "sla_status", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The SLA status of the ticket" + }, + { + "name": "sla_outcome", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The SLA outcome of the ticket" + }, + { + "name": "sla_tracking_state", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The SLA Tracking State of the ticket" + }, + { + "name": "field_name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Field name to search by" + }, + { + "name": "field_value", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Field value to search by" + }, + { + "name": "current_step", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Current step name" + }, + { + "name": "expiration_date_from", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Search requests with expiration date from this date" + }, + { + "name": "expiration_date_to", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Search requests with expiration date until this date" + }, + { + "name": "domain_name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The Domain of the ticket" + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Offset the count starting point" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Ticket list length" + }, + { + "name": "ids_only", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Set to true to get only the tickets' ID" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "206": { + "description": "Partial Content" + }, + "403": { + "description": "Access is denied." + }, + "400": { + "description": "Cannot find specified domain <DOMAIN_NAME>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/search_by/free_text": { + "get": { + "tags": [ + "Search" + ], + "operationId": "searchTicketsByFreeText", + "summary": "Returns a list of tickets by free-text query", + "description": "Square brackets ('[' and ']') are not supported for free text searches using an API request. Replace '[' with '%5B' and ']' with '%5D'.\nIncorrect:\nparameter=createdate:[20080120 TO 20090120]\nCorrect:\nparameter=createdate:%5B20080120%20TO%2020090120%5D\nIf you set 'count' to 0, all tickets found will be returned, which may lead to performance issues.\n\n This API is different version of /securechange/tickets/free_text_search API.\nThe output format in this version has changed compared to previous version.\n Results containing just one element will now be returned as a single element array rather than an object.", + "parameters": [ + { + "name": "parameter", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Free text search parameter (Search syntax details)" + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Offset the count starting point" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Tickets list max length" + }, + { + "name": "ids_only", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Set to true to get only the tickets' ID" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "206": { + "description": "Partial Content" + }, + "400": { + "description": "Illegal count value entered. Max value is 1000" + }, + "403": { + "description": "Access is denied." + }, + "404": { + "description": "No entity found for query" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/search_by/group": { + "get": { + "tags": [ + "Search" + ], + "operationId": "showTicketsByGroupId", + "summary": "Returns a list of tickets for a given group", + "description": "If the search is successful but no results are found (for example, If no tickets found for the group), the return code will be 200 and the results will be empty.\nIf the indexing is in progress, then the return code will be 206 and the results will contain only the indexed tickets.\nIf you set 'count' to 0, all tickets found will be returned, which may lead to performance issues.\nIf you set 'ids_only' to true, the result includes tickets' ID without any other ticket data.", + "parameters": [ + { + "name": "group_id", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the Group" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "A limit of the number of tickets to be returned - default value is 1000" + }, + { + "name": "ids_only", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Set to true to get only the tickets' ID" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "206": { + "description": "Partial content due to indexing in progress" + }, + "400": { + "description": "Group ID was not found." + }, + "403": { + "description": "User has no permissions to view group's tickets" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/search_by/query": { + "get": { + "tags": [ + "Search" + ], + "operationId": "searchTicketsByQueryId", + "summary": "Returns a list of tickets by query id for user", + "description": "If the query is successful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.\nIf the query is successful but indexing is in progress then the return code will be 206 and the results will contain only the indexed tickets.\nIf you set 'count' to 0, all tickets found will be returned, which may lead to performance issues.\nIf you set 'ids_only' to true, the result includes tickets' ID without any other ticket data.", + "parameters": [ + { + "name": "query_id", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the query" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "A limit of the number of tickets to be returned - default value is 1000" + }, + { + "name": "ids_only", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Set to true to get only the tickets' ID" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "206": { + "description": "Partial Content" + }, + "400": { + "description": "Query ID was not found." + }, + "403": { + "description": "Access is denied." + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getTicket", + "summary": "Returns the details of a specified ticket", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + }, + { + "name": "showStepsDetails", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Include steps' details in the response" + }, + { + "name": "showTasksFields", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Include tasks' fields in the response" + }, + { + "name": "showApplicationChanges", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Include application changes in the response" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "No entity found for query" + }, + "200": { + "description": "Returns the details of a specified ticket", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/cancel": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "cancelTicket", + "summary": "Cancel a ticket", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the ticket as shown in SecureChange" + }, + { + "name": "requester_id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The user of the ticket's requester, when logged in user is canceling on behalf" + } + ], + "responses": { + "403": { + "description": "Access is denied." + }, + "404": { + "description": "Ticket ID was not found" + }, + "200": { + "description": "Cancel a ticket" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/change_requester/{assigneeId}": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "changeRequesterTicket", + "summary": "Change the requester of the specified ticket task to the specified user.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "assigneeId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The assignee ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CommentDTO" + } + } + } + }, + "responses": { + "400": { + "description": "The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing" + }, + "404": { + "description": "There is no requester (User) with ID." + }, + "200": { + "description": "Change the requester of the specified ticket task to the specified user." + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/confirm": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "confirm", + "summary": "Confirm the request", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "requester_id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The user of the ticket's requester, when logged in user is confirm on behalf" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfirmCommentDTO" + } + } + } + }, + "responses": { + "400": { + "description": "The user can not confirm the ticket, because he is not in the domain of the ticket" + }, + "403": { + "description": "Access is denied." + }, + "404": { + "description": "There is no ticket with ID ." + }, + "200": { + "description": "Confirm the request" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/export": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "exportTicket", + "summary": "Export ticket to a PDF", + "description": "Export ticket to a PDF is not supported for Rule Decommission, Rule Modification, Rule Recertification or Clone network object policy.\nThe name of the downloaded file is returned in the Filename field of the content-disposition header.\nThe file content is returned in the response body.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + } + ], + "responses": { + "200": { + "description": "" + }, + "400": { + "description": "Export to PDF is not available for this workflow type." + }, + "403": { + "description": "You do not have permission to export this ticket. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/history": { + "get": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "getTicketHistory", + "summary": "Returns the history of the specified ticket", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + } + ], + "responses": { + "403": { + "description": "User has no permissions to view ticket history" + }, + "404": { + "description": "There is no ticket with ID." + }, + "200": { + "description": "Returns the history of the specified ticket", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketHistoryListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/map_rules": { + "post": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "mapRules", + "summary": "Map rules to ticket", + "description": "Maps the rules from the ticket to the relevant rules in SecureTrack. \nAdds record set entries to the relevant rules metadata. \nLink to history is found in the returned location header. \nApplicable only for closed tickets in the following workflows: Access Request, Access Request and Modify Group, and Clone Server Policy. \nUse handler_id for running on behalf of another user. \nTo get handler_id, use the System Users API.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the ticket as shown in SecureChange" + }, + { + "name": "handler_id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Run API on behalf of defined user id" + } + ], + "responses": { + "201": { + "description": "Started asynchronous mapping of rules to ticket ID <ID>. Mapping status is displayed in ticket history." + }, + "400": { + "description": "Ticket's workflow type does not support this operation" + }, + "403": { + "description": "On behalf user do not have permission to access ticket <ID>" + }, + "404": { + "description": "There is no handler (User) with ID <ID>." + }, + "412": { + "description": "Ticket is not in closed status" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/pause_sla": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "pauseSLA", + "summary": "Pause SLA for specific ticket", + "description": "When a ticket is in progress and its workflow enables calendar-based SLA, a permitted user can pause its SLA tracking progress.\nPermitted user must have 'Pause SLA' permission and be that ticket's current assignee.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + } + ], + "responses": { + "200": { + "description": "" + }, + "400": { + "description": "SLA is already paused for this ticket" + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/reject": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "rejectTicket", + "summary": "Reject a ticket", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the ticket as shown in SecureChange" + }, + { + "name": "handler_id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The user id, when logged in user is rejecting on behalf" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RejectCommentDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Comment cannot be empty" + }, + "403": { + "description": "Access is denied." + }, + "404": { + "description": "There is no handler (User) with ID <ID>." + }, + "200": { + "description": "Reject a ticket" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/resume_sla": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "resumeSLA", + "summary": "Resume SLA for specific ticket", + "description": "When a ticket's SLA tracking progress is paused, any user who is that ticket's current assignee, can resume the SLA tracking progress.\nTake note that paused SLA tracking progress automatically resumes when the ticket changes its current step.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + } + ], + "responses": { + "200": { + "description": "" + }, + "400": { + "description": "SLA is already running for this ticket" + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getTicketStages", + "summary": "Returns the details of a specified ticket stages", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Ticket ID was not found" + }, + "200": { + "description": "Returns the details of a specified ticket stages", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketStagesListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/current/tasks/{taskId}": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "doneStep_2", + "summary": "Change a task of a ticket at the current step", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Missing revision ID for the device" + }, + "403": { + "description": "Task can not be done because there are unlicensed devices for change automation" + }, + "406": { + "description": "Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP" + }, + "200": { + "description": "Change a task of a ticket at the current step" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/current/tasks/{taskId}/fields": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "updateFieldList_2", + "summary": "Change multiple field within a task of a ticket in the current step", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskFieldListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Missing revision ID for the device" + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "406": { + "description": "Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP" + }, + "200": { + "description": "Change multiple field within a task of a ticket in the current step" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/current/tasks/{taskId}/fields/{fieldId}": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "updateField", + "summary": "Change a field within a task of a ticket at the current step", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskFieldDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Missing revision ID for the device" + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "406": { + "description": "Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP" + }, + "200": { + "description": "Change a field within a task of a ticket at the current step" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/current/tasks/{taskId}/multi_server_decommission_request/designer": { + "put": { + "tags": [ + "Network Object Decommissioning" + ], + "operationId": "runServerDecommissionDesigner", + "summary": "Run server decommission designer for given task", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "responses": { + "400": { + "description": "The provided task lacks a decommission request field." + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "200": { + "description": "Run server decommission designer for given task" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/current/tasks/{taskId}/multi_server_decommission_request/impact_analysis": { + "put": { + "tags": [ + "Network Object Decommissioning" + ], + "operationId": "runServerDecommissionImpactAnalysis", + "summary": "Run Impact Analysis for given task", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "responses": { + "400": { + "description": "The provided task lacks a decommission request field." + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "200": { + "description": "Run Impact Analysis for given task" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/current/tasks/{taskId}/multi_server_decommission_request/verifier": { + "put": { + "tags": [ + "Network Object Decommissioning" + ], + "operationId": "runServerDecommissionVerifier", + "summary": "Run Verifier for given task", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "responses": { + "400": { + "description": "The provided task lacks a decommission request field." + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "200": { + "description": "Run Verifier for given task" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/current/tasks/{taskId}/rule_recertification/update_metadata": { + "put": { + "tags": [ + "Rule Recertification" + ], + "operationId": "runRuleRecertificationUpdateMetadata", + "summary": "Run Update Metadata for given task", + "description": "A link to the rule recertification field will returned in the location field of the header, for example: /securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/72", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "responses": { + "400": { + "description": "The provided task lacks a rule recertification request field." + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "200": { + "description": "Run Update Metadata for given task" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getTicketStageById", + "summary": "Returns the details of a specified ticket stages", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the step as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Stage ID was not found in ticket ID." + }, + "200": { + "description": "Returns the details of a specified ticket stages", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketStageDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getStageTasks", + "summary": "Returns the details of the tasks", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the step as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Stage ID was not found in ticket ID." + }, + "200": { + "description": "Returns the details of the tasks", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "doneStep", + "summary": "Change a task of a ticket", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Missing revision ID for the device" + }, + "403": { + "description": "Task can not be done because there are unlicensed devices for change automation" + }, + "406": { + "description": "Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP" + }, + "200": { + "description": "Change a task of a ticket" + } + } + }, + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getStageTaskById", + "summary": "Returns the details of a specified task", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the step as shown in SecureChange" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the task as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Task with ID was not found in Stage ID in ticket ID ." + }, + "200": { + "description": "Returns the details of a specified task", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/accept": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "acceptTaskSelfAssign", + "summary": "Accept task API", + "description": "When a task is on self assignment mode awaiting assignment, any participant user can use this API to assign it to themselves", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "responses": { + "200": { + "description": "" + }, + "400": { + "description": "You can only update the current step of the ticket. Step ID <ID> does not match the current step ID <ID>." + }, + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Task with ID was not found in Stage ID in ticket ID ." + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/clone_server_policy/verifier": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getServerCloneVerifierResults", + "summary": "Get server clone policy verifier results", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "responses": { + "404": { + "description": "Verifier results were not found in the server clone policy request." + }, + "200": { + "description": "Get server clone policy verifier results", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/clone_server_policy_verifer_result_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getTaskFields", + "summary": "Returns the details of a the fields", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the step as shown in SecureChange" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the task as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Task with ID was not found in Stage ID in ticket ID ." + }, + "200": { + "description": "Returns the details of a the fields", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskFieldListDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Tickets" + ], + "operationId": "updateFieldList", + "summary": "Change multiple fields within a task of a ticket", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskFieldListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Missing revision ID for the device" + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "406": { + "description": "Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP" + }, + "200": { + "description": "Change multiple fields within a task of a ticket" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "updateField_2", + "summary": "Change a field within a task of a ticket", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskFieldDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Missing revision ID for the device" + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "406": { + "description": "Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP" + }, + "200": { + "description": "Change a field within a task of a ticket" + } + } + }, + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getTaskFieldById", + "summary": "Returns the details of a specified field", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the step as shown in SecureChange" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the task as shown in SecureChange" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the field as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Field ID was not found in Task ID in Stage ID in ticket ID ." + }, + "200": { + "description": "Returns the details of a specified field", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskFieldDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getFieldDesignerResults", + "summary": "Get designer results according to field id", + "description": "Use this API to retrieve designer results generated in R17-2 and later.\nRedesign status field will only appear for the current step.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "404": { + "description": "Designer results were not found in the request." + }, + "200": { + "description": "Get designer results according to field id", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/access_request_designer_result_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer/commit_report/{managementId}": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getCommitResults", + "summary": "Returns the results of the Commit action", + "description": "GENERAL USE\nThe report returns the Commit results for the device with the specified management ID and for the devices suggested in the Designer results. The report also includes results for devices that are in the related hierarchy of these devices.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "managementId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Management ID" + } + ], + "responses": { + "404": { + "description": "Designer results were not found in the request." + }, + "200": { + "description": "Returns the results of the Commit action", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CommitReportDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer/device/{deviceId}/commands": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getDeviceCommandsFromFieldDesignerResults", + "summary": "Get commands for device from designer results of a specific field id", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "deviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Device ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "404": { + "description": "Device with ID <ID> does not support Commands feature." + }, + "200": { + "description": "Get commands for device from designer results of a specific field id", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/DesignerCommandsDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer/device/{deviceId}/commit": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "commitDevice", + "summary": "Commit policy changes", + "description": "Create an asynchronous task to commit policy changes to all the devices managed by the specified management device.\nOnce the Commit task is created, the task status changes to pending and becomes locked for editing until the task completes.\nUse the API function link in the response location header to check the status of the task.\nOnce the task is complete, the results become available.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "deviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Device ID" + } + ], + "responses": { + "202": { + "description": "Commit task has been created." + }, + "400": { + "description": "Commit is not supported for device ID <ID>." + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer/device/{deviceId}/update": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "updateDevice", + "summary": "Update the device with designer suggestions", + "description": "Create an asynchronous task to update Designer suggestions to the specified device. \nOnce the Update Device task is created, the status of the task changes to pending and it becomes locked for editing until the update completes. \nThe response location header has a link to an API function which you can use to check the status of the task. \nOnce the Update Device task is complete, the results become available and are recorded in the ticket's history.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "deviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Device ID" + }, + { + "name": "force", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Force update device even if the policy on the device has already been modified" + } + ], + "responses": { + "202": { + "description": "Update device task has been created." + }, + "400": { + "description": "Provisioning is not supported for device ID <ID>." + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer/device/{managementId}": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getDesignerResultsByDeviceId", + "summary": "Get designer results according to field id and device id", + "description": "Use this API to retrieve designer results per specific device.\nRedesign status field will only appear for the current step.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "managementId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Device ID" + } + ], + "responses": { + "404": { + "description": "Device with ID <ID> was not found in designer result." + }, + "200": { + "description": "Get designer results according to field id and device id", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/access_request_designer_result_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer/redesign": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "redesign", + "summary": "Redesign", + "description": "Create an asynchronous task to redesign.\nOnce the Redesign task is created, the status of the task changes to pending and it becomes locked for editing until the redesign completes.\nThe response location header has a link to an API function which you can use to check the status of the task.\nOnce the Redesign task is complete, the results become available.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "202": { + "description": "Redesign task has been created." + }, + "400": { + "description": "Redesign will not be run because it is not needed." + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_designer": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getSystemResults", + "summary": "Get OPM designer results according to ticket id and field id", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "400": { + "description": "The field with id <ID> does not exist on ticket with id <ID>." + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "You do not have permission to remove this comment. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with id: <ID>." + }, + "200": { + "description": "Get OPM designer results according to ticket id and field id", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/SystemResultListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_designer/systems/{systemId}": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getDesignerResultPerSystem", + "summary": "Get OPM designer results per system according to ticket id, field id and system id", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "systemId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "System ID" + }, + { + "name": "devices_count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Maximum number of devices to be returned in the system result" + }, + { + "name": "devices_offset", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "A number indicating the distance from the first device record in the data set" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/DesignerResults" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "You do not have permission to access ticket <ID>." + }, + "404": { + "description": "Specified field, id: <ID> , name: <NAME>, cannot contain designer result" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_designer/systems/{systemId}/replace_instructions": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "replaceOpmDesignerInstructions", + "summary": "Replace OPM Designer instructions for a system", + "description": "GENERAL USE\n1. Use the API '/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_designer/systems/{systemId}' to retrieve the designer results.\n2. Run this API to modify the required instructions.\n\nGENERAL NOTES\na. All instruction properties may be modified except the instruction ID, which is immutable.\nb. Each request may contain one or more instructions; each instruction represents a single change operation (ADD, MODIFY, DELETE).\nc. All referenced UIDs must already exist in the system.\nd. All network related values: IP addresses, object types, service definitions and protocols, must be valid and logically correct from a networking perspective.\n\n\nInstruction object notes:\na. The id field is mandatory and uniquely identifies the instruction and cannot be modified.\nb. The change_type defines the type of action and must be one of the permitted values (ADD, MODIFY, DELETE).\nc. The changed_entity object must always be included and defines the specific object being modified or created.\nd. The relation_changes list must be present, and defines how entity relations will be updated.\n\nChangedEntity notes:\na. The type field is required and determines which entity subtype must be used (HOST, SUBNET, IP_RANGE, SERVICE types, RULE, etc.).\nb. The uid is optional and used when modifying existing entities.\nc. The new_entity_uid is optional and used when the system assigns a new UID.\nd. The name is optional.\ne. Additional required fields depend on the entity subtype (Host, Subnet, IP Range, Rule, Transport Service).\n\nChangedEntity subtype requirements:\na. Host: ip_type and ip are required.\nb. Subnet: ip_type and ip are required, and one of netmask or cidr.\nc. IP Range: ip_type, min_ip, and max_ip are required.\nd. IP Service: min_protocol and max_protocol required.\ne. ICMP Service: min_icmp_type and max_icmp_type required.\nf. Transport Service: min_port, max_port, and protocol are required.\ng. Rule: In case of a new rule, only the location field is required; the comment is optional.\n\nRelationChange notes:\na. The relation_change_type is required and defines the type of change applied (ADD, MODIFY, DELETE).\nb. The relation field is required and identifies the relation being updated (SOURCE, DESTINATION, SERVICE, MEMBER, SRC_ZONE, DST_ZONE).\nc. The predefined_value is optional and used to set special values like ANY.\nd. Both entities and embedded_entities must be present in the request (can be empty lists).\n\nEntityReference notes:\na. The type and name fields are required to reference an existing entity.\nb. One of the following must exist: uid or new_entity_uid.\nc. The name field remains required for identifying the referenced entity.\n\nRuleLocation notes:\na. The placement field is required and determines rule positioning (BEFORE, AFTER, LAST).\nb. The other_rule_uid or other_rule_identifier may be used when placement is BEFORE or AFTER another rule.\n\nEmbeddedEntity notes:\na. Embedded entities contain full object definitions used inside relation changes.\nb. Each embedded entity requires a type and additional fields based on subtype.\n\nEmbedded entity subtype requirements:\na. Host: ip_type and ip are required.\nb. Subnet: ip_type and ip are required, and one of netmask or cidr.\nc. IP Range: ip_type, min_ip, and max_ip required.\nd. Transport Service: min_port, max_port, and protocol required.\ne. IP Service: min_protocol and max_protocol required.\nf. ICMP Service: min_icmp_type and max_icmp_type required.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "systemId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "System ID" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ReplaceInstructionResult" + } + } + } + }, + "400": { + "description": "Rule location is missing for new rule <RULE_IDENTIFIER>" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Customization is not allowed while provisioning is running" + }, + "404": { + "description": "Device result not found for instruction <INSTRUCTION_ID>" + }, + "500": { + "description": "Internal database failure." + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_designer/systems/{systemId}/update": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "updateOpmDevice", + "summary": "Update the opm device with designer suggestions", + "description": "Create an asynchronous task to update Designer suggestions to the specified opm device. \nOnce the Update Device task is created, the status of the task changes to pending and it becomes locked for editing until the update completes. \nThe response location header has a link to an API function which you can use to check the status of the task. \nOnce the Update Device task is complete, the results become available and are recorded in the ticket's history.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "systemId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "System ID" + }, + { + "name": "force", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Force update system even if the policy on the system has already been modified" + } + ], + "responses": { + "202": { + "description": "Update system task has been created." + }, + "400": { + "description": "system <ID> is not eligible for provisioning." + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_provisioning": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getProvisioningResults", + "summary": "Get OPM provisioning results according to ticket id and field id", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ProvisioningResultListDTO" + } + } + } + }, + "400": { + "description": "The field with id <ID> does not exist on ticket with id <ID>." + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "You do not have permission to access ticket <ID>." + }, + "404": { + "description": "Specified field, id: <ID> , name: <NAME>, cannot contain designer result" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_provisioning/systems/{systemId}": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getProvisioningResultPerSystem", + "summary": "Get OPM provisioning results per system according to ticket id, field id and system id", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "systemId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "System result ID" + }, + { + "name": "devices_count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Maximum number of devices to be returned in the system result" + }, + { + "name": "devices_offset", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "A number indicating the distance from the first device record in the data set" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ProvisioningSystemResult" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "You do not have permission to access ticket <ID>." + }, + "404": { + "description": "Specified system, id: <ID>, cannot contain provisioning result" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/related_rules": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getRelatedRules", + "summary": "Get related rules according to field id", + "description": "Use this API to retrieve rules related to the traffic specified by the Access Request fields in the ticket.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view related rules. Contact your administrator for assistance." + }, + "404": { + "description": "Field ID <ID> was not found in Task ID <ID> in Stage ID <ID> in ticket ID <ID>" + }, + "200": { + "description": "Get related rules according to field id", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/related_rules_related_rules_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/security_zones": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getSecurityZones", + "summary": "Get security zones according to field id", + "description": "Use this API to retrieve security zones for multi access result field", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "404": { + "description": "There is no ticket with ID <ID>." + }, + "401": { + "description": "Cannot update ticket because it is either closed, rejected or waiting for requester confirmation" + }, + "400": { + "description": "Security zones tool is not enabled for the requested field." + }, + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "200": { + "description": "Get security zones according to field id", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/AccessRequestsSecurityZonesDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/multi_access_request/{fieldId}/verifier": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getARVerifierResults", + "summary": "Get access request verifier results", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Request ID" + } + ], + "responses": { + "404": { + "description": "Verifier results were not found in the access request." + }, + "200": { + "description": "Get access request verifier results", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/access_request_verifer_result_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/multi_access_request/{fieldId}/verifier/topology_map": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getARVerifierResultsTopologyMap", + "summary": "Returns topology map image (png file) for specific verifier results", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Request ID" + } + ], + "responses": { + "404": { + "description": "Topology map was not found for this field." + }, + "200": { + "description": "Returns topology map image (png file) for specific verifier results" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/multi_server_decommission_request/{fieldId}/designer": { + "get": { + "tags": [ + "Network Object Decommissioning" + ], + "operationId": "getServerDecommissionDesignerResults", + "summary": "Get server decommission designer results", + "description": "Use this API to retrieve designer results generated in R17-1 and earlier.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Server Decommission Request ID" + } + ], + "responses": { + "404": { + "description": "The given TYPE does not contain a field with ID <ID>." + }, + "200": { + "description": "Get server decommission designer results", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/designer_results" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/multi_server_decommission_request/{fieldId}/impact_analysis": { + "get": { + "tags": [ + "Network Object Decommissioning" + ], + "operationId": "getImpactAnalysisResults", + "summary": "Get impact analysis results", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Server Decommission Request ID" + } + ], + "responses": { + "404": { + "description": "The given TYPE does not contain a field with ID <ID>." + }, + "200": { + "description": "Get impact analysis results", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/result_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/multi_server_decommission_request/{fieldId}/verifier": { + "get": { + "tags": [ + "Network Object Decommissioning" + ], + "operationId": "getVerifierResults", + "summary": "Get verifier results", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Server Decommission Request ID" + } + ], + "responses": { + "404": { + "description": "The given TYPE does not contain a field with ID <ID>." + }, + "200": { + "description": "Get verifier results", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/result_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/reassign/{assigneeId}": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "reassignTicketTask", + "summary": "Reassigns the specified ticket task to the specified user.", + "description": "Values can only be updated for the current step.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "assigneeId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The assignee ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReassignTaskCommentDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Task <NAME> is no longer active" + }, + "404": { + "description": "No entity found for query" + }, + "200": { + "description": "Reassigns the specified ticket task to the specified user." + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/redo/{toStepId}": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "redoTicketStep", + "summary": "Returns the specified ticket to the specified step", + "description": "Values can only be updated for the current step.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "toStepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "To which step we the ticket will return" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RedoStepCommentDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Task <NAME> is no longer active" + }, + "403": { + "description": "User has no permissions to redo ticket steps." + }, + "404": { + "description": "No entity found for query" + }, + "200": { + "description": "Returns the specified ticket to the specified step" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/rule_decommission/verifier": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getRdVerifierResults", + "summary": "Get rule decommision verifier results", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "responses": { + "404": { + "description": "Verifier results were not found in the request." + }, + "200": { + "description": "Get rule decommision verifier results", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/rule_decommission_verifier_result_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/tasks/{taskId}/designer/instruction/{instructionId}": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "updateInstruction", + "summary": "Modify the Designer suggestions for Access Request, Clone Server Policy, Decommission Network Object Request or Rule Decommission", + "description": "GENERAL USE\n1. Create a ticket using UI/API.\n2. Run the designer using UI/API.\n3. Use relevent API to get the designer results.\n4. Run this API to modify the required parameters.\n\n*Note: you can modify one parameter at a time.\n\n Change rule location use\na. Modifying the rule order places the new rule before the rule with the specified identifier (rule name or number).\nb. Modifying the rule placement to \"last\" places the new rule as last rule or last pre-rule (depending on the vendor convention for the device).\nc. For vendors that support \"after\" placement, modifying the rule placement allows positioning the new rule before or after the suggested rule location.\nd. For Check Point R80 and above releases, the indented rule numbering format can be applied to globally assigned policies (for example, \"rule_order\": \"4.5\").\n\ntrack level permitted values:\nNONE, LOG, ACCOUNT, ALERT, SNMP, MAIL, USER_DEFINED, EMERGENCIES, ALERTS, CRITICAL, ERRORS, WARNINGS, NOTIFICATIONS, INFORMATIONAL, DEBUGGING, DISABLED, DEFAULT, FULL_LOG, NETWORK_LOG, USER_ALERT_1, USER_ALERT_2, USER_ALERT_3 \n\nrule placement permitted values:\nBEFORE, AFTER, LAST", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "instructionId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Instruction ID" + }, + { + "name": "force", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "force update when new revision available" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/change" + } + } + } + }, + "responses": { + "200": { + "description": "New rule will be shadowed or break acceleration" + }, + "400": { + "description": "AppliedTo list is longer than 20 items." + }, + "412": { + "description": "Current step does not support Designer modification action" + }, + "404": { + "description": "The log forwarding profile <LOG FORWARDING PROFILE> was not found." + }, + "403": { + "description": "New revision is available, cannot modify the Designer results" + }, + "409": { + "description": "Object already exists" + }, + "503": { + "description": "Not connected to SecureTrack." + }, + "500": { + "description": "An error occurred in SecureTrack while trying to validate the log forwarding profile." + }, + "406": { + "description": "Invalid UIDs: [<SECURITY GROUP UID>, <SECURITY GROUP UID>]" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/ticket_properties": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "updateTicketProperties", + "summary": "Change the ticket properties", + "description": "Change the ticket properties listed in the TicketPropertiesDTO. \nWhen specifying the priority property you must use Critical/High/Normal/Low. \nWhen specifying the notification_group property you must use the ID of the group or leave the ID empty to remove the group. This property can be updated on a closed ticket.\nWhen specifying the referenced_ticket property you must use the ID of the ticket or leave the ID empty to remove the ticket.\nWhen specifying the expiration_date property, you must use a yyyy-mm-dd format, or leave the value empty to remove the expiration date. To ignore the field, do not include it in the request. This property can be updated on a closed ticket.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketPropertiesDTO" + } + } + } + }, + "responses": { + "400": { + "description": "This workflow does not support expiration dates" + }, + "403": { + "description": "The user is not allowed to add the specified referenced ticket." + }, + "404": { + "description": "There is no ticket with ID <ID>." + }, + "406": { + "description": "Invalid format detected: priority - Permitted values are: Critical, High, Normal, Low" + }, + "200": { + "description": "Change the ticket properties" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{ticketId}/comments/{commentId}": { + "delete": { + "tags": [ + "Tickets" + ], + "operationId": "deleteComment", + "summary": "Delete a comment from a ticket", + "parameters": [ + { + "name": "ticketId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "commentId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Comment ID" + } + ], + "responses": { + "400": { + "description": "The comment with id <ID> cannot be deleted because it is a SYSTEM comment (only USER comments can be deleted)" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "You do not have permission to remove this comment. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with id: <ID>." + }, + "200": { + "description": "Delete a comment from a ticket" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{ticketId}/steps/{stepId}/tasks/{taskId}/comments": { + "post": { + "tags": [ + "Tickets" + ], + "operationId": "addComment", + "summary": "Add a new comment to a ticket", + "description": "The comment may include attached files which are identified by their uid Identifier.Returns the ID of the comment that was added.", + "parameters": [ + { + "name": "ticketId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketCommentDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Comment was created." + }, + "400": { + "description": "You do not have access to this attachment: <UID>" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance" + }, + "404": { + "description": "Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>." + }, + "406": { + "description": "Invalid format detected:\nattachments - Attachments list is longer than 10 items" + } + } + } + }, + "/securechangeworkflow/api/securechange/triggers/": { + "get": { + "tags": [ + "Triggers" + ], + "operationId": "getTriggers", + "summary": "Returns the details of triggers", + "description": "Get triggers by name or id or get a list of all triggers. Can see the id of triggers using Get by name API\"", + "parameters": [ + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Trigger Name" + }, + { + "name": "id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Trigger ID" + } + ], + "responses": { + "403": { + "description": "User has no permissions to view triggers" + }, + "404": { + "description": "There is no trigger with ID: <ID>" + }, + "200": { + "description": "Returns the details of triggers", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkflowTriggersDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Triggers" + ], + "operationId": "addTriggers", + "summary": "Submit new workflow trigger", + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkflowTriggersDTO" + } + } + } + }, + "responses": { + "400": { + "description": " Cannot deserialize value of type `com.tufin.securechange.rest.dto.script.enums.Event` from String : not one of the values accepted for Enum class: [ADVANCE, AUTOMATION_FAILED, CLOSE, CANCEL, RESUBMIT, CREATE, REOPEN, REDO, REJECT, RESOLVE], relevant for json" + }, + "403": { + "description": " Access is denied" + }, + "406": { + "description": " Must not be empty." + }, + "201": { + "description": " 201 created" + } + } + } + }, + "/securechangeworkflow/api/securechange/users/": { + "get": { + "tags": [ + "System Users" + ], + "operationId": "getParties", + "summary": "Return the list of users", + "description": "user_name: case insensitive, search mode: contains text\nexact_name: when set to true, user_name search mode is case sensitive and exact text\nshow_permissions: when set to true, party permissions will be returned\nemail: case insentitive, search mode: exact match\nLogical OR between user_name and email.", + "parameters": [ + { + "name": "showIndirectRelation", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Members that belong to the selected group only indirectly" + }, + { + "name": "user_name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The user's login name" + }, + { + "name": "email", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The user's email" + }, + { + "name": "exact_name", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Search user_name as exact match" + }, + { + "name": "show_permissions", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Permissions of the user" + } + ], + "responses": { + "200": { + "description": "Return the list of users", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PartyListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "System Users" + ], + "operationId": "addParty", + "summary": "Create new local users and Import LDAP users to SecureChange by simulating login process", + "description": "This API implicitly imports LDAP users as automatics users to SecureChange by simulating their login.\nTo explicitly import LDAP entities- both users and groups, it is recommended to use /users/import API", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PartyDTO" + } + } + } + }, + "responses": { + "403": { + "description": "Access is denied." + }, + "400": { + "description": "The username 'admin' is reserved for the SecureChange system administrator." + }, + "406": { + "description": "Invalid format detected: notes - {value} is invalid. Text includes invalid expressions such as HTML tags or command line operations" + }, + "200": { + "description": "Create new local users and Import LDAP users to SecureChange by simulating login process" + } + } + } + }, + "/securechangeworkflow/api/securechange/users/group": { + "post": { + "tags": [ + "System Users" + ], + "operationId": "createLocalGroup", + "summary": "Create local group", + "description": "Only users with 'view settings tab' permission can run this API.", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateGroupDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Name already exists" + }, + "200": { + "description": "Create local group" + } + } + } + }, + "/securechangeworkflow/api/securechange/users/group/{id}": { + "put": { + "tags": [ + "System Users" + ], + "operationId": "changeGroupMembers", + "summary": "Change local group members", + "description": "Only users with 'view settings tab' permission can run this API.\nOnly local or imported LDAP users can be added to local groups.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Group ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GroupChangeDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Cannot add a group to a group that it already contains. Group {ID1} contains group {ID2}" + }, + "200": { + "description": "Change local group members" + } + } + } + }, + "/securechangeworkflow/api/securechange/users/import": { + "post": { + "tags": [ + "System Users" + ], + "operationId": "importLdap", + "summary": "Import user / group from LDAP", + "description": "The imported user / group will be visible in SecureChange GUI under users section.\nIn multi domain mode, imported entity will be assigned with the domains of \"any user\" group.\nOnly users with 'view settings tab' permission can run this API.", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LdapPartyDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Unable to establish a connection to server <SERVER_IP>:<SERVER_PORT> within the configured timeout of <TIMEOUT> milliseconds." + }, + "403": { + "description": "Access is denied" + }, + "200": { + "description": "Import user / group from LDAP" + } + } + } + }, + "/securechangeworkflow/api/securechange/users/{id}": { + "get": { + "tags": [ + "System Users" + ], + "operationId": "getParty", + "summary": "Return the specified user", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "User ID" + }, + { + "name": "scope", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Specifies the fields that will be returned in the response. FULL returns all fields. BASIC returns selected fields only. In the examples, you can see the list of fields returned for BASIC" + }, + { + "name": "showIndirectRelation", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Members that belong to the selected group only indirectly" + }, + { + "name": "show_permissions", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Permissions of the user" + } + ], + "responses": { + "400": { + "description": "User or group was not found." + }, + "200": { + "description": "Return the specified user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PartyDTO" + } + } + } + } + } + }, + "delete": { + "tags": [ + "System Users" + ], + "operationId": "deleteParty", + "summary": "Delete the specified User or Group", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "User ID" + } + ], + "responses": { + "400": { + "description": "User with id {id} does not exist" + }, + "200": { + "description": "Delete the specified User or Group" + } + } + } + }, + "/securechangeworkflow/api/securechange/users/{id}/roles": { + "put": { + "tags": [ + "System Users" + ], + "operationId": "updatePartyRoles", + "summary": "Update the roles that are assigned to a group or a user", + "description": "Update the roles assigned to existing group or user. Roles are identified by their unique name (not case-sensitive). An empty role list will remove all roles assigned to the specified group or user.\nRunning this API requires 'View Settings tab and configure Orchestration Suite settings' permission.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Group ID or User ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RolesListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Input parameter is not valid" + }, + "403": { + "description": "Access is denied." + }, + "406": { + "description": "Invalid format detected: name - is invalid. Text must include <1-50> characters" + }, + "200": { + "description": "Update the roles that are assigned to a group or a user" + } + } + } + }, + "/securechangeworkflow/api/securechange/workflows/active_workflows": { + "get": { + "tags": [ + "Workflows" + ], + "operationId": "getActiveWorkflowsByType", + "summary": "returns a list of the active workflows in securechange", + "description": "The workflow types to filter by are defined as follows : \nGENERICGeneric WorkflowACCESS_REQUEST_AND_MODIFY_GROUPAccess Request & Modify GroupACCESS_REQUESTAccess RequestMODIFY_GROUPModify GroupDECOMMISSION_NETWORK_OBJECTDecommission network objectRULE_DECOMMISSIONRule DecomissionRULE_RECERTIFICATIONRule RecertificationCLONE_NETWORK_OBJECT_POLICYClone network object PolicyRULE_MODIFICATIONRule Modification", + "parameters": [ + { + "name": "type", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Type of the workflow to filter by" + } + ], + "responses": { + "403": { + "description": "Access is denied" + }, + "400": { + "description": "<TYPE> is not a valid workflow type" + }, + "200": { + "description": "returns a list of the active workflows in securechange", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BasicWorkflowInfoListDTO" + } + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/Tufin/SecureChange/OpenAPIs/tufin_securechange-latest.json b/Tufin/SecureChange/OpenAPIs/tufin_securechange-latest.json new file mode 100644 index 0000000..b839554 --- /dev/null +++ b/Tufin/SecureChange/OpenAPIs/tufin_securechange-latest.json @@ -0,0 +1,9339 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Tufin SecureChange", + "description": "Tufin SecureChange network security change automation and workflow REST API.", + "version": "latest", + "x-vendor-api-version": "25.2", + "x-itential-curated": "Trimmed to 70 of 101 upstream operations covering ticket creation/read/update and full lifecycle actions (Tickets, Ticket Lifecycle: confirm/reject/cancel/reassign/redo), ticket step/task/field handling, non-deprecated ticket search, saved queries CRUD, request search/cancel, workflow listing, and target-device lookup for access requests. See the repo README for the full scope and the full spec." + }, + "servers": [ + { + "url": "https://{host}/securechangeworkflow/api", + "variables": { + "host": { + "default": "tufin.example.com" + } + } + } + ], + "security": [ + { + "basicAuth": [] + } + ], + "components": { + "securitySchemes": { + "basicAuth": { + "type": "http", + "scheme": "basic" + } + }, + "schemas": { + "RDVerifierError": { + "type": "object" + }, + "DomainDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the domain" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the domain" + }, + "description": { + "type": "string", + "description": "The description of the domain" + } + }, + "required": [ + "name", + "id", + "description" + ] + }, + "LocalDate": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "format": "int32" + } + } + }, + "CommitResultsDTO": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/CommitReportStatus" + }, + "report": { + "$ref": "#/components/schemas/commit_commit_result_link" + } + } + }, + "TicketExternalDataDTO": { + "type": "object", + "properties": { + "request_id": { + "type": "string", + "description": "The request ID" + }, + "requester": { + "type": "string", + "description": "The requester" + } + } + }, + "RelatedRulesBindingDTO": { + "type": "object", + "properties": { + "related_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedRuleContainerDTO" + } + } + } + }, + "RoleDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the role" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the role" + }, + "role_link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "description": { + "type": "string", + "description": "The description of the role" + } + }, + "required": [ + "name", + "id" + ] + }, + "account_ref": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The account ref name" + }, + "id": { + "type": "string", + "description": "The account ref ID" + }, + "cloud_vendor": { + "type": "string", + "description": "The account ref cloud vendor" + } + } + }, + "TicketDTO": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "The priority of the request" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the ticket" + }, + "status": { + "type": "string", + "description": "The status of the ticket" + }, + "application_details": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "comments": { + "$ref": "#/components/schemas/TicketCommentListDTO" + }, + "expiration_date": { + "type": "string", + "description": "Request is valid until this date" + }, + "subject": { + "type": "string", + "description": "The subject of the ticket" + }, + "referenced_ticket": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "requester": { + "type": "string", + "description": "The name of the requester" + }, + "create_date": { + "type": "string", + "format": "date-time", + "description": "The ticket creation date" + }, + "update_date": { + "type": "string", + "format": "date-time", + "description": "The ticket last update date" + }, + "close_date": { + "type": "string", + "format": "date-time", + "description": "The ticket close date" + }, + "notification_group": { + "$ref": "#/components/schemas/group" + }, + "sla_status": { + "type": "string", + "description": "The Tickets current SLA status" + }, + "sla_outcome": { + "type": "string", + "description": "The outcome of the SLA" + }, + "sla_tracking_state": { + "type": "string", + "description": "The Tickets current SLA tracking state" + }, + "steps": { + "$ref": "#/components/schemas/TicketStagesListDTO" + }, + "business_duration": { + "type": "integer", + "format": "int64", + "description": "The ticket business duration" + }, + "expiration_field_name": { + "type": "string", + "description": "The Request is required until" + }, + "expiration_status": { + "$ref": "#/components/schemas/ExpirationStatusDTO" + }, + "external_data": { + "$ref": "#/components/schemas/TicketExternalDataDTO" + }, + "current_step": { + "$ref": "#/components/schemas/TicketCurrentStageReferenceDTO" + }, + "workflow": { + "$ref": "#/components/schemas/WorkflowReferenceDTO" + }, + "domain_name": { + "type": "string", + "description": "The domain in which the ticket is posted" + }, + "requester_id": { + "type": "integer", + "format": "int64", + "description": "The user id which the ticket is created on behalf of (used for 'on-behalf' feature)" + }, + "application_changes": { + "$ref": "#/components/schemas/TicketApplicationChangeListDTO" + }, + "completion_details": { + "$ref": "#/components/schemas/CompletionDetailsDTO" + } + }, + "required": [ + "priority", + "subject", + "workflow", + "domain_name" + ] + }, + "multi_target": { + "type": "object", + "properties": { + "target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TargetDTO" + }, + "description": "The list of target objects" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "target", + "name", + "read_only" + ] + }, + "RelatedRulesAccessRequestDTO": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedRulesDeviceDTO" + } + }, + "AR": { + "type": "integer", + "format": "int32" + } + } + }, + "labels": { + "type": "object", + "properties": { + "label": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The labels for the traffic flow" + } + } + }, + "TicketStageDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The step name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The step ID" + }, + "tasks": { + "$ref": "#/components/schemas/TicketTaskListDTO" + }, + "skipped": { + "type": "boolean", + "description": "whether the task was skipped" + }, + "redone": { + "type": "boolean", + "description": "whether the task was redone" + }, + "business_duration": { + "type": "integer", + "format": "int64", + "description": "The step business duration" + } + }, + "required": [ + "tasks" + ] + }, + "SubPolicyDTO": { + "type": "object", + "properties": { + "sub_policy_uid": { + "$ref": "#/components/schemas/UUID" + }, + "sub_policy_rule": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The rules related to the subpolicy" + }, + "sub_policy_name": { + "type": "string", + "description": "The name of the Inline Layer subpolicy" + } + }, + "required": [ + "sub_policy_uid", + "sub_policy_rule", + "sub_policy_name" + ] + }, + "DesignerBindingSuggestionsDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "binding_uid": { + "type": "string" + }, + "binding_name": { + "type": "string" + }, + "instruction": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerInstructionDTO" + }, + "description": "List of instructions" + } + } + }, + "MultiDestinationDTO": { + "type": "object", + "properties": { + "destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DestinationDTO" + }, + "description": "The destinations" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "destination", + "name", + "read_only" + ] + }, + "CompletionDetailsDTO": { + "type": "object", + "properties": { + "stepId": { + "type": "integer", + "format": "int64", + "description": "The completion step id " + } + } + }, + "RedesignStatusDTO": { + "type": "object" + }, + "ZoneType": { + "type": "object" + }, + "PartyDTOType": { + "type": "object" + }, + "ObjectReferenceUIDDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the referenced object" + }, + "uid": { + "$ref": "#/components/schemas/UUID" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + } + } + }, + "IpType": { + "type": "object", + "properties": { + "ipv6": { + "type": "boolean" + }, + "ipv4": { + "type": "boolean" + } + } + }, + "MembersListDTO": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartyDTO" + }, + "description": "The list of members" + }, + "partial_list": { + "type": "boolean", + "description": "Partial list; true if only a partial list is returned" + } + } + }, + "OpmDeviceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "device name" + }, + "item": { + "type": "array", + "items": { + "type": "string" + }, + "description": "device identifier path" + }, + "api_v1_Id": { + "type": "integer", + "format": "int32", + "description": "device api v1 id" + } + } + }, + "Referenced": { + "type": "object", + "properties": { + "xmlValue": { + "type": "string" + } + } + }, + "ObjectReferenceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the referenced object" + }, + "id": { + "type": "string", + "description": "ID" + }, + "type": { + "type": "string", + "description": "The type of the referenced object" + }, + "display_name": { + "type": "string", + "description": "The display name of the referenced object" + }, + "management_domain": { + "type": "string", + "description": "The management domain from which the referenced object comes from" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the referenced object" + }, + "ip": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FQDNIpDTO" + } + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of references to a DM_INLINE group members" + } + }, + "required": [ + "id" + ] + }, + "VerifierDeviceDTO": { + "type": "object", + "properties": { + "time": { + "$ref": "#/components/schemas/LocalTime" + }, + "date": { + "$ref": "#/components/schemas/LocalDate" + }, + "verifier_warning": { + "type": "string", + "description": "verifier warning" + }, + "verifier_error": { + "type": "string", + "description": "verifier error message" + }, + "verifier_error_code": { + "type": "string", + "description": "verifier error code" + }, + "verifier_binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifierBindingDTO" + }, + "description": "verifier bindings" + }, + "vendor": { + "type": "string", + "description": "vendor" + }, + "verification_status": { + "type": "string", + "description": "verification status" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "ID of management" + }, + "management_name": { + "type": "string", + "description": "name of management" + }, + "device_type": { + "$ref": "#/components/schemas/CpType" + }, + "revision_id": { + "type": "integer", + "format": "int32", + "description": "revision id" + }, + "vendor_type": { + "$ref": "#/components/schemas/VendorTypeDTO" + }, + "revision_number": { + "type": "integer", + "format": "int32", + "description": "revision number" + }, + "administrator": { + "type": "string", + "description": "name of administrator that made the change" + }, + "changed_on": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "management_ip": { + "type": "string", + "description": "ip of management" + }, + "received_on": { + "$ref": "#/components/schemas/LocalDateTime" + } + }, + "required": [ + "management_id", + "revision_id" + ] + }, + "VerifierOpmTargetDTO": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ResultDTO" + }, + "error": { + "$ref": "#/components/schemas/ErrorDTO" + }, + "requested_target": { + "type": "array", + "items": { + "type": "string" + }, + "description": "verifier opm requested target" + } + } + }, + "access_request_verifer_result_expanded": { + "type": "object", + "properties": { + "verifier_target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifierDeviceDTO" + }, + "description": "The targets verified" + }, + "verifier_opm_target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifierOpmTargetDTO" + }, + "description": "The opm targets verified" + }, + "topology_image_link": { + "$ref": "#/components/schemas/LinkDTO" + } + } + }, + "TicketStagesListDTO": { + "type": "object", + "properties": { + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketStageDTO" + }, + "description": "The list of steps" + } + }, + "required": [ + "step" + ] + }, + "ExternalRiskAnalysisResultDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The external risk's comment" + }, + "severity": { + "$ref": "#/components/schemas/RiskAnalysisSeverity" + }, + "status": { + "type": "string", + "description": "The external risk's status" + }, + "score": { + "type": "number", + "format": "double", + "description": "The external risk's score" + }, + "detailed_report_url": { + "type": "string", + "description": "The detailed_report_url of external risk" + } + }, + "required": [ + "comment", + "severity", + "status", + "score", + "detailed_report_url" + ] + }, + "DeviceUserDTO": { + "type": "object", + "properties": { + "typeOnDevice": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "VpnCommunityDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "clone_server_policy_verifer_result_expanded": { + "type": "object", + "properties": { + "cannot_compute_reason": { + "type": "string", + "description": "cannot compute reason error message" + }, + "verifier_target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerCloneVerificationDeviceDTO" + }, + "description": "The targets verified" + } + } + }, + "ResultDTO": { + "type": "object", + "properties": { + "version": { + "$ref": "#/components/schemas/VersionDTO" + }, + "device": { + "$ref": "#/components/schemas/OpmDeviceDTO" + }, + "combined_policy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "verifier combined policies result" + } + } + }, + "LinkDTO": { + "type": "object", + "properties": { + "@href": { + "type": "string", + "description": "The location of the referenced object" + } + }, + "required": [ + "@href" + ] + }, + "url_category": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "comment": { + "type": "string" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int32" + }, + "overrides": { + "type": "boolean" + }, + "overridden": { + "type": "boolean" + }, + "urls": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "TicketApplicationChangeListDTO": { + "type": "object", + "properties": { + "application_change": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketApplicationChangeDTO" + }, + "description": "The application changes list" + } + }, + "required": [ + "application_change" + ] + }, + "users": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of users" + } + } + }, + "VerifierBindingDTO": { + "type": "object", + "properties": { + "implementing_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "description": "implementing rules for specific device binding" + }, + "violating_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "description": "violating rules for specific device binding" + }, + "verifier_warning": { + "type": "string", + "description": "warning" + }, + "verified": { + "type": "boolean", + "description": "whether binding is verified" + }, + "percent_implemented": { + "type": "number", + "format": "double", + "description": "implementation percent" + }, + "implementation_percentage_threshold": { + "type": "number", + "format": "double", + "description": "original threshold percent" + }, + "verifier_error": { + "type": "string", + "description": "verifier error message" + }, + "handled_by_implicit_cleanup_rule": { + "$ref": "#/components/schemas/RuleTrafficHandling" + }, + "verifier_error_code": { + "type": "string", + "description": "verifier error code" + }, + "binding": { + "$ref": "#/components/schemas/Binding_DTO" + } + } + }, + "TargetDTO": { + "type": "object", + "properties": { + "external_uid": { + "type": "string", + "description": "The external uid" + }, + "external_parent_uid": { + "type": "string", + "description": "The external parent uid" + }, + "tenant_id": { + "type": "string", + "description": "The tenant id" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "SlimRuleDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "rule name" + }, + "comment": { + "type": "string", + "description": "rule comment" + }, + "option": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleOption" + }, + "description": "options" + }, + "is_disabled": { + "type": "boolean", + "description": "is disabled" + }, + "uid": { + "type": "string", + "description": "rule uid" + }, + "action": { + "$ref": "#/components/schemas/RuleAction" + }, + "ruleNumber": { + "type": "integer", + "format": "int64", + "description": "rule number" + }, + "displayRuleNumber": { + "type": "string", + "description": "display_rule_number" + }, + "sourceNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "source networks" + }, + "destinationNetworks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "destination networks" + }, + "destinationServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "destination services" + }, + "sourceServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseServiceDTO" + }, + "description": "source services" + }, + "applications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + }, + "description": "application" + }, + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUserDTO" + }, + "description": "users" + }, + "additional_parameter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/additional_parameter" + }, + "description": "additional parameters" + }, + "url_category": { + "type": "array", + "items": { + "$ref": "#/components/schemas/url_category" + }, + "description": "url categories" + }, + "install_on": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + }, + "description": "install on" + }, + "time": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TimeDTO" + }, + "description": "time" + }, + "community": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VpnCommunityDTO" + }, + "description": "communities" + }, + "track": { + "$ref": "#/components/schemas/RuleTrackDTO" + }, + "sub_policy": { + "$ref": "#/components/schemas/SubPolicyDTO" + }, + "rule_location": { + "type": "string", + "description": "rule_location" + }, + "negatedDestination": { + "type": "boolean", + "description": "The destination is negated" + }, + "negatedDestinationService": { + "type": "boolean", + "description": "The destination service is negated" + }, + "negatedSource": { + "type": "boolean", + "description": "The source is negated" + }, + "negatedSourceService": { + "type": "boolean", + "description": "The source service is negated" + }, + "from_zone": { + "type": "string", + "description": "from_zone" + }, + "to_zone": { + "type": "string", + "description": "to_zone" + } + } + }, + "LocalDateTime": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "format": "int32" + } + } + }, + "compliance_policies": { + "type": "object", + "properties": { + "compliance_policy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CompliancePolicyDTO" + }, + "description": "The compliance policy for the risk" + } + } + }, + "TicketCommentDTO": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/CommentOriginDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "id" + }, + "type": { + "type": "string", + "description": "The comment type" + }, + "content": { + "type": "string", + "description": "The comment" + }, + "user": { + "type": "string", + "description": "The commenter" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The date created" + }, + "task_name": { + "type": "string", + "description": "The task name connected with this comment" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceUIDDTO" + }, + "description": "The attachments" + }, + "visible_to_requester": { + "type": "boolean", + "description": "Specifies whether the comment is visible to the requester" + }, + "user_id": { + "type": "integer", + "format": "int64", + "description": "The commenter id" + } + } + }, + "ViolationDTO": { + "type": "object", + "properties": { + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "ExpirationStatusDTO": { + "type": "object" + }, + "FQDNIpDTO": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "ipType": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "subnetMask": { + "type": "string" + } + } + }, + "ServerCloneVerificationBindingDTO": { + "type": "object", + "properties": { + "rule_implemented": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerCloneVerificationSlimRuleDTO" + }, + "description": "implementing rules for specific device binding" + }, + "rule_not_implemented": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerCloneVerificationNotImplementedSlimRuleDTO" + }, + "description": "not implementing rules for specific device binding" + }, + "binding": { + "$ref": "#/components/schemas/Binding_DTO" + } + } + }, + "ServerCloneVerificationNotImplementedSlimRuleDTO": { + "type": "object", + "properties": { + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "rule's not implemented ip list" + }, + "object_name": { + "type": "array", + "items": { + "type": "string" + }, + "description": "overridden and overriding object name list" + }, + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "from_server": { + "$ref": "#/components/schemas/MarkedNetworkObjectsDTO" + }, + "to_servers": { + "$ref": "#/components/schemas/MarkedNetworkObjectsDTO" + } + } + }, + "MultiSourceDTO": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SourceDTO" + }, + "description": "The sources" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "source", + "name", + "read_only" + ] + }, + "RDVerificationRulesDTO": { + "type": "object", + "properties": { + "rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "description": "rules" + }, + "status": { + "type": "string" + } + } + }, + "AdminDomainDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "VersionDTO": { + "type": "object", + "properties": { + "timestamp": { + "type": "string", + "description": "version timestamp" + } + } + }, + "PolicyZoneDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ZoneType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "global": { + "type": "boolean" + }, + "address_book": { + "type": "string" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "zone_name_in_parent": { + "type": "string" + } + } + }, + "TicketCommentListDTO": { + "type": "object", + "properties": { + "comment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketCommentDTO" + }, + "description": "The comment" + } + } + }, + "service": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "match_rule": { + "type": "string" + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "TicketTaskFieldDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "MarkedObjectsDTO": { + "type": "object", + "properties": { + "uid": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "applications": { + "type": "object", + "properties": { + "application": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The applications" + } + } + }, + "ApplicationDTO": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "RiskDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message" + }, + "status": { + "type": "string", + "description": "The risk's status" + }, + "external_risk_analysis": { + "$ref": "#/components/schemas/ExternalRiskAnalysisResultDTO" + }, + "security_policy_violations": { + "$ref": "#/components/schemas/SecurityPolicyViolationDTO" + }, + "compliance_policies": { + "$ref": "#/components/schemas/compliance_policies" + }, + "compliance_and_usp_status": { + "type": "string" + }, + "reason": { + "type": "string", + "description": "The reason for the risk" + } + } + }, + "ServiceDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type" + }, + "port": { + "type": "string", + "description": "port" + }, + "protocol": { + "type": "string", + "description": "protocol" + }, + "application_name": { + "type": "string", + "description": "application name" + }, + "non_default_ports": { + "type": "boolean", + "description": "The application identity includes non-default services" + }, + "predefined_name": { + "type": "string", + "description": "predefined name" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceDTO" + }, + "description": "application services" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "multi_service": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceDTO" + }, + "description": "The services" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "service", + "name", + "read_only" + ] + }, + "UnlicensedDevicesForAutomationDTO": { + "type": "object", + "properties": { + "unlicensed_device_for_automation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "unlicensed devices for automation" + } + } + }, + "NetworkObjectDTO": { + "type": "object", + "properties": { + "host_name": { + "type": "string", + "description": "host name" + }, + "region": { + "type": "string", + "description": "region" + }, + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The external resource reference ips" + }, + "cidr": { + "type": "string", + "format": "int16", + "description": "cidr" + }, + "netmask": { + "type": "string", + "description": "netmask" + }, + "ip_address": { + "type": "string", + "description": "ip address" + }, + "range_first_ip": { + "type": "string", + "description": "min ip" + }, + "range_last_ip": { + "type": "string", + "description": "max ip" + }, + "nat_ip_address": { + "type": "string", + "description": "nat ip address" + }, + "dns_ip_addresses": { + "$ref": "#/components/schemas/MultiDnsIpAddressDTO" + }, + "nat_netmask": { + "type": "string", + "description": "nat netmask" + }, + "nat_cidr": { + "type": "string", + "format": "int16", + "description": "nat cidr" + }, + "resource_ref": { + "$ref": "#/components/schemas/resource_ref" + }, + "account_ref": { + "$ref": "#/components/schemas/account_ref" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "RuleTrafficHandling": { + "type": "object" + }, + "access_request_designer_result_expanded": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "redesign_status": { + "$ref": "#/components/schemas/RedesignStatusDTO" + }, + "device_suggestion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerDeviceSuggestionsDTO" + }, + "description": "List of devices to change" + }, + "error_description": { + "type": "string", + "description": "error description" + } + } + }, + "RelatedRulesDeviceDTO": { + "type": "object", + "properties": { + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedRulesBindingDTO" + } + }, + "management_id": { + "type": "integer", + "format": "int32" + } + } + }, + "LocalTime": { + "type": "object" + }, + "RuleTrackDTO": { + "type": "object", + "properties": { + "track_level": { + "$ref": "#/components/schemas/RuleTrackLevel" + }, + "track_interval": { + "type": "integer", + "format": "int32" + } + } + }, + "additional_parameter": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "display_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "ServerCloneVerificationSlimRuleDTO": { + "type": "object", + "properties": { + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "from_server": { + "$ref": "#/components/schemas/MarkedNetworkObjectsDTO" + }, + "to_servers": { + "$ref": "#/components/schemas/MarkedNetworkObjectsDTO" + } + } + }, + "PermissionDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the permission" + }, + "value": { + "type": "boolean", + "description": "The permission setting" + }, + "key": { + "type": "string", + "description": "The Enum that represents the permission" + } + }, + "required": [ + "name", + "value" + ] + }, + "ServerCloneVerificationDeviceDTO": { + "type": "object", + "properties": { + "verifier_binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServerCloneVerificationBindingDTO" + }, + "description": "verifier bindings" + }, + "vendor": { + "type": "string", + "description": "vendor" + }, + "verification_status": { + "type": "string", + "description": "verification status" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "ID of management" + }, + "management_name": { + "type": "string", + "description": "name of management" + }, + "device_type": { + "$ref": "#/components/schemas/CpType" + }, + "revision_id": { + "type": "integer", + "format": "int32", + "description": "revision id" + }, + "vendor_type": { + "$ref": "#/components/schemas/VendorTypeDTO" + }, + "revision_number": { + "type": "integer", + "format": "int32", + "description": "revision number" + }, + "administrator": { + "type": "string", + "description": "name of administrator that made the change" + }, + "changed_on": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "management_ip": { + "type": "string", + "description": "ip of management" + }, + "received_on": { + "$ref": "#/components/schemas/LocalDateTime" + } + }, + "required": [ + "management_id", + "revision_id" + ] + }, + "related_rules_related_rules_expanded": { + "type": "object", + "properties": { + "access_request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedRulesAccessRequestDTO" + } + } + } + }, + "DesignerPersistedCommandDTO": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "push status" + }, + "order": { + "type": "integer", + "format": "int32" + }, + "command": { + "type": "string" + }, + "failure_reason": { + "type": "string", + "description": "in case that push failed" + } + } + }, + "TicketCurrentStageReferenceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The current step name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The current step id" + } + } + }, + "VerifierDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message" + }, + "status": { + "type": "string", + "description": "The status (whether it is verified or not)" + }, + "result": { + "$ref": "#/components/schemas/VerifierResultDTO" + }, + "reason": { + "$ref": "#/components/schemas/void" + } + } + }, + "RolesListDTO": { + "type": "object", + "properties": { + "role": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RoleDTO" + }, + "description": "The list of roles of the user" + } + }, + "required": [ + "role" + ] + }, + "RuleAction": { + "type": "object" + }, + "TicketTaskListDTO": { + "type": "object", + "properties": { + "task": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketTaskDTO" + }, + "description": "The list of tasks" + } + }, + "required": [ + "task" + ] + }, + "MembersOfListDTO": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartyDTO" + }, + "description": "The group to which the user belongs" + } + } + }, + "ComplianceRuleListDTO": { + "type": "object", + "properties": { + "compliance_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ComplianceRuleDTO" + }, + "description": "The list of compliance policy rules" + } + } + }, + "CommitReportStatus": { + "type": "object" + }, + "TimeDTO": { + "type": "object", + "properties": { + "month": { + "type": "string" + }, + "days": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "comments": { + "type": "string" + }, + "end_period": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "start_period": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "month_days": { + "type": "string" + }, + "time_interval_from1": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_from2": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_from3": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_to1": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_to2": { + "$ref": "#/components/schemas/LocalTime" + }, + "time_interval_to3": { + "$ref": "#/components/schemas/LocalTime" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "MarkedNetworkObjectsDTO": { + "type": "object", + "properties": { + "uid": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "commit_commit_result_link": { + "type": "object" + }, + "RDVerifierBindingDTO": { + "type": "object", + "properties": { + "binding_name": { + "type": "string", + "description": "binding name" + }, + "binding_uid": { + "type": "string", + "description": "binding uid" + }, + "implemented_rules": { + "$ref": "#/components/schemas/RDVerificationRulesDTO" + }, + "violated_rules_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RDVerificationRulesDTO" + }, + "description": "violated rules lists" + } + } + }, + "RuleOption": { + "type": "object" + }, + "DesignerInstructionDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "content": { + "type": "string" + }, + "error_message": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "status": { + "type": "string" + }, + "rule_uid": { + "type": "string" + }, + "warning_message": { + "type": "string" + }, + "tag": { + "type": "array", + "items": { + "type": "string" + } + }, + "instruction_type": { + "type": "string" + }, + "rule_order": { + "type": "string" + }, + "rule_placement": { + "type": "string" + }, + "implementation_failure_reason": { + "type": "string" + }, + "requested_network_object_name": { + "type": "string" + }, + "requested_service_object_name": { + "type": "string" + }, + "rule_name": { + "type": "string" + }, + "original_shadowed_rule_num": { + "type": "integer", + "format": "int64" + }, + "original_shadowed_rule_name": { + "type": "string" + }, + "security_group": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityGroupDTO" + } + }, + "application_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + } + }, + "display_rule_order": { + "type": "string" + }, + "log_forwarding_profile": { + "type": "string" + }, + "source_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "destination_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object" + } + }, + "service_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/service" + } + }, + "modified_object_name": { + "type": "string" + }, + "order": { + "type": "array", + "items": { + "type": "string" + } + }, + "modified_object_uid": { + "type": "string" + }, + "change_action": { + "type": "string" + }, + "before_global": { + "type": "boolean" + }, + "security_profile_group": { + "type": "string" + }, + "implementing_access_request": { + "type": "string" + }, + "url_category_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/url_category" + } + }, + "device_added_network_object": { + "$ref": "#/components/schemas/network_object" + }, + "device_added_service_object": { + "$ref": "#/components/schemas/service" + }, + "device_removed_network_object": { + "$ref": "#/components/schemas/network_object" + }, + "device_removed_service_object": { + "$ref": "#/components/schemas/service" + }, + "before_section": { + "type": "boolean" + }, + "device_modified_network_object": { + "$ref": "#/components/schemas/network_object" + }, + "device_modified_service_object": { + "$ref": "#/components/schemas/service" + }, + "modified_field": { + "type": "array", + "items": { + "type": "string" + } + }, + "device_added_user_object": { + "$ref": "#/components/schemas/DeviceUserDTO" + }, + "requested_user_object_name": { + "type": "string" + }, + "user_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceUserDTO" + } + } + } + }, + "RiskAnalysisSeverity": { + "type": "object" + }, + "VerifierResultDTO": { + "type": "object" + }, + "BaseServiceDTO": { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "SecurityPolicyViolationSeverity": { + "type": "object" + }, + "SecurityGroupDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Security group name" + }, + "uid": { + "type": "string", + "description": "Security group uid" + } + }, + "required": [ + "name", + "uid" + ] + }, + "RuleTrackLevel": { + "type": "object", + "properties": { + "displayName": { + "type": "string" + } + } + }, + "WorkflowReferenceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The workflow name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The workflow ID" + }, + "uses_topology": { + "type": "boolean", + "description": "When the value is true, the Access Request tools in the workflow use Topology. When the value is false, the Access Request tools in the workflow do not use Topology." + } + }, + "required": [ + "name" + ] + }, + "PartyDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the user" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyDTOType" + }, + "display_name": { + "type": "string", + "description": "The display name of the user" + }, + "email": { + "type": "string", + "description": "The email of the user" + }, + "ldapDn": { + "type": "string", + "description": "The LDAP DN of the user" + }, + "ldap_configuration": { + "$ref": "#/components/schemas/LdapConfigurationDTO" + }, + "roles": { + "$ref": "#/components/schemas/RolesListDTO" + }, + "authentication_method": { + "type": "string", + "description": "The method of authentication for the user" + }, + "origin_type": { + "type": "string", + "description": "The origin type of the user, 'Local' is available to GET only" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member_of": { + "$ref": "#/components/schemas/MembersOfListDTO" + }, + "domains": { + "$ref": "#/components/schemas/DomainsListDTO" + } + }, + "required": [ + "name" + ] + }, + "MultiDnsIpAddressDTO": { + "type": "object", + "properties": { + "ip_address": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of dns ip address" + } + } + }, + "DomainsListDTO": { + "type": "object", + "properties": { + "domain": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DomainDTO" + }, + "description": "The list of domains" + } + }, + "required": [ + "domain" + ] + }, + "SourceDTO": { + "type": "object", + "properties": { + "ldap_entity_id": { + "type": "string", + "description": "ldap group Id" + }, + "ldap_entity_dn": { + "type": "string", + "description": "ldap group dn" + }, + "ldap_entity_name": { + "type": "string", + "description": "ldap group name" + }, + "host_name": { + "type": "string", + "description": "host name" + }, + "region": { + "type": "string", + "description": "region" + }, + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The external resource reference ips" + }, + "cidr": { + "type": "string", + "format": "int16", + "description": "cidr" + }, + "netmask": { + "type": "string", + "description": "netmask" + }, + "ip_address": { + "type": "string", + "description": "ip address" + }, + "range_first_ip": { + "type": "string", + "description": "min ip" + }, + "range_last_ip": { + "type": "string", + "description": "max ip" + }, + "nat_ip_address": { + "type": "string", + "description": "nat ip address" + }, + "dns_ip_addresses": { + "$ref": "#/components/schemas/MultiDnsIpAddressDTO" + }, + "nat_netmask": { + "type": "string", + "description": "nat netmask" + }, + "nat_cidr": { + "type": "string", + "format": "int16", + "description": "nat cidr" + }, + "resource_ref": { + "$ref": "#/components/schemas/resource_ref" + }, + "account_ref": { + "$ref": "#/components/schemas/account_ref" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "NatInfoDTO": { + "type": "object", + "properties": { + "interface_name": { + "type": "string" + } + } + }, + "TicketApplicationChangeDTO": { + "type": "object" + }, + "CommentOriginDTO": { + "type": "object" + }, + "UUID": { + "type": "object" + }, + "GroupPermissionDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the permission" + }, + "value": { + "type": "boolean", + "description": "The permission setting" + } + } + }, + "group": { + "type": "object", + "properties": { + "members": { + "$ref": "#/components/schemas/MembersListDTO" + }, + "groupPermissions": { + "$ref": "#/components/schemas/GroupPermissionsListDTO" + }, + "description": { + "type": "string", + "description": "Description of the group" + }, + "name": { + "type": "string", + "description": "The name of the user" + }, + "permissions": { + "$ref": "#/components/schemas/PermissionListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the user" + }, + "type": { + "$ref": "#/components/schemas/PartyDTOType" + }, + "display_name": { + "type": "string", + "description": "The display name of the user" + }, + "email": { + "type": "string", + "description": "The email of the user" + }, + "ldapDn": { + "type": "string", + "description": "The LDAP DN of the user" + }, + "ldap_configuration": { + "$ref": "#/components/schemas/LdapConfigurationDTO" + }, + "roles": { + "$ref": "#/components/schemas/RolesListDTO" + }, + "authentication_method": { + "type": "string", + "description": "The method of authentication for the user" + }, + "origin_type": { + "type": "string", + "description": "The origin type of the user, 'Local' is available to GET only" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member_of": { + "$ref": "#/components/schemas/MembersOfListDTO" + }, + "domains": { + "$ref": "#/components/schemas/DomainsListDTO" + } + }, + "required": [ + "name" + ] + }, + "DestinationDTO": { + "type": "object", + "properties": { + "url_category_name": { + "type": "string", + "description": "urlCategoryName" + }, + "host_name": { + "type": "string", + "description": "host name" + }, + "region": { + "type": "string", + "description": "region" + }, + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The external resource reference ips" + }, + "cidr": { + "type": "string", + "format": "int16", + "description": "cidr" + }, + "netmask": { + "type": "string", + "description": "netmask" + }, + "ip_address": { + "type": "string", + "description": "ip address" + }, + "range_first_ip": { + "type": "string", + "description": "min ip" + }, + "range_last_ip": { + "type": "string", + "description": "max ip" + }, + "nat_ip_address": { + "type": "string", + "description": "nat ip address" + }, + "dns_ip_addresses": { + "$ref": "#/components/schemas/MultiDnsIpAddressDTO" + }, + "nat_netmask": { + "type": "string", + "description": "nat netmask" + }, + "nat_cidr": { + "type": "string", + "format": "int16", + "description": "nat cidr" + }, + "resource_ref": { + "$ref": "#/components/schemas/resource_ref" + }, + "account_ref": { + "$ref": "#/components/schemas/account_ref" + }, + "object_type": { + "type": "string", + "description": "The object type" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management id, this field is mandatory in GroupChangeDTO and GroupMemberNetworkObjectDTO" + }, + "management_name": { + "type": "string", + "description": "The management name, this field is mandatory in TargetDto" + }, + "@type": { + "type": "string", + "description": "The data type, in cases where object_updated_status is EXISTING_NOT_EDITED or EXISTING_EDITED, use type=\"Object\"" + }, + "object_UID": { + "type": "string", + "description": "The object uid, if you are adding a newly created object from a different group to the selected group, object_UID must be equal to name" + }, + "object_details": { + "type": "string", + "description": "The object details" + }, + "object_name": { + "type": "string", + "description": "The object name" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "name", + "read_only" + ] + }, + "RelatedRuleContainerDTO": { + "type": "object", + "properties": { + "rule": { + "$ref": "#/components/schemas/SlimRuleDTO" + }, + "ignore": { + "type": "boolean" + }, + "intersecting_objects": { + "$ref": "#/components/schemas/MarkedObjectsDTO" + } + } + }, + "CompliancePolicyDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The compliance policy name" + }, + "type": { + "type": "string", + "description": "The compliance policy type" + }, + "compliance_rules": { + "$ref": "#/components/schemas/ComplianceRuleListDTO" + } + } + }, + "ErrorDTO": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "error message" + }, + "code": { + "type": "string", + "description": "error code" + } + } + }, + "rule_decommission_verifier_result_expanded": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RDVerifierDeviceDTO" + }, + "description": "The targets verified" + } + } + }, + "TicketTaskDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The task name" + }, + "fields": { + "$ref": "#/components/schemas/TicketTaskFieldListDTO" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task ID" + }, + "status": { + "type": "string", + "description": "The task status" + }, + "unlicensed_devices_for_automation": { + "$ref": "#/components/schemas/UnlicensedDevicesForAutomationDTO" + }, + "pending_reason": { + "type": "string", + "description": "The task pending reason" + }, + "assignee_id": { + "type": "integer", + "format": "int64", + "description": "The assignee ID" + }, + "task_business_duration": { + "type": "integer", + "format": "int64", + "description": "The task business duration" + }, + "assignee": { + "type": "string", + "description": "The task assignee" + }, + "is_assigner": { + "type": "boolean", + "description": "Indicates whether the handler is the assigner" + }, + "assignee_participant_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the participant the assignee is based on" + }, + "pending_reason_description": { + "type": "string", + "description": "The task pending reason description" + }, + "potential_handlers": { + "$ref": "#/components/schemas/PartyListDTO" + } + }, + "required": [ + "fields", + "id", + "status", + "assignee" + ] + }, + "AccessRuleDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + }, + "labels": { + "$ref": "#/components/schemas/labels" + }, + "order": { + "type": "string", + "description": "The order" + }, + "action": { + "type": "string", + "description": "The action" + }, + "applications": { + "$ref": "#/components/schemas/applications" + }, + "users": { + "$ref": "#/components/schemas/users" + }, + "targets": { + "$ref": "#/components/schemas/multi_target" + }, + "uuid": { + "$ref": "#/components/schemas/UUID" + }, + "source_domain": { + "type": "string", + "description": "For SecureChange, The name of the source domain. For SecureApp, The name of the source customer. mandatory if interconnected domain mode is enabled" + }, + "destination_domain": { + "type": "string", + "description": "For SecureChange, The name of the destination domain. For SecureApp, The name of the destination customer. mandatory if interconnected domain mode is enabled" + }, + "sources": { + "$ref": "#/components/schemas/MultiSourceDTO" + }, + "destinations": { + "$ref": "#/components/schemas/MultiDestinationDTO" + }, + "use_topology": { + "type": "boolean" + }, + "verifier_result": { + "$ref": "#/components/schemas/VerifierDTO" + }, + "risk_analysis_result": { + "$ref": "#/components/schemas/RiskDTO" + }, + "services": { + "$ref": "#/components/schemas/multi_service" + }, + "name": { + "type": "string", + "description": "The task field name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The task field ID" + }, + "read_only": { + "type": "boolean", + "description": "Is the field readonly" + } + }, + "required": [ + "action", + "targets", + "source_domain", + "destination_domain", + "sources", + "destinations", + "services", + "name", + "read_only" + ] + }, + "PermissionListDTO": { + "type": "object", + "properties": { + "permission": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PermissionDTO" + }, + "description": "The list of permissions" + } + }, + "required": [ + "permission" + ] + }, + "PartyListDTO": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartyDTO" + }, + "description": "The list of users" + } + }, + "required": [ + "user" + ] + }, + "network_object": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "zone": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "installable_target": { + "type": "boolean" + }, + "referenced": { + "$ref": "#/components/schemas/Referenced" + }, + "management_domain": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "version_id": { + "type": "integer", + "format": "int64" + }, + "type_on_device": { + "type": "string" + }, + "address_book": { + "type": "string" + }, + "device_type": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "any_zone": { + "type": "boolean" + }, + "group_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "origin": { + "$ref": "#/components/schemas/Origin" + }, + "name": { + "type": "string" + }, + "class_name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "implicit": { + "type": "boolean" + }, + "shared": { + "type": "boolean" + }, + "application_name": { + "type": "string" + }, + "application_id": { + "type": "integer", + "format": "int64" + }, + "admin_domain": { + "$ref": "#/components/schemas/AdminDomainDTO" + }, + "inDomainElementId": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "PushStatusReasonDTO": { + "type": "object" + }, + "ComplianceRuleDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The compliance rule name" + }, + "number": { + "type": "string", + "description": "The compliance rule number" + } + } + }, + "TicketTaskFieldListDTO": { + "type": "object", + "properties": { + "field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketTaskFieldDTO" + }, + "description": "The field parameter" + } + }, + "required": [ + "field" + ] + }, + "DesignerDeviceSuggestionsDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "management_id": { + "type": "integer", + "format": "int64" + }, + "management_name": { + "type": "string" + }, + "redesign_status": { + "$ref": "#/components/schemas/RedesignStatusDTO" + }, + "vendor_name": { + "type": "string" + }, + "offline_device": { + "type": "boolean", + "description": "is offline device" + }, + "device_software_version": { + "type": "string" + }, + "push_status_reason": { + "$ref": "#/components/schemas/PushStatusReasonDTO" + }, + "change_id": { + "type": "string" + }, + "revision_number": { + "type": "integer", + "format": "int32" + }, + "ancestor_management_id": { + "type": "integer", + "format": "int32" + }, + "ancestor_management_name": { + "type": "string" + }, + "ancestor_management_revision_id": { + "type": "integer", + "format": "int32" + }, + "new_revision_arrived": { + "type": "boolean", + "description": "is new revision arrived" + }, + "push_status": { + "type": "string" + }, + "push_request_id": { + "type": "integer", + "format": "int64" + }, + "designer_command": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerPersistedCommandDTO" + } + }, + "binding_suggestion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DesignerBindingSuggestionsDTO" + } + }, + "commit_results": { + "$ref": "#/components/schemas/CommitResultsDTO" + } + } + }, + "SecurityPolicyViolationDTO": { + "type": "object", + "properties": { + "security_policy_violation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ViolationDTO" + } + } + } + }, + "RDVerifierDeviceDTO": { + "type": "object", + "properties": { + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RDVerifierBindingDTO" + }, + "description": "bindings" + }, + "verifierError": { + "$ref": "#/components/schemas/RDVerifierError" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "ID of management" + }, + "management_name": { + "type": "string", + "description": "name of management" + }, + "device_type": { + "$ref": "#/components/schemas/CpType" + }, + "revision_id": { + "type": "integer", + "format": "int32", + "description": "revision id" + }, + "vendor_type": { + "$ref": "#/components/schemas/VendorTypeDTO" + }, + "revision_number": { + "type": "integer", + "format": "int32", + "description": "revision number" + }, + "administrator": { + "type": "string", + "description": "name of administrator that made the change" + }, + "changed_on": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "management_ip": { + "type": "string", + "description": "ip of management" + }, + "received_on": { + "$ref": "#/components/schemas/LocalDateTime" + } + }, + "required": [ + "management_id", + "revision_id" + ] + }, + "GroupPermissionsListDTO": { + "type": "object", + "properties": { + "groupPermission": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GroupPermissionDTO" + }, + "description": "The list of permissions for this group" + } + } + }, + "resource_ref": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The resource ref name" + }, + "id": { + "type": "string", + "description": "The resource ref ID" + }, + "type": { + "type": "string", + "description": "The resource ref type" + } + } + }, + "LdapConfigurationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the LDAP server" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the LDAP server" + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port of the LDAP server" + }, + "server": { + "type": "string", + "description": "The server (host) of the LDAP server" + }, + "trust_any_certificate": { + "type": "boolean", + "description": "Should the LDAP server trust any certificate" + }, + "ldap_vendor": { + "type": "string", + "description": "The vendor of the LDAP server" + }, + "base_dn": { + "type": "string", + "description": "The base dn of the LDAP server" + }, + "user_dn": { + "type": "string", + "description": "The user dn of the LDAP server" + }, + "connect_using_ssl": { + "type": "boolean", + "description": "Should the LDAP server connect using SSL" + }, + "connect_timeout": { + "type": "integer", + "format": "int32", + "description": "The timeout for connecting the LDAP server" + } + }, + "required": [ + "name", + "id", + "port", + "server", + "trust_any_certificate", + "ldap_vendor", + "base_dn", + "user_dn", + "connect_using_ssl", + "connect_timeout" + ] + }, + "Binding_DTO": { + "type": "object" + }, + "QueryDTO": { + "type": "object" + }, + "QueryDTOList": { + "type": "object", + "properties": { + "query": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryDTO" + } + } + } + }, + "RequestsSearchListDTO": { + "type": "object", + "properties": { + "request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestSearchDTO" + }, + "description": " The list of requests" + } + } + }, + "RequestSearchDTO": { + "type": "object" + }, + "DeviceIdsListDTO": { + "type": "object", + "properties": { + "id": { + "type": "array", + "items": { + "type": "integer" + } + }, + "v2_id": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "sc_device": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The device name" + }, + "id": { + "type": "integer", + "format": "int32", + "description": "The device ID" + }, + "device_type": { + "type": "string", + "description": "The device type" + }, + "ip": { + "type": "string", + "description": "The device IP" + }, + "vendor": { + "type": "string", + "description": "The device vendor" + }, + "external_uid": { + "type": "string", + "description": "The external uid" + }, + "external_parent_uid": { + "type": "string", + "description": "The external parent uid" + }, + "tenant_id": { + "type": "string", + "description": "The tenant id" + }, + "v2_id": { + "type": "string", + "description": "The device v2 ID" + }, + "domain": { + "$ref": "#/components/schemas/DomainDTO" + }, + "system_id": { + "type": "string", + "description": "The device system ID" + } + }, + "required": [ + "name", + "id", + "device_type", + "ip", + "vendor", + "v2_id", + "domain", + "system_id" + ] + }, + "DeviceListDTO": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sc_device" + } + } + } + }, + "TicketHistoryDTO": { + "type": "object", + "properties": { + "task_name": { + "type": "string", + "description": "The task name" + }, + "step_name": { + "type": "string", + "description": "The step name" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "date" + }, + "performed_by": { + "type": "string", + "description": "performed by" + }, + "description": { + "type": "string", + "description": "description" + } + }, + "required": [ + "task_name", + "step_name", + "date", + "performed_by", + "description" + ] + }, + "task_assignment_data": { + "type": "object", + "properties": { + "assignee_id": { + "type": "string", + "description": "the internal id of the assignee" + }, + "assignee_name": { + "type": "string", + "description": "the name of the assignee" + }, + "participant_id": { + "type": "string", + "description": "the internal id of the assignee party" + }, + "participant_name": { + "type": "string", + "description": "the name of the assignee party" + } + }, + "required": [ + "assignee_id", + "assignee_name", + "participant_id", + "participant_name" + ] + }, + "TicketHistoryListDTO": { + "type": "object", + "properties": { + "ticket_id": { + "type": "integer", + "format": "int64", + "description": "The ticket ID" + }, + "ticket_history_activity": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketHistoryDTO" + }, + "description": "The ticket history" + } + }, + "required": [ + "ticket_id", + "ticket_history_activity" + ] + }, + "TicketEvent": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "the type of the event" + }, + "timestamp": { + "type": "string", + "description": "the timestamp of the event" + }, + "domain_id": { + "type": "string", + "description": "the id of the domain" + }, + "ticket_id": { + "type": "string", + "description": "the id of the ticket" + }, + "task_id": { + "type": "string", + "description": "the internal id of the task" + }, + "workflow_type": { + "type": "string", + "description": "workflow type" + }, + "business_duration": { + "type": "integer", + "format": "int64", + "description": "the business duration" + }, + "sla_status": { + "type": "string", + "description": "the sla status" + }, + "workflow_name": { + "type": "string", + "description": "the name of the workflow" + }, + "task_name": { + "type": "string", + "description": "the name of the task" + }, + "parent_workflow_id": { + "type": "string", + "description": "the internal id of the parent workflow" + }, + "step_id": { + "type": "string", + "description": "the internal id of the step" + }, + "step_name": { + "type": "string", + "description": "the name of the step" + }, + "assignment_type": { + "type": "string", + "description": "the type of the assignment. possible types are: assigner, self assigned and reassign group" + }, + "task_assigned_data": { + "$ref": "#/components/schemas/task_assignment_data" + }, + "initiated_by": { + "type": "string", + "description": "initiated by" + }, + "potential_participants": { + "type": "array", + "items": { + "type": "string" + }, + "description": "the potential participants from the workflow" + }, + "error_automation_tool": { + "$ref": "#/components/schemas/error_automation_tool" + } + }, + "required": [ + "type", + "timestamp", + "domain_id", + "ticket_id", + "workflow_name", + "parent_workflow_id" + ] + }, + "CommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + } + }, + "required": [ + "comment" + ] + }, + "error_automation_tool": { + "type": "object", + "properties": { + "error_tool": { + "type": "string", + "description": "the automation tool that failed" + }, + "error_reason": { + "type": "array", + "items": { + "type": "string" + }, + "description": "the reason for the error" + } + } + }, + "RejectCommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + } + }, + "required": [ + "comment" + ] + }, + "TicketEventsCreateHistoryStatusDTO": { + "type": "object", + "properties": { + "run_status": { + "$ref": "#/components/schemas/HistoryStatus" + }, + "oldest_event_time": { + "type": "string", + "description": "Oldest event time" + } + }, + "required": [ + "run_status" + ] + }, + "HistoryStatus": { + "type": "object" + }, + "TicketEventsCreateHistoryRequestDTO": { + "type": "object", + "properties": { + "from": { + "type": "string", + "description": "from date. Date format expected: yyyy-MM-dd" + } + }, + "required": [ + "from" + ] + }, + "ReassignTaskCommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + } + }, + "required": [ + "comment" + ] + }, + "RedoStepCommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment" + } + }, + "required": [ + "comment" + ] + }, + "TicketEventListDTO": { + "type": "object", + "properties": { + "ticket_event": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketEvent" + }, + "description": "The ticket event list" + }, + "countOfElemnt": { + "type": "integer", + "format": "int32" + }, + "totalElement": { + "type": "integer", + "format": "int64" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of items that can be retrieved" + } + }, + "required": [ + "ticket_event", + "count", + "total" + ] + }, + "ConfirmCommentDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string" + } + }, + "required": [ + "comment" + ] + }, + "InstructionStatus": { + "type": "object" + }, + "CoveredByField": { + "type": "object", + "properties": { + "order": { + "type": "integer", + "format": "int32", + "description": "Order" + }, + "type": { + "type": "string", + "description": "Field type" + } + }, + "required": [ + "order", + "type" + ] + }, + "RootDevice": { + "type": "object", + "properties": { + "api_v1_id": { + "type": "integer", + "format": "int32", + "description": "API v1 ID" + } + }, + "required": [ + "api_v1_id" + ] + }, + "AccessRequestsSecurityZonesDTO": { + "type": "object", + "properties": { + "access_request_security_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRequestSecurityZoneDTO" + }, + "description": "The list of access request security zone" + } + }, + "required": [ + "access_request_security_zone" + ] + }, + "AccessRequestSecurityZoneDTO": { + "type": "object", + "properties": { + "security_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityZoneDTO" + }, + "description": "The security zones of the destination" + }, + "access_request": { + "$ref": "#/components/schemas/AccessRequestDTO" + } + } + }, + "CommitDeviceResultDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "policy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommitPolicyResultDTO" + } + }, + "status": { + "$ref": "#/components/schemas/CommitStatusDTO" + }, + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "warning": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ChangedEntity": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name" + }, + "type": { + "type": "string", + "description": "The entity type" + }, + "uid": { + "type": "string", + "description": "UID" + }, + "new_entity_uid": { + "type": "string", + "description": "The new entity UID" + } + }, + "required": [ + "type" + ] + }, + "TicketListDTO": { + "type": "object", + "properties": { + "next": { + "$ref": "#/components/schemas/LinkDTO" + }, + "previous": { + "$ref": "#/components/schemas/LinkDTO" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketDTO" + }, + "description": "The list of tickets" + } + }, + "required": [ + "next", + "previous", + "ticket" + ] + }, + "DesignerResults": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The designer results ID" + }, + "status": { + "type": "string", + "description": "Result Status" + }, + "root_device": { + "$ref": "#/components/schemas/Device" + }, + "new_revision_status": { + "type": "string", + "description": "Revision status" + }, + "total_devices_results": { + "type": "integer", + "format": "int32", + "description": "Total devices results count per system ID" + }, + "device_results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceResults" + }, + "description": "Designer results for a device" + }, + "system_id": { + "type": "string", + "description": "The designer results system ID" + } + }, + "required": [ + "id", + "status", + "root_device", + "new_revision_status", + "total_devices_results", + "device_results", + "system_id" + ] + }, + "CombinedPolicy": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name" + }, + "uid": { + "type": "string", + "description": "UID" + } + }, + "required": [ + "name", + "uid" + ] + }, + "InstructionStatusResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Errors" + } + }, + "required": [ + "id", + "errors" + ] + }, + "DeviceProvisioningStatus": { + "type": "object" + }, + "ReplaceInstructionResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Status" + }, + "instructions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InstructionStatusResult" + }, + "description": "Instructions" + } + }, + "required": [ + "status", + "instructions" + ] + }, + "BusinessDurationRequestDTO": { + "type": "object", + "properties": { + "from": { + "type": "string", + "description": "the creation date of the affected tickets. Default value if not set is 2 years ago. Date format expected: yyyy-MM-dd. Value is limited for up to 2 years ago." + } + }, + "required": [ + "from" + ] + }, + "TicketPropertiesDTO": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "The priority of the ticket (use 'Critical, High, Normal, Low')" + }, + "expiration_date": { + "type": "string", + "description": "The expiration date of the ticket (use yyyy-mm-dd for update and empty value for NONE)" + }, + "referenced_ticket": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "notification_group": { + "$ref": "#/components/schemas/group" + } + } + }, + "CommitPolicyResultDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "fw_result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommitTargetResultDTO" + } + }, + "status": { + "$ref": "#/components/schemas/CommitStatusDTO" + }, + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "warning": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Field": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Field type" + } + }, + "required": [ + "type" + ] + }, + "ZoneDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the zone" + }, + "id": { + "type": "string", + "description": "The ID of the zone" + } + } + }, + "ProvisioningStatus": { + "type": "object" + }, + "DeviceResults": { + "type": "object", + "properties": { + "device": { + "$ref": "#/components/schemas/Device" + }, + "new_revision_status": { + "type": "string", + "description": "Revision status" + }, + "policy_suggestions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicySuggestions" + }, + "description": "Policy suggestions" + } + }, + "required": [ + "device", + "new_revision_status", + "policy_suggestions" + ] + }, + "Instruction": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Instruction ID" + }, + "change_type": { + "type": "string", + "description": "Type of instruction change" + }, + "changed_entity": { + "$ref": "#/components/schemas/ChangedEntity" + }, + "relation_changes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelationChange" + }, + "description": "Relation changes" + }, + "customization_type": { + "type": "string", + "description": "Type of customization" + } + }, + "required": [ + "id", + "change_type", + "changed_entity", + "relation_changes" + ] + }, + "SystemResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Result status" + }, + "redesign_status": { + "$ref": "#/components/schemas/RedesignStatusDTO" + }, + "root_device": { + "$ref": "#/components/schemas/RootDevice" + }, + "system_name": { + "type": "string", + "description": "System name" + }, + "href": { + "$ref": "#/components/schemas/LinkDTO" + }, + "system_id": { + "type": "string", + "description": "System ID" + } + }, + "required": [ + "status", + "redesign_status", + "root_device", + "system_name", + "href", + "system_id" + ] + }, + "CommitReportDTO": { + "type": "object", + "properties": { + "endTime": { + "type": "string" + }, + "duration": { + "type": "string" + }, + "vendorName": { + "type": "string" + }, + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommitDeviceResultDTO" + } + }, + "ticketId": { + "type": "integer", + "format": "int64" + }, + "managmentName": { + "type": "string" + }, + "notRunReason": { + "type": "string" + }, + "startTime": { + "type": "string" + } + } + }, + "ResultDetails": { + "type": "object", + "properties": { + "instructions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Instruction" + }, + "description": "Instructions" + }, + "covered_by_fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CoveredByField" + }, + "description": "Covered by fields" + }, + "nat_on_path": { + "type": "boolean", + "description": "Set to true to get the NAT on path" + } + }, + "required": [ + "instructions", + "covered_by_fields", + "nat_on_path" + ] + }, + "Instructions": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ResultDetails" + }, + "status": { + "type": "string", + "description": "Status" + }, + "access_request": { + "$ref": "#/components/schemas/Field" + }, + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "required": [ + "status", + "access_request" + ] + }, + "EmbeddedEntity": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Entity type" + } + }, + "required": [ + "type" + ] + }, + "ProvisioningInstructionDTO": { + "type": "object", + "properties": { + "error_message": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/InstructionStatus" + }, + "instruction_id": { + "type": "string" + } + } + }, + "DeviceProvisioningResultDTO": { + "type": "object", + "properties": { + "device_id": { + "type": "string" + }, + "device_provisioning_status": { + "$ref": "#/components/schemas/DeviceProvisioningStatus" + }, + "provisioning_instruction_status": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProvisioningInstructionDTO" + } + } + } + }, + "ProvisioningResultListDTO": { + "type": "object", + "properties": { + "provisioning_link": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LinkDTO" + }, + "description": "The provisioning result links list" + } + }, + "required": [ + "provisioning_link" + ] + }, + "CommitTargetResultDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "display_name": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/CommitStatusDTO" + }, + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "warning": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "change": { + "type": "object", + "properties": { + "new_value": { + "type": "string" + } + } + }, + "SecurityZoneDTO": { + "type": "object", + "properties": { + "any": { + "type": "boolean", + "description": "The security zone is all" + }, + "zone": { + "$ref": "#/components/schemas/ZoneDTO" + }, + "network_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectDTO" + }, + "description": "The list of network objects " + } + } + }, + "RelationChange": { + "type": "object", + "properties": { + "entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EntityReference" + }, + "description": "Entities" + }, + "relation_change_Type": { + "type": "string", + "description": "Change type" + }, + "relation": { + "type": "string", + "description": "Relation" + }, + "predefined_value": { + "type": "string", + "description": "Predefined value" + }, + "embedded_entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EmbeddedEntity" + }, + "description": "Embedded entities" + } + }, + "required": [ + "entities", + "relation_change_Type", + "relation", + "embedded_entities" + ] + }, + "SystemResultListDTO": { + "type": "object", + "properties": { + "system_result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemResult" + }, + "description": "The system result list" + } + }, + "required": [ + "system_result" + ] + }, + "DesignerCommandsDTO": { + "type": "object", + "properties": { + "command": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AccessRequestDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the access request" + }, + "order": { + "type": "string", + "description": "The order of the access request" + } + } + }, + "Device": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The device name" + }, + "uid": { + "type": "string", + "description": "The device UID" + }, + "v1_id": { + "type": "string", + "description": "The device V1 ID" + } + }, + "required": [ + "name", + "uid", + "v1_id" + ] + }, + "ProvisioningSystemResult": { + "type": "object", + "properties": { + "error_message": { + "type": "string" + }, + "provisioning_status": { + "$ref": "#/components/schemas/ProvisioningStatus" + }, + "device_provisioning_results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceProvisioningResultDTO" + } + }, + "redesigned_after_provisioning": { + "type": "boolean" + }, + "system_id": { + "type": "string" + } + } + }, + "PolicySuggestions": { + "type": "object", + "properties": { + "combined_policy": { + "$ref": "#/components/schemas/CombinedPolicy" + }, + "access_request_instructions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Instructions" + }, + "description": "The access request instructions" + } + }, + "required": [ + "access_request_instructions" + ] + }, + "EntityReference": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name" + }, + "type": { + "type": "string", + "description": "Entity type" + }, + "uid": { + "type": "string", + "description": "UID" + }, + "new_entity_uid": { + "type": "string", + "description": "The new entity UID" + } + }, + "required": [ + "name", + "type" + ] + }, + "Error": { + "type": "object", + "properties": { + "error_code": { + "type": "string", + "description": "Error code" + } + }, + "required": [ + "error_code" + ] + }, + "BasicWorkflowInfoListDTO": { + "type": "object", + "properties": { + "workflow": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BasicWorkflowInfoDTO" + } + } + } + }, + "BasicWorkflowInfoDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "CommitStatusDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "CpType": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "Origin": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "VendorTypeDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "void": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + } + } + }, + "paths": { + "/securechangeworkflow/api/securechange/devices/": { + "get": { + "tags": [ + "SecureChange Devices" + ], + "operationId": "getDevices", + "summary": "Get details of target devices", + "parameters": [ + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "device name or part of a name" + }, + { + "name": "show_targets", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "show_targets true: Returns the details of devices that can be selected as a target in Access Request tickets
show_targets false: Returns the details of devices with objects that can be used in tickets" + } + ], + "responses": { + "404": { + "description": "Devices not found" + }, + "200": { + "description": "Get details of target devices", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/DeviceListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/devices/excluded": { + "get": { + "tags": [ + "SecureChange Devices" + ], + "operationId": "getExcludedDevices", + "summary": "Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange", + "description": "For example on this Panorama hierarchy:\nDG1 - Excluded\n  DG1.1\n    FW1\n    FW2\n    FW3\n\nCalling this API with false value will return only DG1's id.\nCalling this API with true value will return DG1, FW1, FW2, FW3 id's.", + "parameters": [ + { + "name": "show_all", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "When set to true - Displays the specified devices and all their child firewalls in the hierarchy, which will be excluded implicitly.
When set to false - Displays only the devices which were explicitly excluded.
Default value is false.
" + } + ], + "responses": { + "200": { + "description": "Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/DeviceIdsListDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "SecureChange Devices" + ], + "operationId": "putExcludedDevices", + "summary": "Update the whole list of excluded devices in SecureChange", + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeviceIdsListDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Update the whole list of excluded devices in SecureChange" + } + } + } + }, + "/securechangeworkflow/api/securechange/devices/suggest_target": { + "post": { + "tags": [ + "SecureChange Devices" + ], + "operationId": "suggestTarget", + "summary": "Get suggested targets for a given access request", + "description": "Returns a list of suggested targets for a given access request, based on topology calculations.", + "parameters": [ + { + "name": "domain_name", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "Domain Name" + }, + { + "name": "workflow_name", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "Workflow Name" + } + ], + "requestBody": { + "required": false, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/AccessRuleDTO" + } + } + } + }, + "responses": { + "200": { + "description": "Targets returned successfully", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/multi_target" + } + } + } + }, + "400": { + "description": "User does not have permissions to domain or domain does not exist" + }, + "403": { + "description": "Access is denied" + } + } + } + }, + "/securechangeworkflow/api/securechange/queries/": { + "post": { + "tags": [ + "Queries" + ], + "operationId": "createQuery", + "summary": "Create new query", + "description": "The query syntax should follow the rules in: (Free search syntax rules)", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/QueryDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Access is denied" + }, + "400": { + "description": "Invalid filter: <FILTER_NAME> syntax" + } + } + }, + "get": { + "tags": [ + "Queries" + ], + "operationId": "getSavedQueries", + "summary": "Returns the queries details", + "description": "Returns a list of queries saved by the current user.\nReturns only basic information about each query.", + "responses": { + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "200": { + "description": "Returns the queries details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueryDTOList" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/queries/{id}": { + "get": { + "tags": [ + "Queries" + ], + "operationId": "getQuery", + "summary": "Returns the query's details", + "description": "Returns a specific query saved by the current user.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Query ID" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/QueryDTO" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Access is denied" + }, + "400": { + "description": "The query ID does not exist, or you do not have the required permissions" + } + } + }, + "put": { + "tags": [ + "Queries" + ], + "operationId": "updateQuery", + "summary": "Update an existing query", + "description": "The query syntax should follow the rules in: (Free search syntax rules)", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Query ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/QueryDTO" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Access is denied" + }, + "400": { + "description": "Invalid filter: <FILTER_NAME> syntax" + } + } + }, + "delete": { + "tags": [ + "Queries" + ], + "operationId": "deleteQuery", + "summary": "Delete query", + "description": "Delete a query created by the current user", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Query ID" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Access is denied" + }, + "400": { + "description": "The query ID does not exist, or you do not have the required permissions" + } + } + } + }, + "/securechangeworkflow/api/securechange/requests/search": { + "get": { + "tags": [ + "Requests" + ], + "operationId": "searchRequests", + "summary": "Returns the list of requests by search parameters.", + "description": "The API returns both tickets and ticket drafts.\r\nPass an OR value to the logicalOperator parameter to use a logical OR relationship between search parameters. Default value: AND.", + "description": "Returns the status of an ongoing historical event assembly, initiated by calling POST historical_events.\nThe field ?oldest_event_time? shows the last event successfully added to the lifecycle events repository, use this field to track the action's progress.\nEvents are migrated from newest to oldest, within the specified timeframe.", + "responses": { + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Access is denied" + }, + "200": { + "description": "Monitor status of ongoing historical event assembly
", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketEventsCreateHistoryStatusDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/search_by/details": { + "get": { + "tags": [ + "Search" + ], + "operationId": "searchTicketsByDetails", + "summary": "Returns a list of tickets by search parameters", + "description": "If the query is successful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.\nIf the query is successful but there is indexing in progress then the return code will be 206 and the results will hold only the indexed tickets.\nIf you set 'ids_only' to true, the result includes tickets' ID without any other ticket data.\nIf you set 'count' to 0, all tickets found will be returned, which may lead to performance issues.\n\n This API is different version of /securechange/tickets/search API.\n The output format in this version has changed compared to previous version.\n Results containing just one element will now be returned as a single element array rather than an object.", + "parameters": [ + { + "name": "id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "subject", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The subject of the ticket" + }, + { + "name": "requester", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The requester of the ticket" + }, + { + "name": "group", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The group handling the ticket" + }, + { + "name": "assigned_to", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The user name of the person assigned to the ticket" + }, + { + "name": "priority", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The priority of the ticket" + }, + { + "name": "ticket_status", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The status of the ticket" + }, + { + "name": "task_status", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The status of the task" + }, + { + "name": "sla_status", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The SLA status of the ticket" + }, + { + "name": "sla_outcome", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The SLA outcome of the ticket" + }, + { + "name": "sla_tracking_state", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The SLA Tracking State of the ticket" + }, + { + "name": "field_name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Field name to search by" + }, + { + "name": "field_value", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Field value to search by" + }, + { + "name": "current_step", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Current step name" + }, + { + "name": "expiration_date_from", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Search requests with expiration date from this date" + }, + { + "name": "expiration_date_to", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Search requests with expiration date until this date" + }, + { + "name": "domain_name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "The Domain of the ticket" + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Offset the count starting point" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Ticket list length" + }, + { + "name": "ids_only", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Set to true to get only the tickets' ID" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "206": { + "description": "Partial Content" + }, + "403": { + "description": "Access is denied." + }, + "400": { + "description": "Cannot find specified domain <DOMAIN_NAME>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/search_by/free_text": { + "get": { + "tags": [ + "Search" + ], + "operationId": "searchTicketsByFreeText", + "summary": "Returns a list of tickets by free-text query", + "description": "Square brackets ('[' and ']') are not supported for free text searches using an API request. Replace '[' with '%5B' and ']' with '%5D'.\nIncorrect:\nparameter=createdate:[20080120 TO 20090120]\nCorrect:\nparameter=createdate:%5B20080120%20TO%2020090120%5D\nIf you set 'count' to 0, all tickets found will be returned, which may lead to performance issues.\n\n This API is different version of /securechange/tickets/free_text_search API.\nThe output format in this version has changed compared to previous version.\n Results containing just one element will now be returned as a single element array rather than an object.", + "parameters": [ + { + "name": "parameter", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Free text search parameter (Search syntax details)" + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Offset the count starting point" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Tickets list max length" + }, + { + "name": "ids_only", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Set to true to get only the tickets' ID" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "206": { + "description": "Partial Content" + }, + "400": { + "description": "Illegal count value entered. Max value is 1000" + }, + "403": { + "description": "Access is denied." + }, + "404": { + "description": "No entity found for query" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/search_by/group": { + "get": { + "tags": [ + "Search" + ], + "operationId": "showTicketsByGroupId", + "summary": "Returns a list of tickets for a given group", + "description": "If the search is successful but no results are found (for example, If no tickets found for the group), the return code will be 200 and the results will be empty.\nIf the indexing is in progress, then the return code will be 206 and the results will contain only the indexed tickets.\nIf you set 'count' to 0, all tickets found will be returned, which may lead to performance issues.\nIf you set 'ids_only' to true, the result includes tickets' ID without any other ticket data.", + "parameters": [ + { + "name": "group_id", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the Group" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "A limit of the number of tickets to be returned - default value is 1000" + }, + { + "name": "ids_only", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Set to true to get only the tickets' ID" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "206": { + "description": "Partial content due to indexing in progress" + }, + "400": { + "description": "Group ID was not found." + }, + "403": { + "description": "User has no permissions to view group's tickets" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/search_by/query": { + "get": { + "tags": [ + "Search" + ], + "operationId": "searchTicketsByQueryId", + "summary": "Returns a list of tickets by query id for user", + "description": "If the query is successful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.\nIf the query is successful but indexing is in progress then the return code will be 206 and the results will contain only the indexed tickets.\nIf you set 'count' to 0, all tickets found will be returned, which may lead to performance issues.\nIf you set 'ids_only' to true, the result includes tickets' ID without any other ticket data.", + "parameters": [ + { + "name": "query_id", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the query" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "A limit of the number of tickets to be returned - default value is 1000" + }, + { + "name": "ids_only", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Set to true to get only the tickets' ID" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "206": { + "description": "Partial Content" + }, + "400": { + "description": "Query ID was not found." + }, + "403": { + "description": "Access is denied." + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getTicket", + "summary": "Returns the details of a specified ticket", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + }, + { + "name": "showStepsDetails", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Include steps' details in the response" + }, + { + "name": "showTasksFields", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Include tasks' fields in the response" + }, + { + "name": "showApplicationChanges", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Include application changes in the response" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "No entity found for query" + }, + "200": { + "description": "Returns the details of a specified ticket", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/cancel": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "cancelTicket", + "summary": "Cancel a ticket", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the ticket as shown in SecureChange" + }, + { + "name": "requester_id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The user of the ticket's requester, when logged in user is canceling on behalf" + } + ], + "responses": { + "403": { + "description": "Access is denied." + }, + "404": { + "description": "Ticket ID was not found" + }, + "200": { + "description": "Cancel a ticket" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/change_requester/{assigneeId}": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "changeRequesterTicket", + "summary": "Change the requester of the specified ticket task to the specified user.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "assigneeId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The assignee ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CommentDTO" + } + } + } + }, + "responses": { + "400": { + "description": "The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing" + }, + "404": { + "description": "There is no requester (User) with ID." + }, + "200": { + "description": "Change the requester of the specified ticket task to the specified user." + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/confirm": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "confirm", + "summary": "Confirm the request", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "requester_id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The user of the ticket's requester, when logged in user is confirm on behalf" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfirmCommentDTO" + } + } + } + }, + "responses": { + "400": { + "description": "The user can not confirm the ticket, because he is not in the domain of the ticket" + }, + "403": { + "description": "Access is denied." + }, + "404": { + "description": "There is no ticket with ID ." + }, + "200": { + "description": "Confirm the request" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/export": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "exportTicket", + "summary": "Export ticket to a PDF", + "description": "Export ticket to a PDF is not supported for Rule Decommission, Rule Modification, Rule Recertification or Clone network object policy.\nThe name of the downloaded file is returned in the Filename field of the content-disposition header.\nThe file content is returned in the response body.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + } + ], + "responses": { + "200": { + "description": "" + }, + "400": { + "description": "Export to PDF is not available for this workflow type." + }, + "403": { + "description": "You do not have permission to export this ticket. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/history": { + "get": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "getTicketHistory", + "summary": "Returns the history of the specified ticket", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + } + ], + "responses": { + "403": { + "description": "User has no permissions to view ticket history" + }, + "404": { + "description": "There is no ticket with ID." + }, + "200": { + "description": "Returns the history of the specified ticket", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketHistoryListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/map_rules": { + "post": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "mapRules", + "summary": "Map rules to ticket", + "description": "Maps the rules from the ticket to the relevant rules in SecureTrack. \nAdds record set entries to the relevant rules metadata. \nLink to history is found in the returned location header. \nApplicable only for closed tickets in the following workflows: Access Request, Access Request and Modify Group, and Clone Server Policy. \nUse handler_id for running on behalf of another user. \nTo get handler_id, use the System Users API.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the ticket as shown in SecureChange" + }, + { + "name": "handler_id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Run API on behalf of defined user id" + } + ], + "responses": { + "201": { + "description": "Started asynchronous mapping of rules to ticket ID <ID>. Mapping status is displayed in ticket history." + }, + "400": { + "description": "Ticket's workflow type does not support this operation" + }, + "403": { + "description": "On behalf user do not have permission to access ticket <ID>" + }, + "404": { + "description": "There is no handler (User) with ID <ID>." + }, + "412": { + "description": "Ticket is not in closed status" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/pause_sla": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "pauseSLA", + "summary": "Pause SLA for specific ticket", + "description": "When a ticket is in progress and its workflow enables calendar-based SLA, a permitted user can pause its SLA tracking progress.\nPermitted user must have 'Pause SLA' permission and be that ticket's current assignee.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + } + ], + "responses": { + "200": { + "description": "" + }, + "400": { + "description": "SLA is already paused for this ticket" + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/reject": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "rejectTicket", + "summary": "Reject a ticket", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID of the ticket as shown in SecureChange" + }, + { + "name": "handler_id", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The user id, when logged in user is rejecting on behalf" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RejectCommentDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Comment cannot be empty" + }, + "403": { + "description": "Access is denied." + }, + "404": { + "description": "There is no handler (User) with ID <ID>." + }, + "200": { + "description": "Reject a ticket" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/resume_sla": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "resumeSLA", + "summary": "Resume SLA for specific ticket", + "description": "When a ticket's SLA tracking progress is paused, any user who is that ticket's current assignee, can resume the SLA tracking progress.\nTake note that paused SLA tracking progress automatically resumes when the ticket changes its current step.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + } + ], + "responses": { + "200": { + "description": "" + }, + "400": { + "description": "SLA is already running for this ticket" + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getTicketStages", + "summary": "Returns the details of a specified ticket stages", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Ticket ID was not found" + }, + "200": { + "description": "Returns the details of a specified ticket stages", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketStagesListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/current/tasks/{taskId}": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "doneStep_2", + "summary": "Change a task of a ticket at the current step", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Missing revision ID for the device" + }, + "403": { + "description": "Task can not be done because there are unlicensed devices for change automation" + }, + "406": { + "description": "Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP" + }, + "200": { + "description": "Change a task of a ticket at the current step" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/current/tasks/{taskId}/fields": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "updateFieldList_2", + "summary": "Change multiple field within a task of a ticket in the current step", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskFieldListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Missing revision ID for the device" + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "406": { + "description": "Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP" + }, + "200": { + "description": "Change multiple field within a task of a ticket in the current step" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/current/tasks/{taskId}/fields/{fieldId}": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "updateField", + "summary": "Change a field within a task of a ticket at the current step", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskFieldDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Missing revision ID for the device" + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "406": { + "description": "Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP" + }, + "200": { + "description": "Change a field within a task of a ticket at the current step" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getTicketStageById", + "summary": "Returns the details of a specified ticket stages", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the step as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Stage ID was not found in ticket ID." + }, + "200": { + "description": "Returns the details of a specified ticket stages", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketStageDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getStageTasks", + "summary": "Returns the details of the tasks", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the step as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Stage ID was not found in ticket ID." + }, + "200": { + "description": "Returns the details of the tasks", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "doneStep", + "summary": "Change a task of a ticket", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Missing revision ID for the device" + }, + "403": { + "description": "Task can not be done because there are unlicensed devices for change automation" + }, + "406": { + "description": "Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP" + }, + "200": { + "description": "Change a task of a ticket" + } + } + }, + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getStageTaskById", + "summary": "Returns the details of a specified task", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the step as shown in SecureChange" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the task as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Task with ID was not found in Stage ID in ticket ID ." + }, + "200": { + "description": "Returns the details of a specified task", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/accept": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "acceptTaskSelfAssign", + "summary": "Accept task API", + "description": "When a task is on self assignment mode awaiting assignment, any participant user can use this API to assign it to themselves", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "responses": { + "200": { + "description": "" + }, + "400": { + "description": "You can only update the current step of the ticket. Step ID <ID> does not match the current step ID <ID>." + }, + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Task with ID was not found in Stage ID in ticket ID ." + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/clone_server_policy/verifier": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getServerCloneVerifierResults", + "summary": "Get server clone policy verifier results", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "responses": { + "404": { + "description": "Verifier results were not found in the server clone policy request." + }, + "200": { + "description": "Get server clone policy verifier results", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/clone_server_policy_verifer_result_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getTaskFields", + "summary": "Returns the details of a the fields", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the step as shown in SecureChange" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the task as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Task with ID was not found in Stage ID in ticket ID ." + }, + "200": { + "description": "Returns the details of a the fields", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskFieldListDTO" + } + } + } + } + } + }, + "put": { + "tags": [ + "Tickets" + ], + "operationId": "updateFieldList", + "summary": "Change multiple fields within a task of a ticket", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskFieldListDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Missing revision ID for the device" + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "406": { + "description": "Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP" + }, + "200": { + "description": "Change multiple fields within a task of a ticket" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "updateField_2", + "summary": "Change a field within a task of a ticket", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskFieldDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Missing revision ID for the device" + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "406": { + "description": "Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP" + }, + "200": { + "description": "Change a field within a task of a ticket" + } + } + }, + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getTaskFieldById", + "summary": "Returns the details of a specified field", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the step as shown in SecureChange" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the task as shown in SecureChange" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the field as shown in SecureChange" + }, + { + "name": "expand_links", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "See expanded view of the objects" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "404": { + "description": "Field ID was not found in Task ID in Stage ID in ticket ID ." + }, + "200": { + "description": "Returns the details of a specified field", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketTaskFieldDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getFieldDesignerResults", + "summary": "Get designer results according to field id", + "description": "Use this API to retrieve designer results generated in R17-2 and later.\nRedesign status field will only appear for the current step.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "404": { + "description": "Designer results were not found in the request." + }, + "200": { + "description": "Get designer results according to field id", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/access_request_designer_result_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer/commit_report/{managementId}": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getCommitResults", + "summary": "Returns the results of the Commit action", + "description": "GENERAL USE\nThe report returns the Commit results for the device with the specified management ID and for the devices suggested in the Designer results. The report also includes results for devices that are in the related hierarchy of these devices.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "managementId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Management ID" + } + ], + "responses": { + "404": { + "description": "Designer results were not found in the request." + }, + "200": { + "description": "Returns the results of the Commit action", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CommitReportDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer/device/{deviceId}/commands": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getDeviceCommandsFromFieldDesignerResults", + "summary": "Get commands for device from designer results of a specific field id", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "deviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Device ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "404": { + "description": "Device with ID <ID> does not support Commands feature." + }, + "200": { + "description": "Get commands for device from designer results of a specific field id", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/DesignerCommandsDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer/device/{deviceId}/commit": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "commitDevice", + "summary": "Commit policy changes", + "description": "Create an asynchronous task to commit policy changes to all the devices managed by the specified management device.\nOnce the Commit task is created, the task status changes to pending and becomes locked for editing until the task completes.\nUse the API function link in the response location header to check the status of the task.\nOnce the task is complete, the results become available.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "deviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Device ID" + } + ], + "responses": { + "202": { + "description": "Commit task has been created." + }, + "400": { + "description": "Commit is not supported for device ID <ID>." + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer/device/{deviceId}/update": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "updateDevice", + "summary": "Update the device with designer suggestions", + "description": "Create an asynchronous task to update Designer suggestions to the specified device. \nOnce the Update Device task is created, the status of the task changes to pending and it becomes locked for editing until the update completes. \nThe response location header has a link to an API function which you can use to check the status of the task. \nOnce the Update Device task is complete, the results become available and are recorded in the ticket's history.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "deviceId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Device ID" + }, + { + "name": "force", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Force update device even if the policy on the device has already been modified" + } + ], + "responses": { + "202": { + "description": "Update device task has been created." + }, + "400": { + "description": "Provisioning is not supported for device ID <ID>." + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer/device/{managementId}": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getDesignerResultsByDeviceId", + "summary": "Get designer results according to field id and device id", + "description": "Use this API to retrieve designer results per specific device.\nRedesign status field will only appear for the current step.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "managementId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Device ID" + } + ], + "responses": { + "404": { + "description": "Device with ID <ID> was not found in designer result." + }, + "200": { + "description": "Get designer results according to field id and device id", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/access_request_designer_result_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/designer/redesign": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "redesign", + "summary": "Redesign", + "description": "Create an asynchronous task to redesign.\nOnce the Redesign task is created, the status of the task changes to pending and it becomes locked for editing until the redesign completes.\nThe response location header has a link to an API function which you can use to check the status of the task.\nOnce the Redesign task is complete, the results become available.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "202": { + "description": "Redesign task has been created." + }, + "400": { + "description": "Redesign will not be run because it is not needed." + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_designer": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getSystemResults", + "summary": "Get OPM designer results according to ticket id and field id", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "400": { + "description": "The field with id <ID> does not exist on ticket with id <ID>." + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "You do not have permission to remove this comment. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with id: <ID>." + }, + "200": { + "description": "Get OPM designer results according to ticket id and field id", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/SystemResultListDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_designer/systems/{systemId}": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getDesignerResultPerSystem", + "summary": "Get OPM designer results per system according to ticket id, field id and system id", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "systemId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "System ID" + }, + { + "name": "devices_count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Maximum number of devices to be returned in the system result" + }, + { + "name": "devices_offset", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "A number indicating the distance from the first device record in the data set" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/DesignerResults" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "You do not have permission to access ticket <ID>." + }, + "404": { + "description": "Specified field, id: <ID> , name: <NAME>, cannot contain designer result" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_designer/systems/{systemId}/replace_instructions": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "replaceOpmDesignerInstructions", + "summary": "Replace OPM Designer instructions for a system", + "description": "GENERAL USE\n1. Use the API '/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_designer/systems/{systemId}' to retrieve the designer results.\n2. Run this API to modify the required instructions.\n\nGENERAL NOTES\na. All instruction properties may be modified except the instruction ID, which is immutable.\nb. Each request may contain one or more instructions; each instruction represents a single change operation (ADD, MODIFY, DELETE).\nc. All referenced UIDs must already exist in the system.\nd. All network related values: IP addresses, object types, service definitions and protocols, must be valid and logically correct from a networking perspective.\n\n\nInstruction object notes:\na. The id field is mandatory and uniquely identifies the instruction and cannot be modified.\nb. The change_type defines the type of action and must be one of the permitted values (ADD, MODIFY, DELETE).\nc. The changed_entity object must always be included and defines the specific object being modified or created.\nd. The relation_changes list must be present, and defines how entity relations will be updated.\n\nChangedEntity notes:\na. The type field is required and determines which entity subtype must be used (HOST, SUBNET, IP_RANGE, SERVICE types, RULE, etc.).\nb. The uid is optional and used when modifying existing entities.\nc. The new_entity_uid is optional and used when the system assigns a new UID.\nd. The name is optional.\ne. Additional required fields depend on the entity subtype (Host, Subnet, IP Range, Rule, Transport Service).\n\nChangedEntity subtype requirements:\na. Host: ip_type and ip are required.\nb. Subnet: ip_type and ip are required, and one of netmask or cidr.\nc. IP Range: ip_type, min_ip, and max_ip are required.\nd. IP Service: min_protocol and max_protocol required.\ne. ICMP Service: min_icmp_type and max_icmp_type required.\nf. Transport Service: min_port, max_port, and protocol are required.\ng. Rule: In case of a new rule, only the location field is required; the comment is optional.\n\nRelationChange notes:\na. The relation_change_type is required and defines the type of change applied (ADD, MODIFY, DELETE).\nb. The relation field is required and identifies the relation being updated (SOURCE, DESTINATION, SERVICE, MEMBER, SRC_ZONE, DST_ZONE).\nc. The predefined_value is optional and used to set special values like ANY.\nd. Both entities and embedded_entities must be present in the request (can be empty lists).\n\nEntityReference notes:\na. The type and name fields are required to reference an existing entity.\nb. One of the following must exist: uid or new_entity_uid.\nc. The name field remains required for identifying the referenced entity.\n\nRuleLocation notes:\na. The placement field is required and determines rule positioning (BEFORE, AFTER, LAST).\nb. The other_rule_uid or other_rule_identifier may be used when placement is BEFORE or AFTER another rule.\n\nEmbeddedEntity notes:\na. Embedded entities contain full object definitions used inside relation changes.\nb. Each embedded entity requires a type and additional fields based on subtype.\n\nEmbedded entity subtype requirements:\na. Host: ip_type and ip are required.\nb. Subnet: ip_type and ip are required, and one of netmask or cidr.\nc. IP Range: ip_type, min_ip, and max_ip required.\nd. Transport Service: min_port, max_port, and protocol required.\ne. IP Service: min_protocol and max_protocol required.\nf. ICMP Service: min_icmp_type and max_icmp_type required.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "systemId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "System ID" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ReplaceInstructionResult" + } + } + } + }, + "400": { + "description": "Rule location is missing for new rule <RULE_IDENTIFIER>" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Customization is not allowed while provisioning is running" + }, + "404": { + "description": "Device result not found for instruction <INSTRUCTION_ID>" + }, + "500": { + "description": "Internal database failure." + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_designer/systems/{systemId}/update": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "updateOpmDevice", + "summary": "Update the opm device with designer suggestions", + "description": "Create an asynchronous task to update Designer suggestions to the specified opm device. \nOnce the Update Device task is created, the status of the task changes to pending and it becomes locked for editing until the update completes. \nThe response location header has a link to an API function which you can use to check the status of the task. \nOnce the Update Device task is complete, the results become available and are recorded in the ticket's history.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "systemId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "System ID" + }, + { + "name": "force", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Force update system even if the policy on the system has already been modified" + } + ], + "responses": { + "202": { + "description": "Update system task has been created." + }, + "400": { + "description": "system <ID> is not eligible for provisioning." + }, + "403": { + "description": "You do not have permission to update this task. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with ID <ID>" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_provisioning": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getProvisioningResults", + "summary": "Get OPM provisioning results according to ticket id and field id", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ProvisioningResultListDTO" + } + } + } + }, + "400": { + "description": "The field with id <ID> does not exist on ticket with id <ID>." + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "You do not have permission to access ticket <ID>." + }, + "404": { + "description": "Specified field, id: <ID> , name: <NAME>, cannot contain designer result" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_provisioning/systems/{systemId}": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getProvisioningResultPerSystem", + "summary": "Get OPM provisioning results per system according to ticket id, field id and system id", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + }, + { + "name": "systemId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "System result ID" + }, + { + "name": "devices_count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Maximum number of devices to be returned in the system result" + }, + { + "name": "devices_offset", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "A number indicating the distance from the first device record in the data set" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ProvisioningSystemResult" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "You do not have permission to access ticket <ID>." + }, + "404": { + "description": "Specified system, id: <ID>, cannot contain provisioning result" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/related_rules": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getRelatedRules", + "summary": "Get related rules according to field id", + "description": "Use this API to retrieve rules related to the traffic specified by the Access Request fields in the ticket.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "403": { + "description": "You do not have permission to view related rules. Contact your administrator for assistance." + }, + "404": { + "description": "Field ID <ID> was not found in Task ID <ID> in Stage ID <ID> in ticket ID <ID>" + }, + "200": { + "description": "Get related rules according to field id", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/related_rules_related_rules_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/security_zones": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getSecurityZones", + "summary": "Get security zones according to field id", + "description": "Use this API to retrieve security zones for multi access result field", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Field ID" + } + ], + "responses": { + "404": { + "description": "There is no ticket with ID <ID>." + }, + "401": { + "description": "Cannot update ticket because it is either closed, rejected or waiting for requester confirmation" + }, + "400": { + "description": "Security zones tool is not enabled for the requested field." + }, + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance." + }, + "200": { + "description": "Get security zones according to field id", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/AccessRequestsSecurityZonesDTO" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/multi_access_request/{fieldId}/verifier": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getARVerifierResults", + "summary": "Get access request verifier results", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Request ID" + } + ], + "responses": { + "404": { + "description": "Verifier results were not found in the access request." + }, + "200": { + "description": "Get access request verifier results", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/access_request_verifer_result_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/multi_access_request/{fieldId}/verifier/topology_map": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getARVerifierResultsTopologyMap", + "summary": "Returns topology map image (png file) for specific verifier results", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "fieldId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Request ID" + } + ], + "responses": { + "404": { + "description": "Topology map was not found for this field." + }, + "200": { + "description": "Returns topology map image (png file) for specific verifier results" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/reassign/{assigneeId}": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "reassignTicketTask", + "summary": "Reassigns the specified ticket task to the specified user.", + "description": "Values can only be updated for the current step.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "assigneeId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The assignee ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReassignTaskCommentDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Task <NAME> is no longer active" + }, + "404": { + "description": "No entity found for query" + }, + "200": { + "description": "Reassigns the specified ticket task to the specified user." + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/redo/{toStepId}": { + "put": { + "tags": [ + "Ticket Lifecycle" + ], + "operationId": "redoTicketStep", + "summary": "Returns the specified ticket to the specified step", + "description": "Values can only be updated for the current step.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "toStepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "To which step we the ticket will return" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RedoStepCommentDTO" + } + } + } + }, + "responses": { + "400": { + "description": "Task <NAME> is no longer active" + }, + "403": { + "description": "User has no permissions to redo ticket steps." + }, + "404": { + "description": "No entity found for query" + }, + "200": { + "description": "Returns the specified ticket to the specified step" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/rule_decommission/verifier": { + "get": { + "tags": [ + "Tickets" + ], + "operationId": "getRdVerifierResults", + "summary": "Get rule decommision verifier results", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "responses": { + "404": { + "description": "Verifier results were not found in the request." + }, + "200": { + "description": "Get rule decommision verifier results", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/rule_decommission_verifier_result_expanded" + } + } + } + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/tasks/{taskId}/designer/instruction/{instructionId}": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "updateInstruction", + "summary": "Modify the Designer suggestions for Access Request, Clone Server Policy, Decommission Network Object Request or Rule Decommission", + "description": "GENERAL USE\n1. Create a ticket using UI/API.\n2. Run the designer using UI/API.\n3. Use relevent API to get the designer results.\n4. Run this API to modify the required parameters.\n\n*Note: you can modify one parameter at a time.\n\n Change rule location use\na. Modifying the rule order places the new rule before the rule with the specified identifier (rule name or number).\nb. Modifying the rule placement to \"last\" places the new rule as last rule or last pre-rule (depending on the vendor convention for the device).\nc. For vendors that support \"after\" placement, modifying the rule placement allows positioning the new rule before or after the suggested rule location.\nd. For Check Point R80 and above releases, the indented rule numbering format can be applied to globally assigned policies (for example, \"rule_order\": \"4.5\").\n\ntrack level permitted values:\nNONE, LOG, ACCOUNT, ALERT, SNMP, MAIL, USER_DEFINED, EMERGENCIES, ALERTS, CRITICAL, ERRORS, WARNINGS, NOTIFICATIONS, INFORMATIONAL, DEBUGGING, DISABLED, DEFAULT, FULL_LOG, NETWORK_LOG, USER_ALERT_1, USER_ALERT_2, USER_ALERT_3 \n\nrule placement permitted values:\nBEFORE, AFTER, LAST", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + }, + { + "name": "instructionId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Instruction ID" + }, + { + "name": "force", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "force update when new revision available" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/change" + } + } + } + }, + "responses": { + "200": { + "description": "New rule will be shadowed or break acceleration" + }, + "400": { + "description": "AppliedTo list is longer than 20 items." + }, + "412": { + "description": "Current step does not support Designer modification action" + }, + "404": { + "description": "The log forwarding profile <LOG FORWARDING PROFILE> was not found." + }, + "403": { + "description": "New revision is available, cannot modify the Designer results" + }, + "409": { + "description": "Object already exists" + }, + "503": { + "description": "Not connected to SecureTrack." + }, + "500": { + "description": "An error occurred in SecureTrack while trying to validate the log forwarding profile." + }, + "406": { + "description": "Invalid UIDs: [<SECURITY GROUP UID>, <SECURITY GROUP UID>]" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{id}/ticket_properties": { + "put": { + "tags": [ + "Tickets" + ], + "operationId": "updateTicketProperties", + "summary": "Change the ticket properties", + "description": "Change the ticket properties listed in the TicketPropertiesDTO. \nWhen specifying the priority property you must use Critical/High/Normal/Low. \nWhen specifying the notification_group property you must use the ID of the group or leave the ID empty to remove the group. This property can be updated on a closed ticket.\nWhen specifying the referenced_ticket property you must use the ID of the ticket or leave the ID empty to remove the ticket.\nWhen specifying the expiration_date property, you must use a yyyy-mm-dd format, or leave the value empty to remove the expiration date. To ignore the field, do not include it in the request. This property can be updated on a closed ticket.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "The ID number of the ticket as shown in SecureChange" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketPropertiesDTO" + } + } + } + }, + "responses": { + "400": { + "description": "This workflow does not support expiration dates" + }, + "403": { + "description": "The user is not allowed to add the specified referenced ticket." + }, + "404": { + "description": "There is no ticket with ID <ID>." + }, + "406": { + "description": "Invalid format detected: priority - Permitted values are: Critical, High, Normal, Low" + }, + "200": { + "description": "Change the ticket properties" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{ticketId}/comments/{commentId}": { + "delete": { + "tags": [ + "Tickets" + ], + "operationId": "deleteComment", + "summary": "Delete a comment from a ticket", + "parameters": [ + { + "name": "ticketId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "commentId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Comment ID" + } + ], + "responses": { + "400": { + "description": "The comment with id <ID> cannot be deleted because it is a SYSTEM comment (only USER comments can be deleted)" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "You do not have permission to remove this comment. Contact your administrator for assistance." + }, + "404": { + "description": "There is no ticket with id: <ID>." + }, + "200": { + "description": "Delete a comment from a ticket" + } + } + } + }, + "/securechangeworkflow/api/securechange/tickets/{ticketId}/steps/{stepId}/tasks/{taskId}/comments": { + "post": { + "tags": [ + "Tickets" + ], + "operationId": "addComment", + "summary": "Add a new comment to a ticket", + "description": "The comment may include attached files which are identified by their uid Identifier.Returns the ID of the comment that was added.", + "parameters": [ + { + "name": "ticketId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Ticket ID" + }, + { + "name": "stepId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Step ID" + }, + { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task ID" + } + ], + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TicketCommentDTO" + } + } + } + }, + "responses": { + "201": { + "description": "Comment was created." + }, + "400": { + "description": "You do not have access to this attachment: <UID>" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "You do not have permission to view this task. Contact your administrator for assistance" + }, + "404": { + "description": "Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>." + }, + "406": { + "description": "Invalid format detected:\nattachments - Attachments list is longer than 10 items" + } + } + } + }, + "/securechangeworkflow/api/securechange/workflows/active_workflows": { + "get": { + "tags": [ + "Workflows" + ], + "operationId": "getActiveWorkflowsByType", + "summary": "returns a list of the active workflows in securechange", + "description": "The workflow types to filter by are defined as follows : \nGENERICGeneric WorkflowACCESS_REQUEST_AND_MODIFY_GROUPAccess Request & Modify GroupACCESS_REQUESTAccess RequestMODIFY_GROUPModify GroupDECOMMISSION_NETWORK_OBJECTDecommission network objectRULE_DECOMMISSIONRule DecomissionRULE_RECERTIFICATIONRule RecertificationCLONE_NETWORK_OBJECT_POLICYClone network object PolicyRULE_MODIFICATIONRule Modification", + "parameters": [ + { + "name": "type", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Type of the workflow to filter by" + } + ], + "responses": { + "403": { + "description": "Access is denied" + }, + "400": { + "description": "<TYPE> is not a valid workflow type" + }, + "200": { + "description": "returns a list of the active workflows in securechange", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BasicWorkflowInfoListDTO" + } + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/Tufin/SecureChange/README.md b/Tufin/SecureChange/README.md new file mode 100644 index 0000000..a33dab7 --- /dev/null +++ b/Tufin/SecureChange/README.md @@ -0,0 +1,78 @@ +# Tufin SecureChange + +Tufin SecureChange is the network security change automation and workflow component of the Tufin Orchestration Suite. It manages the full lifecycle of firewall/network change tickets — submission, multi-step approval and design tasks, rule mapping, and closure — through a REST API authenticated with HTTP Basic auth against a Tufin user account. + +## Table of Contents + +- [Contents](#contents) +- [Requirements](#requirements) +- [Integration Configuration](#integration-configuration) +- [OpenAPIs](#openapis) + - [`tufin_securechange-latest.json`](#tufin_securechange-latestjson) + - [`tufin_securechange-25.2.json`](#tufin_securechange-252json) +- [Studio Projects](#studio-projects) + - [Tufin SecureChange Project](#tufin-securechange-project) + +## Contents + +| Asset | Description | +|---|---| +| [OpenAPIs/](./OpenAPIs/) | SecureChange REST API OpenAPI specs — curated `-latest` plus the full dated spec | +| [Studio Projects/](./Studio%20Projects/) | Itential Platform project containing all 70 curated workflows in 7 folders | + +## Requirements + +| Requirement | Version | +|---|---| +| Itential Platform | P6+ | +| Tufin SecureChange | R25-2 (25.2) | +| `Tufin SecureChange:latest` Integration Model | Import from `OpenAPIs/tufin_securechange-latest.json` | + +## Integration Configuration + +Create an Itential Platform integration instance from the `Tufin SecureChange:latest` Integration Model, authenticated with a Tufin user's HTTP Basic credentials, pointed at your SecureChange management server (`https:///securechangeworkflow/api`). The Studio Project's workflows are wired to an integration instance named **`Tufin SecureChange`** via `adapter_id` — if your instance uses a different name, update `adapter_id` in each workflow task after importing. + +## OpenAPIs + +| Spec | Version | Operations | Description | +|---|---|---|---| +| [`tufin_securechange-latest.json`](./OpenAPIs/tufin_securechange-latest.json) | latest (curated) | 70 | Trimmed from the full 101-operation upstream spec — see breakdown below | +| [`tufin_securechange-25.2.json`](./OpenAPIs/tufin_securechange-25.2.json) | 25.2 | 101 | Full spec for SecureChange R25-2 (101 operations) | + +### `tufin_securechange-latest.json` + +Actively-maintained spec (`x-vendor-api-version: 25.2`). Trimmed from the full 101-operation upstream spec down to 70 operations covering common automation CRUD. + +Resources included, by category: + +- **Tickets**: ticket submission, read, export, and step/task/field read and update +- **Ticket Lifecycle**: confirm/reject/cancel a ticket, reassign/redo a task, designer commit/update actions, rule mapping, ticket history +- **Search**: non-deprecated ticket search by details, free text, group, or saved query +- **Queries**: saved-query CRUD +- **Requests**: request search and cancel +- **SecureChange Devices**: target device lookup and suggestion for access requests +- **Workflows**: active workflow listing + +Excluded as deprecated, deep admin/config plumbing, or niche: the deprecated free-text/parameter ticket search endpoints, system users, system configuration, roles, triggers, domains, attachments, change audit, extensions, external provider integration, rule recertification, and network object decommissioning. + +### `tufin_securechange-25.2.json` + +Full spec for SecureChange R25-2 (101 operations) — the vendor's complete published API surface, converted from its native Swagger 1.2 documentation format to OpenAPI 3.0. See `tufin_securechange-latest.json` above for the curated subset if you just need common CRUD automation. + +## Studio Projects + +### Tufin SecureChange Project + +Backed by the **Tufin SecureChange** REST API via the `Tufin SecureChange:latest` Integration Model. The project contains **70 workflows** — one atomic workflow per curated operation — organized into **7 folders** matching the OpenAPI resource categories above. + +| Folder | Workflows | +|---|---| +| Tickets | 39 | +| Ticket Lifecycle | 15 | +| Search | 4 | +| SecureChange Devices | 4 | +| Queries | 5 | +| Requests | 2 | +| Workflows | 1 | + +Each workflow accepts a JSON object of the source operation's path/query parameters (and, for write operations, a `spec` object holding the request body) when run manually or called as a child workflow, and returns the full HTTP response envelope (`{ok, url, status, headers, text, body}`) from the adapter task. diff --git a/Tufin/SecureChange/Studio Projects/Tufin SecureChange.project.json b/Tufin/SecureChange/Studio Projects/Tufin SecureChange.project.json new file mode 100644 index 0000000..d3e4d55 --- /dev/null +++ b/Tufin/SecureChange/Studio Projects/Tufin SecureChange.project.json @@ -0,0 +1,8412 @@ +{ + "_id": "88212851afb14a2b9e445666", + "name": "Tufin SecureChange", + "description": "Ticket creation, lookup, search, full lifecycle actions (confirm/reject/cancel/reassign/redo), step/task/field handling, saved query CRUD, and workflow/request automation against Tufin SecureChange.", + "components": [ + { + "iid": 0, + "reference": "271dae3b-3313-4471-af32-047b9b6012fa", + "type": "workflow", + "folder": "/Queries", + "document": { + "name": "Returns the queries details", + "description": "Returns a list of queries saved by the current user.\nReturns only basic information about each query.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1": { + "name": "getSavedQueries", + "canvasName": "getSavedQueries", + "summary": "Returns the queries details", + "description": "Returns a list of queries saved by the current user.\nReturns only basic information about each query.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1": { + "type": "standard", + "state": "success" + } + }, + "1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": {} + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 1, + "reference": "805db9aa-52dd-4562-b09f-0c1fe7a20f4d", + "type": "workflow", + "folder": "/Queries", + "document": { + "name": "Create new query", + "description": "The query syntax should follow the rules in: (Free search syntax rules)", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2": { + "name": "createQuery", + "canvasName": "createQuery", + "summary": "Create new query", + "description": "The query syntax should follow the rules in: (Free search syntax rules)", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2": { + "type": "standard", + "state": "success" + } + }, + "2": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 2, + "reference": "9666f860-0501-491b-b556-f83477c0f8d3", + "type": "workflow", + "folder": "/Queries", + "document": { + "name": "Delete query", + "description": "Delete a query created by the current user", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "3": { + "name": "deleteQuery", + "canvasName": "deleteQuery", + "summary": "Delete query", + "description": "Delete a query created by the current user", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "3": { + "type": "standard", + "state": "success" + } + }, + "3": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Query ID" + } + }, + "required": [ + "id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 3, + "reference": "90ade7f3-4597-4f9d-8349-e9ee6a49f09c", + "type": "workflow", + "folder": "/Queries", + "document": { + "name": "Returns the query's details", + "description": "Returns a specific query saved by the current user.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "4": { + "name": "getQuery", + "canvasName": "getQuery", + "summary": "Returns the query's details", + "description": "Returns a specific query saved by the current user.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "4": { + "type": "standard", + "state": "success" + } + }, + "4": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Query ID" + } + }, + "required": [ + "id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 4, + "reference": "bc508880-593c-41dc-9262-348c266c58db", + "type": "workflow", + "folder": "/Queries", + "document": { + "name": "Update an existing query", + "description": "The query syntax should follow the rules in: (Free search syntax rules)", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "5": { + "name": "updateQuery", + "canvasName": "updateQuery", + "summary": "Update an existing query", + "description": "The query syntax should follow the rules in: (Free search syntax rules)", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "5": { + "type": "standard", + "state": "success" + } + }, + "5": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Query ID" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 5, + "reference": "3ec6ad41-39da-4eb0-85da-00fa2f692bd2", + "type": "workflow", + "folder": "/Requests", + "document": { + "name": "Returns the list of requests by search parameters.", + "description": "The API returns both tickets and ticket drafts.\r\nPass an OR value to the logicalOperator parameter to use a logical OR relationship between search parameters. Default value: AND.(Search syntax details)" + }, + "start": { + "type": "integer", + "description": "Offset the count starting point" + }, + "count": { + "type": "integer", + "description": "Tickets list max length" + }, + "ids_only": { + "type": "boolean", + "description": "Set to true to get only the tickets' ID" + } + } + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 9, + "reference": "326ad0f8-0afe-424b-a9af-d20fd77d08d9", + "type": "workflow", + "folder": "/Search", + "document": { + "name": "Returns a list of tickets for a given group", + "description": "If the search is successful but no results are found (for example, If no tickets found for the group), the return code will be 200 and the results will be empty.\nIf the indexing is in progress, then the return code will be 206 and the results will contain only the indexed tickets.\nIf you set 'count' to 0, all tickets found will be returned, which may lead to performance issues.\nIf you set 'ids_only' to true, the result includes tickets' ID without any other ticket data.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a": { + "name": "showTicketsByGroupId", + "canvasName": "showTicketsByGroupId", + "summary": "Returns a list of tickets for a given group", + "description": "If the search is successful but no results are found (for example, If no tickets found for the group), the return code will be 200 and the results will be empty.\nIf the indexing is in progress, then the return code will be 206 and the results will contain only the indexed tickets.\nIf you set 'count' to 0, all tickets found will be returned, which may lead to performance issues.\nIf you set 'ids_only' to true, the result includes tickets' ID without any other ticket data.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "group_id": "$var.job.group_id", + "count": "$var.job.count", + "ids_only": "$var.job.ids_only" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a": { + "type": "standard", + "state": "success" + } + }, + "a": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "group_id": { + "type": "integer", + "description": "The ID of the Group" + }, + "count": { + "type": "integer", + "description": "A limit of the number of tickets to be returned - default value is 1000" + }, + "ids_only": { + "type": "boolean", + "description": "Set to true to get only the tickets' ID" + } + }, + "required": [ + "group_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 10, + "reference": "e310a0b9-6069-4f93-b14c-eeacc665c234", + "type": "workflow", + "folder": "/Search", + "document": { + "name": "Returns a list of tickets by query id for user", + "description": "If the query is successful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.\nIf the query is successful but indexing is in progress then the return code will be 206 and the results will contain only the indexed tickets.\nIf you set 'count' to 0, all tickets found will be returned, which may lead to performance issues.\nIf you set 'ids_only' to true, the result includes tickets' ID without any ot", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "b": { + "name": "searchTicketsByQueryId", + "canvasName": "searchTicketsByQueryId", + "summary": "Returns a list of tickets by query id for user", + "description": "If the query is successful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.\nIf the query is successful but indexing is in progress then the return code will be 206 and the results will contain only the indexed tickets.\nIf you set 'count' to 0, all tickets found will be returned, which may lead to performance issues.\nIf you set 'ids_only' to true, the result includes tickets' ID without any other ticket data.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "query_id": "$var.job.query_id", + "count": "$var.job.count", + "ids_only": "$var.job.ids_only" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "b": { + "type": "standard", + "state": "success" + } + }, + "b": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "query_id": { + "type": "integer", + "description": "The ID of the query" + }, + "count": { + "type": "integer", + "description": "A limit of the number of tickets to be returned - default value is 1000" + }, + "ids_only": { + "type": "boolean", + "description": "Set to true to get only the tickets' ID" + } + }, + "required": [ + "query_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 11, + "reference": "750f37dd-ca08-4c4c-91d5-ab50134d8d13", + "type": "workflow", + "folder": "/SecureChange Devices", + "document": { + "name": "Get details of target devices", + "description": "Get details of target devices", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "c": { + "name": "getDevices", + "canvasName": "getDevices", + "summary": "Get details of target devices", + "description": "Get details of target devices", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "name": "$var.job.name", + "show_targets": "$var.job.show_targets" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "c": { + "type": "standard", + "state": "success" + } + }, + "c": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "device name or part of a name" + }, + "show_targets": { + "type": "boolean", + "description": "show_targets true: Returns the details of devices that can be selected as a target in Access Request tickets
show_targets false: Returns the details of devices with objects that can be used in tickets" + } + } + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 12, + "reference": "cc26d144-5c4e-4444-9d47-0c367e998c27", + "type": "workflow", + "folder": "/SecureChange Devices", + "document": { + "name": "getExcludedDevices", + "description": "For example on this Panorama hierarchy:\nDG1 - Excluded\n  DG1.1\n    FW1\n    FW2\n    FW3\n\nCalling this API with false value will return only DG1's id.\nCalling this API with true value will return DG1, FW1, FW2, FW3 id's.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "d": { + "name": "getExcludedDevices", + "canvasName": "getExcludedDevices", + "summary": "Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange", + "description": "For example on this Panorama hierarchy:\nDG1 - Excluded\n  DG1.1\n    FW1\n    FW2\n    FW3\n\nCalling this API with false value will return only DG1's id.\nCalling this API with true value will return DG1, FW1, FW2, FW3 id's.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "show_all": "$var.job.show_all" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "d": { + "type": "standard", + "state": "success" + } + }, + "d": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "show_all": { + "type": "boolean", + "description": "When set to true - Displays the specified devices and all their child firewalls in the hierarchy, which will be excluded implicitly.
When set to false - Displays only the devices which were explicitly excluded.
Default value is false.
" + } + } + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 13, + "reference": "e52db586-083e-4b78-967f-c3d67df839a7", + "type": "workflow", + "folder": "/SecureChange Devices", + "document": { + "name": "Update the whole list of excluded devices in SecureChange", + "description": "Update the whole list of excluded devices in SecureChange", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "e": { + "name": "putExcludedDevices", + "canvasName": "putExcludedDevices", + "summary": "Update the whole list of excluded devices in SecureChange", + "description": "Update the whole list of excluded devices in SecureChange", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "e": { + "type": "standard", + "state": "success" + } + }, + "e": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "type": "object", + "description": "Request body payload." + } + } + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 14, + "reference": "6a033053-e0df-43fb-b8f4-30bdba01f240", + "type": "workflow", + "folder": "/SecureChange Devices", + "document": { + "name": "Get suggested targets for a given access request", + "description": "Returns a list of suggested targets for a given access request, based on topology calculations.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "f": { + "name": "suggestTarget", + "canvasName": "suggestTarget", + "summary": "Get suggested targets for a given access request", + "description": "Returns a list of suggested targets for a given access request, based on topology calculations.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "domain_name": "$var.job.domain_name", + "workflow_name": "$var.job.workflow_name", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "f": { + "type": "standard", + "state": "success" + } + }, + "f": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "domain_name": { + "type": "string", + "description": "Domain Name" + }, + "workflow_name": { + "type": "string", + "description": "Workflow Name" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "domain_name", + "workflow_name" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 15, + "reference": "7996969f-2d67-4e9f-9904-78d00271bbe7", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Return lifecycle events", + "description": "Returns a list of ticket lifecycle events in descending order, according to the event timestamp.\nLimited to a maximum of five concurrent calls.\nBy default, This API only returns events that have occurred on R24-1 and later.\nIf your desired timeframe includes events that occurred in previous versions, you must first run POST historical_events to assemble the data for those events.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "10": { + "name": "searchEvents", + "canvasName": "searchEvents", + "summary": "Return lifecycle events", + "description": "Returns a list of ticket lifecycle events in descending order, according to the event timestamp.\nLimited to a maximum of five concurrent calls.\nBy default, This API only returns events that have occurred on R24-1 and later.\nIf your desired timeframe includes events that occurred in previous versions, you must first run POST historical_events to assemble the data for those events.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "start": "$var.job.start", + "count": "$var.job.count", + "get_total": "$var.job.get_total", + "type": "$var.job.type", + "assignee_name": "$var.job.assignee_name", + "assignee_id": "$var.job.assignee_id", + "participant_name": "$var.job.participant_name", + "participant_id": "$var.job.participant_id", + "ticket_id": "$var.job.ticket_id", + "workflow_name": "$var.job.workflow_name", + "parent_workflow_id": "$var.job.parent_workflow_id", + "step_name": "$var.job.step_name", + "step_id": "$var.job.step_id", + "date_from": "$var.job.date_from", + "date_to": "$var.job.date_to", + "business_duration_exceeds_hours": "$var.job.business_duration_exceeds_hours", + "sla_status": "$var.job.sla_status", + "workflow_type": "$var.job.workflow_type" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "10": { + "type": "standard", + "state": "success" + } + }, + "10": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "start": { + "type": "integer", + "description": "Offset the count starting point" + }, + "count": { + "type": "integer", + "description": "Limit number of results (default is 1000)" + }, + "get_total": { + "type": "boolean", + "description": "Set to true to get the total number of items that can be retrieved" + }, + "type": { + "type": "array", + "description": "Search by type of the event." + }, + "assignee_name": { + "type": "array", + "description": "Search by assignee name." + }, + "assignee_id": { + "type": "array", + "description": "Search by internal assignee id." + }, + "participant_name": { + "type": "array", + "description": "Search by participant users names, Only events of type TASK_ASSIGNED are returned for this filter" + }, + "participant_id": { + "type": "array", + "description": "Search by internal participant id." + }, + "ticket_id": { + "type": "array", + "description": "Search by ticket id." + }, + "workflow_name": { + "type": "array", + "description": "Search by workflow name." + }, + "parent_workflow_id": { + "type": "array", + "description": "Search by parent workflow id." + }, + "step_name": { + "type": "array", + "description": "Search by step name." + }, + "step_id": { + "type": "array", + "description": "Search by step id." + }, + "date_from": { + "type": "string", + "description": "Search for records from this date. Date format expected: yyyy-mm-dd" + }, + "date_to": { + "type": "string", + "description": "Search for records until this date. Date format expected: yyyy-mm-dd" + }, + "business_duration_exceeds_hours": { + "type": "integer", + "description": "Search by business duration" + }, + "sla_status": { + "type": "array", + "description": "Search by sla status" + }, + "workflow_type": { + "type": "array", + "description": "Search by workflow type" + } + } + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 16, + "reference": "7e44b731-e5be-4258-89ef-4ad2c9fb069e", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Include historical event data in lifecycle queries", + "description": "Assembles data from events that occurred before R24-1, allowing these events to be included in GET lifecycle_events.\nThis action can take some time. Once you call this API, you cannot call it again until the first action has finished.\nYou can check the action progress by calling GET historical_events_status.\nSupported events: [TICKET_CREATION].", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "11": { + "name": "createEventsFromHistory", + "canvasName": "createEventsFromHistory", + "summary": "Include historical event data in lifecycle queries", + "description": "Assembles data from events that occurred before R24-1, allowing these events to be included in GET lifecycle_events.\nThis action can take some time. Once you call this API, you cannot call it again until the first action has finished.\nYou can check the action progress by calling GET historical_events_status.\nSupported events: [TICKET_CREATION].", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "11": { + "type": "standard", + "state": "success" + } + }, + "11": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 17, + "reference": "df4dcd1c-39c6-448e-9da5-c5fa10e48120", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Monitor status of ongoing historical event assembly
", + "description": "Returns the status of an ongoing historical event assembly, initiated by calling POST historical_events.\nThe field ?oldest_event_time? shows the last event successfully added to the lifecycle events repository, use this field to track the action's progress.\nEvents are migrated from newest to oldest, within the specified timeframe.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "12": { + "name": "getTicketEventHistoryStatusIfRunning", + "canvasName": "getTicketEventHistoryStatusIfRunning", + "summary": "Monitor status of ongoing historical event assembly
", + "description": "Returns the status of an ongoing historical event assembly, initiated by calling POST historical_events.\nThe field ?oldest_event_time? shows the last event successfully added to the lifecycle events repository, use this field to track the action's progress.\nEvents are migrated from newest to oldest, within the specified timeframe.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "12": { + "type": "standard", + "state": "success" + } + }, + "12": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": {} + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 18, + "reference": "852b5d1f-e88f-46fe-9839-8ab1a4c271ba", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Cancel a ticket", + "description": "Cancel a ticket", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "13": { + "name": "cancelTicket", + "canvasName": "cancelTicket", + "summary": "Cancel a ticket", + "description": "Cancel a ticket", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "requester_id": "$var.job.requester_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "13": { + "type": "standard", + "state": "success" + } + }, + "13": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ticket as shown in SecureChange" + }, + "requester_id": { + "type": "integer", + "description": "The user of the ticket's requester, when logged in user is canceling on behalf" + } + }, + "required": [ + "id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 19, + "reference": "e85375f3-77b5-4bff-9d96-010487346bbd", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Change the requester of the specified ticket task to the specified user.", + "description": "Change the requester of the specified ticket task to the specified user.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "14": { + "name": "changeRequesterTicket", + "canvasName": "changeRequesterTicket", + "summary": "Change the requester of the specified ticket task to the specified user.", + "description": "Change the requester of the specified ticket task to the specified user.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "assigneeId": "$var.job.assigneeId", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "14": { + "type": "standard", + "state": "success" + } + }, + "14": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "assigneeId": { + "type": "integer", + "description": "The assignee ID" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "assigneeId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 20, + "reference": "4b7c8d98-8061-4720-82aa-c5dbabd7b2ee", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Confirm the request", + "description": "Confirm the request", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "15": { + "name": "confirm", + "canvasName": "confirm", + "summary": "Confirm the request", + "description": "Confirm the request", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "requester_id": "$var.job.requester_id", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "15": { + "type": "standard", + "state": "success" + } + }, + "15": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "requester_id": { + "type": "integer", + "description": "The user of the ticket's requester, when logged in user is confirm on behalf" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 21, + "reference": "8697813d-d805-47d0-b6de-731774ba3ac2", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Returns the history of the specified ticket", + "description": "Returns the history of the specified ticket", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "16": { + "name": "getTicketHistory", + "canvasName": "getTicketHistory", + "summary": "Returns the history of the specified ticket", + "description": "Returns the history of the specified ticket", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "16": { + "type": "standard", + "state": "success" + } + }, + "16": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + } + }, + "required": [ + "id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 22, + "reference": "a3d60f5f-ef5e-4694-9d37-a384626fe067", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Map rules to ticket", + "description": "Maps the rules from the ticket to the relevant rules in SecureTrack. \nAdds record set entries to the relevant rules metadata. \nLink to history is found in the returned location header. \nApplicable only for closed tickets in the following workflows: Access Request, Access Request and Modify Group, and Clone Server Policy. \nUse handler_id for running on behalf of another user. \nTo get handler_id, use the System Users API.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "17": { + "name": "mapRules", + "canvasName": "mapRules", + "summary": "Map rules to ticket", + "description": "Maps the rules from the ticket to the relevant rules in SecureTrack. \nAdds record set entries to the relevant rules metadata. \nLink to history is found in the returned location header. \nApplicable only for closed tickets in the following workflows: Access Request, Access Request and Modify Group, and Clone Server Policy. \nUse handler_id for running on behalf of another user. \nTo get handler_id, use the System Users API.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "handler_id": "$var.job.handler_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "17": { + "type": "standard", + "state": "success" + } + }, + "17": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ticket as shown in SecureChange" + }, + "handler_id": { + "type": "integer", + "description": "Run API on behalf of defined user id" + } + }, + "required": [ + "id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 23, + "reference": "0902d203-64f4-41bb-bd67-18a6a50f1b3a", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Reject a ticket", + "description": "Reject a ticket", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "18": { + "name": "rejectTicket", + "canvasName": "rejectTicket", + "summary": "Reject a ticket", + "description": "Reject a ticket", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "handler_id": "$var.job.handler_id", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "18": { + "type": "standard", + "state": "success" + } + }, + "18": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ticket as shown in SecureChange" + }, + "handler_id": { + "type": "integer", + "description": "The user id, when logged in user is rejecting on behalf" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 24, + "reference": "bae29bd0-6b84-424f-9856-8690c05522dd", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Commit policy changes", + "description": "Create an asynchronous task to commit policy changes to all the devices managed by the specified management device.\nOnce the Commit task is created, the task status changes to pending and becomes locked for editing until the task completes.\nUse the API function link in the response location header to check the status of the task.\nOnce the task is complete, the results become available.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "19": { + "name": "commitDevice", + "canvasName": "commitDevice", + "summary": "Commit policy changes", + "description": "Create an asynchronous task to commit policy changes to all the devices managed by the specified management device.\nOnce the Commit task is created, the task status changes to pending and becomes locked for editing until the task completes.\nUse the API function link in the response location header to check the status of the task.\nOnce the task is complete, the results become available.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId", + "deviceId": "$var.job.deviceId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "19": { + "type": "standard", + "state": "success" + } + }, + "19": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + }, + "deviceId": { + "type": "integer", + "description": "Device ID" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId", + "deviceId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 25, + "reference": "8ce5919a-989f-4f59-bcd5-78fdc2db8aa1", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Update the device with designer suggestions", + "description": "Create an asynchronous task to update Designer suggestions to the specified device. \nOnce the Update Device task is created, the status of the task changes to pending and it becomes locked for editing until the update completes. \nThe response location header has a link to an API function which you can use to check the status of the task. \nOnce the Update Device task is complete, the results become available and are recorded in the ticket's history.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1a": { + "name": "updateDevice", + "canvasName": "updateDevice", + "summary": "Update the device with designer suggestions", + "description": "Create an asynchronous task to update Designer suggestions to the specified device. \nOnce the Update Device task is created, the status of the task changes to pending and it becomes locked for editing until the update completes. \nThe response location header has a link to an API function which you can use to check the status of the task. \nOnce the Update Device task is complete, the results become available and are recorded in the ticket's history.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId", + "deviceId": "$var.job.deviceId", + "force": "$var.job.force" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1a": { + "type": "standard", + "state": "success" + } + }, + "1a": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + }, + "deviceId": { + "type": "integer", + "description": "Device ID" + }, + "force": { + "type": "boolean", + "description": "Force update device even if the policy on the device has already been modified" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId", + "deviceId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 26, + "reference": "13aff9e2-d2e6-4a9d-a92d-1906223f21fe", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Redesign", + "description": "Create an asynchronous task to redesign.\nOnce the Redesign task is created, the status of the task changes to pending and it becomes locked for editing until the redesign completes.\nThe response location header has a link to an API function which you can use to check the status of the task.\nOnce the Redesign task is complete, the results become available.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1b": { + "name": "redesign", + "canvasName": "redesign", + "summary": "Redesign", + "description": "Create an asynchronous task to redesign.\nOnce the Redesign task is created, the status of the task changes to pending and it becomes locked for editing until the redesign completes.\nThe response location header has a link to an API function which you can use to check the status of the task.\nOnce the Redesign task is complete, the results become available.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1b": { + "type": "standard", + "state": "success" + } + }, + "1b": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 27, + "reference": "03079661-8bf7-431b-bf78-f05a8e437e2f", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Update the opm device with designer suggestions", + "description": "Create an asynchronous task to update Designer suggestions to the specified opm device. \nOnce the Update Device task is created, the status of the task changes to pending and it becomes locked for editing until the update completes. \nThe response location header has a link to an API function which you can use to check the status of the task. \nOnce the Update Device task is complete, the results become available and are recorded in the ticket's history.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1c": { + "name": "updateOpmDevice", + "canvasName": "updateOpmDevice", + "summary": "Update the opm device with designer suggestions", + "description": "Create an asynchronous task to update Designer suggestions to the specified opm device. \nOnce the Update Device task is created, the status of the task changes to pending and it becomes locked for editing until the update completes. \nThe response location header has a link to an API function which you can use to check the status of the task. \nOnce the Update Device task is complete, the results become available and are recorded in the ticket's history.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId", + "systemId": "$var.job.systemId", + "force": "$var.job.force" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1c": { + "type": "standard", + "state": "success" + } + }, + "1c": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + }, + "systemId": { + "type": "string", + "description": "System ID" + }, + "force": { + "type": "boolean", + "description": "Force update system even if the policy on the system has already been modified" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId", + "systemId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 28, + "reference": "0f6f0dc6-e134-49f3-842b-d736fbeb9582", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Reassigns the specified ticket task to the specified user.", + "description": "Values can only be updated for the current step.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1d": { + "name": "reassignTicketTask", + "canvasName": "reassignTicketTask", + "summary": "Reassigns the specified ticket task to the specified user.", + "description": "Values can only be updated for the current step.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "assigneeId": "$var.job.assigneeId", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1d": { + "type": "standard", + "state": "success" + } + }, + "1d": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "assigneeId": { + "type": "integer", + "description": "The assignee ID" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "stepId", + "taskId", + "assigneeId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 29, + "reference": "70a0c0b7-04fe-4e17-9bf4-267828ebaba2", + "type": "workflow", + "folder": "/Ticket Lifecycle", + "document": { + "name": "Returns the specified ticket to the specified step", + "description": "Values can only be updated for the current step.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1e": { + "name": "redoTicketStep", + "canvasName": "redoTicketStep", + "summary": "Returns the specified ticket to the specified step", + "description": "Values can only be updated for the current step.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "toStepId": "$var.job.toStepId", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1e": { + "type": "standard", + "state": "success" + } + }, + "1e": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "toStepId": { + "type": "integer", + "description": "To which step we the ticket will return" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "stepId", + "taskId", + "toStepId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 30, + "reference": "f225334e-711f-4af5-83b1-78001cab6c05", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Returns the details of specified tickets (max 100 tickets in a single query)", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "1f": { + "name": "getTickets", + "canvasName": "getTickets", + "summary": "Returns the details of specified tickets (max 100 tickets in a single query)", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "status": "$var.job.status", + "count": "$var.job.count", + "start": "$var.job.start", + "desc": "$var.job.desc", + "expand_links": "$var.job.expand_links", + "showStepsDetails": "$var.job.showStepsDetails", + "showApplicationChanges": "$var.job.showApplicationChanges" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "1f": { + "type": "standard", + "state": "success" + } + }, + "1f": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The status of the tickets" + }, + "count": { + "type": "integer", + "description": "Tickets list max pagination length (max value is 100)" + }, + "start": { + "type": "integer", + "description": "Offset the count starting point" + }, + "desc": { + "type": "boolean", + "description": "Get the list in descending order" + }, + "expand_links": { + "type": "boolean", + "description": "See expanded view of the objects" + }, + "showStepsDetails": { + "type": "boolean", + "description": "Include steps' details in the response" + }, + "showApplicationChanges": { + "type": "boolean", + "description": "Include application changes in the response" + } + } + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 31, + "reference": "4552fe62-bfbc-42d1-9dfe-8a9b9f217be8", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Submit a new ticket to Secure Change", + "description": "GENERAL USE\nWhen posting a Modify Group ticket, group scope must be configured for FortiManager advanced and Juniper SRX devices.\nJuniper SRX devices:\nGlobal address-book will be used unless an existing address-book is given.\nTicket validation will fail in case given Address Book is not configured on the device.\nFortiManager advanced devices:\n'Any' zone will be used unless an existing zone is given.\nTicket validation will fail in case given zone is not configured on the device.\n*Note: Zones and ", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "20": { + "name": "addTicket", + "canvasName": "addTicket", + "summary": "Submit a new ticket to Secure Change", + "description": "GENERAL USE\nWhen posting a Modify Group ticket, group scope must be configured for FortiManager advanced and Juniper SRX devices.\nJuniper SRX devices:\nGlobal address-book will be used unless an existing address-book is given.\nTicket validation will fail in case given Address Book is not configured on the device.\nFortiManager advanced devices:\n'Any' zone will be used unless an existing zone is given.\nTicket validation will fail in case given zone is not configured on the device.\n*Note: Zones and address-books must not be configured for other devices.\n\nUsing newly created objects from a different group in the same ticket\nThe user can add a newly created object from a different group to the selected group, with object_UID equal to the name of the newly created object.\nFor management devices with hierarchies, the newly created object does not populate other levels of the hierarchies.\n\nPermitted values for @type\nAllowed values for @type property included in DestinationDTO and SourceDTO are:\nANY\nIP\nDNS\nObject - Device's existing object\nINTERNET\nLDAP (SourceDTO only) - LDAP entity\n\nTo use a service object in a new request you must use two parameters to specify the object. The parameter options are:\n1. Both object_UID and management_id \n2. Both object_name and management_name \n\nTo use a network object in a new request you must use two parameters to specify the object. The parameter options are:\n1. Both object_UID and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.\n\nIn order to add a comment in a new request you must enter a value in the Content field\n.To add a comment with an attachment, enter a value in the uid field. The uid value should be taken from the location header response in POST https://localhost/securechangeworkflow/api/securechange/attachments\nOnly the user that uploaded the attachment has permission to add it to a ticket.\n\nIf the API is called to open a ticket for a SecureApp application with more than 100 ARs,\nit must be split into multiple tickets of up to 100 ARs each.\nThe count parameter specifies the number of tickets to be opened.\n\nThe Location header in the response contains a URL that you can use to retrieve the details of the created ticket.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "closed": "$var.job.closed", + "count": "$var.job.count", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "20": { + "type": "standard", + "state": "success" + } + }, + "20": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "closed": { + "type": "boolean", + "description": "Cannot be done from the API" + }, + "count": { + "type": "integer", + "description": "The number of tickets that will be created from the application" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 32, + "reference": "b09d97fc-591c-48d0-8f0a-ee2d310f0d86", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Include historical business duration data", + "description": "Retroactively calculate ticket's business duration for closed tickets, which were created in the past (up to 2 years ago)\nThis action can take a while. Once you call this API, you cannot call it again until the first action has finished.\n\nOnly closed tickets are affected by this API.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "21": { + "name": "createFromThePast", + "canvasName": "createFromThePast", + "summary": "Include historical business duration data", + "description": "Retroactively calculate ticket's business duration for closed tickets, which were created in the past (up to 2 years ago)\nThis action can take a while. Once you call this API, you cannot call it again until the first action has finished.\n\nOnly closed tickets are affected by this API.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "21": { + "type": "standard", + "state": "success" + } + }, + "21": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "type": "object", + "description": "Request body payload." + } + } + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 33, + "reference": "b87f9076-570c-4215-9c2a-03a86a0f6dd0", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Returns the details of a specified ticket", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "22": { + "name": "getTicket", + "canvasName": "getTicket", + "summary": "Returns the details of a specified ticket", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "expand_links": "$var.job.expand_links", + "showStepsDetails": "$var.job.showStepsDetails", + "showTasksFields": "$var.job.showTasksFields", + "showApplicationChanges": "$var.job.showApplicationChanges" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "22": { + "type": "standard", + "state": "success" + } + }, + "22": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID number of the ticket as shown in SecureChange" + }, + "expand_links": { + "type": "boolean", + "description": "See expanded view of the objects" + }, + "showStepsDetails": { + "type": "boolean", + "description": "Include steps' details in the response" + }, + "showTasksFields": { + "type": "boolean", + "description": "Include tasks' fields in the response" + }, + "showApplicationChanges": { + "type": "boolean", + "description": "Include application changes in the response" + } + }, + "required": [ + "id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 34, + "reference": "d03b2cc6-8a0f-4c1a-912c-dfca508a389c", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Export ticket to a PDF", + "description": "Export ticket to a PDF is not supported for Rule Decommission, Rule Modification, Rule Recertification or Clone network object policy.\nThe name of the downloaded file is returned in the Filename field of the content-disposition header.\nThe file content is returned in the response body.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "23": { + "name": "exportTicket", + "canvasName": "exportTicket", + "summary": "Export ticket to a PDF", + "description": "Export ticket to a PDF is not supported for Rule Decommission, Rule Modification, Rule Recertification or Clone network object policy.\nThe name of the downloaded file is returned in the Filename field of the content-disposition header.\nThe file content is returned in the response body.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "23": { + "type": "standard", + "state": "success" + } + }, + "23": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID number of the ticket as shown in SecureChange" + } + }, + "required": [ + "id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 35, + "reference": "86a35c6a-ddd4-4bd9-8cfb-08fabb9e8241", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Pause SLA for specific ticket", + "description": "When a ticket is in progress and its workflow enables calendar-based SLA, a permitted user can pause its SLA tracking progress.\nPermitted user must have 'Pause SLA' permission and be that ticket's current assignee.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "24": { + "name": "pauseSLA", + "canvasName": "pauseSLA", + "summary": "Pause SLA for specific ticket", + "description": "When a ticket is in progress and its workflow enables calendar-based SLA, a permitted user can pause its SLA tracking progress.\nPermitted user must have 'Pause SLA' permission and be that ticket's current assignee.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "24": { + "type": "standard", + "state": "success" + } + }, + "24": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + } + }, + "required": [ + "id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 36, + "reference": "b1a88bec-5414-461f-a7c3-815e6d032269", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Resume SLA for specific ticket", + "description": "When a ticket's SLA tracking progress is paused, any user who is that ticket's current assignee, can resume the SLA tracking progress.\nTake note that paused SLA tracking progress automatically resumes when the ticket changes its current step.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "25": { + "name": "resumeSLA", + "canvasName": "resumeSLA", + "summary": "Resume SLA for specific ticket", + "description": "When a ticket's SLA tracking progress is paused, any user who is that ticket's current assignee, can resume the SLA tracking progress.\nTake note that paused SLA tracking progress automatically resumes when the ticket changes its current step.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "25": { + "type": "standard", + "state": "success" + } + }, + "25": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + } + }, + "required": [ + "id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 37, + "reference": "7026beda-f7a9-4ef2-b20d-f3cb89dd440a", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Returns the details of a specified ticket stages", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "26": { + "name": "getTicketStages", + "canvasName": "getTicketStages", + "summary": "Returns the details of a specified ticket stages", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "expand_links": "$var.job.expand_links" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "26": { + "type": "standard", + "state": "success" + } + }, + "26": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID number of the ticket as shown in SecureChange" + }, + "expand_links": { + "type": "boolean", + "description": "See expanded view of the objects" + } + }, + "required": [ + "id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 38, + "reference": "e07863b5-54a4-4c91-95e3-35367b44cb04", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Change a task of a ticket at the current step", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "27": { + "name": "doneStep_2", + "canvasName": "doneStep_2", + "summary": "Change a task of a ticket at the current step", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "taskId": "$var.job.taskId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "27": { + "type": "standard", + "state": "success" + } + }, + "27": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "taskId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 39, + "reference": "d087dbac-8078-4a5e-a911-41a7e897b1b7", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Change multiple field within a task of a ticket in the current step", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "28": { + "name": "updateFieldList_2", + "canvasName": "updateFieldList_2", + "summary": "Change multiple field within a task of a ticket in the current step", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "taskId": "$var.job.taskId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "28": { + "type": "standard", + "state": "success" + } + }, + "28": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "taskId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 40, + "reference": "81d659ba-2d70-44e0-b773-9c0502a9fa82", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Change a field within a task of a ticket at the current step", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "29": { + "name": "updateField", + "canvasName": "updateField", + "summary": "Change a field within a task of a ticket at the current step", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "29": { + "type": "standard", + "state": "success" + } + }, + "29": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "taskId", + "fieldId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 41, + "reference": "9a04da3a-fb14-4304-90e5-8041fe03e2b7", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Returns the details of a specified ticket stages 2", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2a": { + "name": "getTicketStageById", + "canvasName": "getTicketStageById", + "summary": "Returns the details of a specified ticket stages", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "expand_links": "$var.job.expand_links" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2a": { + "type": "standard", + "state": "success" + } + }, + "2a": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID number of the ticket as shown in SecureChange" + }, + "stepId": { + "type": "integer", + "description": "The ID number of the step as shown in SecureChange" + }, + "expand_links": { + "type": "boolean", + "description": "See expanded view of the objects" + } + }, + "required": [ + "id", + "stepId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 42, + "reference": "9cb083ee-ff11-4fdd-b555-47f887c71138", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Returns the details of the tasks", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2b": { + "name": "getStageTasks", + "canvasName": "getStageTasks", + "summary": "Returns the details of the tasks", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "expand_links": "$var.job.expand_links" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2b": { + "type": "standard", + "state": "success" + } + }, + "2b": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID number of the ticket as shown in SecureChange" + }, + "stepId": { + "type": "integer", + "description": "The ID number of the step as shown in SecureChange" + }, + "expand_links": { + "type": "boolean", + "description": "See expanded view of the objects" + } + }, + "required": [ + "id", + "stepId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 43, + "reference": "3da0c913-6ce2-4e80-8c80-1d56a32fed18", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Returns the details of a specified task", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2c": { + "name": "getStageTaskById", + "canvasName": "getStageTaskById", + "summary": "Returns the details of a specified task", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "expand_links": "$var.job.expand_links" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2c": { + "type": "standard", + "state": "success" + } + }, + "2c": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID number of the ticket as shown in SecureChange" + }, + "stepId": { + "type": "integer", + "description": "The ID number of the step as shown in SecureChange" + }, + "taskId": { + "type": "integer", + "description": "The ID number of the task as shown in SecureChange" + }, + "expand_links": { + "type": "boolean", + "description": "See expanded view of the objects" + } + }, + "required": [ + "id", + "stepId", + "taskId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 44, + "reference": "9cbea97c-0f32-4583-a4f4-6882627b3e9b", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Change a task of a ticket", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2d": { + "name": "doneStep", + "canvasName": "doneStep", + "summary": "Change a task of a ticket", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2d": { + "type": "standard", + "state": "success" + } + }, + "2d": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "stepId", + "taskId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 45, + "reference": "ffba38e6-b526-47a2-b7d6-9281138acb59", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Accept task API", + "description": "When a task is on self assignment mode awaiting assignment, any participant user can use this API to assign it to themselves", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2e": { + "name": "acceptTaskSelfAssign", + "canvasName": "acceptTaskSelfAssign", + "summary": "Accept task API", + "description": "When a task is on self assignment mode awaiting assignment, any participant user can use this API to assign it to themselves", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2e": { + "type": "standard", + "state": "success" + } + }, + "2e": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + } + }, + "required": [ + "id", + "stepId", + "taskId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 46, + "reference": "4d970206-b2a6-4584-9f1d-e04a6f121bd7", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Get server clone policy verifier results", + "description": "Get server clone policy verifier results", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "2f": { + "name": "getServerCloneVerifierResults", + "canvasName": "getServerCloneVerifierResults", + "summary": "Get server clone policy verifier results", + "description": "Get server clone policy verifier results", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "2f": { + "type": "standard", + "state": "success" + } + }, + "2f": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + } + }, + "required": [ + "id", + "stepId", + "taskId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 47, + "reference": "72207f4d-3ffc-4ec7-85e3-0d41ad28ce1a", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Returns the details of a the fields", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "30": { + "name": "getTaskFields", + "canvasName": "getTaskFields", + "summary": "Returns the details of a the fields", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "expand_links": "$var.job.expand_links" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "30": { + "type": "standard", + "state": "success" + } + }, + "30": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID number of the ticket as shown in SecureChange" + }, + "stepId": { + "type": "integer", + "description": "The ID number of the step as shown in SecureChange" + }, + "taskId": { + "type": "integer", + "description": "The ID number of the task as shown in SecureChange" + }, + "expand_links": { + "type": "boolean", + "description": "See expanded view of the objects" + } + }, + "required": [ + "id", + "stepId", + "taskId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 48, + "reference": "517de8f9-fb53-4740-b95c-415a64f6fd75", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Change multiple fields within a task of a ticket", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "31": { + "name": "updateFieldList", + "canvasName": "updateFieldList", + "summary": "Change multiple fields within a task of a ticket", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "31": { + "type": "standard", + "state": "success" + } + }, + "31": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "stepId", + "taskId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 49, + "reference": "b3825715-d3bb-4c7a-b284-ccd17d1e0222", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Returns the details of a specified field", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "32": { + "name": "getTaskFieldById", + "canvasName": "getTaskFieldById", + "summary": "Returns the details of a specified field", + "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId", + "expand_links": "$var.job.expand_links" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "32": { + "type": "standard", + "state": "success" + } + }, + "32": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID number of the ticket as shown in SecureChange" + }, + "stepId": { + "type": "integer", + "description": "The ID number of the step as shown in SecureChange" + }, + "taskId": { + "type": "integer", + "description": "The ID number of the task as shown in SecureChange" + }, + "fieldId": { + "type": "integer", + "description": "The ID number of the field as shown in SecureChange" + }, + "expand_links": { + "type": "boolean", + "description": "See expanded view of the objects" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 50, + "reference": "3e8116ab-e8c3-4082-bac5-f98a714160d2", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Change a field within a task of a ticket", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "33": { + "name": "updateField_2", + "canvasName": "updateField_2", + "summary": "Change a field within a task of a ticket", + "description": "To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id \n2. Both object_name and management_name \n\nTo use a network object in an existing request you must use two parameters to specify the object. The parameter options are:\n1. Both st_uid and management_id (for Access Request and Group Change workflow)\n2. Both object_name and management_name (only for Access Request workflow)\n3. Both object_name and management_id (only for Group Change workflow)\n**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name\n\nFor the Modify Group workflow, verifies that the fields listed in the API call have valid values.\nOther fields that are included in the step are not affected by the validation and retain their existing values.\nUpdates applied to values in global fields are carried forward from this step and do not affect values in previous steps.\n\nThe Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Network object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range \n* Device network object types: \n    SecureTrack API element <type_on_device> cannot include the following types: \n    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic\n* Network object IP types:\n    SecureTrack API element <ip_type> includes one of the following types: \n    IPv4, Other, IPv4_IPv6\n* The device network object is available in the latest revision\n\nThe Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:\n* Explicit object: \n    SecureTrack API element <implicit> is false\n* Service object types: \n    SecureTrack API element <class_name> includes one of the following types: \n    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service\n* Device service object types: \n    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type\n* The device service object is available in the latest revision\n\nThe Rule Modification workflow supports adding the same new object to more than one rule by defining an 'add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "33": { + "type": "standard", + "state": "success" + } + }, + "33": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 51, + "reference": "3d4e1cb6-eaf4-4d3a-9ae3-bee2a5ec5c15", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Get designer results according to field id", + "description": "Use this API to retrieve designer results generated in R17-2 and later.\nRedesign status field will only appear for the current step.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "34": { + "name": "getFieldDesignerResults", + "canvasName": "getFieldDesignerResults", + "summary": "Get designer results according to field id", + "description": "Use this API to retrieve designer results generated in R17-2 and later.\nRedesign status field will only appear for the current step.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "34": { + "type": "standard", + "state": "success" + } + }, + "34": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 52, + "reference": "690220cb-ad15-439d-a78e-b837e92308c6", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Returns the results of the Commit action", + "description": "GENERAL USE\nThe report returns the Commit results for the device with the specified management ID and for the devices suggested in the Designer results. The report also includes results for devices that are in the related hierarchy of these devices.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "35": { + "name": "getCommitResults", + "canvasName": "getCommitResults", + "summary": "Returns the results of the Commit action", + "description": "GENERAL USE\nThe report returns the Commit results for the device with the specified management ID and for the devices suggested in the Designer results. The report also includes results for devices that are in the related hierarchy of these devices.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId", + "managementId": "$var.job.managementId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "35": { + "type": "standard", + "state": "success" + } + }, + "35": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + }, + "managementId": { + "type": "integer", + "description": "Management ID" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId", + "managementId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 53, + "reference": "fdcc02d2-58c9-42e8-8dec-3a82dc785047", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Get commands for device from designer results of a specific field id", + "description": "Get commands for device from designer results of a specific field id", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "36": { + "name": "getDeviceCommandsFromFieldDesignerResults", + "canvasName": "getDeviceCommandsFromFieldDesignerResults", + "summary": "Get commands for device from designer results of a specific field id", + "description": "Get commands for device from designer results of a specific field id", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "deviceId": "$var.job.deviceId", + "fieldId": "$var.job.fieldId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "36": { + "type": "standard", + "state": "success" + } + }, + "36": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "deviceId": { + "type": "integer", + "description": "Device ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "deviceId", + "fieldId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 54, + "reference": "cc0dc134-c375-4dba-845e-e289f8c4dde5", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Get designer results according to field id and device id", + "description": "Use this API to retrieve designer results per specific device.\nRedesign status field will only appear for the current step.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "37": { + "name": "getDesignerResultsByDeviceId", + "canvasName": "getDesignerResultsByDeviceId", + "summary": "Get designer results according to field id and device id", + "description": "Use this API to retrieve designer results per specific device.\nRedesign status field will only appear for the current step.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId", + "managementId": "$var.job.managementId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "37": { + "type": "standard", + "state": "success" + } + }, + "37": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + }, + "managementId": { + "type": "integer", + "description": "Device ID" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId", + "managementId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 55, + "reference": "334ad148-4757-4986-8bcf-96e66d321b74", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Get OPM designer results according to ticket id and field id", + "description": "Get OPM designer results according to ticket id and field id", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "38": { + "name": "getSystemResults", + "canvasName": "getSystemResults", + "summary": "Get OPM designer results according to ticket id and field id", + "description": "Get OPM designer results according to ticket id and field id", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "38": { + "type": "standard", + "state": "success" + } + }, + "38": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 56, + "reference": "e92fe838-38cc-48fd-96de-a62057498f6b", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "getDesignerResultPerSystem", + "description": "Get OPM designer results per system according to ticket id, field id and system id", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "39": { + "name": "getDesignerResultPerSystem", + "canvasName": "getDesignerResultPerSystem", + "summary": "Get OPM designer results per system according to ticket id, field id and system id", + "description": "Get OPM designer results per system according to ticket id, field id and system id", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId", + "systemId": "$var.job.systemId", + "devices_count": "$var.job.devices_count", + "devices_offset": "$var.job.devices_offset" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "39": { + "type": "standard", + "state": "success" + } + }, + "39": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + }, + "systemId": { + "type": "string", + "description": "System ID" + }, + "devices_count": { + "type": "integer", + "description": "Maximum number of devices to be returned in the system result" + }, + "devices_offset": { + "type": "integer", + "description": "A number indicating the distance from the first device record in the data set" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId", + "systemId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 57, + "reference": "d9cebc93-0330-4908-9fbc-e0314dd88551", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Replace OPM Designer instructions for a system", + "description": "GENERAL USE\n1. Use the API '/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_designer/systems/{systemId}' to retrieve the designer results.\n2. Run this API to modify the required instructions.\n\nGENERAL NOTES\na. All instruction properties may be modified except the instruction ID, which is immutable.\nb. Each request may contain one or more instructions; each instruction represents a single change operation (ADD, MODIFY, DELETE).\nc. All referenced UIDs must already exi", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "3a": { + "name": "replaceOpmDesignerInstructions", + "canvasName": "replaceOpmDesignerInstructions", + "summary": "Replace OPM Designer instructions for a system", + "description": "GENERAL USE\n1. Use the API '/securechange/tickets/{id}/steps/{stepId}/tasks/{taskId}/fields/{fieldId}/opm_designer/systems/{systemId}' to retrieve the designer results.\n2. Run this API to modify the required instructions.\n\nGENERAL NOTES\na. All instruction properties may be modified except the instruction ID, which is immutable.\nb. Each request may contain one or more instructions; each instruction represents a single change operation (ADD, MODIFY, DELETE).\nc. All referenced UIDs must already exist in the system.\nd. All network related values: IP addresses, object types, service definitions and protocols, must be valid and logically correct from a networking perspective.\n\n\nInstruction object notes:\na. The id field is mandatory and uniquely identifies the instruction and cannot be modified.\nb. The change_type defines the type of action and must be one of the permitted values (ADD, MODIFY, DELETE).\nc. The changed_entity object must always be included and defines the specific object being modified or created.\nd. The relation_changes list must be present, and defines how entity relations will be updated.\n\nChangedEntity notes:\na. The type field is required and determines which entity subtype must be used (HOST, SUBNET, IP_RANGE, SERVICE types, RULE, etc.).\nb. The uid is optional and used when modifying existing entities.\nc. The new_entity_uid is optional and used when the system assigns a new UID.\nd. The name is optional.\ne. Additional required fields depend on the entity subtype (Host, Subnet, IP Range, Rule, Transport Service).\n\nChangedEntity subtype requirements:\na. Host: ip_type and ip are required.\nb. Subnet: ip_type and ip are required, and one of netmask or cidr.\nc. IP Range: ip_type, min_ip, and max_ip are required.\nd. IP Service: min_protocol and max_protocol required.\ne. ICMP Service: min_icmp_type and max_icmp_type required.\nf. Transport Service: min_port, max_port, and protocol are required.\ng. Rule: In case of a new rule, only the location field is required; the comment is optional.\n\nRelationChange notes:\na. The relation_change_type is required and defines the type of change applied (ADD, MODIFY, DELETE).\nb. The relation field is required and identifies the relation being updated (SOURCE, DESTINATION, SERVICE, MEMBER, SRC_ZONE, DST_ZONE).\nc. The predefined_value is optional and used to set special values like ANY.\nd. Both entities and embedded_entities must be present in the request (can be empty lists).\n\nEntityReference notes:\na. The type and name fields are required to reference an existing entity.\nb. One of the following must exist: uid or new_entity_uid.\nc. The name field remains required for identifying the referenced entity.\n\nRuleLocation notes:\na. The placement field is required and determines rule positioning (BEFORE, AFTER, LAST).\nb. The other_rule_uid or other_rule_identifier may be used when placement is BEFORE or AFTER another rule.\n\nEmbeddedEntity notes:\na. Embedded entities contain full object definitions used inside relation changes.\nb. Each embedded entity requires a type and additional fields based on subtype.\n\nEmbedded entity subtype requirements:\na. Host: ip_type and ip are required.\nb. Subnet: ip_type and ip are required, and one of netmask or cidr.\nc. IP Range: ip_type, min_ip, and max_ip required.\nd. Transport Service: min_port, max_port, and protocol required.\ne. IP Service: min_protocol and max_protocol required.\nf. ICMP Service: min_icmp_type and max_icmp_type required.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId", + "systemId": "$var.job.systemId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "3a": { + "type": "standard", + "state": "success" + } + }, + "3a": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + }, + "systemId": { + "type": "string", + "description": "System ID" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId", + "systemId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 58, + "reference": "153ab7e7-be1d-4111-bc46-c83cb978942b", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Get OPM provisioning results according to ticket id and field id", + "description": "Get OPM provisioning results according to ticket id and field id", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "3b": { + "name": "getProvisioningResults", + "canvasName": "getProvisioningResults", + "summary": "Get OPM provisioning results according to ticket id and field id", + "description": "Get OPM provisioning results according to ticket id and field id", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "3b": { + "type": "standard", + "state": "success" + } + }, + "3b": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 59, + "reference": "43a82c70-02f3-4fca-ad82-d8890aa46d3b", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "getProvisioningResultPerSystem", + "description": "Get OPM provisioning results per system according to ticket id, field id and system id", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "3c": { + "name": "getProvisioningResultPerSystem", + "canvasName": "getProvisioningResultPerSystem", + "summary": "Get OPM provisioning results per system according to ticket id, field id and system id", + "description": "Get OPM provisioning results per system according to ticket id, field id and system id", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId", + "systemId": "$var.job.systemId", + "devices_count": "$var.job.devices_count", + "devices_offset": "$var.job.devices_offset" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "3c": { + "type": "standard", + "state": "success" + } + }, + "3c": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + }, + "systemId": { + "type": "string", + "description": "System result ID" + }, + "devices_count": { + "type": "integer", + "description": "Maximum number of devices to be returned in the system result" + }, + "devices_offset": { + "type": "integer", + "description": "A number indicating the distance from the first device record in the data set" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId", + "systemId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 60, + "reference": "806d5338-4c2c-48de-b148-546dda3908a2", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Get related rules according to field id", + "description": "Use this API to retrieve rules related to the traffic specified by the Access Request fields in the ticket.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "3d": { + "name": "getRelatedRules", + "canvasName": "getRelatedRules", + "summary": "Get related rules according to field id", + "description": "Use this API to retrieve rules related to the traffic specified by the Access Request fields in the ticket.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "3d": { + "type": "standard", + "state": "success" + } + }, + "3d": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 61, + "reference": "342047be-458a-43d8-b59e-6139a062dfe9", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Get security zones according to field id", + "description": "Use this API to retrieve security zones for multi access result field", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "3e": { + "name": "getSecurityZones", + "canvasName": "getSecurityZones", + "summary": "Get security zones according to field id", + "description": "Use this API to retrieve security zones for multi access result field", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "3e": { + "type": "standard", + "state": "success" + } + }, + "3e": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Field ID" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 62, + "reference": "4a23f69d-3aaf-4eb4-ab0c-0df71cfe8003", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Get access request verifier results", + "description": "Get access request verifier results", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "3f": { + "name": "getARVerifierResults", + "canvasName": "getARVerifierResults", + "summary": "Get access request verifier results", + "description": "Get access request verifier results", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "3f": { + "type": "standard", + "state": "success" + } + }, + "3f": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Request ID" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 63, + "reference": "076a017e-0066-43a3-853d-2eda2d75678a", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Returns topology map image (png file) for specific verifier results", + "description": "Returns topology map image (png file) for specific verifier results", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "40": { + "name": "getARVerifierResultsTopologyMap", + "canvasName": "getARVerifierResultsTopologyMap", + "summary": "Returns topology map image (png file) for specific verifier results", + "description": "Returns topology map image (png file) for specific verifier results", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "fieldId": "$var.job.fieldId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "40": { + "type": "standard", + "state": "success" + } + }, + "40": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "fieldId": { + "type": "integer", + "description": "Request ID" + } + }, + "required": [ + "id", + "stepId", + "taskId", + "fieldId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 64, + "reference": "4b0b33f9-c17d-44e5-85f9-246de3289fbe", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Get rule decommision verifier results", + "description": "Get rule decommision verifier results", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "41": { + "name": "getRdVerifierResults", + "canvasName": "getRdVerifierResults", + "summary": "Get rule decommision verifier results", + "description": "Get rule decommision verifier results", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "41": { + "type": "standard", + "state": "success" + } + }, + "41": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + } + }, + "required": [ + "id", + "stepId", + "taskId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 65, + "reference": "28a8b02f-dfda-4f33-a516-3fc5eb66e0fe", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "updateInstruction", + "description": "GENERAL USE\n1. Create a ticket using UI/API.\n2. Run the designer using UI/API.\n3. Use relevent API to get the designer results.\n4. Run this API to modify the required parameters.\n\n*Note: you can modify one parameter at a time.\n\n Change rule location use\na. Modifying the rule order places the new rule before the rule with the specified identifier (rule name or number).\nb. Modifying the rule placement to \"last\" places the new rule as last rule or last pre-rule (depending on the vendor convention f", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "42": { + "name": "updateInstruction", + "canvasName": "updateInstruction", + "summary": "Modify the Designer suggestions for Access Request, Clone Server Policy, Decommission Network Object Request or Rule Decommission", + "description": "GENERAL USE\n1. Create a ticket using UI/API.\n2. Run the designer using UI/API.\n3. Use relevent API to get the designer results.\n4. Run this API to modify the required parameters.\n\n*Note: you can modify one parameter at a time.\n\n Change rule location use\na. Modifying the rule order places the new rule before the rule with the specified identifier (rule name or number).\nb. Modifying the rule placement to \"last\" places the new rule as last rule or last pre-rule (depending on the vendor convention for the device).\nc. For vendors that support \"after\" placement, modifying the rule placement allows positioning the new rule before or after the suggested rule location.\nd. For Check Point R80 and above releases, the indented rule numbering format can be applied to globally assigned policies (for example, \"rule_order\": \"4.5\").\n\ntrack level permitted values:\nNONE, LOG, ACCOUNT, ALERT, SNMP, MAIL, USER_DEFINED, EMERGENCIES, ALERTS, CRITICAL, ERRORS, WARNINGS, NOTIFICATIONS, INFORMATIONAL, DEBUGGING, DISABLED, DEFAULT, FULL_LOG, NETWORK_LOG, USER_ALERT_1, USER_ALERT_2, USER_ALERT_3 \n\nrule placement permitted values:\nBEFORE, AFTER, LAST", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "taskId": "$var.job.taskId", + "instructionId": "$var.job.instructionId", + "force": "$var.job.force", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "42": { + "type": "standard", + "state": "success" + } + }, + "42": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Ticket ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "instructionId": { + "type": "integer", + "description": "Instruction ID" + }, + "force": { + "type": "boolean", + "description": "force update when new revision available" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "taskId", + "instructionId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 66, + "reference": "15de5822-f64e-4631-957b-6d024ee3fe76", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Change the ticket properties", + "description": "Change the ticket properties listed in the TicketPropertiesDTO. \nWhen specifying the priority property you must use Critical/High/Normal/Low. \nWhen specifying the notification_group property you must use the ID of the group or leave the ID empty to remove the group. This property can be updated on a closed ticket.\nWhen specifying the referenced_ticket property you must use the ID of the ticket or leave the ID empty to remove the ticket.\nWhen specifying the expiration_date property, you must use ", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "43": { + "name": "updateTicketProperties", + "canvasName": "updateTicketProperties", + "summary": "Change the ticket properties", + "description": "Change the ticket properties listed in the TicketPropertiesDTO. \nWhen specifying the priority property you must use Critical/High/Normal/Low. \nWhen specifying the notification_group property you must use the ID of the group or leave the ID empty to remove the group. This property can be updated on a closed ticket.\nWhen specifying the referenced_ticket property you must use the ID of the ticket or leave the ID empty to remove the ticket.\nWhen specifying the expiration_date property, you must use a yyyy-mm-dd format, or leave the value empty to remove the expiration date. To ignore the field, do not include it in the request. This property can be updated on a closed ticket.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "id": "$var.job.id", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "43": { + "type": "standard", + "state": "success" + } + }, + "43": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID number of the ticket as shown in SecureChange" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "id", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 67, + "reference": "59022b0e-b7b6-4ee9-baeb-0ece84bf7e5b", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Delete a comment from a ticket", + "description": "Delete a comment from a ticket", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "44": { + "name": "deleteComment", + "canvasName": "deleteComment", + "summary": "Delete a comment from a ticket", + "description": "Delete a comment from a ticket", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "ticketId": "$var.job.ticketId", + "commentId": "$var.job.commentId" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "44": { + "type": "standard", + "state": "success" + } + }, + "44": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "ticketId": { + "type": "integer", + "description": "Ticket ID" + }, + "commentId": { + "type": "integer", + "description": "Comment ID" + } + }, + "required": [ + "ticketId", + "commentId" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 68, + "reference": "5aa9f84c-8da1-452e-b604-041b2569d897", + "type": "workflow", + "folder": "/Tickets", + "document": { + "name": "Add a new comment to a ticket", + "description": "The comment may include attached files which are identified by their uid Identifier.Returns the ID of the comment that was added.", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "45": { + "name": "addComment", + "canvasName": "addComment", + "summary": "Add a new comment to a ticket", + "description": "The comment may include attached files which are identified by their uid Identifier.Returns the ID of the comment that was added.", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "ticketId": "$var.job.ticketId", + "stepId": "$var.job.stepId", + "taskId": "$var.job.taskId", + "bodyContentType": "application/xml", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "45": { + "type": "standard", + "state": "success" + } + }, + "45": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "ticketId": { + "type": "integer", + "description": "Ticket ID" + }, + "stepId": { + "type": "integer", + "description": "Step ID" + }, + "taskId": { + "type": "integer", + "description": "Task ID" + }, + "spec": { + "type": "object", + "description": "Request body payload." + } + }, + "required": [ + "ticketId", + "stepId", + "taskId", + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 69, + "reference": "6555cb66-9239-41f5-94b3-876b4af496d1", + "type": "workflow", + "folder": "/Workflows", + "document": { + "name": "returns a list of the active workflows in securechange", + "description": "The workflow types to filter by are defined as follows : \nGENERICGeneric WorkflowACCESS_REQUEST_AND_MODIFY_GROUPAccess Request & Modify GroupACCESS_REQUESTAccess RequestMODIFY_GROUPModify GroupDECOMMISSION_NETWORK_OBJECTDecommission network objectRULE_DECOMMISSIONRule DecomissionRULE_RECERTIFICATIONRule RecertificationCLONE_NETWORK_OBJECT_POLICYClone network object PolicyRULE_MODIFICATIONRule Modification", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "46": { + "name": "getActiveWorkflowsByType", + "canvasName": "getActiveWorkflowsByType", + "summary": "returns a list of the active workflows in securechange", + "description": "The workflow types to filter by are defined as follows : \nGENERICGeneric WorkflowACCESS_REQUEST_AND_MODIFY_GROUPAccess Request & Modify GroupACCESS_REQUESTAccess RequestMODIFY_GROUPModify GroupDECOMMISSION_NETWORK_OBJECTDecommission network objectRULE_DECOMMISSIONRule DecomissionRULE_RECERTIFICATIONRule RecertificationCLONE_NETWORK_OBJECT_POLICYClone network object PolicyRULE_MODIFICATIONRule Modification", + "location": "Adapter", + "locationType": "Tufin SecureChange:latest", + "app": "Tufin SecureChange:latest", + "type": "automatic", + "displayName": "Tufin SecureChange", + "variables": { + "incoming": { + "adapter_id": "Tufin SecureChange", + "type": "$var.job.type" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "46": { + "type": "standard", + "state": "success" + } + }, + "46": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the workflow to filter by" + } + } + }, + "outputSchema": { + "type": "object", + "properties": { + "response": { + "type": "object", + "description": "Full HTTP response envelope ({ok, url, status, headers, text, body})." + } + } + }, + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + } + ], + "folders": [ + { + "nodeType": "folder", + "name": "Queries", + "children": [ + { + "iid": 0, + "nodeType": "component" + }, + { + "iid": 1, + "nodeType": "component" + }, + { + "iid": 2, + "nodeType": "component" + }, + { + "iid": 3, + "nodeType": "component" + }, + { + "iid": 4, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "Requests", + "children": [ + { + "iid": 5, + "nodeType": "component" + }, + { + "iid": 6, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "Search", + "children": [ + { + "iid": 7, + "nodeType": "component" + }, + { + "iid": 8, + "nodeType": "component" + }, + { + "iid": 9, + "nodeType": "component" + }, + { + "iid": 10, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "SecureChange Devices", + "children": [ + { + "iid": 11, + "nodeType": "component" + }, + { + "iid": 12, + "nodeType": "component" + }, + { + "iid": 13, + "nodeType": "component" + }, + { + "iid": 14, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "Ticket Lifecycle", + "children": [ + { + "iid": 15, + "nodeType": "component" + }, + { + "iid": 16, + "nodeType": "component" + }, + { + "iid": 17, + "nodeType": "component" + }, + { + "iid": 18, + "nodeType": "component" + }, + { + "iid": 19, + "nodeType": "component" + }, + { + "iid": 20, + "nodeType": "component" + }, + { + "iid": 21, + "nodeType": "component" + }, + { + "iid": 22, + "nodeType": "component" + }, + { + "iid": 23, + "nodeType": "component" + }, + { + "iid": 24, + "nodeType": "component" + }, + { + "iid": 25, + "nodeType": "component" + }, + { + "iid": 26, + "nodeType": "component" + }, + { + "iid": 27, + "nodeType": "component" + }, + { + "iid": 28, + "nodeType": "component" + }, + { + "iid": 29, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "Tickets", + "children": [ + { + "iid": 30, + "nodeType": "component" + }, + { + "iid": 31, + "nodeType": "component" + }, + { + "iid": 32, + "nodeType": "component" + }, + { + "iid": 33, + "nodeType": "component" + }, + { + "iid": 34, + "nodeType": "component" + }, + { + "iid": 35, + "nodeType": "component" + }, + { + "iid": 36, + "nodeType": "component" + }, + { + "iid": 37, + "nodeType": "component" + }, + { + "iid": 38, + "nodeType": "component" + }, + { + "iid": 39, + "nodeType": "component" + }, + { + "iid": 40, + "nodeType": "component" + }, + { + "iid": 41, + "nodeType": "component" + }, + { + "iid": 42, + "nodeType": "component" + }, + { + "iid": 43, + "nodeType": "component" + }, + { + "iid": 44, + "nodeType": "component" + }, + { + "iid": 45, + "nodeType": "component" + }, + { + "iid": 46, + "nodeType": "component" + }, + { + "iid": 47, + "nodeType": "component" + }, + { + "iid": 48, + "nodeType": "component" + }, + { + "iid": 49, + "nodeType": "component" + }, + { + "iid": 50, + "nodeType": "component" + }, + { + "iid": 51, + "nodeType": "component" + }, + { + "iid": 52, + "nodeType": "component" + }, + { + "iid": 53, + "nodeType": "component" + }, + { + "iid": 54, + "nodeType": "component" + }, + { + "iid": 55, + "nodeType": "component" + }, + { + "iid": 56, + "nodeType": "component" + }, + { + "iid": 57, + "nodeType": "component" + }, + { + "iid": 58, + "nodeType": "component" + }, + { + "iid": 59, + "nodeType": "component" + }, + { + "iid": 60, + "nodeType": "component" + }, + { + "iid": 61, + "nodeType": "component" + }, + { + "iid": 62, + "nodeType": "component" + }, + { + "iid": 63, + "nodeType": "component" + }, + { + "iid": 64, + "nodeType": "component" + }, + { + "iid": 65, + "nodeType": "component" + }, + { + "iid": 66, + "nodeType": "component" + }, + { + "iid": 67, + "nodeType": "component" + }, + { + "iid": 68, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "Workflows", + "children": [ + { + "iid": 69, + "nodeType": "component" + } + ] + } + ], + "createdBy": { + "provenance": "LDAP", + "username": "admin@itential", + "_id": "528f091e2efa44c5bd35fa57" + }, + "lastUpdatedBy": { + "provenance": "LDAP", + "username": "admin@itential", + "_id": "c862f35b134f49418cf72193" + }, + "created": "2026-09-15T00:00:00.000Z", + "lastUpdated": "2026-09-15T00:00:00.000Z", + "iid": 70, + "thumbnail": "", + "backgroundColor": "", + "referencedComponentHashes": [] +} \ No newline at end of file diff --git a/Tufin/SecureTrack/OpenAPIs/tufin_securetrack-25.2.json b/Tufin/SecureTrack/OpenAPIs/tufin_securetrack-25.2.json new file mode 100644 index 0000000..a539b46 --- /dev/null +++ b/Tufin/SecureTrack/OpenAPIs/tufin_securetrack-25.2.json @@ -0,0 +1,28328 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Tufin SecureTrack", + "description": "Tufin SecureTrack network security policy management and visibility REST API.", + "version": "25.2" + }, + "servers": [ + { + "url": "https://{host}/securetrack/api", + "variables": { + "host": { + "default": "tufin.example.com" + } + } + } + ], + "security": [ + { + "basicAuth": [] + } + ], + "components": { + "securitySchemes": { + "basicAuth": { + "type": "http", + "scheme": "basic" + } + }, + "schemas": { + "additional_param_tag_type": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "InterfaceForNetworkObjectListDTO": { + "type": "object", + "properties": { + "interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceForNetworkObjectDTO" + } + } + } + }, + "DipNatInfoDTO": { + "type": "object", + "properties": { + "shift_from": { + "type": "string", + "description": "shift_from" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "Object ID of NAT info" + }, + "interface_name": { + "type": "string", + "description": "Interface name of NAT info" + } + }, + "required": [ + "id", + "interface_name" + ] + }, + "ServiceDTO": { + "type": "object", + "properties": { + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "type_on_device": { + "type": "string", + "description": "type on device" + }, + "management_domain": { + "type": "string", + "description": "management domain " + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "management_domain", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "ServiceGroupDTO": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of references to the service group members" + }, + "is_device_predefined": { + "type": "boolean", + "description": "Is device predefined" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "type_on_device": { + "type": "string", + "description": "type on device" + }, + "management_domain": { + "type": "string", + "description": "management domain " + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "member", + "management_domain", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "additional_param_log_forwarding_type": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "Comparator": { + "type": "object" + }, + "SingleServiceDTO": { + "type": "object", + "properties": { + "protocol": { + "type": "string", + "format": "int16", + "description": "The port number, for IP service: protocol is not specified." + }, + "min": { + "type": "integer", + "format": "int32", + "description": "For IP, TCP and UDP Services: the minimum port number, ICMP Service: the ICMP type number." + }, + "max": { + "type": "integer", + "format": "int32", + "description": "For IP, TCP and UDP Services: the maximum port number." + }, + "negate": { + "type": "boolean", + "description": "Negates the defined port(s), that is: the defined port(s) are ignored, and only all other logs are analyzed." + }, + "timeout": { + "type": "string", + "description": "The timeout value for the service in seconds" + }, + "icmp_code": { + "type": "integer", + "format": "int32", + "description": "The icmp code" + }, + "minSource": { + "type": "integer", + "format": "int32", + "description": "For IP, TCP and UDP Services: the minimum source port number, ICMP Service: the ICMP type number." + }, + "maxSource": { + "type": "integer", + "format": "int32", + "description": "For IP, TCP and UDP Services: the maximum source port number." + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "type_on_device": { + "type": "string", + "description": "type on device" + }, + "management_domain": { + "type": "string", + "description": "management domain " + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "management_domain", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "NetworkObjectDTO": { + "type": "object", + "properties": { + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "nat_info", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "CheckpointNatInfoDTO": { + "type": "object", + "properties": { + "checkpoint_nat_type": { + "type": "string", + "description": "checkpoint nat type" + }, + "mapped_to_ip": { + "type": "string", + "description": "mapped to ip" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "Object ID of NAT info" + }, + "interface_name": { + "type": "string", + "description": "Interface name of NAT info" + } + }, + "required": [ + "id", + "interface_name" + ] + }, + "VipMappingDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "Vip mapping object ID" + }, + "mapped_to_service": { + "$ref": "#/components/schemas/ServiceDTO" + }, + "version_id": { + "type": "integer", + "format": "int32", + "description": "version ip" + }, + "virtual_port": { + "type": "string", + "description": "virtual port" + }, + "mapped_to_ip": { + "type": "string", + "description": "mapped to ip" + } + } + }, + "NatInfoDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "Object ID of NAT info" + }, + "interface_name": { + "type": "string", + "description": "Interface name of NAT info" + } + }, + "required": [ + "id", + "interface_name" + ] + }, + "MipNatInfoDTO": { + "type": "object", + "properties": { + "mapped_to_ip": { + "type": "string", + "description": "mapped to ip" + }, + "virtual_router": { + "type": "string", + "description": "virtual router" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "Object ID of NAT info" + }, + "interface_name": { + "type": "string", + "description": "Interface name of NAT info" + } + }, + "required": [ + "id", + "interface_name" + ] + }, + "InterfaceForNetworkObjectDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "interface_ips": { + "$ref": "#/components/schemas/InterfaceIpListDTO" + } + }, + "required": [ + "interface_ips" + ] + }, + "AdditionalParameterListDTO": { + "type": "object", + "properties": { + "additionalParameterListDTO": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdditionalParameterDTO" + } + } + } + }, + "IdentityAwarenessUserDTO": { + "type": "object", + "properties": { + "dn": { + "type": "string", + "description": "DN" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "pool_member_1": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the server group member" + }, + "ip": { + "type": "string", + "description": "The IP address of the server group member" + }, + "netmask": { + "type": "string", + "description": "The netmask for the IP address of the server group member" + } + } + }, + "LinkDTO": { + "type": "object", + "properties": { + "@href": { + "type": "string", + "description": "The location of the referenced object" + } + }, + "required": [ + "@href" + ] + }, + "VipMappingListDTO": { + "type": "object", + "properties": { + "vip_mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VipMappingDTO" + } + } + } + }, + "InterfaceIpListDTO": { + "type": "object", + "properties": { + "interface_ip": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceIpDTO" + }, + "description": "Interface IPs" + } + }, + "required": [ + "interface_ip" + ] + }, + "RangeNetworkObjectDTO": { + "type": "object", + "properties": { + "first_ip": { + "type": "string", + "description": "Min ip" + }, + "last_ip": { + "type": "string", + "description": "Max ip" + }, + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "nat_info", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "BasicNetworkObjectDTO": { + "type": "object", + "properties": { + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "nat_info", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "InterfaceIpDTO": { + "type": "object", + "properties": { + "visibility": { + "type": "string", + "description": "ip visibility (private/public)" + }, + "ip": { + "type": "string", + "description": "IP address of interface" + }, + "precedence": { + "type": "string", + "description": "ip precedence (primary/secondary)" + }, + "vendorAttachmentPolicy": { + "type": "string", + "description": "ip vendor attachment policy" + }, + "netmask": { + "type": "string", + "description": "Network mask of interface" + } + }, + "required": [ + "ip", + "netmask" + ] + }, + "behind_interface_nat_type": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "SubnetNetworkObjectDTO": { + "type": "object", + "properties": { + "ip": { + "type": "string", + "description": "The ip" + }, + "netmask": { + "type": "string", + "description": "The netmask" + }, + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "nat_info", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "additional_param_central_nat_type": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "NetworkObjectBehindGatewayDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "ip": { + "type": "string" + }, + "action": { + "type": "string" + }, + "netmask": { + "type": "string" + }, + "maxIp": { + "type": "string" + } + } + }, + "NetworkIpType": { + "type": "object" + }, + "additional_param_nat_pool_type": { + "type": "object", + "properties": { + "nat_pool_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectDTO" + }, + "description": "The NAT pool object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "CloudSecurityGroupDTO": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The members" + }, + "namespace": { + "type": "string" + }, + "exclusion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The exclusions" + }, + "access_allowed": { + "type": "boolean", + "description": "access allowed" + }, + "match_criteria": { + "type": "string" + }, + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "member", + "exclusion", + "access_allowed", + "nat_info", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "VipNatInfoDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "Object ID of NAT info" + }, + "interface_name": { + "type": "string", + "description": "Interface name of NAT info" + } + }, + "required": [ + "id", + "interface_name" + ] + }, + "VMInstanceDTO": { + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "interfaces": { + "$ref": "#/components/schemas/InterfaceForNetworkObjectListDTO" + }, + "ip": { + "type": "string", + "description": "The IP of the object" + }, + "network_object_behind_gw": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectBehindGatewayDTO" + } + }, + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "nat_info", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "additional_param_group_type": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The list of referenced objects" + }, + "extended_member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdditionalParameterDTO" + } + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "additional_param_aci_subject_name_type": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "IdentityAwarenessDTO": { + "type": "object", + "properties": { + "user": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IdentityAwarenessUserDTO" + }, + "description": "The users" + }, + "network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectDTO" + }, + "description": "The networks" + }, + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "user", + "network", + "nat_info", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "FortigateNatInfoDTO": { + "type": "object", + "properties": { + "mapped-ip-max": { + "type": "string", + "description": "mapped-ip-max" + }, + "mapped-ip": { + "type": "string", + "description": "mapped-ip" + }, + "port_forwarding_type": { + "type": "string", + "description": "port_forwarding_type" + }, + "src_filter": { + "type": "string", + "description": "src_filter" + }, + "forti_vip": { + "type": "boolean", + "description": "forti_vip" + }, + "Interface": { + "type": "string", + "description": "Interface" + }, + "external-port": { + "type": "string", + "description": "external-port" + }, + "mapped-port": { + "type": "string", + "description": "mapped-port" + }, + "src_interface_filter": { + "type": "string", + "description": "src_interface_filter" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "Object ID of NAT info" + }, + "interface_name": { + "type": "string", + "description": "Interface name of NAT info" + } + }, + "required": [ + "id", + "interface_name" + ] + }, + "FQDNIpDTO": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "subnetMask": { + "type": "string" + }, + "ipType": { + "type": "string" + } + } + }, + "additional_param_direction": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "DomainNetworkObjectDTO": { + "type": "object", + "properties": { + "domain": { + "type": "string" + }, + "ip": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FQDNIpDTO" + } + }, + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "nat_info", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "DuplicateNetworkObjectDTO": { + "type": "object", + "properties": { + "ip": { + "type": "string", + "description": "IP address" + }, + "netmask": { + "type": "string", + "description": "Netmask" + }, + "min_ip": { + "type": "string", + "description": "Minimal IP address" + }, + "max_ip": { + "type": "string", + "description": "Maximal IP address" + }, + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "nat_info", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "alias": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The members" + }, + "namespace": { + "type": "string" + }, + "exclusion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The exclusions" + }, + "access_allowed": { + "type": "boolean", + "description": "access allowed" + }, + "match_criteria": { + "type": "string" + }, + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "member", + "exclusion", + "access_allowed", + "nat_info", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "additional_param_rule_scope_type": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "URLCategoryDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The URL category's name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the URL category" + }, + "class_name": { + "type": "string", + "description": "The URL category's display name" + }, + "comment": { + "type": "string", + "description": "A comment describing the URL category" + }, + "management_domain": { + "type": "string", + "description": "The management domain of the URL category" + }, + "overrides": { + "type": "boolean", + "description": "Original value override" + }, + "overridden": { + "type": "boolean", + "description": "Original value overridden" + }, + "url": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of URLs" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + }, + "required": [ + "name", + "id", + "class_name", + "management_domain", + "overrides", + "overridden" + ] + }, + "NetworkObjectVirtualServerDTO": { + "type": "object", + "properties": { + "port": { + "type": "string", + "description": "The port that the virtual server is forwarding (Any is shown as \"-1\")" + }, + "protocol": { + "type": "string", + "description": "The protocol that the virtual server is forwarding" + }, + "netmask": { + "type": "string", + "description": "The netmask for the virtual server VIP address" + }, + "f5_device_name": { + "type": "string", + "description": "The name of the device" + }, + "virtual_ip": { + "type": "string", + "description": "The virtual IP address of the device" + }, + "pool_member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pool_member_1" + }, + "description": "The server group members that are associated with the virtual server" + }, + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + } + }, + "required": [ + "nat_info", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "application_id" + ] + }, + "HostNetworkObjectWithInterfacesDTO": { + "type": "object", + "properties": { + "interfaces": { + "$ref": "#/components/schemas/InterfaceForNetworkObjectListDTO" + }, + "ip": { + "type": "string", + "description": "The IP of the object" + }, + "network_object_behind_gw": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectBehindGatewayDTO" + } + }, + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "nat_info", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "additional_param_version_reference_type": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "UrlCategoryListDTO": { + "type": "object", + "properties": { + "url_category": { + "type": "array", + "items": { + "$ref": "#/components/schemas/URLCategoryDTO" + }, + "description": "URL Category list" + } + }, + "required": [ + "url_category" + ] + }, + "additional_param_security_profile_type": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The security profile description" + }, + "security_profile_category": { + "type": "string", + "description": "The security profile category" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "additional_param_aci_tenant_name_type": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "ObjectReferenceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the referenced object" + }, + "id": { + "type": "string", + "description": "ID" + }, + "type": { + "type": "string", + "description": "The type of the referenced object" + }, + "display_name": { + "type": "string", + "description": "The display name of the referenced object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the referenced object" + }, + "ip": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FQDNIpDTO" + } + }, + "management_domain": { + "type": "string", + "description": "The management domain from which the referenced object comes from" + }, + "link": { + "$ref": "#/components/schemas/LinkDTO" + }, + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "List of references to a DM_INLINE group members" + } + }, + "required": [ + "id" + ] + }, + "additional_param_aci_service_graph_name_type": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "HostNetworkObjectDTO": { + "type": "object", + "properties": { + "ip": { + "type": "string", + "description": "The IP of the object" + }, + "network_object_behind_gw": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectBehindGatewayDTO" + } + }, + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "nat_info", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "NetworkObjectGroupDTO": { + "type": "object", + "properties": { + "member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The members" + }, + "namespace": { + "type": "string" + }, + "exclusion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "The exclusions" + }, + "access_allowed": { + "type": "boolean", + "description": "access allowed" + }, + "match_criteria": { + "type": "string" + }, + "properties": { + "type": "string", + "format": "map" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "ip_type": { + "$ref": "#/components/schemas/NetworkIpType" + }, + "type_on_device": { + "type": "string", + "description": "The type of device" + }, + "management_domain": { + "type": "string" + }, + "any_zone": { + "type": "boolean" + }, + "implicit": { + "type": "boolean" + }, + "domain_name": { + "type": "string" + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "nat_info": { + "$ref": "#/components/schemas/NatInfoDTO" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "member", + "exclusion", + "access_allowed", + "nat_info", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "AdditionalParameterDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The identifier of the additional parameter in the revision" + }, + "display_name": { + "type": "string", + "description": "The name of the additional parameter" + }, + "name": { + "type": "string", + "description": "The name of the object" + }, + "class_name": { + "type": "string", + "description": "The class name of the object" + }, + "uid": { + "type": "string", + "description": "The unique identifier of the entity" + } + } + }, + "Map_String_String": { + "type": "object", + "properties": { + "entry": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Entry_String_String" + } + } + }, + "required": [ + "entry" + ] + }, + "Entry_String_String": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + }, + "ApplicationDTO": { + "type": "object", + "properties": { + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "management_domain": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "SingleApplicationDTO": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Application relevant services" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "management_domain": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "ApplicationGroupDTO": { + "type": "object", + "properties": { + "application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Object references list" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "management_domain": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "application", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "ApplicationListDTO": { + "type": "object", + "properties": { + "application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationDTO" + }, + "description": "Applications list" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of items that can be retrieved" + } + }, + "required": [ + "application", + "count", + "total" + ] + }, + "LocalDate": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "format": "int32" + }, + "month": { + "$ref": "#/components/schemas/Month" + } + } + }, + "LocalDate_NetworkZoneManagerSubnets": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "format": "int32" + } + } + }, + "ChangeAuthorizationBindingDTO": { + "type": "object", + "properties": { + "binding": { + "$ref": "#/components/schemas/BindingDTO" + }, + "install_on_group": { + "type": "string", + "description": "Install on groups" + }, + "policy_zone_pair": { + "$ref": "#/components/schemas/PolicyZonePairDTO" + }, + "acceptingRulesDTO": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DiffRulesDTO" + }, + "description": "Unauthorized opened access" + }, + "blockingRulesDTO": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DiffRulesDTO" + }, + "description": "Unauthorized closed access" + } + }, + "required": [ + "binding" + ] + }, + "WorkflowTicketDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "expiration_date": { + "type": "string", + "format": "date-time" + }, + "requester_display_name": { + "type": "string" + }, + "requester_email": { + "type": "string" + }, + "ticket_status": { + "$ref": "#/components/schemas/WorkflowTicketStatusType" + } + } + }, + "BindingDTO": { + "type": "object", + "properties": { + "direction": { + "type": "string", + "description": "Direction of rule set" + }, + "uid": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "acl": { + "$ref": "#/components/schemas/AclDTO" + }, + "nat_type": { + "type": "string", + "description": "Junos SRX NAT only - Type of NAT used [SOURCE, DESTINATION, STATIC_DESTINATION, STATIC_SOURCE]" + }, + "from_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "description": "Source zones of rule set" + }, + "to_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "description": "Destination zones of rule set" + }, + "postnat_iface": { + "type": "string", + "description": "External interfaces for rule set" + }, + "device_policy_id": { + "type": "integer", + "format": "int64", + "description": "StoneSoft only" + }, + "rule_count": { + "type": "integer", + "format": "int32", + "description": "Number of rules for this rule set" + }, + "binding_type": { + "$ref": "#/components/schemas/BindingType" + }, + "nat_stage": { + "type": "string", + "description": "NAT stage for rule set" + }, + "policy": { + "$ref": "#/components/schemas/ManagementPolicyDTO" + }, + "from_collection": { + "type": "string", + "description": "Junos SRX NAT only - A group of sources for the NAT rule-set [Interface, Zone, Routing Instance]" + }, + "to_collection": { + "type": "string", + "description": "Junos SRX NAT only - A group of destinations for the NAT rule-set [Interface, Zone, Routing Instance]" + }, + "policy_map_name": { + "type": "string", + "description": "Policy map name of rule set" + }, + "cloudSecurityGroupDTO": { + "$ref": "#/components/schemas/CloudSecurityGroupDTO" + }, + "security_rule_count": { + "type": "integer", + "format": "int32", + "description": "Number of security rules for this rule set" + }, + "default": { + "type": "boolean", + "description": "Is default rule set" + }, + "prenat_iface": { + "type": "string", + "description": "Internal interfaces for rule set" + }, + "from_type": { + "type": "string", + "description": "Junos SRX NAT only - Type of source for rule-set [Interface, Zone, Routing Instance]" + }, + "to_type": { + "type": "string", + "description": "Junos SRX NAT only - Type of destination for rule-set [Interface, Zone, Routing Instance]" + } + }, + "required": [ + "direction", + "acl", + "from_zone", + "to_zone", + "postnat_iface", + "rule_count", + "nat_stage", + "policy", + "policy_map_name", + "security_rule_count", + "default", + "prenat_iface" + ] + }, + "JavaLangAccess": { + "type": "object" + }, + "LocalTime": { + "type": "object" + }, + "LocalTime_NetworkZoneManagerSubnets": { + "type": "object" + }, + "TicketDTO": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The id of the ticket" + }, + "source": { + "type": "string", + "description": "The source of the ticket" + } + }, + "required": [ + "id", + "source" + ] + }, + "RuleTrackDTO": { + "type": "object", + "properties": { + "level": { + "type": "string", + "description": "Tracking level of rule" + }, + "interval": { + "type": "string", + "description": "Tracking interval of rule" + } + }, + "required": [ + "level", + "interval" + ] + }, + "RevisionManualAuthorizationDTO": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The last authorization status given manually to the revision" + }, + "user": { + "type": "string", + "description": "The user who last changed the authorization status" + }, + "dateTime": { + "type": "string", + "description": "The date and time of the last manual authorization status" + } + }, + "required": [ + "status", + "user", + "dateTime" + ] + }, + "DiffRulesDTO": { + "type": "object", + "properties": { + "old_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityRuleDTO" + }, + "description": "Old security rules list" + }, + "new_rule": { + "$ref": "#/components/schemas/SecurityRuleDTO" + }, + "rule_violated_traffic": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityRuleWithTrafficViolationDTO" + }, + "description": "Violated traffic contained in rule" + } + } + }, + "RevisionCommentDTO": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of revision comment" + }, + "comment": { + "type": "string", + "description": "Revision comment" + }, + "editor": { + "type": "string", + "description": "Editor of revision comment" + } + }, + "required": [ + "date", + "comment", + "editor" + ] + }, + "BindingType": { + "type": "object" + }, + "SectionNatRuleDTO": { + "type": "object", + "properties": { + "header": { + "type": "string" + }, + "id": { + "type": "string" + }, + "order": { + "type": "integer", + "format": "int64" + }, + "uid": { + "type": "string" + }, + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingDTO" + }, + "description": "Bindings list for NAT rule" + } + }, + "required": [ + "binding" + ] + }, + "InterfaceDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of interface" + }, + "implicit": { + "type": "boolean", + "description": "Is an implicit interface" + }, + "direction": { + "type": "string", + "description": "The direction of the interface" + }, + "zone_id": { + "type": "integer", + "format": "int64", + "description": "The ID of the mapped zone" + }, + "uid": { + "type": "string", + "description": "The UID of interface" + }, + "global": { + "type": "boolean", + "description": "Is a global interface" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "Device ID for interface" + }, + "interface_ips": { + "$ref": "#/components/schemas/InterfaceIpListDTO" + }, + "acl_name": { + "type": "string", + "description": "ACL name of the interface" + }, + "name": { + "type": "string", + "description": "The name of the object" + } + }, + "required": [ + "id", + "implicit", + "direction", + "zone_id", + "uid", + "global", + "device_id", + "interface_ips", + "acl_name", + "name" + ] + }, + "RuleDocumentationDTO": { + "type": "object", + "properties": { + "last_modified": { + "type": "string", + "description": "The date this rule was last modified" + }, + "comment": { + "type": "string", + "description": "The rule comment" + }, + "legacy_rule": { + "type": "boolean", + "description": "Designer and Verifier will treat the specified rule as a shadowed rule when making recommendations or verifying access" + }, + "stealth_rule": { + "type": "boolean", + "description": "Designer and Verifier will treat the specified rule as a stealth rule when making recommendations or verifying access" + }, + "tech_owner": { + "type": "string", + "description": "The techinal owner" + }, + "record_set": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleDocumentationRecordDTO" + }, + "description": "Documentation records for this rule" + }, + "violation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ViolationMetadataDTO" + }, + "description": "List of violations for this rule" + }, + "last_hit": { + "type": "string", + "description": " The date of rule last hit" + }, + "permissiveness_level": { + "type": "string", + "description": "The rule permissiveness score" + }, + "certification_status": { + "$ref": "#/components/schemas/CertificationStatus" + }, + "certification_date": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "certification_expiration_date": { + "$ref": "#/components/schemas/LocalDateTime" + }, + "shadowed": { + "type": "string", + "description": "The rule shadowed status" + }, + "secure_app_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SaApplicationDTO" + }, + "description": "SecureApp applications for this rule" + } + }, + "required": [ + "comment", + "legacy_rule", + "stealth_rule", + "tech_owner", + "record_set", + "violation", + "permissiveness_level", + "shadowed", + "secure_app_application" + ] + }, + "CertificationStatus": { + "type": "object" + }, + "IpType": { + "type": "object", + "properties": { + "ipv4": { + "type": "boolean" + }, + "ipv6": { + "type": "boolean" + } + } + }, + "RuleDocumentationRecordDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "Rule documentation ID" + }, + "expireDate": { + "type": "string", + "format": "date-time", + "description": "Expiration date for rule tickets" + }, + "ticketStatus": { + "$ref": "#/components/schemas/WorkflowTicketStatusType" + }, + "ticketCr": { + "type": "string", + "description": "Ticket information for rule" + }, + "businessOwnerName": { + "type": "string", + "description": "Business owner name for rule" + }, + "businessOwnerEmail": { + "type": "string", + "description": "Business owner Email address for rule" + }, + "ticketOrigin": { + "type": "string", + "description": "Ticketing system source of the specified ID. Supported values: 'scw'" + } + }, + "required": [ + "id", + "expireDate", + "ticketStatus", + "ticketCr", + "businessOwnerName", + "businessOwnerEmail" + ] + }, + "RangeDTO": { + "type": "object", + "properties": { + "from": { + "type": "string" + }, + "to": { + "type": "string" + } + } + }, + "InterfaceListDTO": { + "type": "object", + "properties": { + "interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BasicInterfaceDTO" + }, + "description": "interfaces list" + } + } + }, + "PolicyBlockBindingDTO": { + "type": "object", + "properties": { + "policy_block_name": { + "type": "string", + "description": "policy block name" + }, + "direction": { + "type": "string", + "description": "Direction of rule set" + }, + "uid": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "acl": { + "$ref": "#/components/schemas/AclDTO" + }, + "nat_type": { + "type": "string", + "description": "Junos SRX NAT only - Type of NAT used [SOURCE, DESTINATION, STATIC_DESTINATION, STATIC_SOURCE]" + }, + "from_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "description": "Source zones of rule set" + }, + "to_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "description": "Destination zones of rule set" + }, + "postnat_iface": { + "type": "string", + "description": "External interfaces for rule set" + }, + "device_policy_id": { + "type": "integer", + "format": "int64", + "description": "StoneSoft only" + }, + "rule_count": { + "type": "integer", + "format": "int32", + "description": "Number of rules for this rule set" + }, + "binding_type": { + "$ref": "#/components/schemas/BindingType" + }, + "nat_stage": { + "type": "string", + "description": "NAT stage for rule set" + }, + "policy": { + "$ref": "#/components/schemas/ManagementPolicyDTO" + }, + "from_collection": { + "type": "string", + "description": "Junos SRX NAT only - A group of sources for the NAT rule-set [Interface, Zone, Routing Instance]" + }, + "to_collection": { + "type": "string", + "description": "Junos SRX NAT only - A group of destinations for the NAT rule-set [Interface, Zone, Routing Instance]" + }, + "policy_map_name": { + "type": "string", + "description": "Policy map name of rule set" + }, + "cloudSecurityGroupDTO": { + "$ref": "#/components/schemas/CloudSecurityGroupDTO" + }, + "security_rule_count": { + "type": "integer", + "format": "int32", + "description": "Number of security rules for this rule set" + }, + "default": { + "type": "boolean", + "description": "Is default rule set" + }, + "prenat_iface": { + "type": "string", + "description": "Internal interfaces for rule set" + }, + "from_type": { + "type": "string", + "description": "Junos SRX NAT only - Type of source for rule-set [Interface, Zone, Routing Instance]" + }, + "to_type": { + "type": "string", + "description": "Junos SRX NAT only - Type of destination for rule-set [Interface, Zone, Routing Instance]" + } + }, + "required": [ + "policy_block_name", + "direction", + "acl", + "from_zone", + "to_zone", + "postnat_iface", + "rule_count", + "nat_stage", + "policy", + "policy_map_name", + "security_rule_count", + "default", + "prenat_iface" + ] + }, + "SaApplicationDTO": { + "type": "object", + "properties": { + "app_name": { + "type": "string", + "description": "Application name" + }, + "app_owner": { + "type": "string", + "description": "Application owner" + } + } + }, + "Old2NewMapping": { + "type": "object", + "properties": { + "newId": { + "type": "string" + }, + "oldId": { + "type": "string" + } + } + }, + "AclDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name for ACL" + }, + "interfaces": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceDTO" + }, + "description": "Interfaces for ACL" + }, + "global": { + "type": "boolean", + "description": "Is ACL global" + }, + "ipv6_only": { + "type": "boolean", + "description": "Is ipv6 only ACL " + } + }, + "required": [ + "name", + "interfaces", + "global", + "ipv6_only" + ] + }, + "PolicyTargetDTO": { + "type": "object", + "properties": { + "device_id": { + "type": "integer", + "format": "int32" + }, + "firewall_id": { + "type": "string" + }, + "virtual_firewall_name": { + "type": "string" + }, + "virtual_firewall_securetrack_name": { + "type": "string" + } + } + }, + "ManagementDomainPolicyDTO": { + "type": "object", + "properties": { + "installable_target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyTargetDTO" + } + }, + "name": { + "type": "string", + "description": "Name" + }, + "package": { + "type": "string", + "description": "Package that the policy belons to. Relevant only Fortinet" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "ID" + }, + "admin_domain": { + "type": "string", + "description": "Admin domain name" + }, + "itg_id": { + "type": "integer", + "format": "int32", + "description": "Installation target group ID" + }, + "itg": { + "type": "string", + "description": "Installation target group name" + }, + "unique_active_in_itg": { + "type": "boolean", + "description": "Unique active installation target group" + }, + "admin_domain_id": { + "type": "integer", + "format": "int64", + "description": "Admin domain ID" + } + }, + "required": [ + "name", + "id", + "admin_domain", + "itg_id", + "itg", + "unique_active_in_itg", + "admin_domain_id" + ] + }, + "WorkflowTicketStatusType": { + "type": "object" + }, + "UUID": { + "type": "object" + }, + "PolicyTrafficComparisonRequest": { + "type": "object", + "properties": { + "withTraffic": { + "type": "boolean" + }, + "newVersionId": { + "type": "integer", + "format": "int32" + }, + "oldVersionId": { + "type": "integer", + "format": "int32" + }, + "oldId2newIdMap": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Old2NewMapping" + } + } + } + }, + "SecurityRuleDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name" + }, + "members": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Members" + }, + "time": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Time" + }, + "comment": { + "type": "string", + "description": "Comment" + }, + "option": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Options" + }, + "application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Applications" + }, + "install": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Installed-ons" + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Users" + }, + "src_zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "source zones" + }, + "dst_zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "destination zones" + }, + "user_access": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "User access" + }, + "fmg_from_zone": { + "type": "string", + "description": "Fortimanager source zone" + }, + "fmg_to_zone": { + "type": "string", + "description": "Fortimanager destination zone" + }, + "sub_policy": { + "type": "string", + "description": "Sub policy" + }, + "sub_policy_uid": { + "$ref": "#/components/schemas/UUID" + }, + "sub_policy_shared": { + "type": "boolean", + "description": "Sub policy shared" + }, + "sub_policy_global": { + "type": "boolean", + "description": "Sub policy global" + }, + "rule_location": { + "type": "string", + "description": "Rule Location" + }, + "acceleration_breaker": { + "type": "boolean", + "description": "Acceleration breaker" + }, + "authentication_rule": { + "type": "boolean", + "description": "Authentication rule" + }, + "disabled": { + "type": "boolean", + "description": "Is disabled" + }, + "external": { + "type": "boolean", + "description": "Is external" + }, + "src_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Source networks" + }, + "dst_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Destination networks" + }, + "src_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Source services" + }, + "dst_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Destination services" + }, + "textual_rep": { + "type": "string", + "description": "the textual representation of this rule" + }, + "rule_type": { + "type": "string", + "description": "rule_type" + }, + "is_vpn": { + "type": "boolean", + "description": "Is vpn" + }, + "action": { + "type": "string", + "description": "Rule action" + }, + "rule_number": { + "type": "integer", + "format": "int64", + "description": "Rule number" + }, + "display_rule_number": { + "type": "string", + "description": "Display Rule number" + }, + "track": { + "$ref": "#/components/schemas/RuleTrackDTO" + }, + "implicit": { + "type": "boolean", + "description": "Is implicit" + }, + "criteria": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Criteria" + }, + "src_zone_any": { + "type": "boolean", + "description": "is source zone any " + }, + "dst_zone_any": { + "type": "boolean", + "description": "is destination zone any " + }, + "url_category": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "URL categories" + }, + "documentation": { + "$ref": "#/components/schemas/RuleDocumentationDTO" + }, + "global_location": { + "type": "string", + "description": "Global Location" + }, + "vpn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "VPN" + }, + "rule_location_display": { + "type": "string", + "description": "Rule Location Display" + }, + "src_networks_negated": { + "type": "boolean", + "description": "Negated source networks" + }, + "dest_networks_negated": { + "type": "boolean", + "description": "Negated destination networks" + }, + "src_services_negated": { + "type": "boolean", + "description": "Negated source services" + }, + "dest_services_negated": { + "type": "boolean", + "description": "Negated destination services" + }, + "associatedNatRule": { + "$ref": "#/components/schemas/NatRuleDTO" + }, + "id": { + "type": "string", + "description": "The ID of the rule" + }, + "order": { + "type": "integer", + "format": "int64", + "description": "The Order of the rule" + }, + "uid": { + "type": "string", + "description": "The UID of the rule" + }, + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingDTO" + }, + "description": "The bindings of the rule" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID for this rule" + }, + "cp_uid": { + "type": "string", + "description": "The CheckPoint UID of the rule" + } + }, + "required": [ + "src_networks_negated", + "dest_networks_negated", + "src_services_negated", + "dest_services_negated", + "id", + "order", + "uid", + "binding", + "cp_uid" + ] + }, + "TranslationNatRuleDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "install": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Install-ons for rule" + }, + "disabled": { + "type": "boolean" + }, + "ruleNumber": { + "type": "integer", + "format": "int64" + }, + "nat_type": { + "type": "string" + }, + "srcNatMethod": { + "type": "string" + }, + "dstNatMethod": { + "type": "string" + }, + "serviceNatMethod": { + "type": "string" + }, + "autoNat": { + "type": "boolean" + }, + "orig_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Original services for rule" + }, + "egress_interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceDTO" + }, + "description": "Outgoing interfaces for rule" + }, + "enable_net4tonet6": { + "type": "boolean", + "description": "Enabled IPv4 to IPv6 translation" + }, + "enable_route_lookup": { + "type": "boolean", + "description": "Enabled route lookup" + }, + "set_name": { + "type": "string" + }, + "routing_instance": { + "$ref": "#/components/schemas/RoutingInstanceDTO" + }, + "id": { + "type": "string" + }, + "order": { + "type": "integer", + "format": "int64" + }, + "uid": { + "type": "string" + }, + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingDTO" + }, + "description": "Bindings list for NAT rule" + } + }, + "required": [ + "binding" + ] + }, + "ViolatedTrafficDTO": { + "type": "object", + "properties": { + "port": { + "$ref": "#/components/schemas/RangeDTO" + }, + "protocol": { + "$ref": "#/components/schemas/RangeDTO" + }, + "src": { + "$ref": "#/components/schemas/RangeDTO" + }, + "dst": { + "$ref": "#/components/schemas/RangeDTO" + } + } + }, + "BasicInterfaceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the object" + } + }, + "required": [ + "name" + ] + }, + "ChangeAuthorizationDTO": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Change authorization status" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowTicketDTO" + }, + "description": "SecureChangeWorkflow tickets" + }, + "change_authorization_binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChangeAuthorizationBindingDTO" + }, + "description": "Change authorization bindings" + }, + "new_revision": { + "$ref": "#/components/schemas/RevisionDTO" + }, + "old_revision": { + "$ref": "#/components/schemas/RevisionDTO" + } + }, + "required": [ + "status", + "ticket", + "change_authorization_binding", + "new_revision", + "old_revision" + ] + }, + "DirectionalSecurityGroupBindingDTO": { + "type": "object", + "properties": { + "direction": { + "type": "string", + "description": "Direction of rule set" + }, + "uid": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "acl": { + "$ref": "#/components/schemas/AclDTO" + }, + "nat_type": { + "type": "string", + "description": "Junos SRX NAT only - Type of NAT used [SOURCE, DESTINATION, STATIC_DESTINATION, STATIC_SOURCE]" + }, + "from_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "description": "Source zones of rule set" + }, + "to_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "description": "Destination zones of rule set" + }, + "postnat_iface": { + "type": "string", + "description": "External interfaces for rule set" + }, + "device_policy_id": { + "type": "integer", + "format": "int64", + "description": "StoneSoft only" + }, + "rule_count": { + "type": "integer", + "format": "int32", + "description": "Number of rules for this rule set" + }, + "binding_type": { + "$ref": "#/components/schemas/BindingType" + }, + "nat_stage": { + "type": "string", + "description": "NAT stage for rule set" + }, + "policy": { + "$ref": "#/components/schemas/ManagementPolicyDTO" + }, + "from_collection": { + "type": "string", + "description": "Junos SRX NAT only - A group of sources for the NAT rule-set [Interface, Zone, Routing Instance]" + }, + "to_collection": { + "type": "string", + "description": "Junos SRX NAT only - A group of destinations for the NAT rule-set [Interface, Zone, Routing Instance]" + }, + "policy_map_name": { + "type": "string", + "description": "Policy map name of rule set" + }, + "cloudSecurityGroupDTO": { + "$ref": "#/components/schemas/CloudSecurityGroupDTO" + }, + "security_rule_count": { + "type": "integer", + "format": "int32", + "description": "Number of security rules for this rule set" + }, + "default": { + "type": "boolean", + "description": "Is default rule set" + }, + "prenat_iface": { + "type": "string", + "description": "Internal interfaces for rule set" + }, + "from_type": { + "type": "string", + "description": "Junos SRX NAT only - Type of source for rule-set [Interface, Zone, Routing Instance]" + }, + "to_type": { + "type": "string", + "description": "Junos SRX NAT only - Type of destination for rule-set [Interface, Zone, Routing Instance]" + } + }, + "required": [ + "direction", + "acl", + "from_zone", + "to_zone", + "postnat_iface", + "rule_count", + "nat_stage", + "policy", + "policy_map_name", + "security_rule_count", + "default", + "prenat_iface" + ] + }, + "LocalDateTime": { + "type": "object" + }, + "LocalDateTime_NetworkZoneManagerSubnets": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "format": "int32" + } + } + }, + "ManagementPolicyDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name" + }, + "package": { + "type": "string", + "description": "Package that the policy belons to. Relevant only Fortinet" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "ID" + }, + "admin_domain": { + "type": "string", + "description": "Admin domain name" + }, + "itg_id": { + "type": "integer", + "format": "int32", + "description": "Installation target group ID" + }, + "itg": { + "type": "string", + "description": "Installation target group name" + }, + "unique_active_in_itg": { + "type": "boolean", + "description": "Unique active installation target group" + }, + "admin_domain_id": { + "type": "integer", + "format": "int64", + "description": "Admin domain ID" + } + }, + "required": [ + "name", + "id", + "admin_domain", + "itg_id", + "itg", + "unique_active_in_itg", + "admin_domain_id" + ] + }, + "RoutingInstanceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "interfaces": { + "$ref": "#/components/schemas/InterfaceListDTO" + }, + "id": { + "type": "integer", + "format": "int64" + } + } + }, + "PolicyZonePairDTO": { + "type": "object", + "properties": { + "dst_zone": { + "type": "string", + "description": "Destination zone" + }, + "src_zone": { + "type": "string", + "description": "Source zone" + } + } + }, + "SecurityRuleWithTrafficViolationDTO": { + "type": "object", + "properties": { + "rule_id": { + "type": "integer", + "format": "int64", + "description": "Old violated rule" + }, + "traffic_range": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ViolatedTrafficDTO" + }, + "description": "traffic_range" + } + } + }, + "PanoramaTranslationNatRuleDTO": { + "type": "object", + "properties": { + "additionalParameters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdditionalParameterDTO" + }, + "description": "Tags" + }, + "ruleLocation": { + "type": "string", + "description": "Rule Location" + }, + "outInterface": { + "type": "string", + "description": "Out Interface" + }, + "globalLocation": { + "type": "string", + "description": "Rule Global Location (\"before\" for PreRules, \"after\" for PostRules, empty for interzone and intrazone)" + }, + "srcZones": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "description": "Original Packet - Source Zone" + }, + "dstZones": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "description": "Original Packet - Destination Zone" + }, + "translatedSrcNetworksFallback": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectDTO" + }, + "description": "Translated Packet - Source Network Addresses Fallback (Dynamic IP)" + }, + "translatedSrcInterfacesFallback": { + "type": "string", + "description": "Translated Packet - Source Interface Fallback (Dynamic IP)" + }, + "translatedSrcInterface": { + "type": "string", + "description": "Translated Packet - Source Interface (Dynamic IP and Port)" + }, + "name": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "install": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Install-ons for rule" + }, + "disabled": { + "type": "boolean" + }, + "ruleNumber": { + "type": "integer", + "format": "int64" + }, + "nat_type": { + "type": "string" + }, + "srcNatMethod": { + "type": "string" + }, + "dstNatMethod": { + "type": "string" + }, + "serviceNatMethod": { + "type": "string" + }, + "autoNat": { + "type": "boolean" + }, + "orig_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Original services for rule" + }, + "egress_interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceDTO" + }, + "description": "Outgoing interfaces for rule" + }, + "enable_net4tonet6": { + "type": "boolean", + "description": "Enabled IPv4 to IPv6 translation" + }, + "enable_route_lookup": { + "type": "boolean", + "description": "Enabled route lookup" + }, + "set_name": { + "type": "string" + }, + "routing_instance": { + "$ref": "#/components/schemas/RoutingInstanceDTO" + }, + "id": { + "type": "string" + }, + "order": { + "type": "integer", + "format": "int64" + }, + "uid": { + "type": "string" + }, + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingDTO" + }, + "description": "Bindings list for NAT rule" + } + }, + "required": [ + "binding" + ] + }, + "NatRuleDTO": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "order": { + "type": "integer", + "format": "int64" + }, + "uid": { + "type": "string" + }, + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingDTO" + }, + "description": "Bindings list for NAT rule" + } + }, + "required": [ + "binding" + ] + }, + "RevisionDTO": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The globally unique ID of the revision, may be used for get /revisions/id API " + }, + "time": { + "type": "string", + "description": "The time of the revision" + }, + "date": { + "type": "string", + "description": "The date of the revision" + }, + "comment": { + "$ref": "#/components/schemas/RevisionCommentDTO" + }, + "action": { + "type": "string", + "description": "The action upon this revision was retrieved" + }, + "revisionId": { + "type": "string", + "description": "The order of the revision in the device (for example - will be 3 for the third revision in this device)" + }, + "modules_and_policy": { + "type": "string", + "format": "map", + "description": "The modules and policy names of the revision" + }, + "admin": { + "type": "string", + "description": "The administrator user which caused this revision" + }, + "guiClient": { + "type": "string", + "description": "The GUI client for revision" + }, + "auditLog": { + "type": "string", + "description": "The audit log of the revision" + }, + "policyPackage": { + "type": "string", + "description": "The policy package of the revision" + }, + "automaticAuthorizationStatus": { + "type": "string", + "description": "The authorization status calculated automatically for the revision" + }, + "firewall_status": { + "type": "boolean" + }, + "ready": { + "type": "boolean", + "description": "The status of the revision" + }, + "ticket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TicketDTO" + }, + "description": "The tickets of the revision" + }, + "authorizationStatus": { + "type": "string", + "description": "The authorization status of the changes in the revision" + }, + "manualAuthorization": { + "$ref": "#/components/schemas/RevisionManualAuthorizationDTO" + } + }, + "required": [ + "id", + "time", + "date", + "comment", + "action", + "revisionId", + "modules_and_policy", + "admin", + "guiClient", + "auditLog", + "policyPackage", + "automaticAuthorizationStatus", + "ready", + "ticket", + "authorizationStatus", + "manualAuthorization" + ] + }, + "PolicyZoneDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "ID of the zone" + }, + "global": { + "type": "boolean", + "description": "Is a global zone" + }, + "name": { + "type": "string", + "description": "The name of the object" + } + }, + "required": [ + "id", + "global", + "name" + ] + }, + "SubPolicyBindingDTO": { + "type": "object", + "properties": { + "is_global": { + "type": "boolean", + "description": "Is global sub policy set" + }, + "is_shared": { + "type": "boolean", + "description": "Is shared sub policy set" + }, + "sub_policy_name": { + "type": "string", + "description": "sub policy name" + }, + "direction": { + "type": "string", + "description": "Direction of rule set" + }, + "uid": { + "type": "string" + }, + "ip_type": { + "$ref": "#/components/schemas/IpType" + }, + "acl": { + "$ref": "#/components/schemas/AclDTO" + }, + "nat_type": { + "type": "string", + "description": "Junos SRX NAT only - Type of NAT used [SOURCE, DESTINATION, STATIC_DESTINATION, STATIC_SOURCE]" + }, + "from_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "description": "Source zones of rule set" + }, + "to_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyZoneDTO" + }, + "description": "Destination zones of rule set" + }, + "postnat_iface": { + "type": "string", + "description": "External interfaces for rule set" + }, + "device_policy_id": { + "type": "integer", + "format": "int64", + "description": "StoneSoft only" + }, + "rule_count": { + "type": "integer", + "format": "int32", + "description": "Number of rules for this rule set" + }, + "binding_type": { + "$ref": "#/components/schemas/BindingType" + }, + "nat_stage": { + "type": "string", + "description": "NAT stage for rule set" + }, + "policy": { + "$ref": "#/components/schemas/ManagementPolicyDTO" + }, + "from_collection": { + "type": "string", + "description": "Junos SRX NAT only - A group of sources for the NAT rule-set [Interface, Zone, Routing Instance]" + }, + "to_collection": { + "type": "string", + "description": "Junos SRX NAT only - A group of destinations for the NAT rule-set [Interface, Zone, Routing Instance]" + }, + "policy_map_name": { + "type": "string", + "description": "Policy map name of rule set" + }, + "cloudSecurityGroupDTO": { + "$ref": "#/components/schemas/CloudSecurityGroupDTO" + }, + "security_rule_count": { + "type": "integer", + "format": "int32", + "description": "Number of security rules for this rule set" + }, + "default": { + "type": "boolean", + "description": "Is default rule set" + }, + "prenat_iface": { + "type": "string", + "description": "Internal interfaces for rule set" + }, + "from_type": { + "type": "string", + "description": "Junos SRX NAT only - Type of source for rule-set [Interface, Zone, Routing Instance]" + }, + "to_type": { + "type": "string", + "description": "Junos SRX NAT only - Type of destination for rule-set [Interface, Zone, Routing Instance]" + } + }, + "required": [ + "is_global", + "is_shared", + "sub_policy_name", + "direction", + "acl", + "from_zone", + "to_zone", + "postnat_iface", + "rule_count", + "nat_stage", + "policy", + "policy_map_name", + "security_rule_count", + "default", + "prenat_iface" + ] + }, + "ViolationMetadataDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the violation" + }, + "type": { + "type": "string", + "description": "The type of the violation" + } + }, + "required": [ + "name", + "type" + ] + }, + "Policy": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/CommitStatus" + }, + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Target" + } + }, + "warning": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CommitTaskStatus": { + "type": "object" + }, + "Device": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "status": { + "$ref": "#/components/schemas/CommitTaskStatus" + }, + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "policy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Policy" + } + }, + "revision_id": { + "type": "integer", + "format": "int32" + }, + "warning": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Device_NetworkZoneManagerSubnets": { + "type": "object", + "properties": { + "parent": { + "$ref": "#/components/schemas/Device_NetworkZoneManagerSubnets" + }, + "port": { + "type": "integer", + "format": "int32" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Device_NetworkZoneManagerSubnets" + } + }, + "started": { + "type": "boolean" + }, + "fw1RegularLogMode": { + "type": "string" + }, + "offline": { + "type": "boolean" + }, + "softwareVersion": { + "type": "string" + }, + "disabled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceGroup" + } + }, + "latestRevision": { + "$ref": "#/components/schemas/Revision" + }, + "toBeDeleted": { + "type": "boolean" + }, + "zoneBased": { + "type": "boolean" + }, + "plugin": { + "$ref": "#/components/schemas/StPlugin" + }, + "hasTopology": { + "type": "boolean" + }, + "moduleUid": { + "type": "string" + }, + "moduleType": { + "type": "string" + }, + "objectUsageMode": { + "type": "string" + }, + "ruleOptimizerMode": { + "type": "string" + }, + "proxyServer": { + "$ref": "#/components/schemas/ProxyServer" + }, + "secondaryCertificateId": { + "type": "integer", + "format": "int32" + }, + "isCluster": { + "type": "boolean" + }, + "isAsbr": { + "type": "boolean" + }, + "ignoreSshKeyMismatch": { + "type": "boolean" + }, + "cipher": { + "type": "string" + }, + "sshVersion": { + "type": "string" + }, + "managementSecondaryIp": { + "type": "string" + }, + "deviceUserName": { + "type": "string" + }, + "certificateId": { + "type": "integer", + "format": "int32" + }, + "leaOpsecClientDn": { + "type": "string" + }, + "cpmiOpsecClientDn": { + "type": "string" + }, + "logAssociatedCma": { + "$ref": "#/components/schemas/Device_NetworkZoneManagerSubnets" + }, + "auditLogSourceId": { + "$ref": "#/components/schemas/Device_NetworkZoneManagerSubnets" + }, + "server": { + "$ref": "#/components/schemas/StServer" + }, + "parentManagement": { + "$ref": "#/components/schemas/Device_NetworkZoneManagerSubnets" + }, + "containedIn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AtnTDeviceGroup" + } + }, + "revisions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Revision" + } + }, + "cloudOrganization": { + "$ref": "#/components/schemas/CloudOrganization" + }, + "routingTableEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RoutingTableEntry" + } + }, + "mplsVpnLabels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MplsVpnLabel" + } + }, + "treeRevision": { + "$ref": "#/components/schemas/Revision" + }, + "snmpPort": { + "type": "string" + }, + "devicePassword": { + "type": "string" + }, + "deviceUseEnable": { + "type": "boolean" + }, + "deviceEnablePassword": { + "type": "string" + }, + "deviceLoginUserName": { + "type": "string" + }, + "apiVersion": { + "type": "string" + }, + "deviceLoginPassword": { + "type": "string" + }, + "opsecStatus": { + "type": "string" + }, + "ruleUsageStatus": { + "type": "string" + }, + "monitoringUseDefault": { + "type": "boolean" + }, + "dynamicTopologyDataMode": { + "type": "string" + }, + "leaAuth": { + "type": "string" + }, + "leaPort": { + "type": "string" + }, + "fw1AuditLogFile": { + "type": "string" + }, + "fw1RegularLogFile": { + "type": "string" + }, + "cpmiAuth": { + "type": "string" + }, + "cpmiPort": { + "type": "string" + }, + "deviceTerminalType": { + "$ref": "#/components/schemas/TerminalType" + }, + "monitoringMode": { + "$ref": "#/components/schemas/MonitoringMode" + }, + "mode": { + "$ref": "#/components/schemas/ModeType" + }, + "managementStatus": { + "$ref": "#/components/schemas/ManagementStatus" + }, + "syslogProtocol": { + "type": "string" + }, + "notificationProtocl": { + "type": "string" + }, + "syslogId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "hostName": { + "type": "string" + }, + "contextName": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "cpType": { + "type": "string" + }, + "deviceType": { + "type": "string" + }, + "virtualType": { + "type": "string" + }, + "firewallId": { + "type": "string" + }, + "virtualContext": { + "type": "boolean" + }, + "domain": { + "$ref": "#/components/schemas/Domain" + }, + "uid": { + "type": "string" + } + } + }, + "CommitTarget": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/CommitMetadata" + }, + "warnings": { + "$ref": "#/components/schemas/Collection" + } + } + }, + "DeviceCommit": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "result": { + "$ref": "#/components/schemas/Result" + } + } + }, + "CommitMetadata": { + "type": "object", + "properties": { + "displayName": { + "type": "string" + }, + "managementId": { + "type": "integer", + "format": "int32" + }, + "lastInstallVersionId": { + "type": "integer", + "format": "int32" + }, + "currentVersionId": { + "type": "integer", + "format": "int32" + } + } + }, + "Result": { + "type": "object", + "properties": { + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "device": { + "$ref": "#/components/schemas/Device" + } + } + }, + "ChangeWindowsDTO": { + "type": "object", + "properties": { + "change_window": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChangeWindowDTO" + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of items that can be retrieved" + } + }, + "required": [ + "count", + "total" + ] + }, + "Target": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "display_name": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/CommitStatus" + }, + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "warning": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CommitTasks": { + "type": "object", + "properties": { + "commit_task": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommitTask" + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of items that can be retrieved" + } + }, + "required": [ + "count", + "total" + ] + }, + "PoliciesTargetsDTO": { + "type": "object", + "properties": { + "policy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommitPolicy" + } + } + } + }, + "CommitStatus": { + "type": "object" + }, + "CommitPolicy": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "targets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommitTarget" + } + } + } + }, + "Collection": { + "type": "object" + }, + "ChangeWindowDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "enabled": { + "type": "boolean", + "description": "Active flag" + }, + "description": { + "type": "string" + }, + "domain_id": { + "type": "integer", + "format": "int32" + }, + "uuid": { + "type": "string" + } + }, + "required": [ + "name", + "enabled", + "domain_id", + "uuid" + ] + }, + "CommitTask": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "error": { + "type": "array", + "items": { + "type": "string" + } + }, + "start_date": { + "type": "string" + }, + "end_date": { + "type": "string" + }, + "device_commit": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceCommit" + } + } + } + }, + "MdomZoneDTO": { + "type": "object", + "properties": { + "interface_mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MdomZoneToInterfaceMappingDTO" + } + }, + "id": { + "type": "integer", + "format": "int64", + "description": "ID of the zone" + }, + "global": { + "type": "boolean", + "description": "Is a global zone" + }, + "name": { + "type": "string", + "description": "The name of the object" + } + }, + "required": [ + "id", + "global", + "name" + ] + }, + "BindableObjectDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the object" + } + }, + "required": [ + "name" + ] + }, + "BindableObjectListDTO": { + "type": "object", + "properties": { + "bindableObjectListDTO": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindableObjectDTO" + } + } + } + }, + "MdomZoneToInterfaceMappingDTO": { + "type": "object", + "properties": { + "device_id": { + "type": "integer", + "format": "int32", + "description": "Device id" + }, + "interface_name": { + "type": "string", + "description": "interface name" + } + }, + "required": [ + "device_id", + "interface_name" + ] + }, + "PolicyZoneListDTO": { + "type": "object", + "properties": { + "zones": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyZoneDTO" + } + } + } + }, + "DomainListDTO": { + "type": "object", + "properties": { + "domain": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DomainDTO" + } + } + } + }, + "DomainDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The Name" + }, + "id": { + "type": "string", + "description": "The id" + }, + "address": { + "type": "string", + "description": "The Address" + }, + "description": { + "type": "string", + "description": "The Description" + } + }, + "required": [ + "name" + ] + }, + "SecureChangeAddressDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The IP type: external / internal" + }, + "ip_address": { + "type": "string", + "description": "The IP address" + } + }, + "required": [ + "type", + "ip_address" + ] + }, + "PropertiesDTO": { + "type": "object", + "properties": { + "secure_change_address": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecureChangeAddressDTO" + }, + "description": "List of SecureChange IPs" + }, + "property": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyDTO" + }, + "description": "List of general properties" + } + }, + "required": [ + "property" + ] + }, + "PropertyDTO": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Property value" + }, + "key": { + "type": "string", + "description": "Property name" + } + } + }, + "IpsecTunnelDTO": { + "type": "object", + "properties": { + "local_address": { + "type": "string", + "description": "IPSec tunnel local address" + }, + "ipsec_tunnel_entries": { + "$ref": "#/components/schemas/IpsecTunnelEntryListDTO" + } + }, + "required": [ + "local_address", + "ipsec_tunnel_entries" + ] + }, + "SatelliteGatewayDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "ip": { + "type": "string" + }, + "subnetsBehindGateway": { + "$ref": "#/components/schemas/SubnetsBehindGatewayDTO" + } + } + }, + "CryptoMapEntryPeerListDTO": { + "type": "object", + "properties": { + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "IPSec tunnel crypto map peers' list of IPs" + } + }, + "required": [ + "ip" + ] + }, + "IpsecSatellitesRouting": { + "type": "object" + }, + "CryptoMapListDTO": { + "type": "object", + "properties": { + "crypto_map": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CryptoMapDTO" + } + } + } + }, + "ParticipentingGatewaysDTO": { + "type": "object", + "properties": { + "participating_gateway": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ParticipentGatewayDTO" + } + } + } + }, + "CryptoMapEntryListDTO": { + "type": "object" + }, + "SecurityRuleListDTO": { + "type": "object", + "properties": { + "rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityRuleDTO" + }, + "description": "Security rules" + } + } + }, + "IpsecTunnelEntryDTO": { + "type": "object", + "properties": { + "peers": { + "$ref": "#/components/schemas/CryptoMapEntryPeerListDTO" + }, + "vpn_rules": { + "$ref": "#/components/schemas/SecurityRuleListDTO" + } + }, + "required": [ + "peers", + "vpn_rules" + ] + }, + "SatelliteGatewaysDTO": { + "type": "object", + "properties": { + "satellite_gateway": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SatelliteGatewayDTO" + } + } + } + }, + "IpsecCommunityType": { + "type": "object" + }, + "CryptoMapEntryDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "crypto map entry object ID" + }, + "attached_dynamic_crypto_map": { + "$ref": "#/components/schemas/CryptoMapDTO" + }, + "seq_number": { + "type": "integer", + "format": "int32", + "description": "seq_number" + }, + "ACL": { + "type": "string", + "description": "ACL" + }, + "peers": { + "$ref": "#/components/schemas/CryptoMapEntryPeerListDTO" + } + }, + "required": [ + "id", + "attached_dynamic_crypto_map", + "seq_number", + "ACL", + "peers" + ] + }, + "ParticipentGatewayDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "ip": { + "type": "string" + }, + "subnetsBehindGateway": { + "$ref": "#/components/schemas/SubnetsBehindGatewayDTO" + } + } + }, + "IpsecTunnelEntryListDTO": { + "type": "object", + "properties": { + "ipsec_tunnel_entry": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IpsecTunnelEntryDTO" + }, + "description": "IPSec tunnel entries list" + } + }, + "required": [ + "ipsec_tunnel_entry" + ] + }, + "CryptoMapDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "crypto map object ID" + }, + "crypto_map_entries": { + "$ref": "#/components/schemas/CryptoMapEntryListDTO" + }, + "class_name": { + "type": "string", + "description": "class_name" + }, + "UID": { + "type": "string", + "description": "UID" + }, + "display_name": { + "type": "string", + "description": "display_name" + } + }, + "required": [ + "name", + "id", + "crypto_map_entries", + "class_name", + "UID", + "display_name" + ] + }, + "IpsecCommunitieEntryDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/IpsecCommunityType" + }, + "vpn_routing": { + "$ref": "#/components/schemas/IpsecSatellitesRouting" + }, + "disableNatOn": { + "type": "string" + }, + "participating_Gateways": { + "$ref": "#/components/schemas/ParticipentingGatewaysDTO" + }, + "satellite_gateways": { + "$ref": "#/components/schemas/SatelliteGatewaysDTO" + } + } + }, + "IpsecCommunitiesDTO": { + "type": "object", + "properties": { + "ipsec_community": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IpsecCommunitieEntryDTO" + } + } + }, + "required": [ + "ipsec_community" + ] + }, + "InternetReferralDTO": { + "type": "object", + "properties": { + "device_id": { + "type": "integer", + "format": "int32", + "description": "device ID" + } + }, + "required": [ + "device_id" + ] + }, + "InternetReferralObjectNameDTO": { + "type": "object", + "properties": { + "object_name": { + "type": "string", + "description": "Object name on device" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "device ID" + } + }, + "required": [ + "object_name", + "device_id" + ] + }, + "InternetReferralAnyDTO": { + "type": "object", + "properties": { + "device_id": { + "type": "integer", + "format": "int32", + "description": "device ID" + } + }, + "required": [ + "device_id" + ] + }, + "LdapOu": { + "type": "object", + "properties": { + "displayName": { + "type": "string" + }, + "uid": { + "type": "string" + }, + "dn": { + "type": "string" + } + } + }, + "LdapSearchResult": { + "type": "object", + "properties": { + "ldap_entry": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LdapEntry" + } + }, + "has_more_results_to_return": { + "type": "boolean" + } + } + }, + "LdapUser": { + "type": "object", + "properties": { + "displayName": { + "type": "string" + }, + "uid": { + "type": "string" + }, + "dn": { + "type": "string" + } + } + }, + "LdapSearchByNameCriteria": { + "type": "object", + "properties": { + "search_text": { + "type": "array", + "items": { + "type": "string" + }, + "description": "free text to search" + }, + "ldap_entry_type": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Ldap entry types: OU, GROUP" + }, + "max_search_result": { + "type": "integer", + "format": "int32", + "description": "How many LDAP entities to get in the result" + } + } + }, + "LdapGroup": { + "type": "object", + "properties": { + "displayName": { + "type": "string" + }, + "uid": { + "type": "string" + }, + "dn": { + "type": "string" + } + } + }, + "LdapSearchCriteria": { + "type": "object", + "properties": { + "search_base_dn": { + "type": "string", + "description": "Base DN entry to search from" + }, + "search_text": { + "type": "string", + "description": "Free text search" + }, + "ldap_search_options": { + "$ref": "#/components/schemas/LdapSearchOptionsDTO" + } + } + }, + "LdapSearchOptionsDTO": { + "type": "object", + "properties": { + "ldap_entry_type": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Ldap entry types: OU - organization unit, GROUP" + }, + "max_search_result": { + "type": "integer", + "format": "int32", + "description": "How many LDAP entities to get in the result" + }, + "search_mode": { + "type": "string", + "description": "search mode is relevant for free test search" + }, + "search_depth": { + "type": "string", + "description": "ONE - Search only immediate children that are exactly one level down in the hierarchy of the entry specified by the base DN, SUB - Search the entire subtree of the entry specified by the base DN. default value = SUB" + } + } + }, + "LdapEntry": { + "type": "object", + "properties": { + "displayName": { + "type": "string" + }, + "uid": { + "type": "string" + }, + "dn": { + "type": "string" + } + } + }, + "StatusDTO": { + "type": "object", + "properties": { + "description": { + "type": "string" + } + } + }, + "DeviceLicenseStatusDTO": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The license category or feature type (4 options are available: SecureTrack, SecureChange, Provisioning, OS Monitoring)" + }, + "expiration": { + "type": "string", + "description": "ISO date of the license expiration date (last day when this license is valid)" + }, + "used": { + "type": "integer", + "format": "int32", + "description": "Number of used units" + }, + "status": { + "type": "string", + "description": "License status, e.g., licensed, expired, plug&play, unlicensed, etc." + }, + "sku": { + "type": "string", + "description": "The actual SKU name used by this device" + } + }, + "required": [ + "type", + "status" + ] + }, + "DeviceTasksDTO": { + "type": "object", + "properties": { + "task_count": { + "type": "integer", + "format": "int32" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "device_name": { + "type": "string" + } + } + }, + "TaskResultDTO": { + "type": "object", + "properties": { + "in_progress": { + "$ref": "#/components/schemas/DevicesResultsDTO" + }, + "failed": { + "$ref": "#/components/schemas/DevicesResultsDTO" + }, + "succeeded": { + "$ref": "#/components/schemas/DevicesResultsDTO" + } + } + }, + "QueueSizeConfigDTO": { + "type": "object", + "properties": { + "config": { + "type": "string", + "format": "map" + } + } + }, + "DeviceDataDTO": { + "type": "object", + "properties": { + "vaultServer": { + "type": "string" + }, + "collectRuleUsage": { + "type": "boolean" + }, + "collectObjectUsage": { + "type": "boolean" + }, + "deviceDataChangeFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FieldNames" + } + }, + "ruleOptimizerUsage": { + "type": "boolean" + } + } + }, + "JsonNode": { + "type": "object" + }, + "Entry_String_Integer": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "integer" + } + }, + "required": [ + "key", + "value" + ] + }, + "DevicesResultsDTO": { + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceResultDTO" + } + } + } + }, + "Logger": { + "type": "object" + }, + "DevicesListDTO": { + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceDTO" + } + } + } + }, + "TaskDTO": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "ticketId": { + "type": "integer", + "format": "int64" + }, + "taskId": { + "type": "string" + }, + "insertionTimestamp": { + "type": "string", + "format": "date-time" + } + } + }, + "DetailedDeviceListDTO": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailedDeviceDTO" + }, + "description": "The devices list" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of total available elements" + } + }, + "required": [ + "device", + "count", + "total" + ] + }, + "TasksListDTO": { + "type": "object", + "properties": { + "task": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaskDTO" + } + } + } + }, + "Map_String_Integer": { + "type": "object", + "properties": { + "entry": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Entry_String_Integer" + } + } + }, + "required": [ + "entry" + ] + }, + "DetailedDeviceDTO": { + "type": "object", + "properties": { + "OS_Version": { + "type": "string", + "description": "The OS version of the firewall" + }, + "rule_usage_mode": { + "type": "string", + "description": "Rule usage mode" + }, + "status": { + "type": "string", + "description": "Device status" + }, + "context_name": { + "type": "string", + "description": "The context name of the device" + }, + "ip": { + "type": "string", + "description": "IP address of device" + }, + "latest_revision": { + "type": "string", + "description": "Latest revision of device" + }, + "virtual_type": { + "type": "string", + "description": "The virtual type of the device" + }, + "parent_id": { + "type": "integer", + "format": "int32", + "description": "The parent ID of the device" + }, + "module_type": { + "type": "string", + "description": "Module type" + }, + "object_usage_mode": { + "type": "string", + "description": "Object usage mode" + }, + "rule_optimizer_mode": { + "type": "string", + "description": "Rule optimizer mode" + }, + "installed_policy": { + "type": "string", + "description": "Installed policy currently active on the device" + }, + "license": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceLicenseStatusDTO" + }, + "description": "Licensing information" + }, + "name": { + "type": "string", + "description": "The name of the device" + }, + "id": { + "type": "string", + "description": "The ID of the device" + }, + "offline": { + "type": "boolean", + "description": "Device is offline" + }, + "model": { + "type": "string", + "description": "The model of the device" + }, + "vendor": { + "type": "string", + "description": "The vendor of the device" + }, + "domain_id": { + "type": "string", + "description": "The domain identifier of the device" + }, + "domain_name": { + "type": "string", + "description": "The domain name of the device" + }, + "module_uid": { + "type": "string" + }, + "topology": { + "type": "boolean", + "description": "Device has topology" + } + }, + "required": [ + "status", + "ip", + "latest_revision", + "name", + "offline", + "model", + "vendor", + "domain_id", + "domain_name", + "topology" + ] + }, + "FieldNames": { + "type": "object" + }, + "st_device": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the device" + }, + "id": { + "type": "string", + "description": "The ID of the device" + }, + "offline": { + "type": "boolean", + "description": "Device is offline" + }, + "model": { + "type": "string", + "description": "The model of the device" + }, + "vendor": { + "type": "string", + "description": "The vendor of the device" + }, + "domain_id": { + "type": "string", + "description": "The domain identifier of the device" + }, + "domain_name": { + "type": "string", + "description": "The domain name of the device" + }, + "module_uid": { + "type": "string" + }, + "topology": { + "type": "boolean", + "description": "Device has topology" + } + }, + "required": [ + "name", + "offline", + "model", + "vendor", + "domain_id", + "domain_name", + "topology" + ] + }, + "WaitingTasksListDTO": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceTasksDTO" + } + } + } + }, + "DeviceDTO": { + "type": "object", + "properties": { + "display_name": { + "type": "string", + "description": "required for POST, optional for PATCH" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "required for PATCH" + }, + "ip_address": { + "type": "string", + "description": "required for POST, optional for PATCH" + }, + "virtual_type": { + "type": "string" + }, + "vendor": { + "type": "string", + "description": "required for POST" + }, + "securetrack_server": { + "type": "string" + }, + "model": { + "type": "string", + "description": "required for POST" + }, + "securetrack_domain": { + "type": "string" + }, + "deviceDataDTO": { + "$ref": "#/components/schemas/DeviceDataDTO" + }, + "enable_vault": { + "type": "boolean" + }, + "enable_topology": { + "type": "boolean" + }, + "sslCertificateIdOnRC": { + "type": "integer", + "format": "int32" + }, + "sslCertificateOnRC": { + "type": "string" + }, + "vpc_auto_import": { + "type": "boolean" + }, + "vnet_auto_import": { + "type": "boolean" + }, + "importedDomainName": { + "type": "string" + } + }, + "required": [ + "display_name", + "device_id", + "ip_address", + "vendor", + "model" + ] + }, + "DeviceResultDTO": { + "type": "object", + "properties": { + "display_name": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/StatusDTO" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "ip_address": { + "type": "string" + } + } + }, + "AbortTaskRequestDTO": { + "type": "object", + "properties": { + "deviceId": { + "type": "integer", + "format": "int32" + }, + "taskId": { + "type": "string" + } + } + }, + "NatRuleListDTO": { + "type": "object", + "properties": { + "natRuleListDTO": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NatRuleDTO" + } + } + } + }, + "NetworkObjectListDTO": { + "type": "object", + "properties": { + "network_object": { + "$ref": "#/components/schemas/void" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of items that can be retrieved" + } + }, + "required": [ + "network_object", + "count", + "total" + ] + }, + "ClassMapDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + } + }, + "acl_name": { + "type": "string" + } + } + }, + "RuleListDTO": { + "type": "object", + "properties": { + "rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleDTO" + }, + "description": "The rules list" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of total available elements" + } + }, + "required": [ + "rule", + "count", + "total" + ] + }, + "ZBSecurityRuleDTO": { + "type": "object", + "properties": { + "effectiveAction": { + "type": "string", + "description": "Effective action" + }, + "classMap": { + "$ref": "#/components/schemas/ClassMapDTO" + }, + "name": { + "type": "string", + "description": "Name" + }, + "members": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Members" + }, + "time": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Time" + }, + "comment": { + "type": "string", + "description": "Comment" + }, + "option": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Options" + }, + "application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Applications" + }, + "install": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Installed-ons" + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Users" + }, + "src_zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "source zones" + }, + "dst_zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "destination zones" + }, + "user_access": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "User access" + }, + "fmg_from_zone": { + "type": "string", + "description": "Fortimanager source zone" + }, + "fmg_to_zone": { + "type": "string", + "description": "Fortimanager destination zone" + }, + "sub_policy": { + "type": "string", + "description": "Sub policy" + }, + "sub_policy_uid": { + "$ref": "#/components/schemas/UUID" + }, + "sub_policy_shared": { + "type": "boolean", + "description": "Sub policy shared" + }, + "sub_policy_global": { + "type": "boolean", + "description": "Sub policy global" + }, + "rule_location": { + "type": "string", + "description": "Rule Location" + }, + "acceleration_breaker": { + "type": "boolean", + "description": "Acceleration breaker" + }, + "authentication_rule": { + "type": "boolean", + "description": "Authentication rule" + }, + "disabled": { + "type": "boolean", + "description": "Is disabled" + }, + "external": { + "type": "boolean", + "description": "Is external" + }, + "src_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Source networks" + }, + "dst_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Destination networks" + }, + "src_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Source services" + }, + "dst_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Destination services" + }, + "textual_rep": { + "type": "string", + "description": "the textual representation of this rule" + }, + "rule_type": { + "type": "string", + "description": "rule_type" + }, + "is_vpn": { + "type": "boolean", + "description": "Is vpn" + }, + "action": { + "type": "string", + "description": "Rule action" + }, + "rule_number": { + "type": "integer", + "format": "int64", + "description": "Rule number" + }, + "display_rule_number": { + "type": "string", + "description": "Display Rule number" + }, + "track": { + "$ref": "#/components/schemas/RuleTrackDTO" + }, + "implicit": { + "type": "boolean", + "description": "Is implicit" + }, + "criteria": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Criteria" + }, + "src_zone_any": { + "type": "boolean", + "description": "is source zone any " + }, + "dst_zone_any": { + "type": "boolean", + "description": "is destination zone any " + }, + "url_category": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "URL categories" + }, + "documentation": { + "$ref": "#/components/schemas/RuleDocumentationDTO" + }, + "global_location": { + "type": "string", + "description": "Global Location" + }, + "vpn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "VPN" + }, + "rule_location_display": { + "type": "string", + "description": "Rule Location Display" + }, + "src_networks_negated": { + "type": "boolean", + "description": "Negated source networks" + }, + "dest_networks_negated": { + "type": "boolean", + "description": "Negated destination networks" + }, + "src_services_negated": { + "type": "boolean", + "description": "Negated source services" + }, + "dest_services_negated": { + "type": "boolean", + "description": "Negated destination services" + }, + "associatedNatRule": { + "$ref": "#/components/schemas/NatRuleDTO" + }, + "id": { + "type": "string", + "description": "The ID of the rule" + }, + "order": { + "type": "integer", + "format": "int64", + "description": "The Order of the rule" + }, + "uid": { + "type": "string", + "description": "The UID of the rule" + }, + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingDTO" + }, + "description": "The bindings of the rule" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID for this rule" + }, + "cp_uid": { + "type": "string", + "description": "The CheckPoint UID of the rule" + } + }, + "required": [ + "src_networks_negated", + "dest_networks_negated", + "src_services_negated", + "dest_services_negated", + "id", + "order", + "uid", + "binding", + "cp_uid" + ] + }, + "NetworkObjectLimitedListDTO": { + "type": "object", + "properties": { + "network_object": { + "$ref": "#/components/schemas/void" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of total available elements" + } + }, + "required": [ + "network_object", + "count", + "total" + ] + }, + "AciSecurityRuleDTO": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "priority" + }, + "additional_parameter_full": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdditionalParameterDTO" + }, + "description": "additional_parameter_full" + }, + "name": { + "type": "string", + "description": "Name" + }, + "members": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Members" + }, + "time": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Time" + }, + "comment": { + "type": "string", + "description": "Comment" + }, + "option": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Options" + }, + "application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Applications" + }, + "install": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Installed-ons" + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Users" + }, + "src_zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "source zones" + }, + "dst_zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "destination zones" + }, + "user_access": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "User access" + }, + "fmg_from_zone": { + "type": "string", + "description": "Fortimanager source zone" + }, + "fmg_to_zone": { + "type": "string", + "description": "Fortimanager destination zone" + }, + "sub_policy": { + "type": "string", + "description": "Sub policy" + }, + "sub_policy_uid": { + "$ref": "#/components/schemas/UUID" + }, + "sub_policy_shared": { + "type": "boolean", + "description": "Sub policy shared" + }, + "sub_policy_global": { + "type": "boolean", + "description": "Sub policy global" + }, + "rule_location": { + "type": "string", + "description": "Rule Location" + }, + "acceleration_breaker": { + "type": "boolean", + "description": "Acceleration breaker" + }, + "authentication_rule": { + "type": "boolean", + "description": "Authentication rule" + }, + "disabled": { + "type": "boolean", + "description": "Is disabled" + }, + "external": { + "type": "boolean", + "description": "Is external" + }, + "src_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Source networks" + }, + "dst_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Destination networks" + }, + "src_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Source services" + }, + "dst_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Destination services" + }, + "textual_rep": { + "type": "string", + "description": "the textual representation of this rule" + }, + "rule_type": { + "type": "string", + "description": "rule_type" + }, + "is_vpn": { + "type": "boolean", + "description": "Is vpn" + }, + "action": { + "type": "string", + "description": "Rule action" + }, + "rule_number": { + "type": "integer", + "format": "int64", + "description": "Rule number" + }, + "display_rule_number": { + "type": "string", + "description": "Display Rule number" + }, + "track": { + "$ref": "#/components/schemas/RuleTrackDTO" + }, + "implicit": { + "type": "boolean", + "description": "Is implicit" + }, + "criteria": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Criteria" + }, + "src_zone_any": { + "type": "boolean", + "description": "is source zone any " + }, + "dst_zone_any": { + "type": "boolean", + "description": "is destination zone any " + }, + "url_category": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "URL categories" + }, + "documentation": { + "$ref": "#/components/schemas/RuleDocumentationDTO" + }, + "global_location": { + "type": "string", + "description": "Global Location" + }, + "vpn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "VPN" + }, + "rule_location_display": { + "type": "string", + "description": "Rule Location Display" + }, + "src_networks_negated": { + "type": "boolean", + "description": "Negated source networks" + }, + "dest_networks_negated": { + "type": "boolean", + "description": "Negated destination networks" + }, + "src_services_negated": { + "type": "boolean", + "description": "Negated source services" + }, + "dest_services_negated": { + "type": "boolean", + "description": "Negated destination services" + }, + "associatedNatRule": { + "$ref": "#/components/schemas/NatRuleDTO" + }, + "id": { + "type": "string", + "description": "The ID of the rule" + }, + "order": { + "type": "integer", + "format": "int64", + "description": "The Order of the rule" + }, + "uid": { + "type": "string", + "description": "The UID of the rule" + }, + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingDTO" + }, + "description": "The bindings of the rule" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID for this rule" + }, + "cp_uid": { + "type": "string", + "description": "The CheckPoint UID of the rule" + } + }, + "required": [ + "src_networks_negated", + "dest_networks_negated", + "src_services_negated", + "dest_services_negated", + "id", + "order", + "uid", + "binding", + "cp_uid" + ] + }, + "CloudSecurityRuleDTO": { + "type": "object", + "properties": { + "priority": { + "type": "string" + }, + "ip_type": { + "type": "string" + }, + "name": { + "type": "string", + "description": "Name" + }, + "members": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Members" + }, + "time": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Time" + }, + "comment": { + "type": "string", + "description": "Comment" + }, + "option": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Options" + }, + "application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Applications" + }, + "install": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Installed-ons" + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Users" + }, + "src_zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "source zones" + }, + "dst_zone": { + "type": "array", + "items": { + "type": "string" + }, + "description": "destination zones" + }, + "user_access": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "User access" + }, + "fmg_from_zone": { + "type": "string", + "description": "Fortimanager source zone" + }, + "fmg_to_zone": { + "type": "string", + "description": "Fortimanager destination zone" + }, + "sub_policy": { + "type": "string", + "description": "Sub policy" + }, + "sub_policy_uid": { + "$ref": "#/components/schemas/UUID" + }, + "sub_policy_shared": { + "type": "boolean", + "description": "Sub policy shared" + }, + "sub_policy_global": { + "type": "boolean", + "description": "Sub policy global" + }, + "rule_location": { + "type": "string", + "description": "Rule Location" + }, + "acceleration_breaker": { + "type": "boolean", + "description": "Acceleration breaker" + }, + "authentication_rule": { + "type": "boolean", + "description": "Authentication rule" + }, + "disabled": { + "type": "boolean", + "description": "Is disabled" + }, + "external": { + "type": "boolean", + "description": "Is external" + }, + "src_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Source networks" + }, + "dst_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Destination networks" + }, + "src_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Source services" + }, + "dst_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Destination services" + }, + "textual_rep": { + "type": "string", + "description": "the textual representation of this rule" + }, + "rule_type": { + "type": "string", + "description": "rule_type" + }, + "is_vpn": { + "type": "boolean", + "description": "Is vpn" + }, + "action": { + "type": "string", + "description": "Rule action" + }, + "rule_number": { + "type": "integer", + "format": "int64", + "description": "Rule number" + }, + "display_rule_number": { + "type": "string", + "description": "Display Rule number" + }, + "track": { + "$ref": "#/components/schemas/RuleTrackDTO" + }, + "implicit": { + "type": "boolean", + "description": "Is implicit" + }, + "criteria": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "Criteria" + }, + "src_zone_any": { + "type": "boolean", + "description": "is source zone any " + }, + "dst_zone_any": { + "type": "boolean", + "description": "is destination zone any " + }, + "url_category": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "URL categories" + }, + "documentation": { + "$ref": "#/components/schemas/RuleDocumentationDTO" + }, + "global_location": { + "type": "string", + "description": "Global Location" + }, + "vpn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectReferenceDTO" + }, + "description": "VPN" + }, + "rule_location_display": { + "type": "string", + "description": "Rule Location Display" + }, + "src_networks_negated": { + "type": "boolean", + "description": "Negated source networks" + }, + "dest_networks_negated": { + "type": "boolean", + "description": "Negated destination networks" + }, + "src_services_negated": { + "type": "boolean", + "description": "Negated source services" + }, + "dest_services_negated": { + "type": "boolean", + "description": "Negated destination services" + }, + "associatedNatRule": { + "$ref": "#/components/schemas/NatRuleDTO" + }, + "id": { + "type": "string", + "description": "The ID of the rule" + }, + "order": { + "type": "integer", + "format": "int64", + "description": "The Order of the rule" + }, + "uid": { + "type": "string", + "description": "The UID of the rule" + }, + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingDTO" + }, + "description": "The bindings of the rule" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID for this rule" + }, + "cp_uid": { + "type": "string", + "description": "The CheckPoint UID of the rule" + } + }, + "required": [ + "src_networks_negated", + "dest_networks_negated", + "src_services_negated", + "dest_services_negated", + "id", + "order", + "uid", + "binding", + "cp_uid" + ] + }, + "RuleDTO": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the rule" + }, + "order": { + "type": "integer", + "format": "int64", + "description": "The Order of the rule" + }, + "uid": { + "type": "string", + "description": "The UID of the rule" + }, + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingDTO" + }, + "description": "The bindings of the rule" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID for this rule" + }, + "cp_uid": { + "type": "string", + "description": "The CheckPoint UID of the rule" + } + }, + "required": [ + "id", + "order", + "uid", + "binding", + "cp_uid" + ] + }, + "SectionRuleDTO": { + "type": "object", + "properties": { + "header": { + "type": "string", + "description": "Section header" + }, + "global_location": { + "type": "string", + "description": "Global Location" + }, + "id": { + "type": "string", + "description": "The ID of the rule" + }, + "order": { + "type": "integer", + "format": "int64", + "description": "The Order of the rule" + }, + "uid": { + "type": "string", + "description": "The UID of the rule" + }, + "binding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingDTO" + }, + "description": "The bindings of the rule" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID for this rule" + }, + "cp_uid": { + "type": "string", + "description": "The CheckPoint UID of the rule" + } + }, + "required": [ + "header", + "global_location", + "id", + "order", + "uid", + "binding", + "cp_uid" + ] + }, + "PathCalcAsyncTask": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/PathCalcAsyncTaskStatus" + }, + "taskId": { + "type": "string" + }, + "createTime": { + "type": "integer", + "format": "int64" + } + } + }, + "TopologyRouteDTO": { + "type": "object", + "properties": { + "vrf": { + "type": "string" + }, + "interface": { + "type": "string" + }, + "next_hop_ip": { + "type": "string" + }, + "next_hop_vr": { + "type": "string" + }, + "network_ip": { + "type": "string" + }, + "network_mask": { + "type": "string" + } + } + }, + "DeviceDetailsDTO": { + "type": "object", + "properties": { + "device_id": { + "type": "integer", + "format": "int32" + }, + "device_name": { + "type": "string" + }, + "device_domain": { + "type": "integer", + "format": "int32" + }, + "device_vendor": { + "type": "string" + }, + "device_virtual_type": { + "type": "string" + }, + "device_parent": { + "type": "integer", + "format": "int32" + }, + "device_topology_enabled": { + "type": "boolean" + }, + "device_context_name": { + "type": "string" + }, + "device_firewall_id": { + "type": "string" + }, + "opm_device_id": { + "type": "string" + }, + "opm_system_id": { + "type": "string" + }, + "opm_type": { + "type": "string" + }, + "opm_parent": { + "type": "string" + }, + "opm_vendor": { + "type": "string" + }, + "opm_model": { + "type": "string" + }, + "device_has_dynamic_topology": { + "type": "string" + }, + "device_model": { + "type": "string" + } + } + }, + "RestCloudUserDataDTO": { + "type": "object", + "properties": { + "cloud_members": { + "type": "array", + "items": { + "type": "integer" + } + }, + "cloud_name": { + "type": "string" + } + } + }, + "PbrActionJson": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "Type": { + "type": "object" + }, + "BindingJson": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleJson" + } + }, + "enforcedOn": { + "type": "array", + "items": { + "type": "string" + } + }, + "error": { + "type": "string" + } + } + }, + "TopologyModeDTO": { + "type": "object", + "properties": { + "mgmtId": { + "type": "integer", + "format": "int32" + }, + "domainId": { + "type": "integer", + "format": "int32" + }, + "mode": { + "$ref": "#/components/schemas/Mode" + } + } + }, + "PathCalcAsyncTaskStatus": { + "type": "object" + }, + "DomainTrafficMapInfo": { + "type": "object", + "properties": { + "source_network_object_mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectMapInfo" + } + }, + "destination_network_object_mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectMapInfo" + } + }, + "service_object_mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceMapInfo" + } + } + } + }, + "RouteMaps": { + "type": "object" + }, + "EntryType": { + "type": "object" + }, + "TopologyCloudType": { + "type": "object", + "properties": { + "value": { + "type": "string" + } + } + }, + "TransparentFirewalls": { + "type": "object", + "properties": { + "TransparentFirewall": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransparentFirewallDTO" + } + } + }, + "required": [ + "TransparentFirewall" + ] + }, + "PathDomainResults": { + "type": "object", + "properties": { + "path_domain_entry": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PathDomainResultDto" + } + } + } + }, + "GenericPolicy": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenericRule" + } + } + } + }, + "TransparentFirewallsDTO": { + "type": "object" + }, + "NetworkObjectMapInfo": { + "type": "object", + "properties": { + "network_object": { + "type": "string" + }, + "traffic": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "InterfaceCustomerTagsDTO": { + "type": "object" + }, + "UnRoutedElements": { + "type": "object", + "properties": { + "destination": { + "type": "string" + }, + "source": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SynchType": { + "type": "object", + "properties": { + "value": { + "type": "string" + } + } + }, + "SuggestedCloudListDTO": { + "type": "object", + "properties": { + "cloud": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SuggestedCloudDTO" + } + }, + "count": { + "type": "integer", + "format": "int32" + }, + "total": { + "type": "integer", + "format": "int64" + } + } + }, + "TopologySynchronizeTimingDTO": { + "type": "object", + "properties": { + "hour": { + "type": "integer", + "format": "int32" + }, + "dayOfWeek": { + "type": "integer", + "format": "int32" + }, + "minutes": { + "type": "integer", + "format": "int32" + }, + "synchType": { + "$ref": "#/components/schemas/SynchType" + } + } + }, + "GenericRule": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "type": "string" + } + }, + "destination": { + "type": "array", + "items": { + "type": "string" + } + }, + "service": { + "type": "array", + "items": { + "type": "string" + } + }, + "action": { + "$ref": "#/components/schemas/RuleAction" + }, + "ruleNumber": { + "type": "integer", + "format": "int32" + } + } + }, + "GenericVpns": { + "type": "object", + "properties": { + "GenericVpn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenericVpnDTO" + } + } + }, + "required": [ + "GenericVpn" + ] + }, + "SuggestedCloudDTO": { + "type": "object", + "properties": { + "cloud_name": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "cloud_id": { + "type": "integer", + "format": "int32" + }, + "management_name": { + "type": "string" + }, + "management_id": { + "type": "integer", + "format": "int32" + }, + "vertex_id": { + "type": "integer", + "format": "int32" + }, + "routes_count": { + "type": "integer", + "format": "int32" + }, + "is_parent": { + "type": "boolean" + }, + "parent_vertex_id": { + "type": "integer", + "format": "int32" + }, + "parent_cloud_id": { + "type": "integer", + "format": "int32" + }, + "parent_cloud_name": { + "type": "string" + } + } + }, + "PbrEntryJson": { + "type": "object", + "properties": { + "actions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PbrActionJson" + } + }, + "interfaceName": { + "type": "string" + }, + "routeMapName": { + "type": "string" + }, + "aclName": { + "type": "string" + }, + "seqNumber": { + "type": "integer", + "format": "int32" + } + } + }, + "SyncStatusJson": { + "type": "object", + "properties": { + "percentage": { + "type": "number", + "format": "double" + }, + "lastVersion": { + "type": "integer", + "format": "int64" + } + } + }, + "GenericDeviceDataDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "customer_id": { + "type": "integer", + "format": "int32" + } + } + }, + "GenericRoutes": { + "type": "object", + "properties": { + "GenericRoute": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenericRouteDTO" + } + } + }, + "required": [ + "GenericRoute" + ] + }, + "RestSubnetsListDTO": { + "type": "object", + "properties": { + "subnets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RestSubnetDTO" + } + }, + "count": { + "type": "integer", + "format": "int32" + }, + "total": { + "type": "integer", + "format": "int64" + } + } + }, + "TopologyDevices": { + "type": "object", + "properties": { + "TopologyDevice": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceDetailsDTO" + } + } + }, + "required": [ + "TopologyDevice" + ] + }, + "JoinSubnetRequest": { + "type": "object", + "properties": { + "subnetId": { + "type": "integer", + "format": "int32" + }, + "interfaceIds": { + "type": "array", + "items": { + "type": "integer" + } + } + } + }, + "IgnoredInterfacesDTO": { + "type": "object" + }, + "GenericInterfaceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + }, + "mask": { + "type": "string" + }, + "vrf": { + "type": "string" + }, + "unnumbered": { + "type": "boolean" + }, + "mgmtId": { + "type": "integer", + "format": "int32" + }, + "ip": { + "type": "string" + }, + "mpls": { + "type": "boolean" + } + } + }, + "GenericVpnConnectionDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "generic": { + "type": "boolean" + }, + "interface_name": { + "type": "string" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "tunnel_src_interface": { + "type": "string" + }, + "vpn_name": { + "type": "string" + }, + "tunnel_src_ip": { + "type": "string" + }, + "tunnel_dest_ip": { + "type": "string" + } + } + }, + "GenericPolicies": { + "type": "object" + }, + "NatJson": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/Type" + }, + "originalServices": { + "type": "array", + "items": { + "type": "string" + } + }, + "policyRuleNumber": { + "type": "integer", + "format": "int64" + }, + "originalIps": { + "type": "array", + "items": { + "type": "string" + } + }, + "translatedIps": { + "type": "array", + "items": { + "type": "string" + } + }, + "translatedServices": { + "type": "array", + "items": { + "type": "string" + } + }, + "objectNames": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PathDomainResultDto": { + "type": "object", + "properties": { + "domainId": { + "type": "integer", + "format": "int32" + }, + "domainName": { + "type": "string" + }, + "vertex": { + "type": "string" + }, + "entryType": { + "$ref": "#/components/schemas/EntryType" + } + } + }, + "NextHopType": { + "type": "object" + }, + "RestSubnetDeviceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "is_generic": { + "type": "boolean" + }, + "interface_name": { + "type": "string" + }, + "interface_id": { + "type": "integer", + "format": "int32" + }, + "interface_ip": { + "type": "string" + } + } + }, + "RestCloudDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "type": { + "$ref": "#/components/schemas/TopologyCloudType" + }, + "members": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RestCloudMemberDTO" + } + }, + "domain": { + "type": "integer", + "format": "int32" + }, + "ip": { + "type": "string" + } + } + }, + "GenericVpnDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "interfaceName": { + "type": "string" + }, + "generic": { + "type": "boolean" + }, + "deviceId": { + "type": "integer", + "format": "int32" + }, + "tunnelSourceIpAddr": { + "type": "string" + }, + "tunnelSourceInterface": { + "type": "string" + }, + "vpnName": { + "type": "string" + }, + "tunnelDestIpAddr": { + "type": "string" + } + } + }, + "PaDeviceJson": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + }, + "natList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NatJson" + } + }, + "incomingInterfaces": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceJson" + } + }, + "vendor": { + "type": "string" + }, + "nextDevices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NextDeviceJson" + } + }, + "ipsecList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IpsecJson" + } + }, + "pbrEntryList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PbrEntryJson" + } + }, + "bindings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingJson" + } + }, + "sdwanEntryJsonList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SdwanEntryJson" + } + } + } + }, + "RuleAction": { + "type": "object" + }, + "IpsecType": { + "type": "object" + }, + "IgnoredInterfaces": { + "type": "object", + "properties": { + "IgnoredInterface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IgnoredInterfaceDTO" + } + } + }, + "required": [ + "IgnoredInterface" + ] + }, + "IpsecJson": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/IpsecType" + }, + "sourceIp": { + "type": "string" + }, + "acl": { + "type": "string" + }, + "peer": { + "type": "string" + }, + "seqNumber": { + "type": "integer", + "format": "int32" + }, + "outgoingInterface": { + "$ref": "#/components/schemas/InterfaceJson" + }, + "participatingGateways": { + "type": "array", + "items": { + "type": "string" + } + }, + "satelliteGateways": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TopologyRouteListDTO": { + "type": "object", + "properties": { + "route": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TopologyRouteDTO" + } + } + } + }, + "GenericInterfaces": { + "type": "object", + "properties": { + "GenericInterface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenericInterfaceDTO" + } + } + }, + "required": [ + "GenericInterface" + ] + }, + "Mode": { + "type": "object" + }, + "LastHopInterfaceListDTO": { + "type": "object", + "properties": { + "interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LastHopInterfaceDTO" + } + } + } + }, + "NextDeviceJson": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "routes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RouteJson" + } + } + } + }, + "RouteJson": { + "type": "object", + "properties": { + "routeDestination": { + "type": "string" + }, + "nextHopIp": { + "type": "string" + }, + "outgoingInterfaceName": { + "type": "string" + }, + "outgoingVrf": { + "type": "string" + }, + "mplsInputLabel": { + "type": "string" + }, + "mplsOutputLabel": { + "type": "string" + }, + "evpnInputLabel": { + "type": "string" + }, + "evpnOutputLabel": { + "type": "string" + }, + "evpnType": { + "type": "string" + } + } + }, + "SdwanEntryJson": { + "type": "object", + "properties": { + "members": { + "type": "string" + }, + "seqNumber": { + "type": "integer", + "format": "int32" + }, + "policyName": { + "type": "string" + }, + "ruleName": { + "type": "string" + } + } + }, + "GenericInterfacesDTO": { + "type": "object" + }, + "RestAnonymousSubnetListDTO": { + "type": "object", + "properties": { + "network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RestAnonymousSubnetDTO" + } + }, + "count": { + "type": "integer", + "format": "int32" + }, + "total": { + "type": "integer", + "format": "int64" + } + } + }, + "TopologySettingDTO": { + "type": "object", + "properties": { + "exportImageCollapsed": { + "type": "boolean" + }, + "synchronizeTiming": { + "$ref": "#/components/schemas/TopologySynchronizeTimingDTO" + }, + "overlappingIp": { + "type": "boolean" + } + } + }, + "RestCloudsListDTO": { + "type": "object", + "properties": { + "topology_cloud": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RestCloudDTO" + } + }, + "count": { + "type": "integer", + "format": "int32" + }, + "total": { + "type": "integer", + "format": "int64" + } + } + }, + "TransparentFirewallDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "outputL3DeviceId": { + "type": "integer", + "format": "int32" + }, + "outputL3IsGenericDevice": { + "type": "boolean" + }, + "outputL3InterfaceName": { + "type": "string" + }, + "outputL3InterfaceIp": { + "type": "string" + }, + "layer2DeviceId": { + "type": "integer", + "format": "int32" + }, + "inputL2InterfaceName": { + "type": "string" + }, + "outputL2InterfaceName": { + "type": "string" + }, + "inputL3DeviceId": { + "type": "integer", + "format": "int32" + }, + "inputL3IsGenericDevice": { + "type": "boolean" + }, + "inputL3InterfaceName": { + "type": "string" + }, + "inputL3InterfaceIp": { + "type": "string" + } + } + }, + "RestSubnetDetailedDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "mask": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "domainIdTag": { + "type": "integer", + "format": "int32" + } + } + }, + "RestSubnetDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "mask": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "domainIdTag": { + "type": "integer", + "format": "int32" + } + } + }, + "GenericDeviceListDTO": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenericDeviceDataDTO" + } + } + } + }, + "LastHopInterfaceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "mask": { + "type": "string" + }, + "zone": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "generic_device_id": { + "type": "integer", + "format": "int32" + }, + "virtual_router": { + "type": "string" + } + } + }, + "RestAnonymousSubnetDTO": { + "type": "object", + "properties": { + "mask": { + "type": "string" + }, + "ip": { + "type": "string" + } + } + }, + "InterfaceCustomerTags": { + "type": "object", + "properties": { + "InterfaceCustomerTag": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceCustomerTagDTO" + } + } + }, + "required": [ + "InterfaceCustomerTag" + ] + }, + "GenericRoutesDTO": { + "type": "object" + }, + "InterfaceCustomerTagDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "customerId": { + "type": "integer", + "format": "int32" + }, + "interfaceName": { + "type": "string" + }, + "generic": { + "type": "boolean" + }, + "deviceId": { + "type": "integer", + "format": "int32" + } + } + }, + "GenericVpnsDTO": { + "type": "object" + }, + "RuleJson": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "type": "string" + }, + "type": { + "type": "string" + }, + "sourceNegated": { + "type": "boolean" + }, + "aclName": { + "type": "string" + }, + "sources": { + "type": "array", + "items": { + "type": "string" + } + }, + "destNegated": { + "type": "boolean" + }, + "serviceNegated": { + "type": "boolean" + }, + "ruleIdentifier": { + "type": "string" + }, + "ruleUid": { + "type": "string" + }, + "destinations": { + "type": "array", + "items": { + "type": "string" + } + }, + "services": { + "type": "array", + "items": { + "type": "string" + } + }, + "applications": { + "type": "array", + "items": { + "type": "string" + } + }, + "users": { + "type": "array", + "items": { + "type": "string" + } + }, + "urlCategories": { + "type": "array", + "items": { + "type": "string" + } + }, + "action": { + "type": "string" + }, + "ruleScope": { + "type": "string" + }, + "tenantName": { + "type": "string" + }, + "contractName": { + "type": "string" + }, + "subjectName": { + "type": "string" + }, + "serviceGraphName": { + "type": "string" + }, + "ruleDirection": { + "type": "string" + }, + "rulePriority": { + "type": "string" + }, + "destinationZones": { + "type": "array", + "items": { + "type": "string" + } + }, + "sourceZones": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "RestGenericVpnListDTO": { + "type": "object", + "properties": { + "generic_vpn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenericVpnConnectionDto" + } + }, + "count": { + "type": "integer", + "format": "int32" + }, + "total": { + "type": "integer", + "format": "int64" + } + } + }, + "ServiceMapInfo": { + "type": "object", + "properties": { + "service": { + "type": "array", + "items": { + "type": "string" + } + }, + "service_object": { + "type": "string" + } + } + }, + "GenericRouteDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "mask": { + "type": "string" + }, + "destination": { + "type": "string" + }, + "vrf": { + "type": "string" + }, + "mgmtId": { + "type": "integer", + "format": "int32" + }, + "interfaceName": { + "type": "string" + }, + "nextHop": { + "type": "string" + }, + "nextHopType": { + "$ref": "#/components/schemas/NextHopType" + } + } + }, + "generic_policys": { + "type": "object", + "properties": { + "generic_policy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenericPolicy" + } + } + }, + "required": [ + "generic_policy" + ] + }, + "JoinCloudDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "clouds": { + "type": "array", + "items": { + "type": "integer" + } + } + } + }, + "RestCloudMemberDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "ip": { + "type": "string" + } + } + }, + "PaResults": { + "type": "object", + "properties": { + "unrouted_elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnRoutedElements" + } + }, + "traffic_allowed": { + "type": "boolean" + }, + "device_info": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaDeviceJson" + } + } + } + }, + "InterfaceJson": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "subnet": { + "type": "string" + }, + "vpnConnection": { + "type": "string" + }, + "incomingVrf": { + "type": "string" + } + } + }, + "IgnoredInterfaceDTO": { + "type": "object", + "properties": { + "mgmtId": { + "type": "integer", + "format": "int32" + }, + "interfaceName": { + "type": "string" + }, + "ip": { + "type": "string" + } + } + }, + "PatternMatchEntryDTO": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The zone entry ID." + }, + "type": { + "type": "string", + "description": "Entry type. Currently only \"security_group_by_name\" is supported" + }, + "comment": { + "type": "string", + "description": "Entry comment" + }, + "pattern": { + "type": "string", + "description": "Pattern to find security group by name" + }, + "zone_name": { + "type": "string", + "description": "Entry zone name" + }, + "zone_id": { + "type": "integer", + "format": "int32", + "description": "Entry zone identifier" + }, + "new_zone_id": { + "type": "integer", + "format": "int32", + "description": "New zone identifier to migrate the entry into" + }, + "domain": { + "$ref": "#/components/schemas/tufin-client-api_domain" + } + }, + "required": [ + "id", + "type", + "pattern" + ] + }, + "PatternMatchEntriesFindResultDTO": { + "type": "object", + "properties": { + "pattern_match_entry": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatternMatchEntryDTO" + }, + "description": "Pattern match entries List" + }, + "paging_info": { + "$ref": "#/components/schemas/PagerDTO" + } + }, + "required": [ + "pattern_match_entry", + "paging_info" + ] + }, + "CreatePatternMatchEntryRequestDTO": { + "type": "object", + "properties": { + "pattern_match_entry": { + "$ref": "#/components/schemas/PatternMatchEntryDTO" + } + }, + "required": [ + "pattern_match_entry" + ] + }, + "tufin-client-api_domain": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the domain" + }, + "id": { + "type": "integer", + "format": "int32", + "description": "The ID of the domain" + }, + "address": { + "type": "string", + "description": "The address of the domain" + }, + "description": { + "type": "string", + "description": "The description of the domain" + } + }, + "required": [ + "name", + "id", + "address", + "description" + ] + }, + "PagerDTO": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "List elements counter" + }, + "start": { + "type": "integer", + "format": "int64", + "description": "Start element index, started from zero" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Total list elements" + } + }, + "required": [ + "count", + "start", + "total" + ] + }, + "ManagementStatus": { + "type": "object", + "properties": { + "statusCode": { + "type": "integer", + "format": "int32" + }, + "haActive": { + "type": "string" + } + } + }, + "RevisionManualAuthorizationStatus": { + "type": "object" + }, + "DeviceGroup": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "parent": { + "$ref": "#/components/schemas/DeviceGroup" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "domain": { + "$ref": "#/components/schemas/Domain" + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Device_NetworkZoneManagerSubnets" + } + }, + "groupMembers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceGroup" + } + } + } + }, + "ChangeRequest": { + "type": "object", + "properties": { + "source": { + "$ref": "#/components/schemas/ChangeRequestSource" + }, + "requestId": { + "type": "string" + }, + "changeUid": { + "type": "string" + } + } + }, + "RevisionAction": { + "type": "object" + }, + "StPlugin": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "time": { + "$ref": "#/components/schemas/Timestamp" + }, + "date": { + "type": "string", + "format": "date-time" + }, + "version": { + "type": "string" + }, + "revision": { + "type": "string" + }, + "vendor": { + "type": "string" + }, + "protocols": { + "type": "string" + }, + "model": { + "type": "string" + }, + "plugin_name": { + "type": "string" + }, + "data_retriever": { + "type": "string" + }, + "command_line": { + "type": "string" + }, + "standard_input": { + "type": "string" + } + } + }, + "ChangeRequestSource": { + "type": "object" + }, + "CloudOrganizationProperty": { + "type": "object", + "properties": { + "organization": { + "$ref": "#/components/schemas/CloudOrganization" + }, + "value": { + "type": "string" + }, + "key": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "encrypted": { + "type": "boolean" + } + } + }, + "StServer": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "displayName": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "serverType": { + "type": "string" + }, + "diskUsage": { + "type": "integer", + "format": "int32" + } + } + }, + "MplsVpnLabel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "mask": { + "type": "string" + }, + "destination": { + "type": "string" + }, + "deviceId": { + "type": "integer", + "format": "int32" + }, + "nextHop": { + "type": "string" + }, + "virtualRouterId": { + "type": "integer", + "format": "int32" + }, + "genericDeviceId": { + "type": "integer", + "format": "int32" + }, + "outValue": { + "type": "string" + }, + "inType": { + "type": "string" + }, + "inValue": { + "type": "string" + }, + "outType": { + "type": "string" + }, + "uid": { + "type": "string" + } + } + }, + "UserLoginType": { + "type": "object" + }, + "RevisionAutomaticAuthorizationStatus": { + "type": "object", + "properties": { + "value": { + "type": "string" + } + } + }, + "ProxyServer": { + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "integer", + "format": "int32" + }, + "password": { + "type": "string" + }, + "user": { + "type": "string" + }, + "proxyServerId": { + "type": "integer", + "format": "int32" + }, + "enable": { + "type": "boolean" + } + } + }, + "RoutingTableEntry": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "mask": { + "type": "string" + }, + "destination": { + "type": "string" + }, + "interfaceName": { + "type": "string" + }, + "virtualRouter": { + "$ref": "#/components/schemas/VirtualRouter" + }, + "evpnOutLabel": { + "type": "integer", + "format": "int32" + }, + "parentMgmtId": { + "type": "integer", + "format": "int32" + }, + "parentDevice": { + "$ref": "#/components/schemas/Device_NetworkZoneManagerSubnets" + }, + "parentGenericDevice": { + "$ref": "#/components/schemas/GenericDevice" + }, + "gatewayIp": { + "type": "string" + }, + "nextHopVirtualRouter": { + "$ref": "#/components/schemas/VirtualRouter" + }, + "routingType": { + "type": "string" + }, + "nextHopName": { + "type": "string" + }, + "outputVr": { + "$ref": "#/components/schemas/VirtualRouter" + }, + "uid": { + "type": "string" + } + } + }, + "CloudProxyServer": { + "type": "object", + "properties": { + "port": { + "type": "integer", + "format": "int32" + }, + "password": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "Revision": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "time": { + "$ref": "#/components/schemas/LocalTime_NetworkZoneManagerSubnets" + }, + "date": { + "$ref": "#/components/schemas/LocalDate_NetworkZoneManagerSubnets" + }, + "device": { + "$ref": "#/components/schemas/Device_NetworkZoneManagerSubnets" + }, + "action": { + "$ref": "#/components/schemas/RevisionAction" + }, + "revisionId": { + "type": "integer", + "format": "int32" + }, + "modules": { + "type": "array", + "items": { + "type": "string" + } + }, + "modulesAndPolicy": { + "type": "string", + "format": "map" + }, + "uuid": { + "$ref": "#/components/schemas/UUID" + }, + "mode": { + "type": "string" + }, + "comments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RevisionComment" + } + }, + "admin": { + "type": "string" + }, + "actualDate": { + "$ref": "#/components/schemas/LocalDate_NetworkZoneManagerSubnets" + }, + "actualTime": { + "$ref": "#/components/schemas/LocalTime_NetworkZoneManagerSubnets" + }, + "app": { + "type": "string" + }, + "guiClient": { + "type": "string" + }, + "auditLog": { + "type": "string" + }, + "policyPackage": { + "type": "string" + }, + "globalPolicy": { + "type": "string" + }, + "automaticAuthorizationStatus": { + "$ref": "#/components/schemas/RevisionAutomaticAuthorizationStatus" + }, + "firewallStatus": { + "type": "boolean" + }, + "ready": { + "type": "boolean" + }, + "cleanupRuleAction": { + "type": "boolean" + }, + "changeRequests": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChangeRequest" + } + }, + "manualAuthorization": { + "type": "boolean" + }, + "cpTypeForVersion": { + "type": "string" + } + } + }, + "GenericDevice": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "routingTableEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RoutingTableEntry" + } + }, + "mplsVpnLabels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MplsVpnLabel" + } + }, + "customerId": { + "type": "integer", + "format": "int32" + }, + "domain": { + "$ref": "#/components/schemas/Domain" + }, + "uid": { + "type": "string" + } + } + }, + "ZoneEntryListDTO": { + "type": "object", + "properties": { + "zone_entry": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ZoneEntryDTO" + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of total available elements" + } + }, + "required": [ + "count", + "total" + ] + }, + "AtnTDeviceGroup": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "domain": { + "$ref": "#/components/schemas/Domain" + }, + "contains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Device_NetworkZoneManagerSubnets" + } + } + } + }, + "Domain": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "address": { + "type": "string" + }, + "description": { + "type": "string" + }, + "permittedUsers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "UserType": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "displayName": { + "type": "string" + } + } + }, + "ZoneEntryDTO": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The zone entry ID." + }, + "comment": { + "type": "string", + "description": "The zone entry comment." + }, + "tag": { + "type": "string" + }, + "prefix": { + "type": "string", + "description": "The zone entry IP prefix." + }, + "zoneName": { + "type": "string" + }, + "zoneId": { + "type": "integer", + "format": "int32" + }, + "ip": { + "type": "string", + "description": "The zone entry IP address." + }, + "netmask": { + "type": "string", + "description": "The zone entry IP netmask." + }, + "new_zone_id": { + "type": "integer", + "format": "int32" + }, + "domain": { + "$ref": "#/components/schemas/DomainDTO" + } + }, + "required": [ + "id", + "prefix", + "ip", + "netmask" + ] + }, + "User": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "dateFormat": { + "type": "string" + }, + "profileGroupMember": { + "type": "boolean" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "userType": { + "$ref": "#/components/schemas/UserType" + }, + "canAccessGlobalContext": { + "type": "boolean" + }, + "emailAddress": { + "type": "string" + }, + "permittedDomains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Domain" + } + }, + "permittedDevices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Device_NetworkZoneManagerSubnets" + } + }, + "userLoginType": { + "$ref": "#/components/schemas/UserLoginType" + }, + "lastLoginProfileGroupName": { + "type": "string" + }, + "recentRevisionsPeriod": { + "type": "string" + }, + "deviceDefaultView": { + "type": "string" + }, + "modifiedColor": { + "type": "string" + }, + "deletedColor": { + "type": "string" + }, + "insertedColor": { + "type": "string" + }, + "innerModifiedColor": { + "type": "string" + }, + "showAllObjects": { + "type": "boolean" + }, + "canViewAnyDevice": { + "type": "boolean" + } + } + }, + "Timestamp": { + "type": "object", + "properties": { + "nanos": { + "type": "integer", + "format": "int32" + } + } + }, + "AdminDomainInfo": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/AdminDomainInfoId" + }, + "domainId": { + "type": "string" + }, + "lastSnapshotId": { + "type": "integer", + "format": "int32" + } + } + }, + "DeviceGroupDTO": { + "type": "object", + "properties": { + "domain": { + "$ref": "#/components/schemas/DomainDTO" + }, + "atnTDeviceGroup": { + "$ref": "#/components/schemas/AtnTDeviceGroup" + } + } + }, + "CloudOrganization": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CloudOrganizationProperty" + } + }, + "id": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + }, + "domain": { + "$ref": "#/components/schemas/Domain" + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Device_NetworkZoneManagerSubnets" + } + }, + "proxyServer": { + "$ref": "#/components/schemas/CloudProxyServer" + }, + "serverId": { + "type": "integer", + "format": "int32" + }, + "proxyEnabled": { + "type": "boolean" + }, + "importedMembersDomain": { + "$ref": "#/components/schemas/Domain" + } + } + }, + "RevisionComment": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "comment": { + "type": "string" + }, + "editor": { + "type": "string" + } + } + }, + "DurationFieldType": { + "type": "object" + }, + "Chronology": { + "type": "object" + }, + "RevisionManualAuthorization": { + "type": "object", + "properties": { + "authorizationStatus": { + "$ref": "#/components/schemas/RevisionManualAuthorizationStatus" + }, + "authorizingUserId": { + "type": "string" + }, + "authorizationDate": { + "$ref": "#/components/schemas/LocalDateTime_NetworkZoneManagerSubnets" + } + } + }, + "VirtualRouter": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "interfaces": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TopologyInterface" + } + }, + "id": { + "type": "integer", + "format": "int32" + }, + "routes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RoutingTableEntry" + } + }, + "mgmtId": { + "type": "integer", + "format": "int32" + }, + "mplsVpnLabels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MplsVpnLabel" + } + }, + "genericDeviceId": { + "type": "integer", + "format": "int32" + }, + "uid": { + "type": "string" + } + } + }, + "AdminDomainInfoId": { + "type": "object", + "properties": { + "mgmtId": { + "type": "integer", + "format": "int32" + }, + "domainName": { + "type": "string" + } + } + }, + "TopologyInterface": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "virtualRouter": { + "$ref": "#/components/schemas/VirtualRouter" + }, + "netmask": { + "type": "string" + }, + "parentMgmtId": { + "type": "integer", + "format": "int32" + }, + "apiV2InterfaceId": { + "type": "string" + }, + "parentGenericDeviceId": { + "type": "integer", + "format": "int32" + }, + "vsxWrpLink": { + "type": "string" + }, + "extVsys": { + "type": "boolean" + }, + "routeMapName": { + "type": "string" + }, + "topologyLayer2DataId": { + "type": "array", + "items": { + "type": "integer" + } + }, + "cryptoMapName": { + "type": "string" + }, + "customerIdTag": { + "type": "integer", + "format": "int32" + }, + "routeBasedVpns": { + "type": "string" + }, + "vpc": { + "type": "boolean" + }, + "bridgeDomain": { + "type": "string" + }, + "externalRoutedNetwork": { + "type": "string" + }, + "parentDeviceName": { + "type": "string" + }, + "parentGenericDeviceName": { + "type": "string" + }, + "uid": { + "type": "string" + } + } + }, + "Entry_AccessRequestNetworkDTO_NetworkObjectsZoneListDTO": { + "type": "object", + "properties": { + "key": { + "$ref": "#/components/schemas/AccessRequestNetworkDTO" + }, + "value": { + "$ref": "#/components/schemas/NetworkObjectsZoneListDTO" + } + }, + "required": [ + "key", + "value" + ] + }, + "TopologyVertex": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "domain": { + "$ref": "#/components/schemas/Domain" + }, + "cloud": { + "$ref": "#/components/schemas/Cloud" + } + } + }, + "raw_network_range": { + "type": "object", + "properties": { + "min_ip": { + "type": "string", + "description": "The minimum IP address of the network range" + }, + "max_ip": { + "type": "string", + "description": "The maximum IP address of the network range" + }, + "negate": { + "type": "boolean", + "description": "All addresses except for the specified addresses" + } + }, + "required": [ + "min_ip", + "max_ip" + ] + }, + "ZoneHierarchyDTO": { + "type": "object", + "properties": { + "zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ZoneHierarchyDTO" + } + }, + "cloud": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CloudDTO" + } + } + } + }, + "CloudDTO": { + "type": "object", + "properties": { + "cloud": { + "$ref": "#/components/schemas/Cloud" + } + } + }, + "raw_network_subnet": { + "type": "object", + "properties": { + "mask": { + "type": "string", + "description": "The mask of the network" + }, + "prefix": { + "type": "string", + "description": "The prefix of the network" + }, + "ip": { + "type": "string", + "description": "The IP address of the network" + }, + "negate": { + "type": "boolean", + "description": "All addresses except for the specified addresses" + } + }, + "required": [ + "mask", + "prefix", + "ip" + ] + }, + "AccessRequestNetworkListDTO": { + "type": "object", + "properties": { + "network_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRequestNetworkDTO" + } + } + } + }, + "ZoneDependencyDTO": { + "type": "object", + "properties": { + "zone_id": { + "type": "integer", + "format": "int32" + }, + "reports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ZoneReportDTO" + } + } + } + }, + "ip_network": { + "type": "object", + "properties": { + "network": { + "$ref": "#/components/schemas/RawNetworkDTO" + }, + "id": { + "type": "string", + "description": "The ID of the access request network object" + }, + "source_region": { + "type": "string", + "description": "The source region of the access request network object" + }, + "sANetworkObjectId": { + "type": "integer", + "format": "int64", + "description": "The ID of SecureApp network object" + } + }, + "required": [ + "network" + ] + }, + "SecurityZonesResultDTO": { + "type": "object", + "properties": { + "accessRequestNetworkZonesMap": { + "type": "string", + "format": "map", + "description": "Map of network elements to security zones" + } + }, + "required": [ + "accessRequestNetworkZonesMap" + ] + }, + "SecurityLevel": { + "type": "object" + }, + "NetworkObjectsZoneListDTO": { + "type": "object", + "properties": { + "network_objects_zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectsZoneDTO" + }, + "description": "List of security zones mapped to a network element" + } + }, + "required": [ + "network_objects_zone" + ] + }, + "RawNetworkDTO": { + "type": "object", + "properties": { + "negate": { + "type": "boolean", + "description": "All addresses except for the specified addresses" + } + } + }, + "ZoneReportDTO": { + "type": "object", + "properties": { + "report": { + "$ref": "#/components/schemas/ZoneReport" + } + } + }, + "ZoneOtherDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the zone" + }, + "id": { + "type": "string", + "description": "The ID of the zone" + }, + "domain_name": { + "type": "string", + "description": "The zone domain" + } + } + }, + "network_object_member": { + "type": "object", + "properties": { + "path": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The location of the violating network object within the network object group of the access request" + }, + "last_member": { + "$ref": "#/components/schemas/object_network" + } + } + }, + "raw_network_ipv6": { + "type": "object", + "properties": { + "prefix": { + "type": "string", + "description": "The prefix of the network" + }, + "ip": { + "type": "string", + "description": "The IP address of the network" + }, + "negate": { + "type": "boolean", + "description": "All addresses except for the specified addresses" + } + }, + "required": [ + "prefix", + "ip" + ] + }, + "domain": { + "type": "object", + "properties": { + "domainName": { + "type": "string" + }, + "networks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ip_network" + } + }, + "id": { + "type": "string", + "description": "The ID of the access request network object" + }, + "source_region": { + "type": "string", + "description": "The source region of the access request network object" + }, + "sANetworkObjectId": { + "type": "integer", + "format": "int64", + "description": "The ID of SecureApp network object" + } + } + }, + "Subnet": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "ip": { + "type": "string" + }, + "netmask": { + "type": "string" + }, + "uid": { + "type": "string" + } + } + }, + "internet": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the access request network object" + }, + "source_region": { + "type": "string", + "description": "The source region of the access request network object" + }, + "sANetworkObjectId": { + "type": "integer", + "format": "int64", + "description": "The ID of SecureApp network object" + } + } + }, + "RawNetworkTextualType": { + "type": "object" + }, + "CloudEntry": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "ip": { + "type": "string" + }, + "netmask": { + "type": "string" + }, + "cloud": { + "$ref": "#/components/schemas/Cloud" + }, + "behindCloud": { + "type": "boolean" + } + } + }, + "ldap_entity": { + "type": "object", + "properties": { + "ldapEntityDn": { + "type": "string" + }, + "entityName": { + "type": "string" + }, + "ldapEntityId": { + "type": "string" + }, + "id": { + "type": "string", + "description": "The ID of the access request network object" + }, + "source_region": { + "type": "string", + "description": "The source region of the access request network object" + }, + "sANetworkObjectId": { + "type": "integer", + "format": "int64", + "description": "The ID of SecureApp network object" + } + } + }, + "Map_AccessRequestNetworkDTO_NetworkObjectsZoneListDTO": { + "type": "object", + "properties": { + "entry": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Entry_AccessRequestNetworkDTO_NetworkObjectsZoneListDTO" + } + } + }, + "required": [ + "entry" + ] + }, + "CloudEntryType": { + "type": "object" + }, + "NetworkObjectsZoneDTO": { + "type": "object", + "properties": { + "network_object_path": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network_object_member" + }, + "description": "List of network object group members matching the security zone" + }, + "zone": { + "$ref": "#/components/schemas/ZoneOtherDTO" + } + }, + "required": [ + "zone" + ] + }, + "object_network": { + "type": "object", + "properties": { + "uid": { + "type": "string", + "description": "The UID of the network object" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management ID of the network object" + }, + "id": { + "type": "string", + "description": "The ID of the access request network object" + }, + "source_region": { + "type": "string", + "description": "The source region of the access request network object" + }, + "sANetworkObjectId": { + "type": "integer", + "format": "int64", + "description": "The ID of SecureApp network object" + } + }, + "required": [ + "uid", + "management_id" + ] + }, + "access_request_url_category": { + "type": "object", + "properties": { + "urlCategoryName": { + "type": "string", + "description": "Url category name" + }, + "id": { + "type": "string", + "description": "The ID of the access request network object" + }, + "source_region": { + "type": "string", + "description": "The source region of the access request network object" + }, + "sANetworkObjectId": { + "type": "integer", + "format": "int64", + "description": "The ID of SecureApp network object" + } + }, + "required": [ + "urlCategoryName" + ] + }, + "AccessRequestNetworkDTO": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the access request network object" + }, + "source_region": { + "type": "string", + "description": "The source region of the access request network object" + }, + "sANetworkObjectId": { + "type": "integer", + "format": "int64", + "description": "The ID of SecureApp network object" + } + } + }, + "ZoneDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the zone" + }, + "id": { + "type": "string", + "description": "The ID of the zone" + }, + "comment": { + "type": "string", + "description": "The zone comment." + }, + "shared": { + "type": "boolean", + "description": "Is the zone shared between domains." + }, + "internet": { + "type": "boolean", + "description": "Is the zone the Internet zone" + }, + "unassociated_networks": { + "type": "boolean", + "description": "Is the zone the Unassociated networks zone" + }, + "userNetworks": { + "type": "boolean", + "description": "Is the zone the Users Networks zone" + }, + "urlCategory": { + "type": "boolean", + "description": "Is the zone the Url category zone" + }, + "domain": { + "$ref": "#/components/schemas/DomainDTO" + }, + "importing_domain": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DomainDTO" + }, + "description": "Domains that import this zone." + } + }, + "required": [ + "name", + "id" + ] + }, + "ZoneReport": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "Zone": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "entries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ZoneEntry" + } + }, + "comment": { + "type": "string" + }, + "domain": { + "$ref": "#/components/schemas/Domain" + }, + "shared": { + "type": "boolean" + }, + "containedIn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Zone" + } + }, + "internet": { + "type": "boolean" + }, + "unassociatedNetworks": { + "type": "boolean" + }, + "userNetworks": { + "type": "boolean" + }, + "urlCategory": { + "type": "boolean" + }, + "importingDomains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Domain" + } + }, + "contains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Zone" + } + }, + "containedClouds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Cloud" + } + } + } + }, + "security_group_name": { + "type": "object", + "properties": { + "security_group_name": { + "type": "string", + "description": "Security group name" + }, + "id": { + "type": "string", + "description": "The ID of the access request network object" + }, + "source_region": { + "type": "string", + "description": "The source region of the access request network object" + }, + "sANetworkObjectId": { + "type": "integer", + "format": "int64", + "description": "The ID of SecureApp network object" + } + }, + "required": [ + "security_group_name" + ] + }, + "ZoneHierarchyListDTO": { + "type": "object", + "properties": { + "zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ZoneHierarchyDTO" + } + } + } + }, + "textual": { + "type": "object", + "properties": { + "displayName": { + "type": "string" + }, + "text": { + "type": "string" + }, + "namespaceId": { + "type": "integer", + "format": "int32" + }, + "groupIps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RawNetworkDTO" + } + }, + "subType": { + "$ref": "#/components/schemas/RawNetworkTextualType" + }, + "id": { + "type": "string", + "description": "The ID of the access request network object" + }, + "source_region": { + "type": "string", + "description": "The source region of the access request network object" + }, + "sANetworkObjectId": { + "type": "integer", + "format": "int64", + "description": "The ID of SecureApp network object" + } + } + }, + "Cloud": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "entries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CloudEntry" + } + }, + "subnets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subnet" + } + }, + "securityLevel": { + "$ref": "#/components/schemas/SecurityLevel" + }, + "customerIdTag": { + "type": "integer", + "format": "int32" + }, + "interfaceIp": { + "type": "string" + }, + "customerName": { + "type": "string" + }, + "uid": { + "type": "string" + } + } + }, + "ZoneListDTO": { + "type": "object", + "properties": { + "zone": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ZoneDTO" + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of total available elements" + } + }, + "required": [ + "count", + "total" + ] + }, + "ZoneDependencyListDTO": { + "type": "object", + "properties": { + "dependency": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ZoneDependencyDTO" + } + } + } + }, + "ZoneEntry": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "zone": { + "$ref": "#/components/schemas/Zone" + }, + "comment": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "prefix": { + "type": "string", + "format": "int16" + }, + "ip": { + "type": "string" + }, + "ipType": { + "$ref": "#/components/schemas/IpType" + }, + "atnTDeviceGroup": { + "$ref": "#/components/schemas/AtnTDeviceGroup" + } + } + }, + "DestinationType": { + "type": "object" + }, + "TopologyBindingRuleListDTO": { + "type": "object", + "properties": { + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleListDTO" + } + } + } + }, + "RouteActionDTO": { + "type": "object", + "properties": { + "action": { + "$ref": "#/components/schemas/routeAction" + }, + "interfaceName": { + "type": "string" + }, + "nextHop": { + "type": "string" + }, + "vrf": { + "type": "string" + } + } + }, + "route_map": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "route_map_entry": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RouteMapEntryDTO" + } + }, + "interfacesName": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "route_map_entry": { + "type": "object", + "properties": { + "seqNumber": { + "type": "integer", + "format": "int32" + }, + "aclName": { + "type": "string" + }, + "entryAction": { + "type": "string" + }, + "routeActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RouteActionDTO" + } + }, + "pbrEntryRules": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "route_maps": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "routeMapEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/route_map_entry" + } + } + } + }, + "routeAction": { + "type": "object" + }, + "RouteMapsDTO": { + "type": "object", + "properties": { + "route_map": { + "type": "array", + "items": { + "$ref": "#/components/schemas/route_map" + } + } + } + }, + "ManagementPolicyListDTO": { + "type": "object", + "properties": { + "managementPolicyListDTO": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ManagementPolicyDTO" + } + } + } + }, + "RouteMapEntryDestinationDTO": { + "type": "object", + "properties": { + "interfaceName": { + "type": "string" + }, + "nextHop": { + "type": "string" + }, + "vrf": { + "type": "string" + }, + "destinationType": { + "type": "string" + } + } + }, + "RouteMapEntryDTO": { + "type": "object", + "properties": { + "match": { + "type": "string" + }, + "route_map_entry_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RouteMapEntryDestinationDTO" + } + }, + "entryAction": { + "type": "string" + }, + "matchType": { + "type": "string" + } + } + }, + "BindingListDTO": { + "type": "object", + "properties": { + "bindingListDTO": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BindingDTO" + } + } + } + }, + "PolicyAnalysisBindingDTO": { + "type": "object", + "properties": { + "rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleDTO" + }, + "description": "The Rule list" + }, + "binding": { + "$ref": "#/components/schemas/BindingDTO" + } + } + }, + "PolicyAnalysisResultDTO": { + "type": "object", + "properties": { + "device_and_bindings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyAnalysisDeviceDTO" + }, + "description": "Policy analysis devices list" + } + } + }, + "PolicyAnalysisDeviceDTO": { + "type": "object", + "properties": { + "binding_and_rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyAnalysisBindingDTO" + }, + "description": "The Binding list" + }, + "device": { + "$ref": "#/components/schemas/st_device" + } + } + }, + "RiskDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The risk name" + }, + "id": { + "type": "string", + "description": "The risk id" + }, + "type": { + "$ref": "#/components/schemas/RiskDefinitionType" + }, + "code": { + "type": "string", + "description": "The risk code" + }, + "devices": { + "$ref": "#/components/schemas/DeviceListDTO" + }, + "instances_total": { + "type": "integer", + "format": "int64", + "description": "Instances count" + }, + "instances": { + "$ref": "#/components/schemas/RuleListDTO" + } + }, + "required": [ + "name", + "id", + "type", + "code", + "devices", + "instances_total", + "instances" + ] + }, + "IncidentInterpretation": { + "type": "object" + }, + "Map_IncidentParamKey_String": { + "type": "object", + "properties": { + "entry": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Entry_IncidentParamKey_String" + } + } + }, + "required": [ + "entry" + ] + }, + "CleanupDuplicationsDTO": { + "type": "object", + "properties": { + "duplicate_objects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CleanupDuplicateObjectDTO" + }, + "description": "Cleanup instances for duplicate objects" + }, + "name": { + "type": "string", + "description": "Name for cleanup" + }, + "id": { + "type": "string", + "description": "Revision ID for cleanup" + }, + "code": { + "type": "string", + "description": "Code for cleanup" + }, + "devices": { + "$ref": "#/components/schemas/DeviceListDTO" + }, + "instances_total": { + "type": "integer", + "format": "int64", + "description": "Number of instances in cleanup result" + } + }, + "required": [ + "duplicate_objects", + "name", + "id", + "code", + "devices", + "instances_total" + ] + }, + "RiskListDTO": { + "type": "object", + "properties": { + "score": { + "type": "integer", + "format": "int32", + "description": "The Score" + }, + "risk": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RiskDTO" + }, + "description": "Risk Instances" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of total available elements" + } + }, + "required": [ + "score", + "risk", + "count", + "total" + ] + }, + "CleanupDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name for cleanup" + }, + "id": { + "type": "string", + "description": "Revision ID for cleanup" + }, + "code": { + "type": "string", + "description": "Code for cleanup" + }, + "devices": { + "$ref": "#/components/schemas/DeviceListDTO" + }, + "instances_total": { + "type": "integer", + "format": "int64", + "description": "Number of instances in cleanup result" + } + }, + "required": [ + "name", + "id", + "code", + "devices", + "instances_total" + ] + }, + "CleanupDuplicateObjectDTO": { + "type": "object", + "properties": { + "duplicate_objects_number": { + "type": "integer", + "format": "int32", + "description": "Number of duplicate objects in cleanup" + }, + "policy_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceObjectDTO" + }, + "description": "Duplicate objects for cleanup" + } + }, + "required": [ + "duplicate_objects_number", + "policy_object" + ] + }, + "CleanupListDTO": { + "type": "object", + "properties": { + "score": { + "type": "integer", + "format": "int32", + "description": "The Score" + }, + "cleanup": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CleanupDTO" + }, + "description": "The rule list" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of total available elements" + } + }, + "required": [ + "cleanup", + "count", + "total" + ] + }, + "RiskSeverity": { + "type": "object" + }, + "DeviceObjectDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "RiskDefinitionType": { + "type": "object" + }, + "CleanupDeviceObjectDTO": { + "type": "object", + "properties": { + "instances": { + "$ref": "#/components/schemas/DeviceObjectListDTO" + }, + "name": { + "type": "string", + "description": "Name for cleanup" + }, + "id": { + "type": "string", + "description": "Revision ID for cleanup" + }, + "code": { + "type": "string", + "description": "Code for cleanup" + }, + "devices": { + "$ref": "#/components/schemas/DeviceListDTO" + }, + "instances_total": { + "type": "integer", + "format": "int64", + "description": "Number of instances in cleanup result" + } + }, + "required": [ + "instances", + "name", + "id", + "code", + "devices", + "instances_total" + ] + }, + "RiskDefinitionSource": { + "type": "object" + }, + "IncidentParamKey": { + "type": "object" + }, + "FullyShadowedRulesCleanupDTO": { + "type": "object", + "properties": { + "shadowed_rules": { + "$ref": "#/components/schemas/FullyShadowedRulesCleanupResultsListDTO" + } + } + }, + "FullyShadowedRulesCleanupResultDTO": { + "type": "object", + "properties": { + "rule": { + "$ref": "#/components/schemas/SecurityRuleDTO" + }, + "shadowing_rules": { + "$ref": "#/components/schemas/SecurityRuleListDTO" + } + } + }, + "CleanupResultsSetDTO": { + "type": "object", + "properties": { + "shadowed_rules_cleanup": { + "$ref": "#/components/schemas/FullyShadowedRulesCleanupDTO" + } + } + }, + "DeviceObjectListDTO": { + "type": "object", + "properties": { + "policy_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceObjectDTO" + }, + "description": "The list of resources and their details" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of total available elements" + } + }, + "required": [ + "policy_object", + "count", + "total" + ] + }, + "DeviceListDTO": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/st_device" + }, + "description": "The devices list" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of total available elements" + } + }, + "required": [ + "device", + "count", + "total" + ] + }, + "Risk": { + "type": "object", + "properties": { + "incident": { + "$ref": "#/components/schemas/Incident" + }, + "numOfInstances": { + "type": "integer", + "format": "int64" + } + } + }, + "DuplicateServiceDTO": { + "type": "object", + "properties": { + "protocol": { + "type": "string", + "format": "int16", + "description": "Protocol" + }, + "min_port": { + "type": "integer", + "format": "int32", + "description": "Minimal port value" + }, + "max_port": { + "type": "integer", + "format": "int32", + "description": "Maximal port value" + }, + "session_timeout": { + "type": "integer", + "format": "int32", + "description": "Session timeout" + }, + "min_src_port": { + "type": "integer", + "format": "int32", + "description": "Minimal source port" + }, + "max_src_port": { + "type": "integer", + "format": "int32", + "description": "Maximal source port" + }, + "overrides": { + "type": "boolean", + "description": "Original value override, applicable only for Panorama NG" + }, + "type_on_device": { + "type": "string", + "description": "type on device" + }, + "management_domain": { + "type": "string", + "description": "management domain " + }, + "management_domain_securetrack_name": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the device object" + }, + "id": { + "type": "string", + "description": "The ID of the device object" + }, + "type": { + "type": "string", + "description": "The type of the device object" + }, + "class_name": { + "type": "string", + "description": "The class name of the device object" + }, + "display_name": { + "type": "string", + "description": "The display name of the device object" + }, + "comment": { + "type": "string", + "description": "The comment of the device object" + }, + "global": { + "type": "boolean", + "description": "Is a global device object" + }, + "uid": { + "type": "string", + "description": "The uid of the device object" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "The device ID of the device object" + }, + "application_id": { + "type": "integer", + "format": "int64", + "description": "Application ID of the device object" + }, + "deviceName": { + "type": "string", + "description": "Device name for device object" + } + }, + "required": [ + "management_domain", + "name", + "id", + "type", + "class_name", + "display_name", + "comment", + "global", + "uid", + "device_id", + "application_id", + "deviceName" + ] + }, + "Entry_IncidentParamKey_String": { + "type": "object", + "properties": { + "key": { + "$ref": "#/components/schemas/IncidentParamKey" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + }, + "CleanupRuleDTO": { + "type": "object", + "properties": { + "instances": { + "$ref": "#/components/schemas/RuleListDTO" + }, + "name": { + "type": "string", + "description": "Name for cleanup" + }, + "id": { + "type": "string", + "description": "Revision ID for cleanup" + }, + "code": { + "type": "string", + "description": "Code for cleanup" + }, + "devices": { + "$ref": "#/components/schemas/DeviceListDTO" + }, + "instances_total": { + "type": "integer", + "format": "int64", + "description": "Number of instances in cleanup result" + } + }, + "required": [ + "instances", + "name", + "id", + "code", + "devices", + "instances_total" + ] + }, + "FullyShadowedRulesCleanupResultsListDTO": { + "type": "object", + "properties": { + "shadowed_rule": { + "$ref": "#/components/schemas/Collection" + } + } + }, + "Incident": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "type": { + "$ref": "#/components/schemas/RiskDefinitionType" + }, + "severity": { + "$ref": "#/components/schemas/RiskSeverity" + }, + "source": { + "$ref": "#/components/schemas/RiskDefinitionSource" + }, + "description": { + "type": "string" + }, + "code": { + "type": "string" + }, + "interpretation": { + "$ref": "#/components/schemas/IncidentInterpretation" + }, + "orBetweenTufinTests": { + "type": "boolean" + }, + "params": { + "type": "string", + "format": "map" + }, + "extraInfo": { + "type": "string" + }, + "incidentType": { + "type": "integer", + "format": "int32" + } + } + }, + "RevisionListDTO": { + "type": "object", + "properties": { + "revision": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RevisionDTO" + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of total available elements" + } + }, + "required": [ + "count", + "total" + ] + }, + "RuleLastUsageListDTO": { + "type": "object", + "properties": { + "rule_last_usage": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rule_last_usage" + } + } + } + }, + "rule_last_usage": { + "type": "object", + "properties": { + "applications": { + "type": "string", + "format": "map", + "description": "Pairs of applications and applications last hits" + }, + "users": { + "type": "string", + "format": "map", + "description": "Pairs of users and users last hits" + }, + "rule_last_hit": { + "type": "string", + "description": "The date of rule last hit" + }, + "rule_UID": { + "type": "string", + "description": "The Rule uuid" + } + } + }, + "SecureCloudFWConfigurationsRequest": { + "type": "object" + }, + "RuleCountDevice": { + "type": "object", + "properties": { + "device_id": { + "type": "integer", + "format": "int32", + "description": "Device id" + }, + "revision_id": { + "type": "integer", + "format": "int32", + "description": "Revision id" + }, + "rule_count": { + "type": "integer", + "format": "int32", + "description": "Rule count" + } + } + }, + "RuleCountDeviceWithName": { + "type": "object", + "properties": { + "deviceName": { + "type": "string", + "description": "Device name" + }, + "vendor": { + "type": "string", + "description": "Vendor" + }, + "device_id": { + "type": "integer", + "format": "int32", + "description": "Device id" + }, + "revision_id": { + "type": "integer", + "format": "int32", + "description": "Revision id" + }, + "rule_count": { + "type": "integer", + "format": "int32", + "description": "Rule count" + } + } + }, + "RuleCountDeviceList": { + "type": "object", + "properties": { + "device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCountDevice" + }, + "description": "Device list" + } + } + }, + "ServiceListDTO": { + "type": "object", + "properties": { + "service": { + "$ref": "#/components/schemas/void" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of returned elements" + }, + "total": { + "type": "integer", + "format": "int64", + "description": "Number of items that can be retrieved" + } + }, + "required": [ + "count", + "total" + ] + }, + "TimeListDTO": { + "type": "object", + "properties": { + "time_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TimeDTO" + } + } + } + }, + "TimeDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the time object" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "object id" + }, + "class_name": { + "type": "string", + "description": "class name" + }, + "month": { + "type": "string" + }, + "uid": { + "type": "string", + "description": "The UID of the time object" + }, + "global": { + "type": "boolean", + "description": "Is a global time object" + }, + "comments": { + "type": "string", + "description": "The comments of the time object" + }, + "end_period": { + "type": "string", + "description": "End period of time object" + }, + "start_period": { + "type": "string", + "description": "Start period of time object" + }, + "month_days": { + "type": "string", + "description": "Relevant days of month for time object" + }, + "week_days": { + "type": "string", + "description": "Relevant week days for time object" + }, + "time_interval": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TimeIntervalDTO" + }, + "description": "Time intervals of time object" + } + }, + "required": [ + "id", + "class_name", + "uid", + "global", + "end_period", + "start_period", + "month_days", + "week_days", + "time_interval" + ] + }, + "TimeIntervalDTO": { + "type": "object", + "properties": { + "from": { + "type": "string", + "description": "Start of time interval" + }, + "to": { + "type": "string", + "description": "End of time interval" + } + } + }, + "VMDTO": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Virtual machine UID" + }, + "display_name": { + "type": "string", + "description": "Virtual machine display name" + }, + "ip": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Virtual machine IP addresses" + } + }, + "required": [ + "id", + "display_name", + "ip" + ] + }, + "RelevanceMetricsRequestDTO": { + "type": "object", + "properties": { + "source": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Source IP addresses" + }, + "dest": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Destination IP addresses" + }, + "target": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Calculations target device id" + } + }, + "required": [ + "source", + "dest", + "target" + ] + }, + "PolicyRelevanceMetricsForTrafficResponse": { + "type": "object", + "properties": { + "policy_relevance_per_target": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRelevancePerTargetDTO" + }, + "description": "Policy relevance data for outgoing traffic" + } + }, + "required": [ + "policy_relevance_per_target" + ] + }, + "PolicyRelevanceDTO": { + "type": "object", + "properties": { + "relevant_vm_count": { + "type": "integer", + "format": "int32", + "description": "Count of VMs relevant for the traffic path" + }, + "irrelevant_vm_count": { + "type": "integer", + "format": "int32", + "description": "The count of irrelevant VMs for the traffic path that are still covered by the policy" + }, + "vm": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VMDTO" + }, + "description": "Virtual machines that are covered by the policy and relevant for the traffic path" + }, + "display_name": { + "type": "string", + "description": "Policy display name, depends of policy type" + }, + "direction": { + "type": "string", + "description": "Direction of traffic" + }, + "tags": { + "type": "string", + "format": "map", + "description": "Tags applied to the policy" + }, + "policy_id": { + "type": "string", + "description": "Policy UID" + } + }, + "required": [ + "display_name", + "direction", + "policy_id" + ] + }, + "PolicyRelevancePerTargetDTO": { + "type": "object", + "properties": { + "target": { + "type": "integer", + "format": "int32", + "description": "Target device id" + }, + "policy_relevance": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRelevanceDTO" + }, + "description": "Policy relevance data for target security group UID" + } + }, + "required": [ + "target", + "policy_relevance" + ] + }, + "block_only_matrix_cell_violation": { + "type": "object", + "properties": { + "not_blocked_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + }, + "description": "The list of violating services" + }, + "not_blocked_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/application" + }, + "description": "The list of violating applications" + }, + "blocked_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + }, + "description": "The list of allowed services" + }, + "flow": { + "$ref": "#/components/schemas/FlowDTO" + }, + "flow_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "Sources that violate the flow" + }, + "flow_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "Destinations that violate the flow" + }, + "type": { + "type": "string" + }, + "from_zone": { + "$ref": "#/components/schemas/ZoneOtherDTO" + }, + "to_zone": { + "$ref": "#/components/schemas/ZoneOtherDTO" + }, + "source_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The source network objects" + }, + "destination_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The destination network objects" + } + } + }, + "AccessRequestServiceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the service of the access request" + }, + "id": { + "type": "string" + } + } + }, + "AccessRequestListDTO": { + "type": "object", + "properties": { + "access_request": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRequestDTO" + }, + "description": "List of access requests" + }, + "ticket_domain_id": { + "type": "integer", + "format": "int32", + "description": "The domain ID of the ticket" + } + }, + "required": [ + "access_request" + ] + }, + "RawServiceDTO": { + "type": "object", + "properties": { + "negate": { + "type": "boolean", + "description": "All services except for the specified service" + }, + "predefined": { + "type": "boolean", + "description": "Is a predefined service" + }, + "min_port": { + "type": "integer", + "format": "int32", + "description": "Minimum port value" + }, + "max_port": { + "type": "integer", + "format": "int32", + "description": "Maximum port value" + }, + "min_protocol": { + "type": "integer", + "format": "int32", + "description": "Minimum protocol value" + }, + "max_protocol": { + "type": "integer", + "format": "int32", + "description": "Maximum protocol value" + }, + "sAServiceId": { + "type": "integer", + "format": "int64", + "description": "The ID of the service from SecureApp" + } + }, + "required": [ + "min_port", + "max_port", + "min_protocol", + "max_protocol" + ] + }, + "implicit_service": { + "type": "object", + "properties": { + "service": { + "$ref": "#/components/schemas/RawServiceDTO" + }, + "name": { + "type": "string", + "description": "The name of the service of the access request" + }, + "id": { + "type": "string" + } + }, + "required": [ + "service" + ] + }, + "RawAction": { + "type": "object" + }, + "RestrictedCellDTO": { + "type": "object", + "properties": { + "flow": { + "$ref": "#/components/schemas/FlowDTO" + }, + "violatingServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "violatingApplications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/application" + } + }, + "requirementServices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + } + }, + "flow_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "Sources that violate the flow" + }, + "flow_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "Destinations that violate the flow" + }, + "type": { + "type": "string" + }, + "from_zone": { + "$ref": "#/components/schemas/ZoneOtherDTO" + }, + "to_zone": { + "$ref": "#/components/schemas/ZoneOtherDTO" + }, + "source_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The source network objects" + }, + "destination_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The destination network objects" + } + } + }, + "single_network_object": { + "type": "object", + "properties": { + "access_request_network": { + "$ref": "#/components/schemas/AccessRequestNetworkDTO" + } + } + }, + "SecurityPolicyMatrixType": { + "type": "object" + }, + "SecurityPolicyViolationsForMultiArDTO": { + "type": "object", + "properties": { + "security_policy_violations_for_ar": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityPolicyViolationForArDTO" + }, + "description": "The list of violations of the access request" + } + } + }, + "MatrixCellDTO": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "from_zone": { + "$ref": "#/components/schemas/ZoneOtherDTO" + }, + "to_zone": { + "$ref": "#/components/schemas/ZoneOtherDTO" + }, + "source_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The source network objects" + }, + "destination_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The destination network objects" + } + } + }, + "service_member": { + "type": "object", + "properties": { + "path": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The location of the violating service within the service group of the access request" + }, + "last_member": { + "$ref": "#/components/schemas/object_service" + } + } + }, + "AccessRequestDTO": { + "type": "object", + "properties": { + "access_request_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRequestServiceDTO" + }, + "description": "List of services" + }, + "access_request_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRequestApplicationDTO" + }, + "description": "List of applications" + }, + "action": { + "$ref": "#/components/schemas/RawAction" + }, + "source_domain_id": { + "type": "integer", + "format": "int32", + "description": "The domain ID of the source network" + }, + "destination_domain_id": { + "type": "integer", + "format": "int32", + "description": "The domain ID of the destination network" + }, + "access_request_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRequestNetworkDTO" + }, + "description": "List of source networks" + }, + "access_request_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRequestNetworkDTO" + }, + "description": "List of destination networks" + }, + "use_topology": { + "type": "boolean", + "description": "Is using topology" + }, + "access_request_order": { + "type": "integer", + "format": "int64", + "description": "The ID of the access request" + } + }, + "required": [ + "access_request_service", + "access_request_application", + "action", + "access_request_source", + "access_request_destination", + "use_topology", + "access_request_order" + ] + }, + "blocked_matrix_cell_violation": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "from_zone": { + "$ref": "#/components/schemas/ZoneOtherDTO" + }, + "to_zone": { + "$ref": "#/components/schemas/ZoneOtherDTO" + }, + "source_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The source network objects" + }, + "destination_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The destination network objects" + } + } + }, + "FlowDTO": { + "type": "object" + }, + "FlowDTO_UnifiedSecurityPolicyExceptions": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/FlowTypeDTO" + } + }, + "required": [ + "type" + ] + }, + "restricted_matrix_cell_violation": { + "type": "object", + "properties": { + "not_allowed_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + }, + "description": "The list of violating services" + }, + "not_allowed_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/application" + }, + "description": "The list of violating applications" + }, + "allowed_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInViolationDTO" + }, + "description": "The list of allowed services" + }, + "allowed_application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/application" + }, + "description": "The list of allowed applications" + }, + "flow": { + "$ref": "#/components/schemas/FlowDTO" + }, + "flow_source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "Sources that violate the flow" + }, + "flow_destination": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "Destinations that violate the flow" + }, + "type": { + "type": "string" + }, + "from_zone": { + "$ref": "#/components/schemas/ZoneOtherDTO" + }, + "to_zone": { + "$ref": "#/components/schemas/ZoneOtherDTO" + }, + "source_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The source network objects" + }, + "destination_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The destination network objects" + } + } + }, + "ServiceInViolationDTO": { + "type": "object" + }, + "unmatched_private_address_violation": { + "type": "object", + "properties": { + "violation_source_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The violating source network objects" + }, + "violation_destination_network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkObjectInViolationDTO" + }, + "description": "The violating destination network objects" + }, + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "security_zone_matrix_violation": { + "type": "object", + "properties": { + "matrix_cell_violation": { + "$ref": "#/components/schemas/MatrixCellDTO" + }, + "security_zone_matrix": { + "$ref": "#/components/schemas/SecurityZoneMatrixDTO" + }, + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "access_request_application_identity": { + "type": "object", + "properties": { + "application_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRequestServiceDTO" + }, + "description": "List of services" + }, + "non_default_ports": { + "type": "boolean", + "description": "The application identity includes non-default services" + }, + "name": { + "type": "string", + "description": "The name of the application" + } + } + }, + "single_service": { + "type": "object", + "properties": { + "access_request_service": { + "$ref": "#/components/schemas/AccessRequestServiceDTO" + } + } + }, + "AccessRequestApplicationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application" + } + } + }, + "SecurityZoneMatrixDTO": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/SecurityPolicyMatrixType" + }, + "description": { + "type": "string", + "description": "The description of security policy matrix" + }, + "name": { + "type": "string", + "description": "The name of the security policy matrix" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the security policy matrix" + }, + "domain_id": { + "type": "string", + "description": "The domain ID of the security policy matrix" + }, + "domain_name": { + "type": "string", + "description": "The domain name of the security policy matrix" + } + } + }, + "SecurityPolicyViolationForArDTO": { + "type": "object", + "properties": { + "violation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ViolationDTO" + }, + "description": "The list of security policy violations" + }, + "access_request_order": { + "type": "integer", + "format": "int64", + "description": "The ID of the access request" + }, + "cannot_compute_reason": { + "type": "string", + "description": "The reason for the violation calculation failure" + } + } + }, + "ViolationDTO": { + "type": "object", + "properties": { + "severity": { + "$ref": "#/components/schemas/SecurityPolicyViolationSeverity" + } + } + }, + "SecurityPolicyViolationSeverity": { + "type": "object" + }, + "NetworkObjectInViolationDTO": { + "type": "object" + }, + "object_service": { + "type": "object", + "properties": { + "uid": { + "type": "string", + "description": "The UID of the service object" + }, + "management_id": { + "type": "integer", + "format": "int32", + "description": "The management ID of the service object" + }, + "name": { + "type": "string", + "description": "The name of the service of the access request" + }, + "id": { + "type": "string" + } + }, + "required": [ + "uid", + "management_id" + ] + }, + "application": { + "type": "object", + "properties": { + "access_request_application": { + "type": "string", + "description": "The application of the access request" + } + } + }, + "UspAlertConfigurationStatusDTO": { + "type": "object" + }, + "UspAlertConfigurationListDTO": { + "type": "object", + "properties": { + "usp_alert_configuration": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UspAlertConfigurationDTO" + }, + "description": "The alerts list" + } + }, + "required": [ + "usp_alert_configuration" + ] + }, + "UspAlertConfigurationDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Alert name" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "Alert ID" + }, + "description": { + "type": "string", + "description": "Alert description" + }, + "status": { + "$ref": "#/components/schemas/UspAlertConfigurationStatusDTO" + }, + "domain_id": { + "type": "integer", + "format": "int32", + "description": "Domain ID" + }, + "all_devices": { + "type": "boolean", + "description": "Marked if the alert is configured for all devices" + }, + "send_syslog": { + "type": "boolean", + "description": "True if alert is sent via syslog" + }, + "emails": { + "type": "string", + "description": "The recipients email addresses" + }, + "low_severity": { + "type": "boolean", + "description": "True if alert is applicable for low severity" + }, + "medium_severity": { + "type": "boolean", + "description": "True if alert is applicable for medium severity" + }, + "high_severity": { + "type": "boolean", + "description": "True if alert is applicable for high severity" + }, + "critical_severity": { + "type": "boolean", + "description": "True if alert is applicable for critical severity" + }, + "user_id": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The recipients users" + }, + "device_id": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Device IDs to be alerted on" + } + }, + "required": [ + "name", + "id", + "status", + "domain_id", + "all_devices", + "send_syslog", + "emails", + "low_severity", + "medium_severity", + "high_severity", + "critical_severity", + "user_id", + "device_id" + ] + }, + "TagPolicyRequirementSeverity": { + "type": "object", + "properties": { + "value": { + "type": "string" + } + } + }, + "MandatoryTagPolicyRequirementDTO": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Tags list" + }, + "requirement_type": { + "type": "string", + "description": "Tag policy requirement type" + }, + "requirement_description": { + "type": "string", + "description": "Tag policy requirement description" + }, + "requirement_severity": { + "$ref": "#/components/schemas/TagPolicyRequirementSeverity" + }, + "requirement_name": { + "type": "string", + "description": "Tag policy requirement name" + } + }, + "required": [ + "tags", + "requirement_type", + "requirement_name" + ] + }, + "ValidValuesTagPolicyRequirementDTO": { + "type": "object", + "properties": { + "tag": { + "type": "string", + "description": "Tag name" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of valid values for given tag name" + }, + "requirement_type": { + "type": "string", + "description": "Tag policy requirement type" + }, + "requirement_description": { + "type": "string", + "description": "Tag policy requirement description" + }, + "requirement_severity": { + "$ref": "#/components/schemas/TagPolicyRequirementSeverity" + }, + "requirement_name": { + "type": "string", + "description": "Tag policy requirement name" + } + }, + "required": [ + "tag", + "values", + "requirement_type", + "requirement_name" + ] + }, + "TagPolicyViolationsCheckRequestDTO": { + "type": "object", + "properties": { + "tagPolicyResource": { + "$ref": "#/components/schemas/TagPolicyResource" + } + }, + "required": [ + "tagPolicyResource" + ] + }, + "TagPolicyDetailedResponseDTO": { + "type": "object", + "properties": { + "tagPolicyDTO": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagPolicyDTO" + } + }, + "errorMessage": { + "type": "string" + }, + "status": { + "type": "string", + "description": "Response status" + } + }, + "required": [ + "status" + ] + }, + "TagPolicyRequirementDTO": { + "type": "object", + "properties": { + "requirement_description": { + "type": "string", + "description": "Tag policy requirement description" + }, + "requirement_severity": { + "$ref": "#/components/schemas/TagPolicyRequirementSeverity" + }, + "requirement_name": { + "type": "string", + "description": "Tag policy requirement name" + } + }, + "required": [ + "requirement_name" + ] + }, + "TagPolicyDTO": { + "type": "object", + "properties": { + "context": { + "type": "integer", + "format": "int32", + "description": "Tag policy context" + }, + "policy_name": { + "type": "string", + "description": "Tag policy name" + }, + "requirements_last_modify_time": { + "type": "string", + "format": "date-time", + "description": "Tag policy requirements last modify time" + }, + "policy_description": { + "type": "string", + "description": "Tag policy description" + }, + "requirements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagPolicyRequirementDTO" + }, + "description": "Tag policy requirements list" + }, + "policy_id": { + "type": "string", + "description": "Tag policy external ID" + } + }, + "required": [ + "policy_name", + "requirements" + ] + }, + "InvalidTagValueViolationAttributesDTO": { + "type": "object", + "properties": { + "invalid_value": { + "type": "string", + "description": "Tag violated value" + }, + "tag": { + "type": "string", + "description": "Tag name" + }, + "valid_value": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Tag valid values" + } + }, + "required": [ + "invalid_value", + "tag", + "valid_value" + ] + }, + "TagPolicyResponseDTO": { + "type": "object", + "properties": { + "policyName": { + "type": "string" + }, + "externalId": { + "type": "string" + }, + "errorMessage": { + "type": "string" + }, + "status": { + "type": "string", + "description": "Response status" + } + }, + "required": [ + "status" + ] + }, + "TagPolicyViolationAttributesDTO": { + "type": "object" + }, + "TagPolicyViolationsResponseDTO": { + "type": "object", + "properties": { + "violations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagPolicyViolationDTO" + }, + "description": "Tag policy violations list" + }, + "errorMessage": { + "type": "string" + }, + "status": { + "type": "string", + "description": "Response status" + } + }, + "required": [ + "violations", + "status" + ] + }, + "TagPolicyResource": { + "type": "object" + }, + "MandatoryTagMissingViolationAttributesDTO": { + "type": "object", + "properties": { + "missing_tag": { + "type": "string", + "description": "Missing mandatory tag" + } + }, + "required": [ + "missing_tag" + ] + }, + "TagPolicyViolationDTO": { + "type": "object", + "properties": { + "violation_message": { + "type": "string", + "description": "Violation message" + }, + "policy_name": { + "type": "string", + "description": "Tag policy name" + }, + "policy_id": { + "type": "string", + "description": "Tag policy identifier" + }, + "requirement_severity": { + "$ref": "#/components/schemas/TagPolicyRequirementSeverity" + }, + "violation_attributes": { + "$ref": "#/components/schemas/TagPolicyViolationAttributesDTO" + }, + "requirement_name": { + "type": "string", + "description": "Tag policy requirement name" + } + }, + "required": [ + "violation_message", + "policy_name", + "policy_id", + "violation_attributes", + "requirement_name" + ] + }, + "subnet": { + "type": "object", + "properties": { + "prefix": { + "type": "string", + "description": "The CIDR prefix length of the subnet query item" + }, + "ip": { + "type": "string", + "description": "The IP address of the subnet query item" + }, + "netmask": { + "type": "string", + "description": "The network mask of the subnet query item" + }, + "id": { + "type": "string", + "description": "The ID of the query item" + } + }, + "required": [ + "prefix", + "ip", + "netmask", + "id" + ] + }, + "Node": { + "type": "object" + }, + "GroupHead": { + "type": "object" + }, + "CharPredicate": { + "type": "object" + }, + "predefined": { + "type": "object", + "properties": { + "predefined_service_name": { + "type": "string" + }, + "predefined_service_id": { + "type": "integer", + "format": "int64" + }, + "predefined_service_range": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryPredefinedServiceItemRangeDTO" + } + }, + "id": { + "type": "string" + } + } + }, + "SecurityPolicyEntryToExceptionAccessDTO": { + "type": "object", + "properties": { + "from_zone": { + "type": "string" + }, + "to_zone": { + "type": "string" + }, + "policy_name": { + "type": "string" + }, + "from_domain": { + "type": "string" + }, + "to_domain": { + "type": "string" + } + }, + "required": [ + "from_zone", + "to_zone", + "policy_name" + ] + }, + "zone": { + "type": "object", + "properties": { + "zone_name": { + "type": "string", + "description": "The name of the zone for the zone query item" + }, + "zone_id": { + "type": "string", + "description": "The ID of the zone for the zone query item" + }, + "domain_name": { + "type": "string", + "description": "The name of the domain for the zone query item" + }, + "id": { + "type": "string", + "description": "The ID of the query item" + } + }, + "required": [ + "zone_name", + "zone_id", + "domain_name", + "id" + ] + }, + "TufinTestDTO": { + "type": "object", + "properties": { + "tufin_test_description": { + "type": "string", + "description": "Description of the test" + }, + "mitigation": { + "type": "string", + "description": "Suggested mitigation action for the test" + }, + "extra_info": { + "type": "string", + "description": "Long description of the test" + } + }, + "required": [ + "tufin_test_description", + "mitigation" + ] + }, + "device_network": { + "type": "object", + "properties": { + "mgmt_id": { + "type": "string", + "description": "The management ID of the device query item" + }, + "mgmt_name": { + "type": "string", + "description": "The management name of the device query item" + }, + "network_name": { + "type": "string", + "description": "The name of the device query item" + }, + "network_uid": { + "type": "string", + "description": "The UID of the device query item" + }, + "id": { + "type": "string", + "description": "The ID of the query item" + } + }, + "required": [ + "mgmt_id", + "mgmt_name", + "network_name", + "network_uid", + "id" + ] + }, + "AccessType": { + "type": "object" + }, + "FlowViolatingObjectsDTO": { + "type": "object", + "properties": { + "negated": { + "type": "boolean", + "description": "If the flow violating objects are negated" + }, + "violating_object": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PathDTO" + }, + "description": "The objects that violate the flow" + } + }, + "required": [ + "negated", + "violating_object" + ] + }, + "QueryNetworkItemDTO": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the query item" + } + }, + "required": [ + "id" + ] + }, + "ExceptionAccessMatchingRulesDTO": { + "type": "object", + "properties": { + "matching_rules_for_device": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceMatchingRulesDTO" + }, + "description": "The matching rules" + }, + "exception_access": { + "$ref": "#/components/schemas/SecurityPolicyExceptionAccessDTO" + } + } + }, + "FlowTypeDTO": { + "type": "object" + }, + "QueryServiceItemDTO": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + }, + "MatrixRequirementDTO": { + "type": "object", + "properties": { + "from_zone": { + "type": "string", + "description": "The source zone of the requirement" + }, + "to_zone": { + "type": "string", + "description": "The destination zone of the requirement" + }, + "rule_property": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RulePropertyDTO" + }, + "description": "The rule properties that are defined for the requirement" + }, + "policy_control_name": { + "type": "string", + "description": "The name of the matrix" + }, + "flow": { + "$ref": "#/components/schemas/FlowDTO_UnifiedSecurityPolicyExceptions" + }, + "access_type": { + "$ref": "#/components/schemas/AccessType" + }, + "allowed_services": { + "$ref": "#/components/schemas/QueryServiceCollectionDTO" + }, + "blocked_services": { + "$ref": "#/components/schemas/QueryServiceCollectionDTO" + } + }, + "required": [ + "from_zone", + "to_zone", + "policy_control_name", + "access_type" + ] + }, + "Object": { + "type": "object" + }, + "QueryServiceCollectionDTO": { + "type": "object", + "properties": { + "service_item": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryServiceItemDTO" + } + }, + "id": { + "type": "string" + }, + "is_any": { + "type": "boolean" + }, + "exclude_any": { + "type": "boolean" + }, + "negate": { + "type": "boolean" + } + } + }, + "SecurityRequirementDTO": { + "type": "object" + }, + "range_network": { + "type": "object", + "properties": { + "minIp": { + "type": "string", + "description": "The first IP address of the network range query item" + }, + "maxIp": { + "type": "string", + "description": "The last IP address of the network range query item" + }, + "id": { + "type": "string", + "description": "The ID of the query item" + } + }, + "required": [ + "minIp", + "maxIp", + "id" + ] + }, + "Severity": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "RuleReferenceDTO": { + "type": "object", + "properties": { + "rule_id": { + "type": "integer", + "format": "int64", + "description": "The rule ID " + }, + "rule_link": { + "$ref": "#/components/schemas/LinkDTO" + } + } + }, + "ViolationZoneDTO": { + "type": "object", + "properties": { + "zone_name": { + "type": "string", + "description": "The name of the zone containing the violation" + }, + "network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PathDTO" + }, + "description": "The violating networks that are contained in the zone" + } + }, + "required": [ + "zone_name", + "network" + ] + }, + "RulePropertyTypeDTO": { + "type": "object" + }, + "QueryNetworkCollectionDTO": { + "type": "object", + "properties": { + "network_item": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryNetworkItemDTO" + } + }, + "id": { + "type": "string" + }, + "is_any": { + "type": "boolean" + }, + "exclude_any": { + "type": "boolean" + }, + "negate": { + "type": "boolean" + } + } + }, + "MatchingRuleDTO": { + "type": "object", + "properties": { + "ruleReference": { + "$ref": "#/components/schemas/RuleReferenceDTO" + }, + "exempted_violation_instance": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InstanceViolationDTO" + }, + "description": "Exempted violations" + } + } + }, + "PathDTO": { + "type": "object", + "properties": { + "path": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The path of the violating objects" + } + }, + "required": [ + "path" + ] + }, + "SecurityPolicyExceptionListDTO": { + "type": "object", + "properties": { + "security_policy_exception": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityPolicyExceptionDTO" + } + } + } + }, + "RulePropertyDTO": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The type of the rule property" + }, + "type": { + "$ref": "#/components/schemas/RulePropertyTypeDTO" + }, + "payload": { + "type": "string", + "description": "The payload" + } + }, + "required": [ + "description", + "type", + "payload" + ] + }, + "SecurityPolicyExceptionDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creation_date": { + "type": "string" + }, + "ticket_id": { + "type": "string" + }, + "expiration_date": { + "type": "string" + }, + "domain": { + "$ref": "#/components/schemas/DomainDTO" + }, + "created_by": { + "type": "string" + }, + "approved_by": { + "type": "string" + }, + "requested_by": { + "type": "string" + }, + "exempted_traffic": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityPolicyExceptionAccessDTO" + } + } + }, + "required": [ + "name", + "expiration_date" + ] + }, + "QueryPredefinedServiceItemRangeDTO": { + "type": "object", + "properties": { + "protocol": { + "type": "string", + "format": "int16" + }, + "min": { + "type": "integer", + "format": "int32" + }, + "max": { + "type": "integer", + "format": "int32" + }, + "negate": { + "type": "boolean" + } + } + }, + "RulePropertyViolationDTO": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/RulePropertyTypeDTO" + } + }, + "required": [ + "type" + ] + }, + "Pair": { + "type": "object", + "properties": { + "first": { + "$ref": "#/components/schemas/Object" + }, + "second": { + "$ref": "#/components/schemas/Object" + } + } + }, + "Pattern": { + "type": "object" + }, + "PCIRequirementDTO": { + "type": "object", + "properties": { + "test_name": { + "type": "string", + "description": "The name of the PCI test" + }, + "description": { + "type": "string", + "description": "The description of the PCI requirement" + }, + "profile_name": { + "type": "string", + "description": "The name of the PCI requirement profile" + } + }, + "required": [ + "test_name", + "description", + "profile_name" + ] + }, + "ViolatingServicesDTO": { + "type": "object", + "properties": { + "negated": { + "type": "boolean" + }, + "violating_service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PathDTO" + } + } + } + }, + "QueryCustomServiceItemProtocolType": { + "type": "object", + "properties": { + "value": { + "type": "integer", + "format": "int32" + }, + "portRange": { + "$ref": "#/components/schemas/Pair" + } + } + }, + "custom": { + "type": "object", + "properties": { + "port": { + "type": "string" + }, + "protocol": { + "type": "string" + }, + "id": { + "type": "string" + } + } + }, + "SecurityPolicyExceptionAccessDTO": { + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "The comment for the exception access" + }, + "status": { + "type": "string", + "description": "The status of the exception access" + }, + "service_collection": { + "$ref": "#/components/schemas/QueryServiceCollectionDTO" + }, + "zone_to_zone_security_requirement": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityPolicyEntryToExceptionAccessDTO" + } + }, + "source_entities_network_collection": { + "$ref": "#/components/schemas/QueryNetworkCollectionDTO" + }, + "source_network_collection": { + "$ref": "#/components/schemas/QueryNetworkCollectionDTO" + }, + "dest_entities_network_collection": { + "$ref": "#/components/schemas/QueryNetworkCollectionDTO" + }, + "dest_network_collection": { + "$ref": "#/components/schemas/QueryNetworkCollectionDTO" + } + }, + "required": [ + "service_collection", + "zone_to_zone_security_requirement", + "source_network_collection", + "dest_network_collection" + ] + }, + "int": { + "type": "object" + }, + "ExceptionMatchingRulesDTO": { + "type": "object", + "properties": { + "matching_rules_for_exception_access": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExceptionAccessMatchingRulesDTO" + }, + "description": "The rules that match the security policy exception" + } + } + }, + "device_service": { + "type": "object", + "properties": { + "mgmt_id": { + "type": "string" + }, + "mgmt_name": { + "type": "string" + }, + "service_name": { + "type": "string" + }, + "service_uid": { + "type": "string" + }, + "id": { + "type": "string" + } + } + }, + "DeviceMatchingRulesDTO": { + "type": "object", + "properties": { + "device_id": { + "type": "integer", + "format": "int32", + "description": "The ID of the device" + }, + "matching_rule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MatchingRuleDTO" + }, + "description": "The rules that match the security policy exception" + } + } + }, + "InstanceViolationDTO": { + "type": "object", + "properties": { + "severity": { + "$ref": "#/components/schemas/Severity" + }, + "creation_date": { + "type": "string", + "description": "Date this violation first occurred" + }, + "sources_in_zone": { + "$ref": "#/components/schemas/ViolationZoneDTO" + }, + "destinations_in_zone": { + "$ref": "#/components/schemas/ViolationZoneDTO" + }, + "security_requirement": { + "$ref": "#/components/schemas/SecurityRequirementDTO" + }, + "violating_services": { + "$ref": "#/components/schemas/ViolatingServicesDTO" + }, + "rule_property_violation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RulePropertyViolationDTO" + }, + "description": "Violations of rule properties" + }, + "flow_source_violations": { + "$ref": "#/components/schemas/FlowViolatingObjectsDTO" + }, + "flow_destination_violations": { + "$ref": "#/components/schemas/FlowViolatingObjectsDTO" + }, + "tufin_test": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TufinTestDTO" + } + } + } + }, + "range_service": { + "type": "object", + "properties": { + "minPort": { + "type": "integer", + "format": "int32" + }, + "maxPort": { + "type": "integer", + "format": "int32" + }, + "minProtocol": { + "type": "integer", + "format": "int32" + }, + "maxProtocol": { + "type": "integer", + "format": "int32" + }, + "id": { + "type": "string" + } + } + }, + "InterfaceUserMappingDTO": { + "type": "object", + "properties": { + "interface_name": { + "type": "string" + }, + "zone_user_action": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ZoneUserActionDTO" + } + } + } + }, + "ZoneUserActionDTO": { + "type": "object", + "properties": { + "zoneId": { + "type": "integer", + "format": "int32" + }, + "action": { + "type": "string" + } + } + }, + "InterfacesManualMappingsDTO": { + "type": "object", + "properties": { + "interface_manual_mapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InterfaceUserMappingDTO" + } + } + } + }, + "SecurityPolicyDeviceMappingDTO": { + "type": "object", + "properties": { + "interface": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityPolicyInterfaceDTO" + } + }, + "device_id": { + "type": "integer", + "format": "int32" + }, + "affiliated_interface": { + "$ref": "#/components/schemas/Collection" + } + }, + "required": [ + "interface", + "device_id" + ] + }, + "SecurityPolicyListDTO": { + "type": "object", + "properties": { + "securityPolicy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityPolicyDTO" + }, + "description": "The list of security policies and their details" + } + }, + "required": [ + "securityPolicy" + ] + }, + "SecurityPolicyDTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the security policy matrix" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the security policy matrix" + }, + "domain_id": { + "type": "string", + "description": "The domain ID of the security policy matrix" + }, + "domain_name": { + "type": "string", + "description": "The domain name of the security policy matrix" + } + } + }, + "SecurityPolicyInterfaceDTO": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "zone": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "zone" + ] + }, + "CountDTO": { + "type": "object", + "properties": { + "": { + "type": "integer", + "format": "int64" + } + } + }, + "Image": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "ModeType": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "MonitoringMode": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "Month": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "SubnetsBehindGatewayDTO": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "TerminalType": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "attachment": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + }, + "void": { + "type": "object", + "description": "Placeholder: the vendor's published Swagger 1.2 docs reference this type by name but do not define it." + } + } + }, + "paths": { + "/securetrack/api/bindings/{device_id}/PBR_rules": { + "get": { + "tags": [ + "Policies and Sub-Policies" + ], + "operationId": "getPBRRules", + "summary": "Get PBR routes of a specified device and interface name ", + "description": "This API returns PBR routes and ACL in the topology map", + "parameters": [ + { + "name": "device_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "The unique identifier of target device" + }, + { + "name": "inputInterfaceName", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "Interface name" + } + ], + "responses": { + "200": { + "description": "Returns PBR routes of a specified device and interface name", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/route_maps" + } + } + } + }, + "400": { + "description": "Input params are not well formatted" + }, + "404": { + "description": "Entity not found" + } + } + } + }, + "/securetrack/api/bindings/{device_id}/binding_query": { + "get": { + "tags": [ + "Policies and Sub-Policies" + ], + "operationId": "getLastInstalledVersionBindingsByVersionId", + "summary": "Get list of sub-policies (bindings) with input and/or output interfaces", + "description": "Retrieve list of bindings of input and/or output interfaces", + "parameters": [ + { + "name": "device_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "The unique identifier of target device" + }, + { + "name": "supremum_version_id", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "The unique identifier of target revision" + }, + { + "name": "inputInterfaceName", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "Input interface name" + }, + { + "name": "outputInterfaceName", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "Output interface name" + } + ], + "responses": { + "200": { + "description": "Get list of sub-policies (bindings) with input and/or output interfaces", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/BindingListDTO" + } + } + } + } + } + } + }, + "/securetrack/api/bindings/{device_id}/ipsec_communities": { + "get": { + "tags": [ + "IPsec VPN" + ], + "operationId": "GetIpsecCommunitiesForManagementId", + "summary": "Get Check Point VPN (IPSec) communities and gateways", + "description": "Get Check Point VPN (IPSec) Communities and gateways that partcipant in those communities.\nWorks on clusters and gateways, not on management servers.", + "parameters": [ + { + "name": "device_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "The unique identifier of target device" + } + ], + "responses": { + "200": { + "description": "Get Check Point VPN (IPSec) communities and gateways", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/IpsecCommunitiesDTO" + } + } + } + } + } + } + }, + "/securetrack/api/bindings/{device_id}/ipsec_tunnels": { + "get": { + "tags": [ + "IPsec VPN" + ], + "operationId": "GetIpsecTunnelsForTopologyInterface", + "summary": "Get Cisco IPsec policy and peers", + "description": "Get policy and peers defined on a Cisco crypto map which is applied to specific interface (provided through the outputInterfaceName parameter) in the running config.\nYou can retrieve the interface names by calling the /devices/id/interfaces API.", + "parameters": [ + { + "name": "device_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "The unique identifier of target device" + }, + { + "name": "outputInterfaceName", + "in": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "Interface name" + } + ], + "responses": { + "200": { + "description": "Get Cisco IPsec policy and peers", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/IpsecTunnelDTO" + } + } + } + } + } + } + }, + "/securetrack/api/bindings/{device_id}/topology_interfaces": { + "get": { + "tags": [ + "Policies and Sub-Policies" + ], + "operationId": "getBindingsForTopologyInterfaces", + "summary": "Get rules by input and output interfaces", + "parameters": [ + { + "name": "device_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "The unique identifier of target device" + }, + { + "name": "inputInterfaceName", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Input interface name" + }, + { + "name": "outputInterfaceName", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Output interface name" + }, + { + "name": "isIpv6", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Is ipv6 policy" + } + ], + "responses": { + "200": { + "description": "Get rules by input and output interfaces", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TopologyBindingRuleListDTO" + } + } + } + } + } + } + }, + "/securetrack/api/change_authorization/": { + "get": { + "tags": [ + "Change Authorization" + ], + "operationId": "changeAuthorization", + "summary": "Determine if changes between two revisions are authorized", + "description": "This API checks for unauthorized changes between any two versions of a firewall policy.\nThe API returns authorized if and only if all traffic changes between the two versions were authorized by SecureChange tickets.\nThe API returns unauthorized if there is at least one change that cannot be matched to a SecureChange ticket.\n\nThe API checks access that was granted (checked against access requests with action=Accept) as well as access that was removed (checked against access requests with action=Drop or Remove).\nThe API returns the authorization status, the relevant tickets in SecureChange and the rules that implement unauthorized access changes.\n\nNote 1: To use this API you must enable \"Authorize Revisions with Tickets\" in SecureTrack/Configuration/Ticketing.\nNote 2: Use the ID returned by the /revisions API for new_version and old_version.\nNote 3: The default value for traffic_details and ignore_tickets is false.\nNote 4: Traffic that is handled by an implicit rule will not have a rule ID.", + "parameters": [ + { + "name": "new_version", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "New version ID" + }, + { + "name": "old_version", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Old version ID" + }, + { + "name": "traffic_details", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Return unauthorized traffic change details for all modified rules" + }, + { + "name": "ignore_tickets", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Ignore SecureChange tickets and consider all traffic changes unauthorized" + } + ], + "responses": { + "200": { + "description": "Change authorization has been successfully calculated", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ChangeAuthorizationDTO" + } + } + } + }, + "400": { + "description": "Could not find the requested revisions for comparison" + } + } + } + }, + "/securetrack/api/change_authorization/policyTrafficComparison": { + "post": { + "tags": [ + "Change Authorization" + ], + "operationId": "policyTrafficComparison", + "summary": "Compare revisions on two different devices in terms of traffic.", + "description": "This API compares two arbitrary revisions from any devices. The comparison will be done in terms of allowed/denied traffic.\nThe API returns authorized if and only if there are no differences between the traffic allowed/denied by the rules in the two revisions.\nThe API returns unauthorized if there is at least one difference in terms of allowed/denied traffic between the two revisions.\nNote 1: To map policies from one revision to the other use oldId2newIdMap and provide the UIDs of the policies to be compared.\nNote 2: Parameter in the request body specifies if the result will return traffic difference details for all incompatible rules \nNote 3: The format of the result is the same as the one returned by /change_authorization \nNote 4: The API accepts in request body only one pair of oldId - newId map \nNote 5: The request is valid only if the mapping ids are found in the active policies", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyTrafficComparisonRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Policies diff was successfully calculated", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ChangeAuthorizationDTO" + } + } + } + }, + "400": { + "description": "Could not find the requested revisions for comparison" + } + } + } + }, + "/securetrack/api/change_windows/": { + "get": { + "tags": [ + "Change Windows" + ], + "operationId": "getAll", + "summary": "Get name and status for all change windows", + "description": "Retrieves a list of all change windows.\nFor valid pagination, both start and count should be provided. Otherwise, pagination is turned off. \nThe default value for get_total is false. For API calls that have pagination, set get_total to true on the first call. \nUse the value to returned in total to determine how many additional calls are required to retrieve all the desired results. \nTo improve performance, omit or set get_total to false on any subsequent calls.", + "parameters": [ + { + "name": "context", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Global MSSP context" + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Starting result for query allowable value is numeric" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Number of change windows for query starting from starting page, allowable type is numeric" + }, + { + "name": "get_total", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Set to true to get the total number of items that can be retrieved" + } + ], + "responses": { + "200": { + "description": "OK ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ChangeWindowsDTO" + } + } + } + }, + "400": { + "description": "Count parameter must be a positive value " + }, + "403": { + "description": "Not permitted to access this context " + } + } + } + }, + "/securetrack/api/change_windows/installation_targets/{mgmt_id}": { + "get": { + "tags": [ + "Change Windows" + ], + "operationId": "getInstallationTargets", + "summary": "Get installation targets for a specific management", + "description": "Retrieves installation targets for a specific management.", + "parameters": [ + { + "name": "context", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Global MSSP context" + }, + { + "name": "mgmt_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "Management Id" + } + ], + "responses": { + "200": { + "description": "OK ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PoliciesTargetsDTO" + } + } + } + }, + "403": { + "description": "Not permitted to access this context " + }, + "404": { + "description": "Failed to find installation targets for management " + } + } + } + }, + "/securetrack/api/change_windows/{uid}/tasks": { + "get": { + "tags": [ + "Change Windows" + ], + "operationId": "getTasks", + "summary": "Get a list of completed policy changes for a specific change window", + "description": "Retrieves a list of completed policy changes for a specific change window.\nFor valid pagination, both start and count should be provided. Otherwise, pagination is turned off. \nThe default value for get_total is false. For API calls that have pagination, set get_total to true on the first call. \nUse the value to returned in total to determine how many additional calls are required to retrieve all the desired results. \nTo improve performance, omit or set get_total to false on any subsequent calls.", + "parameters": [ + { + "name": "context", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Global MSSP context" + }, + { + "name": "uid", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "Change window uuid" + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Starting result for query allowable value is numeric" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Number of tasks for query starting from starting page, allowable type is numeric" + }, + { + "name": "get_total", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Set to true to get the total number of items that can be retrieved" + } + ], + "responses": { + "200": { + "description": "OK ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CommitTasks" + } + } + } + }, + "400": { + "description": "Count parameter must be a positive value " + }, + "403": { + "description": "Not permitted to access this context " + }, + "404": { + "description": "Change window with uuid was not found in domain " + } + } + } + }, + "/securetrack/api/change_windows/{uid}/tasks/{task_id}": { + "get": { + "tags": [ + "Change Windows" + ], + "operationId": "getCommitTask", + "summary": "Get scheduling and device details for a specific change window", + "description": "Retrieves scheduling and device details for a specific change window.", + "parameters": [ + { + "name": "context", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Global MSSP context" + }, + { + "name": "uid", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "Change window uuid" + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "Task Id" + } + ], + "responses": { + "200": { + "description": "OK ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CommitTask" + } + } + } + }, + "400": { + "description": "Count parameter must be a positive value " + }, + "403": { + "description": "Not permitted to access this context " + }, + "404": { + "description": "Fail to find task for change window " + } + } + } + }, + "/securetrack/api/cleanup/": { + "get": { + "tags": [ + "Policy Optimization" + ], + "operationId": "getCleanups", + "summary": "Get cleanups results", + "parameters": [ + { + "name": "context", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Global MSSP context" + }, + { + "name": "devices", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Devices ids" + } + ], + "responses": { + "200": { + "description": "Get cleanups results", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CleanupListDTO" + } + } + } + } + } + } + }, + "/securetrack/api/cleanup/{cleanup_id}/devices": { + "get": { + "tags": [ + "Policy Optimization" + ], + "operationId": "getCleanupDevices", + "summary": "Get devices in cleanup results", + "parameters": [ + { + "name": "context", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Global MSSP context" + }, + { + "name": "cleanup_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Cleanup id" + } + ], + "responses": { + "200": { + "description": "Get devices in cleanup results", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CleanupDTO" + } + } + } + } + } + } + }, + "/securetrack/api/cleanup/{cleanup_id}/instances": { + "get": { + "tags": [ + "Policy Optimization" + ], + "operationId": "getCleanupInstances", + "summary": "Get the specific objects or rules identified for the cleanup results", + "parameters": [ + { + "name": "context", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Global MSSP context" + }, + { + "name": "cleanup_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Cleanup id" + }, + { + "name": "devices", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Devices ids" + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Start" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Results count" + } + ], + "responses": { + "200": { + "description": "Get the specific objects or rules identified for the cleanup results", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CleanupDTO" + } + } + } + } + } + } + }, + "/securetrack/api/devices/": { + "get": { + "tags": [ + "Monitored Devices" + ], + "operationId": "getDevices", + "summary": "Get devices", + "description": "Returns the list of devices that are configured in SecureTrack, including the vendor, model, name, domain and device ID.\nThe results can be sorted by ip, name, vendor and model.\nFor more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .", + "parameters": [ + { + "name": "context", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "description": "Global MSSP context" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Device name" + }, + { + "name": "ip", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Device IP address" + }, + { + "name": "vendor", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Device vendor" + }, + { + "name": "model", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Device model" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Sort ascending or descending allowable types are: asc or desc " + }, + { + "name": "start", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Starting page for query allowable type is numeric" + }, + { + "name": "count", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Number of pages for query starting from starting page allowable type in numeric" + }, + { + "name": "show_os_version", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Show os version as apart of the response" + }, + { + "name": "show_license", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "Show license information for each device" + }, + { + "name": "status", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Device status, allowable values are: started, stopped, connected, disabled or error" + } + ], + "responses": { + "200": { + "description": "Get devices", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/DetailedDeviceListDTO" + } + } + } + } + } + }, + "post": { + "tags": [ + "Monitored Devices" + ], + "operationId": "addDevice", + "summary": "Add offline device", + "description": "You can choose to select the domain either by name or id using the domain_id or domain_name tags.\nDevice name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()", + "requestBody": { + "required": true, + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/st_device" + } + } + } + }, + "responses": { + "200": { + "description": "Add offline device" + } + } + } + }, + "/securetrack/api/devices/bulk/": { + "post": { + "tags": [ + "Monitored Devices" + ], + "operationId": "addDevices", + "summary": "Add devices to SecureTrack", + "description": "Use this API to add a single device or a list of devices to SecureTrack. \nThe following devices can be added: Check Point CMA R80, SMC R80, Smart 1 Cloud; Cisco ASA; Cisco Router; Cisco Nexus; Cisco XR; Cisco Meraki; Palo Alto Panorama NG; Fortinet FortiManager; Microsoft Azure; Amazon AWS; Arista CVP and EOS \nThe API body should include a JSON file with the mandatory parameters for the operation. \nString parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^(). \nCurrently supported types: CMA, SMC, Smart 1 Cloud, ASA, Cisco Router, Nexus, XR, Cisco Meraki, Panorama NG, FortiManager, Azure, AWS, Arista CVP and EOS\n\nThis API verifies connection to the provided device, before adding a device.\nThis is done by:\n  Cisco - Connect with SSH and see that the credentials are correct.\n  Check Point (Excluding Smart 1 Cloud) - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.\n  Panorama - Login through the API to check connectivity.\n  Fortimanager - Login through the API to check connectivity.\n  Arista - The SSL certificate is retrieved.\nIf the connection test fails the device will not be added.\nThe connection is not verified for Smart 1 Cloud, Cisco Router,Nexus and XR. \nOnly \"live\" device with correct credentials can be added using this API.\nFor Cisco Router, Nexus and XR there are 2 usage examples : one only with mandatory fields (device name example : Router-Cisco-mandatory-fields) and one with both mandatory and optional fields ( device name example : Router-Cisco-all-fields). \n Only for Cisco Router, the 'router_operating_system' field can take the following values: IOS, IOS-XE and IOS-XE-SDWAN. The latter corresponds to Cisco Viptela cEdge routers. \n\nWhen adding a new AWS or Azure device and the field use_cloud_organization is set to true, than the cloud_organization and account_id or subscription _id fields become mandatory. \nThe value for cloud_organization must match the name defined in the Cloud Organization settings within TOS. \nOnly users with Super Admin privileges are authorized to use this setting. \nWhen adding a new Azure subscription using the API, the usage analysis feature will be turned off by default, unless you explicitly specify \"collect_rule_usage_traffic_logs\" : true and also \"collect_object_usage_traffic_logs\" : true and also \"rule_optimizer_usage\" : true. See Azure example body - \"azure_device\"", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DevicesListDTO" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted" + }, + "408": { + "description": "Request timed out" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Task with UID already running" + } + } + }, + "patch": { + "tags": [ + "Monitored Devices" + ], + "operationId": "editDevices", + "summary": "Edit Securetrack device", + "description": "Use this API to edit the settings of a management device, including changing multiple parameters in the same call.\nThe API body should include a JSON file with the mandatory parameters for the operation.\nString parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().\nThe following devices can be edited: Check Point R80+,Check Point Smart-1, Cisco ASA, Cisco Meraki, Panorama NG, Fortinet FortiManager, Microsoft Azure, Juniper MX and SRX, Amazon AWS, Arista CVP and EOS.\nMicrosoft Azure (we currently support editing vnet and management device).\nNote: This API cannot be used to edit SecureTrack Domains and SecureTrack Servers.\nThis API verifies connection to the provided device, before updating a device. For Juniper MX only the username and password update is supported. No validation is done for these fields.\nFor Juniper SRX only the username, password and vault update is supported. Only the vault name is validated.\nFor the supported devices the validation is done by:\n  Cisco - Connect with SSH and see that the credentials are correct.\n  Check Point - Test OPSEC connectivity and verifies the connectivity for API login.\n  Panorama - Login through the API to check connectivity.\n  Fortimanager - Login through the API to check connectivity.\n  Arista - The SSL certificate is retrieved.\nIf the connection test fails the device will not be updated.\nOnly \"live\" device with correct credentials can be updated using this API. \nOnly for Cisco Router, the 'router_operating_system' field can take the following values: IOS, IOS-XE and IOS-XE-SDWAN. The latter corresponds to Cisco Viptela cEdge routers.\nWhen editing an AWS or Azure device and the field use_cloud_organization is set to true, then the field cloud_organization becomes mandatory. Additionally, the account_id or subscription_id fields can no longer be used.", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DevicesListDTO" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted" + }, + "408": { + "description": "Request timed out" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Task with UID already running" + } + } + } + }, + "/securetrack/api/devices/bulk/delete": { + "delete": { + "tags": [ + "Monitored Devices" + ], + "operationId": "deleteDevices", + "summary": "Delete SecureTrack devices in bulk", + "description": "Use this API to delete SecureTrack devices in bulk.\nThis function is supported for all devices.\nThe input for API is the Management ID (mgmt_ID).\nUse the mgmt_ID of a management device to delete it and its managed devices.\nUse multiple mgmt_IDs to delete individual devices in bulk.", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DevicesListDTO" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted" + }, + "408": { + "description": "Request timed out" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Task with UID already running" + } + } + } + }, + "/securetrack/api/devices/bulk/import": { + "post": { + "tags": [ + "Monitored Devices" + ], + "operationId": "importDevices", + "summary": "Import managed devices", + "description": "Use this API to import more managed devices to SecureTrack.\nThe following devices can be added: Device Groups (for Panorama), Administrative Domains (for FortiManager), Account (for Meraki).\nCurrently supported types: Panorama, FortiManager, Cisco ASA, Microsoft Azure, Cisco Meraki, Amazon AWS, Arista Eos.\nPlease see examples below per device id: device id 1 for Panorama, device 2 for FortiManager, device id 3 for Cisco ASA, device id 4 for Azure, device id 5 for Meraki, device id 6 for Amazon, device id 7 for Arista Eos.", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DevicesListDTO" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted" + }, + "408": { + "description": "Request timed out" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Task with UID already running" + } + } + } + }, + "/securetrack/api/devices/bulk/tasks/{task_uid}": { + "get": { + "tags": [ + "Monitored Devices" + ], + "operationId": "showTask", + "summary": "Get specific task results of bulk operations on devices", + "description": "Use this API to track in-progress actions involving monitored devices. A list of devices and their status is displayed.\nThe API supports actions initiated by:\n- /securetrack/api/devices/bulk - in the case of failure, the relevant device is added to the \"failed\" list with the status element containing the description. Example: \"No connection to device. \"\n- /securetrack/api/devices/bulk/update_topology_data", + "parameters": [ + { + "name": "task_uid", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "Task UID" + } + ], + "responses": { + "404": { + "description": "The task with the given UID was not found" + }, + "400": { + "description": "Bad request" + }, + "200": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaskResultDTO" + } + } + } + }, + "408": { + "description": "Request timed out" + }, + "500": { + "description": "Internal server error" + } + } + } + }, + "/securetrack/api/devices/bulk/update_topology_data": { + "post": { + "tags": [ + "Monitored Devices" + ], + "operationId": "updateTopologyData", + "summary": "Update topology data", + "description": "Use this API to manually trigger retrieval of topology data collection.\nThis functionality is applicable to all root devices with dynamic topology setting enabled.\nThe topology data will be retrieved for the root device and all of its managed devices.\nUse /securetrack/api/devices/bulk/tasks/{task_uid} API to track the progress of the retrieval.\nAfter the task status is complete, run Fast Topology Sync to see the updated device topology on the map.