You can use connectors to build integrations for the SOAR Platform application, with little or no coding
required.
Before you begin
You must have an OpenAPI spec 3.0 .yaml
or .json
file
available on the system that contains the functions that you want to import. For importing as
connector functions, only OpenAPI spec 3.0 files are supported currently.Before importing into
the SOAR Platform, you can view and edit the OpenAPI
spec using the swagger editor at https://editor.swagger.io.
If there are problems with the OpenAPI
spec, importing will fail. Correct any problems outside of the SOAR Platform and retry the import.
Make sure that the
OpenAPI spec 3.0 files that you are importing meet the following requirements:
- Make sure there are no external references that point to external documents.
- Make sure that a schema is provided for path parameters, such as header and query
parameters.
- Server parameters must be fully defined.
- Server URLs must be fully qualified, including the schema, for example
http://
or https://
, and cannot contain variables.
- Request parameters cannot specify media types, such as application or
.json
.
- Authentication methods are limited to API key, bearer, or basic authentication.
Some functions in successfully imported OpenAPI spec files will be disabled if the
function definition contains one or more of following items. Correct these problems outside of the
SOAR Platform and retry the import:
- HEAD HTTP operation.
oneOf
and anyOf
schema types.
- Request body with media types other than application or
.json
.
- Missing path parameters.
About this task
Connectors provide a simple way to add functions to the SOAR Platform. Using connectors, you can quickly build
integrations, with little or minimal coding required.
From the Connectors tab, you can import Open API Spec files, parse the
data, and then create connector functions to use in your playbooks. You must configure security
credentials for the function to authenticate against the REST API endpoints.
Exporting or importing playbooks with connector functions is not supported currently and
connector functions do not work in MSSP organizations.
Procedure
-
To start adding a connector, complete one of the following actions:
- From the Playbooks > Connectors tab, click Add connector
functions > Import connector APIs.
- From a playbook canvas, click the Functions icon (
) in the
playbook library, click the Connectors tab, and then click Add
connector functions > Import connector APIs.
- From the Import connector page, click in the Upload
file area.
- Search for and select a
.yaml
or .json
file that
contains the functions.
- Click Upload and then Next.
The
system parses the data in the file and renders the data onscreen.
- From the Connector Details page, enter a folder name for the data
in the file and enter a description.
- From the Functions section, select the functions that you want to
import. By default, all of the functions are selected. To omit any function, deselect
it.
- From the authentication section, click Configure to create a
security profile for the function to authenticate against the REST API endpoints. If you do not
configure a security profile, a half blue circle icon is displayed for the connector. Complete the
following steps to configure authentication:
- From the Security scheme drop-down menu, select an authentication scheme.
The supported authentication schemes are
API Key
, Bearer
,
Basic authentication
, and None
. Depending on the
Security scheme you select, other configuration fields are displayed.
- Complete any fields that appear for the security scheme that you selected. All fields that are
displayed are required fields.
- From the Server URL drop-down menu, select the URL for which the function
needs to authenticate.
- Enter your key or username and password for authentication.
- Save your changes.
A green icon is shown for the connector to indicate that it is correctly configured.
Note: If you
subsequently change the security configuration, values you entered for the username and password do
not persist, so you must reenter them.
- Click Save to save and return to the
Connectors tab, where the functions you imported are shown in the list under
the folder name that you provided.
- To view information about the function, select the function from the list.
- Click the edit icon to edit the function.
From the Edit
Function page, edit the function details, request parameters, and response data as
required.
- To add a function to the playbook, drag it to the canvas, or click the
+ icon.
- From the canvas, click the function to open the function configuration
window.