Scripting

Scripting lets you extend IDM functionality. For example, you can provide custom logic between source and target mappings, define correlation rules, filters, triggers, and so on. This guide shows you how to use scripts in IDM and provides reference information on the script engine.

Call a Script

Call a script from the IDM configuration using inline source or a file reference.

Script Configuration

Modify the parameters to compile, debug, and run scripts.

Custom Endpoints

Run arbitrary scripts through the REST URI.

Script Triggers

Learn where and how you can trigger scripts.

Script Variables

Learn about the variables available to scripts.

Scripting Function Reference

Reference for openidm object methods, global utility functions, and logger functions available to scripts.

IDM supports scripts written in JavaScript and Groovy, and bundles the following libraries to support scripting.

Script options and locations are defined in the script configuration.

Default scripts are located in (/path/to/openidm/bin/defaults/script/). Do not modify the scripts in this directory. Rather, copy the default scripts to a different location, make the changes, and update the referenced scripts in the applicable conf/ file. You can put custom scripts in any of the locations referenced in the sources property in conf/script.json.

Rhino

Rhino runs JavaScript. Rhino has limited support for ES6 / ES2015 (JavaScript version 1.7). For more information, refer to Rhino ES2015 Support.

To find the Rhino version bundled with your instance, locate the org.mozilla.rhino-<version>.jar file in the openidm/bundle directory.

Groovy

Groovy provides Groovy script support.

To find the Groovy version bundled with your instance, locate the groovy-<version>.jar file in the openidm/bundle directory.

Lodash and Handlebars

IDM bundles Lodash and Handlebars for Rhino scripting.

Using Handlebars JS in server-side JS scripts requires synchronization; for example:

var Handlebars = require("lib/handlebars");
var result = new Packages.org.mozilla.javascript.Synchronizer(function() {
  var template = Handlebars.compile("Handlebars {{doesWhat}}");
  return template({ doesWhat: "rocks!" });
}, Handlebars)();
console.log(result);

To find the version bundled with your instance:

Lodash: Check the version comment at the top of openidm/bin/defaults/script/lib/lodash.js.
Handlebars: Locate the handlebars-<version>.jar file in the openidm/bundle directory.

BouncyCastle

IDM bundles BouncyCastle for signing JWTs.

The IDM-bundled BouncyCastle .jar includes the unused org.bouncycastle.asn1.util.Dump command-line utility. Don’t reference it in your scripts. Learn more in BouncyCastle issue 634.

To find the BouncyCastle version bundled with your instance, locate the bcprov-<version>.jar or bcpkix-<version>.jar file in the openidm/bundle directory.

Name changes for ForgeRock products

Product names changed when ForgeRock became part of Ping Identity.

The following name changes have been in effect since early 2024:

Old name	New name
ForgeRock Identity Cloud	PingOne Advanced Identity Cloud
ForgeRock Access Management	PingAM
ForgeRock Directory Services	PingDS
ForgeRock Identity Management	PingIDM
ForgeRock Identity Gateway	PingGateway

Old name

New name

ForgeRock Identity Cloud

PingOne Advanced Identity Cloud

ForgeRock Access Management

PingAM

ForgeRock Directory Services

PingDS

ForgeRock Identity Management

PingIDM

ForgeRock Identity Gateway

PingGateway

Learn more about the name changes in New names for ForgeRock products in the Knowledge Base.