UNPKG

@itentialopensource/adapter-tufin_secureapp

Version:

This adapter integrates with system: sample.

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