README.md revision 98402e015588101604b2c0ac6adfd8ab924a4fa4
/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2014 ForgeRock AS. All rights reserved.
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*/
sciptedcrest2dj Sample - Scripted CREST to OpenDJ
=================================================
This sample demonstrates how to use Scripted CREST to connect to OpenDJs REST API. This sample enables the basic create,
read, update, and delete (CRUD) operations for groups and users. This sample requires a fresh install of OpenIDM and
OpenDJ.
Scripted CREST is meant to be used with CREST based REST API. The main difference between a CREST based REST API and a
generic REST API is CREST is a well known API for ForgeRock products and we can leverage the CREST resources in the
groovy scripts to create CREST requests.
For example, in CREST to do a create request you would do the following.
CreateRequest request = Requests.newCreateRequest(objectClassInfo.resourceContainer, new JsonValue(user))
Resource resource = connection.create(new RootContext(), request)
This will create a formatted create REST request and do the HTTP request based on that format. With a generic REST API,
the groovy script will need to manually build an HTTP request based on some defined REST API. This manual creation
would require setting the method, path, content and other HTTP request properties to make the REST call.
Setup OpenDJ
------------
1. Extract OpenDJ to a folder called opendj.
2. Run the following command to initalize OpenDJ.
$ opendj/setup --cli --hostname localhost --ldapPort 1389 --rootUserDN "cn=Directory Manager" \
--rootUserPassword password --adminConnectorPort 4444 --baseDN dc=com --acceptLicense --addBaseEntry \
--no-prompt --quiet
3. Setup Replication on OpenDJ.
$ opendj/bin/dsconfig create-replication-server --hostname localhost --port 4444 --bindDN "cn=Directory Manager" \
--bindPassword password --provider-name "Multimaster Synchronization" --set replication-port:8989 \
--set replication-server-id:2 --type generic --trustAll --no-prompt
$ opendj/bin/dsconfig create-replication-domain --hostname localhost --port 4444 --bindDN "cn=Directory Manager" \
--bindPassword password --provider-name "Multimaster Synchronization" --domain-name example_com \
--set base-dn:dc=example,dc=com --set replication-server:localhost:8989 --set server-id:3 --type generic \
--trustAll --no-prompt
4. Enable OpenDJ HTTP Connection Handler.
$ opendj/bin/dsconfig set-connection-handler-prop --hostname localhost --port 4444 \
--bindDN "cn=Directory Manager" --bindPassword password --handler-name "HTTP Connection Handler" \
--set enabled:true --set listen-port:8090 --no-prompt --trustAll
5. Enable OpenDJ HTTP logs.
$ opendj/bin/dsconfig set-log-publisher-prop --hostname localhost --port 4444 --bindDN "cn=Directory Manager" \
--bindPassword password --publisher-name "File-Based HTTP Access Logger" --set enabled:true --no-prompt \
--trustAll
6. Load the ldif supplied in the data folder into OpenDJ.
$ opendj/bin/ldapmodify --bindDN "cn=Directory Manager" --bindPassword password --hostname localhost \
--port 1389 --filename /path/to/openidm/samples/scriptedcrest2dj/data/ldap.ldif
7. Copy the http-config.json file located in the data folder to the opendj/config directory.
8. Restart OpenDJ.
$ opendj/bin/stop-ds --restart
OpenIDM Instructions
--------------------
1. Start OpenIDM with the configuration for sample scriptedcrest2dj.
2. Create a Group.
$ curl --header "Content-Type: application/json" \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request POST \
--data '{
"_id" : "group1"
}' \
{
"_rev": "0000000025c93bdd",
"meta": {
"created": "2014-10-08T03:55:46Z"
},
"displayName": "group1",
"_id": "group1"
}
3. Create a User.
$ curl --header "Content-Type: application/json" \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request POST \
--data '{
"name": {
"familyName": "Smith",
"givenName" : "User"
},
"contactInformation": {
"emailAddress" : "user@example.com",
"telephoneNumber" : "444-444-4444"
},
"password" : "TestPassw0rd",
"displayName" : "User.Smith",
"_id" : "user"
}' \
{
"_rev": "00000000ecf58034",
"contactInformation": {
"emailAddress": "user@example.com",
"telephoneNumber": "444-444-4444"
},
"meta": {
"created": "2014-10-08T03:56:13Z"
},
"name": {
"givenName": "User",
"familyName": "Smith"
},
"_id": "user",
"userName": "user@example.com",
"displayName": "User.Smith"
}
4. Update user telephone number.
$ curl --header "Content-Type: application/json" \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request PUT \
--data '{
"name": {
"familyName": "Smith",
"givenName" : "User"
},
"contactInformation": {
"emailAddress" : "user@example.com",
"telephoneNumber" : "555-555-5555"
},
"password" : "TestPassw0rd",
"displayName" : "User.Smith",
"_id" : "user"
}' \
{
"_rev": "00000000981a9f3f",
"contactInformation": {
"emailAddress": "user@example.com",
"telephoneNumber": "555-555-5555"
},
"meta": {
"created": "2014-10-08T03:56:13Z",
"lastModified": "2014-10-08T03:56:50Z"
},
"name": {
"givenName": "User",
"familyName": "Smith"
},
"_id": "user",
"userName": "user@example.com",
"displayName": "User.Smith"
}
5. Update group by adding a user.
$ curl --header "Content-Type: application/json" \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request PUT \
--data '{
"_id" : "group1",
"members" : [{"_id" : "user"}]
}' \
{
"_rev": "00000000c07c6d6a",
"meta": {
"created": "2014-10-08T03:55:46Z",
"lastModified": "2014-10-08T03:57:24Z"
},
"displayName": "group1",
"members": [
{
"displayName": "User.Smith",
"_id": "user"
}
],
"_id": "group1"
}
6. Read the user data.
$ curl --header "Content-Type: application/json" \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request GET \
{
"_rev": "00000000981a9f3f",
"contactInformation": {
"emailAddress": "user@example.com",
"telephoneNumber": "555-555-5555"
},
"_id": "user",
"meta": {
"created": "2014-10-08T03:56:13Z",
"lastModified": "2014-10-08T03:56:50Z"
},
"name": {
"givenName": "User",
"familyName": "Smith"
},
"displayName": "User.Smith",
"groups": [
{
"_id": "group1"
}
],
"userName": "user@example.com"
}
7. Read the group.
$ curl --header "Content-Type: application/json" \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request GET \
{
"_rev": "00000000c07c6d6a",
"displayName": "group1",
"_id": "group1",
"members": [
{
"displayName": "User.Smith",
"_id": "user"
}
],
"meta": {
"created": "2014-10-08T03:55:46Z",
"lastModified": "2014-10-08T03:57:24Z"
}
}
8. Delete the user.
$ curl --header "Content-Type: application/json" \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request DELETE \
{
"_id": "user"
}
9. Delete the group.
$ curl --header "Content-Type: application/json" \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request DELETE \
{
"_id": "group1"
}
Other Available Commands
------------------------
This sample also supports running reconciliation on users and groups.
$ curl -k -H "Content-type: application/json" -u "openidm-admin:openidm-admin" -X POST \
{"_id":"a72d6c6f-c019-4598-a199-52d9dcca9dae","state":"ACTIVE"}
$ curl -k -H "Content-type: application/json" -u "openidm-admin:openidm-admin" -X POST \
{"_id":"5d887e40-250a-4da7-af48-d2c9bc6c0b00","state":"ACTIVE"}
This shows the basic CRUD operations on users and groups using ScriptedCREST and the OpenDJ rest2ldap API. To read
more documentation on the Groovy ScriptedCREST connector and for help with customization please see the
[Groovy Connector Framework Docs](http://openicf.forgerock.org/connectors/groovy-connector/doc/groovy-connector-1.4.2.0-SNAPSHOT/index.html)