MongoDB connector

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 ICF operations.

The MongoDB connector uses Java MongoDB driver v4.5.1. For MongoDB version compatibility information, refer to Compatibility in the MongoDB Documentation.

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, refer to the MongoDB documentation.

The commands in this chapter assume an administrative user named myUserAdmin with password Passw0rd who has the readWrite role on the test database.

Install the MongoDB connector

You can download any connector from Backstage, but some come bundled with Identity Cloud, IDM, or RCS by default. When using a bundled connector, you can skip installing it and move directly to configuration.

Bundle availability
Connector	Identity Cloud	IDM	RCS
MongoDB	No	Yes	No

Download the connector .jar file from Backstage.

If you are running the connector locally, place it in the /path/to/openidm/connectors directory, for example:
```
mv ~/Downloads/mongodb-connector-1.5.20.16.jar /path/to/openidm/connectors/
```
If you are using a remote connector server (RCS), place it in the /path/to/openicf/connectors directory on the RCS.

Configure the MongoDB connector

Create a connector configuration using the IDM admin UI:

From the navigation bar, click Configure > Connectors.
On the Connectors page, click New Connector.
On the New Connector page, type a Connector Name.
From the Connector Type drop-down list, select MongoDB Connector - 1.5.20.16.
Complete the Base Connector Details.

For a list of all configuration properties, refer to MongoDB Connector Configuration
Click Save.

When your connector is configured correctly, the connector displays as Active in the admin UI.

Refer to this procedure to create a connector configuration over REST.

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 in IDM. Copy the sample connector configuration to your project’s conf/ directory, and adjust the configurationProperties to match your MongoDB instance:

"configurationProperties" : {
    "connectionURI" : "mongodb://localhost:27017",
    "host" : "localhost",
    "port" : "27017",
    "user" : "myUserAdmin",
    "password" : "Passw0rd",
    "userDatabase" : "admin",
    "database" : "test",
    ...
}

Set "enabled" : true to enable the connector.

Test the MongoDB 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.

MongoDB remote connector

If you want to run this connector outside of Identity Cloud or IDM, you can configure the MongoDB connector as a remote connector. Java Connectors installed remotely on a Java Connector Server function identically to those bundled locally within Identity Cloud or installed locally on IDM.

You can download the MongoDB connector from here.

Refer to Remote connectors for configuring the MongoDB remote connector.

OpenICF Interfaces Implemented by the MongoDB Connector

The MongoDB Connector implements the following OpenICF interfaces. For additional details, see ICF interfaces:

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:

Basic Configuration Properties

Property Type Default Encrypted⁽¹⁾ Required⁽²⁾

