Chat now with support
Chat with Support

Identity Manager 9.2.1 - API Development Guide

Managing API plug-ins

With the help of API plug-ins, you can implement and use your own customized APIs and API projects.

Prerequisites:

  • You use a version management system (for example, Git).

  • You use an Integrated Development Environment (IDE).

Detailed information about this topic

Creating API plug-ins

To implement your own customized APIs and API projects, you can create API plug-ins.

To create an API plug-in

  1. Start your IDE (such as Visual Studio).

  2. Create a new .NET Framework 4.8 project with a name that complies with the format: <project name>.CompositionApi.Server.Plugin.

  3. Add references to the following DLL files from the One Identity Manager installation directory:

    • QBM.CompositionApi.Server.dll

    • VI.Base.dll

    • VI.DB.dll

  4. Create the API code.

  5. Compile the DLL file in your IDE.

  6. Copy the DLL file to the One Identity Manager install directory.

  7. Import the DLL file into your Software Loader database using the One Identity Manager and assign it to the Business API Server and Development and Testing machine roles. For more information on importing files using the Software Loader, see the One Identity Manager Operational Guide.

  8. Restart the API Server and ensure that the <project name>.CompositionApi.Server.Plugin file exists in the bin folder of the API Server install directory.

  9. Compile the appropriate TypeScript API client (see Compiling TypeScript API clients).

Editing API plug-ins

You can edit existing API plug-ins.

To edit an existing API plug-in

  1. Start your IDE (such as Visual Studio).

  2. Open an existing .NET Framework 4.8 project.

  3. Edit the API code.

  4. Compile the DLL file in your IDE.

  5. Copy the DLL file to the One Identity Manager install directory.

  6. Import the DLL file into your One Identity Manager database using the Software Loader. For more information on importing files using the Software Loader, see the One Identity Manager Operational Guide.

  7. Restart the API Server and ensure that the <project name>.CompositionApi.Server.Plugin file exists in the bin folder of the API Server install directory.

  8. Compile the appropriate TypeScript API client (see Compiling TypeScript API clients).

Compiling TypeScript API clients

After you create an API plug-in, you need to compile a corresponding TypeScript API client.

To compile a TypeScript API client

  1. Open a command line interface (for example, Windows Powershell).

  2. In the command line program, go to the One Identity Manager installation directory.

  3. Run the ImxClient's start-update command (see start-update).

    Example 

    imxclient start-update

  4. Run the ImxClient's compile-api command (see compile-api).

    Example 

    imxclient compile-api /copyapi imx-api-ccc.tgz /packagename imx-api-ccc

    The dialog to select the database connection is opened.

  5. In the dialog, perform one of the following actions:

    • to use an existing connection to the One Identity Manager database, select it in the Select a database connection menu.

      - OR -

    • to create a new connection to the One Identity Manager database, click Add new connection and enter a new connection.

  6. Select the authentication method and, under Authentication method, enter the login data for the database.

  7. Click Log in.

  8. Import the imx-api-ccc npm package into your TypeScript application.

    TIP: (Optional) If you want to use another name for the imx-api-ccc packet, extend the remove-local-packages.js by adding a line for the packet in the list. This ensures that your package is not included in package locking and is always updated from the local source.

  9. Copy the imx-api-ccc.tgz to the bin\imx-modules subfolder of your IIS installation.

  10. Import the TGZ file into your One Identity Manager database using the Software Loader and assign it to the Business API Server machine role. For more information on importing files using the Software Loader, see the One Identity Manager Operational Guide.

  11. Restart the API Server and ensure that the imx-api-ccc.tgz file is in the bin\imx-modules folder of your IIS installation.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating