Chat now with support
Chat with Support

Identity Manager 8.2 - API Designer Benutzer-und Entwicklungshandbuch

Der API Designer Grundlagen der API-Entwicklung Beispiele und Hilfe – Software Development Kit Schnellstart – Eine API erstellen Arbeiten mit dem API Designer
API Designer starten Projekttypen Benutzeroberfläche Globale Einstellungen Datenbankobjekte Änderungen kennzeichnen Suchen und Ersetzen Mehrsprachige Texte Datenbankabfragen verwalten Tabreiter verwalten Layouts verwalten Änderungshistorie anzeigen (Befehlsliste) Lesezeichen API kompilieren Versionen verwalten (Kompilierungszweige) API testen C#-Projekte mit dem API Designer verbinden
API-Projekte API-Dateien API Server ImxClient-Kommandozeilenprogramm

API-Projekte erstellen

Sie können jederzeit neue API-Projekte erstellen.

Um ein API-Projekt zu erstellen

  1. In der Menüleiste klicken Sie Ansicht > Navigation.

  2. In der Navigation klicken Sie API-Projekte.

  3. Klicken Sie (Hinzufügen) > API-Projekt hinzufügen.

  4. Im Definitionsbaumfenster klicken Sie den obersten Knoten.

  5. In der Menüleiste klicken Sie Ansicht > Knotenbearbeitung.

  6. Im Knotenbearbeitungsfenster nehmen Sie die folgenden Einstellungen vor:

    Einstellung

    Beschreibung

    Allgemeine Einstellungen

    Bezeichner

    Geben Sie einen eindeutigen Namen für den Knoten ein.

    Technisches Kürzel

    Geben Sie einen Kurznamen für das API-Projekt ein. Dieser Name wird später für die Zuordnung des Projekts verwendet.

    Control-ID

    Geben Sie eine eindeutige ID für den Knoten ein.

    Modellversion

    Zeigt Ihnen die verwendete Modellversion an.

    Ablaufkontrolle

    Erweiterungen auf diesem Dokument erlauben

    Aktivieren Sie diese Option, um das Anlegen von Erweiterungen an diesem Knoten zu erlauben.

    Erweiterte Einstellungen

    Erforderliche Datenbankmodule

    (Optional) Geben Sie die Datenbankmodule ein, die für dieses API-Projekt erforderlich sind.

  7. Legen Sie weitere Einstellungen für das API-Projekt fest (siehe Authentifizierung konfigurieren und Kompilierung konfigurieren).

  8. In der Symbolleiste klicken Sie (Speichern).

Verwandte Themen

API-Projekte bearbeiten

Sie können jederzeit Ihre bereits erstellten API-Projekte bearbeiten.

HINWEIS: Sie können keine API-Projekte bearbeiten, die vom API Designer vordefiniert wurden.

Um ein bestehendes API-Projekt zu bearbeiten

  1. In der Menüleiste klicken Sie Ansicht > Navigation.

  2. In der Navigation klicken Sie API-Projekte.

  3. In der Baumstruktur doppelklicken Sie das API-Projekt, das Sie bearbeiten möchten.

  4. In der Menüleiste klicken Sie Ansicht > Knotenbearbeitung.

  5. Im Definitionsbaumfenster und Knotenbearbeitungsfenster legen Sie weitere Einstellungen für das API-Projekt fest (siehe Authentifizierung konfigurieren und Kompilierung konfigurieren).

  6. In der Symbolleiste klicken Sie (Speichern).

Verwandte Themen

API-Projekte löschen

Sie können jederzeit Ihre bereits erstellten API-Projekte löschen.

HINWEIS: Sie können keine API-Projekte löschen, die vom API Designer vordefiniert wurden.

Um ein API-Projekt zu löschen

  1. In der Menüleiste klicken Sie Ansicht > Navigation.

  2. In der Navigation klicken Sie API-Projekte.

  3. In der Baumstruktur klicken Sie das API-Projekt, das Sie löschen möchten.

  4. Klicken Sie (Löschen).

  5. Im Dialogfenster bestätigen Sie die Abfrage mit Ja.

  6. In der Baumstruktur klicken Sie (Daten neu laden).

Verwandte Themen

Authentifizierung konfigurieren

Mithilfe des Knotens Authentifizierung im Definitionsbaumfenster legen Sie fest, wie sich Clients an der API anmelden können.

Es gibt drei Authentifizierungsoptionen, die Sie konfigurieren können:

  • Standard: Es sind nur die Authentifizierungsmethoden zugelassen, die Sie hier auflisten. Für diese Methode können Sie zudem Single Sign-on aktivieren.

  • Alle manuellen Module zulassen: Es sind alle manuellen Authentifizierungsmodule zugelassen, sofern diese für das gewählte Produkt aktiviert sind. Für diese Methode können Sie zudem Single Sign-on aktivieren.

  • Festgelegte Anmeldedaten: Diese Einstellung ermöglicht eine Anmeldung mit fest hinterlegten Anmeldedaten an der API. In diesem Fall müssen Sie Anmeldedaten in der web.config-Datei jedes API Servers hinterlegen.

Um die zulässigen manuellen Authentifizierungsmöglichkeiten selber festzulegen

  1. In der Menüleiste klicken Sie Ansicht > Navigation.

  2. In der Navigation klicken Sie API-Projekte.

  3. In der Baumstruktur doppelklicken Sie das API-Projekt, das Sie bearbeiten möchten.

  4. Im Definitionsbaumfenster klicken Sie den Knoten (Authentifizierung).

  5. In der Menüleiste klicken Sie Ansicht > Knotenbearbeitung.

  6. Im Knotenbearbeitungsfenster führen Sie die folgenden Aktionen aus:

    1. In der Auswahlliste Authentifizierungstyp wählen Sie Standard.

    2. Im Eingabefeld Control-ID geben Sie eine eindeutige ID für den Knoten ein.

    3. (Optional) Im Eingabefeld Authentifizierungseigenschaften geben Sie Eigenschaften der Authentifizierung ein. Weitere Informationen zu den Authentifizierungsmodulen erhalten Sie im One Identity Manager Konfigurationshandbuch.

    4. (Optional) Wenn Berechtigungen für Benutzer über ein Produkt gesteuert werden, aktivieren Sie die Option Produkt und wählen Sie in der Auswahlliste das entsprechende Produkt aus.

  7. Im Definitionsbaumfenster klappen Sie den Knoten (Authentifizierung) aus.

  8. Rechtsklicken Sie den Knoten (Manuelle Authentifizierungsmodule).

  9. Im Kontextmenü klicken Sie Authentifizierungsmodul.

    Der Knoten Authentifizierungsmodul wird dem Knoten untergeordnet.

  10. Klicken Sie den Knoten Authentifizierungsmodul.

  11. Im Knotenbearbeitungsfenster wählen Sie in der Auswahlliste Name das gewünschte Authentifizierungsmodul aus. Weitere Informationen zu den Authentifizierungsmodulen erhalten Sie im One Identity Manager Konfigurationshandbuch.

  12. Im Eingabefeld Control-ID geben Sie eine eindeutige ID für den Knoten ein.

  13. Wiederholen Sie die Schritte 8 bis 12, bis Sie alle gewünschten Authentifizierungsmethoden festgelegt haben.

  14. In der Menüleiste klicken Sie (Speichern).

Um alle manuellen Authentifizierungsmöglichkeiten zuzulassen

  1. In der Menüleiste klicken Sie Ansicht > Navigation.

  2. In der Navigation klicken Sie (API-Projekte).

  3. In der Baumstruktur doppelklicken Sie das API-Projekt, das Sie bearbeiten möchten.

  4. Im Definitionsbaumfenster klicken Sie den Knoten (Authentifizierung).

  5. In der Menüleiste klicken Sie Ansicht > Knotenbearbeitung.

  6. Im Knotenbearbeitungsfenster führen Sie die folgenden Aktionen aus:

    1. In der Auswahlliste Authentifizierungstyp wählen Sie Alle manuellen Module zulassen.

    2. Im Eingabefeld Control-ID geben Sie eine eindeutige ID für den Knoten ein.

    3. (Optional) Im Eingabefeld Authentifizierungseigenschaftengeben Sie Eigenschaften der Authentifizierung ein.

    4. (Optional) Aktivieren Sie die Option Produkt und wählen Sie in der Auswahlliste das Produkt aus.

  7. In der Menüleiste klicken Sie (Speichern).

Um Single Sign-on zuzulassen

  1. In der Menüleiste klicken Sie Ansicht > Navigation.

  2. In der Navigation klicken Sie (API-Projekte).

  3. In der Baumstruktur doppelklicken Sie das API-Projekt, das Sie bearbeiten möchten.

  4. Im Definitionsbaumfenster klappen Sie den Knoten (Authentifizierung) aus.

  5. Rechtsklicken Sie den Knoten (Authentifizierungsmodule für Single Sign-on).

    HINWEIS: Dieser Knoten steht Ihnen nur zur Verfügung, wenn Sie die manuellen Authentifizierungsmöglichkeiten selber festgelegt haben oder wenn Sie alle manuellen Authentifizierungsmöglichkeiten zulassen.

  6. Im Kontextmenü klicken Sie Authentifizierungsmodul.

    Der Knoten Authentifizierungsmodul wird dem Knoten untergeordnet.

  7. Klicken Sie den Knoten Authentifizierungsmodul.

  8. In der Menüleiste klicken Sie Ansicht > Knotenbearbeitung.

  9. Im Knotenbearbeitungsfenster wählen Sie in der Auswahlliste Name das gewünschte Authentifizierungsmodul aus. Weitere Informationen zu den Authentifizierungsmodulen erhalten Sie im One Identity Manager Konfigurationshandbuch.

  10. In der Menüleiste klicken Sie (Speichern).

Anmeldung mit hinterlegten Anmeldedaten

Um die Anmeldung mit hinterlegten Anmeldedaten zuzulassen, führen Sie zwei Schritte aus:

  1. Hinterlegen Sie in der Datei web.config jedes API Servers die Anmeldedaten der Benutzer, die Zugriff erhalten sollen.

  2. Konfigurieren Sie die Authentifizierung im API Designer am API-Projekt.

Um Anmeldedaten im API Server zu hinterlegen

  1. Verbinden Sie sich auf Ihren API Server.

  2. Öffnen Sie die Datei web.config in einem Texteditor.

    HINWEIS: Falls die Datei verschlüsselt ist, müssen Sie sie vor der Bearbeitung entschlüsseln.

  3. Im Abschnitt <connectionStrings> fügen Sie folgenden Eintrag hinzu:

    <add name="sub:<NAME>" connectionString="Module=DialogUser;User=<BENUTZER>;(Password)Password=<KENNWORT>" />

    • <NAME> steht für den Namen/Bezeichner des API-Projekts

    • <BENUTZER> steht für den Anmeldenamen des Benutzers

    • <KENNWORT> steht für das Kennwort des Benutzers

  4. Speichern Sie Ihre Änderungen an der Datei.

  5. (Optional) Verschlüsseln Sie die Datei.

Um die Anmeldung mit hinterlegten Anmeldedaten am API-Projekt zu konfigurieren

  1. Starten Sie den API Designer

  2. In der Menüleiste klicken Sie Ansicht > Navigation.

  3. In der Navigation klicken Sie (API-Projekte).

  4. In der Baumstruktur doppelklicken Sie das API-Projekt, das Sie bearbeiten möchten.

  5. Im Definitionsbaumfenster klicken Sie den Knoten (Authentifizierung).

  6. In der Menüleiste klicken Sie Ansicht > Knotenbearbeitung.

  7. Im Knotenbearbeitungsfenster führen Sie die folgenden Aktionen aus:

    1. In der Auswahlliste Authentifizierungstyp wählen Sie Festgelegte Anmeldedaten.

    2. Im Eingabefeld Control-ID geben Sie eine eindeutige ID für den Knoten ein.

    3. (Optional) Im Eingabefeld Authentifizierungseigenschaftengeben Sie Eigenschaften der Authentifizierung ein.

    4. (Optional) Aktivieren Sie die Option Produkt und wählen Sie in der Auswahlliste das Produkt aus.

  8. In der Menüleiste klicken Sie (Speichern).

Verwandte Themen
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating