During this training you will receive an already installed Ubisecure Identity Server environment for your learning purposes. However, knowing the installation process of Ubisecure Identity Server will be very useful in the future when you need to install or upgrade on your own.
In practice, Ubisecure Identity Server is built based on two main components: Ubisecure SSO and Ubisecure CustomerID. For both components, Single Node Installation is the simplest possible deployment and will be used for training purposes.
SSO is installed first, as it is a requirement for installing CustomerID.
The following graph shows an overview of the main steps of installing Ubisecure Identity Server:
Ubisecure SSO Installation
Ubisecure CustomerID Installation
IAM Academy environment
Each student has access to a pre-installed IAM Academy environment consisting of the following services
Ubisecure SSO Management Console
Ubisecure CustomerID Administration Interface
Ubisecure CustomerID Self-service Interface
Ubisecure CustomerID Password reset tool
|Computer||Your public IPv4 address|
Part 1: Getting familiar with Ubisecure SSO Management
Now it's time to get familiar with some basics about SSO management.
Step 1: Sign in to Ubisecure SSO management console
- Open the address https://login.smartplan.com:8443/ubilogin in a browser
Step 2: Change the system user password
- On Site Navigator, select site ”System”
- Select ”Users” tab
- Select user ”Administrator”. Note, username system is an administrator user.
- Select ”Password” and enter a new password of your choice
- Verify by logging out and then logging in
Step 3: Create your own administrative user account
- On Site Navigator, select site ”System”
- Select ”Users” tab
- At the bottom select "New User"
- Enter at least the fields "Name" and "Username." We suggest using your first name as "username."
- Check "Enabled" and finally click "OK" button.
- There are still three steps to do:
- enabling Password as an authentication method for the user,
- and setting a password, and
- adding the user to the administrators' group
- In order to set a password, first go to "Methods" tab. Check authentication method "Password" and finally click the button "Update" at the bottom of the page.
- Now passwords is an authentication method enabled for this user.
- Now go back to Users tab, and click on "Password" button under "Common Tasks"
- Write your password (twice) and click OK. Once the pop up disappears, click "Update."
- In order to add the user to the administrators' group, first go to "Member of" tab. Then click "Add" button at he bottom of the page. Select "Administrators" and "Authenticated Users" groups and click the button "OK"
- Log out from system user.
- Now log in with your own administrative user account.
Part 2: Prepare for federation training tasks
To minimize configuration steps, we must enable two settings - one to disable backchannel logout flows which can be prevented by incorrect firewall settings, and the second to set the metadata configuration to show the public key within an X.509 certificate.
On the main screen, add SAML 2.0 Compatibility Flags (notice the space between the two flags):
Once the flag is set, press "Update" button
Part 3: Manage Ubisecure SSO Services
It's useful to get familiar with the services that Ubisecure SSO runs and how they affect the system. SSO runs two services:
- UbiloginDirectory (Active Directory Lightweight Directory Services)
- UbiloginServer (Apache Tomcat)
These services restart automatically whenever the system reboots.
When do you need to restart a service?
- When changing files that reference new files (new languages, new logos, new templates)
- When installing upgrades
Step 1: Restarting Ubisecure SSO Services
There are two ways of restarting the services: via Command Prompt or via "Services" GUI.
The first way is via the Command Prompt. To open it, type "cmd" in Search box, and right-click to run as Administrator.
The sequence of commands is:
The second way is via Windows graphical user interface. To launch "Services" GUI, type "services" in Search box.
In the following screenshot you can see the two services running:
You must replicate the four steps in the exact order.
Now choose your preferred way, and perform the following tasks in this order:
- Stop UbiloginServer
- Stop UbiloginDirectory
- Start UbiloginDirectory
- Start UbiloginServer
Verify that the service is running by logging in.
Step 2: System User Password Reset
Step 3: Disable System User
Security best practice dictates that administrators should always access the system using personally named accounts and any generic accounts should be disabled.
On Ubisecure SSO management interface, Home / System / Users and select "Administrator." The User object main view will look like this:
Uncheck the "Enabled" status and then click "Update" button. Now the system user is disabled.
Verify by trying to login with "system" user.
Part 4: Getting familiar with Ubisecure CustomerID Admin User Interface
Right after CustomerID is installed, there are no user accounts you can log in. You must first create an administrative user account on the system. This is done with the CustomerID Example User Data Import.
However, in this training environment there is an administrative user created.
Step 1: Create User Accounts on CustomerID with Import Tool
Get familiar with import tool by creating a new user account, the administrative user Scott Long for SmartPlan: email@example.com
%PROGRAMFILES%\Ubisecure\customerid\toolsfolder, modify the provided template import file.
(You can use Notepad++ editor if you prefer so)
Edit the file and include Scott's account. The import file could contain multiple users - for example for migrating users from an existing system, separated by a blank line.
- Now comment anything else that was written on the file, by adding "# " (without quotation marks) at the beginning of any other line.
Then execute the import command:
- Successful execution will show something like this:
Create 'firstname.lastname@example.org': OK
'Assign Role': OK
Step 2: Log in to CustomerID administrative interface
The service address of CustomerID admin interface is:
In case you have problems logging in, there is an administrator account with the following credentials:
Step 3: Set the default language for CustomerID
On CustomerID you must edit eidm2.properties file to set the language preferences. By default after installation, the default language is Finnish. We will now change the default language to English.
Add the following lines to the file C:\Program Files\Ubisecure\customerid\application\custom\eidm2.properties
The change requires a restart of the application server to take effect, see next step.
Unlike SSO, CustomerID uses Wildfly instead of Tomcat.
Changes to the
eidm2.properties file require a restart of the CustomerID service to become effective. The service you must restart is Wildfly as seen in the picture: