Identity Manager 9.3 - API Development Guide

To make it easier for you to start developing your API, One Identity provides a Software Development Kit (SDK) with lots of commented code examples.

You will find the SDK in the GitHub Repository.

To implement your own APIs, you can create API plugins.

The API Server loads all DLLs matching the *.CompositionApi.Server.PlugIn.dll naming scheme and deploys the API definitions contained in them.

To implement your own APIs, the following options are available:

• You can add an API to a One Identity API project (see Adding APIs to One Identity API projects).

• You can create your own API project (Creating API projects).

• You can add an API to your own existing API projects (see Adding APIs to your own API projects).

Detailed information about this topic

With the help of API plugins, 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

To implement your own customized APIs and API projects, you can create API plugins.

To create an API plugin

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

2. Create a new .NET 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. In the API code, add the following attribute in front of the namespace declaration:

   [assembly: QBM.CompositionApi.PlugIns.Module("CCC")]

6. Compile the DLL file in your IDE.

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

8. 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.

9. 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.

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