@itentialopensource/adapter-tufin_secureapp

openapi: 3.0.0 info: title: Tufin-SecureApp-R19-2-RC1 description: Tufin Orchestration Suite - Tufin SecureChange/SecureApp APIs. For detailed information about the APIs please see the documentation at: https://your-securetrack-server/securechangeworkflow/apidoc contact: {} version: '1.0' servers: - url: http://example.com/securechangeworkflow/api variables: {} paths: /secureapp/repository/applications/{applicationId}/application_access_requests: get: tags: - Access Portal summary: Retrieveexistingapplicationaccessrequests description: 'Parameters: applicationId: The unique identifier of the application Usage Example https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests Response Messages: 400: The application was already deleted. 401: Access is denied 401: You do not have permission to access application with ID 401: No available licenses. Ask your SecureApp administrator for assistance. 404: There is no application with the specified ID.' operationId: Retrieveexistingapplicationaccessrequests parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: applicationId in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - Access Portal summary: Createapplicationaccessrequest description: 'Parameters: applicationId: The unique identifier of the application body: application access request Usage Example <table><tr><td>URL</td><td>https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests</td></tr><tr><td>BODY</td><td><application_access_request>     <server_group_id>1</server_group_id>     <server_ip>1.1.1.1</server_ip>     <comment>Request to join the WebServers server group</comment> </application_access_request></td></tr></table> Response Messages: 201: Application access request was submitted. 400: The application was already deleted. 400: Server id cannot be empty. 400: Hostname or IP cannot be empty. 400: The provided server does not exist in application. 400: The provided server is not allowed to access. 400: Request already created 400: Requester cannot be null 400: Group cannot be empty 400: Invalid ip 401: Access is denied 401: No available licenses. Ask your SecureApp administrator for assistance. 404: There is no application with the specified ID.' operationId: Createapplicationaccessrequest parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/xml type: string example: application/xml - name: applicationId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/xml: schema: allOf: - $ref: '#/components/schemas/application_access_request' - xml: name: application_access_request attribute: false wrapped: false example: >- <application_access_request> <server_group_id>1</server_group_id> <server_ip>1.1.1.1</server_ip> <comment>Request to join the WebServers server group</comment> </application_access_request> example: >- <application_access_request> <server_group_id>1</server_group_id> <server_ip>1.1.1.1</server_ip> <comment>Request to join the WebServers server group</comment> </application_access_request> required: true responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Access Portal summary: Updateapplicationaccessrequests description: 'Use this API to approve or reject application access requests Parameters: applicationId: The unique identifier of the application body: application access requests Usage Example <table><tr><td>URL</td><td>https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests</td></tr><tr><td>BODY</td><td><application_access_requests>     <application_access_request>         <id>1</id>         <action>APPROVE</action>     </application_access_request>     <application_access_request>         <id>2</id>         <action>REJECT</action>     </application_access_request> </application_access_requests></td></tr></table> Response Messages: 200: Application access requests were updated. 400: The application was already deleted. 400: Invalid ID for access request 400: Cannot update access request with id ID 400: Action cannot be empty in request with id ID 400: Invalid action in request with id ID 400: The Server group is lock for discovery 401: Access is denied 401: No available licenses. Ask your SecureApp administrator for assistance. 404: There is no application with the specified ID.' operationId: Updateapplicationaccessrequests parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/xml type: string example: application/xml - name: applicationId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/xml: schema: allOf: - $ref: '#/components/schemas/application_access_requests' - xml: name: application_access_requests attribute: false wrapped: false example: >- <application_access_requests> <application_access_request> <id>1</id> <action>APPROVE</action> </application_access_request> <application_access_request> <id>2</id> <action>REJECT</action> </application_access_request> </application_access_requests> example: >- <application_access_requests> <application_access_request> <id>1</id> <action>APPROVE</action> </application_access_request> <application_access_request> <id>2</id> <action>REJECT</action> </application_access_request> </application_access_requests> required: true responses: '200': description: '' headers: {} content: {} deprecated: false /secureapp/repository/applications/{applicationId}/application_access_requests/{requestId}: get: tags: - Access Portal summary: RetrieveanexistingapplicationaccessrequestbyID description: 'Parameters: applicationId: The unique identifier of the application requestId: The unique identifier of the application access request Usage Example https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1 Response Messages: 400: The application was already deleted. 401: Access is denied 401: You do not have permission to access application with ID 401: No available licenses. Ask your SecureApp administrator for assistance. 404: There is no application with the specified ID. 404: Access request with id ID was not found in application with id ID' operationId: RetrieveanexistingapplicationaccessrequestbyID parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: applicationId in: path description: '' required: true style: simple schema: type: string - name: requestId in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Access Portal summary: Updateanapplicationaccessrequest description: 'Use this API to approve or reject application access requests Parameters: applicationId: The unique identifier of the application requestId: The unique identifier of the application access request body: application access request Usage Example <table><tr><td>URL</td><td>https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1</td></tr><tr><td>BODY</td><td><application_access_request>     <action>APPROVE</action> </application_access_request></td></tr></table> Response Messages: 200: Application access request was updated. 400: The application was already deleted. 400: Invalid ID for access request 400: Cannot update access request with id ID 400: Action cannot be empty in request with id ID 400: Invalid action in request with id ID 400: The Server group is lock for discovery 401: Access is denied 401: No available licenses. Ask your SecureApp administrator for assistance. 404: There is no application with the specified ID.' operationId: Updateanapplicationaccessrequest parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/xml type: string example: application/xml - name: applicationId in: path description: '' required: true style: simple schema: type: string - name: requestId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/xml: schema: allOf: - $ref: '#/components/schemas/application_access_request2' - xml: name: application_access_request attribute: false wrapped: false example: >- <application_access_request> <action>APPROVE</action> </application_access_request> example: >- <application_access_request> <action>APPROVE</action> </application_access_request> required: true responses: '200': description: '' headers: {} content: {} deprecated: false /secureapp/repository/applications/{applicationId}/connections: post: tags: - Application Connections summary: Createconnections description: 'Parameters: applicationId: The unique identifier of the application body: The list of the connections Usage Example <table><tr><td>URL</td><td>https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections</td></tr><tr><td>BODY</td><td><connections>      <connection>          <name>Connection A</name>          <comment>Connection A comment</comment>          <sources>              <source>                  <id>2</id>              </source>              <source>                  <id>3</id>              </source>          </sources>          <services>              <service>                  <id>1</id>              </service>          </services>          <destinations>              <destination>                  <id>1</id>              </destination>          </destinations>      </connection>      <connection>          <name>Connection B</name>      </connection>      <connection>          <name>Connection C</name>          <sources>              <source>                  <id>2</id>              </source>          </sources>      </connection> </connections></td></tr></table> Response Messages: 200: Connections were created. 201: Connection was created. 400: There are no items to add. 400: You cannot add to application NAME because it was decommissioned. 400: Connection name already exists. 400: Reference to service ID is invalid. 400: Reference to source/destination with ID is invalid. 400: Connection NAME contains duplicate destinations. 400: Destination cannot contain users. 400: Resource cannot contain other objects along with Any. 400: Connection NAME contains duplicate sources. 400: You cannot add external resources to interface connections. 400: You cannot have Any in both the source and destination. 400: You cannot add external resources to interface connections. 400: Source cannot contain both users and servers. 400: Connection NAME contains duplicate services. 400: Cannot contain other services along with ANY. 400: Connections can only include objects within the same customer. 401: You do not have permission to access application that contains the server ID 401: No available licenses. Ask your SecureApp administrator for assistance. 401: You do not have permissions to edit this application. 401: Access is denied 404: There is no application with the specified ID.' operationId: Createconnections parameters: - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/xml type: string example: application/xml - name: applicationId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/xml: schema: allOf: - $ref: '#/components/schemas/connections' - xml: name: connections attribute: false wrapped: false example: >- <connections> <connection> <name>Connection A</name> <comment>Connection A comment</comment> <sources> <source> <id>2</id> </source> <source> <id>3</id> </source> </sources> <services> <service> <id>1</id> </service> </services> <destinations> <destination> <id>1</id> </destination> </destinations> </connection> <connection> <name>Connection B</name> </connection> <connection> <name>Connection C</name> <sources> <source> <id>2</id> </source> </sources> </connection> </connections> example: >- <connections> <connection> <name>Connection A</name> <comment>Connection A comment</comment> <sources> <source> <id>2</id> </source> <source> <id>3</id> </source> </sources> <services> <service> <id>1</id> </service> </services> <destinations> <destination> <id>1</id> </destination> </destinations> </connection> <connection> <name>Connection B</name> </connection> <connection> <name>Connection C</name> <sources> <source> <id>2</id> </source> </sources> </connection> </connections> required: true responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Application Connections summary: Updateconnections description: 'Parameters: applicationId: The unique identifier of the application body: List of connections Usage Example <table><tr><td>URL</td><td>https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections</td></tr><tr><td>BODY</td><td><connections>      <connection>          <id>1</id>          <name>Connection A</name>          <comment>Connection A comment</comment>          <sources>              <source>                  <id>2</id>              </source>              <source>                  <id>3</id>              </source>          </sources>          <services>              <service>                  <id>1</id>              </service>          </services>          <destinations>              <destination>                  <id>1</id>              </destination>          </destinations>      </connection>      <connection>          <id>2</id>          <name>Connection B</name>      </connection>      <connection>          <id>3</id>          <name>Connection C</name>          <sources>              <source>                  <id>2</id>              </source>          </sources>      </connection> </connections></td></tr></table> Response Messages: 200: Connections were modified. 400: Reference to service ID is invalid. 400: Reference to source/destination with ID is invalid. 400: Connection name cannot be empty. 400: Connection name already exists. 400: Connection NAME contains duplicate destinations. 400: Destination cannot contain users. 400: Resource cannot contain other objects along with Any. 400: Connection NAME contains duplicate sources. 400: You cannot add external resources to interface connections. 400: You cannot have Any in both the source and destination. 400: You cannot add external resources to interface connections. 400: Source cannot contain both users and servers. 400: Connection NAME contains duplicate services. 400: Cannot contain other services along with ANY. 400: Connections can only include objects within the same customer. 401: No available licenses. Ask your SecureApp administrator for assistance. 401: You do not have permission to access application that contains the server ID 401: You do not have permissions to edit this application. 401: Access is denied 401: You cannot edit or delete an external connection. 404: There is no application with the specified ID. 404: Connection with ID was not found for application with ID.' operationId: Updateconnections parameters: - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/xml type: string example: application/xml - name: applicationId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/xml: schema: allOf: - $ref: '#/components/schemas/connections1' - xml: name: connections attribute: false wrapped: false example: >- <connections> <connection> <id>1</id> <name>Connection A</name> <comment>Connection A comment</comment> <sources> <source> <id>2</id> </source> <source> <id>3</id> </source> </sources> <services> <service> <id>1</id> </service> </services> <destinations> <destination> <id>1</id> </destination> </destinations> </connection> <connection> <id>2</id> <name>Connection B</name> </connection> <connection> <id>3</id> <name>Connection C</name> <sources> <source> <id>2</id> </source> </sources> </connection> </connections> example: >- <connections> <connection> <id>1</id> <name>Connection A</name> <comment>Connection A comment</comment> <sources> <source> <id>2</id> </source> <source> <id>3</id> </source> </sources> <services> <service> <id>1</id> </service> </services> <destinations> <destination> <id>1</id> </destination> </destinations> </connection> <connection> <id>2</id> <name>Connection B</name> </connection> <connection> <id>3</id> <name>Connection C</name> <sources> <source> <id>2</id> </source> </sources> </connection> </connections> required: true responses: '200': description: '' headers: {} content: {} deprecated: false get: tags: - Application Connections summary: Retrieveexistingconnections description: 'Parameters: applicationId: The unique identifier of the application name: The name of the connection [optional] Usage Example https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections Usage Example https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections?name=Connection Name Response Messages: 401: No available licenses. Ask your SecureApp administrator for assistance. 401: Access is denied 401: You do not have permission to access application with ID 404: There is no application with the specified ID. 404: There are no connections with the name NAME.' operationId: Retrieveexistingconnections parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: applicationId in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /secureapp/repository/applications/{applicationId}/connections_extended: get: tags: - Application Connections summary: Retrieveexistingconnections,withextendedresourcesinformation description: 'Parameters: applicationId: The unique identifier of the application name: The name of the connection [optional] start: Return results starting only from the specified index; 0-based index; default value = 0 [optional] count: Return the specified number of results. Returns all results if no value specified [optional] Usage Example https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended Usage Example https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name Usage Example https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name&start=50&count=100 Response Messages: 400: Start value cannot be a negative number. 400: Count value must be greater than 0. 401: No available licenses. Ask your SecureApp administrator for assistance. 401: Access is denied. 404: There is no application with the specified ID. 404: There are no connections with the name NAME.' operationId: Retrieveexistingconnections,withextendedresourcesinformation parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: applicationId in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /secureapp/repository/applications/{application_id}/connections/{connection_id}/repair: post: tags: - Application Connections summary: Createatickettorepairaconnection description: 'Parameters: application_id: The application ID connection_id: The connection ID body: Ticket Usage Example <table><tr><td>URL</td><td>https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/2/repair</td></tr><tr><td>BODY</td><td><ticket>     <subject>Repair connection 2</subject>     <requester>u1</requester>     <priority>Normal</priority>     <workflow>         <name>Workflow with topology</name>     </workflow>     <steps>         <step>             <name>Open request</name>             <tasks>                 <task>                     <fields>                         <field xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="text_area">                             <name>Business Justification</name>                             <text>I need access to ftp </text>                         </field>                         <field xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="text_field">                             <name>Project Number</name>                             <text>CR124560</text>                         </field>                         <field xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="hyperlink">                             <name>Hyperlink</name>                             <url>http://192.168.1.1/ticket</url>                         </field>                         <field xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="drop_down_list">                             <name>Change Window</name>                             <selection>Monday</selection>                         </field>                         <field xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="manager">                             <name>manager email</name>                             <text>manager@tufin.com</text>                         </field>                     </fields>                 </task>             </tasks>         </step>     </steps>     <comments/> </ticket></td></tr></table> Response Messages: 201: Ticket was created. 401: Access is denied. 401: To create a ticket you must purchase a valid SecureChange license. 401: No available licenses. Ask your SecureApp administrator for assistance. 401: You do not have permissions to edit this application. 404: There is no application with the specified ID. 404: Connection with ID was not found for application with ID. 403: Cannot create a ticket to repair this connection because the connection status is not disconnected. 403: Cannot create a ticket to repair this connection because the connection was edited but a ticket has not been created yet. 403: Cannot create a ticket to repair this connection because there are other open tickets for an application that includes this connection. 400: The requester must be the currently logged in user. 400: Workflow was not found. 400: Workflow is not active. 400: Workflow configuration is not valid. 400: Workflow is not set. 401: Logged in user: NAME do not have permission to perform on behalf actions. 401: You are not a participant in the first step of this workflow. 400: You cannot enter a status for a new ticket. 400: Requester cannot open a ticket in domain. 400: Invalid ticket priority. 400: Expiration field is required. 400: Submit ticket enabled only with the first step. 400: First step can be only with one task. 400: The specified workflow does not contain an access request field in the first step. 400: You cannot use an access request field to create a ticket from SecureApp. 400: The ticket fields do not match the fields in the current step of the workflow. 400: You cannot change the value of a field because it is read-only.' operationId: Createatickettorepairaconnection parameters: - name: Accept in: header description: '' required: true style: simple schema: type: string example: application/json - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/xml type: string example: application/xml - name: application_id in: path description: '' required: true style: simple schema: type: string - name: connection_id in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/xml: schema: allOf: - $ref: '#/components/schemas/ticket' - xml: name: ticket attribute: false wrapped: false example: >- <ticket> <subject>Repair connection 2</subject> <requester>u1</requester> <priority>Normal</priority> <workflow> <name>Workflow with topology</name> </workflow> <steps> <step> <name>Open request</name> <tasks> <task> <fields> <field type="text_area"> <name>Business Justification</name> <text>I need access to ftp </text> </field> <field type="text_field"> <name>Project Number</name> <text>CR124560</text> </field> <field type="hyperlink"> <name>Hyperlink</name> <url>http://192.168.1.1/ticket</url> </field> <field type="drop_down_list"> <name>Change Window</name> <selection>Monday</selection> </field> <field type="manager"> <name>manager email</name> <text>manager@tufin.com</text> </field> </fields> </task> </tasks> </step> </steps> </ticket> example: >- <ticket> <subject>Repair connection 2</subject> <requester>u1</requester> <priority>Normal</priority> <workflow> <name>Workflow with topology</name> </workflow> <steps> <step> <name>Open request</name> <tasks> <task> <fields> <field type="text_area"> <name>Business Justification</name> <text>I need access to ftp </text> </field> <field type="text_field"> <name>Project Number</name> <text>CR124560</text> </field> <field type="hyperlink"> <name>Hyperlink</name> <url>http://192.168.1.1/ticket</url> </field> <field type="drop_down_list"> <name>Change Window</name> <selection>Monday</selection> </field> <field type="manager"> <name>manager email</name> <text>manager@tufin.com</text> </field> </fields> </task> </tasks> </step> </steps> </ticket> required: true responses: '200': description: '' headers: {} content: {} deprecated: false /secureapp/repository/applications/{applicationId}/connections/{connectionId}: delete: tags: - Application Connections summary: Deleteconnection description: 'Parameters: applicationId: The unique identifier of the application connectionId: The unique identifier of the connection Usage Example https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1 Response Messages: 200: Connection was deleted. 401: No available licenses. Ask your SecureApp administrator for assistance. 401: You do not have permissions to edit this application. 401: Access is denied 401: You cannot edit or delete an external connection. 404: There is no application with the specified ID. 404: Connection with ID was not found for application with ID.' operationId: Deleteconnection parameters: - name: applicationId in: path description: '' required: true style: simple schema: type: string - name: connectionId in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Application Connections summary: Updateaconnection description: 'Parameters: applicationId: The unique identifier of the application connectionId: The unique identifier of the connection body: Connection Usage Example <table><tr><td>URL</td><td>https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections/1</td></tr><tr><td>BODY</td><td> <connection>      <name>Connection A</name>      <comment>Connection A comment</comment>      <sources>          <source>              <id>2</id>          </source>          <source>              <id>3</id>          </source>      </sources>      <services>          <service>              <id>1</id>          </service>      </services>      <destinations>          <destination>              <id>1</id>          </destination>      </destinations> </connection></td></tr></table> Response Messages: 200: Connection was modified. 400: Reference to service ID is invalid. 400: Reference to source/destination with ID is invalid. 400: Connection name cannot be empty. 400: Connection name already exists. 400: Connection NAME contains duplicate destinations. 400: Destination cannot contain users. 400: Resource cannot contain other objec