Vault-API
Wenn Sie bereits die HashiCorp-Vault-HTTP-API verwenden, können Sie das zugehörige API-Format und die zugehörigen Richtlinien verwenden, um mit IBM Cloud® Secrets Manager zu interagieren.
Um die Standard-REST-API für Secrets Manager zu verwenden, lesen Sie die Secrets Manager API-Referenz.
Übersicht
Secrets Manager verwendet HashiCorp Vault mit zusätzlicher Unterstützung für die IBM Cloud IAM Auth-Methode und eine Reihe von Secrets-Engines zur Unterstützung von Operationen in Secrets Manager für verschiedene Geheimnistypen.
Alle Operationen folgen den REST-API-Standards, die für die Vault-HTTP-APIs verfügbar sind. Weitere Informationen über die Authentifizierung und die Verwendung der Vault HTTP APIs finden Sie in der Vault-Dokumentation.
Secrets Manager beschränkt den Vault-Zugriff auf bestimmte Pfade, die Sie beim Arbeiten mit geheimen Schlüsseln und beim Anmelden bei Ihrer Instanz unterstützen. Alle anderen Pfade geben einen HTTP 403 Forbidden-Antwortstatuscode
zurück. Plug-ins und andere Komponenten, die von HashiCorp Vault angeboten werden, sind möglicherweise nicht über Secrets Manager zugänglich. Weitere Informationen finden Sie im Abschnitt zu häufig gestellten Fragen.
Endpunkt-URLs
Verwenden Sie für den Zugriff auf Secrets Manager unter Verwendung der Vault-APIs die dedizierte Endpunkt-URL, die für Ihre Secrets Manager-Serviceinstanz eindeutig ist.
Eine vollständige Liste der Endpunkt-URLs nach Region für öffentliche und private Konnektivität finden Sie unter Service-Endpunkte.
Sie können Ihren eindeutigen Endpunkt URL auch auf der Seite " Endpunkte" der Benutzeroberfläche Secrets Manager finden oder durch eine Anfrage an HTTP abrufen. Weitere Informationen finden Sie im Abschnitt zum Anzeigen von Endpunkt-URLs.
Allgemeine Header
In diesem Abschnitt werden die allgemeinen Header beschrieben, die allen Anforderungen gemeinsam sind.
| Überschrift | Beschreibung |
|---|---|
X-Vault-Token |
Erforderlich. Ein gültiges Vault-Token mit ausreichenden Berechtigungen für die Ausführung der Operation. |
Content-Type |
Erforderlich. application/json |
Zeitmarken
Die Zeitstempel in allen Anfragen und Antworten, wie z. B. Erstellungs- und Verfallsdatum, werden gemäß RFC 3339 formatiert. Beispiel:1985-04-12T23:20:50.52Z
Feldnamen
Diese API entspricht den Richtlinien der Vault-HTTP-API. Alle Feldnamen werden im Schlangenformat (snake_case) formatiert.
Anmeldung
Bei Vault anmelden
Nimmt eine Anmeldung bei Vault mithilfe eines IBM Cloud-IAM-Tokens vor und ruft ein Vault-Token mit zugeordneten Richtlinien ab.
| Anforderungsparameter | Beschreibung |
|---|---|
token |
Erforderlich. Ihr IBM Cloud IAM-Zugriffstoken. |
Beispielanforderung
curl -X PUT "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/auth/ibmcloud/login" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"token": "{IAM_token}"
}'
Beispielantwort
{
"request_id": "d9a41bfe-b8ba-8709-f1be-6dbdbc305e07",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": null,
"wrap_info": null,
"warnings": null,
"auth": {
"client_token": "s.w6vmYTRuEJdzEvVFVYjIEAYG",
"accessor": "5m6VpELSK42N3sq0yTEuVhn5",
"policies": [
"default",
"instance-reader"
],
"token_policies": [
"default",
"instance-reader"
],
"metadata": {
"bss_acc": "791f5fb10986423e97aa8512f18b7e65",
"grant_type": "urn:ibm:params:oauth:grant-type:apikey",
"name": "secrets-manager-test-reader",
"resource": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e::",
"user": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0"
},
"lease_duration": 3600,
"renewable": true,
"entity_id": "336f5725-b98d-e0c6-921a-6041e2d3157d",
"token_type": "service",
"orphan": true
}
}
Anmeldetoken konfigurieren
Konfiguriert die Dauer oder TTL (Time-To-Live) und die Lebensdauer (MaxTTL) eines Vault-Anmeldetokens.
Verwenden Sie eine Dauerzeichenfolge wie 300s oder 2h45m. Gültige Zeiteinheiten sind s, m und h. Das IBM Cloud -Plug-in 'auth' setzt die Standarddauer (TTL) für Anmeldetoken
auf 1 Stunde und die Standardlebensdauer (MaxTTL) auf 24 Stunden.
| Anforderungsparameter | Beschreibung |
|---|---|
token_max_ttl |
Die maximale Lebensdauer des Anmeldetokens. Der Standardwert ist 24h. Dieser Wert darf den Vaultwert MaxLeaseTTL nicht überschreiten. |
token_ttl |
Die zu Anfang festgelegte Dauer (Time-to-Live, TTL) des Anmeldetokens, das generiert werden soll. Der Standardwert ist 1h. |
Beispielanforderung
curl -X PUT "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/auth/ibmcloud/manage/login" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault_token}' \
-H 'Content-Type: application/json' \
-d '{
"token_ttl": "30m",
"token_max_ttl": "2h"
}'
Beispielantwort
Diese Operation gibt HTTP 204 No Content zurück.
Konfiguration eines Anmeldetokens abrufen
Ruft die Anmeldekonfiguration eines Vault-Tokens ab.
Beispielanforderung
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/auth/ibmcloud/manage/login" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Beispielantwort
{
"request_id": "41bc89dc-c950-113f-aa8f-a025646d2975",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"login": {
"token_max_ttl": "2h0m0s",
"token_ttl": "30m0s"
}
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Gruppen geheimer Schlüssel
Gruppe geheimer Schlüssel erstellen
Erstellt eine Gruppe geheimer Schlüssel.
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Erforderlich. Ein lesbarer Aliasname, den Sie der Gruppe geheimer Schlüssel zuweisen möchten. |
description |
Eine erweiterte Beschreibung der Gruppe von geheimen Schlüsseln. |
Beispielanforderung
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/auth/ibmcloud/manage/groups" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-secret-group",
"description": "Extended description for my secret group."
}'
Beispielantwort
{
"request_id": "f0e47267-940e-1a59-8742-e4e77401b06b",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"creation_date": "2020-12-15T22:08:46Z",
"description": "Extended description for my secret group.",
"id": "2bcaa289-5d38-aa57-910d-970e418ab1b3",
"last_update_date": "2020-12-15T22:08:46Z",
"name": "test-secret-group",
"type": "application/vnd.ibm.secrets-manager.secret.group+json"
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Gruppen geheimer Schlüssel auflisten
Listet die Gruppen geheimer Schlüssel auf, die in Ihrer Secrets Manager -Serviceinstanz verfügbar sind.
Beispielanforderung
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/auth/ibmcloud/manage/groups" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Beispielantwort
{
"request_id": "7ecc32f2-b78b-9290-015c-24803a1e87c9",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"groups": [
{
"creation_date": "2020-12-14T14:48:55Z",
"description": "Read and write to Cloud Object storage buckets.",
"id": "714e070d-8122-6270-198c-fef9166729e3",
"last_update_date": "2020-12-14T14:48:55Z",
"name": "cloud-object-storage-writers",
"type": "application/vnd.ibm.secrets-manager.secret.group+json"
},
{
"creation_date": "2020-12-15T22:08:46Z",
"description": "Extended description for my secret group.",
"id": "2bcaa289-5d38-aa57-910d-970e418ab1b3",
"last_update_date": "2020-12-15T22:08:46Z",
"name": "test-secret-group",
"type": "application/vnd.ibm.secrets-manager.secret.group+json"
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Gruppe geheimer Schlüssel aktualisieren
Aktualisiert die Details einer vorhandenen Gruppe geheimer Schlüssel.
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Erforderlich. Ein lesbarer Aliasname, den Sie der Gruppe geheimer Schlüssel zuweisen möchten. |
description |
Eine erweiterte Beschreibung der Gruppe von geheimen Schlüsseln. |
Beispielanforderung
curl -X PUT "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/auth/ibmcloud/manage/groups/{group_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "updated-secret-group-name",
"description": "Updated description for my secret group"
}'
Beispielantwort
{
"request_id": "b02c5035-9da1-85fe-b7c7-3db2c77ddbb6",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"creation_date": "2020-12-15T22:08:46Z",
"description": "Updated description for my secret group.",
"id": "2bcaa289-5d38-aa57-910d-970e418ab1b3",
"last_update_date": "2020-12-15T22:16:32Z",
"name": "updated-secret-group-name",
"type": "application/vnd.ibm.secrets-manager.secret.group+json"
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Gruppe geheimer Schlüssel abrufen
Ruft eine Gruppe geheimer Schlüssel und ihre Details ab.
Beispielanforderung
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/auth/ibmcloud/manage/groups/{group_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Beispielantwort
{
"request_id": "0d127ae6-8359-bc36-af53-3a56be4c3e24",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"creation_date": "2020-12-15T22:08:46Z",
"description": "Updated description for my secret group.",
"id": "2bcaa289-5d38-aa57-910d-970e418ab1b3",
"last_update_date": "2020-12-15T22:18:44Z",
"name": "updated-secret-group-name",
"type": "application/vnd.ibm.secrets-manager.secret.group+json"
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Gruppe geheimer Schlüssel löschen
Löscht eine Gruppe geheimer Schlüssel.
Beispielanforderung
curl -X DELETE "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/auth/ibmcloud/manage/groups/{group_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Beispielantwort
{
"request_id": "37065859-3238-f671-941f-d43ac340ad99",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": null,
"wrap_info": null,
"warnings": null,
"auth": null
}
Geheime Schlüssel
Geheimen Schlüssel erstellen
Erstellt oder importiert einen geheimen Schlüssel unter Verwendung der Secrets Manager-Engines für geheime Schlüssel. Sie können einen der folgenden Typen geheimer Schlüssel hinzufügen:
- Beliebige geheime Schlüssel (
arbitrary) - IAM-Berechtigungsnachweise (
iam_credentials) - Geheime Schlüssel/Wert-Schlüssel (
kv) - Benutzerberechtigungsnachweise (
user_credentials) - Importierte Zertifikate (
import_cert) - Private Zertifikate (
private_cert) - Öffentliche Zertifikate (
public_cert) - Serviceberechtigungsnachweise (
service_credentials) - Benutzerdefinierte Berechtigungsnachweise (
custom_credentials)
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Erforderlich. Ein lesbarer Aliasname, den Sie dem geheimen Schlüssel zuweisen möchten. |
description |
Eine erweiterte Beschreibung des geheimen Schlüssels. |
payload |
Erforderlich. Die Daten des geheimen Schlüssels, die dem geheimen Schlüssel zugeordnet werden sollen. |
expiration_date |
Das Verfallsdatum, das Sie dem geheimen Schlüssel zuordnen möchten. Das Datumsformat folgt RFC 3339. |
labels[] |
Beschriftungen, die Sie zum Filtern von geheimen Schlüsseln in Ihrer Instanz verwenden können. Es können bis zu 30 Beschriftungen hinzugefügt werden. |
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Erforderlich. Ein lesbarer Aliasname, den Sie dem geheimen Schlüssel zuweisen möchten. |
description |
Eine erweiterte Beschreibung des geheimen Schlüssels. |
access_groups[] |
Erforderlich. Die Zugriffsgruppen, die die Funktionen der Service-ID und des API-Schlüssels definieren, die für den geheimen Schlüssel iam_credentials generiert werden. |
ttl |
Erforderlich. Die Lebensdauer (Time-to-Live, TTL) oder die Dauer des Leasingverhältnisses, die den generierten Berechtigungsnachweisen zugeordnet werden soll. Der Wert kann eine ganze Zahl sein, die die Anzahl der Sekunden
angibt, oder die Zeichenfolgedarstellung einer Dauer, wie z. B. 120m oder 24h. |
labels[] |
Beschriftungen, die Sie zum Filtern von geheimen Schlüsseln in Ihrer Instanz verwenden können. Es können bis zu 30 Beschriftungen hinzugefügt werden. |
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Erforderlich. Ein lesbarer Aliasname, den Sie dem geheimen Schlüssel zuweisen möchten. |
description |
Eine erweiterte Beschreibung des geheimen Schlüssels. |
payload |
Erforderlich. Die Daten des geheimen Schlüssels im JSON-Format, die dem geheimen Schlüssel zugewiesen werden sollen. Die maximale Dateigröße beträgt 512 KB. |
labels[] |
Beschriftungen, die Sie zum Filtern von geheimen Schlüsseln in Ihrer Instanz verwenden können. Es können bis zu 30 Beschriftungen hinzugefügt werden. |
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Erforderlich. Ein lesbarer Aliasname, den Sie dem geheimen Schlüssel zuweisen möchten. |
description |
Eine erweiterte Beschreibung des geheimen Schlüssels. |
username |
Erforderlich. Der Benutzername, der dem geheimen Schlüssel zugeordnet werden soll. |
password |
Das Kennwort, das dem geheimen Schlüssel zugeordnet werden soll. |
expiration_date |
Das Verfallsdatum, das Sie dem geheimen Schlüssel zuordnen möchten. Das Datumsformat folgt RFC 3339. |
labels[] |
Beschriftungen, die Sie zum Filtern von geheimen Schlüsseln in Ihrer Instanz verwenden können. Es können bis zu 30 Beschriftungen hinzugefügt werden. |
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Erforderlich. Ein lesbarer Aliasname, den Sie dem geheimen Schlüssel zuweisen möchten. |
description |
Eine erweiterte Beschreibung des geheimen Schlüssels. |
certificate |
Erforderlich. Die Zertifikatsdaten, die einem geheimen Schlüssel imported_cert zugeordnet werden sollen. |
private_key |
Der übereinstimmende private Schlüssel, der einem geheimen imported_cert-Schlüssel zugeordnet werden soll. |
intermediate |
Die Daten des Zwischenzertifikats, die einem geheimen import_cert-Schlüssel zugeordnet werden sollen. |
labels[] |
Beschriftungen, die Sie zum Filtern von geheimen Schlüsseln in Ihrer Instanz verwenden können. Es können bis zu 30 Beschriftungen hinzugefügt werden. |
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Erforderlich. Ein lesbarer Aliasname, den Sie dem geheimen Schlüssel zuweisen möchten. |
description |
Eine erweiterte Beschreibung des geheimen Schlüssels. |
certificate_template |
Erforderlich. Der Name der Zertifikatsvorlage. |
common_name |
Der vollständig qualifizierte Domänenname oder Hostdomänenname für das Zertifikat. |
labels[] |
Beschriftungen, die Sie zum Filtern von geheimen Schlüsseln in Ihrer Instanz verwenden können. Es können bis zu 30 Beschriftungen hinzugefügt werden. |
alt_names |
Die alternativen Subjektnamen, die für das Zertifikat definiert werden sollen, in einer durch Kommas begrenzten Liste. |
ip_sans |
Die alternativen IP-Subjektnamen, die für das Zertifikat definiert werden sollen, in einer durch Kommas begrenzten Liste. |
uri_sans |
Die alternativen URI-Subjektnamen, die für das Zertifikat definiert werden sollen, in einer durch Kommas begrenzten Liste. |
other_sans |
Die angepasste Objekt-ID (OID) oder UTF8-string Subject Alternative Names, die für das Zertifikat definiert werden sollen.
Die alternativen Namen müssen mit den Werten übereinstimmen, die im Feld |
ttl |
Die Lebensdauer (TTL, Time-to-Live), die einem privaten Zertifikat zugeordnet wird.
Der Wert kann als String-Darstellung einer Dauer in Stunden angegeben werden, zum Beispiel ' 12h '. Der Wert darf die |
format |
Das Format der zurückgegebenen Daten. Zulässige Werte: pem, pem_bundle. Standardwert: pem |
auto_rotate |
Legt fest, ob Secrets Manager Ihr Zertifikat automatisch rotiert. Bei privaten Zertifikaten wird das Zertifikat entsprechend dem in den Feldern interval und unit angegebenen Zeitintervall rotiert. |
interval |
Wird zusammen mit dem Feld unit verwendet, um das Rotationsintervall anzugeben. Das Mindestintervall beträgt einen Tag und das maximale Intervall beträgt 3 Jahre (1095 Tage). Erforderlich, wenn auto_rotate auf
true gesetzt ist. |
unit |
Die Zeiteinheit des Rotationsintervalls. Zulässige Werte: day, month |
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Erforderlich. Ein lesbarer Aliasname, den Sie dem geheimen Schlüssel zuweisen möchten. |
description |
Eine erweiterte Beschreibung des geheimen Schlüssels. |
ca |
Erforderlich. Der Name der Konfiguration der Zertifizierungsstelle. |
dns |
Erforderlich. Der Name der DNS-Providerkonfiguration. |
common_name |
Erforderlich. Der vollständig qualifizierte Domänenname oder Hostdomänenname für das Zertifikat. |
alt_names[] |
Die alternativen Namen, die für das Zertifikat definiert werden sollen. |
bundle_certs |
Legt fest, ob Ihr ausgestelltes Zertifikat mit Zwischenzertifikaten gebündelt wird.
Setzen Sie diese Option auf |
key_algorithm |
Die Kennung für den Verschlüsselungsalgorithmus, der zum Generieren des öffentlichen Schlüssels verwendet werden soll, der dem Zertifikat zugeordnet ist.
Zulässige Werte: |
auto_rotate |
Legt fest, ob Secrets Manager Ihr Zertifikat automatisch rotiert.
Wenn Sie die Option |
rotate_keys |
Legt fest, ob Secrets Manager den privaten Schlüssel für Ihr Zertifikat automatisch rotiert. Wenn der Wert auf true gesetzt ist, generiert und speichert der Service einen neuen privaten Schlüssel für Ihr rotiertes Zertifikat.
Standardwert:false |
labels[] |
Beschriftungen, die Sie zum Filtern von geheimen Schlüsseln in Ihrer Instanz verwenden können. Es können bis zu 30 Beschriftungen hinzugefügt werden. |
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Erforderlich. Ein lesbarer Aliasname, den Sie dem geheimen Schlüssel zuweisen möchten. |
source_crn |
Erforderlich. Der CRN der Quellenserviceinstanz. |
role |
Erforderlich. Der Name der IAM-Servicerolle für die Berechtigungsstufe, die Sie zuweisen möchten |
ttl |
Die Lebensdauer (TTL, Time-to-Live), die den Berechtigungsnachweisen zugeordnet wird Die Zeit kann in Tagen angegeben werden. |
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Erforderlich. Ein lesbarer Aliasname, den Sie dem geheimen Schlüssel zuweisen möchten. |
description |
Eine erweiterte Beschreibung des geheimen Schlüssels. |
configuration |
Erforderlich. Der Name der Konfiguration für benutzerdefinierte Berechtigungsnachweise. |
parameters |
Erforderlich. Die für die Konfiguration der benutzerdefinierten Anmeldeinformationen erforderlichen Parameter im JSON-Format. |
labels[] |
Beschriftungen, die Sie zum Filtern von geheimen Schlüsseln in Ihrer Instanz verwenden können. Es können bis zu 30 Beschriftungen hinzugefügt werden. |
auto_rotate |
Legt fest, ob Secrets Manager Ihr Geheimnis automatisch rotieren soll. |
interval |
Wird zusammen mit dem Feld unit verwendet, um das Rotationsintervall anzugeben. Erforderlich, wenn auto_rotate auf true eingestellt ist. |
unit |
Die Zeiteinheit des Rotationsintervalls. Zulässige Werte: day, month |
Beispielanforderungen
Erstellen Sie einen beliebigen geheimen Schlüssel in der default-Gruppe geheimer Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-arbitrary-secret",
"description": "Extended description for my secret.",
"payload": "secret-data",
"labels": [
"dev",
"us-south"
],
"expiration_date": "2030-04-01T09:30:00Z"
}'
Erstellen Sie einen beliebigen geheimen Schlüssel in einer vorhandenen Gruppe geheimer Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets/groups/{group_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-arbitrary-secret-in-group",
"description": "Extended description for my secret.",
"payload": "secret-data",
"labels": [
"dev",
"us-south"
],
"expiration_date": "2030-04-01T09:30:00Z"
}'
Erstellen Sie IAM-Berechtigungsnachweise in der Gruppe geheimer Schlüssel default.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/iam_credentials/roles/{secret_name}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-iam-credentials",
"description": "Extended description for my secret.",
"access_groups": [
"AccessGroupId-0529f490-129c-4877-a2a0-b57f50d3e53b"
],
"labels": [
"dev",
"us-south"
],
"ttl": "30m"
}'
Erstellen Sie IAM-Berechtigungsnachweise in einer vorhandenen Gruppe.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/iam_credentials/roles/groups/{group_id}/{secret_name}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-iam-credentials-in-group",
"description": "Extended description for my secret.",
"access_groups": [
"AccessGroupId-0529f490-129c-4877-a2a0-b57f50d3e53b"
],
"labels": [
"dev",
"us-south"
],
"ttl": "30m"
}'
Erstellen Sie einen geheimen Schlüssel/Wert-Schlüssel in der default-Gruppe geheimer Schlüssel. Weitere Informationen.
curl -X POST 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/kv/secrets' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-kv-secret",
"description": "Extended description for my secret.",
"payload": {
"key1": "value1"
},
"labels": [
"dev",
"us-south"
]
}'
Erstellen Sie einen geheimen Schlüssel/Wert-Schlüssel in einer vorhandenen Gruppe geheimer Schlüssel.
curl -X POST 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/kv/secrets/groups/{group_id}' \
-H 'Accept: application/json/groups/{group_id}' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-kv-secret",
"description": "Extended description for my secret.",
"payload": {
"key1": "value1"
},
"labels": [
"dev",
"us-south"
]
}'
Erstellen Sie Benutzerberechtigungsnachweise in der default-Gruppe geheimer Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/secrets" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-username-password",
"description": "Extended description for my secret.",
"username": "user123",
"password": "cloudy-rainy-coffee-book",
"expiration_date": "2020-12-31T00:00:00Z",
"labels": [
"dev",
"us-south"
]
}'
Erstellen Sie Benutzerberechtigungen in einer vorhandenen Gruppe geheimer Schlüssel:
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/secrets/groups/{group_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-username-password-in-group",
"description": "Extended description for my secret.",
"username": "user123",
"password": "cloudy-rainy-coffee-book",
"expiration_date": "2020-12-31T00:00:00Z",
"labels": [
"dev",
"us-south"
]
}'
Importieren Sie ein SSL/TLS-Zertifikat und ordnen Sie es der Gruppe geheimer Schlüssel default zu.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/imported_cert/secrets" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-imported-certificate",
"description": "Extended description for my secret."
"certificate": "-----BEGIN CERTIFICATE-----\nMIICWzCCAcQCC...(redacted)",
"private_key": "-----BEGIN PRIVATE KEY-----\nMIICdgIBADANB...(redacted)",
"intermediate": "-----BEGIN CERTIFICATE-----\nMIICUzHHraOa...(redacted)",
"labels": [
"dev",
"us-south"
]
}'
Importieren Sie ein SSL/TLS-Zertifikat und ordnen Sie es einer vorhandenen Gruppe geheimer Schlüssel zu.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/imported_cert/secrets/groups/{group_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-imported-certificate-in-group",
"description": "Extended description for my secret."
"certificate": "-----BEGIN CERTIFICATE-----\nMIICWzCCAcQCC...(redacted)",
"private_key": "-----BEGIN PRIVATE KEY-----\nMIICdgIBADANB...(redacted)",
"intermediate": "-----BEGIN CERTIFICATE-----\nMIICUzHHraOa...(redacted)",
"labels": [
"dev",
"us-south"
]
}'
Bestellen Sie ein öffentliches SSL/TLS-Zertifikat und weisen Sie es der Gruppe geheimer Schlüssel default zu.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/public_cert/secrets" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-public-certificate-in-group",
"description": "Extended description for my secret.",
"ca": "my-configured-certificate-authority",
"dns": "my-configured-dns-provider",
"common_name": "example.com",
"alt_names": [
"www.example.com"
],
"labels": [
"dev",
"us-south"
],
"bundle_certs": false,
"key_algorithm": "RSA2048",
"rotation": {
"auto_rotate": false,
"rotate_keys": false
}
}'
Bestellen Sie ein öffentliches SSL/TLS-Zertifikat und weisen Sie es einer vorhandenen Gruppe geheimer Schlüssel zu.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/public_cert/secrets/groups/{group_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-public-certificate-in-group",
"description": "Extended description for my secret.",
"ca": "my-configured-certificate-authority",
"dns": "my-configured-dns-provider",
"common_name": "example.com",
"alt_names": [
"www.example.com"
],
"labels": [
"dev",
"us-south"
],
"bundle_certs": false,
"key_algorithm": "RSA2048",
"rotation": {
"auto_rotate": false,
"rotate_keys": false
}
}'
Erstellen Sie ein privates SSL/TLS-Zertifikat und ordnen Sie es der Gruppe geheimer Schlüssel default zu.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/private_cert/secrets" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-private-certificate",
"description": "Extended description for my secret.",
"certificate_template": "my-configured-certificate-template",
"common_name": "example.com",
"alt_names": [
"www.example.com"
],
"labels": [
"dev",
"us-south"
],
"rotation": {
"auto_rotate": true,
"interval": 90,
"unit": day
}
}'
Erstellen Sie ein privates SSL/TLS-Zertifikat und ordnen Sie es einer vorhandenen Gruppe geheimer Schlüssel zu.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/private_cert/secrets/groups/{group_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-private-certificate",
"description": "Extended description for my secret.",
"certificate_template": "my-configured-certificate-template",
"common_name": "example.com",
"alt_names": [
"www.example.com"
],
"labels": [
"dev",
"us-south"
],
"rotation": {
"auto_rotate": true,
"interval": 90,
"unit": day
}
}'
Erstellen oder importieren Sie einen Satz von Dienstanmeldeinformationen.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/service_credentials/secrets" \
-H 'Accept: application/json' \
-H "X-Vault-Token: $VAULT_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"name": "test-sc-secret",
"source_crn":"crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675bc::",
"role":"crn:v1:bluemix:public:iam::::serviceRole:Manager",
"ttl":"90d"
}' | jq
Erstellen Sie ein benutzerdefiniertes Geheimnis für Anmeldeinformationen in der Gruppe default secret.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/custom_credentials/secrets" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-custom-credentials-secret",
"description": "Extended description for my custom credentials secret.",
"configuration": "my-custom-credentials-config",
"parameters": {
"username": "user@example.com",
"api_key": "example-api-key"
},
"labels": [
"dev",
"us-south"
],
"rotation": {
"auto_rotate": true,
"interval": 30,
"unit": "day"
}
}'
Erstellen Sie ein benutzerdefiniertes Zugangsdatengeheimnis in einer bestehenden Geheimhaltungsgruppe.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/custom_credentials/secrets/groups/{group_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-custom-credentials-secret-in-group",
"description": "Extended description for my custom credentials secret.",
"configuration": "my-custom-credentials-config",
"parameters": {
"username": "user@example.com",
"api_key": "example-api-key"
},
"labels": [
"dev",
"us-south"
],
"rotation": {
"auto_rotate": true,
"interval": 30,
"unit": "day"
}
}'
Beispielantworten
Eine Anforderung zum Erstellen eines beliebigen geheimen Schlüssels in der default-Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "8c047529-de3a-a79d-7c2f-c382a8e75312",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-15T22:34:53Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:a6972127-35ad-b36f-aac8-0223f0475cb6",
"description": "Extended description for my secret.",
"expiration_date": "2030-04-01T09:30:00Z",
"id": "a6972127-35ad-b36f-aac8-0223f0475cb6",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2020-12-15T22:34:53Z",
"name": "test-arbitrary-secret-in-group",
"secret_data": {
"payload": "secret-data"
},
"secret_group_id": "339c026a-ac0f-1ea1-3d43-99adf871b49a",
"secret_type": "arbitrary",
"state": 1,
"state_description": "Active",
"versions": [
{
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-15T22:34:53Z",
"id": "a7f55e6f-b068-977b-062e-4de644633982"
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Erstellen einer beliebigen Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "8c047529-de3a-a79d-7c2f-c382a8e75312",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-15T22:34:53Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:a6972127-35ad-b36f-aac8-0223f0475cb6",
"description": "Extended description for my secret.",
"expiration_date": "2030-04-01T09:30:00Z",
"id": "a6972127-35ad-b36f-aac8-0223f0475cb6",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2020-12-15T22:34:53Z",
"name": "test-arbitrary-secret-in-group",
"secret_data": {
"payload": "secret-data"
},
"secret_group_id": "339c026a-ac0f-1ea1-3d43-99adf871b49a",
"secret_type": "arbitrary",
"state": 1,
"state_description": "Active",
"versions": [
{
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-15T22:34:53Z",
"id": "a7f55e6f-b068-977b-062e-4de644633982"
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Erstellen von IAM-Berechtigungsnachweisen in der default-Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "3bef24c5-5ab9-72f4-8a1a-dd35a6e7aa15",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"access_groups": [
"AccessGroupId-0529f490-129c-4877-a2a0-b57f50d3e53b"
],
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-16T21:34:51Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:8bc5eae8-e5b7-9599-de8e-525d1c3e2723",
"description": "Extended description for my secret.",
"id": "8bc5eae8-e5b7-9599-de8e-525d1c3e2723",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2020-12-16T21:34:51Z",
"name": "test-iam-credentials",
"secret_type": "iam_credentials",
"state": 1,
"state_description": "Active",
"ttl": 1800
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Erstellen von IAM-Berechtigungsnachweisen in einer vorhandenen Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "2278a441-6dbe-5ee8-4a4b-3b5b1e814231",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"access_groups": [
"AccessGroupId-0529f490-129c-4877-a2a0-b57f50d3e53b"
],
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-16T21:57:13Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:99425779-0707-4877-81CB-ca11e28b6ef1",
"description": "Extended description for my secret.",
"id": "99425779-0707-4877-81CB-ca11e28b6ef1",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2020-12-16T21:57:13Z",
"name": "test-iam-credentials-in-group",
"secret_group_id": "714e070d-8122-6270-198c-fef9166729e3",
"secret_type": "iam_credentials",
"state": 1,
"state_description": "Active",
"ttl": 1800
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Erstellen von geheimen Schlüssel/Wert-Schlüsseln in der default-Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "6e0000-60c0-d0ef-bc00-000c0a000b00",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "iam-ServiceId-9ca407-f38d-000e-0b02-ed6b41",
"creation_date": "2022-01-25T19:22:59Z",
"crn": "crn:v1:bluemix:public:secrets-manager:eu-gb:a/0000000be376647f5f961f5:50004-5f59-4164-8bfc-5000cf66:secret:43f000f-4085-000c-c028-6ff00004dbd",
"description": "Extended description for my secret.",
"downloaded": false,
"id": "40000df-4000-300c-c01028-6ff20000dbd",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2022-01-25T19:22:59Z",
"name": "test-kv-secret",
"secret_data": {
"payload": {
"key1": "value1"
}
},
"secret_type": "kv",
"state": 1,
"state_description": "Active",
"versions": [
{
"created_by": "iam-ServiceId-9ca407-f38d-000e-0b02-ed6b41",
"creation_date": "2022-01-25T19:22:59Z",
"downloaded": false,
"id": "40000df-4000-300c-c01028-6ff20000dbd",
"payload_available": true
}
],
"versions_total": 1
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Erstellen von geheimen Schlüssel/Wert-Schlüsseln in einer vorhandenen Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "a0766ef6-5bfe-d92d-4894-6d3f40126b25",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "iam-ServiceId-9ca24407-f38d-479e-8b02-ed6b4e1b0d31",
"creation_date": "2022-01-27T17:59:20Z",
"crn": "crn:v1:bluemix:public:secrets-manager:eu-gb:a/4b85ea6bbea644a6be376647f5f961f5:5f1a3554-5f59-4164-8bfc-5eef0a20cf66:secret:21764466-5a9d-a9df-fc71-5b8ee4ecbb99",
"description": "Extended description for my secret.",
"downloaded": false,
"id": "21764466-5a9d-a9df-fc71-5b8ee4ecbb99",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2022-01-27T17:59:20Z",
"name": "test-kv-secret6",
"secret_data": {
"payload": {
"key6": "value6"
}
},
"secret_group_id": "aded5ffd-da17-c923-eb21-600569c5d1c2",
"secret_type": "kv",
"state": 1,
"state_description": "Active",
"versions": [
{
"created_by": "iam-ServiceId-9ca24407-f38d-479e-8b02-ed6b4e1b0d31",
"creation_date": "2022-01-27T17:59:20Z",
"downloaded": false,
"id": "96d5b7dd-d8fb-5afc-9c05-6cfdaff8af9e",
"payload_available": true
}
],
"versions_total": 1
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Erstellen von Benutzerberechtigungsnachweisen in der default-Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "96fc9603-5aff-5daa-f25c-efc3599b374b",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-15T22:43:36Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:2bd4c8fc-c1e4-f9d7-8026-6c04610f051f",
"description": "Extended description for my secret.",
"expiration_date": "2020-12-31T00:00:00Z",
"id": "2bd4c8fc-c1e4-f9d7-8026-6c04610f051f",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2020-12-15T22:43:36Z",
"name": "test-username-password",
"secret_data": {
"password": "cloudy-rainy-coffee-book",
"username": "user123"
},
"secret_type": "username_password",
"state": 1,
"state_description": "Active",
"versions": [
{
"auto_rotated": false,
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-15T22:43:36Z",
"id": "ae4b3afd-5e63-5951-790b-f1892e8c5267"
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Erstellen von Benutzerberechtigungen in einer vorhandenen Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "4ccc9dd5-af3a-6865-293f-3f704d2866e1",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-15T22:46:41Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:be4a0846-4cb5-3bfa-bab5-10a44dfc3e85",
"description": "Extended description for my secret.",
"expiration_date": "2020-12-31T00:00:00Z",
"id": "be4a0846-4cb5-3bfa-bab5-10a44dfc3e85",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2020-12-15T22:46:41Z",
"name": "test-username-password-in-group",
"secret_data": {
"password": "cloudy-rainy-coffee-book",
"username": "user123"
},
"secret_group_id": "339c026a-ac0f-1ea1-3d43-99adf871b49a",
"secret_type": "username_password",
"state": 1,
"state_description": "Active",
"versions": [
{
"auto_rotated": false,
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-15T22:46:41Z",
"id": "a09c7a3c-13a5-7a17-fadc-e7850496d27a"
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Import eines Zertifikats in die default-Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "811b893b-55c7-b6bb-4e55-26a7a8362164",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"algorithm": "RSA",
"common_name": "example.com",
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2021-06-03T20:50:11Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:be4a0846-4cb5-3bfa-bab5-10a44dfc3e85",
"description": "Extended description for my secret.",
"expiration_date": "2021-06-04T15:25:44Z",
"id": "be4a0846-4cb5-3bfa-bab5-10a44dfc3e85",
"intermediate_included": false,
"issuer": "US Texas Austin Example Corp. Example Org example.com",
"key_algorithm": "SHA256-RSA",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2021-06-03T20:50:11Z",
"name": "test-imported-certificate-in-group",
"private_key_included": true,
"secret_type": "imported_cert",
"serial_number": "fc:22:29:7e:57:25:8a:05",
"state": 1,
"state_description": "Active",
"validity": {
"not_after": "2021-06-04T15:25:44Z",
"not_before": "2021-06-03T15:25:44Z"
},
"versions": [
{
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2021-06-03T20:50:11.278296706Z",
"expiration_date": "2021-06-04T15:25:44Z",
"id": "be4a0846-4cb5-3bfa-bab5-10a44dfc3e85",
"serial_number": "fc:22:29:7e:57:25:8a:05",
"validity": {
"not_after": "2021-06-04T15:25:44Z",
"not_before": "2021-06-03T15:25:44Z"
}
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Importieren eines Zertifikats in eine vorhandene geheime Gruppe gibt die folgende Antwort zurück:
{
"request_id": "811b893b-55c7-b6bb-4e55-26a7a8362164",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"algorithm": "RSA",
"common_name": "example.com",
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2021-06-03T20:50:11Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:be4a0846-4cb5-3bfa-bab5-10a44dfc3e85",
"description": "Extended description for my secret.",
"expiration_date": "2021-06-04T15:25:44Z",
"id": "be4a0846-4cb5-3bfa-bab5-10a44dfc3e85",
"intermediate_included": false,
"issuer": "US Texas Austin Example Corp. Example Org example.com",
"key_algorithm": "SHA256-RSA",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2021-06-03T20:50:11Z",
"name": "test-imported-certificate-in-group",
"private_key_included": true,
"secret_group_id": "339c026a-ac0f-1ea1-3d43-99adf871b49a",
"secret_type": "imported_cert",
"serial_number": "fc:22:29:7e:57:25:8a:05",
"state": 1,
"state_description": "Active",
"validity": {
"not_after": "2021-06-04T15:25:44Z",
"not_before": "2021-06-03T15:25:44Z"
},
"versions": [
{
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2021-06-03T20:50:11.278296706Z",
"expiration_date": "2021-06-04T15:25:44Z",
"id": "e4f44e8b-abe0-9267-88da-199e754f974a",
"serial_number": "fc:22:29:7e:57:25:8a:05",
"validity": {
"not_after": "2021-06-04T15:25:44Z",
"not_before": "2021-06-03T15:25:44Z"
}
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Erstellen oder Importieren einer Gruppe von Serviceberechtigungsnachweisen gibt die folgende Antwort zurück:
{
"request_id": "b7b8799c-e0f7-f31c-c050-3d66f854c214",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "IBMid-2723462DAH",
"creation_date": "2023-11-23T13:33:36Z",
"crn": "crn:v1:staging:public:secrets-manager:us-south:a/826aa2b9cab6c666477fc55ebc47bacc:e2c32ad4-1414-41e0-8747-e107e6b9f8e6:secret:c70951dd-f672-9995-968d-b76204b2432d",
"custom_metadata": {},
"downloaded": true,
"iam_apikey_description": "Auto-generated for key crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bacc:f85409e9-1a06-47d5-8320-95ed4e1675cc:resource-key:d13dd212-cd38-4732-a14e-1889ee3ca4fa",
"iam_apikey_id": "ApiKey-4fdabb94-2654-4ab7-8d01-fbf41117b4a9",
"iam_apikey_name": "test-sc-secret",
"iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
"iam_serviceid_crn": "crn:v1:staging:public:iam-identity::a/826aa2b9cab6c666477fc55ebc47bacc::serviceid:ServiceId-38fd1d20-db0b-4ae6-bee9-23d6468e149f",
"id": "c70951dd-f672-9995-968d-b76204b2432d",
"labels": [],
"last_update_date": "2023-11-23T13:33:36Z",
"locks_total": 0,
"name": "test-sc-secret",
"parameters": {},
"resource_key_crn": "crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bacc:f85409e9-1a06-47d5-8320-95ed4e1675cc:resource-key:d13dd212-cd38-4732-a14e-1889ee3ca4fa",
"resource_key_name": "test-sc-secret",
"role": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
"secret_data": {
"apikey": "xxxxxxxxxxxxxxxxxxxx",
"guid": "f85409e9-1a06-47d5-8320-95ed4e1675bc",
"iam_apikey_description": "Auto-generated for key crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bacc:f85409e9-1a06-47d5-8320-95ed4e1675cc:resource-key:d13dd212-cd38-4732-a14e-1889ee3ca4fa",
"iam_apikey_id": "ApiKey-4fdabb94-2654-4ab7-8d01-fbf41117b4a9",
"iam_apikey_name": "test-sc-secret",
"iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
"iam_serviceid_crn": "crn:v1:staging:public:iam-identity::a/826aa2b9cab6c666477fc55ebc47bacc::serviceid:ServiceId-38fd1d20-db0b-4ae6-bee9-23d6468e149f",
"instance_id": "f85409e9-1a06-47d5-8320-95ed4e1675cc",
"plan": "33b50df2-9cd6-4005-a941-bf0a59f0d133",
"region": "us-south"
},
"secret_type": "service_credentials",
"source_crn": "crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675cc::",
"state": 1,
"state_description": "Active",
"ttl": 7776000,
"versions": [
{
"created_by": "IBMid-2723462DAH",
"creation_date": "2023-11-23T13:33:36Z",
"downloaded": true,
"expiration_date": "2024-02-21T13:33:36Z",
"id": "1ab6e797-c74d-419d-0863-a8976b64efe8",
"payload_available": true,
"version_custom_metadata": {}
}
],
"versions_total": 1
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Geheimen Schlüssel abrufen
Wert eines geheimen Schlüssel abrufen. Zum Abrufen des geheimen Schlüssels kann entweder die ID oder der Name des geheimen Schlüssels verwendet werden.
Beispielanforderungen
Beliebigen geheimen Schlüssel abrufen.
curl -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets/{secret_id_or_secret_name}' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Rufen Sie einen beliebigen geheimen Schlüssel in einer vorhandenen Gruppe geheimer Schlüssel ab.
curl -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets/groups/{group_id}/{secret_id_or_secret_name}' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
IAM-Berechtigungsnachweise abrufen.
curl -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/iam_credentials/creds/{secret_id_or_secret_name}' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Rufen Sie IAM-Berechtigungsnachweise in einer vorhandenen Gruppe geheimer Schlüssel ab.
curl -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/iam_credentials/creds/groups/{group_id}/{secret_id_or_secret_name}' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Geheime Schlüssel/Wert-Schlüssel abrufen. Weitere Informationen.
curl -L -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/kv/secrets/{secret_id_or_secret_name}' \
-H 'Accept: application/json'\
-H 'X-Vault-Token: {Vault-Token}'
Geheime Schlüssel/Wert-Schlüssel in einer vorhandenen Gruppe geheimer Schlüssel abrufen.
curl -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/kv/secrets/groups/{group_id}/{secret_id_or_secret_name}' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Benutzerberechtigungsnachweise abrufen.
curl -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/secrets/{secret_id_or_secret_name}' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Abrufen der Benutzerberechtigungsnachweise in einer vorhandenen Gruppe von geheimen Schlüsseln.
curl -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/secrets/groups/{group_id}/{secret_id_or_secret_name}' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Ein importiertes Zertifikat abrufen.
curl -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/imported_cert/secrets/{secret_id_or_secret_name}' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Rufen Sie ein importiertes Zertifikat in einer vorhandenen Gruppe von geheimen Schlüsseln ab.
curl -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/imported_cert/secrets/groups/{group_id}/{secret_id_or_secret_name}' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Holen Sie sich eine Reihe von Dienstanmeldeinformationen.
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/service_credentials/secrets/{secret_id_or_secret_name}" \
-H 'Accept: application/json' \
-H "X-Vault-Token: $VAULT_TOKEN" | jq
Benutzerdefinierte Berechtigungsnachweise abrufen.
curl -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/custom_credentials/secrets/{secret_id_or_secret_name}' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Abrufen von benutzerdefinierten Berechtigungsnachweisen in einer bestehenden geheimen Gruppe.
curl -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/custom_credentials/secrets/groups/{group_id}/{secret_id_or_secret_name}' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Beispielantworten
Eine Anforderung zum Abrufen eines beliebigen geheimen Schlüssels gibt die folgende Antwort zurück:
{
"request_id": "463e84e8-3a0c-1061-1a6e-6ce1434c7ba2",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-16T20:54:52Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:582a8f65-9a2b-a072-4fc3-e69ff3462c23",
"description": "Extended description for my secret.",
"expiration_date": "2030-04-01T09:30:00Z",
"id": "582a8f65-9a2b-a072-4fc3-e69ff3462c23",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2020-12-16T20:54:52Z",
"name": "test-arbitrary-secret",
"secret_data": {
"payload": "secret-data"
},
"secret_type": "arbitrary",
"state": 1,
"state_description": "Active",
"versions": [
{
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-16T20:54:52Z",
"id": "03d9ddb3-aa1d-d929-40c8-04027213ef08"
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
A request to retrieve an arbitrary secret in an existing secret group returns the following response:
{
"request_id": "791340bd-5664-c1e3-e779-d1391494f55d",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-15T22:34:53Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:a6972127-35ad-b36f-aac8-0223f0475cb6",
"description": "Extended description for my secret.",
"expiration_date": "2030-04-01T09:30:00Z",
"id": "a6972127-35ad-b36f-aac8-0223f0475cb6",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2020-12-15T22:34:53Z",
"name": "test-arbitrary-secret-in-group",
"secret_data": {
"payload": "secret-data"
},
"secret_group_id": "339c026a-ac0f-1ea1-3d43-99adf871b49a",
"secret_type": "arbitrary",
"state": 1,
"state_description": "Active",
"versions": [
{
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-15T22:34:53Z",
"id": "a7f55e6f-b068-977b-062e-4de644633982"
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Generieren von IAM-Berechtigungsnachweisen gibt die folgende Antwort zurück:
{
"request_id": "c9716624-669f-2ef4-5560-a5d4e6618826",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"access_groups": [
"AccessGroupId-0529f490-129c-4877-a2a0-b57f50d3e53b"
],
"api_key": "U40hERZ0h-0C0cnka2bEuL2y...(redacted)",
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-16T21:55:31Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:d7a2b83f-997c-4914-857a-86bfcdbf0873",
"description": "Extended description for my secret.",
"id": "d7a2b83f-997c-4914-857a-86bfcdbf0873",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2020-12-16T22:05:16Z",
"name": "test-iam-credentials",
"secret_type": "iam_credentials",
"service_id": "ServiceId-43c79ec9-7f02-481d-92f1-e60363483298",
"state": 1,
"state_description": "Active",
"ttl": 1800
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Generieren von IAM-Berechtigungsnachweisen in einer vorhandenen Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "201eaa80-d5f1-2697-66dd-481d94a52685",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"access_groups": [
"AccessGroupId-0529f490-129c-4877-a2a0-b57f50d3e53b"
],
"api_key": "CFQY6wWPI3C3wKx6XLC9p0c3e...(redacted)",
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-16T21:57:13Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:99425779-0707-4877-81CB-ca11e28b6ef1",
"description": "Extended description for my secret.",
"id": "99425779-0707-4877-81CB-ca11e28b6ef1",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2020-12-16T22:07:20Z",
"name": "test-iam-credentials-in-group",
"secret_group_id": "714e070d-8122-6270-198c-fef9166729e3",
"secret_type": "iam_credentials",
"service_id": "ServiceId-d1a99978-2108-4eec-9dae-bdf5691e7136",
"state": 1,
"state_description": "Active",
"ttl": 1800
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Abrufen eines geheimen Schlüssel/Wert-Schlüssels gibt die folgende Antwort zurück:
{
"request_id": "1e0000-7100-cb00b-d00a-b350000f5a",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "iam-ServiceId-9c00000-00d-000e-8000-ed6b40000",
"creation_date": "2022-01-25T19:22:04Z",
"crn": "crn:v1:bluemix:public:secrets-manager:eu-gb:a/4b85000004a6be3700000f5:5f1000-5f00-4000-8bfc-5e0000f66:secret:0000ea8e-7d00-69ce-c000a-0a00000b3ee",
"description": "Extended description for my secret.",
"downloaded": true,
"id": "00002ea8e-7lk90-00ce-c200a-00004b3ee",
"labels": [],
"last_update_date": "2022-01-25T19:22:04Z",
"name": "test-kv-secret",
"secret_data": {
"payload": {
"key1": "value1"
}
},
"secret_type": "kv",
"state": 1,
"state_description": "Active",
"versions": [
{
"created_by": "iam-ServiceId-000000-f000d-479e-8b02-ed600000",
"creation_date": "2022-01-25T19:22:04Z",
"downloaded": true,
"id": "bf00007-800dc-0006-14d9-a7c720000bh",
"payload_available": true
}
],
"versions_total": 1
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Abrufen eines geheimen Schlüssel/Wert-Schlüssels in einer vorhandenen Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "a0000c-e00-000ef-d000e8-a68e60000",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "Id-000000",
"creation_date": "2022-01-26T20:11:29Z",
"crn": "crn:v1:bluemix:public:secrets-manager:eu-gb:a/4b0000a6bbe:5f1a3554-5f59-4164-8bfc-5e0000000cf66:secret:e006e8bc-f497-dc93-4102-9d0000001",
"description": "Extended description for my secret.",
"downloaded": true,
"id": "e00000c-f0000-d0003-00002-9d9cf2000001",
"labels": [],
"last_update_date": "2022-01-26T20:11:29Z",
"name": "test-kv-secret-from-group",
"secret_data": {
"payload": {
"key5": "value5"
}
},
"secret_group_id": "0000ffd-da17-c0000-eb0000-600000002",
"secret_type": "kv",
"state": 1,
"state_description": "Active",
"versions": [
{
"created_by": "Id-0000000",
"creation_date": "2022-01-26T20:11:29Z",
"downloaded": true,
"id": "5c000000-000c3-00003-de0000-c0d200000",
"payload_available": true
}
],
"versions_total": 1
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Abrufen eines importierten Zertifikats gibt die folgende Antwort zurück:
{
"request_id": "811b893b-55c7-b6bb-4e55-26a7a8362164",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"algorithm": "RSA",
"common_name": "example.com",
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2021-06-03T20:50:11Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:be4a0846-4cb5-3bfa-bab5-10a44dfc3e85",
"description": "Extended description for my secret.",
"expiration_date": "2021-06-04T15:25:44Z",
"id": "be4a0846-4cb5-3bfa-bab5-10a44dfc3e85",
"intermediate_included": true,
"issuer": "US Texas Austin Example Corp. Example Org example.com",
"key_algorithm": "SHA256-RSA",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2021-06-03T20:50:11Z",
"name": "test-imported-certificate",
"private_key_included": true,
"secret_data": {
"certificate": "-----BEGIN CERTIFICATE-----\nMIICWzCCAcQCC...(redacted)",
"intermediate": "-----BEGIN CERTIFICATE-----\nMIICUzHHraOa...(redacted)",
"private_key": "-----BEGIN PRIVATE KEY-----\nMIICdgIBADANB...(redacted)"
},
"secret_type": "imported_cert",
"serial_number": "fc:22:29:7e:57:25:8a:05",
"state": 1,
"state_description": "Active",
"validity": {
"not_after": "2021-06-04T15:25:44Z",
"not_before": "2021-06-03T15:25:44Z"
},
"versions": [
{
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2021-06-03T20:50:11.278296706Z",
"expiration_date": "2021-06-04T15:25:44Z",
"id": "e4f44e8b-abe0-9267-88da-199e754f974a",
"serial_number": "fc:22:29:7e:57:25:8a:05",
"validity": {
"not_after": "2021-06-04T15:25:44Z",
"not_before": "2021-06-03T15:25:44Z"
}
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Abrufen einer Gruppe von Serviceberechtigungsnachweisen gibt die folgende Antwort zurück:
{
"request_id": "18d15b17-eb6f-68ad-8b44-4033ab64feb1",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "IBMid-2723462DAH",
"creation_date": "2023-11-23T13:33:36Z",
"crn": "crn:v1:staging:public:secrets-manager:us-south:a/826aa2b9cab6c666477fc55ebc47bacc:e2c32ad4-1414-41e0-8747-e107e6b9f8a6:secret:c70951dd-f672-9995-968d-b76204b2432d",
"custom_metadata": {},
"downloaded": true,
"iam_apikey_description": "Auto-generated for key crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bacc:f85409e9-1a06-47d5-8320-95ed4e1675cc:resource-key:d13dd212-cd38-4732-a14e-1889ee3ca4fa",
"iam_apikey_id": "ApiKey-4fdabb94-2654-4ab7-8d01-fbf41117b4a9",
"iam_apikey_name": "test-sc-secret",
"iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
"iam_serviceid_crn": "crn:v1:staging:public:iam-identity::a/826aa2b9cab6c666477fc55ebc47bacc::serviceid:ServiceId-38fd1d20-db0b-4ae6-bee9-23d6468e149f",
"id": "c70951dd-f672-9995-968d-b76204b2432d",
"labels": [],
"last_update_date": "2023-11-23T13:33:36Z",
"locks_total": 0,
"name": "test-sc-secret",
"parameters": {},
"resource_key_crn": "crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bacc:f85409e9-1a06-47d5-8320-95ed4e1675cc:resource-key:d13dd212-cd38-4732-a14e-1889ee3ca4fa",
"resource_key_name": "test-sc-secret",
"role": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
"secret_data": {
"apikey": "xxxxxxxxxxxxxxxxxxxxxxx",
"guid": "f85409e9-1a06-47d5-8320-95ed4e1675cc",
"iam_apikey_description": "Auto-generated for key crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bacc:f85409e9-1a06-47d5-8320-95ed4e1675cc:resource-key:d13dd212-cd38-4732-a14e-1889ee3ca4fa",
"iam_apikey_id": "ApiKey-4fdabb94-2654-4ab7-8d01-fbf41117b4a9",
"iam_apikey_name": "test-sc-secret",
"iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
"iam_serviceid_crn": "crn:v1:staging:public:iam-identity::a/826aa2b9cab6c666477fc55ebc47bacc::serviceid:ServiceId-38fd1d20-db0b-4ae6-bee9-23d6468e149f",
"instance_id": "f85409e9-1a06-47d5-8320-95ed4e1675cc",
"plan": "33b50df2-9cd6-4005-a941-bf0a59f0d133",
"region": "us-south"
},
"secret_type": "service_credentials",
"source_crn": "crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bacc:f85409e9-1a06-47d5-8320-95ed4e1675cc::",
"state": 1,
"state_description": "Active",
"ttl": 7776000,
"versions": [
{
"created_by": "IBMid-2723462DAH",
"creation_date": "2023-11-23T13:33:36Z",
"downloaded": true,
"expiration_date": "2024-02-21T13:33:36Z",
"id": "1ab6e797-c74d-419d-0863-a8976b64efe8",
"payload_available": true,
"version_custom_metadata": {}
}
],
"versions_total": 1
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Geheime Schlüssel auflisten
Rufen Sie eine Liste geheimer Schlüssel ab, die in einer Secrets Manager-Engine für geheime Schlüssel verfügbar sind.
Beispielanforderungen
Listen Sie geheime Schlüssel auf.
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Listen Sie beliebige geheime Schlüssel in einer vorhandenen Gruppe geheimer Schlüssel auf:
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets/groups/{group_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Beispielantworten
Eine Anforderung zum Auflisten aller beliebigen geheimen Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "d8eb84fd-c0bd-08ae-c3ad-cff87606953c",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"secrets": [
{
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-15T22:34:53Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:a6972127-35ad-b36f-aac8-0223f0475cb6",
"description": "Extended description for my secret.",
"expiration_date": "2030-04-01T09:30:00Z",
"id": "a6972127-35ad-b36f-aac8-0223f0475cb6",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2020-12-15T22:34:53Z",
"name": "test-arbitrary-secret-in-group",
"secret_group_id": "339c026a-ac0f-1ea1-3d43-99adf871b49a",
"secret_type": "arbitrary",
"state": 1,
"state_description": "Active"
},
{
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2020-12-15T22:41:14Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:ea1907c8-8c8e-6b83-3c20-05f2015b80d8",
"description": "Extended description for my secret.",
"expiration_date": "2030-04-01T09:30:00Z",
"id": "ea1907c8-8c8e-6b83-3c20-05f2015b80d8",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2020-12-15T22:41:14Z",
"name": "another-arbitrary-secret-in-group",
"secret_group_id": "339c026a-ac0f-1ea1-3d43-99adf871b49a",
"secret_type": "arbitrary",
"state": 1,
"state_description": "Active"
}
],
"secrets_total": 2
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Geheime Metadaten abrufen
Rufen Sie die Metadaten eines geheimen Schlüssels ab, wie z. B. den Namen oder die Beschreibung. Um den tatsächlichen Wert eines geheimen Schlüssels abzurufen, verwenden Sie Geheimen Schlüssel abrufen.
Beispielanforderungen
Metadaten für einen geheimen arbitrary-Schlüssel abrufen.
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets/{secret_id}/metadata" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Metadaten für einen geheimen arbitrary-Schlüssel in einer vorhandenen Gruppe geheimer Schlüssel abrufen.
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets/groups/{group_id}/{secret_id}/metadata" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Metadaten für einen geheimen kv-Schlüssel abrufen. Weitere Informationen.
curl -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/kv/secrets/{secret_id}/metadata' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Metadaten für einen geheimen kv-Schlüssel in einer vorhandenen Gruppe geheimer Schlüssel abrufen.
curl -X GET 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/kv/secrets/groups/{group_id}/{secret_id}/metadata' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Beispielantworten
Eine Anfrage zum Abrufen der Metadaten eines arbitrary-Geheimnisses liefert folgende Antwort:
{
"request_id": "372645c0-9d97-5f6b-0755-99145eacdb93",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2021-06-04T02:55:40Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:ea1907c8-8c8e-6b83-3c20-05f2015b80d8",
"description": "Extended description for my secret.",
"expiration_date": "2030-04-01T09:30:00Z",
"id": "ea1907c8-8c8e-6b83-3c20-05f2015b80d8",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2021-06-04T02:55:40Z",
"name": "test-arbitrary-secret",
"secret_type": "arbitrary",
"state": 1,
"state_description": "Active"
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anfrage zum Abrufen der Metadaten eines kv-Geheimnisses liefert folgende Antwort:
{
"request_id": "0a0000e-0a0f-edfh-000a-ec2000ab00",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "iam-ServiceId-9ca00000-f00d-000e-8b02-ed6b000pl",
"creation_date": "2022-01-25T19:22:04Z",
"crn": "crn:v1:bluemix:public:secrets-manager:eu-gb:a/4000000bbea00000000647f000001f5:5f000004-5f00-40000-8bfc-5mnh0a200000:secret:00000ea8e-7d00-00ce-c00poa-0a00000f0000e",
"description": "Extended description for my secret.",
"downloaded": true,
"id": "0a0000e-0a0f-edfh-000a-ec2000ab00",
"labels": [],
"last_update_date": "2022-01-25T19:22:04Z",
"name": "test-kv-secret",
"secret_type": "kv",
"state": 1,
"state_description": "Active",
"versions_total": 1
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Abrufen der Metadaten eines geheimen kv-Schlüssels in einer vorhandenen Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "0a0000e-0a0f-edfh-000a-ec2000ab00",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "id-0000000YC6X",
"creation_date": "2022-01-26T20:11:29Z",
"crn": "crn:v1:bluemix:public:secrets-manager:eu-gb:a/4000000bbea00000000647f000001f5:5f000004-5f00-40000-8bfc-5mnh0a200000:secret:00000ea8e-7d00-00ce-c00poa-0a00000f0000e",
"description": "Test secret in test secret group.",
"downloaded": true,
"id": "0a0000e-0a0f-edfh-000a-ec2000ab00",
"labels": [],
"last_update_date": "2022-01-26T20:11:29Z",
"name": "test-kv-secret-from-group",
"secret_group_id": "aded0a0000e-0a0f-edfh-000a-ec2000ab00",
"secret_type": "kv",
"state": 1,
"state_description": "Active",
"versions_total": 1
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Metadaten von geheimen Schlüsseln aktualisieren
Aktualisieren Sie die Metadaten eines geheimen Schlüssels, wie z. B. den Namen, die Beschreibung oder das Ablaufdatum. Um den tatsächlichen Wert eines geheimen Schlüssels turnusmäßig zu wechseln, verwenden Sie die Option Geheimen Schlüssel turnusmäßig wechseln.
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Der aktualisierte Name, der dem geheimen Schlüssel zugeordnet werden soll. |
description |
Die aktualisierte Beschreibung, die dem geheimen Schlüssel zugeordnet werden soll. |
expiration_date |
Das aktualisierte Ablaufdatum, das dem geheimen Schlüssel zugeordnet werden soll. Diese Option wird für die Typen arbitrary und username_password für geheime Schlüssel unterstützt. Das Datumsformat folgt
RFC 3339. |
Beispielanforderungen
Aktualisieren Sie den Namen eines geheimen arbitrary-Schlüssels in der default-Gruppe geheimer Schlüssel.
curl -X PUT "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets/{secret_id}/metadata" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-d '{
"name": "updated-arbitrary-secret-name"
}'
Aktualisiert das Ablaufdatum eines geheimen arbitrary-Schlüssels in einer vorhandenen Gruppe geheimer Schlüssel.
curl -X PUT "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets/groups/{group_id}/{secret_id}/metadata" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-d '{
"expiration_date": "2030-05-01T09:30:00Z"
}'
Beispielantworten
Eine Anforderung zum Aktualisieren der Metadaten eines geheimen arbitrary-Schlüssels in der default-Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "372645c0-9d97-5f6b-0755-99145eacdb93",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2021-06-04T02:55:40Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:secret:ea1907c8-8c8e-6b83-3c20-05f2015b80d8",
"description": "Updated description for my secret.",
"expiration_date": "2030-04-01T09:30:00Z",
"id": "ea1907c8-8c8e-6b83-3c20-05f2015b80d8",
"labels": [
"dev",
"us-south"
],
"last_update_date": "2021-06-05T02:55:40Z",
"name": "updated-arbitrary-secret",
"secret_type": "arbitrary",
"state": 1,
"state_description": "Active"
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Geheimen Schlüssel turnusmäßig wechseln
Erstellen Sie eine neue Version eines geheimen Schlüssels. Der geheime Schlüssel behält seine identifizierenden Informationen, z. B. seinen Namen und seine ID, bei. Informationen zum Festlegen einer Richtlinie für den automatischen turnusmäßigen Wechsel eines geheimen Schlüssels finden Sie im Artikel Geheime Richtlinien festlegen.
| Anforderungsparameter | Beschreibung |
|---|---|
payload |
Die neuen geheimen Daten, die einem arbitrary oder einem geheimen kv-Schlüssel zugeordnet werden sollen. |
password |
Das neue Kennwort, das einem geheimen username_password-Schlüssel zugeordnet werden soll. |
certificate |
Das neue Zertifikat, das einem geheimen imported_cert-Schlüssel zugeordnet werden soll. |
private_key |
Der neue private Schlüssel, der einem geheimen imported_cert-Schlüssel zugeordnet werden soll. |
intermediate |
Die neuen Zwischenzertifikatsdaten, die einem geheimen import_cert-Schlüssel zugeordnet werden sollen. |
Beispielanforderungen
Wechseln Sie einen geheimen arbitrary-Schlüssel turnusmäßig in der default-Gruppe geheimer Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets/{secret_id}/rotate" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-d '{
"payload": "new-secret-data"
}'
Wechseln Sie einen geheimen arbitrary-Schlüssel turnusmäßig in einer vorhandenen Gruppe geheimer Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets/groups/{group_id}/{secret_id}/rotate" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-d '{
"payload": "new-secret-data"
}'
Wechseln Sie einen geheimen kv-Schlüssel turnusmäßig in der default-Gruppe der geheimen Schlüssel. Weitere Informationen.
curl -X POST 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/kv/secrets/{secret_id}/rotate' \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"payload": {
"key7":"value7"
}
}'
Wechseln Sie einen geheimen kv-Schlüssel turnusmäßig in einer vorhandenen Gruppe geheimer Schlüssel.
curl -X POST 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/kv/secrets/groups/{group_id}/{secret_id}/rotate' \
-H 'Accept: application/json'
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"payload": {
"key7":"value7"
}
}'
Wechseln Sie einen geheimen username_password-Schlüssel turnusmäßig in der default-Gruppe der geheimen Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/secrets/{secret_id}/rotate" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-d '{
"password": "new-password"
}'
Wechseln Sie einen geheimen imported_cert-Schlüssel turnusmäßig in der default-Gruppe geheimer Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/imported_cert/secrets/{secret_id}/rotate" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}' \
-d '{
"certificate": "new-certificate",
"private_key": "new-private-key",
"intermediate": "new-intermediate-certificate"
}'
Beispielantworten
Eine Anforderung zum turnusmäßigen Wechseln eines geheimen kv-Schlüssels in der default-Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "e00000b-0000-0ad1-beb0-00000d0000",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "iam-ServiceId-9ca2000007-f0000d-400000e-8b02-ed6b000000",
"creation_date": "2022-01-25T19:22:04Z",
"crn": "crn:v1:bluemix:public:secrets-manager:eu-gb:a/00000a6bbea644a6be000000001f5:5f1a000000-5f000-4000-8bfc-5eef00000:secret:00000ea8e-7d00-00ce-c00a-0a0000f000ee",
"description": "Extended description for my secret.",
"downloaded": false,
"id": "00000ea00-7d0000-0000ce-c0002a-0a0000f4b3ee",
"labels": [],
"last_update_date": "2022-01-27T21:05:25Z",
"name": "test-kv-secret",
"secret_data": {
"payload": {
"key7": "value7"
}
},
"secret_type": "kv",
"state": 1,
"state_description": "Active",
"versions": [
{
"created_by": "iam-ServiceId-9ca2000007-f0000d-400000e-8b02-ed6b000000",
"creation_date": "2022-01-25T19:22:04Z",
"downloaded": true,
"id": "00000ea00-7d0000-0000ce-c0002a-0a0000f4b3ee",
"payload_available": false
},
{
"created_by": "iam-ServiceId-9ca2000007-f0000d-400000e-8b02-ed6b000000",
"creation_date": "2022-01-27T21:05:25Z",
"downloaded": false,
"id": "00000ea00-7d0000-0000ce-c0002a-0a0000f4b3ee",
"payload_available": true
}
],
"versions_total": 2
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum turnusmäßigen Wechseln eines geheimen kv-Schlüssels in einer vorhandenen Gruppe geheimer Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "e00000b-0000-0ad1-beb0-00000d0000",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"created_by": "IBMid-662001YC6X",
"creation_date": "2022-01-26T20:11:29Z",
"crn": "crn:v1:bluemix:public:secrets-manager:eu-gb:a/4b85ea6bbea644a6be376647f5f961f5:5f1a3554-5f59-4164-8bfc-5eef0a20cf66:secret:e006e8bc-f497-dc93-4102-9d9cf2051a41",
"description": "Test secret in test secret group.",
"downloaded": false,
"id": "00000ea00-7d0000-0000ce-c0002a-0a0000f4b3ee",
"labels": [],
"last_update_date": "2022-01-27T21:00:27Z",
"name": "test-kv-secret-from-group",
"secret_data": {
"payload": {
"key7": "value7"
}
},
"secret_group_id": "00000ea00-7d0000-0000ce-c0002a-0a0000f4b3ee",
"secret_type": "kv",
"state": 1,
"state_description": "Active",
"versions": [
{
"created_by": "iam-ServiceId-00000ea00-7d0000-0000ce-c0002a-0a0000f4b3ee",
"creation_date": "2022-01-26T20:11:29Z",
"downloaded": true,
"id": "00000ea00-7d0000-0000ce-c0002a-0a0000f4b3ee",
"payload_available": false
},
{
"created_by": "iam-ServiceId-00000ea00-7d0000-0000ce-c0002a-0a0000f4b3ee",
"creation_date": "2022-01-27T21:00:03Z",
"downloaded": false,
"id": "00000ea00-7d0000-0000ce-c0002a-0a0000f4b3ee",
"payload_available": false
},
{
"created_by": "iam-ServiceId-00000ea00-7d0000-0000ce-c0002a-0a0000f4b3ee",
"creation_date": "2022-01-27T21:00:27Z",
"downloaded": false,
"id": "00000ea00-7d0000-0000ce-c0002a-0a0000f4b3ee",
"payload_available": true
}
],
"versions_total": 3
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Geheimen Schlüssel löschen
Löscht einen geheimen Schlüssel aus einer Secrets Manager-Engine für geheime Schlüssel.
Beispielanforderungen
Löschen Sie einen beliebigen geheimen Schlüssel in der default-Gruppe geheimer Schlüssel.
curl -X DELETE "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets/{secret_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Löschen Sie einen beliebigen geheimen Schlüssel in einer vorhandenen Gruppe geheimer Schlüssel.
curl -X DELETE "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets/groups/{group_id}/{secret_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Beispielantwort
{
"request_id": "e48436e3-23d3-ab4a-7642-535cab8935a8",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": null,
"wrap_info": null,
"warnings": null,
"auth": null
}
Sperren
Geheime Sperren auflisten
Auflistung der Sperren, die mit einem bestimmten Geheimnis verbunden sind.
| Abfrageparameter | Beschreibung |
|---|---|
limit |
Die Anzahl der abzurufenden Sperren. Der Standardwert ist 25. Wenn Sie eine andere Gruppe von Elementen abrufen möchten, verwenden Sie limit mit offset, um durch Ihre verfügbaren Ressourcen zu blättern. |
offset |
Die Anzahl der zu überspringenden Sperren. Der Standardwert ist '0'. Durch die Angabe von offset wird eine Teilmenge von Sperren abgerufen, die mit dem offset-Wert beginnt. Verwenden Sie Offset mit Limit, um Ihre verfügbaren Geheimsperren durchzublättern. |
search |
Filtert Sperren, die die angegebene Zeichenfolge in ihrem Namen enthalten. |
Beispielanforderung
Listet Sperren für einen beliebigen geheimen Schlüssel auf.
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/locks/{secret_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Listet Sperren für einen geheimen Schlüssel für Benutzerberechtigungsnachweise in einer vorhandenen Gruppe geheimer Schlüssel auf
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/locks/groups/{group_id}/{secret_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Blättern Sie mit limit und offset durch die verfügbaren Sperren.
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/locks/groups/{group_id}/{secret_id}?limit={limit}&offset={offset}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Filtern Sie nach Sperren, deren Namen book enthalten
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/locks/groups/{group_id}/{secret_id}?search=book" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Beispielantwort
{
"request_id": "ba51140d-31a8-0a51-dd5b-1ca59838e881",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"locks": [
{
"attributes": {
"key": "value"
},
"created_by": "iam-ServiceId-222b47ab-b08e-4619-b68f-8014a2c3acb8",
"creation_date": "2022-06-30T21:41:36.616174Z",
"description": "Test lock for secret in the default secret group.",
"last_update_date": "2022-06-30T21:41:36.616174Z",
"name": "lock-for-app-2",
"secret_group_id": "default",
"secret_id": "184408d6-8264-5ff3-c308-6922ed04ad88",
"secret_version_alias": "current",
"secret_version_id": "f2b68dbb-c291-87df-6026-7611c324c823"
},
{
"attributes": {
"key": "value"
},
"created_by": "iam-ServiceId-222b47ab-b08e-4619-b68f-8014a2c3acb8",
"creation_date": "2022-06-30T20:56:33.138337Z",
"description": "Test lock for secret in the default secret group.",
"last_update_date": "2022-06-30T21:14:14.903163Z",
"name": "lock-for-app-1",
"secret_group_id": "default",
"secret_id": "184408d6-8264-5ff3-c308-6922ed04ad88",
"secret_version_alias": "previous",
"secret_version_id": "09d9718b-b411-4111-a8f4-b1397d22d11b"
}
],
"locks_total": 2
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Geheimen Schlüssel sperren
Erstellen Sie mindestens eine Sperre für die aktuelle Version eines geheimen Schlüssels.
Mit einer Sperre kann verhindert werden, dass ein geheimer Schlüssel gelöscht oder geändert werden kann, während er von Ihren Anwendungen verwendet wird. Eine erfolgreiche Anforderung ordnet Ihrem geheimen Schlüssel eine neue Sperre zu oder ersetzt eine Sperre mit demselben Namen, wenn sie bereits vorhanden ist. Darüber hinaus können Sie mit dieser Methode alle übereinstimmenden Sperren für einen geheimen Schlüssel aufheben, indem Sie einen optionalen Sperrmodus verwenden.
lock_exclusive: Entfernt alle anderen Sperren mit gleichem Namen, wenn sie in der vorherigen Version des Geheimnisses gefunden wurden.lock_exclusive_delete: Wielock_exclusive, löscht aber auch permanent die Daten der vorherigen Version des geheimen Schlüssels, wenn keine Sperren gefunden werden.
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Ein von Menschen lesbarer Name, der dem geheimen Schloss zugewiesen wird. Namen sind pro Version des geheimen Schlüssels eindeutig. /n Anmerkung: Das Erstellen einer Sperre mit einem vorhandenen Namen ersetzt die Sperre und überschreibt ihre Attribute. |
description |
Eine ausführliche Beschreibung Ihres Geheimschlosses. |
attributes |
Optionale Informationen für die Zuordnung zu einer Sperre, wie z. B. Ressourcen-CRNs, die von der Automatisierung verwendet werden. |
Beispielanforderung
Erstellen Sie eine Sperre für einen geheimen Schlüssel in der Standardgruppe geheimer Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/{secret_type}/locks/{secret_id}/lock" \
-H 'X-Vault-Token: {Vault-Token}'
-H 'Content-Type: application/json' \
-D '{
"locks": [
{
"name": "lock-for-app-1",
"description": "Test lock for secret in the default secret group.",
"attributes": {
"key": "value"
}
}
]
}'
Erstellen Sie zwei Sperren für die aktuelle Version eines geheimen Schlüssels in einer vorhandenen Gruppe geheimer Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/{secret_type}/locks/groups/{group_id}/{secret_id}/lock" \
-H 'X-Vault-Token: {Vault-Token}'
-H 'Content-Type: application/json' \
-D '{
"locks": [
{
"name": "lock-for-app-1",
"description": "Test lock for secret in a custom secret group.",
"attributes": {
"key": "value"
}
},
{
"name": "lock-for-app-2",
"description": "Test lock for secret in a custom secret group.",
"attributes": {
"key": "value"
}
}
]
}'
Sperren Sie eine geheime Version exklusiv.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/{secret_type}/locks/{secret_id}/lock_exclusive" \
-H 'X-Vault-Token: {Vault-Token}'
-H 'Content-Type: application/json' \
-D '{
"locks": [
{
"name": "lock-for-app-1",
"description": "Test lock for secret in the default secret group.",
"attributes": {
"key": "value"
}
}
]
}'
Sperren Sie eine geheime Version exklusiv und löschen Sie die Daten der vorherigen Version.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/{secret_type}/locks/{secret_id}/lock_exclusive_delete" \
-H 'X-Vault-Token: {Vault-Token}'
-H 'Content-Type: application/json' \
-D '{
"locks": [
{
"name": "lock-for-app-1",
"description": "Test lock for secret in the default secret group.",
"attributes": {
"key": "value"
}
}
]
}'
Beispielantwort
Eine Anforderung zum Sperren der aktuellen Version eines geheimen Schlüssels, der sich in der Standardgruppe geheimer Schlüssel befindet, gibt die folgende Antwort zurück:
{
"request_id": "cad3f223-ec90-1e8e-9408-7fc3c9c50b86",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"secret_group_id": "default",
"secret_id": "184408d6-8264-5ff3-c308-6922ed04ad88",
"versions": [
{
"alias": "current",
"id": "f2b68dbb-c291-87df-6026-7611c324c823",
"locks": [
"lock-for-app-1"
],
"payload_available": true
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Sperren der aktuellen Version eines geheimen Schlüssels, die eine angepasste Gruppe geheimer Schlüssel ist, gibt die folgende Antwort zurück:
{
"request_id": "a717fba0-275d-36d2-49e6-ae54fc820ca4",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"secret_group_id": "d2e98a96-18ed-f13c-8dee-db955fb94122",
"secret_id": "c86946e6-b392-2613-159d-aff5a3f095b3",
"versions": [
{
"alias": "current",
"id": "ad6aa6d9-b43c-4bc3-597d-15c376622e64",
"locks": [
"lock-for-app-1"
],
"payload_available": true
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Geheimen Schlüssel entsperren
Löschen Sie mindestens eine Sperre, die der aktuellen Version eines geheimen Schlüssels zugeordnet ist.
Eine erfolgreiche Anforderung löscht die von Ihnen angegebenen Sperren. Um alle Sperren zu entfernen, können Sie {"locks": ["*"]} im Anforderungshauptteil übergeben. Geben Sie andernfalls die Namen der Sperren
an, die Sie löschen wollen. Beispiel: {"locks": ["lock1", "lock2"]}.
Ein Geheimnis gilt erst dann als entsperrt und kann widerrufen oder gelöscht werden, wenn alle Sperren entfernt wurden. Um zu verstehen, ob ein geheimer Schlüssel Sperren enthält, überprüfen Sie das Feld locks_total, das als Teil
der Metadaten Ihres geheimen Schlüssels zurückgegeben wird.
Beispielanforderung
Entfernen Sie alle Sperren, die mit einem Geheimnis verbunden sind.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/{secret_type}/locks/{secret_id}/unlock" \
-H 'X-Vault-Token: {Vault-Token}'
-H 'Content-Type: application/json' \
-D '{
"locks": ["*"]
}'
Entfernen Sie zwei Sperren aus einem geheimen Schlüssel in einer vorhandenen Gruppe geheimer Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/{secret_type}/locks/groups/{group_id}/{secret_id}/unlock" \
-H 'X-Vault-Token: {Vault-Token}'
-H 'Content-Type: application/json' \
-D '{
"locks": ["lock-name-1", "lock-name-2"]
}'
Beispielantwort
Eine Anforderung zum Entfernen aller Sperren gibt die folgende Antwort zurück:
{
"request_id": "4708ebbf-eab0-e68a-9e72-d1c67a209fdc",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"secret_group_id": "default",
"secret_id": "184408d6-8264-5ff3-c308-6922ed04ad88",
"versions": [
{
"alias": "current",
"id": "f2b68dbb-c291-87df-6026-7611c324c823",
"locks": [],
"payload_available": true
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Entfernen nur bestimmter Sperren listet die verbleibenden Sperren in der Antwort auf:
{
"request_id": "4d954026-68b3-6506-dc1d-5e77574fd2f0",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"secret_group_id": "default",
"secret_id": "184408d6-8264-5ff3-c308-6922ed04ad88",
"versions": [
{
"alias": "current",
"id": "f2b68dbb-c291-87df-6026-7611c324c823",
"locks": [
"lock-for-app-1"
],
"payload_available": true
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Geheime Versionssperren auflisten
Listen Sie die Sperren auf, die einer angegebenen Version des geheimen Schlüssels zugeordnet sind.
Verwenden Sie {version_id} im URL Pfad, um die Version anzugeben. Die Aliasnamen current oder previous sind ebenfalls zulässig.
| Abfrageparameter | Beschreibung |
|---|---|
limit |
Die Anzahl der abzurufenden Sperren. Der Standardwert ist 25. Wenn Sie eine andere Gruppe von Elementen abrufen möchten, verwenden Sie limit mit offset, um durch Ihre verfügbaren Ressourcen zu blättern. |
offset |
Die Anzahl der zu überspringenden Sperren. Der Standardwert ist '0'. Durch die Angabe von offset wird eine Teilmenge von Sperren abgerufen, die mit dem offset-Wert beginnt. Verwenden Sie Offset mit Limit, um Ihre verfügbaren Geheimsperren durchzublättern. |
search |
Filtert Sperren, die die angegebene Zeichenfolge in ihrem Namen enthalten. |
Beispielanforderung
Listet Sperren für eine bestimmte Version eines beliebigen geheimen Schlüssels auf.
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/locks/{secret_id}/versions/{version_id}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Listet Sperren für die aktuelle Version eines geheimen Schlüssels für Benutzerberechtigungsnachweise in einer vorhandenen Gruppe geheimer Schlüssel auf.
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/locks/groups/{group_id}/{secret_id}/versions/current" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Blättern Sie mit limit und offset durch die verfügbaren Sperren.
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/locks/groups/{group_id}/{secret_id}/versions/current?limit={limit}&offset={offset}" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Filtern Sie nach Sperren, deren Namen book enthalten
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/locks/groups/{group_id}/{secret_id}/versions/current?search=book" \
-H 'Accept: application/json' \
-H 'X-Vault-Token: {Vault-Token}'
Beispielantwort
Eine Anforderung zum Abrufen der Sperrendetails zur aktuellen Version eines geheimen Schlüssels gibt die folgende Antwort zurück:
{
"request_id": "ba51140d-31a8-0a51-dd5b-1ca59838e881",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"locks": [
{
"attributes": {
"key": "value"
},
"created_by": "iam-ServiceId-222b47ab-b08e-4619-b68f-8014a2c3acb8",
"creation_date": "2022-06-30T21:41:36.616174Z",
"description": "Test lock for secret in the default secret group.",
"last_update_date": "2022-06-30T21:41:36.616174Z",
"name": "lock-for-app-2",
"secret_group_id": "default",
"secret_id": "184408d6-8264-5ff3-c308-6922ed04ad88",
"secret_version_alias": "current",
"secret_version_id": "f2b68dbb-c291-87df-6026-7611c324c823"
},
{
"attributes": {
"key": "value"
},
"created_by": "iam-ServiceId-222b47ab-b08e-4619-b68f-8014a2c3acb8",
"creation_date": "2022-06-30T20:56:33.138337Z",
"description": "Test lock for secret in the default secret group.",
"last_update_date": "2022-06-30T21:14:14.903163Z",
"name": "lock-for-app-1",
"secret_group_id": "default",
"secret_id": "184408d6-8264-5ff3-c308-6922ed04ad88",
"secret_version_alias": "current",
"secret_version_id": "f2b68dbb-c291-87df-6026-7611c324c823"
}
],
"locks_total": 2
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Version eines geheimen Schlüssels sperren
Erstellen Sie mindestens eine Sperre für eine angegebene Version eines geheimen Schlüssels. Verwenden Sie zur Angabe einer Version den Pfadparameter {version_id},
um die eindeutige ID der aktuellen oder früheren Version Ihres geheimen Schlüssels anzugeben. Die Aliasnamen current oder previous sind ebenfalls zulässig.
Mit einer Sperre kann verhindert werden, dass ein geheimer Schlüssel gelöscht oder geändert werden kann, während er von Ihren Anwendungen verwendet wird. Eine erfolgreiche Anforderung ordnet Ihrem geheimen Schlüssel eine neue Sperre zu oder ersetzt eine Sperre mit demselben Namen, wenn sie bereits vorhanden ist. Darüber hinaus können Sie mit dieser Methode alle übereinstimmenden Sperren für einen geheimen Schlüssel aufheben, indem Sie einen optionalen Sperrmodus verwenden.
lock_exclusive: Entfernt alle anderen Sperren mit gleichem Namen, wenn sie in der vorherigen Version des Geheimnisses gefunden wurden.lock_exclusive_delete: Wielock_exclusive, löscht aber auch permanent die Daten der vorherigen Version des geheimen Schlüssels, wenn keine Sperren gefunden werden.
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Ein von Menschen lesbarer Name, der dem geheimen Schloss zugewiesen wird. Namen sind pro Version des geheimen Schlüssels eindeutig. /n Anmerkung: Das Erstellen einer Sperre mit einem vorhandenen Namen ersetzt die Sperre und überschreibt ihre Attribute. |
description |
Eine ausführliche Beschreibung Ihres Geheimschlosses. |
attributes |
Optionale Informationen für die Zuordnung zu einer Sperre, wie z. B. Ressourcen-CRNs, die von der Automatisierung verwendet werden. |
Beispielanforderung
Erstellt eine Sperre für die angegebene Version eines geheimen Schlüssels in der Standardgruppe für geheime Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/{secret_type}/locks/{secret_id}/versions/{version_id}/lock" \
-H 'X-Vault-Token: {Vault-Token}'
-H 'Content-Type: application/json' \
-D '{
"locks": [
{
"name": "lock-for-app-1",
"description": "Test lock for secret in the default secret group.",
"attributes": {
"key": "value"
}
}
]
}'
Ersetzen Sie {version_id} im Pfad URL durch den Alias current, um eine Sperre für die aktuelle geheime Version zu erstellen. Die Aliasnamen current oder previous sind zulässig.
Erstellen Sie zwei Sperren für die aktuelle Version eines geheimen Schlüssels in einer vorhandenen Gruppe geheimer Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/{secret_type}/locks/groups/{group_id}/{secret_id}/versions/current/lock" \
-H 'X-Vault-Token: {Vault-Token}'
-H 'Content-Type: application/json' \
-D '{
"locks": [
{
"name": "lock-for-app-1",
"description": "Test lock for secret in a custom secret group.",
"attributes": {
"key": "value"
}
},
{
"name": "lock-for-app-2",
"description": "Test lock for secret in a custom secret group.",
"attributes": {
"key": "value"
}
}
]
}'
Erstellen Sie eine Sperre für die Vorgängerversion eines geheimen Schlüssels in einer vorhandenen Gruppe geheimer Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/{secret_type}/locks/groups/{group_id}/{secret_id}/versions/previous/lock" \
-H 'X-Vault-Token: {Vault-Token}'
-H 'Content-Type: application/json' \
-D '{
"locks": [
{
"name": "lock-for-app-1",
"description": "Test lock for secret in a custom secret group.",
"attributes": {
"key": "value"
}
}
]
}'
Beispielantwort
Eine Anforderung zum Sperren der vorherigen Version eines geheimen Schlüssels in einer angepassten Gruppe geheimer Schlüssel
{
"request_id": "97a3d1fb-c137-9c1c-16fb-7aebf05a0eae",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"secret_group_id": "d2e98a96-18ed-f13c-8dee-db955fb94122",
"secret_id": "c86946e6-b392-2613-159d-aff5a3f095b3",
"versions": [
{
"alias": "current",
"id": "3993c39b-3ef5-f6f3-5e20-f6f9c6f8d053",
"locks": [],
"payload_available": true
},
{
"alias": "previous",
"id": "ad6aa6d9-b43c-4bc3-597d-15c376622e64",
"locks": [
"lock-for-app-1"
],
"payload_available": true
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Geheime Version entsperren
Löschen einer oder mehrerer Sperren, die mit der angegebenen geheimen Version verbunden sind.
Eine erfolgreiche Anforderung löscht die von Ihnen angegebenen Sperren. Um alle Sperren zu entfernen, können Sie {"locks": ["*"]} im Anforderungshauptteil übergeben. Geben Sie andernfalls die Namen der Sperren
an, die Sie löschen wollen. Beispiel: {"locks": ["lock-1", "lock-2"]}.
Ein Geheimnis gilt erst dann als entsperrt und kann widerrufen oder gelöscht werden, wenn alle Sperren entfernt wurden. Um zu verstehen, ob ein geheimer Schlüssel Sperren enthält, überprüfen Sie das Feld locks_total, das als Teil
der Metadaten Ihres geheimen Schlüssels zurückgegeben wird.
Beispielanforderung
Entfernen Sie alle Sperren für eine geheime Version.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/{secret_type}/locks/{secret_id}/versions/{version_id}/unlock" \
-H 'X-Vault-Token: {Vault-Token}'
-H 'Content-Type: application/json' \
-D '{
"locks": ["*"]
}'
Ersetzen Sie {version_id} im Pfad URL durch den Alias current, um Sperren aus der aktuellen geheimen Version zu entfernen. Die Aliasnamen current oder previous sind zulässig.
Entfernen Sie zwei Sperren für die aktuelle Version eines geheimen Schlüssels in einer vorhandenen Gruppe geheimer Schlüssel.
curl -X POST "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/{secret_type}/locks/groups/{group_id}/{secret_id}/versions/current/unlock" \
-H 'X-Vault-Token: {Vault-Token}'
-H 'Content-Type: application/json' \
-D '{
"locks": ["lock-name-1", "lock-name-2"]
}'
Beispielantwort
Eine Anforderung zum Entfernen aller Sperren gibt die folgende Antwort zurück:
{
"request_id": "4708ebbf-eab0-e68a-9e72-d1c67a209fdc",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"secret_group_id": "default",
"secret_id": "184408d6-8264-5ff3-c308-6922ed04ad88",
"versions": [
{
"alias": "current",
"id": "f2b68dbb-c291-87df-6026-7611c324c823",
"locks": [],
"payload_available": true
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Entfernen nur bestimmter Sperren listet die verbleibenden Sperren in der Antwort auf:
{
"request_id": "4d954026-68b3-6506-dc1d-5e77574fd2f0",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"secret_group_id": "default",
"secret_id": "184408d6-8264-5ff3-c308-6922ed04ad88",
"versions": [
{
"alias": "current",
"id": "f2b68dbb-c291-87df-6026-7611c324c823",
"locks": [
"lock-for-app-1"
],
"payload_available": true
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Richtlinien
Richtlinien für geheime Schlüssel festlegen
Erstellt oder aktualisiert eine Richtlinie für den automatischen turnusmäßigen Wechsel eines geheimen Schlüssels. Unterstützte Typen geheimer Schlüssel: username_password
| Anforderungsparameter | Beschreibung |
|---|---|
interval |
Die Länge des Zeitintervalls für die Rotation des geheimen Schlüssels. |
unit |
Die Geräte für das Zeitintervall für die Rotation des geheimen Schlüssels. Zulässige Werte sind: Tag, Monat |
Beispielanforderung
Legen Sie eine Rotationsrichtlinie für einen geheimen username_password-Schlüssel in der default-Gruppe geheimer Schlüssel fest.
curl -X PUT "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/secrets/{secret_id}/policies" \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
--data-raw '{
"policies": [
{
"rotation": {
"interval": 10,
"unit": "day"
},
"type": "application/vnd.ibm.secrets-manager.secret.policy+json"
}
]
}'
Legen Sie eine Rotationsrichtlinie für einen geheimen username_password-Schlüssel in einer vorhandenen Gruppe geheimer Schlüssel fest.
curl -X PUT "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/secrets/groups/{group_id}/{secret_id}/policies" \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"policies": [
{
"rotation": {
"interval": 10,
"unit": "day"
},
"type": "application/vnd.ibm.secrets-manager.secret.policy+json"
}
]
}'
Beispielantwort
{
"request_id": "89698bdc-d787-4a74-eb2f-53e055ddc7f3",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"policies": [
{
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2021-06-21T14:30:17Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:policy:ea1907c8-8c8e-6b83-3c20-05f2015b80d8",
"id": "ea1907c8-8c8e-6b83-3c20-05f2015b80d8",
"last_update_date": "2021-06-21T14:33:41Z",
"rotation": {
"interval": 10,
"unit": "day"
},
"type": "application/vnd.ibm.secrets-manager.secret.policy+json",
"updated_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0"
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Richtlinien für geheime Schlüssel aufführen
Ruft eine Liste der Richtlinien ab, die einem geheimen Schlüssel zugeordnet sind.
Beispielanforderung
Listet die Richtlinien für einen geheimen username_password-Schlüssel auf
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/secrets/{secret_id}/policies" \
-H 'X-Vault-Token: {Vault-Token}'
Listet die Richtlinien für einen geheimen username_password Schlüssel in einer vorhandenen Gruppe geheimer Schlüssel auf.
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/secrets/groups/{group_id}/{secret_id}/policies" \
-H 'X-Vault-Token: {Vault-Token}'
Beispielantwort
{
"request_id": "89698bdc-d787-4a74-eb2f-53e055ddc7f3",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"policies": [
{
"created_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0",
"creation_date": "2021-06-21T14:30:17Z",
"crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0:policy:ea1907c8-8c8e-6b83-3c20-05f2015b80d8",
"id": "ea1907c8-8c8e-6b83-3c20-05f2015b80d8",
"last_update_date": "2021-06-21T14:33:41Z",
"rotation": {
"interval": 10,
"unit": "day"
},
"type": "application/vnd.ibm.secrets-manager.secret.policy+json",
"updated_by": "iam-ServiceId-c0c7cfa4-b24e-4917-ad74-278f2fee5ba0"
}
]
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Konfiguration
Konfiguration eines Typs für geheime Schlüssel festlegen
Konfiguriert eine Engine eines geheimen Schlüssels, die als Back-End für eine bestimmte Art von geheimen Schlüsseln dient. Sie können die Konfiguration für die folgenden Typen von geheimen Schlüsseln festlegen: iam_credentials
| Anforderungsparameter | Beschreibung |
|---|---|
api_key |
Ein IBM Cloud API-Schlüssel, der Dienst-IDs erstellen und verwalten kann. Dem API-Schlüssel muss die Rolle „Editor-Plattform“ für den Service „Zugriffsgruppenservice“ und die Rolle „Operator-Plattform“ für den IAM-Identitätsservice zugeordnet werden. |
Beispielanforderung
Konfigurieren Sie die iam_credentials-Engine für geheime Schlüssel.
curl -X PUT "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/iam_credentials/config/root" \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"api_key": "<API_KEY>"
}'
Beispielantwort
Eine Anforderung zum Konfigurieren der iam_credentials-Engine für geheime Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "f7ac2068-6b07-7602-76af-093e354a444a",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": null,
"wrap_info": null,
"warnings": null,
"auth": null
}
Konfiguration eines Typs für geheime Schlüssel abrufen
Ruft die Konfiguration einer Engine für geheime Schlüssel ab.
Beispielanforderung
Rufen Sie die Konfiguration der iam_credentials-Engine für geheime Schlüssel ab.
curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/iam_credentials/config/root" \
-H 'X-Vault-Token: {Vault-Token}'
Beispielantwort
Eine Anforderung zum Abrufen der Konfiguration der iam_credentials-Engine für geheime Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "12f0a38d-93a5-6a9a-1997-79928f15c5ea",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"api_key_hash": "caf9eabec3c6dcc7f91cb6ea295eb97c8e34e70b0cf5942d6351d8746d9cc2da"
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Konfiguration hinzufügen
Fügt einer Engine für geheime Schlüssel ein Konfigurationselement hinzu. Diese Methode wird für komplexere Systeme verwendet, z. B. public_cert -und private_cert -Systeme.
Sie können mehrere Konfigurationen für Ihre Instanz hinzufügen:
- Bis zu 10 Konfigurationen öffentlicher Zertifizierungsstellen
- Bis zu 10 DNS-Providerkonfigurationen
- Bis zu 10 Konfigurationen privater Stammzertifizierungsstellen
- Bis zu 10 Konfigurationen für private Zwischenzertifizierungsstellen
- Bis zu 10 Zertifikatvorlagen
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Ein lesbarer Name, der Ihrer Konfiguration der Zertifizierungsstelle zugeordnet werden soll. |
type |
Der Umgebungstyp, z. B. die Let's Encrypt Staging- oder Produktionsumgebung, die der URL entspricht, die Sie für die Bestellung öffentlicher Zertifikate anvisieren möchten. Zulässige Werte: letsencrypt-stage, letsencrypt |
private_key |
Der private Schlüssel, der Ihrem registrierten ACME-Account zugeordnet ist. |
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Ein lesbarer Name, der Ihrer DNS-Providerkonfiguration zugeordnet werden soll. |
type |
Der Name des DNS-Providers, den Sie verwenden möchten. Folgende Werte sind zulässig: cis |
cis_crn |
Der CRN der Cloud Internet Services (CIS)-Instanz, die Sie verwenden wollen. |
cis_apikey |
Ein API-Schlüssel, der Zugriff auf Ihre CIS-Instanz und Secrets Manager-Instanz hat. Alternativ können Sie auch eine Autorisierung zwischen beiden Services erstellen, indem Sie IAM verwenden. |
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Ein lesbarer Name, der Ihrer Konfiguration der Zertifizierungsstelle zugeordnet werden soll. |
type |
Der Typ der Zertifizierungsstelle, die Sie erstellen wollen. Zulässige Werte: root_certificate_authority, intermediate_certificate_authority. |
[params..] |
Eine vollständige Liste der Parameter finden Sie unter Konfiguration hinzufügen. |
| Anforderungsparameter | Beschreibung |
|---|---|
name |
Ein lesbarer Name, der Ihrer Zertifikatsvorlage zugeordnet werden soll |
type |
Der Typ der Konfiguration, die hinzugefügt werden soll. Verwenden Sie für Zertifikatvorlagen certificate_templates. |
[params..] |
Eine vollständige Liste der Parameter finden Sie unter Konfiguration hinzufügen. |
Beispielanforderungen
Fügen Sie eine Konfiguration für eine öffentliche Zertifizierungsstelle hinzu.
curl -X PUT "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/public_cert/config/certificate_authorities" \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d '{
"name": "test-certificate-authority",
"type": "letsencrypt-stage",
"config": {
"private_key": "-----BEGIN PRIVATE KEY-----\nMIICdgIBADANB...(redacted)"
}
}'
Fügen Sie eine Konfiguration für eine private Stammzertifizierungsstelle hinzu.
curl -X POST 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/private_cert/config/root_certificate_authorities' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-H '{
"name": "my-configured-root-ca",
"type": "root_certificate_authority",
"config": {
"max_ttl": "43830h",
"common_name": "example.com",
"crl_disable": false,
"crl_distribution_points_encoded": true,
"issuing_certificates_urls_encoded": true
}
}'
Fügen Sie eine Konfiguration für eine temporäre Zertifizierungsstelle hinzu.
curl -X POST 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/private_cert/config/intermediate_certificate_authorities' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-H '{
"name": "my-configured-intermediate-ca",
"type": "intermediate_certificate_authority",
"config": {
"max_ttl": "26300h",
"common_name": "example.com",
"signing_method": "internal|external",
"issuer": "my-configured-root-ca",
"crl_expiry": "72h",
"crl_disable": false,
"crl_distribution_points_encoded": true,
"issuing_certificates_urls_encoded": true
}
}
Fügen Sie eine Zertifikatsvorlage hinzu.
curl -X POST 'https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/private_cert/config/certificate_templates' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-H '{
"name": "my-configured-certificate-template",
"type": "certificate_template",
"config": {
"certificate_authority": "my-configured-intermediate-ca",
"max_ttl": "8760h",
"allow_any_name": true,
"enforce_hostnames": false,
"allowed_uri_sans": [
"https://www.example.com/test"
]
}
}'
Beispielantworten
Eine Anforderung zum Hinzufügen einer Konfiguration einer öffentlichen Zertifizierungsstelle gibt die folgende Antwort zurück:
{
"request_id": "af1a900d-3cec-7f6d-8878-fa43d1587d90",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"config": {
"private_key": "-----BEGIN PRIVATE KEY-----\nMIICdgIBADANB...(redacted)"
},
"name": "test-certificate-authority",
"type": "letsencrypt-stage"
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Eine Anforderung zum Hinzufügen einer Konfiguration für eine private Zertifizierungsstelle gibt die folgende Antwort zurück:
{
"request_id": "0b221b39-1cd8-fa92-62e5-361c5e1b5d92",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"config": {
"common_name": "example.com",
"country": [],
"crl_disable": false,
"crl_distribution_points_encoded": true,
"crl_expiry": 259200,
"data": {
"certificate": "-----BEGIN CERTIFICATE-----\nMIIGZjCCBU6gAwIBAgIUFsqE2...(redacted",
"expiration": 1808862713,
"issuing_ca": "-----BEGIN CERTIFICATE-----\nMIIGZjCCBU6gAwIBAgIUFsqE2...(redacted)",
"serial_number": "16:ca:84:d8:4f:e5:b0:6c:5c:06:db:51:52:58:c1:3e:0b:96:ce:4f"
},
"exclude_cn_from_sans": false,
"expiration_date": "2027-04-27T21:51:53Z",
"format": "pem",
"issuing_certificates_urls_encoded": true,
"key_bits": 2048,
"key_type": "rsa",
"locality": [],
"max_path_length": -1,
"max_ttl": 157788000,
"organization": [],
"other_sans": [],
"ou": [],
"permitted_dns_domains": [],
"postal_code": [],
"private_key_format": "der",
"province": [],
"status": "configured",
"street_address": [],
"ttl": 157788000
},
"name": "my-configured-root-ca",
"type": "root_certificate_authority"
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Konfiguration aktualisieren
Aktualisiert die Konfiguration einer Engine für geheime Schlüssel, die als Back-End für einen bestimmten Typ von geheimem Schlüssel dient. Sie können die Konfiguration für die folgenden Typen geheimer Schlüssel aktualisieren: iam_credentials,
private_cert, public_cert
Beispielanforderungen
Aktualisiert eine DNS-Providerkonfiguration für die public_cert -Engine für geheime Schlüssel.
curl -X PUT 'https://https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/public_cert/config/dns_providers' \
-H 'X-Vault-Token: {Vault-Token}' \
-H 'Content-Type: application/json' \
-d'{
"name": "my-cis-instance",
"type": "cis",
"config": {
"cis_crn": "crn:v1:bluemix:public:internet-svcs:global:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0::",
"cis_apikey": "<API_KEY>"
}
}'
Beispielantwort
Eine Anforderung zum Hinzufügen einer DNS-Providerkonfiguration für die public_cert-Engine für geheime Schlüssel gibt die folgende Antwort zurück:
{
"request_id": "3c891ae8-18d3-f38e-5b98-dc1db2874f16",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": {
"config": {
"cis_apikey": "mGjiCelas...(redacted)",
"cis_crn": "crn:v1:bluemix:public:internet-svcs:global:a/a5ebf2570dcaedf18d7ed78e216c263a:0f4c764e-dc3d-44d1-bd60-a2f7cd91e0c0::"
},
"name": "my-cis-instance",
"type": "cis"
},
"wrap_info": null,
"warnings": null,
"auth": null
}
Konfiguration löschen
Entfernt eine Konfiguration für eine Engine für geheime Schlüssel, die als Back-End für einen bestimmten Typ geheimer Schlüssel dient. Sie können Konfigurationen für die folgenden Typen von geheimen Schlüsseln löschen: public_cert,
private_cert
Beispielanforderungen
Löschen Sie die Konfiguration einer öffentlichen Zertifizierungsstelle.
curl -X DELETE 'https://https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/public_cert/config/certificate_authorities/my-lets-encrypt' \
-H 'X-Vault-Token: {Vault-Token}' \
Löschen Sie die DNS-Providerkonfiguration.
curl -X DELETE 'https://https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/public_cert/config/dns_providers/my-cis-instance' \
-H 'X-Vault-Token: {Vault-Token}' \
Löscht die Konfiguration einer privaten Zertifizierungsstelle.
curl -X DELETE 'https://https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/private_cert/config/root_certificate_authorities/my-root-ca' \
-H 'X-Vault-Token: {Vault-Token}' \
Beispielantwort
Eine erfolgreiche Anforderung gibt die Antwort HTTP 204 No Content zurück.