Difference between revisions of "HowTo:Configure UBIK Credentials Service"

Latest revision as of 08:32, 12 August 2026

The UBIK Credentials Portal is an ASP.NET Core web application that provides a self-service interface for users to set their initial password and securely reset forgotten passwords. The portal communicates with the UBIK USAM WebService to perform password management operations.

This page describes how to install, configure, and use the UBIK Credentials Portal.

[edit]

Prerequisites
Installation
Configuration

Prerequisites

Make sure the USAM is installed on the IIS Server.
Install the UBIK Credentials Portal on the IIS Server.
If the IIS Server does not have it installed, download and install the .NET 8.0 Hosting Bundle from Microsoft. This bundle includes the .NET Runtime and the ASP.NET Core Runtime required for hosting ASP.NET Core applications on IIS.
Make sure all published application files are accessible.
Configure the application by modifying the appsettings.json file included in the published UBIK Credentials Portal package.

Installation

Download the UBIK Credentials Portal package from the Augmensys release portal.
Deploy the published UBIK Credentials Portal files to the designated website folder on the IIS Server (create the folder if necessary).
IIS Manager setting check: see IIS Manager

IIS Manager

Add a new website under the Sites folder in IIS Manager.
- "Site Name", "Application pool", "Physical path", "Binding", "Host Name", "Port" and "SSL Certificate" should be adapted accordingly.
Example settings.

When setting up the IIS Application Pool responsible for the Credentials Portal, the Load User Profile setting should be enabled.

Configuration

Firewall settings

Firewall and Router settings must be adapted so the Credentials Portal can be accessed from outside the IIS Server.

Create a new inbound rule in the Windows Firewall using the same port configured in the IIS website binding.
Configure port forwarding on the router using the same port if external access is required.

USAM Connection

The Credentials Portal communicates with the UBIK USAM WebService.

Open the appsettings.json file included in the published UBIK Credentials Portal package and configure the USAM endpoint.

"UsamService": {
"BaseUrl": "https://hostname:port/PathToUsam/USAM.svc/"
}

Password Policy

The Credentials Portal supports configurable password policies to enforce secure passwords.

The following settings can be configured:

Minimum password length
Require at least one lowercase character
Require at least one uppercase character
Require at least one digit
Require at least one special character

Example:

"PasswordStrength": {
"MinLength": 8,
"RequireUpperCase": true,
"RequireLowerCase": true,
"RequireDigit": true,
"RequireSpecialCharacter": true
}

Portal Appearance

The appearance of the portal can be customized.

The following properties can be configured:

Portal title
Background (brand) color
Font color
Portal icon

Example:

"PortalAppearance": {
"PortalTitle": "Your preferred text here",
"BrandColor": "#F16FFF",
"BrandFontColor": "#FFFFFF",
"IconUrl": "https://yourdomain.com/icon.png"
}

@@ Line 1: / Line 1: @@
-= UBIK Credentials Portal =
+The '''UBIK Credentials Portal''' is an ASP.NET Core web application that provides a self-service interface for users to set their initial password and securely reset forgotten passwords. The portal communicates with the UBIK USAM WebService to perform password management operations.
-The '''UBIK Credentials Portal''' is an ASP.NET Core web application that provides a web-based self-service interface for users to securely define their initial password and reset forgotten passwords. The portal communicates with the UBIK USAM WebService to perform password management operations.
+This page describes how to install, configure, and use the UBIK Credentials Portal.
-This page describes how to install, configure and use the UBIK Credentials Portal.
+<!-- DO NOT REMOVE THIS -->{{Template:HowTo/Begin}}<!-- DO NOT REMOVE THIS -->
-= Overview =
+= Prerequisites =
 * Make sure the [[HowTo:Install_UBIK_Web_Service#UBIK.C2.AE_Authentication_Web_Service_USAM.svc|USAM]] is installed on the IIS Server.
@@ Line 13: / Line 13: @@
 * Configure the application by modifying the '''appsettings.json''' file included in the published UBIK Credentials Portal package.
+= Installation =
-= Installation UBIK Credentials Portal =
 * Download the UBIK Credentials Portal package from the Augmensys release portal.
@@ Line 24: / Line 23: @@
 * Add a new website under the '''Sites''' folder in IIS Manager.
 ** "Site Name", "Application pool", "Physical path", "Binding", "Host Name", "Port" and "SSL Certificate"  should be adapted accordingly.
-* ''' Example settings'''. <br/> [[Image:IIS1.PNG|300px]]
+* ''' Example settings'''. <br/> [[Image:Credentials_IIS.png|300px]]
 {{Hint|When setting up the IIS Application Pool responsible for the Credentials Portal, the ''Load User Profile'' setting should be enabled.}}
+= Configuration =
-= Setting up UBIK Credentials Portal =
 == Firewall settings ==
@@ Line 41: / Line 39: @@
 The Credentials Portal communicates with the UBIK USAM WebService.
-Open the **appsettings.json** file included in the published UBIK Credentials Portal package and configure the USAM endpoint.
+Open the '''appsettings.json''' file included in the published UBIK Credentials Portal package and configure the USAM endpoint.
 <source lang="xml">
@@ Line 95: / Line 93: @@
 </source>
-=See also=
+<!-- DO NOT REMOVE THIS -->{{Template:HowTo/End}}<!-- DO NOT REMOVE THIS -->
-<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
+== See also ==
 * [[HowTo:Configure_Microsoft_IIS_for_UBIK]]
 * [[HowTo:Install_Microsoft_IIS]]
+[[Category:Install|Configure UBIK Credentials Service]]
+[[Category:Web service|Configure UBIK Credentials Service]]
+[[Category:Installing|Configure UBIK Credentials Service]]
+[[Category:Version 5.2|Configure UBIK Credentials Service]]