Chat now with support
Chat mit Support

Identity Manager 9.3 - API-Entwicklungshandbuch

Über dieses Handbuch Grundlagen der API-Entwicklung Beispiele und Hilfe – Software Development Kit Eigene APIs implementieren ImxClient-Kommandozeilenprogramm

API-Plugins bearbeiten

Sie können bestehende API-Plugins bearbeiten.

Um ein bestehendes API-Plugin zu bearbeiten

  1. Starten Sie Ihre IDE (beispielsweise Visual Studio).

  2. Öffnen Sie ein bestehendes .NET 8-Projekt.

  3. Bearbeiten Sie den API-Code.

  4. Kompilieren Sie die DLL-Datei in Ihrer IDE.

  5. Kopieren Sie die DLL-Datei in das One Identity Manager-Installationsverzeichnis.

  6. Importieren Sie die DLL-Datei mithilfe des Software Loaders in Ihre One Identity Manager-Datenbank. Weitere Informationen zum Importieren von Dateien mit dem Software Loader finden Sie im One Identity Manager Administrationshandbuch für betriebsunterstützende Aufgaben.

  7. Starten Sie den API Server neu und stellen Sie sicher, dass die Datei <Name des Projekts>.CompositionApi.Server.Plugin im Ordner bin des API Server-Installationsverzeichnisses vorhanden ist.

  8. Kompilieren Sie den entsprechenden TypeScript API-Client (siehe TypeScript API-Clients kompilieren).

TypeScript API-Clients kompilieren

Nachdem Sie ein API-Plugin erstellt haben, müssen Sie einen entsprechenden TypeScript API-Client kompilieren.

Um einen TypeScript API-Client zu kompilieren

  1. Öffnen Sie ein Kommandozeilenprogramm (zum Beispiel Windows Powershell).

  2. Im Kommandozeilenprogramm wechseln Sie in das Installationsverzeichnis von One Identity Manager.

  3. Führen Sie das ImxClient-Kommando start-update aus (siehe start-update).

    Beispiel 

    imxclient start-update

  4. Führen Sie das ImxClient-Kommando compile-api aus (siehe compile-api).

    Beispiel 

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

    Das Dialogfenster zum Auswählen der Datenbankverbindung öffnet sich.

  5. Im Dialogfenster nehmen Sie eine der folgenden Aktionen vor:

    • Um eine bestehende Verbindung zur One Identity Manager-Datenbank zu verwenden, wählen Sie aus der Auswahlliste Datenbankverbindung auswählen die entsprechende Verbindung aus.

      - ODER -

    • Um eine neue Verbindung zur One Identity Manager-Datenbank zu verwenden, klicken Sie Neue Verbindung erstellen und geben Sie eine neue Verbindung an.

  6. Unter Authentifizierungsverfahren geben Sie das Verfahren und die Anmeldedaten an, mit denen Sie sich an der Datenbank anmelden möchten.

  7. Klicken Sie Anmelden.

  8. Importieren Sie das npm-Paket imx-api-ccc in Ihre TypeScript-Anwendung.

    TIPP: (Optional) Falls Sie einen anderen Paketnamen als imx-api-ccc verwenden möchten, erweitern Sie die Datei remove-local-packages.js und fügen Sie eine Zeile für das Paket in die Liste ein. Dies sorgt dafür, dass Ihr Paket nicht in das Package Locking aufgenommen wird und immer aus der lokalen Quelle aktualisiert wird.

  9. Kopieren Sie die Datei imx-api-ccc.tgz in den Unterordner bin\imx-modules Ihrer IIS-Installation.

  10. Importieren Sie die TGZ-Datei mithilfe des Software Loaders in Ihre One Identity Manager-Datenbank und weisen Sie sie der Maschinenrolle Business API Server zu. Weitere Informationen zum Importieren von Dateien mit dem Software Loader finden Sie im One Identity Manager Administrationshandbuch für betriebsunterstützende Aufgaben.

  11. Starten Sie den API Server neu und stellen Sie sicher, dass die Datei imx-api-ccc.tgz im Ordner bin\imx-modules Ihrer IIS-Installation vorhanden ist.

Verwandte Themen

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.

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen