MongoDB v2.0.0

About the connector

MongoDB is an open-source document database that provides high performance, high availability, and automatic scaling. Use the MongoDB connector to perform automated operations, such as inserting or updating documents, retrieving a list of all available collections from the MongoDB database, and querying the MongoDB database.

This document provides information about the MongoDB Connector, which facilitates automated interactions, with a MongoDB server using FortiSOAR™ playbooks. Add the MongoDB Connector as a step in FortiSOAR™ playbooks and perform automated operations with MongoDB.

Version information

Connector Version: 2.0.0

FortiSOAR™ Version Tested on: 7.5.0-4015

MongoDB Version Tested on: 7.0.8

Authored By: Fortinet

Certified: Yes

Release Notes for version 2.0.0

Following enhancements have been made to the MongoDB Connector in version 2.0.0:

• Updated the python dependency pymongo.
• The input parameter Filter in the action Delete Documents action is now mandatory.
• Fixed the issue where the health check failed when the optional parameters in the connector configuration were not provided.
• A new input parameter Database has been added to the following actions:
  • Insert Documents
  • Query Documents
  • Update Documents
  • Delete Documents
  • Get Collections

Installing the connector

Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-mongodb

Prerequisites to configuring the connector

• You must have the credentials of MongoDB server to which you will connect and perform automated operations.
• The FortiSOAR™ server should have outbound connectivity to port 443 on the MongoDB server.

Minimum Permissions Required

• Not applicable

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the MongoDB connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations:

operation: Insert Documents

Input parameters

Output

The output contains the following populated JSON schema:

{
    "status": "",
    "message": ""
}

operation: Query Documents

Input parameters

Output

The output contains the following populated JSON schema:

{
    "status": "",
    "data": ""
}

operation: Update Documents

Input parameters

Output

The output contains the following populated JSON schema:

{
    "status": "",
    "message": ""
}

operation: Delete Documents

Input parameters

Output

The output contains the following populated JSON schema:

{
    "status": "",
    "message": ""
}

operation: Get Collections

Input parameters

Output

Output schema is not available at this time.

Included playbooks

The Sample - MongoDB - 2.0.0 playbook collection comes bundled with the MongoDB connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the MongoDB connector.

• Delete Documents
• Get Collections
• Insert Documents
• Query Documents
• Update Documents

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.