Use case scenario
An operator wants to synchronize users from a CSV file into Identity Manager.
This article describes how to synchronize users from a CSV file into Smart ID Identity Manager.
Prerequisites
-
The steps in Users CSV - Start-up guide must have been done.
Step-by-step instruction for the administrator
Prepare the CSV file
-
The format of the CSV file must include all the fields in the data pool in this exact order (if not using a header):
FirstName;LastName;UserName;CN;UPN;Email;UserNumber;User type;User status;Comment;Reason;Template;Organizational unit;Organization;ObjectGUID
-
Leave empty fields missing, but the entry should still exist.
-
Do not leave blank spaces before or after the delimiter.
Example:Example: CSV fileTestFirst;TestLast;testuser;10.20.30;2423;testuser@test.de;123;type;active;;;;TestOrgUnit;Nexus;123321
-
Upload the CSV file on the server so that Identity Manager has access to it (if using Docker you must create a volume).
Log in to Identity Manager Admin
-
Log in to Identity Manager Admin with your administrator account.
Do settings in Identity Manager Admin
-
Set the path to the CSV file in Identity Manager Admin:
-
In Identity Manager Admin, go to Home > Data Pools > CSV Users.
-
In the Data source tab, insert the path of the CSV file from the server in the File Name field.
-
Select the Delimiter. In the example above it is ; (semi colon).
-
-
To modify the settings, see "Options" below.
Schedule the synchronization
To set up scheduling of the synchronization:
-
In Identity Manager Admin, go to Home > Batch Synchronization.
-
Select Synchronize CSV users to Identity Manager.
-
To adjust the scheduler, type the appropriate cron expression in Expression to schedule the job.
-
Click Save.
-
To see this update in Identity Manager Operator, you must click Clear cache in the in Identity Manager Operator UI.
Use case details
Overview and technical details
|
Use case description |
As a administrator I want to sync users via CSV file.
|
|---|---|
|
Outcome |
|
|
Symbolic name of batch synchronization |
UsersAddonCSVBatchSyncCreate |
|
Name of batch synchronization |
Import users from CSV |
|
Symbolic name of the process |
UsersAddonCSVBatchSyncProcCreate |
|
Process name |
Batch sync create user |
|
Component |
Synchronize CSV users with Identity Manager |
|
Process start |
Batch synchronization |
Options
About the options
See Request card.
Set the user's end state
Option: Set the user's end state
-
Default = true (the end state is active)
-
To manage the option, see here: Users add-on CSV - Manage option to set the user's end state
Add uniqueness check
Option: Add uniqueness check
-
Default = true (uniqueness check will be done)
-
To manage the option, see here: Users add-on CSV- Manage option to add a uniqueness check
Additional information