When importing users or other data from external systems, it is recommended that REST API provided by the Ubisecure CustomerID is used.
Users can be created by using the functions provided by the REST API or by using the import tool provided in the installation package.
Import Tool
Overview
With Import Tool you are able to create a large amount of organizations, users and roles to Ubisecure CustomerID. Also, you are able to modify user details and role memberships. The data must be stored to a set of files and then can be imported.
For full support of extended characters, the data file must be saved in UTF-8 format without BOM (byte order mark). See http://en.wikipedia.org/wiki/UTF-8#Byte_order_mark
Running
Import tool on Windows is located at C:\Program Files\Ubisecure\customerid\ application\tools\importtool\import.cmd. On Linux the respective path is /usr/local/ubisecure/customerid/application/tools/importool/import.shsh .
Using the import tool is a straight forward process; the command takes a list of filenames as a parameter and imports the data found in them to the system. For example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
import.cmd importdata.cid |
would read the file importdata.cid and take the data therein to the system.
Error Policies
The behavior of the import tool in error situations can be affected using two parameters: the error policy and the duplicate policy.
...
For example calling import tool as follows:
| Code Block | ||||
|---|---|---|---|---|
| ||||
import.cmd -errors stop -duplicates error importdata.cid |
would import entities normally but if at any point an entity to be added is already found in the system the process would stop.
Import File Structure (Organization)
Compulsory values:
entity: organization
id: ENTITYNAME
Optional values:
virtual: true | false (default: false)
friendlyName: FRIENDLYNAME (default: empty)
organizationClass: ORGANIZATIONTYPE (default: empty)
membership: ENTITYNAME (multivalued)
role: ROLENAME (multivalued)
<custom attribute>: VALUE
| Note |
|---|
NOTE: You don't need to include those roles to the organization definition that will be added to the organization automatically based on the organization type definition in the |
Example:
entity: organization
id: Example Organization/Example Department
virtual: false
friendlyName: Example
membership: Project1
membership: Project2
role: OrganizationMainUser
role: OrganizationUser
idnumber: 1234
Import File Structure (Role)
Compulsory values:
entity: role
role: ENTITYNAME
Supported characters are ("a-zA-Z") with Scandinavian characters ("äöåÄÖÅ"), numbers ("0-9"), space (" ") and ",._-". All other characters are replaced with a space.
Example:
entity: role
role: Example Organization/TestRole
Import File Structure (User)
Compulsory values:
entity: user
organization: ENTITYNAME
Optional values:
uniqueID: UUID (default: random, cannot be used when importing to AD)
uid: USERNAME (compulsory if new user)
firstname: FIRSTNAME
surname: SURNAME
email: EMAIL (compulsory if new user)
mobile: MOBILE
hetu: SSN
locale: LOCALE
roles.remove: true | false (default: false)
role: ENTITYNAME
password: PASSWORD
sms.activated: true | false (default: true)
otp.activated: true | false (default: false)
otp.state: OTPSTATE
create: true | false (default: false)
<custom attribute>: VALUE
Example:
entity: user
organization: Example Organization
uniqueID: d78db826-9469-44ed-9c95-4825ce3cdf06
uid: john.smith
firstname: John
surname: Smith
email: john.smith@example.com
mobile: +358505551234
roles.remove: true
role: eIDM/eIDMUser
role: Example Organization/OrganizationUser
role: Example Organization/OrganizationMainUser
role: Another Example/OrganizationMainUser
password: pass
create: true
customerid: 12345