Secrets Manager-API-Änderungsprotokoll

In diesem Änderungsprotokoll können Sie Informationen zu den neuesten Änderungen, Verbesserungen und Aktualisierungen für die IBM Cloud® Secrets Manager -API finden. Das Änderungsprotokoll enthält eine Auflistung der vorgenommenen Änderungen in der zeitlichen Reihenfolge ihrer jeweiligen Freigabe. Änderungen an vorhandenen Versionen der Anwendungsprogrammierschnittstelle (API) sind so konzipiert, dass sie mit vorhandenen Clientanwendungen kompatibel sind.

Weitere Informationen zu allgemeinen Aktualisierungen und Verbesserungen für den Secrets Manager-Service finden Sie im Abschnitt Releaseinformationen.

25. August 2025

  • Ein neues Feld retrieved_at wurde hinzugefügt, um festzustellen, wann der letzte Zugriff auf ein Geheimnis erfolgte.

17. Februar 2025

  • Ein neues Feld managed_csr wurde hinzugefügt, um die Funktion "Importierte Zertifikate mit verwalteter CSR" zu unterstützen.

7. Oktober 2024

  • Eine neue Konfiguration action_type, private_cert_configuration_action_rotate_intermediate, ist jetzt verfügbar, um die Rotation eines Zwischenzertifikats der Zertifizierungsstelle zu ermöglichen. Erfahren Sie mehr über die Rotation einer Zwischen-CA.

23. September 2024

  • Die Create Secret API unterstützt jetzt die Erstellung eines IAM-Geheimnisses für die Verwaltung von Anmeldeinformationen auf einem anderen IBM Cloud-Konto durch Übergabe der Konto-ID im neuen account_id-Feld.
  • Eine neue Eigenschaft disabled wurde zur Konfiguration der IAM-Anmeldeinformationen hinzugefügt. Verwenden Sie diese Eigenschaft, um die API-Schlüsselkonfiguration zu deaktivieren, wenn Sie zur Verwendung der IAM-Dienstautorisierungskonfiguration wechseln.
  • Die Methode Konfiguration aktualisieren kann jetzt verwendet werden, um entweder das Feld api_key oder das Feld disabled zu aktualisieren.
  • Ein neues Feld account_id wird zurückgegeben, wenn die zu verwaltende Service-ID zu einem anderen IBM Cloud-Konto gehört.

9. September 2024

  • Das Feld expiration_date wird jetzt auch für geheime Versionen zurückgegeben.

6. August 2024

  • Verwenden Sie die Option secret_types, um die Konfiguration für einen bestimmten Motor aufzulisten. Unterstützte Werte sind: iam_credentials, public_cert, und private_cert.
  • Neue Eigenschaft crypto_key zur Bereitstellung eines eigenen HSM.

10. Juni 2024

  • Die Metadaten-API aktualisieren unterstützt jetzt null für das Feld expiration_date, sodass der Ablauf für die Typen arbitrary und username_passowrd für geheime Schlüssel inaktiviert werden kann.

11. März 2024

  • Die API für Serviceendpunkte gibt jetzt auch den Schlüsselmanagementservice zurück, der für die Serviceinstanz ausgewählt wurde-providerverwaltet oder vom Benutzer bereitgestellt (Key Protect oder Hyper Protect Crypto Services).
  • Die API für geheime Schlüssel auflisten akzeptiert jetzt zusätzliche Parameter, ?secret_types=... zum Filtern nach Typ des geheimen Schlüssels und ?match_all_labels=... zum Filtern nach einer Bezeichnung oder einer Kombination von Bezeichnungen.

12. Februar 2024

  • Der Typ des geheimen Schlüssels für Benutzerberechtigungsnachweise unterstützt jetzt die Generierung eines automatisch generierten Kennworts bei der Erstellung des geheimen Schlüssels, wenn das Feld password leer bleibt. Außerdem können Sie die Länge des Kennworts steuern und festlegen, ob Zahlen, Symbole und Großbuchstaben eingeschlossen werden sollen, indem Sie das Feld password_generation_policy einschließen. Weitere Informationen finden Sie unter Benutzerberechtigungsnachweise speichern.
  • Bei einer vorhandenen DNS-Providerkonfiguration können Sie zwischen API-Schlüssel und Service-zu-Service-Autorisierung wechseln, indem Sie eine leere Zeichenfolge im Feld apikey übergeben. Hinweis: Es wird davon ausgegangen, dass vor dem Wechsel eine Service-to-Service-Autorisierung für dieselbe Cloud Internet Services-Instanz mit einer identischen oder übereinstimmenden Zugriffsrichtlinie konfiguriert wurde.

20. September 2023

Rufen Sie einen geheimen Schlüssel nach Name anstelle der ID ab, indem Sie einen neuen API-Endpunkt verwenden /api/v2/secret_groups/{secret_group_name}/secret_types/{secret_type}/secrets/{name}. Weitere Informationen finden Sie unter Auf geheime Schlüssel zugreifen.

17. April 2023

Version 2.0.0 wurde am 17. April 2023 freigegeben. Dieses Release enthält die folgenden Aktualisierungen:

  • Sie müssen secret_type nicht mehr in die API URL aufnehmen, um ein Geheimnis zu identifizieren.
  • Der Name der Gruppe geheimer Schlüssel muss für jede Instanz von Secrets Manager eindeutig sein.
  • Ressourcenaktualisierungen werden als HTTP-Patch-Vorgänge definiert.
  • Die Konfigurations-API folgt dem Muster der Secrets Manager-API. config_type fungiert ähnlich wie secret_type als API-Diskriminator.
  • Konfigurationen werden ähnlich wie das Modell Secrets Manager als openAPI-Verbünde mit Metadaten und Datenabschnitten modelliert. Zuordnungen zwischen IAM-Rollen und Konfigurations-API folgen demselben Muster für die API Secrets Manager. Ein IAM-Viewer kann beispielsweise Konfigurationen auflisten, um ihre Metadaten anzuzeigen.
  • Listenoperationen geben nur Metadaten für geheime Schlüssel, Version des geheimen Schlüssels und Konfigurationsressourcen zurück.
  • Die Aktion zum Rotieren eines geheimen Schlüssels ist jetzt die API zum Erstellen einer neuen Version des geheimen Schlüssels: POST/v2/secrets/{id}/versions.
  • Die Aktion zum Wiederherstellen der Version des geheimen Schlüssels ist jetzt die API zum Erstellen einer neuen Version des geheimen Schlüssels mit dem Hauptteilparameter restored_from_version.
  • Die Aktion zum Löschen von IAM-Berechtigungsnachweisen ist jetzt die API zum Löschen von Daten einer geheimen Version: DELETE /v2/secrets/{id}/versions/{version_id}/secret_data.
  • Die Richtlinien-API ist jetzt in Version 2.0in die Metadaten-API integriert.
  • Die Aktionen zum Auflisten von geheimen Schlüsseln und Abrufen von Metadaten für geheime Schlüssel geben das Feld versions_total zurück. Der Inhalt der Version ist nicht enthalten.
  • Auf aktuelle und frühere Versionen geheimer Schlüssel kann mithilfe der Aliasnamen current und previous in Versions-APIs verwiesen werden.
  • Ab dem 17. April 2023 wird die API v1 von IBM Cloud® Secrets Manager zugunsten von v2nicht mehr verwendet. Wenn Sie weiterhin aktiv mit der API v1von Secrets Manager arbeiten, stellen Sie sicher, dass Sie Ihr Upgrade so schnell wie möglich starten. Am 31. Oktober 2023 wird die Unterstützung für die Secrets Manager-API v1 entfernt.

12. September 2022

Dieses Release enthält die folgenden Aktualisierungen:

10. Juli 2022

Dieses Release enthält die folgenden Aktualisierungen:

25. April 2022

Dieses Release enthält die folgenden Aktualisierungen:

  • Der Typ des geheimen private_cert -Schlüssels, der zum Erstellen von TLS-Zertifikaten mit dem Service verwendet werden kann, wurde hinzugefügt. Weitere Informationen finden Sie unter Private Zertifikate erstellen.
  • Die Methode Aktion für eine Version eines geheimen Schlüssels aufrufen wurde hinzugefügt, mit der eine Version eines privaten Zertifikats widerrufen werden kann. Derzeit unterstützt diese API nur geheime private_cert-Schlüssel.
  • Die Methode "Invoke an action on a secret" wurde aktualisiert, um revoke als eine unterstützte Aktion aufzunehmen. Derzeit wird die Aktion revoke nur für private_cert Geheimnisse unterstützt.
  • Die Methode Get a version of a secret wurde aktualisiert; mit dieser Methode kann die vorherige Version eines geheimen Schlüssels abgerufen werden. Diese API unterstützt jetzt private_cert geheime Schlüssel zusätzlich zu imported_cert und public_cert.
  • Die Methoden Konfiguration hinzufügen, Konfigurationen auflisten, Konfiguration aktualisieren, Konfiguration abrufenund Konfiguration entfernen wurden aktualisiert. Diese APIs unterstützen jetzt private_cert geheime Schlüssel zusätzlich zu public_cert.
  • Es wurde die Methode Aktion für eine Konfiguration aufrufen hinzugefügt, die zum Ausführen von Operationen für bestimmte Konfigurationselemente verwendet wird, z. B. Stammzertifizierungsstellen oder temporäre Zertifizierungsstellen. Derzeit unterstützt diese API nur geheime private_cert-Schlüssel.

3. Februar 2022

Dieses Release enthält die folgende Aktualisierung:

31. Januar 2022

Dieses Release enthält die folgende Aktualisierung:

  • kv wurde als Typ für geheime Schlüssel zur Methode Geheimen Schlüssel erstellen hinzugefügt. Sie können geheime Schlüssel, einschließlich komplexer JSON-Dokumente, die für den Zugriff auf geschützte Systeme innerhalb oder außerhalb von IBM Cloud verwendet werden, speichern und verwalten.

22. November 2021

Dieses Release enthält die folgenden Aktualisierungen:

  • Der Zeichenfolgeparameter service_id wurde der Methode Geheimen Schlüssel erstellen als Option für den Anforderungshauptteil hinzugefügt. Sie können dieses Feld verwenden, um IAM-Berechtigungsnachweise mit einer vorhandenen Service-ID aus Ihrem Konto zu erstellen, sodass nur ein API-Schlüssel generiert wird, wenn der geheime Schlüssel gelesen oder darauf zugegriffen wird.
  • Der Zeichenfolgeparameter api_key_id wurde den Antwortdetails der Methoden Geheimen Schlüssel erstellen und Metadaten für geheime Schlüssel abrufen hinzugefügt.
  • Der boolesche Parameter service_id_is_static wurde zu den Antwortdetails der Methoden Geheimen Schlüssel erstellen und Metadaten für geheime Schlüssel abrufen hinzugefügt. Dieser Parameter zeigt an, ob ein geheimer IAM-Berechtigungsnachweis unter Verwendung einer vorhandenen Service-ID erstellt wurde.
  • Es wurde die Methode Versionen eines geheimen Schlüssels auflisten hinzugefügt, mit der Versionsprotokolldaten für einen geheimen Schlüssel abgerufen werden können.
  • Die booleschen Parameter payload_available und downloaded wurden den Antwortdetails der Methoden Geheimen Schlüssel abrufen, Metadaten der Version des geheimen Schlüssels abrufen und Versionen eines geheimen Schlüssels auflisten hinzugefügt. Mit diesen Parametern können Sie ermitteln, ob die Version eines geheimen Schlüssels für die Wiederherstellung verfügbar ist und ob sie bereits zuvor gelesen oder darauf zugegriffen wurde.
  • Der Abfrageparameter restore wurde als Anfrageoption für die Methode Invoke an action on a secret hinzugefügt. Mit dieser Aktion können Sie die Vorgängerversion eines geheimen Schlüssels wiederherstellen.
  • Die Methode Get a version of a secret wurde aktualisiert; mit dieser Methode kann die vorherige Version eines geheimen Schlüssels abgerufen werden. Diese API unterstützt jetzt neben public_cert und imported_cert auch geheime Schlüssel für arbitrary, iam_credentials und username_password.

20. September 2021

Dieses Release enthält die folgenden Aktualisierungen:

  • Es wurde der Typ public_cert für geheime Schlüssel hinzugefügt, der verwendet werden kann, um domänenvalidierte TLS-Zertifikate mit dem Service zu bestellen. Weitere Informationen finden Sie unter Zertifikate bestellen.
  • Die Methoden Add a configuration, List configurations, Update a configuration, Get a configuration und Remove a configuration wurden hinzugefügt; sie können verwendet werden, um Engine-Konfigurationen zum Service hinzuzufügen. Derzeit unterstützen diese APIs nur geheime public_cert-Schlüssel.
  • Die Methode Get a version of a secret wurde aktualisiert; mit dieser Methode kann die vorherige Version eines geheimen Schlüssels abgerufen werden. Diese API unterstützt jetzt geheime public_cert-Schlüssel zusätzlich zu imported_cert.

11. Juli 2021

Dieses Release enthält die folgenden Aktualisierungen:

  • Die maximale Länge für Namen von geheimen Schlüsseln wurde in 240 Zeichen geändert.
  • Die maximale Länge für Beschreibungen von geheimen Schlüsseln wurde auf 1.024 Zeichen geändert.in

20. Juni 2021

Dieses Release enthält die folgenden Aktualisierungen:

  • Es wurde der Typ imported_cert für geheime Schlüssel hinzugefügt, der zum Speichern von X.509-Zertifikaten im Service verwendet werden kann. Weitere Informationen finden Sie unter Zertifikate importieren.
  • Die Methode Get a version of a secret wurde hinzufügt; sie kann zum Abrufen der vorherigen Version eines geheimen Schlüssels verwendet werden. Derzeit unterstützt diese API nur geheime imported_cert-Schlüssel.

13 April 2021

Dieses Release enthält die folgenden Aktualisierungen:

  • Der Abfrageparameter group={secret_group_ID} wurde hinzugefügt, mit dem eine Liste der geheimen Schlüssel nach Gruppe geheimer Schlüssel gefiltert werden kann.

7. März 2021

Dieses Release enthält die folgenden Aktualisierungen:

  • Der boolesche Parameter reuse_api_key für geheime IAM-Berechtigungsnachweise wurde hinzugefügt.

10. Februar 2021

Dieses Release enthält die folgenden Aktualisierungen:

  • Der Abfrageparameter search={string} wurde hinzugefügt, mit dem eine Liste der geheimen Schlüssel gefiltert werden kann, die eine angegebene Zeichenfolge enthalten.
  • Der Abfrageparameter sort_by={field_name} wurde hinzugefügt, mit dem eine Liste der geheimen Schlüssel nach einem angegebenen Metadatenfeld gefiltert werden kann.

25. Januar 2021

Dieses Release enthält die folgenden Aktualisierungen:

  • Die maximale Länge für Namen geheimer Schlüssel wurde in 128 Zeichen geändert.
  • Die maximale Länge für Namen geheimer Gruppen wurde in 62 Zeichen geändert.