You can create custom connectors in the SOAR application to build integrations for SOAR, with little or no coding required.

1. To create a custom connector, complete one of the following actions:
   • From the Playbooks > Connectors tab, click Add connector functions > Create connector.
   • From a playbook canvas, click the Functions icon () in the playbook library, click the Connectors tab, and then click Add connector functions > Create connector.
2. From the Connector Details section, enter the connector name in the Folder Name field and enter a description.
3. From the Security 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:
   1. From the Security scheme menu, select an authentication scheme. The supported authentication schemes are API Key, basic authentication, bearer, OAuth 2.0 and None. Depending on the Security scheme you select, other configuration fields are displayed.
   2. Complete any fields that appear for the security scheme that you selected. All fields that are displayed are required fields.
   3. Enter the Server URL. Server URLs must be fully qualified, including the schema, for example http:// or https://, and cannot contain variables.
   4. Enter relevant security credentials such as API key value, username and password.
   5. 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, and other values such as client ID, client secret do not persist, so you must reenter them.
4. From the Functions section, click Create function and provide the function details, request parameters, request body, and response for the API endpoint. Note the following:
   • Response schema definition and response sample are optional. If no schema definition is specified, SOAR saves the response based on the endpoint return result. However, function result output properties are not shown in the playbook data navigator, but it shows as "object".
   • Make sure Request body or Response parameter schema definitions do not include $ref, oneof, anyOf and allOf elements.
5. From the Runtime section, associate the connector with a running App Host.
6. From the Additional settings section, configure how the connector interacts with the API and handles requests.
7. Click Save to save and return to the Connectors tab and the newly created connector is added to the connectors list.

You can create connector functions by importing OpenAPI spec files to build integrations for the SOAR application, with little or no coding required.

1. 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.
2. From the Import connector page, click in the Upload file area.
3. Search for and select a .yaml or .json file that contains the functions.
4. Click Upload and then Next.
   The system parses the data in the file and renders the data onscreen.
5. From the Connector Details page, enter a folder name for the data in the file and enter a description.
6. 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.
7. 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:
   1. From the Security scheme menu, select an authentication scheme. The supported authentication schemes are limited to security schemes specified in the OpenAPI spec. Depending on the Security scheme that you select, other configuration fields are displayed.
   2. Complete any fields that appear for the security scheme that you selected. All fields that are displayed are required fields.
   3. From the Server URL menu, select the URL for which the function needs to authenticate.
   4. Enter relevant security credentials such as API Key value, and username and password.
   5. 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.
8. Click Save to save and return to the Connectors tab, where the newly created connector is added to the list of connectors.
   Remember: If your OpenAPI specs do not meet the requirements described above, you see error messages when you save the new connector. Review the error messages and correct the problems outside of SOAR and retry the import.
9. Click the edit icon to edit the function.
   From the Edit Function page, edit the function details, request parameters, and response data as required.

You can edit a connector that you previously created. You cannot edit connectors that were created by importing OpenAPI specs.

1. From the Playbooks > Connectors tab, click the connector that you want to edit.
2. From the Edit connector page, you can make the following changes:

   Connector details and description

   You can change the connector folder name where the imported function is stored and you can change the description.

   Security section

   You configure or change the security profile.

   Note: You cannot change the security scheme for imported OpenAPI specs.

   Functions

   You can add any functions that you imported previously that are not currently selected, and you can remove functions. You cannot import new functions.

   Runtime

   Associate the connector with a running App Host.

   Additional settings

   Configure how the connector interacts with the API and handles requests.

3. Save your changes.

You can easily delete a connector from the Playbooks > Connectors tab.

1. Go to the Playbooks > Connectors tab.
2. For the connector that you want to delete, click the overflow menu () and then Delete.
3. Click Delete to confirm.

You must use connectors with an App Host and configure the connector to use the App Host.

About this task

You can associate multiple connectors with the same App Host but a connector can be associated with only one App Host at a time. You can switch a connector between multiple App Hosts. If the primary App Host is down, you can switch to a secondary App Host. For example, if you have three connectors, one connector can be deployed to App Host A and connectors two and three can be deployed to different App Hosts.

Configure the App Host to use with connectors from the Playbooks > Connectors tab.

1. Go to the Playbooks > Connectors tab.
2. Click the connector that you want to configure with the App Host.
3. From the Runtime section, select an active App Host and save.

You can access functions in the library from the Functions > Connectors or Functions > AppExchange tab on the Playbook canvas window.

1. In the Playbook canvas window, click the Functions icon () in the playbook library.
2. Complete one of the following, depending on whether you want to add a connector function or a function from an app or other function:
   • To add a connector function, from the Connector tab, search for and select the function.
   • To add a function from an app or a function that you created, click the AppExchange tab and expand the app name to see its functions. To see functions that are not associated with an app, expand the Other category.

   Tip: Click the Open filters icon to filter the list of functions.
3. To view information about the function, select the function from the list.
4. To add a function to the playbook, drag it to the canvas, or click the + icon.
5. On the canvas, select the function to open the function configuration window.
6. Under Function output, type a name in the Output name field.

   You can use to this name to make the function output available to scripts that start later in the playbook.

7. For the functions inputs, determine the method for delivering inputs:
   For connector functions, to define inputs, expand the Request parameters section, and select the Form or Raw tab. Use the Raw tab to use a script to enter function inputs using playbook data.

   • If you select the Form tab, enter values for each field. To select the input field directly from the playbook schema, click the Choose from schema icon ( ), and browse through the list to find the object that you want to use. Click the + icon to add the path to the input field. The object or property type must match the input field type. If it does not, a validation message appears under the input field.

   • Use the Raw tab to set a JSON payload as function Request body.

   If you want to use the connector function result outputs in the local scripts, you can use the following syntax:

   JSON Primitive types – String, Integer, Boolean, Number*
          o <fn outputname>.data
   
   incident.properties.cust_str_field = playbook.functions.results.out1.data incident.properties.boolean_field = playbook.functions.results.out1.data JSON Primitive type array
         o <fn outputname>.data[]
   
   incident.properties.cust_str_field = playbook.functions.results.out1.data[0]
   JSON Object with no root name
        o <fn outputname>.firstName
   
   incident.properties.cust_str_field = playbook.functions.results.out1.data.first_name
   JSON Object array
       o. <fn outputname>.data[0][“firstName”]
   
   incident.properties.cust_str_field = playbook.functions.results.out1.data[0][“first_name”]
   JSON Object with root name
   
   incident.properties.cust_str_field = playbook.functions.results.out1.employee[0][“first_name”]
   
   *Number can return the double/float values. However, field def support only integer values. It should be saved as string value
   

   For non-connector functions:

   • To manually define the inputs, click the Fields tab and type a value in each input field.

     To select the input field directly from the playbook schema, click the Choose from schema icon ( ), and browse through the list to find the object that you want to use. Click the + icon to add the path to the input field.

     The object or property type must match the input field type. If it does not, a validation message appears under the input field.

   • To use a script to programmatically define the inputs, click the Script tab.

     If a script is present, click Edit script to update it.

     To add objects directly from the playbook schema, click the View playbook schema icon ( ), and browse through the list to find the object that you want to use. Click the + icon to add the path to the script builder.

     For information about building scripts, see Input scripts.

8. To duplicate or remove the function, on the playbook canvas, right-click on the function and select Duplicate mode or Remove.

You can download connector log files to help troubleshooting or identify any problems.

1. Go to the Playbooks > Connectors tab.
2. Click the overflow menu () and then Download logs.
3. From the Download logs modal, select a time range for the logs that you want to download, either for all time available, or for a specific time range.
4. From the Advanced settings section, you can change the log source from the current container to a previous container, if available.
5. Click Download logs to download.