Fortinet black logo

SOAP Connector v2.4.1

2.4.1
Copy Link
Copy Doc ID fa0bb389-29e7-11ed-9d74-fa163e15d75b:394

Overview

FortiSOAR™ provides you with a number of pre-installed connectors or built-ins, such as the SOAP or Database connectors that you can use within FortiSOAR™ playbooks, as a connector step, and perform automated operations. These connectors are bundled and named based on the type of operations the connectors can perform. For example, the Database connector would contain actions that you can perform with respect to the database like querying the database. It is easy to extend and enhance these connectors.

Apart from the FortiSOAR™ Built-in connectors, Fortinet also provides a number of connectors for popular integrations like SIEMs, such as FortiSIEM, Splunk, etc., and Ticketing systems such as Jira. You can see a list of published connectors on the FortiSOAR Connectors Documentation site.

The process of installing, configuring, and using connectors is defined in the Introduction to connectors chapter in the "Connectors Guide", which is part of the FortiSOAR™ documentation or see the Installing a connector and Configuring a connector articles.

FortiSOAR™ Built-in connectors are upgraded by default with a FortiSOAR™ upgrade. Use the Content Hub to upgrade your connectors to the latest version, in case you want to only upgrade the connectors and not FortiSOAR™. For more information on the connector store, see the Introduction to connectors chapter and see the FortiSOAR Built-in connectors article.

Important: Before you upgrade your FortiSOAR™ version, it is highly recommended that you take a backup of your FortiSOAR™ Built-in connector's (SSH, IMAP, Database, etc.) configuration since the configuration of your FortiSOAR™ Built-in connectors might be reset if there are changes to the configuration parameters across versions.

SOAP

Use this connector to make SOAP calls by sending SOAP functions and receiving data.
The SOAP connector contains a full-fledged SOAP client that reads WSDL from the configuration and populates the list of actions and all the required/optional inputs from WSDL.

Version information

Connector Version: 2.4.1

Authored By: Fortinet.

Certified: Yes

Release Notes for version 2.4.1

Following enhancements have been made to the SOAP connector in version 2.4.1:

  • Added the 'Documentation' link on the Connector configuration popup, which opens the documentation for this version of the connector.

NOTE: For more information on previous releases of the SOAP connector, see the SOAP Connector v2.4.0 document.

Configuration parameters

In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the SOAP connector card. On the connector popup, click the Configurations tab to enter the required configuration details.

Parameter Description
WSDL URL URL of the WSDL using which the connector should read the configuration and populate the list of actions and all the required/optional input parameters.
Username Specify the username to access the WSDL.
Password Specify the password to access the WSDL.
Cert File Add the certificate required to access the WSDL.
Verify SSL Select this checkbox to verify the SSL certificate.
Raw Response Select this checkbox to include raw responses in the SOAP response.

Actions supported by the connector

The following automated operations can be included in playbooks:

Function Description
SOAP Call Makes SOAP calls by reading the WSDL that you have specified in the 'Configuration' parameters, and accordingly populates the list of actions and all the required/optional input parameters. This action integrates the specified SOAP web services with FortiSOAR™.
NOTE: Supported from FortiSOAR release 6.4.1 and later.
SOAP Call (Generic) Makes SOAP calls based on the SOAP function you have specified.
NOTE: This action is retained for backward compatibility.

operation: SOAP Call

Input parameters

Parameter Description
SOAP Service Select the SOAP service you want to use based on the WSDP you have specified in the 'Configuration' parameters.
NOTE: This parameter makes an API call named "get_wsdl_details" to dynamically populate its drop-down selections.
Port Type Select the port type required for the selected SOAP service.
Function Name Select the name of the function that you want to use to make SOAP calls and receive data.
Based on the function selected, the remaining required or optional parameters get displayed. The headers list gets populated and even the output schema of this step gets populated in the next steps of the playbook according to the function you have selected.
Additional SOAP Headers Specify any extra headers that are required for the requests.

operation: SOAP Call (Generic)

Input parameters

Parameter Description
SOAP Function Specify the SOAP function that you want to use to make SOAP calls and retrieve data.
Params Specify the parameters for the SOAP function that you want to use to make SOAP calls and retrieve data.
Additional SOAP Headers Specify any extra headers that are required for the requests.
Previous
Next

Overview

FortiSOAR™ provides you with a number of pre-installed connectors or built-ins, such as the SOAP or Database connectors that you can use within FortiSOAR™ playbooks, as a connector step, and perform automated operations. These connectors are bundled and named based on the type of operations the connectors can perform. For example, the Database connector would contain actions that you can perform with respect to the database like querying the database. It is easy to extend and enhance these connectors.

Apart from the FortiSOAR™ Built-in connectors, Fortinet also provides a number of connectors for popular integrations like SIEMs, such as FortiSIEM, Splunk, etc., and Ticketing systems such as Jira. You can see a list of published connectors on the FortiSOAR Connectors Documentation site.

The process of installing, configuring, and using connectors is defined in the Introduction to connectors chapter in the "Connectors Guide", which is part of the FortiSOAR™ documentation or see the Installing a connector and Configuring a connector articles.

FortiSOAR™ Built-in connectors are upgraded by default with a FortiSOAR™ upgrade. Use the Content Hub to upgrade your connectors to the latest version, in case you want to only upgrade the connectors and not FortiSOAR™. For more information on the connector store, see the Introduction to connectors chapter and see the FortiSOAR Built-in connectors article.

Important: Before you upgrade your FortiSOAR™ version, it is highly recommended that you take a backup of your FortiSOAR™ Built-in connector's (SSH, IMAP, Database, etc.) configuration since the configuration of your FortiSOAR™ Built-in connectors might be reset if there are changes to the configuration parameters across versions.

SOAP

Use this connector to make SOAP calls by sending SOAP functions and receiving data.
The SOAP connector contains a full-fledged SOAP client that reads WSDL from the configuration and populates the list of actions and all the required/optional inputs from WSDL.

Version information

Connector Version: 2.4.1

Authored By: Fortinet.

Certified: Yes

Release Notes for version 2.4.1

Following enhancements have been made to the SOAP connector in version 2.4.1:

NOTE: For more information on previous releases of the SOAP connector, see the SOAP Connector v2.4.0 document.

Configuration parameters

In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the SOAP connector card. On the connector popup, click the Configurations tab to enter the required configuration details.

Parameter Description
WSDL URL URL of the WSDL using which the connector should read the configuration and populate the list of actions and all the required/optional input parameters.
Username Specify the username to access the WSDL.
Password Specify the password to access the WSDL.
Cert File Add the certificate required to access the WSDL.
Verify SSL Select this checkbox to verify the SSL certificate.
Raw Response Select this checkbox to include raw responses in the SOAP response.

Actions supported by the connector

The following automated operations can be included in playbooks:

Function Description
SOAP Call Makes SOAP calls by reading the WSDL that you have specified in the 'Configuration' parameters, and accordingly populates the list of actions and all the required/optional input parameters. This action integrates the specified SOAP web services with FortiSOAR™.
NOTE: Supported from FortiSOAR release 6.4.1 and later.
SOAP Call (Generic) Makes SOAP calls based on the SOAP function you have specified.
NOTE: This action is retained for backward compatibility.

operation: SOAP Call

Input parameters

Parameter Description
SOAP Service Select the SOAP service you want to use based on the WSDP you have specified in the 'Configuration' parameters.
NOTE: This parameter makes an API call named "get_wsdl_details" to dynamically populate its drop-down selections.
Port Type Select the port type required for the selected SOAP service.
Function Name Select the name of the function that you want to use to make SOAP calls and receive data.
Based on the function selected, the remaining required or optional parameters get displayed. The headers list gets populated and even the output schema of this step gets populated in the next steps of the playbook according to the function you have selected.
Additional SOAP Headers Specify any extra headers that are required for the requests.

operation: SOAP Call (Generic)

Input parameters

Parameter Description
SOAP Function Specify the SOAP function that you want to use to make SOAP calls and retrieve data.
Params Specify the parameters for the SOAP function that you want to use to make SOAP calls and retrieve data.
Additional SOAP Headers Specify any extra headers that are required for the requests.
Previous
Next