Chat now with support
Chat with Support

Identity Manager 8.2.1 - API Development Guide

Basic principles of API development Examples and help – Software Development Kit API configuration Implementing your own APIs API Designer Quick start – Creating an API with the API Designer Working with the API Designer
Starting the API Designer Project types User interface Global settings Database objects Labeling changes Find and replace Multilingual captions Managing database queries Managing tabs Managing layouts Displaying the change history (command list) Bookmarks Compiling an API Managing versions (compilation branches) Testing an API Linking C# projects to the API Designer
API projects API methods ImxClient command line program

Configuring the compilation

Use the Compilation settings node in the API Designer's definition tree view to configure the settings for compiling the API.

If you want to use code from other DLLs in your API code (for example, API files from other projects), you need to create an assembly reference so that the compiler recognizes these DLLs.

To create an assembly reference

  1. Start the API Designer program.

  2. In the menu bar, click View > Navigation.

  3. Click API projects in the navigation.

  4. In the tree structure, double-click the API project to be edited.

  5. In the definition tree view, right-click the Compilation settings node.

  6. In the context menu, click Assembly reference.

    The Assembly reference node is added under this node.

  7. In the definition tree view, click Assembly reference.

  8. Click View > Node editor on the menu bar.

  9. In the node editor view, enter the name of the assembly you wish to reference into the Referenced assembly field.

  10. In the menu bar, click (Save).

Related topics

Implementing your own APIs

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

To implement your own API

  1. Create an API plugin (see Creating and editing API plugins).

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

Detailed information about this topic

Creating and editing API plugins

With the help of API plugins, you can implement and use your customized APIs.

You can also convert existing API projects that you have created with the API Designer into API plugins (see Converting API projects to API plugins).

Prerequisites:

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

  • You are use an Integrated Development Environment (IDE).

To create an API plugin

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

  2. Create a new .NET Framework 4.8 project named CCC.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. Import the DLL file into your One Identity Manager database using the Software Loader and assign it to the API Server machine role. 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 CCC.CompositionApi.Server.Plugin.dll file is present.

To edit an existing API plugin

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

  2. Open the existing .NET Framework 4.8 project.

  3. Edit the API code.

  4. Compile the DLL file in your IDE.

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

  6. Restart the API Server and ensure that the CCC.CompositionApi.Server.Plugin.dll file is present.

Converting API projects to API plugins

You can convert API projects that you have created with the API Designer to API plugins. To do this, you must import the API project's code as C# code into an API file, then delete the API project and create a new API plug-in with the code from the new API file.

To convert an API project to an API plugin

  1. Start the API Designer program.

  2. In the menu bar, click View > Navigation.

  3. In the navigation, click API projects.

  4. In the hierarchy, double-click the API project you want to convert.

  5. Click Generated code.

  6. Copy the entire code to clipboard.

  7. In the menu bar, click View > Navigation.

  8. In the navigation, click API files.

  9. Click Add > Add API file.

  10. In the new window paste the code from the clipboard.

  11. In the Identifier field, enter a name for the API file.

  12. On the toolbar, click (Save).

  13. Delete the API project (see Deleting API projects).

  14. Create the API plugin using the code from the newly created API file (see Creating and editing API plugins).

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating