Sicherheitsprofile-Seite im Jitterbit API Manager

Einführung

Verwenden Sie die Seite Sicherheitsprofile im API Manager, um Sicherheitsprofile zu konfigurieren und zu verwalten. Sicherheitsprofile steuern den Benutzerzugriff auf die APIs des API Managers.

Alternativ können Sie Sicherheitsprofile mit dem APIM AI Assistant erstellen und verwalten.

Um Aktionen auszuführen oder Änderungen auf der Seite Sicherheitsprofile vorzunehmen, ist eine Rolle mit Admin-Berechtigung erforderlich. Benutzer in Nicht-Admin-Rollen mit Lesen oder höherem Zugriffsrecht auf die Umgebung haben nur Lesezugriff.

Für Informationen zu Sicherheitsprofilen siehe Sicherheitsprofile in Schlüsselkonzepte.

Zugriff auf die Sicherheitsprofile-Seite

Um auf die Seite Sicherheitsprofile zuzugreifen, verwenden Sie das Harmony-Portal-Menü, um API Manager > Sicherheitsprofile auszuwählen.

Kopfzeile der Sicherheitsprofile-Seite

Die Kopfzeile oben auf der Seite Sicherheitsprofile enthält ein Suchfeld, Filter und eine Schaltfläche zum Erstellen eines neuen Sicherheitsprofils:

• Filter: Sie können Sicherheitsprofile nach einer der folgenden Optionen filtern:

  

  • Auth-Typ: Wählen Sie die Authentifizierungstypen für die Sicherheitsprofile aus. Optionen sind OAuth 2.0, API-Schlüssel, Basic oder Anonym. Wenn alle Filter nicht ausgewählt sind, werden Sicherheitsprofile mit jedem Authentifizierungstyp angezeigt.

  • Standard-Sicherheitsprofil: Wählen Sie aus, ob Standard- oder Nicht-Standardprofile angezeigt werden sollen.

  • Umgebung: Wählen Sie Umgebungen aus, in denen sich die Sicherheitsprofile befinden. Wenn alle Filter nicht ausgewählt sind, werden Sicherheitsprofile für alle Umgebungen in Ihrer Organisation angezeigt (beschränkt auf Umgebungen, auf die Sie zugreifen können).

  • Vertrauenswürdige IP-Gruppe: Wählen Sie die vertrauenswürdigen IP-Gruppen aus, die in den Sicherheitsprofilen enthalten sind.

• Suche: Geben Sie einen Teil des Namens eines Sicherheitsprofils ein, um Sicherheitsprofile nach Namen zu filtern. Die Suche ist nicht groß-/kleinschreibungsempfindlich.

• Spalten filtern: Klicken Sie, um die Anordnung und Sichtbarkeit der Spalten zu ändern. Die Spalten-Schublade öffnet sich:

  

  Die Schublade enthält diese Steuerungen:

  • Alle anzeigen: Alle Spalten sichtbar machen.
  • Verschieben: Ziehen und Ablegen, um die Spaltenposition im Verhältnis zu anderen zu ändern.
  • Ausblenden: Die Spalte ist sichtbar. Klicken Sie, um sie auszublenden.
  • Anzeigen: Die Spalte ist ausgeblendet. Klicken Sie, um sie anzuzeigen.
  • Speichern: Änderungen an den Spalten speichern.
  • Abbrechen: Schließen Sie die Spalten-Schublade, ohne Änderungen zu speichern.

• Neu: Klicken Sie, um eine der folgenden Optionen auszuwählen:

  • Mit KI erstellen: Öffnet den APIM-Assistenten, um ein Sicherheitsprofil mit natürlichen Sprachaufforderungen zu erstellen. Weitere Informationen finden Sie unter Verwendung des KI-Assistenten.

    Hinweis

    Um den APIM KI-Assistenten zu verwenden, muss Ihre Harmony-Lizenz die Option APIM KI-Assistent enthalten. Kontaktieren Sie Ihren Customer Success Manager (CSM), um diese Option zu Ihrer Lizenz hinzuzufügen.

  • Sicherheitsprofil: Öffnet die Konfigurationsschublade für Sicherheitsprofile, um manuell ein neues Sicherheitsprofil zu erstellen.

Konfigurieren eines Sicherheitsprofils

Die Konfigurationsschublade für Sicherheitsprofile ist in zusammenklappbare Abschnitte Profil, Authentifizierung, Protokollierung und Vertrauenswürdige IP-Adresse unterteilt. Konfigurieren Sie die Felder in jedem Abschnitt wie unten beschrieben und klicken Sie dann auf Speichern, um die Konfiguration zu speichern und zu schließen, oder auf Abbrechen, um sie ohne Speicherung zu schließen.

Profil

• Profilname: Geben Sie einen Namen ein, um das Sicherheitsprofil zu identifizieren. Der Name darf nicht mit einem Leerzeichen beginnen oder enden.

  Vorsicht

  Wenn Sie das Sicherheitsprofil mit OAuth 2.0 konfigurieren und Microsoft Entra ID oder Google als den OAuth 2.0-Identitätsanbieter verwenden (unten konfiguriert), darf der Profilname keine Leerzeichen enthalten. Wenn der Profilname Leerzeichen enthält, erhalten Sie einen Fehler, wenn Sie versuchen, auf eine API zuzugreifen, der das Sicherheitsprofil zugewiesen ist.

• Umgebung: Verwenden Sie das Dropdown-Menü, um eine vorhandene Umgebung auszuwählen, in der das Sicherheitsprofil zugewiesen werden kann. Sie können einen Teil des Umgebungsnamens in das Menü eingeben, um die Liste der Umgebungen zu filtern. Die Menüergebnisse werden in Echtzeit mit jedem Tastendruck gefiltert. Um mehr über die Beziehung von Umgebungen zu Sicherheitsprofilen zu erfahren, siehe Mehrere Sicherheitsprofile in Schlüsselkonzepte.

• Standard: Wählen Sie diese Option aus, um dieses Sicherheitsprofil zum Standard für die ausgewählte Umgebung zu machen. Das Standard-Sicherheitsprofil wird vorab ausgewählt, wenn eine neue API erstellt wird. In jeder Umgebung kann nur ein Standard-Sicherheitsprofil ausgewählt werden. Nachdem ein Standard-Sicherheitsprofil für eine Umgebung festgelegt wurde, ersetzt die Auswahl eines anderen Sicherheitsprofils als Standard die bestehende Auswahl des Standard-Sicherheitsprofils. Die Auswahl oder Änderung des Standard-Sicherheitsprofils hat keinen Einfluss auf das Sicherheitsprofil, das bestehenden APIs zugewiesen ist.

• Beschreibung: Geben Sie eine optionale Beschreibung des Sicherheitsprofils ein.

• Ratenlimits und Treffer pro Minute: Aktivieren Sie Ratenlimits, um eine gemeinsame maximale Anzahl von API-Treffern pro Minute durchzusetzen, die über alle APIs, denen dieses Sicherheitsprofil zugewiesen ist, gemacht werden können. Wenn diese Option ausgewählt ist, müssen Sie eine maximale Anzahl von Treffern pro Minute eingeben.

  Wenn aktiviert, werden Anrufe über dem festgelegten Maximum abgelehnt. Daher können Anrufe an APIs, die dieses Sicherheitsprofil zugewiesen haben, eine erhöhte Anzahl von Ablehnungen erfahren. Weitere Informationen finden Sie unter Ratenlimits in Schlüsselkonzepte.

Authentifizierung

Verwenden Sie das Menü Auth-Typ, um einen Authentifizierungstyp für das Sicherheitsprofil auszuwählen. Nachdem Sie den Typ ausgewählt haben, werden zusätzliche Felder verfügbar, die konfiguriert werden können. Dieser Abschnitt beschreibt die Felder für jeden Typ:

• Anonym
• API-Schlüssel
• Basic
• OAuth 2.0

Anonym

Wählen Sie den Authentifizierungstyp Anonym, wenn keine Authentifizierung erforderlich ist.

API-Schlüssel

Wählen Sie den Authentifizierungstyp API-Schlüssel, um ein API-Schlüssel-Wert-Paar zu verwenden, um auf eine API zuzugreifen, die diesem Sicherheitsprofil zugewiesen ist. Wenn dieser Typ ausgewählt ist, werden diese Felder verwendet, um die erforderlichen Anmeldeinformationen zu erstellen:

• Schlüssel: Geben Sie den Headernamen ein, den Sie verwenden möchten, z. B. Authorization oder X-API-KEY. Es sind maximal 256 Zeichen erlaubt.
• Wert: Ein Wert wird automatisch für die Verwendung mit dem Schlüssel-Headernamen generiert. Sie können den Wert bearbeiten oder das -Aktualisierungssymbol verwenden, um einen neuen Wert zu generieren. Es sind maximal 256 Zeichen erlaubt.
• Kopieren: Kopiert den Wert in Ihre Zwischenablage.

Basic

Wählen Sie den Authentifizierungstyp Basic, um die grundlegende HTTP-Authentifizierung zu verwenden, um auf eine API zuzugreifen, die diesem Sicherheitsprofil zugewiesen ist. Wenn dieser Typ ausgewählt ist, werden diese Felder verwendet, um die erforderlichen Anmeldeinformationen zu erstellen:

• Benutzername: Geben Sie einen Benutzernamen ein, um auf die API zuzugreifen. Der Benutzername ist groß- und kleinschreibungsempfindlich und sollte keinen Doppelpunkt (:) enthalten, wenn Sie die Anmeldeinformationen in einem HTTP-Header verwenden möchten, wenn Sie die API aufrufen.

• Passwort: Geben Sie ein Passwort ein, um auf die API zuzugreifen.

Base64Encode("exampleuser"+":"+"examplepassword")

OAuth 2.0

Wählen Sie den Authentifizierungstyp OAuth 2.0, um ein OAuth 2.0-Autorisierungstoken zu verwenden, um auf eine API zuzugreifen, die dieses Sicherheitsprofil zugewiesen hat. OAuth 2.0 ist ein offener Standard für Zugriffsdelegation. Wenn dieser Typ ausgewählt ist, werden diese Felder verwendet, um die erforderlichen Anmeldeinformationen zu erstellen:

• OAuth-Anbieter: Verwenden Sie das Dropdown-Menü, um einen unterstützten Identitätsanbieter auszuwählen. Wählen Sie einen von Azure AD (Microsoft Entra ID), Google, Okta oder Salesforce.

• 2-beiniger OAuth-Fluss: Standardmäßig wird für alle Identitätsanbieter 3-beiniger OAuth verwendet. Dieser Prozess erfordert eine manuelle Interaktion zur Authentifizierung, wenn auf eine API zugegriffen wird, die dieses Sicherheitsprofil zugewiesen hat. Die Option 2-beiniger OAuth-Fluss ist nur für Microsoft Entra ID (Microsoft Entra ID) und Okta verfügbar. Diese Option ermöglicht es Ihnen, einen Scope und ein Audience zu konfigurieren, um den manuellen Schritt zu entfernen.

  Hinweis

  Wenn Sie ein privates API-Gateway verwenden, müssen Sie die Gateway-Version 10.48 oder höher verwenden, damit diese Option funktioniert. Wenn das Gateway nicht Version 10.48 oder höher ist, wird 3-beiniger OAuth verwendet, selbst wenn 2-beiniger OAuth konfiguriert ist. Wenn Sie kein privates API-Gateway verwenden, hat diese Option keine Versionsanforderungen.

• Autorisierte Domains: Geben Sie Domainnamen durch Kommas getrennt ein, um den Zugriff auf die erlaubten Domains zu beschränken. Lassen Sie das Feld leer für uneingeschränkten Zugriff.

