Chat now with support
Chat with Support

Identity Manager 9.1.2 - API-Entwicklungshandbuch

APIs zu One Identity-API-Projekten hinzufügen

Um One Identity-HTML-Anwendungen um angepasste Funktionen zu ergänzen, können Sie eigene APIs zu One Identity-API-Projekten hinzufügen. Dazu erstellen Sie ein API-Plugin, definieren darin die API und weisen diesem API-Plugin das entsprechende One Identity-API-Projekt zu.

Um eine eigene API zu einem One Identity-API-Projekt hinzuzufügen

  1. Erstellen oder bearbeiten Sie ein API-Plugin (siehe API-Plugins erstellen oder API-Plugins bearbeiten) und nehmen Sie dabei folgende Aktionen vor:

    1. Erstellen Sie in dem API-Plugin-Projekt eine neue Klasse. Diese Klasse stellt den sogenannten API-Provider dar.

    2. Deklarieren Sie die Klasse mit dem Interface, das zu dem API-Projekt gehört, zu dem Sie Ihre API hinzufügen möchten.

      Die folgenden One Identity-API-Projekte können ergänzt werden:

      Tabelle 1: Ausgelieferte API-Projekte

      Name der HTML-Anwendung

      Name des API-Projekts Zu implementierendes Interface

      Web Portal

      portal IApiProviderFor<QER.CompositionApi.Portal.PortalApiProject>

      Web Portal für Betriebsunterstützung

      opsupport IApiProviderFor<QBM.CompositionApi.Operations.OperationsApiProject>

      Administrationsportal

      admin IApiProviderFor<QBM.CompositionApi.AdminApi.AdminApiProject>

      Kennwortrücksetzungsportal

      passwordreset IApiProviderFor<QER.CompositionApi.Password.PasswordPortalApiProject>
    3. Implementieren Sie die Methode Build des Interfaces IApiProviderFor mit der gewünschten API-Funktionalität.

      Beispiel
      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
          }

API-Projekte erstellen

Um One Identity-HTML-Anwendungen um angepasste Funktionen zu ergänzen, können Sie eigene API-Projekte erstellen. Dazu kopieren Sie das Beispiel-API-Projekt CustomApiProject (siehe Beispiele und Hilfe – Software Development Kit), passen es entsprechend an und weisen es einem API-Plugin zu.

Um ein eigenes API-Projekt zu erstellen

  1. Kopieren Sie das Beispiel-API-Projekt CustomApiProject.

  2. Passen Sie das kopierte API-Projekt entsprechend an.

  3. Erstellen Sie ein API-Plugin (siehe API-Plugins erstellen) und nehmen Sie dabei folgende Aktion vor:

    • Erstellen Sie in dem API-Plugin-Projekt eine neue Klasse, die das Interface IApiProviderFor<Name Ihres API-Projekts> implementiert. Diese Klasse stellt den sogenannten API-Provider dar.

APIs zu eigenen API-Projekte hinzufügen

Sie können weitere APIs zu eigenen API-Projekten hinzufügen.

Um eine API zu Ihrem API-Projekt hinzuzufügen

  1. Bearbeiten Sie das API-Plugin (siehe API-Plugins bearbeiten), das zu dem API-Projekt gehört, und nehmen Sie dabei folgende Aktion vor:

    • Erstellen Sie in dem API-Plugin-Projekt eine neue Klasse, die das Interface IApiProviderFor<Name Ihres API-Projekts> implementiert. Diese Klasse stellt den sogenannten API-Provider dar.

ImxClient-Kommandozeilenprogramm

Mithilfe des ImxClient-Kommandozeilenprogramms können Sie verschiedene Funktionen zum Verwalten des API Servers und von Dateien in der Kommandozeile ausführen.

Detaillierte Informationen zum Thema
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating