--- title: MongoDB connector description: Connectors continue to be released outside the IDM release. For the latest documentation, refer to the OpenICF documentation. component: pingidm version: 7.2 page_id: pingidm:connector-reference:mongodb canonical_url: https://docs.pingidentity.com/pingidm/7.2/connector-reference/mongodb.html section_ids: mongodb-before-you-start: Before you start configuring-mongodb-connector: Configure the MongoDB connector implemented-interfaces-org-forgerock-openicf-connectors-mongodb-MongoDBConnector-1.5.20.15: OpenICF Interfaces Implemented by the MongoDB Connector config-properties-org-forgerock-openicf-connectors-mongodb-MongoDBConnector-1.5.20.15: MongoDB Connector Configuration configuration-properties-org-forgerock-openicf-connectors-mongodb-MongoDBConnector-1.5.20.15: Configuration properties operation-script-files-org-forgerock-openicf-connectors-mongodb-MongoDBConnector-1.5.20.15: Operation Script Files groovy-engine-configuration-org-forgerock-openicf-connectors-mongodb-MongoDBConnector-1.5.20.15: Groovy Engine configuration basic-configuration-properties-org-forgerock-openicf-connectors-mongodb-MongoDBConnector-1.5.20.15: Basic Configuration Properties connection-configuration-properties-org-forgerock-openicf-connectors-mongodb-MongoDBConnector-1.5.20.15: Connection Configuration Properties --- # MongoDB connector | | | | - | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | Connectors continue to be released outside the IDM release. For the latest documentation, refer to the [OpenICF documentation](https://docs.pingidentity.com/openicf/index.html). | The MongoDB connector is an implementation of the Scripted Groovy Connector. This connector lets you interact with a MongoDB document database, using Groovy scripts for the OpenICF operations. ## Before you start In a production environment, enable access control on your MongoDB database. If your connector will manage MongoDB users and roles, you must create an administrative user in the `admin` database. If your connector will manage collections in a database, this administrative user must create a specific user and role for the connector for the target database. For information about enabling access control in MongoDB, see the [MongoDB documentation](https://docs.mongodb.com/manual/tutorial/enable-authentication/). The commands in this chapter assume an administrative user named `myUserAdmin` with password `Passw0rd` who has the `readWrite` role on the `test` database. ## Configure the MongoDB connector Create a connector configuration using the admin UI: 1. From the navigation bar, click Configure > Connectors. 2. On the Connectors page, click New Connector. 3. On the New Connector page, type a Connector Name. 4. From the Connector Type drop-down list, select MongoDB Connector - 1.5.20.15. 5. Complete the Base Connector Details. For information about the configurable properties, see [MongoDB Basic Configuration Properties](#config-properties-org-forgerock-openicf-connectors-mongodb-MongoDBConnector-1.5.20.15). 6. Click Save. Alternatively, configure the connector with a configuration file. A sample connector configuration file (`provisioner.openicf-mongodb.json`) is provided in the `/path/to/openidm/samples/example-configurations/provisioners` directory. Copy the sample connector configuration to your project's `conf/` directory, and adjust the `configurationProperties` to match your MongoDB instance: ```json "configurationProperties" : { "connectionURI" : "mongodb://localhost:27017", "host" : "localhost", "port" : "27017", "user" : "myUserAdmin", "password" : "Passw0rd", "userDatabase" : "admin", "database" : "test", ... } ``` Set `"enabled" : true` to enable the connector. When your connector is configured correctly, you can test its status by running the following command: ``` curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Accept-API-Version: resource=1.0" \ --request POST \ "http://localhost:8080/openidm/system?_action=test" [ { "name": "mongodb", "enabled": true, "config": "config/provisioner.openicf/mongodb", "connectorRef": { "bundleVersion": "[1.5.0.0,1.6.0.0)", "bundleName": "org.forgerock.openicf.connectors.mongodb-connector", "connectorName": "org.forgerock.openicf.connectors.mongodb.MongoDBConnector" }, "displayName": "MongoDB Connector", "objectTypes": [ "__ALL__", "account", "role" ], "ok": true } ] ``` A status of `"ok": true` indicates that the MongoDB connector can connect to the database. ## OpenICF Interfaces Implemented by the MongoDB Connector The MongoDB Connector implements the following OpenICF interfaces. For additional details, see [OpenICF interfaces](interfaces.html): * Authenticate Provides simple authentication with two parameters, presumed to be a user name and password. * Create Creates an object and its `uid`. * Delete Deletes an object, referenced by its `uid`. * Resolve Username Resolves an object by its username and returns the `uid` of the object. * Schema Describes the object types, operations, and options that the connector supports. * Script on Connector Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: * The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access. * The script has access to a `connector` variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. * The script has access to any script arguments passed in by the application. * Script on Resource Runs a script on the target resource that is managed by this connector. * Search Searches the target resource for all objects that match the specified object class and filter. * Sync Polls the target resource for synchronization events, that is, native changes to objects on the target resource. * Test Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out). You can invoke the test operation before a connector configuration has been validated. * Update Updates (modifies or replaces) objects on a target resource. ## MongoDB Connector Configuration The MongoDB Connector has the following configurable properties: ### Configuration properties | Property | Type | Default | Encrypted(1) | Required(2) | | -------------------------------------------------------------- | --------------- | ------- | ------------------------ | ------------------------ | | `customSensitiveConfiguration` | `GuardedString` | `null` | [icon: lock, set=fas]Yes | [icon: times, set=fas]No | | Custom Sensitive Configuration script for Groovy ConfigSlurper | | | | | | `customConfiguration` | `String` | `null` | | [icon: times, set=fas]No | | Custom Configuration script for Groovy ConfigSlurper | | | | | (1) Whether the property value is considered confidential, and is therefore encrypted in IDM. (2) A list of operations in this column indicates that the property is required for those operations. ### Operation Script Files | Property | Type | Default | Encrypted(1) | Required(2) | | ----------------------------------------------------------------------------------------------------- | -------- | ------- | ------------ | ------------------------------------------------------------------------------------------------------ | | `createScriptFileName` | `String` | `null` | | * [\[interface-CreateApiOp\]](#interface-CreateApiOp) | | The name of the file used to perform the CREATE operation. | | | | | | `customizerScriptFileName` | `String` | `null` | | [icon: times, set=fas]No | | The script used to customize some function of the connector. Read the documentation for more details. | | | | | | `authenticateScriptFileName` | `String` | `null` | | - [\[interface-AuthenticationApiOp\]](#interface-AuthenticationApiOp) | | The name of the file used to perform the AUTHENTICATE operation. | | | | | | `scriptOnResourceScriptFileName` | `String` | `null` | | * [\[interface-ScriptOnResourceApiOp\]](#interface-ScriptOnResourceApiOp) | | The name of the file used to perform the RUNSCRIPTONRESOURCE operation. | | | | | | `deleteScriptFileName` | `String` | `null` | | - [\[interface-DeleteApiOp\]](#interface-DeleteApiOp) | | The name of the file used to perform the DELETE operation. | | | | | | `resolveUsernameScriptFileName` | `String` | `null` | | * [\[interface-ResolveUsernameApiOp\]](#interface-ResolveUsernameApiOp) | | The name of the file used to perform the RESOLVE\_USERNAME operation. | | | | | | `searchScriptFileName` | `String` | `null` | | - [\[interface-GetApiOp\]](#interface-GetApiOp) - [\[interface-SearchApiOp\]](#interface-SearchApiOp) | | The name of the file used to perform the SEARCH operation. | | | | | | `updateScriptFileName` | `String` | `null` | | * [\[interface-UpdateApiOp\]](#interface-UpdateApiOp) | | The name of the file used to perform the UPDATE operation. | | | | | | `schemaScriptFileName` | `String` | `null` | | - [\[interface-SchemaApiOp\]](#interface-SchemaApiOp) | | The name of the file used to perform the SCHEMA operation. | | | | | | `testScriptFileName` | `String` | `null` | | * [\[interface-TestApiOp\]](#interface-TestApiOp) | | The name of the file used to perform the TEST operation. | | | | | | `syncScriptFileName` | `String` | `null` | | - [\[interface-SyncApiOp\]](#interface-SyncApiOp) | | The name of the file used to perform the SYNC operation. | | | | | (1) Whether the property value is considered confidential, and is therefore encrypted in IDM. (2) A list of operations in this column indicates that the property is required for those operations. ### Groovy Engine configuration | Property | Type | Default | Encrypted(1) | Required(2) | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | ------------ | ------------ | ------------------------- | | `targetDirectory` | `File` | `null` | | [icon: times, set=fas]No | | Directory into which to write classes. | | | | | | `warningLevel` | `int` | `1` | | [icon: times, set=fas]No | | Warning Level of the compiler | | | | | | `scriptExtensions` | `String[]` | `['groovy']` | | [icon: times, set=fas]No | | Gets the extensions used to find groovy files | | | | | | `minimumRecompilationInterval` | `int` | `100` | | [icon: times, set=fas]No | | Sets the minimum of time after a script can be recompiled. | | | | | | `scriptBaseClass` | `String` | `null` | | [icon: times, set=fas]No | | Base class name for scripts (must derive from Script) | | | | | | `scriptRoots` | `String[]` | `null` | | [icon: check, set=fas]Yes | | The root folder to load the scripts from. If the value is null or empty the classpath value is used. | | | | | | `tolerance` | `int` | `10` | | [icon: times, set=fas]No | | The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted. | | | | | | `debug` | `boolean` | `false` | | [icon: times, set=fas]No | | If true, debugging code should be activated | | | | | | `classpath` | `String[]` | `[]` | | [icon: times, set=fas]No | | Classpath for use during compilation. | | | | | | `disabledGlobalASTTransformations` | `String[]` | `null` | | [icon: times, set=fas]No | | Sets a list of global AST transformations which should not be loaded even if they are defined in META-INF/org.codehaus.groovy.transform.ASTTransformation files. By default, none is disabled. | | | | | | `verbose` | `boolean` | `false` | | [icon: times, set=fas]No | | If true, the compiler should produce action information | | | | | | `sourceEncoding` | `String` | `UTF-8` | | [icon: times, set=fas]No | | Encoding for source files | | | | | | `recompileGroovySource` | `boolean` | `false` | | [icon: times, set=fas]No | | If set to true recompilation is enabled | | | | | (1) Whether the property value is considered confidential, and is therefore encrypted in IDM. (2) A list of operations in this column indicates that the property is required for those operations. ### Basic Configuration Properties | Property | Type | Default | Encrypted(1) | Required(2) | | ---------------------------------------------------------------------------------------------------------------- | --------------- | -------------------------- | ------------------------ | ------------------------ | | `connectionURI` | `String` | `null` | | [icon: times, set=fas]No | | The MongoDB client connection URI, for example "mongodb://localhost:27017". Overides other connection parameters | | | | | | `host` | `String` | `localhost` | | [icon: times, set=fas]No | | The MongoDB server host name (localhost by default). | | | | | | `port` | `int` | `27017` | | [icon: times, set=fas]No | | The MongoDB server port number (27017 by default). | | | | | | `user` | `String` | `null` | | [icon: times, set=fas]No | | The MongoDB username | | | | | | `password` | `GuardedString` | `null` | [icon: lock, set=fas]Yes | [icon: times, set=fas]No | | The password used to connect to MongoDB | | | | | | `userDatabase` | `String` | `null` | | [icon: times, set=fas]No | | The name of the database in which the MongoDB user is defined | | | | | | `clusterAddresses` | `String[]` | `null` | | [icon: times, set=fas]No | | A list of additional mongodbDB servers when connecting to a MongoDB cluster (\["host1:27017","host2:27017",…​]") | | | | | | `dateAttributes` | `String[]` | `[]` | | [icon: times, set=fas]No | | Defines the list of attributes to convert to MongoDB BSON Date type on create/update. | | | | | | `database` | `String` | `null` | | [icon: times, set=fas]No | | The database to use | | | | | | `arrayAttributes` | `String[]` | `[]` | | [icon: times, set=fas]No | | Defines the list of attributes that should be considered as BSON Arrays. | | | | | | `includeNullValue` | `boolean` | `false` | | [icon: times, set=fas]No | | If set to true, retains null values in the target MongoDB document (false by default). | | | | | | `includeEmptyList` | `boolean` | `false` | | [icon: times, set=fas]No | | If set to true, retains null values in the target MongoDB document (false by default). | | | | | | `dateFormat` | `String` | `yyyy-MM-dd'T'HH:mm:ss'Z'` | | [icon: times, set=fas]No | | Defines the date format to use for MongoDB Date attributes (defaults to ISO 8601 "yyyy-MM-ddTHH:mm:ssZ"). | | | | | | `timeZone` | `String` | `UTC` | | [icon: times, set=fas]No | | Defines the timezone to use for MongoDB Date attributes. | | | | | | `ICFName` | `String` | `name` | | [icon: times, set=fas]No | | Defines the name to use in the target MongoDB document for the ICF *NAME* attribute. | | | | | (1) Whether the property value is considered confidential, and is therefore encrypted in IDM. (2) A list of operations in this column indicates that the property is required for those operations. ### Connection Configuration Properties | Property | Type | Default | Encrypted(1) | Required(2) | | ---------------------------------------------------------------------- | --------- | ------- | ------------ | ------------------------ | | `sslEnabled` | `boolean` | `true` | | [icon: times, set=fas]No | | Use secure socket layer to connect to MongoDB (true by default) | | | | | | `sslHostNameValidation` | `boolean` | `true` | | [icon: times, set=fas]No | | Defines if host name should be validated when SSL is enabled | | | | | | `maxConnectionIdleTime` | `int` | `0` | | [icon: times, set=fas]No | | The maximum idle time for a pooled connection in ms (0 means no limit) | | | | | | `maxConnectionLifeTime` | `int` | `0` | | [icon: times, set=fas]No | | The maximum life time for a pooled connection in ms (0 means no limit) | | | | | | `minConnectionsPerHost` | `int` | `0` | | [icon: times, set=fas]No | | The minimum number of connections per host (must be >= 0) | | | | | | `maxConnectionsPerHost` | `int` | `5` | | [icon: times, set=fas]No | | The maximum number of connections per host (must be > 0) | | | | | (1) Whether the property value is considered confidential, and is therefore encrypted in IDM. (2) A list of operations in this column indicates that the property is required for those operations.