OpenIDM 2.1 Integration Guide

curl
  --header "X-OpenIDM-Username: openidm-admin"
  --header "X-OpenIDM-Password: openidm-admin"
  --request GET
  "http://localhost:8080/openidm/managed/..."

curl
  --header "X-OpenIDM-Username: openidm-admin"
  --header "X-OpenIDM-Password: openidm-admin"
  --request GET
  "http://localhost:8080/openidm/system/..."

# List all configuration objects:
curl --request GET \
 --header "X-OpenIDM-Username: openidm-admin" \
 --header "X-OpenIDM-Password: openidm-admin" http://localhost:8080/openidm/config
 
# List single instance audit configuration object:
curl \
 --header "X-OpenIDM-Username: openidm-admin" \
 --header "X-OpenIDM-Password: openidm-admin" http://localhost:8080/openidm/config/audit
 
# List multiple instance configuration object:
curl \
 --header "X-OpenIDM-Username: openidm-admin" \
 --header "X-OpenIDM-Password: openidm-admin" http://localhost:8080/openidm/config/provisioner.openicf/xml

PROD.location=production
DEV.location=development

{
"dbUrl" : "local:./db/&{&{environment}.location}-openidm",
"user" : "admin",
"poolMinSize" : 5,
"poolMaxSize" : 20,
...
}

# For DEV environment:
export OPENIDM_OPTS="-Xmx1024m -Denvironment=PROD"
./startup.sh
 
# For PROD environment:
export OPENIDM_OPTS="-Xmx1024m -Denvironment=DEV"
./startup.sh

{
    "logTo" : [
        {
            "logType" : "csv",
            "location" : "&{user.home}/audit",
            "recordDelimiter" : ";"
        }
    ]
}

SEVERE
WARNING
INFO
CONFIG
FINE
FINER
FINEST

org.forgerock.openidm.script.javascript.JavaScript.level=level

org.forgerock.openidm.script.javascript.JavaScript.script-name.level=level

cat provisioner.openicf.connectorinfoprovider.jsn 
{
   "connectorsLocation" : "connectors",
   "remoteConnectorServers" :
      [
         {
            "name" : "dotnet",
            "host" : "127.0.0.1",
            "port" : 8759,
            "useSSL" : false,
            "timeout" : 0,
            "key" : "Passw0rd"
         }
      ]
}

{
    "objects" : [
        {
            "name" : "user",
            "properties" : [
                {
                    "name" : "password",
                    "encryption" : {
                        "key" : "openidm-sym-default"
                    }
                }
            ],
            "onValidate" : {
                "type" : "text/javascript",
                "file" : "script/password-validator.js"
            }
        }
    ]
}

const dictionary = ['password','123456','12345678', 'qwerty', 'abc123'];
 
function isValidPassword() {
    var cleartextObject = openidm.decrypt(object);
    for (var i = 0; i < dictionary.length; i++) {
        if (cleartextObject.password == dictionary[i]) {
            throw "Password Policy Violation Exception";
        };
    };
};
 
isValidPassword();

        "credential-query" : "SELECT * FROM ${_resource} WHERE userName = '${username}'",
        "credential-internaluser-query" : "SELECT * FROM internal_user WHERE _openidm_id = ${username}",

cat authentication.json 
{
    "queryId" : "credential-query",
    "queryOnResource" : "managed/user",
    "propertyMapping" : {
        "userId" : "_id",
        "userCredential" : "password",
        "userRoles" : "roles"
    },
    "defaultUserRoles" : [ ]
}

curl --user userName:password

curl
 --header "X-OpenIDM-Username: openidm-admin"
 --header "X-OpenIDM-Password: openidm-admin"

cat authentication.json 
{
    "queryId" : "credential-query",
    "queryOnResource" : "managed/user",
    "propertyMapping" : {
        "userId" : "_id",
        "userCredential" : "password",
        "userRoles" : "roles"
    },
    "defaultUserRoles" : [ ]
}

if (!allow()) {
    throw "Access denied";
}

mvn package

ant demo.start

ant tomcat.stop

$ cd /opt/openidm/builtFromSrc/activiti-5.10/apps/apache-tomcat-6.0.32/webapps
$ pwd
/opt/openidm/builtFromSrc/activiti-5.10/apps/apache-tomcat-6.0.32/webapps
$ ls
activiti-explorer  activiti-rest  docs  examples  host-manager  manager  ROOT
$ cp /mnt/hgfs/vmshare/src/openidm-workflow-remote-2.1.0-SNAPSHOT.war .

