@itentialopensource/adapter-tufin_secureapp
Version:
This adapter integrates with system: sample.
611 lines • 532 kB
JSON
{
"info": {
"_postman_id": "b5956db8-8e5a-41b1-a975-6bb4d8f75f6c",
"name": "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",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Access Portal",
"item": [
{
"name": "Retrieve existing application access requests",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"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."
},
"response": []
},
{
"name": "Create application access request",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": {
"mode": "raw",
"raw": "<application_access_request>\n\t<server_group_id>1</server_group_id>\n\t<server_ip>1.1.1.1</server_ip>\n\t<comment>Request to join the WebServers server group</comment>\n</application_access_request>"
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"application_access_requests"
]
},
"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><application_access_request><br> <server_group_id>1</server_group_id><br> <server_ip>1.1.1.1</server_ip><br> <comment>Request to join the WebServers server group</comment><br></application_access_request></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."
},
"response": []
},
{
"name": "Update application access requests",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": {
"mode": "raw",
"raw": "<application_access_requests>\n\t<application_access_request>\n\t\t<id>1</id>\n\t\t<action>APPROVE</action>\n\t</application_access_request>\n\t<application_access_request>\n\t\t<id>2</id>\n\t\t<action>REJECT</action>\n\t</application_access_request>\n</application_access_requests>"
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"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><application_access_requests><br> <application_access_request><br> <id>1</id><br> <action>APPROVE</action><br> </application_access_request><br> <application_access_request><br> <id>2</id><br> <action>REJECT</action><br> </application_access_request><br></application_access_requests></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."
},
"response": []
},
{
"name": "Retrieve an existing application access request by ID",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"application_access_requests",
"{{requestId}}"
]
},
"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"
},
"response": []
},
{
"name": "Update an application access request",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": {
"mode": "raw",
"raw": "<application_access_request>\n\t<action>APPROVE</action>\n</application_access_request>"
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"application_access_requests",
"{{requestId}}"
]
},
"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><application_access_request><br> <action>APPROVE</action><br></application_access_request></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."
},
"response": []
}
]
},
{
"name": "Application Connections",
"item": [
{
"name": "Create connections",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": {
"mode": "raw",
"raw": "<connections>\n\t <connection>\n\t\t <name>Connection A</name>\n\t\t <comment>Connection A comment</comment>\n\t\t <sources>\n\t\t\t <source>\n\t\t\t\t <id>2</id>\n\t\t\t </source>\n\t\t\t <source>\n\t\t\t\t <id>3</id>\n\t\t\t </source>\n\t\t </sources>\n\t\t <services>\n\t\t\t <service>\n\t\t\t\t <id>1</id>\n\t\t\t </service>\n\t\t </services>\n\t\t <destinations>\n\t\t\t <destination>\n\t\t\t\t <id>1</id>\n\t\t\t </destination>\n\t\t </destinations>\n\t </connection>\n\t <connection>\n\t\t <name>Connection B</name>\n\t </connection>\n\t <connection>\n\t\t <name>Connection C</name>\n\t\t <sources>\n\t\t\t <source>\n\t\t\t\t <id>2</id>\n\t\t\t </source>\n\t\t </sources>\n\t </connection>\n</connections>"
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"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><connections><br> <connection><br> <name>Connection A</name><br> <comment>Connection A comment</comment><br> <sources><br> <source><br> <id>2</id><br> </source><br> <source><br> <id>3</id><br> </source><br> </sources><br> <services><br> <service><br> <id>1</id><br> </service><br> </services><br> <destinations><br> <destination><br> <id>1</id><br> </destination><br> </destinations><br> </connection><br> <connection><br> <name>Connection B</name><br> </connection><br> <connection><br> <name>Connection C</name><br> <sources><br> <source><br> <id>2</id><br> </source><br> </sources><br> </connection><br></connections></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."
},
"response": []
},
{
"name": "Update connections",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": {
"mode": "raw",
"raw": "<connections>\n\t <connection>\n\t\t <id>1</id>\n\t\t <name>Connection A</name>\n\t\t <comment>Connection A comment</comment>\n\t\t <sources>\n\t\t\t <source>\n\t\t\t\t <id>2</id>\n\t\t\t </source>\n\t\t\t <source>\n\t\t\t\t <id>3</id>\n\t\t\t </source>\n\t\t </sources>\n\t\t <services>\n\t\t\t <service>\n\t\t\t\t <id>1</id>\n\t\t\t </service>\n\t\t </services>\n\t\t <destinations>\n\t\t\t <destination>\n\t\t\t\t <id>1</id>\n\t\t\t </destination>\n\t\t </destinations>\n\t </connection>\n\t <connection>\n\t\t <id>2</id>\n\t\t <name>Connection B</name>\n\t </connection>\n\t <connection>\n\t\t <id>3</id>\n\t\t <name>Connection C</name>\n\t\t <sources>\n\t\t\t <source>\n\t\t\t\t <id>2</id>\n\t\t\t </source>\n\t\t </sources>\n\t </connection>\n</connections>"
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"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><connections><br> <connection><br> <id>1</id><br> <name>Connection A</name><br> <comment>Connection A comment</comment><br> <sources><br> <source><br> <id>2</id><br> </source><br> <source><br> <id>3</id><br> </source><br> </sources><br> <services><br> <service><br> <id>1</id><br> </service><br> </services><br> <destinations><br> <destination><br> <id>1</id><br> </destination><br> </destinations><br> </connection><br> <connection><br> <id>2</id><br> <name>Connection B</name><br> </connection><br> <connection><br> <id>3</id><br> <name>Connection C</name><br> <sources><br> <source><br> <id>2</id><br> </source><br> </sources><br> </connection><br></connections></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."
},
"response": []
},
{
"name": "Retrieve existing connections",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"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."
},
"response": []
},
{
"name": "Retrieve existing connections, with extended resources information",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_extended",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"connections_extended"
]
},
"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."
},
"response": []
},
{
"name": "Create a ticket to repair a connection",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": {
"mode": "raw",
"raw": "<ticket>\n\t<subject>Repair connection 2</subject>\n\t<requester>u1</requester>\n\t<priority>Normal</priority>\n\t<workflow>\n\t\t<name>Workflow with topology</name>\n\t</workflow>\n\t<steps>\n\t\t<step>\n\t\t\t<name>Open request</name>\n\t\t\t<tasks>\n\t\t\t\t<task>\n\t\t\t\t\t<fields>\n\t\t\t\t\t\t<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">\n\t\t\t\t\t\t\t<name>Business Justification</name>\n\t\t\t\t\t\t\t<text>I need access to ftp </text>\n\t\t\t\t\t\t</field>\n\t\t\t\t\t\t<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">\n\t\t\t\t\t\t\t<name>Project Number</name>\n\t\t\t\t\t\t\t<text>CR124560</text>\n\t\t\t\t\t\t</field>\n\t\t\t\t\t\t<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">\n\t\t\t\t\t\t\t<name>Hyperlink</name>\n\t\t\t\t\t\t\t<url>http://192.168.1.1/ticket</url>\n\t\t\t\t\t\t</field>\n\t\t\t\t\t\t<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">\n\t\t\t\t\t\t\t<name>Change Window</name>\n\t\t\t\t\t\t\t<selection>Monday</selection>\n\t\t\t\t\t\t</field>\n\t\t\t\t\t\t<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">\n\t\t\t\t\t\t\t<name>manager email</name>\n\t\t\t\t\t\t\t<text>manager@tufin.com</text>\n\t\t\t\t\t\t</field>\n\t\t\t\t\t</fields>\n\t\t\t\t</task>\n\t\t\t</tasks>\n\t\t</step>\n\t</steps>\n\t<comments/>\n</ticket>"
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connections/{{connection_id}}/repair",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{application_id}}",
"connections",
"{{connection_id}}",
"repair"
]
},
"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><ticket><br> <subject>Repair connection 2</subject><br> <requester>u1</requester><br> <priority>Normal</priority><br> <workflow><br> <name>Workflow with topology</name><br> </workflow><br> <steps><br> <step><br> <name>Open request</name><br> <tasks><br> <task><br> <fields><br> <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\"><br> <name>Business Justification</name><br> <text>I need access to ftp </text><br> </field><br> <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\"><br> <name>Project Number</name><br> <text>CR124560</text><br> </field><br> <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\"><br> <name>Hyperlink</name><br> <url>http://192.168.1.1/ticket</url><br> </field><br> <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\"><br> <name>Change Window</name><br> <selection>Monday</selection><br> </field><br> <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\"><br> <name>manager email</name><br> <text>manager@tufin.com</text><br> </field><br> </fields><br> </task><br> </tasks><br> </step><br> </steps><br> <comments/><br></ticket></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."
},
"response": []
},
{
"name": "Delete connection",
"request": {
"method": "DELETE",
"header": [],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "applicationId",
"value": null,
"type": "text"
},
{
"key": "connectionId",
"value": null,
"type": "text"
}
]
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"connections",
"{{connectionId}}"
]
},
"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."
},
"response": []
},
{
"name": "Update a connection",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": {
"mode": "raw",
"raw": " <connection>\n\t <name>Connection A</name>\n\t <comment>Connection A comment</comment>\n\t <sources>\n\t\t <source>\n\t\t\t <id>2</id>\n\t\t </source>\n\t\t <source>\n\t\t\t <id>3</id>\n\t\t </source>\n\t </sources>\n\t <services>\n\t\t <service>\n\t\t\t <id>1</id>\n\t\t </service>\n\t </services>\n\t <destinations>\n\t\t <destination>\n\t\t\t <id>1</id>\n\t\t </destination>\n\t </destinations>\n </connection>"
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"connections",
"{{connectionId}}"
]
},
"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> <connection><br> <name>Connection A</name><br> <comment>Connection A comment</comment><br> <sources><br> <source><br> <id>2</id><br> </source><br> <source><br> <id>3</id><br> </source><br> </sources><br> <services><br> <service><br> <id>1</id><br> </service><br> </services><br> <destinations><br> <destination><br> <id>1</id><br> </destination><br> </destinations><br> </connection></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."
},
"response": []
},
{
"name": "Retrieve an existing connection by ID",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"connections",
"{{connectionId}}"
]
},
"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."
},
"response": []
}
]
},
{
"name": "Application Identities",
"item": [
{
"name": "Fetches application identities",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/application_identities",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"application_identities"
]
},
"description": "Fetches the list of pre-defined application identities (like facebook) that can be used in a connection.<br><br><u>Parameters:</u><br>name: The name of the service [optional]<br><br><u>Usage Example</u><br>https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities<br><br><u>Usage Example</u><br>https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities?name=facebook<br><br><u>Response Messages:</u><br>404: There are no application identities with the name NAME.<br>401: Access is denied."
},
"response": []
}
]
},
{
"name": "Application Interfaces",
"item": [
{
"name": "Delete interface connection",
"request": {
"method": "DELETE",
"header": [],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "applicationId",
"value": null,
"type": "text"
},
{
"key": "applicationInterfaceId",
"value": null,
"type": "text"
},
{
"key": "connectionInterfaceId",
"value": null,
"type": "text"
}
]
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"application_interfaces",
"{{applicationInterfaceId}}",
"interface_connections",
"{{connectionInterfaceId}}"
]
},
"description": "<u>Parameters:</u><br>applicationId: The unique identifier of the application<br>applicationInterfaceId: The unique identifier of the application interface<br>connectionInterfaceId: The unique identifier of the interface connection<br><br><u>Usage Example</u><br>https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1<br><br><u>Response Messages:</u><br>200: Interface connection was deleted.<br>401: Access is denied<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: Application interface with ID was not found for application with ID.<br>404: Connection interface with ID was not found for application interface with ID."
},
"response": []
},
{
"name": "Update an interface connection",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": {
"mode": "raw",
"raw": "<interface_connection>\n\t<name>Updated name</name>\n\t<sources>\n\t\t<source>\n\t\t\t<id>19</id>\n\t\t</source>\n\t</sources>\n\t<services>\n\t\t<service>\n\t\t\t<id>9</id>\n\t\t</service>\n\t</services>\n\t<comment>Updated connection</comment>\n</interface_connection>"
},
"url": {
"raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}",
"protocol": "https",
"host": [
"{{SecureApp_IP}}"
],
"path": [
"securechangeworkflow",
"api",
"secureapp",
"repository",
"applications",
"{{applicationId}}",
"application_interfaces",
"{{applicationInterfaceId}}",
"interface_connections",
"{{connectionInterfaceId}}"
]
},
"description": "<u>Parameters:</u><br>applicationId: The unique identifier of the application<br>applicationInterfaceId: The unique identifier of the application interface<br>connectionInterfaceId: The unique identifier of the interface connection<br>body: The interface connection<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_interfaces/1/interface_connections/1</td></tr><tr><td>BODY</td><td><interface_connection><br> <name>Updated name</name><br> <sources><br> <source><br> <id>19</id><br> </source><br> </sources><br> <services><br> <service><br> <id>9</id><br> </service><br> </services><br> <comment>Updated connection</comment><br></interface_connection></td></tr></table><br><br><u>Response Messages:</u><br>200: Interface connection was modified.<br>400: Interface connection name cannot be empty.<br>400: Connection name already exists.<br>400: You cannot add user to connection interface.<br>400: You cannot add Any to connection interface.<br>400: You cannot add Internet to connection interface.<br>400: Cannot have external servers.<br>400: Cannot have both sources and destinations.<br>400: Connection NAME contains duplicate sources.<br>400: Connection NAME contains duplicate services.<br>400: