One Identity open source projects are supported through GitHub issues and the One Identity Community. This includes all scripts, plugins, SDKs, modules, code snippets or other solutions. For assistance with any One Identity GitHub project, please raise a new Issue using our supported templates. You may also visit the One Identity Community to ask questions. Requests for assistance made through official One Identity Support will be referred back to GitHub and the One Identity Community forums where those requests can benefit all users.
Submit an Issue · Community · Support
This repository contains the source code for the HTML5 applications contained in Identity Manager.
It is a monorepo containing the Angular workspace, which consists of apps and libraries.
We strongly recommend to read the HTML Development Guide before starting to work with the code in this repository.
By forking this repository, you may create customized versions of the projects and add them to your Identity Manager deployment.
Learn about the latest improvements.
Each Angular library and app belongs to a folder in the projects directory. The workspace is defined in the angular.json file.
| Name | Type | Dependencies inside the workspace |
|---|---|---|
qbm |
Angular library | none |
qer |
Angular library | qbm |
tsb |
Angular plugin library | qbm, qer |
att |
Angular plugin library | qbm, qer |
rmb |
Angular plugin library | qbm, qer |
rms |
Angular plugin library | qbm, qer |
rps |
Angular plugin library | qbm, qer |
sac |
Angular plugin library | qbm, qer |
aad |
Angular plugin library | qbm, qer, tsb |
apc |
Angular plugin library | qbm, qer |
aob |
Angular plugin library | qbm, qer |
uci |
Angular plugin library | qbm, qer |
cpl |
Angular plugin library | qbm, qer |
hds |
Angular plugin library | qbm, qer |
dpr |
Angular plugin library | qbm |
o3t |
Angular plugin library | qbm, qer, tsb |
olg |
Angular plugin library | qbm, qer |
pol |
Angular plugin library | qbm, qer |
Each Angular library belongs to the Identity Manager module of the same name. You do not need to build Angular libraries for modules that are not part of your Identity Manager installation.
A (non-plugin) library acts like a regular compile-time dependency. A plugin library is loaded dynamically at runtime, as determined by each plugin's imx-plugin-config.json file.
For more information about each project, see the readme.md files in each project's folder.
| Name | Description | Project type | Static dependencies |
|---|---|---|---|
qbm-app-landingpage |
API Server landing page and Server Administration | Angular app | qbm |
qer-app-portal |
Portal | Angular app | qbm, qer |
qer-app-operationssupport |
Operations Support Portal | Angular app | qbm, qer |
qer-app-pwdportal |
Password Reset Portal | Angular app | qbm, qer |
custom-app |
Template for custom applications | Angular app | qbm |
Identity Manager 9.3 is based on Angular 18.
Verify that you have installed a compatible node.js version. The version used by the CI build is defined in the .github/workflows/npm-build.yml file in the node-version property. Other versions of node.js, including newer versions, are not guaranteed to be compatible with other Angular versions. Please see the version compatibility table on the official Angular site.
Running and debugging web applications is possible using the default tools of the Angular CLI toolchain. For example, you can use ng serve qer-app-portal to debug the Portal app.
You will need an API Server instance that the web applications will connect to. You can host an API Server locally for development purposes. Run the following command on the command line:
imxclient.exe run-apiserver -B
The web apps will connect to the API Server using the URL defined in the application's environment.ts file. The default setting is http://localhost:8182 which is the default URL that a local API Server will run on.
Please refer to the HTML Development Guide for step-by-step instructions on getting started, building and deploying applications.
This repository also contains component-based documentation. There are two ways to install this documentation locally. The result will be stored in \imxweb\documentation<projectname>.
- Install the Compodoc package globally by running
npm install -g @compodoc/compodoc. - Navigate to the library to create documentation for (e.g.
imxweb\projects\qer). - Run
compodoc -p tsconfig.lib.jsonfor a library orcompodoc -p tsconfig.app.jsonfor an application.
This method only works for qbm, qer and the applications.
- Navigate to imxweb.
- run
npm run doc:<projectname>
We welcome and appreciate contributions. Here's how you can open a pull request to submit code changes.
- Fork the project
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a pull request
Distributed under the One Identity - Open Source License. See LICENSE for more information.