$ cd /opt/openidm/builtFromSrc/activiti-5.10/apps/apache-tomcat-6.0.32/webapps/activiti-explorer/WEB-INF/lib
$ pwd
/opt/openidm/builtFromSrc/activiti-5.10/apps/apache-tomcat-6.0.32/webapps/activiti-explorer/WEB-INF/lib
$ cp /mnt/hgfs/vmshare/src/openidm-workflow-activiti-2.1.0-SNAPSHOT-jar-with-dependencies.jar .

$ cd /opt/openidm/builtFromSrc/activiti-5.10/apps/apache-tomcat-6.0.32/webapps/activiti-explorer/WEB-INF
$ pwd
/opt/openidm/builtFromSrc/activiti-5.10/apps/apache-tomcat-6.0.32/webapps/activiti-explorer/WEB-INF
$ ls
activiti-ui-context.xml  applicationContext.xml  classes  lib  web.xml
$ vi applicationContext.xml

cd $ACTIVITI_HOME/setup
ant demo.stop
ant demo.start

cd $OPENIDM_HOME
cp samples/misc/workflow.json conf/

{
    "enabled" : true,
    "location" : "remote",
    "engine" : {
        "url" : "http://localhost:9090/openidm-workflow-remote-2.1.0-SNAPSHOT/",
        "username" : "kermit",
        "password" : "kermit"
    },

cd $OPENIDM_HOME
./startup.sh

curl \
  --header "X-OpenIDM-Username: openidm-admin" \
  --header "X-OpenIDM-Password: openidm-admin" \
  --request GET "http://localhost:8080/openidm/workflow"
 
{"result":[{"name":"Vacation request","processDefinitionId":"vacationRequest:1:21","key":"vacationRequest"},{"name":"Helpdesk process","processDefinitionId":"escalationExample:1:22","key":"escalationExample"},{"name":"Review sales lead","processDefinitionId":"reviewSaledLead:1:23","key":"reviewSaledLead"},{"name":"Fix system failure","processDefinitionId":"fixSystemFailure:1:24","key":"fixSystemFailure"},{"name":"Expense process","processDefinitionId":"adhoc_Expense_process:1:25","key":"adhoc_Expense_process"}]}

curl \
	--header "X-OpenIDM-Username: openidm-admin" \
	--header "X-OpenIDM-Password: openidm-admin" \
	--request POST "http://localhost:8080/openidm/workflow/processinstance?_action=createProcessInstance" \
	--data '{ "key":"osgiProcess" }'
 
{"_id":"1010","processInstanceId":"1010","status":"ended","businessKey":null,"processDefinitionId":"osgiProcess:1:915"}

$ pwd
/opt/openidm/builtFromSrc/activiti-5.10/apps/apache-tomcat-6.0.32/logs
$ vi catalina.out	
 
script task using expression resolver: [result:[[name:Vacation request, processDefinitionId:vacationRequest:1:21, key:vacationRequest], [name:Helpdesk process, processDefinitionId:escalationExample:1:22, key:escalationExample], [name:Review sales lead, processDefinitionId:reviewSaledLead:1:23, key:reviewSaledLead], [name:Fix system failure, processDefinitionId:fixSystemFailure:1:24, key:fixSystemFailure], [name:Expense process, processDefinitionId:adhoc_Expense_process:1:25, key:adhoc_Expense_process], [name:Osgi process, processDefinitionId:osgiProcess:1:915, key:osgiProcess]]]

Sep 18, 2012 1:07:26 PM org.restlet.engine.log.LogFilter afterHandle
INFO: 2012-09-18	13:07:26	127.0.0.1	kermit	127.0.0.1	9090	GET	/openidm-workflow-remote-2.1.0-SNAPSHOT/	-	200	-0	8	http://localhost:9090	Restlet-Framework/2.0.15	-
script task using expression resolver: [result:[[name:Vacation request, processDefinitionId:vacationRequest:1:21, key:vacationRequest], [name:Helpdesk process, processDefinitionId:escalationExample:1:22, key:escalationExample], [name:Review sales lead, processDefinitionId:reviewSaledLead:1:23, key:reviewSaledLead], [name:Fix system failure, processDefinitionId:fixSystemFailure:1:24, key:fixSystemFailure], [name:Expense process, processDefinitionId:adhoc_Expense_process:1:25, key:adhoc_Expense_process], [name:Osgi process, processDefinitionId:osgiProcess:1:915, key:osgiProcess]]]
Sep 18, 2012 1:07:26 PM org.restlet.engine.log.LogFilter afterHandle
INFO: 2012-09-18	13:07:26	127.0.0.1	kermit	127.0.0.1	9090	GET	/openidm-workflow-remote-2.1.0-SNAPSHOT/	-	200	-0	15	http://localhost:9090	Restlet-Framework/2.0.15	-
script task using resolver: [result:[[name:Vacation request, processDefinitionId:vacationRequest:1:21, key:vacationRequest], [name:Helpdesk process, processDefinitionId:escalationExample:1:22, key:escalationExample], [name:Review sales lead, processDefinitionId:reviewSaledLead:1:23, key:reviewSaledLead], [name:Fix system failure, processDefinitionId:fixSystemFailure:1:24, key:fixSystemFailure], [name:Expense process, processDefinitionId:adhoc_Expense_process:1:25, key:adhoc_Expense_process], [name:Osgi process, processDefinitionId:osgiProcess:1:915, key:osgiProcess]]]

cat workflow.json 
{
    "enabled" : true
}

{
    "enabled" : true,
    "location" : "remote",
    "engine" : {
        "url" : "http://localhost:9090/openidm-workflow-remote-2.1.0-SNAPSHOT/",
        "username" : "kermit",
        "password" : "kermit"
    },

curl --header "X-OpenIDM-Username: openidm-admin" \
  --header "X-OpenIDM-Password: openidm-admin" \
  --data '{"foo":"bar"}' \
  --request POST "http://localhost:8080/openidm/workflow?_action=myWorkflow"

curl \
	--header "X-OpenIDM-Username: openidm-admin" \
	--header "X-OpenIDM-Password: openidm-admin" \
	--request POST "http://localhost:8080/openidm/workflow/processinstance?_action=createProcessInstance" \
	--data '{"key":"EmailNotification","fromSender" : "noreply@openidm","toEmail" : "jdoe@example.com"}'
 
{"_id":"208","processInstanceId":"208","status":"ended","businessKey":null,"processDefinitionId":"EmailNotification:1:207"}

"firstName","uid","lastName","email","employeeNumber",password,"sunrise","sunset","active"
"Darth","DDOE","Doe","doe@example.com","123456","Z29vZA==","2012-06-30T00:00:00Z","2012-12-23T00:00:00Z","TRUE"

cd $OPENIDM_HOME
cp samples/misc/external.email.json conf/

{
        "host" : "smtp.example.com",
        "port" : "25",
        "username" : "openidm",
        "password" : "secret12",
        "mail.smtp.auth" : "true",
        "mail.smtp.starttls.enable" : "true"
}

-> scr list
...
[   6] [active       ] org.forgerock.openidm.external.email
...

curl \
 --header "X-OpenIDM-Username: openidm-admin" \
 --header "X-OpenIDM-Password: openidm-admin" \
 --request POST "http://localhost:8080/openidm/external/email?_from=openidm@example.com&_to=user@example.com&_subject=Test&_body=Test"
 
{"status":"OK"}

var params =  new Object();
params._from = "openidm@example.com";
params._to = "admin@example.com";
params._cc = "wally@example.com,dilbert@example.com";
params._subject = "OpenIDM recon report";
params._type = "text/html";
params._body = "<html><body><p>Recon report follows...</p></body></html>";
 
openidm.action("external/email", params);

curl \
  --header "X-OpenIDM-Username: openidm-admin" \
  --header "X-OpenIDM-Password: openidm-admin" \
  --request POST "http://localhost:8080/openidm/workflow?_action=osgiProcess"
 
curl \
>   --header "X-OpenIDM-Username: openidm-admin" \
>   --header "X-OpenIDM-Password: openidm-admin" \
>   --request POST "http://localhost:8080/openidm/workflow?_action=osgiProcess"
{"error":400,"reason":"Bad Request","detail":"action method not implemented on workflow"}