Property	Type	Default	Encrypted⁽¹⁾	Required⁽²⁾
`connectionURI`	`String`	`null`		No
The MongoDB client connection URI, for example "mongodb://localhost:27017". Overrides other connection parameters.
`host`	`String`	`localhost`		No
The MongoDB server host name.
`port`	`int`	`27017`		No
The MongoDB server port number.
`user`	`String`	`null`		No
The MongoDB username.
`password`	`GuardedString`	`null`	Yes	No
The password used to connect to MongoDB.
`userDatabase`	`String`	`null`		No
The name of the database in which the MongoDB user is defined.
`clusterAddresses`	`String[]`	`null`		No
A list of additional mongodbDB servers when connecting to a MongoDB cluster (["host1:27017","host2:27017",…]").
`dateAttributes`	`String[]`	`[]`		No
Defines the list of attributes to convert to MongoDB BSON Date type on create/update.
`database`	`String`	`null`		No
The database to use.
`arrayAttributes`	`String[]`	`[]`		No
Defines the list of attributes that should be considered as BSON Arrays.
`includeNullValue`	`boolean`	`false`		No
If set to true, retains null values in the target MongoDB document.
`includeEmptyList`	`boolean`	`false`		No
If set to true, retains null values in the target MongoDB document.
`dateFormat`	`String`	`yyyy-MM-dd’T’HH:mm:ss’Z'`		No
Defines the date format to use for MongoDB Date attributes (defaults to ISO 8601 "yyyy-MM-ddTHH:mm:ssZ").
`timeZone`	`String`	`UTC`		No
Defines the timezone to use for MongoDB Date attributes.
`ICFName`	`String`	`name`		No
Defines the name to use in the target MongoDB document for the ICF NAME attribute.

connectionURI

String

null

The MongoDB client connection URI, for example "mongodb://localhost:27017". Overrides other connection parameters.

host

String

localhost

The MongoDB server host name.

port

int

27017

The MongoDB server port number.

user

String

null

The MongoDB username.

password

GuardedString

null

Yes

The password used to connect to MongoDB.

userDatabase

String

null

The name of the database in which the MongoDB user is defined.

clusterAddresses

String[]

null

A list of additional mongodbDB servers when connecting to a MongoDB cluster (["host1:27017","host2:27017",…]").

dateAttributes

String[]

[]

Defines the list of attributes to convert to MongoDB BSON Date type on create/update.

database

String

null

The database to use.

arrayAttributes

String[]

[]

Defines the list of attributes that should be considered as BSON Arrays.

includeNullValue

boolean

false

If set to true, retains null values in the target MongoDB document.

includeEmptyList

boolean

false

If set to true, retains null values in the target MongoDB document.

dateFormat

String

yyyy-MM-dd’T’HH:mm:ss’Z'

Defines the date format to use for MongoDB Date attributes (defaults to ISO 8601 "yyyy-MM-ddTHH:mm:ssZ").

timeZone

String

UTC

Defines the timezone to use for MongoDB Date attributes.

ICFName

String

name

Defines the name to use in the target MongoDB document for the ICF NAME attribute.

⁽¹⁾ Whether the property value is considered confidential, and is therefore encrypted in IDM.

⁽²⁾ A list of operations in this column indicates that the property is required for those operations.

Connection Configuration Properties

Property Type Default Encrypted⁽¹⁾ Required⁽²⁾

Property	Type	Default	Required⁽²⁾
`sslEnabled`	`boolean`	`true`	No
Use secure socket layer to connect to MongoDB.
`sslHostNameValidation`	`boolean`	`true`	No
Defines if host name should be validated when SSL is enabled.
`maxConnectionIdleTime`	`int`	`0`	No
The maximum idle time for a pooled connection in ms (0 means no limit).
`maxConnectionLifeTime`	`int`	`0`	No
The maximum life time for a pooled connection in ms (0 means no limit).
`minConnectionsPerHost`	`int`	`0`	No
The minimum number of connections per host (must be >= 0).
`maxConnectionsPerHost`	`int`	`5`	No
The maximum number of connections per host (must be > 0).

sslEnabled

boolean

true

Use secure socket layer to connect to MongoDB.

sslHostNameValidation

boolean

true

Defines if host name should be validated when SSL is enabled.

maxConnectionIdleTime

int

0

The maximum idle time for a pooled connection in ms (0 means no limit).

maxConnectionLifeTime

int

0

The maximum life time for a pooled connection in ms (0 means no limit).

minConnectionsPerHost

int

0

The minimum number of connections per host (must be >= 0).

maxConnectionsPerHost

int

5

The maximum number of connections per host (must be > 0).

⁽¹⁾ Whether the property value is considered confidential, and is therefore encrypted in IDM.

⁽²⁾ A list of operations in this column indicates that the property is required for those operations.

Groovy Engine configuration

Property Type Default Encrypted⁽¹⁾ Required⁽²⁾

Property	Type	Default	Encrypted⁽¹⁾	Required⁽²⁾
`scriptRoots`	`String[]`	`['bundle-file-path!/scripts/mongodb/']`		Yes
The root folder to load the scripts from. If the value is null or empty the classpath value is used.
`classpath`	`String[]`	`[]`		No
Classpath for use during compilation.
`debug`	`boolean`	`false`		No
If true, debugging code should be activated.
`disabledGlobalASTTransformations`	`String[]`	`null`		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.
`minimumRecompilationInterval`	`int`	`100`		No
Sets the minimum of time after a script can be recompiled.
`recompileGroovySource`	`boolean`	`false`		No
If set to true recompilation is enabled.
`scriptBaseClass`	`String`	`null`		No
Base class name for scripts (must derive from Script).
`scriptExtensions`	`String[]`	`['groovy']`		No
Gets the extensions used to find groovy files.
`sourceEncoding`	`String`	`UTF-8`		No
Encoding for source files.
`targetDirectory`	`File`	`null`		No
Directory into which to write classes.
`tolerance`	`int`	`10`		No
The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted.
`verbose`	`boolean`	`false`		No
If true, the compiler should produce action information.
`warningLevel`	`int`	`1`		No
Warning Level of the compiler.
`customConfiguration`	`String`	`null`		No
Custom Configuration script for Groovy ConfigSlurper.
`customSensitiveConfiguration`	`GuardedString`	`null`	Yes	No
Custom Sensitive Configuration script for Groovy ConfigSlurper.

scriptRoots

String[]

['bundle-file-path!/scripts/mongodb/']

Yes

The root folder to load the scripts from. If the value is null or empty the classpath value is used.

classpath

String[]

[]

Classpath for use during compilation.

debug

boolean

false

If true, debugging code should be activated.

disabledGlobalASTTransformations

String[]

null

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.

minimumRecompilationInterval

int

100

Sets the minimum of time after a script can be recompiled.

recompileGroovySource

boolean

false

If set to true recompilation is enabled.

scriptBaseClass

String

null

Base class name for scripts (must derive from Script).

scriptExtensions

String[]

['groovy']

Gets the extensions used to find groovy files.

sourceEncoding

String

UTF-8

Encoding for source files.

targetDirectory

File

null

Directory into which to write classes.

tolerance

int

10

The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted.

verbose

boolean

false

If true, the compiler should produce action information.

warningLevel

int

1

Warning Level of the compiler.

customConfiguration

String

null

Custom Configuration script for Groovy ConfigSlurper.

customSensitiveConfiguration

GuardedString

null

Yes

Custom Sensitive Configuration script for Groovy ConfigSlurper.

⁽¹⁾ Whether the property value is considered confidential, and is therefore encrypted in IDM.

⁽²⁾ A list of operations in this column indicates that the property is required for those operations.

Operation Script Files

Property Type Default Encrypted⁽¹⁾ Required⁽²⁾

Property	Type	Default	Required⁽²⁾
`authenticateScriptFileName`	`String`	`null`	[interface-AuthenticationApiOp]
The name of the file used to perform the AUTHENTICATE operation.
`createScriptFileName`	`String`	`usersRoles/Create.groovy`	[interface-CreateApiOp]
The name of the file used to perform the CREATE operation.
`customizerScriptFileName`	`String`	`null`	No
The script used to customize some function of the connector. Read the documentation for more details.
`deleteScriptFileName`	`String`	`usersRoles/Delete.groovy`	[interface-DeleteApiOp]
The name of the file used to perform the DELETE operation.
`resolveUsernameScriptFileName`	`String`	`null`	[interface-ResolveUsernameApiOp]
The name of the file used to perform the RESOLVE_USERNAME operation.
`schemaScriptFileName`	`String`	`usersRoles/Schema.groovy`	[interface-SchemaApiOp]
The name of the file used to perform the SCHEMA operation.
`scriptOnResourceScriptFileName`	`String`	`null`	[interface-ScriptOnResourceApiOp]
The name of the file used to perform the RUNSCRIPTONRESOURCE operation.
`searchScriptFileName`	`String`	`usersRoles/Search.groovy`	[interface-GetApiOp] [interface-SearchApiOp]
The name of the file used to perform the SEARCH operation.
`syncScriptFileName`	`String`	`null`	[interface-SyncApiOp]
The name of the file used to perform the SYNC operation.
`testScriptFileName`	`String`	`usersRoles/Test.groovy`	[interface-TestApiOp]
The name of the file used to perform the TEST operation.
`updateScriptFileName`	`String`	`usersRoles/Update.groovy`	[interface-UpdateApiOp]
The name of the file used to perform the UPDATE operation.

authenticateScriptFileName

String

null

[interface-AuthenticationApiOp]

The name of the file used to perform the AUTHENTICATE operation.

createScriptFileName

String

usersRoles/Create.groovy

[interface-CreateApiOp]

The name of the file used to perform the CREATE operation.

customizerScriptFileName

String

null

The script used to customize some function of the connector. Read the documentation for more details.

deleteScriptFileName

String

usersRoles/Delete.groovy

[interface-DeleteApiOp]

The name of the file used to perform the DELETE operation.

resolveUsernameScriptFileName

String

null

[interface-ResolveUsernameApiOp]

The name of the file used to perform the RESOLVE_USERNAME operation.

schemaScriptFileName

String

usersRoles/Schema.groovy

[interface-SchemaApiOp]

The name of the file used to perform the SCHEMA operation.

scriptOnResourceScriptFileName

String

null

[interface-ScriptOnResourceApiOp]

The name of the file used to perform the RUNSCRIPTONRESOURCE operation.

searchScriptFileName

String

usersRoles/Search.groovy

[interface-GetApiOp]
[interface-SearchApiOp]

The name of the file used to perform the SEARCH operation.

syncScriptFileName

String

null

[interface-SyncApiOp]

The name of the file used to perform the SYNC operation.

testScriptFileName

String

usersRoles/Test.groovy

[interface-TestApiOp]

The name of the file used to perform the TEST operation.

updateScriptFileName

String

usersRoles/Update.groovy

[interface-UpdateApiOp]

The name of the file used to perform the UPDATE operation.

⁽¹⁾ Whether the property value is considered confidential, and is therefore encrypted in IDM.

⁽²⁾ A list of operations in this column indicates that the property is required for those operations.

ICF 1.5.20.21

MongoDB connector

Before you start

Install the MongoDB connector

Configure the MongoDB connector

Test the MongoDB connector

MongoDB remote connector

OpenICF Interfaces Implemented by the MongoDB Connector

MongoDB Connector Configuration

Basic Configuration Properties

Connection Configuration Properties

Groovy Engine configuration

Operation Script Files