openidm-cli

node-openidm-cli

OpenIDM CLI for Node.js.

Install

Install from npm:

$ npm install -g openidm-cli

Introduction

Create a profile information.

$ openidm configure
Server URL [http://localhost:8080]: OpenIDM server url
Username [openidm-admin]: X-OpenIDM-Username header value
Password [openidm-admin]: X-OpenIDM-Password header value

The settings are stored in the following location.

$ cat ~/.openidm-cli/credentials
[default]
openidm_server_url=http://localhost:8080
openidm_username=xxxxxxxxxx
openidm_password=xxxxxxxxxx

Operation of a OpenIDM

Example: create managed object.

$ openidm managed/user?_action=create \  
          -X POST \  
          -d '{"userName":"demiglacesource","password":"P@ssw0rd","givenName":"demiglace","sn":"source","mail":"[e-mail]"}'

Example: read managed object.

$ openidm managed/user/demiglacesource -X GET

Options

Please refer to the help.

$ openidm -h

Usage: openidm configure [options]

	"configure" is the first step. 
	performs a "configure", you can set the authentication information for OpenIDM REST API.

	--profile, -p
		OpenIDM profile
		'script --profile=value' or 'script -p value'

Usage: openidm resource [options]

	"resource" is a URI of OpenIDM REST API.

	--help, -h
		Displays help information about this script

	--version, -v
		Displays version info

	--request, -X
		POST or GET or PUT or PATCH or HEAD or DELETE
		'script --request=value' or 'script -X value'

	--data, -d
		JSON value
		'script --data=value' or 'script -d value'

	--rev, -r
		Resource of revision
		'script --rev=value' or 'script -r value'

	--profile, -p
		OpenIDM profile
		'script --profile=value' or 'script -p value'

Using Profile

Profile information can save multiple.
For example, set as follows.

$ openidm configure -p demiglacesource
Server URL [http://localhost:8080]: http://localhost:8080
Username [openidm-admin]: openidm-admin
Password [openidm-admin]: openidm-admin

Profile is added to the credentials.

$ cat ~/.openidm-cli/credentials
[demiglacesource]
openidm_server_url=http://localhost:8080
openidm_username=openidm-admin
openidm_password=openidm-admin

Profile specified method can be selected from the following two types.

$ openidm managed/user/demiglacesource -X GET -p demiglacesource

or

$ export OPENIDM_DEFAULT_PROFILE=demiglacesource
$ openidm managed/user/demiglacesource -X GET

Read data from file

JSON value also accepts input from a file.
Without leaving the shell history, can safely use.

$ cat data.json
{"userName":"demiglacesource","password":"P@ssw0rd","givenName":"demiglace","sn":"source","mail":"[e-mail]"}

$ openidm managed/user?_action=create -X POST -d data.json
...

Link

• https://forgerock.org/openidm
• http://openidm.forgerock.org/docs.html