Jump to: navigation, search

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

(Created page with "= 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...")
 
m
 
(13 intermediate revisions by 2 users not shown)
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 self-service interface for users to set their initial password and securely reset forgotten passwords. The portal communicates with the UBIK USAM Web Service 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.
  
−
= Overview =
+
<!-- DO NOT REMOVE THIS -->{{Template:HowTo/Begin}}<!-- DO NOT REMOVE THIS -->
  
−
= Installation UBIK Credentials Portal =
+
= Prerequisites =
 +
 
 +
* Make sure the [[HowTo:Install_UBIK_Web_Service#UBIK.C2.AE_Authentication_Web_Service_USAM.svc|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 [[Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI#IIS_Manager|IIS Manager]]
  
 
== IIS Manager ==
 
== IIS Manager ==
  
−
= Setting up UBIK Credentials Portal =
+
* 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: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 =
  
 
== Firewall settings ==
 
== 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 ==
 
== 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.
 +
 +
<source lang="xml">
 +
"UsamService": {
 +
    "BaseUrl": "https://hostname:port/PathToUsam/USAM.svc/"
 +
}
 +
</source>
  
 
== Password Policy ==
 
== 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:'''
 +
 +
<source lang="xml">
 +
"PasswordStrength": {
 +
    "MinLength": 8,
 +
    "RequireUpperCase": true,
 +
    "RequireLowerCase": true,
 +
    "RequireDigit": true,
 +
    "RequireSpecialCharacter": true
 +
}
 +
</source>
  
 
== Portal Appearance ==
 
== 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:'''
 +
 +
<source lang="xml">
 +
"PortalAppearance": {
 +
    "PortalTitle": "Your preferred text here",
 +
    "BrandColor": "#F16FFF",
 +
    "BrandFontColor": "#FFFFFF",
 +
    "IconUrl": "https://yourdomain.com/icon.png"
 +
}
 +
</source>
 +
 +
<!-- DO NOT REMOVE THIS -->{{Template:HowTo/End}}<!-- DO NOT REMOVE THIS -->
 +
== 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]]

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

  • 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.
    Credentials IIS.png
IC Hint square.pngWhen 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"
}


See also

Retrieved from "https://wiki.augmensys.com/index.php?title=HowTo:Configure_UBIK_Credentials_Service&oldid=30423"