Ereignisbenachrichtigungen für Secrets Manager aktivieren

Als Administrator von IBM Cloud® Secrets Managerkönnen Sie Benachrichtigungen über Ereignisse in Secrets Manager über E-Mail, SMS oder andere unterstützte Zustellungskanäle an andere Benutzer oder Benutzerziele senden. Darüber hinaus können Sie diese Benachrichtigungen über Ereignisse an andere Anwendungen senden, um Logik zu erstellen, indem Sie beispielsweise ereignisgesteuerte Programmierung mithilfe von Webhooks verwenden. Dies wird durch die Integration zwischen Secrets Manager und IBM Cloud® Event Notifications ermöglicht.

Um Informationen an Event Notifications senden zu können, müssen Sie Ihre Secrets Manager-Serviceinstanz mit Event Notifications verbinden. Weitere Informationen zum Arbeiten mit Event Notifications finden Sie unter Erste Schritte mit Event Notifications.

Wenn Sie Ihre Secrets Manager-Serviceinstanz löschen möchten, entfernen Sie auch Secrets Manager als Quelle in Ihrer Event Notifications-Serviceinstanz.

Erfassung und Versand von Ereignissen durch Secrets Manager

Wenn ein Ereignis von Interesse in Ihrer Secrets Manager-Instanz auftritt, kommuniziert Secrets Manager mit einer verbundenen Event Notifications-Instanz, um eine Benachrichtigung an Unterstütztes Ziel weiterzuleiten.

Secrets Manager aggregiert eine Liste Ihrer anstehenden Benachrichtigungen nach Ereignistyp, dem Typ des geheimen Schlüssels und Ablaufdetails, sofern zutreffend. Alle 1 bis 2 Minuten prüft der Service, ob anstehende Benachrichtigungen vorhanden sind, und sendet sie an den verbundenen Event Notifications-Service. Sie können beispielsweise Benachrichtigungen empfangen, die den folgenden Nachrichten ähneln:

  • Sie haben 1 beliebigen geheimen Schlüssel, der in 1 Tag abläuft.
  • Sie haben 5 geheime Schlüssel für öffentliche Zertifikate, die in 10 Tagen ablaufen.
  • Sie haben 100 importierte geheime Zertifikatsschlüssel, die in 30 Tagen ablaufen.

100 ist die maximale Anzahl geheimer Schlüssel, über die Sie in einer Ereignisbenachrichtigung benachrichtigt werden können.

Ereignisse für Secrets Manager

In der folgenden Tabelle sind die Secrets Manager-Aktionen aufgelistet, die ein Ereignis generieren.

Abhängig vom Typ des geheimen Schlüssels, mit dem Sie im Service arbeiten, wird von Secrets Managermöglicherweise kein Ereignis generiert. Sie erhalten beispielsweise keine Benachrichtigung, wenn ein Zertifikat in weniger als 24 Stunden abläuft. Weitere Informationen hierzu finden Sie unter Ereignisse nach Typ des geheimen Schlüssels.

Aktionen, die Ereignisbenachrichtigungen erzeugen
Ereignisname Ereignistyp Untertyp Beschreibung Bewertung
Geheimer Schlüssel erstellt com.ibm.cloud.secrets-manager.secret_created Ein Ereignis wird gesendet, wenn der Instanz ein geheimer Schlüssel hinzugefügt wird. low
Erstellung des geheimen Schlüssels fehlgeschlagen com.ibm.cloud.secrets-manager.secret_creation_failed Ein Ereignis wird gesendet, wenn eine Anforderung zum Erstellen eines geheimen Schlüssels fehlschlägt. low
Rotation des geheimen Schlüssels ausgeführt com.ibm.cloud.secrets-manager.secret_rotated Ein Ereignis wird gesendet, wenn ein geheimer Schlüssel gewechselt wird und eine neue Version verfügbar ist. low
Rotation des geheimen Schlüssels fehlgeschlagen com.ibm.cloud.secrets-manager.secret_rotation_failed Ein Ereignis wird gesendet, wenn eine Anforderung zum Rotieren eines geheimen Schlüssels fehlschlägt. high
Geheimer Schlüssel läuft in 90 Tagen ab com.ibm.cloud.secrets-manager.secret_about_to_expire in_90_days Ein Ereignis wird gesendet, wenn ein geheimer Schlüssel 90 Tage vom Ablauf entfernt ist. high
Geheimer Schlüssel läuft in 60 Tagen ab com.ibm.cloud.secrets-manager.secret_about_to_expire in_60_days Ein Ereignis wird gesendet, wenn ein geheimer Schlüssel 60 Tage vom Ablauf entfernt ist. high
Geheimer Schlüssel läuft in 30 Tagen ab com.ibm.cloud.secrets-manager.secret_about_to_expire in_30_days Ein Ereignis wird gesendet, wenn ein geheimer Schlüssel 30 Tage vom Ablauf entfernt ist. high
Geheimer Schlüssel läuft in 10 Tagen ab com.ibm.cloud.secrets-manager.secret_about_to_expire in_10_days Ein Ereignis wird gesendet, wenn ein geheimer Schlüssel 10 Tage vom Ablauf entfernt ist. high
Geheimer Schlüssel läuft in 1 Tag ab com.ibm.cloud.secrets-manager.secret_about_to_expire in_1_day Ein Ereignis wird gesendet, wenn ein geheimer Schlüssel einen Tag vom Ablauf entfernt ist. high
Der geheime Schlüssel läuft in weniger als 1 Tag ab. com.ibm.cloud.secrets-manager.secret_about_to_expire in_0_days Ein Ereignis wird gesendet, wenn ein geheimer Schlüssel weniger als einen Tag vom Ablauf entfernt ist. high
Geheimer Schlüssel abgelaufen com.ibm.cloud.secrets-manager.secret_expired Ein Ereignis wird gesendet, wenn ein geheimer Schlüssel sein Ablaufdatum und seine Verfallszeit erreicht. high
Geheimer Schlüssel widerrufen com.ibm.cloud.secrets-manager.secret_revoked Ein Ereignis wird gesendet, wenn eine Version eines geheimen Schlüssels widerrufen wird, bevor der Ablauf geplant ist. low
Geheimer Schlüssel gelöscht com.ibm.cloud.secrets-manager.secret_deleted Ein Ereignis wird gesendet, wenn ein geheimer Schlüssel aus einer Secrets Manager -Instanz gelöscht wird. low
Löschen des geheimen Schlüssels fehlgeschlagen com.ibm.cloud.secrets-manager.secret_deletion_failed Ein Ereignis wird gesendet, wenn eine Anfrage zum Löschen eines Geheimnisses fehlschlägt. high
Löschen des geheimen Schlüssels blockiert com.ibm.cloud.secrets-manager.secret_deletion_blocked Ein Ereignis wird gesendet, wenn ein geheimer Schlüssel nicht gelöscht werden kann, weil er gesperrt ist. low
Geheimer Widerruf blockiert com.ibm.cloud.secrets-manager.secret_revocation_blocked Ein Ereignis wird gesendet, wenn ein geheimer Schlüssel nicht widerrufen werden kann, weil er gesperrt ist. low
Rotation geheimer Schlüssel blockiert com.ibm.cloud.secrets-manager.secret_rotation_blocked Ein Ereignis wird gesendet, wenn ein geheimer Schlüssel nicht rotiert werden kann, weil er gesperrt ist. low
Ablauf des geheimen Schlüssels blockiert com.ibm.cloud.secrets-manager.secret_expiration_blocked Ein Ereignis wird gesendet, wenn ein geheimer Schlüssel nicht ablaufen kann, weil er gesperrt ist. high
Geheime Daten entfernt com.ibm.cloud.secrets-manager.secret_data_removed Ein Ereignis wird gesendet, wenn die Daten eines geheimen Schlüssels entfernt werden. low
Daten der Version des geheimen Schlüssels gelöscht com.ibm.cloud.secrets-manager.secret_version_data_deleted Ein Ereignis wird gesendet, wenn die Daten einer geheimen Version gelöscht werden. low
Geheime Aufgabe erstellt com.ibm.cloud.secrets-manager.secret_task_created Ein Ereignis wird gesendet, wenn eine Aufgabe für ein Geheimnis erstellt wird. low
Geheime Aufgabe gelungen com.ibm.cloud.secrets-manager.secret_task_succeeded Ein Ereignis wird gesendet, wenn eine Aufgabe erfolgreich abgeschlossen wurde. low
Geheime Aufgabe fehlgeschlagen com.ibm.cloud.secrets-manager.secret_task_failed Ein Ereignis wird gesendet, wenn eine Aufgabe fehlschlägt. high
Geheime Aufgabe gelöscht com.ibm.cloud.secrets-manager.secret_task_deleted Ein Ereignis wird gesendet, wenn eine Aufgabe gelöscht wird. low
Testereignis com.ibm.cloud.secrets-manager.test_event Ein Ereignis wird gesendet, wenn eine Testbenachrichtigung an Event Notifications weitergeleitet wird. low

secret_about_to_expire-Ereignisse werden nur einmal am angegebenen Tag gesendet. Das heißt, wenn Sie angeben, dass ein Geheimnis in 10 Tagen ablaufen soll, erhalten Sie eine einzige Benachrichtigung, wenn das Geheimnis noch 10 Tage gültig ist. Sie erhalten zu keinem anderen Zeitpunkt eine Benachrichtigung, z. B. wenn das Geheimnis noch 9 Tage gilt.

Unterstützte Typen geheimer Schlüssel

In der folgenden Tabelle sind die Secrets Manager -Ereignisse aufgelistet, die auf der Basis von Typen geheimer Schlüssel generiert werden können, die im Service unterstützt werden.

Aktionen, die Ereignisse basierend auf dem Geheimnistyp erzeugen
Ereignisname Ereignistyp Auftreten Beliebig IAM-Berechtigungsnachweise Schlüsselwert Benutzerberechtigungsnachweise Importierte Zertifikate Private Zertifikate Öffentliche Zertifikate Serviceberechtigungsnachweise Benutzerdefinierte Berechtigungsnachweise
Geheimer Schlüssel erstellt com.ibm.cloud.secrets-manager.secret_created Pünktlich Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen
Erstellung des geheimen Schlüssels fehlgeschlagen com.ibm.cloud.secrets-manager.secret_creation_failed Pünktlich Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen
Rotation des geheimen Schlüssels ausgeführt com.ibm.cloud.secrets-manager.secret_rotated Pünktlich Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen
Rotation des geheimen Schlüssels fehlgeschlagen com.ibm.cloud.secrets-manager.secret_rotation_failed Pünktlich Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen
Der geheime Schlüssel läuft in Kürze ab com.ibm.cloud.secrets-manager.secret_about_to_expire 90, 60, 30, 10, 1, 0 Tage vor Ablauf des geheimen Schlüssels Symbol für Häkchen Symbol für Häkchen Nicht zutreffend[1] Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen
Geheimer Schlüssel abgelaufen com.ibm.cloud.secrets-manager.secret_expired Täglich Symbol für Häkchen Symbol für Häkchen Nicht zutreffend[2] Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen
Geheimer Schlüssel widerrufen com.ibm.cloud.secrets-manager.secret_revoked Pünktlich Nicht zutreffend[3] Nicht zutreffend[4] Nicht zutreffend[5] Nicht zutreffend[6] Nicht zutreffend[7] Symbol für Häkchen Nicht zutreffend[8] Nicht zutreffend[9] Nicht zutreffend[10]
Geheimer Schlüssel gelöscht com.ibm.cloud.secrets-manager.secret_deleted Pünktlich Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen
Löschen des geheimen Schlüssels blockiert com.ibm.cloud.secrets-manager.secret_deletion_blocked Pünktlich Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen
Rotation geheimer Schlüssel blockiert com.ibm.cloud.secrets-manager.secret_rotation_blocked Einmal[11]
Täglich [12]
Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen
Geheimer Widerruf blockiert com.ibm.cloud.secrets-manager.secret_revocation_blocked Pünktlich Nicht zutreffend[13] Nicht zutreffend[14] Nicht zutreffend[15] Nicht zutreffend[16] Nicht zutreffend[17] Symbol für Häkchen Nicht zutreffend[18] Nicht zutreffend[19] Nicht zutreffend[20]
Ablauf des geheimen Schlüssels blockiert com.ibm.cloud.secrets-manager.secret_expiration_blocked Einmal
Täglich
Symbol für Häkchen Symbol für Häkchen Nicht zutreffend[21] Symbol für Häkchen Nicht zutreffend[22] Nicht zutreffend[23] Nicht zutreffend[24] Symbol für Häkchen Symbol für Häkchen
Daten der Version des geheimen Schlüssels gelöscht com.ibm.cloud.secrets-manager.secret_data_removed Pünktlich Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen Symbol für Häkchen
Geheime Aufgabe erstellt com.ibm.cloud.secrets-manager.secret_task_created Pünktlich Symbol für Häkchen
Geheime Aufgabe gelungen com.ibm.cloud.secrets-manager.secret_task_created Pünktlich Symbol für Häkchen
Geheime Aufgabe fehlgeschlagen com.ibm.cloud.secrets-manager.secret_task_created Pünktlich Symbol für Häkchen
Geheime Aufgabe gelöscht com.ibm.cloud.secrets-manager.secret_task_created Pünktlich Symbol für Häkchen

