In this section, you will discover how to set up your working environment for using the GitHub repository of default HTML applications. This will allow you to develop your own web applications.
Prerequisites:
To set up your working environment
-
Request access to the GitHub repository.
-
Create a branch of the corresponding branch of the GitHub repository (see https://docs.github.com/en/ge t-started/quickstart/fork-a-repo).
-
Install npm (see https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
-
Run the following command in a command line program:
npm install -g @angular/cli@<Versionsnummer>
The Typescript API client is used to access the API.
For each One Identity Manager module that provides API services, an imx-api-<module name>.tgz Angular library exists as an NPM package in the imx-modules folder of the repository.
NOTE: The API client libraries are not dependent on Angular and thus can be used from any JavaScript program.
The TypeScript API clients consist of several parts:
-
Endpoint-based methods:
The V2Client class of the API client contains one method for each API endpoint. The method name is generated with the following format:
<URL path of the API endpoint>_<HTTP method>
Example
The GET portal/serviceitems method becomes the portal_serviceitems_get typescript method.
-
Entity-based methods:
The TypedClient class of the API client contains a wrapper class for each entity-based API method that allows entities to be loaded and stored.
Example of methods for interactive entities
For the portal/serviceitems/interactive method there is the TypedClient.PortalServiceItemsInteractive property of the PortalServiceItemsInteractive wrapper class type.
Depending on the scope of operations supported by an API method, the following methods are available for the wrapper class:
-
The createEntity method is used to create a new entity.
-
The Get_byid method is used to load an interactive entity from the API Server. The API Server only supports loading a single object per query from the database as an interactive entity. The primary key values of the object must be specified as method parameters.
-
The Put and Post methods are used to store entities with the PUT operation. These methods must not be called directly, but are controlled by the commit() method of the IEntity interface.
Encapsulation as a service
Access to the API is encapsulated in a separate Angular service for each Angular library. This Angular service can be imported into custom classes:
-
In the qbm Angular library, the service is called imx_SessionService.
-
In the qer Angular library, the service is called QerApiService.
-
In all other Angular libraries, the service is called ApiService.
To create and edit your own HTML applications, you can modify Angular libraries and add plug-ins to the API Server.
Detailed information about this topic
As soon as One Identity releases product updates for One Identity Manager, you can apply relevant changes to your customized HTML applications.
NOTE: You customized HTML applications are not automatically updated. You are responsible for compiling and deploying up-to-date versions of an HTML application.
To apply changes from a One Identity Manager update to your HTML applications
-
Take the code changes from the GitHub repository of default HTML applications and apply them to your HTML application (see https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/merging-an-upstream-repository-into-your-fork).
-
Compile your HTML application (see Compiling and deploying Angular projects) and fix any compilation errors that may occur.
-
Check the One Identity Manager release notes for changes to the default API or data formats, and verify that your HTML applications still work properly.
-
Deploy the new version of your HTML application (see Compiling and deploying Angular projects).
