Export Tools

Overview

With Export Tool commands you are able to export organizations, users and roles from Ubisecure CustomerID.

Authentication

Export scripts uses REST commands with Basic Authentication, meaning Basic Authentication needs to be enabled and correct credentials need to be available during usage of scripts.

By default, Basic Authentication is enabled, but if you have disabled it with rest.passwordauthentication.enabled in eidm2.properties you need to re-enable it:

rest.passwordauthentication.enabled = true

For credentials, rest.username and rest.password in linux/win32.config cannot be empty and need to match the ones in eidm2.properties.

Running

The tools are located at C:\Program Files\Ubisecure\customerid\tools

For example:

cd C:\Program Files\Ubisecure\customerid\tools
export-users.cmd > users.export

Users can be also exported to CSV (Comma-separated values) format with csv-parameter.

export-users.cmd csv > users.csv

Export Data Filter

Overview

CSV Filter is used to parse selected columns from the exported CSV data. REST interface includes all users' and organizations' attributes to the export file when used as default. CSV filter takes export data as input and parses selected columns and removes the rest.

Running

CSV Filter is as default located at C:\Program Files\Ubisecure\customerid\tools\csv-filter

CSV Filter must be used with REST interface's CSV data and properties file that includes numbers of selected columns. For example: 

cd C:\Program Files\Ubisecure\customerid\tools
export-users.cmd csv | filter.cmd examples\csv-filter\fields.properties > users.csv

fields.properties (is located in csv-filter folder): 

1 4 5

In this example, all users are imported from the Ubisecure CustomerID and columns 1, 4 and 5 are saved to users.csv file.

Export Data Encryption

Overview

Pretty Good Privacy (PGP) is a cryptographic application that is used for signing, encryption and decrypting text, files and directories. PGP encryption uses a combination of hashing, data compression, symmetric-key cryptography and public-key cryptography with several supported algorithms.

GNU Privacy Guard is a GPL Licensed alternative to PGP software. GnuPG can be downloaded from http://www.gnupg.org/ .

Using GnuPG with Data Export

It is possible to encrypt exported data from Ubisecure CustomerID with PGP. For example: 

cd C:\Program Files\Ubisecure\customerid\tools
export-users.cmd csv | gpg -e -r Bob > users.csv.gpg