Identity Manager 9.2.1 - API Development Guide

You can add your own APIs to One Identity API projects to add customized functionality to One Identity HTML applications. To do this, create an API plug-in, define the API in it and assign the corresponding One Identity API project to the API plug-in.

To add an API to a One Identity API project

1. Create or edit an API plug-in (see Creating API plug-ins or Editing API plug-ins) and proceed as follows:
   

   1. Create a new class in the API plug-in project. This class represents the so-called API provider.

   2. Declare the class with the interface that belongs to the API project you want to add your API to.

      The following One Identity API projects can be added:

      Table 1: Supplied API project

      HTML application name	API project name	Interface to implement
      Web Portal	portal	IApiProviderFor<QER.CompositionApi.Portal.PortalApiProject>
      Operations Support Web Portal	opsupport	IApiProviderFor<QBM.CompositionApi.Operations.OperationsApiProject>
      Administration portal	admin	IApiProviderFor<QBM.CompositionApi.AdminApi.AdminApiProject>
      Password Reset Portal	passwordreset	IApiProviderFor<QER.CompositionApi.Password.PasswordPortalApiProject>

   3. Implement the Build method of the IApiProviderFor interface with the desired API functionality.

      Example

      1	public class ExampleApi : IApiProviderFor<QER.CompositionApi.Portal.PortalApiProject>
      2
      3	{
      4	public void Build(IApiBuilder builder)
      5	{
      6	builder.AddMethod(Method.Define("example")
      7	.AllowUnauthenticated()
      8	.HandleGet(qr => new DataObject { Message = "Hello world!" }));
      9	}
      10	}