Benachrichtigungen aktivieren

Von einer Instanz des Secrets Manager-Service generierte Ereignisse können an eine Event Notifications-Serviceinstanz weitergeleitet werden, die in demselben Konto verfügbar ist. Sie können nur eine Secrets Manager-Instanz für eine Event Notifications-Serviceinstanz konfigurieren. Für den Einstieg benötigen Sie Folgendes:

  • Vorgesetzter -Servicezugriff auf dem Secrets Manager -Service.
  • Vorgesetzter -Servicezugriff auf dem Event Notifications -Service. Wenn Sie eine vorhandene Event Notifications -Serviceinstanz in Ihrem Account anzeigen möchten, benötigen Sie auch Zugriff auf die Anzeigeberechtigter -Plattform oder höher.

Verbindung zu Event Notifications in der Benutzerschnittstelle herstellen

Bevor Sie Benachrichtigungen für Secrets Manager aktivieren können, vergewissern Sie sich, dass Sie eine Event Notifications Service-Instanz haben, die sich im selben Konto befindet wie Ihre Secrets Manager Instanz. Dann können Sie den Abschnitt Einstellungen > Event Notifications in der Benutzeroberfläche Secrets Manager verwenden, um die Dienste zu verbinden.

Die Abbildung zeigt den Bildschirm Event Notifications in der Benutzeroberfläche Secrets Manager.
Verbinden mit Event Notifications

  1. Klicken Sie in der Konsole auf das Symbol Menü Menüsymbol > Ressourcenliste.

  2. Wählen Sie in der Liste der Services Ihre Instanz von Secrets Manager aus.

  3. Klicken Sie in der Secrets Manager -Navigation auf Einstellungen.

  4. Klicken Sie im Abschnitt Event Notifications auf Verbinden.

  5. Überprüfen Sie im Seitenbereich die Quellendetails für die Verbindung. Geben Sie optional eine Beschreibung an.

  6. Wählen Sie die Ressourcengruppe und die Event Notifications-Serviceinstanz aus, die Sie verbinden wollen.

    Wenn in Ihrem Konto keine IAM-Berechtigung zwischen Secrets Manager und Event Notifications vorhanden ist, wird ein Dialogfenster angezeigt. Befolgen Sie die Eingabeaufforderungen, um den Zugriff zwischen den Services zu erteilen.

    1. Um Zugriff zwischen Secrets Manager und Event Notificationszu erteilen, klicken Sie auf Autorisieren.
    2. Wählen Sie in der seitlichen Anzeige Event Notifications als Zielservice aus.
    3. Wählen Sie in der Liste der Instanzen die Event Notifications-Serviceinstanz aus, die Sie berechtigen möchten.
    4. Wählen Sie die Rolle Ereignisquellenmanager aus.
    5. Klicken Sie auf Überprüfung.
    6. Klicken Sie auf Zuweisen.
  7. Klicken Sie auf Verbinden, um die Verbindung zu bestätigen.

    Es wird eine Nachricht über die erfolgreiche Ausführung angezeigt, die angibt, dass Secrets Manager jetzt mit Event Notifications verbunden ist. Wenn Sie die Verbindung zu Event Notifications später trennen müssen, können Sie das Optionsmenü Symbol für Optionen > Verbindung trennen verwenden, um Secrets Manager als Quellenservice in der Event Notifications -Instanz zu löschen.

    Wenn Sie die Verbindung zu Event Notifications trennen, löschen Sie die IAM-Berechtigung zwischen Secrets Manager und Event Notifications nicht. Secrets Manager verwendet die vorhandene Berechtigung, um die Registrierung bei Event Notifications aufzuheben. Wenn eine Event Notifications-Instanz gelöscht wird, werden alle Berechtigungen, die zwischen dem Service und Secrets Manager bestehen, auch von IAM gelöscht.

Verbindung zu Event Notifications über die API herstellen

Bevor Sie Benachrichtigungen für Secrets Manager aktivieren können, vergewissern Sie sich, dass Sie eine Event Notifications Service-Instanz haben, die sich im selben Konto befindet wie Ihre Secrets Manager Instanz. Anschließend können Sie programmgesteuert eine Verbindung zu Event Notifications herstellen, indem Sie die API Secrets Manager aufrufen.

Das folgende Beispiel zeigt eine Abfrage, mit der Sie Ihre Secrets Manager-Quellendetails bei Event Notifications registrieren können. Wenn Sie die API aufrufen, müssen Sie die ID-Variablen und das IAM-Token durch die Werte ersetzen, die für Ihre Secrets Manager-Instanz spezifisch sind.

Sie finden den Wert für event_notifications_instance_crn in der Konsole, indem Sie zur Ressourcenliste wechseln und auf die Event Notifications -Instanzzeile klicken.

curl -X POST
   --H "Authorization: Bearer {iam_token}" \
   --H "Accept: application/json" \
   --H "Content-Type: application/json" \
   --d'{
      "event_notifications_instance_crn": "crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::",
      "event_notifications_source_description": "Optional description of this source in an Event Notifications instance.",
      "event_notifications_source_name": "My Secrets Manager"
   }' \
"https://{instance_ID}.{region}.secrets-manager.appdomain.cloud/api/v2/notifications/registration"

Eine erfolgreiche Anforderung gibt den CRN-Wert Ihrer verbundenen Event Notifications-Serviceinstanz zurück. Weitere Informationen zu den erforderlichen und optionalen Anforderungsparametern finden Sie in den API-Dokumenten.

Verbindung zu Event Notifications mit Terraform herstellen

Das folgende Beispiel zeigt eine Konfiguration, die Sie verwenden können, um Ihre Secrets Manager Quellenangaben bei Event Notifications zu registrieren.

    resource "ibm_sm_en_registration" "en_registration" {
        instance_id = local.instance_id
        region = local.region
        name = "test-root-ca"
        event_notifications_instance_crn = var.en_instance_crn
        event_notifications_source_description = "My event notification source"
        event_notifications_source_name = "my_en_source"
    }

Testereignis in der Benutzerschnittstelle an Event Notifications senden

Nachdem Sie Benachrichtigungen für Secrets Manager aktiviert haben, testen Sie Ihre Verbindung, um sicherzustellen, dass die von Secrets Manager generierten Ereignisse an Event Notifications weitergeleitet werden.

Bevor Sie Secrets Manager-Testereignisse senden können, müssen Sie Themen, Ziele und Subskriptionen in Ihrer Event Notifications-Instanz erstellt haben. Stellen Sie sicher, dass der Ereignistypen Testereignis (com.ibm.cloud.secrets-manager.test_event) als Bedingung in Ihrem Abschnitt Event Notifications enthalten ist.