• Client-Anmeldeinformationen: Fügen Sie Paare von Client-Anmeldeinformationen (eine Client-ID und ein Client-Geheimnis) für das Sicherheitsprofil hinzu, damit Verbraucher sich beim API authentifizieren können. Wenn 2-beiniger OAuth-Flow aktiviert ist, können Sie mehrere Client-Anmeldeinformationen hinzufügen, sodass verschiedene Verbraucher sich mit einzigartigen Anmeldeinformationen beim selben API authentifizieren können. Wenn 2-beiniger OAuth-Flow deaktiviert ist (3-beinig), können Sie eine einzelne Client-Anmeldeinformation hinzufügen. Die folgenden Steuerungen sind verfügbar:

  • Suche: Geben Sie einen Teil des Verbrauchernamens ein, um die Liste der Client-Anmeldeinformationen zu filtern.

  • Client-Anmeldeinformation hinzufügen: Klicken Sie, um eine bearbeitbare Zeile zur Tabelle hinzuzufügen. Füllen Sie diese Felder aus (alle sind erforderlich), und klicken Sie dann auf das Häkchen in der Spalte Aktionen, um die Anmeldeinformation zu speichern, oder auf das Schließen-Symbol, um sie zu verwerfen:

    • Verbrauchername: Geben Sie einen Namen ein, um den Verbraucher zu identifizieren, der dieses Anmeldeinformationspaar verwendet.

    • Client-ID: Geben Sie die Client-ID ein, die Sie vom Identitätsanbieter erhalten haben.

    • Client-Geheimnis: Geben Sie das Client-Geheimnis ein, das Sie vom Identitätsanbieter erhalten haben. Verwenden Sie das Anzeigen-Symbol, um den Wert anzuzeigen.

    • Status: Setzen Sie die Anmeldeinformation auf Aktiv oder Inaktiv. Nur Aktive Anmeldeinformationen können zur Authentifizierung mit der API verwendet werden.

  Jede gespeicherte Client-Anmeldeinformation erscheint als Zeile in der Tabelle und zeigt ihren Verbrauchernamen, Client-ID, Client-Geheimnis und Status an. Fahren Sie mit der Maus über eine Zeile, um diese Aktionen in der Spalte Aktionen anzuzeigen:

  • Bearbeiten: Klicken Sie, um die Client-Anmeldeinformation in einer bearbeitbaren Zeile zu bearbeiten.

  • Löschen: Klicken Sie, um die Client-Anmeldeinformation zu löschen.

  Konsultieren Sie die Anweisungen zum Abrufen der Client-ID und des Client-Geheimnisses für Microsoft Entra ID, Google, Okta oder Salesforce.

• Die verbleibenden OAuth 2.0-Felder (OAuth-Umleitungs-URL, OAuth-Bereich, OpenID-Discovery-URL, Zielgruppe, OAuth-Autorisierungs-URL, OAuth-Token-URL, Benutzerinformations-URL und Fügen Sie diese Umleitungs-URL zu Ihrem OAuth-Konto hinzu) sind mit Standardwerten vorausgefüllt und enthalten spezifische Einstellungen für Ihren Identitätsanbieter. Einige dieser Felder erscheinen nur, wenn 2-beiniger OAuth-Flow aktiviert ist. Konfigurieren Sie sie gemäß den Anweisungen für Ihren Identitätsanbieter: Microsoft Entra ID (2-beinig, 3-beinig), Google, Okta (2-beinig, 3-beinig), oder Salesforce.

• Testverbindung: Klicken Sie, um die Verbindung mit dem Identitätsanbieter anhand der bereitgestellten Konfiguration zu überprüfen. Das resultierende Verhalten hängt davon ab, ob die Option 2-beiniger OAuth-Flow verwendet wird:

  • 2-beiniger OAuth: Für Microsoft Entra ID und Okta, wenn 2-beiniger OAuth-Flow verwendet wird, erhält das API-Gateway das Zugriffstoken und die Authentifizierung erfolgt automatisch. Sie werden dann mit einer Nachricht, die die Ergebnisse des Tests anzeigt, zum API-Manager umgeleitet.

  • 3-beiniger OAuth: Für Google und Salesforce sowie für Microsoft Entra ID und Okta, wenn 2-beiniger OAuth-Flow nicht verwendet wird, wird in einem neuen Browser-Tab die native Anmeldeschnittstelle für den Identitätsanbieter angezeigt. Nachdem Sie Ihre Anmeldeinformationen für den Identitätsanbieter eingegeben haben, werden Sie mit einer Nachricht, die die Ergebnisse des Tests anzeigt, zum API-Manager umgeleitet.

Protokollierung

Wählen Sie den Identifikator aus, der in den API-Anforderungsheadern enthalten sein soll, um nachzuvollziehen, welche Authentifizierungsmethode verwendet wurde, um auf dieses Sicherheitsprofil zuzugreifen. Dieser Wert erscheint im Feld Benutzer gesetzt auf in den API-Protokollen für jede API-Anfrage, sodass Sie verschiedene Zugriffsarten überwachen und prüfen können.

Das Label des ersten Optionsfeldes entspricht dem Authentifizierungstyp Typ, der für das Sicherheitsprofil konfiguriert ist:

• Anonym: Sendet den Wert Anonym.

• Basic: Sendet den Wert des Feldes Benutzername (wie in Basic-Authentifizierung definiert).

• OAuth: Sendet den Wert OAuth2.0.

• API-Schlüssel: Sendet den Wert APIKEY.

Wenn Benutzerdefiniert für Protokollierung ausgewählt ist, wird dieses Feld verfügbar:

• Anforderungsheaderfeld: Sendet den Wert, der im Textfeld eingegeben wurde, zum Beispiel X-API-Key.

Vertrauenswürdige IP-Adresse

Sie können auswählen, ob der Zugriff auf die APIs innerhalb des Sicherheitsprofils auf Verbraucher von einer einzelnen IP-Adresse oder einem Bereich von IP-Adressen beschränkt werden soll:

• Vertraue nur Anfragen von den folgenden IP-Bereichen: Aktivieren, um den Zugriff auf die APIs innerhalb eines Sicherheitsprofils auf Verbraucher von bestimmten IP-Adressen zu beschränken. Nur IP-Adressen, die innerhalb der angegebenen Bereiche enthalten sind, können auf die APIs mit diesem Sicherheitsprofil zugreifen. Wenn aktiviert, erscheint eine Tabelle der vorhandenen vertrauenswürdigen IP-Gruppen:

  

  • Suchen: Geben Sie den Namen einer vorhandenen vertrauenswürdigen IP-Gruppe ein. Wenn Sie das Suchfeld anklicken, wird eine Liste der vorhandenen vertrauenswürdigen IP-Gruppen angezeigt. Die Liste wird in Echtzeit mit jedem Tastendruck im Suchfeld gefiltert. Klicken Sie auf den Namen der vertrauenswürdigen IP-Gruppe, um sie dem Sicherheitsprofil hinzuzufügen.

  • Zuweisen: Aktivieren, um die vertrauenswürdige IP-Gruppe dem Sicherheitsprofil zuzuweisen.

  • Name: Der Name der vertrauenswürdigen IP-Gruppe.

  • Verwendet in: Die Namen der Sicherheitsprofile, in denen die vertrauenswürdige IP-Gruppe derzeit verwendet wird.

• Aktionen: Fahren Sie mit der Maus über eine Zeile der vertrauenswürdigen IP-Gruppe, um eine zusätzliche Aktion anzuzeigen:

  • Bearbeiten: Klicken Sie, um die IP-Bereiche für die Zeile der vertrauenswürdigen IP-Gruppe zu bearbeiten.

• Neue vertrauenswürdige IP-Gruppe: Klicken Sie, um eine neue vertrauenswürdige IP-Gruppe hinzuzufügen. Wenn Sie darauf klicken, wird dieser Konfigurationsbildschirm angezeigt:

  

  • Name: Geben Sie einen Namen ein, um die vertrauenswürdige IP-Gruppe zu identifizieren. Für vorhandene vertrauenswürdige IP-Gruppen klicken Sie auf den Namen einer vertrauenswürdigen IP-Gruppe, um ihn umzubenennen.

  • Neuer Bereich: Klicken Sie, um einen Bereich von IP-Adressen hinzuzufügen.

  • Start-IP-Adresse: Geben Sie die erste IP-Adresse ein, die im Bereich enthalten sein soll. Nur IP-Adressen, die im IPv4-Format eingegeben werden, werden unterstützt.

  • End-IP-Adresse: Geben Sie die letzte IP-Adresse ein, die im Bereich enthalten sein soll. Nur IP-Adressen, die im IPv4-Format eingegeben werden, werden unterstützt.

  • Beschreibung: Geben Sie eine Beschreibung des IP-Adressbereichs ein (optional).

  • Aktionen: Fahren Sie mit der Maus über einen IP-Adressbereich, um eine zusätzliche Aktion anzuzeigen:

    • Löschen: Löscht die Zeile des IP-Adressbereichs aus dem Sicherheitsprofil.

  • Abbrechen: Klicken Sie, um die vertrauenswürdige IP-Gruppe zu verwerfen und zur Konfiguration des Sicherheitsprofils zurückzukehren.

  • Speichern: Klicken Sie, um die vertrauenswürdige IP-Gruppe zu speichern. Nachdem das Sicherheitsprofil gespeichert wurde, steht diese vertrauenswürdige IP-Gruppe bei Bedarf für die Verwendung in anderen Sicherheitsprofilen zur Verfügung.

Vorhandene Sicherheitsprofile anzeigen

Die Sicherheitsprofile-Seite zeigt alle vorhandenen Sicherheitsprofile in der ausgewählten Harmony-Organisation, gruppiert nach Umgebung. Jede Spalte der Tabelle wird unten beschrieben:

• Profilname: Der Name des Sicherheitsprofils. Um die Sortierreihenfolge jeder Tabelle zwischen absteigender und aufsteigender alphabetischer Reihenfolge umzuschalten, klicken Sie auf den nach oben oder nach unten zeigenden Pfeil.

• Auth Type: Der Authentifizierungstyp, der verwendet wird, um sich bei den APIs, die diesem Sicherheitsprofil zugewiesen sind, zu authentifizieren und darauf zuzugreifen.

• Description: Eine Beschreibung des Sicherheitsprofils, falls vorhanden.

• APIs using: Die APIs, denen das Sicherheitsprofil zugewiesen ist.

• Hits per minute: Die maximale Anzahl von API-Anfragen, die pro Minute mit diesem Profil erlaubt sind, falls konfiguriert.

• Environment: Die Umgebung, in der das Sicherheitsprofil gilt.

• Environment class: Die Klasse der Umgebung. Diese Information wird nur für Berichtszwecke verwendet.

• Default: Der Name des Standardumfelds des Sicherheitsprofils, falls konfiguriert.

• Created: Das Datum und die lokale Browserzeit, wann das Sicherheitsprofil erstellt wurde.

• Created by: Die E-Mail-Adresse des Benutzers, der das Sicherheitsprofil erstellt hat.

• Last edited: Das Datum und die lokale Browserzeit, wann das Sicherheitsprofil zuletzt bearbeitet wurde.

• Edited by: Die E-Mail-Adresse des Benutzers, der das Sicherheitsprofil zuletzt bearbeitet hat.

• Trusted IP groups: Alle vertrauenswürdigen IP-Gruppen, die dem Sicherheitsprofil zugewiesen sind. Weitere Informationen finden Sie unter Vertrauenswürdige IP-Adressen.

• Actions: Fahren Sie mit der Maus über ein Sicherheitsprofil, um diese Aktionssymbole anzuzeigen:

  • Edit: Klicken Sie, um den Konfigurationsbildschirm des Sicherheitsprofils zu öffnen.

  • Delete: Klicken Sie, um das Sicherheitsprofil dauerhaft zu löschen. Eine Nachricht fordert Sie auf, die Löschung zu bestätigen. Wenn das Sicherheitsprofil einer API zugewiesen ist, müssen Sie es zuerst abmelden oder ersetzen, bevor Sie es löschen.

    Wichtig

    Nachdem Sie ein Sicherheitsprofil von einer API abgemeldet haben, müssen Sie die API speichern und veröffentlichen, damit die Änderung wirksam wird. Bis die API veröffentlicht ist, wird das Sicherheitsprofil weiterhin als "in Verwendung" betrachtet und kann nicht gelöscht werden, bis alle APIs, die es zuvor verwendet haben, mit der aktualisierten Konfiguration veröffentlicht wurden. Dies gilt auch, wenn sich die API im Entwurfsstatus mit dem abgemeldeten Profil befindet.

  • OAuth-Anzeiged URL: Wenn ein 2-beiniges OAuth-Sicherheitsprofil konfiguriert ist, klicken Sie, um die URL zu kopieren, die benötigt wird, um ein OAuth-Token zu generieren. Für Anweisungen siehe 2-beiniges Microsoft Entra ID oder 2-beiniges Okta.

Nächste Schritte

Für weitere Informationen zur Zuordnung von Sicherheitsprofilen zu einer API siehe diese Ressourcen:

• API-Sicherheitsprofile-Registerkarte
• Benutzerdefinierte APIs
• OData-APIs
• Proxy-APIs