Erste Schritte

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Auf dieser Seite wird beschrieben, wie Sie die erweiterte API-Sicherheit für Abo- und „Pay as you go“-Organisationen verwenden.

Erforderliche Rollen und Berechtigungen

In den folgenden Abschnitten werden die erforderlichen Rollen und Berechtigungen für Aufgaben mit der erweiterten API-Sicherheit beschrieben.

Erforderliche Rollen für Sicherheitsberichte

In der folgenden Tabelle sind die erforderlichen Rollen für Aufgaben im Zusammenhang mit Sicherheitsberichten aufgeführt.

Sicherheitsberichte – Aufgabe	Erforderliche Rollen
Erweiterte API-Sicherheit aktivieren oder deaktivieren	Apigee Organisationsadministrator (roles/apigee.admin)
Berichte erstellen	Apigee Organisationsadministrator (roles/apigee.admin) Apigee Sicherheitsadministrator (roles/apigee.securityAdmin)
Berichte ansehen	Apigee Sicherheitsbetrachter (roles/apigee.securityViewer) Apigee Sicherheitsadministrator (roles/apigee.securityAdmin)

Erforderliche Rollen für die Risikobewertung

In der folgenden Tabelle sind die erforderlichen Rollen für Aufgaben im Zusammenhang mit der Risikobewertung aufgeführt.

Risikobewertungsaufgabe	Erforderliche Rollen
Benutzerdefiniertes Sicherheitsprofil erstellen, aktualisieren oder löschen	Apigee Sicherheitsadministrator (roles/apigee.securityAdmin) Apigee Organisationsadministrator (roles/apigee.admin)
Sicherheitsprofil anhängen oder trennen	Apigee Sicherheitsadministrator (roles/apigee.securityAdmin) Apigee Organisationsadministrator (roles/apigee.admin)
Sicherheitspunktzahlen ansehen	Apigee Sicherheitsadministrator (roles/apigee.securityAdmin) Apigee Sicherheits-Viewer (roles/apigee.securityViewer) Apigee Organisationsadministrator (roles/apigee.admin)
Alle Sicherheitsprofile auflisten oder Profil abrufen	Apigee Sicherheitsadministrator (roles/apigee.securityAdmin) Apigee Sicherheits-Viewer (roles/apigee.securityViewer) Apigee Organisationsadministrator (roles/apigee.admin)
Sicherheitsmonitoringbedingung erstellen, aktualisieren oder löschen	Apigee Sicherheitsadministrator (roles/apigee.securityAdmin) Apigee Organisationsadministrator (roles/apigee.admin)
Sicherheitsmonitoringbedingungen auflisten und ansehen	Apigee Sicherheitsadministrator (roles/apigee.securityAdmin) Apigee Sicherheitsbetrachter (roles/apigee.securityViewer) Apigee Organisationsadministrator (roles/apigee.admin)
Messwerte für Sicherheitsmonitoringbedingungen auflisten und ansehen	Monitoring-Administrator (roles/monitoring.admin) Monitoring-Bearbeiter (roles/monitoring.editor)
Monitoringbenachrichtigungen erstellen, aktualisieren oder löschen	Weitere Informationen finden Sie unter Erforderliche Rollen (für Sicherheitsbenachrichtigungen).
Monitoringbenachrichtigungen ansehen	Weitere Informationen finden Sie unter Vorfälle für messwertbasierte Benachrichtigungsrichtlinien: Vorbereitung.

Erforderliche Rollen und Berechtigungen für die Missbrauchserkennung

In der folgenden Tabelle sind die erforderlichen Rollen und Berechtigungen für Aufgaben im Zusammenhang mit der Missbrauchserkennung aufgeführt.

Aufgabe zur Missbrauchserkennung	Erforderliche Rollen und Berechtigungen
Vorfälle in der Benutzeroberfläche zur Missbrauchserkennung ansehen	Apigee Sicherheitsadministrator (roles/apigee.securityAdmin) Apigee Sicherheitsbetrachter (roles/apigee.securityViewer) Apigee Organisationsadministrator (roles/apigee.admin)
Generative KI-Informationen zu Vorfällen ansehen	cloudaicompanion.instances.generateText-Berechtigung
Organisation für Modelle für maschinelles Lernen zur Missbrauchserkennung aktivieren oder deaktivieren	apigee.securitySettings.update-Berechtigung Apigee Sicherheitsadministrator (roles/apigee.securityAdmin) Apigee Organisationsadministrator (roles/apigee.admin)

Erforderliche Rollen für Sicherheitsaktionen

In der folgenden Tabelle sind die erforderlichen Rollen für Aufgaben im Zusammenhang mit Sicherheitsaktionen aufgeführt.

Sicherheitsaktion – Aufgabe	Erforderliche Rollen
Konfigurationen für Sicherheitsaktionen erstellen, bearbeiten oder löschen	Apigee Sicherheitsadministrator (roles/apigee.securityAdmin) Apigee Organisationsadministrator (roles/apigee.admin)
Sicherheitsaktionen ansehen oder auflisten	Apigee Sicherheitsadministrator (roles/apigee.securityAdmin) Apigee Sicherheitsbetrachter (roles/apigee.securityViewer) Apigee Organisationsadministrator (roles/apigee.admin)
Status der Erzwingung prüfen	Apigee Sicherheitsadministrator (roles/apigee.securityAdmin) Apigee Sicherheitsbetrachter (roles/apigee.securityViewer) Apigee Organisationsadministrator (roles/apigee.admin)

Hinweis: Für die in den folgenden Abschnitten beschriebenen API-Aufrufe benötigen Sie ein OAuth 2.0 Zugriffstoken, das mit den Aufrufen übergeben wird.

Erweiterte API-Sicherheit für Abo-Organisationen verwalten

Wenn Sie die erweiterte API-Sicherheit als Abo-Kunde verwenden möchten, muss sie in Ihren Abo-Berechtigungen enthalten sein. Weitere Informationen finden Sie unter Apigee-Berechtigungen. Wenn Sie die erweiterte API-Sicherheit zu Ihren Berechtigungen hinzufügen möchten, wenden Sie sich an Apigee Sales.

Hinweis: Apigee-Testorganisationen können für den Testzeitraum eine Testversion der erweiterten API-Sicherheit von Apigee enthalten. Weitere Informationen erhalten Sie von Apigee Apigee Sales.

Sobald die erweiterte API-Sicherheit in Ihren Berechtigungen enthalten ist, aktivieren Sie sie in Ihrer Organisation:

• Konfiguration von Apigee-Add-ons abrufen
• Erweiterte API-Sicherheit für Abo-Organisationen aktivieren

Wenn Sie sich nicht sicher sind, ob Sie ein Abo oder eine „Pay as you go“-Apigee-Organisation verwenden, wenden Sie sich an den Administrator Ihrer Apigee-Organisation.

Konfiguration von Apigee-Add-ons abrufen

Um Erweiterte API-Sicherheit für Ihre Abo-Organisation zu aktivieren, müssen Sie zuerst Ihre aktuelle Apigee-Add-on-Konfiguration mithilfe des folgenden API-Aufrufs abrufen. Außerdem erfahren Sie, ob die erweiterte API-Sicherheit bereits aktiviert ist.

curl "https://apigee.googleapis.com/v1/organizations/ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

Dabei gilt:

• ORG ist der Name Ihrer Organisation.
• $TOKEN ist die Umgebungsvariable für ein OAuth-Zugriffstoken.

Dieser Aufruf gibt grundlegende Informationen zu Ihrer Organisation zurück, einschließlich eines Abschnitts für Ihre Apigee-Add-on-Konfiguration, der mit der folgenden Zeile beginnt:

"addonsConfig": {

Prüfen Sie, ob dieser Abschnitt den folgenden Eintrag enthält:

"apiSecurityConfig": {
          "enabled": true
      }

Wenn ja, ist die erweiterte API-Sicherheit bereits in der Organisation aktiviert. Andernfalls müssen Sie sie aktivieren, wie im nächsten Schritt beschrieben.

Erweiterte API-Sicherheit für Abo-Organisationen aktivieren

Zum Aktivieren der erweiterten API-Sicherheit in einer Abo-Organisation mit der Standardkonfiguration senden Sie eine POST-Anfrage, wie unten gezeigt.

Achtung: Dieser API-Aufruf überschreibt die aktuelle Add-on-Konfiguration. Sie müssen die aktuelle Konfiguration für alle Add-ons in der unten gezeigten Anfrage einschließen, um zu verhindern, dass sie überschrieben werden.

Hinweise:

• Wenn Sie nach der Aktivierung der erweiterten API-Sicherheit eine neue Umgebung erstellen, müssen Sie den folgenden Befehl noch einmal ausführen, um die erweiterte API-Sicherheit für die neue Umgebung zu aktivieren. Beachten Sie, dass Sie die erweiterte API-Sicherheit nicht deaktivieren müssen, bevor Sie den Befehl noch einmal ausführen.
• Wenn Sie einfach eine Umgebung trennen, in der die erweiterte API-Sicherheit für eine Instanz aktiviert ist, und sie später wieder anhängen, müssen Sie den Befehl unten nicht noch einmal ausführen.

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": true
      }
      <Other entries of your current add-ons configuration>
    }
  }'

Wobei Folgendes gilt:

• ORG ist der Name Ihrer Organisation.
• $TOKEN ist die Umgebungsvariable für ein OAuth-Zugriffstoken.
• <Other entries of your current add-ons configuration> besteht aus allen anderen Einträgen Ihrer aktuellen Apigee-Add-on-Konfiguration.

Hinweis: Der obige API-Aufruf startet einen Vorgang mit langer Ausführungszeit, der einige Zeit in Anspruch nehmen kann.

Wenn die aktuelle Add-on-Konfiguration beispielsweise

"addonsConfig": {
  "integrationConfig": {
      "enabled":true
  },
  "monetizationConfig": {
      "enabled":true
  }
},

ist, wäre der Befehl zur Aktivierung der erweiterten API-Sicherheit

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": true
      },
      "integrationConfig": {
          "enabled": true
      },
      "monetizationConfig": {
          "enabled": true
      }
    }
  }'

Nachdem Sie die Anfrage gesendet haben, wird eine Antwort wie diese angezeigt:

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

Hinweis: Wenn Sie Advanced API Security in einer Organisation aktivieren, kann es bis zu einem Tag dauern, bis die Punktzahlen für vorhandene Proxys und Ziele in einer Umgebung angezeigt werden.

Erweiterte API-Sicherheit für Abo-Organisationen deaktivieren

Wenn Sie die erweiterte API-Sicherheit für Ihre Abo-Organisation deaktivieren müssen, können Sie dazu eine POST-Anfrage senden und die Add-on-Konfiguration im Anfragetext übergeben, wie unten gezeigt.

Achtung: Die Add-on-Konfiguration, die Sie im Anfragetext übergeben, überschreibt die aktuelle Add-on-Konfiguration. Rufen Sie die vorhandene Add-on-Konfiguration im Apigee-Organisationsprofil auf und achten Sie darauf, dass Sie sie in die Anfragenutzlast einfügen.

Hinweis: Der folgende API-Aufruf startet einen Vorgang mit langer Ausführungszeit, der einige Zeit in Anspruch nehmen kann.

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": false
      }
     <Include current add-ons configuration>
    }
  }'

Das folgende Beispiel enthält eine Antwort, die zeigt, dass der Vorgang läuft:

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

Weitere Informationen finden Sie unter Organization Add-ons API konfigurieren.

Erweiterte API-Sicherheit für „Pay as you go“-Organisationen verwalten

Wenn Sie „Pay as you go“-Kunde sind, können Sie Erweiterte API-Sicherheit von Apigee als kostenpflichtiges Add-on aktivieren. Weitere Informationen zum Aktivieren des Add-ons Erweiterte API-Sicherheit für Ihre Zwischenumgebungen oder umfassenden Umgebungen von Apigee finden Sie unter Add-on Erweiterte API-Sicherheits verwalten.

Wenn Sie sich nicht sicher sind, ob Sie ein Abo oder eine „Pay as you go“-Apigee Organisation verwenden, wenden Sie sich an den Administrator Ihrer Apigee-Organisation.

Erweiterte API-Sicherheit für Testorganisationen verwalten

Das Add-on „Erweiterte API-Sicherheit“ ist automatisch in Apigee Testorganisationen (Testversionen) enthalten, muss aber aktiviert werden.

Folgen Sie der Anleitung unter Erweiterte API-Sicherheit für Abo-Organisationen aktivieren, um das Add-on zu aktivieren.

Wenn Sie es deaktivieren müssen, folgen Sie der Anleitung unter Erweiterte API-Sicherheit für Abo-Organisationen deaktivieren.

Erweiterte API-Sicherheit mit Terraform konfigurieren

Apigee unterstützt die Verwendung von , um einige Funktionen der erweiterten API-Sicherheit zu verwalten.

Mit Terraform können Sie beispielsweise Folgendes konfigurieren:

• Sicherheitsprofile für die Risikobewertung 2
• Sicherheitsmonitoringbedingungen für die Risikobewertung 2
• Ausschlusslisten für die Missbrauchserkennung
• Sicherheitsaktionen

Informationen zu den derzeit unterstützten Funktionen finden Sie im Apigee Abschnitt der Terraform Registry. Ressourcennamen im Zusammenhang mit der erweiterten API-Sicherheit beginnen mit google_apigee_security.

Allgemeine Informationen zur Verwendung von Terraform mit Apigee finden Sie unter Terraform mit Apigee verwenden.

Nächste Schritte

Nachdem Sie die erweiterte API-Sicherheit aktiviert haben, finden Sie hier weitere Informationen:

• Sicherheitsberichte
• Risikobewertung
• Missbrauchserkennung
• Sicherheitsbenachrichtigungen
• Sicherheitsaktionen