Die Abbildung zeigt den Bildschirm Event Notifications in der Benutzeroberfläche Secrets Manager.
Senden eines Test-Ereignisses an Event Notifications

  1. Klicken Sie in der Secrets Manager -Benutzerschnittstelle auf Einstellungen.

  2. Klicken Sie im Abschnitt Event Notifications auf Testereignis senden.

    Eine Nachricht über die erfolgreiche Ausführung wird angezeigt, um anzuzeigen, dass das Testereignis erfolgreich an Event Notifications weitergeleitet wurde.

Testereignis mit der API an Event Notifications senden

Nachdem Sie Benachrichtigungen für Secrets Manager aktiviert haben, testen Sie Ihre Verbindung, um sicherzustellen, dass die von Secrets Manager generierten Ereignisse an Event Notifications weitergeleitet werden.

Damit Sie ein Secrets Manager-Testereignis senden können, müssen Sie Themen, Ziele und Subskriptionen in Ihrer Event Notifications-Instanz erstellt haben. Stellen Sie sicher, dass der Ereignistypen Testereignis (com.ibm.cloud.secrets-manager.test_event) als Bedingung in Ihrem Abschnitt Event Notifications enthalten ist.

Das folgende Beispiel zeigt eine Abfrage, mit der Sie ein Testereignis vom Secrets Manager an Event Notifications senden können. Wenn Sie die API aufrufen, müssen Sie die ID-Variablen und das IAM-Token durch die Werte ersetzen, die für Ihre Secrets Manager-Instanz spezifisch sind.

curl -X GET
   --H "Authorization: Bearer {iam_token}" \
   "https://{instance_ID}.{region}.secrets-manager.appdomain.cloud/api/v2/notifications/registration/test"

Eine erfolgreiche Anforderung gibt die HTTP-Antwort 200 OK zurück, um anzuzeigen, dass ein Testereignis erfolgreich an Ihre verbundene Event Notifications-Serviceinstanz weitergeleitet wurde. Weitere Informationen finden Sie in den API-Dokumenten.

Benachrichtigungen an ausgewählte Ziele zustellen

Nachdem Sie Benachrichtigungen für Secrets Manager aktiviert haben, erstellen Sie Themen und Subskriptionen in Event Notifications, damit Alerts an Ihre ausgewählten Ziele weitergeleitet und zugestellt werden.

Eine vollständige Liste der unterstützten Ziele finden Sie in der Event Notifications-Dokumentation.

E-Mail-Benachrichtigungen

Sie können IBM Cloud-E-Mail-Service als Zustellungskanal für Secrets Manager-Ereignisbenachrichtigungen verwenden. Erstellen sie eine Event Notifications-Subskription zwischen einem vorhandenen Thema und dem IBM Cloud-E-Mail-Service, um Ihre Alerts per E-Mail an verschiedene Empfänger weiterzuleiten.

Eine E-Mail von IBM Cloud, die Informationen zu einem Secrets Manager-Ereignis enthält, ähnelt dem folgenden Beispiel:

Subject: Your 2 public certificate secrets expire in 10 days
Body: You have 2 public certificate secrets that expire in 10 days: my-certificate-1, my-certificate-2. You can view and manage your existing secrets by accessing Secrets Manager in the console, or by using the CLI or APIs. For more information, check out the docs.

Um detaillierte Informationen zu einer Ereignisbenachrichtigung in Ihrer E-Mail zu erhalten, wählen Sie die Option Benachrichtigungsnutzdaten hinzufügen aus, wenn Sie eine Event Notifications -Subskription erstellen. Ihre E-Mail zeigt die Details der Benachrichtigungsnutzdaten an, die dem Ereignis zugeordnet sind.

Webhooks

Sie können ein Webhook-Ziel konfigurieren, sodass eine eingehende Benachrichtigung programmgesteuert von einer App oder einem Service verarbeitet werden kann. Weitere Informationen zum Einrichten von Webhooks finden Sie in der Event Notifications-Dokumentation.

Details der Benachrichtigungsnutzdaten

Erfolgreiche Ereignisse, die von Secrets Manager generiert werden, enthalten verschiedene Felder, mit deren Hilfe Sie die Quelle und Details eines Ereignisses ermitteln können.

Ereignisbenachrichtigungen von Secrets Manager enthalten nur Metadateneigenschaften wie Namen oder IDs von Ressourcen. Sensible Daten wie API-Schlüssel oder Kennwörter werden nicht in generierte Ereignisse eingeschlossen.

Die Eigenschaften, die an Event Notifications gesendet werden, variieren je nach Ereignistyp und Typ des geheimen Schlüssels. Wenn beispielsweise ein Ereignis secret_about_to_expire:in_10_days in einer Instanz für einen oder mehrere geheime public_cert-Schlüssel auftritt, sendet Secrets Manager Benachrichtigungsnutzdaten an Event Notifications, das dem folgenden Beispiel ähnelt.

{
   "event_sub_type": "in_10_days",
   "event_type": "secret_about_to_expire",
   "secret_type": "public_cert",
   "secrets": [
      {
         "domains": "domain1.com",
         "event_time": "2022-01-04T00:00:00Z",
         "event_triggered_by": "SecretsManager",
         "secret_expiration": "2022-01-14T00:00:00Z",
         "secret_group_id": "default",
         "secret_id": "crn:v1:bluemix:public:secrets-manager:<region>:a/<account_id>:<instance_id>:secret:<secret_id>",
         "secret_name": "my-certificate-1",
         "serial_number": "1:2:3:4"
      },
      {
         "domains": "domain2.com, domain3.com",
         "event_time": "2022-01-04T00:00:00Z",
         "event_triggered_by": "SecretsManager",
         "secret_expiration": "2022-01-14T00:00:00Z",
         "secret_group_id": "default",
         "secret_id": "crn:v1:bluemix:public:secrets-manager:<region>:a/<account_id>:<instance_id>:secret:<secret_id>",
         "secret_name": "my-certificate-2",
         "serial_number": "1:2:3:4"
      },
   ],
   "source_instance_api_private_url": "https://<instance_id>.private.<region>.secrets-manager.appdomain.cloud/api",
   "source_instance_api_public_url": "https://<instance_id>.<region>.secrets-manager.appdomain.cloud/api",
   "source_instance_crn": "crn:v1:bluemix:public:secrets-manager:<region>:a/<account_id>:<instance_id>::",
   "source_instance_dashboard_url": "https://cloud.ibm.com/services/secrets-manager/crn%3Av1%3Abluemix%3Apublic%3Asecrets-manager%3A<region>%3Aa%2Fa6cc9f5f21f34323a4175c1117638b40%3A<instance_id>%3A%3A",
   "source_service": "SecretsManager"
}

Weitere Informationen zu Ereignisbenachrichtigungseigenschaften finden Sie in der folgenden Tabelle.

Eigenschaften in einer Ereignisbenachrichtigungs-Nutzlast
Eigenschaft Beschreibung
event_sub_type Der Subtyp, der dem Ereignistyp entspricht, der eine Benachrichtigung ausgelöst hat.
event_type Der Ereignistyp, der eine Benachrichtigung ausgelöst hat.
secret_type Der Typ des geheimen Schlüssels, der dem Ereignis zugeordnet ist

Mögliche Werte sind: imported_cert, private_cert, public_cert

secrets[]

Eine Liste von Objekten, die die Metadateneigenschaften eines geheimen Schlüssels enthalten, der dem Ereignis zugeordnet ist. Welche Eigenschaften aufgelistet werden, hängt vom Typ des geheimen Schlüssels ab.

Zu den Eigenschaften, die für alle Typen geheimer Schlüssel gesendet werden, gehören:

  • event_time: Das Datum und die Uhrzeit der Ereignisgenerierung.
  • event_triggered_by: Die Entität, die das Ereignis ausgelöst hat. Dies kann der Service Secrets Manager oder eine IBM ID sein
  • secret_group_id: Die ID der Gruppe geheimer Schlüssel.
  • secret_id: Die ID, die den geheimen Schlüssel eindeutig identifiziert.
  • secret_name: Der Name des geheimen Schlüssels.

Ereignisse für imported_cert, private_cert und public_cert geheime Schlüssel enthalten auch:

  • domains: Die Domänen, die dem Zertifikat zugeordnet sind.
  • serial_number: Die Seriennummer, die dem Zertifikat zugeordnet ist.

Fehlerereignisse können auch Folgendes enthalten:

  • failure_reason: Die Ursache für den Operationsfehler.
tasks[]

Eine Liste von Objekten, die die Metadateneigenschaften einer geheimen Aufgabe enthalten, die mit dem Ereignis verbunden ist.

Zu den Eigenschaften, die für alle Typen geheimer Schlüssel gesendet werden, gehören:

  • event_time: Das Datum und die Uhrzeit der Ereignisgenerierung.
  • event_triggered_by: Die Entität, die das Ereignis ausgelöst hat. Dies kann der Dienst Secrets Manager oder eine IBM ID sein.
  • secret_group_id iD: Die ID der geheimen Gruppe.
  • secret_id iD: Die ID, die das Geheimnis eindeutig identifiziert.
  • secret_name der Name des Geheimnisses.
  • task_id iD der geheimen Aufgabe: Die ID, die die geheime Aufgabe eindeutig identifiziert.
  • secret_status status: Der Status der geheimen Aufgabe.
  • task_trigger auslöser für die Erstellung dieser Aufgabe.
  • task_type typ der geheimen Aufgabe.

Fehlerereignisse können auch Folgendes enthalten:

  • failure_reason: Die Ursache für den Operationsfehler.
source_instance_api_private_url Die Private Endpunkt-URL, die Ihrer Secrets Manager-Serviceinstanz zugeordnet ist.
source_instance_api_public_url Die öffentliche Endpunkt-URL, die Ihrer Secrets Manager-Serviceinstanz zugeordnet ist.
source_instance_crn Der CRN (Cloud Resource Name), der Ihre Secrets Manager-Serviceinstanz eindeutig identifiziert.
source_instance_dashboard_url Die URL zu Ihrem Secrets Manager-Service-Dashboard in der Konsole.
source_service Der Anzeigename des Service, der die Ereignisbenachrichtigung gesendet hat.

  1. Ereignis ist nicht anwendbar, da es für diesen Geheimnistyp kein Time-to-live (TTL)-Limit gibt. ↩︎

  2. Ereignis ist nicht anwendbar, da es für diesen Geheimnistyp kein Time-to-live (TTL)-Limit gibt. ↩︎

  3. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  4. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  5. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  6. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  7. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  8. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  9. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  10. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  11. Sie erhalten eine Benachrichtigung, die Sie darüber informiert, dass die manuelle Rotation nicht erfolgreich war. ↩︎

  12. Wenn eine automatische Rotation fehlschlägt, werden Sie täglich benachrichtigt, bis sie erfolgreich ist. ↩︎

  13. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  14. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  15. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  16. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  17. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  18. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  19. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  20. Ereignis ist nicht anwendbar, weil dieser Benachrichtigungstyp nur für private Zertifikate gilt. ↩︎

  21. Ereignis ist nicht anwendbar, da es für diesen Geheimnistyp kein Time-to-live (TTL)-Limit gibt. ↩︎

  22. Das Ereignis ist nicht anwendbar, da das Verfallsdatum bei dieser Art von Geheimnis nicht gesperrt werden kann. ↩︎

  23. Das Ereignis ist nicht anwendbar, da das Verfallsdatum bei dieser Art von Geheimnis nicht gesperrt werden kann. ↩︎

  24. Das Ereignis ist nicht anwendbar, da das Verfallsdatum bei dieser Art von Geheimnis nicht gesperrt werden kann. ↩︎