MongoDB Atlas

the mongodb atlas connector enables seamless integration with swimlane turbine, allowing for the automation of database management tasks and trigger creation mongodb atlas is a fully managed cloud database developed by the same people that build mongodb the mongodb atlas connector for swimlane turbine allows users to automate complex database operations, such as creating triggers for authentication, database, and scheduled events, as well as running queries and retrieving configurations this integration empowers security teams to streamline their database related workflows, enhance real time data processing, and enforce security measures directly within their security automation playbooks mongodb atlas is a fully managed cloud database service that allows you to deploy, manage, and scale mongodb databases easily it offers various features and tools to ensure your database operates efficiently, securely, and reliably prerequisites to effectively utilize the mongodb atlas connector with swimlane turbine, ensure you have the following username and api key authentication with the following parameters url the base endpoint for mongodb atlas api access public api key your mongodb atlas account's public api key private api key your mongodb atlas account's private api key capabilities this connector provides the following capabilities create a authentication trigger create a database trigger create a scheduled trigger get all triggers get graphql api configuration run a mongodb query notes https //www mongodb com/docs/atlas/app services/admin/api/v3/#section/get an admin api session access token configurations mongodb atlas authentication authenticates using username and api key configuration parameters parameter description type required url a url to the target host string required username public api key string required apikey private api key string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions create a authentication trigger creates a new authentication trigger in mongodb atlas using the provided groupid, appid, name, type, and configuration endpoint url /api/admin/v3 0/groups/{{groupid}}/apps/{{appid}}/triggers method post input argument name type required description path parameters groupid string required an atlas project/group id path parameters appid string required the objectid of your application name string optional the trigger's name type string optional the trigger type for authentication triggers, this value is always "authentication" disabled boolean optional if true, the trigger is disabled and does not listen for events or execute config object optional an object that defines configuration values for the trigger config operation type array required the type of authentication event that the trigger listens for config providers array required the type(s) of authentication provider that the trigger listens to function id string optional the id of the function that the trigger calls when it fires function name string optional the name of the function that the trigger calls when it fires, i e the function described by function id event processors object optional an object where each field name is an event processor id and each value is an object that configures its corresponding event processor event processors function object optional parameter for create a authentication trigger event processors function config object optional parameter for create a authentication trigger event processors function config function id string optional the id of the function that the trigger calls when it fires event processors function config function name string optional the name of the function that the trigger calls when it fires, i e the function described by function id event processors aws eventbridge object optional unique identifier event processors aws eventbridge config object optional unique identifier event processors aws eventbridge config account id string optional an aws account id event processors aws eventbridge config region string optional an aws region event processors aws eventbridge config extended json enabled boolean optional if true, event objects are serialized using ejson id string optional the trigger's unique id input example {"json body" {"name" "onnewapikey","type" "authentication","disabled"\ true,"config" {"operation type" \["create"],"providers" \["api key"]},"function id" "5eea9ca4ca0e356e2c2a148a","function name" "","event processors" {"function" {"config" {"function id" "","function name" ""}},"aws eventbridge" {"config" {"account id" "","region" "","extended json enabled"\ true}}}," id" ""},"path parameters" {"groupid" "57879f6cc4b32dbe440bb8c5","appid" "5997529e46224c6e42gb6dd9"}} output parameter type description status code number http status code of the response reason string response reason phrase name string name of the resource type string type of the resource function id string unique identifier config object output field config config operation type array type of the resource config providers array unique identifier output example {"status code" 201,"response headers" {},"reason" "successfully created","json body" {"name" "onnewapikey","type" "authentication","function id" "5eea9ca4ca0e356e2c2a148a","config" {"operation type" \[],"providers" \[]}}} create a database trigger creates a new database trigger in mongodb atlas with specified group and app ids, allowing customization of name, type, and config endpoint url /api/admin/v3 0/groups/{{groupid}}/apps/{{appid}}/triggers method post input argument name type required description path parameters groupid string required an atlas project/group id path parameters appid string required the objectid of your application name string optional the trigger's name type string optional the trigger type for database triggers, this value is always "database" disabled boolean optional if true, the trigger is disabled and does not listen for events or execute config object optional an object that defines configuration values for the trigger config service id string required the id value of a linked mongodb data source config database string required the name of a database in the linked data source config collection string required the name of a collection in the specified database the trigger listens to events from this collection config operation types array required the type(s) of mongodb change event that the trigger listens for config match object required a $match expression filters change events the trigger will only fire if the expression evaluates to true for a given change event config project object optional a $project expression returns only the specified fields you can include or exclude specific fields, or include newly computed fields config full document boolean required if true, indicates that update change events should include the most current majority committed version of the modified document in the fulldocument field config full document before change boolean required if true, indicates that update change events should include a snapshot of the modified document from immediately before the update was applied config skip catchup events boolean optional if true, enabling the trigger after it was disabled will not invoke events that occurred while the trigger was disabled config tolerate resume errors boolean optional if true, when this trigger's resume token cannot be found in the cluster's oplog, the trigger automatically resumes processing events at the next relevant change stream event config maximum throughput boolean optional if true, the trigger will use the maximize throughput option config unordered boolean required if true, event ordering is disabled and this trigger can process events in parallel if false, event ordering is enabled and the trigger executes events serially function id string optional the id of the function that the trigger calls when it fires function name string optional the name of the function that the trigger calls when it fires, i e the function described by function id event processors object optional an object where each field name is an event processor id and each value is an object that configures its corresponding event processor event processors function object optional parameter for create a database trigger event processors function config object optional parameter for create a database trigger event processors function config function id string optional the id of the function that the trigger calls when it fires event processors function config function name string optional the name of the function that the trigger calls when it fires, i e the function described by function id input example {"json body" {"name" "onnewemployee","type" "database","disabled"\ true,"config" {"service id" "5adeb649b8b998486770ae7c","database" "hr","collection" "employees","operation types" \["insert"],"match" {},"project" {},"full document"\ true,"full document before change"\ true,"skip catchup events"\ true,"tolerate resume errors"\ true,"maximum throughput"\ true,"unordered"\ true},"function id" "","function name" "","event processors" {"function" {"config" {"function id" "","function name" ""}},"aws eventbridge" {"config" {"account id" "","region" "","extended json enabled"\ true}}},"error handler" {"config" {"enabled"\ true,"function id" ""}}," id" ""},"path parameters" {"groupid" "57879f6cc4b32dbe440bb8c5","appid" "5997529e46224c6e42gb6dd9"}} output parameter type description status code number http status code of the response reason string response reason phrase name string name of the resource type string type of the resource function id string unique identifier config object output field config config operation types array type of the resource config database string response data config collection string output field config collection config service id string unique identifier config match object output field config match config project object output field config project config full document boolean output field config full document output example {"status code" 201,"response headers" {},"reason" "successfully created","json body" {"name" "onnewemployee","type" "database","function id" "5eea9ca4ca0e356e2c2a148a","config" {"operation types" \[],"database" "hr","collection" "employees","service id" "5adeb649b8b998486770ae7c","match" {},"project" {},"full document"\ true}}} create a scheduled trigger creates a new scheduled trigger in mongodb atlas using the provided name, type, and configuration along with groupid and appid endpoint url /api/admin/v3 0/groups/{{groupid}}/apps/{{appid}}/triggers method post input argument name type required description path parameters groupid string required an atlas project/group id path parameters appid string required the objectid of your application name string optional the trigger's name type string optional the trigger type for scheduled triggers, this value is always "scheduled" disabled boolean optional if true, the trigger is disabled and does not listen for events or execute config object optional an object that defines configuration values for the trigger config schedule string required a cron expression that specifies when the trigger executes config skip catchup events boolean optional if true, enabling the trigger after it was disabled will not invoke events that occurred while the trigger was disabled function id string optional the id of the function that the trigger calls when it fires function name string optional the name of the function that the trigger calls when it fires, i e the function described by function id event processors object optional an object where each field name is an event processor id and each value is an object that configures its corresponding event processor event processors function object optional parameter for create a scheduled trigger event processors function config object optional parameter for create a scheduled trigger event processors function config function id string optional the id of the function that the trigger calls when it fires event processors function config function name string optional the name of the function that the trigger calls when it fires, i e the function described by function id event processors aws eventbridge object optional unique identifier event processors aws eventbridge config object optional unique identifier event processors aws eventbridge config account id string optional an aws account id event processors aws eventbridge config region string optional an aws region event processors aws eventbridge config extended json enabled boolean optional if true, event objects are serialized using ejson id string optional the trigger's unique id input example {"json body" {"name" "createdailyreport","type" "scheduled","disabled"\ true,"config" {"schedule" "0 8 ","skip catchup events"\ true},"function id" "5eea9ca4ca0e356e2c2a148a","function name" "","event processors" {"function" {"config" {"function id" "","function name" ""}},"aws eventbridge" {"config" {"account id" "","region" "","extended json enabled"\ true}}}," id" ""},"path parameters" {"groupid" "57879f6cc4b32dbe440bb8c5","appid" "5997529e46224c6e42gb6dd9"}} output parameter type description status code number http status code of the response reason string response reason phrase name string name of the resource type string type of the resource function id string unique identifier config object output field config config schedule string output field config schedule output example {"status code" 201,"response headers" {},"reason" "successfully created","json body" {"name" "createdailyreport","type" "scheduled","function id" "5eea9ca4ca0e356e2c2a148a","config" {"schedule" "0 8 "}}} get all triggers retrieve all triggers for a given group and application in mongodb atlas, requiring 'groupid' and 'appid' as path parameters endpoint url /api/admin/v3 0/groups/{{groupid}}/apps/{{appid}}/triggers method get input argument name type required description path parameters groupid string required an atlas project/group id path parameters appid string required the objectid of your application input example {"path parameters" {"groupid" "57879f6cc4b32dbe440bb8c5","appid" "5997529e46224c6e42gb6dd9"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {},"reason" "successfully listed triggers","json body" \[{"name" "onnewemployee","type" "database","function id" "5eea9ca4ca0e356e2c2a148a","config" {}}]} get graphql api configuration retrieve the graphql api configuration for a specified app in a mongodb atlas project, using group and app ids endpoint url /api/admin/v3 0/groups/{{groupid}}/apps/{{appid}}/graphql/config method get input argument name type required description path parameters groupid string required an atlas project/group id path parameters appid string required the objectid of your application input example {"path parameters" {"groupid" "57879f6cc4b32dbe440bb8c5","appid" "5997529e46224c6e42gb6dd9"}} output parameter type description status code number http status code of the response reason string response reason phrase use natural pluralization boolean output field use natural pluralization disable schema introspection boolean output field disable schema introspection output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"use natural pluralization"\ true,"disable schema introspection"\ true}} run a mongodb query executes a specified query or mutation directly in mongodb atlas with system level privileges, requiring groupid, appid, and the query endpoint url /api/admin/v3 0/groups/{{groupid}}/apps/{{appid}}/graphql method post input argument name type required description path parameters groupid string required an atlas project/group id path parameters appid string required he objectid of your application query string optional a stringified graphql file that contains one or more valid graphql operations for your api variables string optional a stringified json object where each field name maps a value to a variable in the specified operation operationname string optional he name of the graphql operation specified in query to run input example {"json body" {"query" "query alltasks { tasks(query { status $status }) { id owner } }","variables" "{ \\"status\\" \\"complete\\" }","operationname" "alltasks"},"path parameters" {"groupid" "57879f6cc4b32dbe440bb8c5","appid" "5997529e46224c6e42gb6dd9"}} output parameter type description status code number http status code of the response reason string response reason phrase data object response data errors array error message if any errors message string response message errors locations array error message if any errors locations line number error message if any errors locations column number error message if any output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"data" {},"errors" \[{}]}} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt