Secrets Manager-Befehlszeilenschnittstelle

Sie können die IBM Cloud® Secrets Manager-Befehlszeilenschnittstelle (CLI) verwenden, um die geheimen Schlüssel in Ihrer Secrets Manager-Instanz zu verwalten.

Aktuelle Version: 2.0.16

Voraussetzungen

Installieren Sie die IBM Cloud CLI und anschließend das Secrets Manager CLI-Plug-in, indem Sie den folgenden Befehl ausführen:

ibmcloud plugin install secrets-manager

Sie werden über die Befehlszeile benachrichtigt, wenn Aktualisierungen für die IBM Cloud-CLI und -Plug-ins verfügbar sind. Stellen Sie sicher, dass die Befehlszeilenschnittstelle auf dem neuesten Stand ist, damit Sie die aktuellen Befehle nutzen können. Sie können die aktuelle Version aller installierten Plug-ins anzeigen, indem Sie den Befehl ibmcloud plugin list ausführen.

Anvisieren einer Secrets Manager-Instanz

Verwenden Sie eine der folgenden Optionen, um die Secrets Manager-Instanz als Ziel auszuwählen.

Führen Sie den Befehl ibmcloud secrets-manager config set aus.

ibmcloud secrets-manager config set service-url https://{instance_ID}.{region}.secrets-manager.appdomain.cloud

Exportieren Sie eine Umgebungsvariable mit Ihrer Secrets Manager-Service-Endpoint-URL.

export SECRETS_MANAGER_URL=https://{instance_ID}.{region}.secrets-manager.appdomain.cloud

Definieren Sie den Serviceendpunkt im Befehl.

ibmcloud secrets-manager secrets --service-url https://{instance_ID}.{region}.secrets-manager.appdomain.cloud

Ersetzen Sie {instance_ID} und {region} durch die Werte, die für Ihre Serviceinstanz von Secrets Manager gelten. Um die Endpunkt-URL zu finden, die für Ihre Instanz spezifisch ist, können Sie sie von der Seite Endpunkte in der Benutzerschnittstelle von Secrets Manager kopieren. Weitere Informationen finden Sie unter Endpunkt-URLs anzeigen.

Globals

Befehle

`ibmcloud secrets-manager docs`

Öffnet die Plug-in-Dokumentation im Webbrowser.

ibmcloud secrets-manager docs

Beispiel

ibmcloud secrets-manager docs

Optionen

--instance-id (Zeichenfolge): Die vom Dienstanbieter zugewiesene Secrets Manager Instanz-ID.
--region (Zeichenfolge): Die Region, in der Sie Ihre Secrets Manager-Instanz bereitgestellt haben. Verfügbare Werte: us-south, us-east, au-syd, jp-osa, jp-tok, eu-de, eu-gb, eu-es, ca-tor, ca-mon, br-sao.
--output (Zeichenfolge): Wählen Sie ein Ausgabeformat - Sie können "json", "yaml" oder "table" wählen. Der Standardwert ist 'table'.
-j, --jmes-query (Zeichenfolge): JMESPath-Abfrage zur Anpassung der Ausgabe angeben.
--service-url (Zeichenfolge): Basisendpunkt-URL für API angeben.
-q, --quiet: Unterdrückt Nachrichten mit ausführlichen Informationen.
-v, --version: Druckt die Plug-in-Version.

Beispiel

ibmcloud secrets-manager
    --instance-id=provide-here-your-smgr-instanceuuid \
    --region=us-south \
    --output=json \
    --jmes-query="[:10]" \
    --service-url="https://myservice.cloud.ibm.com"
    --quiet

Dieses Beispiel demonstriert nur die globalen Optionen, die für alle Unterbefehle verfügbar sind, und ist selbst kein gültiger Befehl.

Konfiguration

Globale Parameter können auch in der persistenten Konfiguration gespeichert werden, so dass sie nicht bei jedem Aufruf des Plug-ins manuell angegeben werden müssen. Jeder Parameter kann mit dem Befehl config und seinen Unterbefehlen konfiguriert werden.

ibmcloud secrets-manager config

`ibmcloud secrets-manager config set`

Legt einen neuen Konfigurationswert für eine bestimmte Option fest. Jeder Unterbefehl des Befehls set wird einer globalen Option zugeordnet. Jeder Unterbefehl akzeptiert ein einzelnes Argument, die Zeichenfolgedarstellung des Werts, der für die Option gespeichert werden soll.

ibmcloud secrets-manager config set <option> <value>

Beispiele

ibmcloud secrets-manager config set service-url \
    'https://{instance_id}.{region}.secrets-manager.appdomain.cloud'

`ibmcloud secrets-manager config get`

Druckt den aktuell eingestellten Wert für eine bestimmte Option aus. Jeder Unterbefehl des Befehls get wird einer globalen Option zugeordnet.

ibmcloud secrets-manager config get <option>

Beispiele

ibmcloud secrets-manager config get service-url

`ibmcloud secrets-manager config unset`

Hebt die Festlegung des aktuell festgelegten Werts für eine bestimmte Option auf. Jeder Unterbefehl des Befehls unset wird einer globalen Option zugeordnet.

Für diesen Service sind die folgenden Unterbefehle verfügbar: service-url,

ibmcloud secrets-manager config unset <option>

Beispiele

ibmcloud secrets-manager config unset service-url

`ibmcloud secrets-manager config list`

Listet alle aktuell festgelegten Konfigurationswerte auf.

ibmcloud secrets-manager config list

Beispiele

ibmcloud secrets-manager config list

Geheime Gruppen

Steuern Sie, wer auf geheime Schlüssel zugreifen kann, indem Sie Gruppen erstellen und verwalten

`ibmcloud secrets-manager secret-group-create`

Erstellen Sie eine Geheimhaltungsgruppe, in der Sie Geheimnisse organisieren und kontrollieren können, wer darauf zugreifen kann.

Eine erfolgreiche Anfrage gibt den ID-Wert der geheimen Gruppe zusammen mit anderen Eigenschaften zurück. Weitere Informationen zu Gruppen geheimer Schlüssel finden Sie in der Dokumentation.

ibmcloud secrets-manager secret-group-create --name NAME [--description DESCRIPTION]

Befehlsoptionen

--name (Zeichenfolge)

Der Name Ihrer Gruppe geheimer Schlüssel. Erforderlich.

Die maximale Länge beträgt 64 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/ entsprechen.

--description (Zeichenfolge)

Eine erweiterte Beschreibung Ihrer Gruppe von geheimen Schlüsseln.

Die maximale Länge beträgt 1024 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

Beispiel

ibmcloud secrets-manager secret-group-create \
    --name my-secret-group \
    --description 'Extended description for this group.'

Beispielausgabe

Beispiel für die Antwort SecretGroup

{
  "created_at" : "2020-10-05T21:33:11Z",
  "description" : "Extended description for this group.",
  "id" : "d898bb90-82f6-4d61-b5cc-b079b66cfa76",
  "name" : "my-secret-group",
  "updated_at" : "2020-11-25T22:13:10Z",
  "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21"
}

`ibmcloud secrets-manager secret-groups`

Listet die Gruppen geheimer Schlüssel auf, die in Ihrer Secrets-Manager-Instanz verfügbar sind

ibmcloud secrets-manager secret-groups

Beispiel

ibmcloud secrets-manager secret-groups

Beispielausgabe

Beispiel für eine SecretGroup-Sammlungsantwort

{
  "secret_groups" : [ {
    "created_at" : "2020-09-05T21:33:11Z",
    "description" : "Default Secret Group",
    "id" : "ee52ebb6-1728-4580-8ede-13f6504e3ae0",
    "name" : "default",
    "updated_at" : "2020-09-25T22:13:10Z",
    "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21"
  }, {
    "created_at" : "2020-10-05T21:33:11Z",
    "description" : "Extended description for this group.",
    "id" : "cb52ebb6-1728-4580-8ede-13f6504e3ae0",
    "name" : "my-secret-group",
    "updated_at" : "2020-11-25T22:13:10Z",
    "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21"
  }, {
    "created_at" : "2020-10-05T22:05:15Z",
    "description" : "Extended description for this group.",
    "id" : "19f88b9c-4f2f-405c-b877-a09338575c3f",
    "name" : "my-second-secret-group",
    "updated_at" : "2020-11-25T22:13:10Z",
    "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21"
  } ],
  "total_count" : 3
}

Standard-JMESPath

Standardmäßig wird eine JMESPath-Abfrage auf die Ausgabe dieses Befehls angewendet, sofern der Benutzer keine eigene Abfrage bereitstellt. Die genaue Abfrage hängt vom Szenario und dem gewünschten Ausgabeformat ab. In der folgenden Tabelle sehen Sie den Status für jede standardmäßige JMESPath-Abfrage:

Standard-JMESPfad
Antwort	Ausgabe	Abfrage
Erfolg	Standard
	Tabelle	`secret_groups[*]`
Fehler	Standard
	Tabelle	`secret_groups[*]`
Alle Seiten	Standard
	Tabelle	`secret_groups[*]`

Wenn eine benutzerdefinierte JMESPath-Abfrage bereitgestellt wird, ersetzt diese jede JMESPath in der obigen Tabelle.

`ibmcloud secrets-manager secret-group`

Abrufen der Eigenschaften einer bestehenden geheimen Gruppe durch Angabe der ID der Gruppe.

ibmcloud secrets-manager secret-group --secret-group-id SECRET-GROUP-ID

Befehlsoptionen

--secret-group-id (Zeichenfolge)

Die ID der Gruppe geheimer Schlüssel. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 7 Zeichen. Der Wert muss dem regulären Ausdruck /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/ entsprechen.

Beispiel

ibmcloud secrets-manager secret-group \
    --secret-group-id d898bb90-82f6-4d61-b5cc-b079b66cfa76

Beispielausgabe

Beispiel für die Antwort SecretGroup

{
  "created_at" : "2020-10-05T21:33:11Z",
  "description" : "Extended description for this group.",
  "id" : "d898bb90-82f6-4d61-b5cc-b079b66cfa76",
  "name" : "my-secret-group",
  "updated_at" : "2020-11-25T22:13:10Z",
  "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21"
}

`ibmcloud secrets-manager secret-group-update`

Aktualisieren Sie die Eigenschaften einer bestehenden geheimen Gruppe, z. B. ihren Namen oder ihre Beschreibung.

ibmcloud secrets-manager secret-group-update --id ID [--name NAME] [--description DESCRIPTION]

Befehlsoptionen

--id (Zeichenfolge)

Die ID der Gruppe geheimer Schlüssel. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--secret-group-patch (generische Map)

Der Anforderungshauptteil zur Aktualisierung einer Gruppe geheimer Schlüssel. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

Geben Sie eine JSON-Zeichenfolgeoption an oder geben Sie eine JSON-Datei an, aus der gelesen werden soll, indem Sie eine Dateipfadoption angeben, die mit einem @ beginnt, z. B. --secret-group-patch=@path/to/file.json.

--name (Zeichenfolge)

Der Name Ihrer Gruppe geheimer Schlüssel. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "secret-group-patch". Sie und diese Option schließen sich gegenseitig aus.

--description (Zeichenfolge)

Eine erweiterte Beschreibung Ihrer Gruppe von geheimen Schlüsseln. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "secret-group-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 1024 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

Beispiel

ibmcloud secrets-manager secret-group-update \
    --id d898bb90-82f6-4d61-b5cc-b079b66cfa76 \
    --name my-secret-group \
    --description 'Extended description for this group.'

Beispielausgabe

Beispiel für die Antwort SecretGroup

{
  "created_at" : "2020-10-05T21:33:11Z",
  "description" : "Extended description for this group.",
  "id" : "d898bb90-82f6-4d61-b5cc-b079b66cfa76",
  "name" : "my-secret-group",
  "updated_at" : "2020-11-25T22:13:10Z",
  "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21"
}

`ibmcloud secrets-manager secret-group-delete`

Löschen Sie eine Gruppe geheimer Schlüssel, indem Sie die ID der Gruppe geheimer Schlüssel angeben.

Hinweis: Eine Gruppe geheimer Schlüssel kann nur gelöscht werden, wenn sie leer ist. Wenn Sie eine geheime Gruppe, die Geheimnisse enthält, entfernen möchten, müssen Sie zuerst die Geheimnisse löschen, die mit der Gruppe verbunden sind.

ibmcloud secrets-manager secret-group-delete --id ID

Befehlsoptionen

--id (Zeichenfolge)

Die ID der Gruppe geheimer Schlüssel. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

Beispiel

ibmcloud secrets-manager secret-group-delete \
    --id d898bb90-82f6-4d61-b5cc-b079b66cfa76

Geheime Schlüssel

Erstellen, bestellen und verwalten Sie verschiedene Arten von Geheimnissen für Ihre Anwendungen und Dienste.

`ibmcloud secrets-manager secret-create`

Erstellen Sie einen geheimen Schlüssel oder importieren Sie einen vorhandenen Wert, den Sie für den Zugriff auf oder die Authentifizierung bei einer geschützten Ressource verwenden können.

Verwenden Sie diesen Vorgang, um ein vorhandenes Geheimnis zu generieren oder zu importieren, z. B. ein TLS Zertifikat, das Sie in Ihrer Secrets Manager Dienstinstanz verwalten können. Eine erfolgreiche Anfrage speichert das Geheimnis in Ihrer speziellen Instanz, basierend auf dem Geheimnistyp und den Daten, die Sie angeben. Die Antwort gibt den ID-Wert des geheimen Schlüssels zusammen mit anderen Metadaten zurück.

Weitere Informationen zu den Typen von geheimen Schlüsseln, die Sie mit Secrets Manager erstellen können, enthält die Dokumention.

ibmcloud secrets-manager secret-create [--secret-prototype SECRET-PROTOTYPE | --secret-custom-metadata SECRET-CUSTOM-METADATA --secret-description SECRET-DESCRIPTION --secret-expiration-date SECRET-EXPIRATION-DATE --secret-labels SECRET-LABELS --secret-name SECRET-NAME --secret-group-id SECRET-GROUP-ID --secret-type SECRET-TYPE --arbitrary-payload ARBITRARY-PAYLOAD --secret-version-custom-metadata SECRET-VERSION-CUSTOM-METADATA --secret-ttl SECRET-TTL --iam-credentials-access-groups IAM-CREDENTIALS-ACCESS-GROUPS --iam-credentials-service-id IAM-CREDENTIALS-SERVICE-ID --iam-credentials-account-id IAM-CREDENTIALS-ACCOUNT-ID --iam-credentials-reuse-apikey=IAM-CREDENTIALS-REUSE-APIKEY --secret-rotation SECRET-ROTATION --imported-cert-certificate IMPORTED-CERT-CERTIFICATE --imported-cert-intermediate IMPORTED-CERT-INTERMEDIATE --imported-cert-private-key IMPORTED-CERT-PRIVATE-KEY --imported-cert-managed-csr IMPORTED-CERT-MANAGED-CSR --kv-data KV-DATA --private-cert-template-name PRIVATE-CERT-TEMPLATE-NAME --certificate-common-name CERTIFICATE-COMMON-NAME --certificate-alt-names CERTIFICATE-ALT-NAMES --private-cert-ip-sans PRIVATE-CERT-IP-SANS --private-cert-uri-sans PRIVATE-CERT-URI-SANS --private-cert-other-sans PRIVATE-CERT-OTHER-SANS --private-cert-csr PRIVATE-CERT-CSR --private-cert-format PRIVATE-CERT-FORMAT --private-cert-private-key-format PRIVATE-CERT-PRIVATE-KEY-FORMAT --private-cert-exclude-cn-from-sans=PRIVATE-CERT-EXCLUDE-CN-FROM-SANS --public-cert-key-algorithm PUBLIC-CERT-KEY-ALGORITHM --public-cert-ca PUBLIC-CERT-CA --public-cert-dns PUBLIC-CERT-DNS --public-cert-bundle-ca=PUBLIC-CERT-BUNDLE-CA --secret-source-service SECRET-SOURCE-SERVICE --username-password-username USERNAME-PASSWORD-USERNAME --username-password-password USERNAME-PASSWORD-PASSWORD --username-password-policy USERNAME-PASSWORD-POLICY --custom-credentials-configuration CUSTOM-CREDENTIALS-CONFIGURATION --custom-credentials-parameters CUSTOM-CREDENTIALS-PARAMETERS]

Befehlsoptionen

--secret-prototype (SecretPrototype)

Eine JSON-Datei mit den erforderlichen Details zum Erstellen eines geheimen Schlüssels. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--secret-custom-metadata (generische Map)

Die Metadaten des geheimen Schlüssels, die Benutzer anpassen können. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--secret-description (Zeichenfolge)

Eine erweiterte Beschreibung Ihres geheimen Schlüssels. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 1024 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--secret-expiration-date (strfmt.DateTime)

Das Datum, an dem das geheime Material abläuft. Das Datumsformat entspricht dem Format RFC 3339. Unterstützte Typen geheimer Schlüssel: arbitrary, username_password. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--secret-labels ([]zeichenfolge)

Bezeichnungen, die Sie zum Suchen nach geheimen Schlüsseln in Ihrer Instanz verwenden können. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 30. Die Mindestlänge beträgt 0.

--secret-name (Zeichenfolge)

Ein lesbarer Name, der Ihrem geheimen Schlüssel zugeordnet werden soll. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/ entsprechen.

--secret-group-id (Zeichenfolge)

Ein UUID-Bezeichner oder default geheime Gruppe. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--secret-type (Zeichenfolge)

Der Typ des geheimen Schlüssels. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Erlaubte Werte sind: arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, username_password, custom_credentials.

--arbitrary-payload (Zeichenfolge)

Die geheimen Daten, die einem arbitrary secret zugeordnet sind. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 1000000 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--secret-version-custom-metadata (generische Map)

Die Metadaten der Version des geheimen Schlüssels, die Benutzer anpassen können. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--secret-ttl (Zeichenfolge)

Die Lebensdauer (Time-to-Live, TTL) oder die Dauer des Leasingverhältnisses, die generierten Berechtigungsnachweisen zugeordnet werden soll. Unterstützte Typen für geheime Schlüssel: iam_credentials, service_credentials, custom_credentials. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 10 Zeichen. Der Wert muss mit dem regulären Ausdruck /^[0-9]+[s,m,h,d]{0,1}$/übereinstimmen.

--iam-credentials-access-groups ([]zeichenfolge)

Zugriffsgruppen, die Sie für ein iam_credentials Geheimnis verwenden können. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /^AccessGroupId-[a-z0-9-]+[a-z0-9]$/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge ist 1 item.

--iam-credentials-service-id (Zeichenfolge)

Die Service-ID, unter der der API-Schlüssel erstellt wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Länge muss 46 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /^ServiceId-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/übereinstimmen.

--iam-credentials-account-id (Zeichenfolge)

Die ID des Kontos, für das die IAM-Anmeldeinformationen erstellt werden. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Länge muss 32 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /^[a-z0-9]*$/übereinstimmen.

--iam-credentials-reuse-apikey (boolescher Wert)

Dieser Parameter gibt an, ob die Service-ID und der API-Schlüssel für zukünftige Leseoperationen wiederverwendet werden. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--secret-rotation (RotationPolicy)

Dieses Feld gibt an, ob Secrets Manager Ihre geheimen Schlüssel automatisch wechseln soll. Unterstützte Typen für geheime Schlüssel: username_password, private_cert, public_cert, iam_credentials, custom_credentials. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--imported-cert-certificate (Zeichenfolge)

Der PEM-codierte Inhalt Ihres Zertifikats. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 100000 Zeichen. Die Mindestlänge beträgt 50 Zeichen. Der Wert muss dem regulären Ausdruck /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/ entsprechen.

--imported-cert-intermediate (Zeichenfolge)

(Optional) Das PEM-codierte Zwischenzertifikat, das dem Stammzertifikat zugeordnet ist Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 100000 Zeichen. Die Mindestlänge beträgt 50 Zeichen. Der Wert muss dem regulären Ausdruck /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/ entsprechen.

--imported-cert-private-key (Zeichenfolge)

(Optional) Der PEM-codierte private Schlüssel, der dem Zertifikat zugeordnet werden soll. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 100000 Zeichen. Die Mindestlänge beträgt 50 Zeichen. Der Wert muss dem regulären Ausdruck /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/ entsprechen.

--imported-cert-managed-csr (ImportedCertificateManagedCsr)

Die zur Erstellung der CSR und des privaten Schlüssels angegebenen Daten. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--kv-data (generische Map)

Die Nutzdaten eines geheimen Schlüssel für Schlüssel/Wert. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Mindestlänge ist 1 item.

--private-cert-template-name (Zeichenfolge)

Der Name der Zertifikatsvorlage. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/ entsprechen.

--certificate-common-name (Zeichenfolge)

Der allgemeine Name (Common Name, CN) steht für den Servernamen, der durch das SSL-Zertifikat geschützt wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Mindestlänge beträgt 4 Zeichen.

--certificate-alt-names ([]zeichenfolge)

Im Feld 'Alternativer Name des Subjekts' können Sie zusätzliche Hostnamen angeben, die durch ein einziges SSL-Zertifikat geschützt werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /^(.*?)$/ entsprechen. Die maximale Länge beträgt 99. Die Mindestlänge beträgt 0.

--private-cert-ip-sans (Zeichenfolge)

Die IP-SANs (Subject Alternative Names), die für das CA-Zertifikat definiert werden sollen, in einer durch Kommas begrenzten Liste. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 2048 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--private-cert-uri-sans (Zeichenfolge)

Die URI-SANs (Subject Alternative Names), die für das CA-Zertifikat definiert werden sollen, in einer durch Kommas begrenzten Liste. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 2048 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--private-cert-other-sans ([]zeichenfolge)

Die benutzerdefinierte Objekt-ID (OID) oder UTF8-string-SANs (Subject Alternative Names), die für das CA-Zertifikat definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-csr (Zeichenfolge)

Die Zertifikatssignieranforderung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 4096 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/ entsprechen.

--private-cert-format (Zeichenfolge)

Das Format der zurückgegebenen Daten. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Zulässige Werte: pem, pem_bundle.

--private-cert-private-key-format (Zeichenfolge)

Das Format des generierten privaten Schlüssels. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Standardwert ist der. Erlaubte Werte sind: der, pkcs8.

--private-cert-exclude-cn-from-sans (boolescher Wert)

Dieser Parameter steuert, ob der allgemeine Name aus SANs (Subject Alternative Names) ausgeschlossen wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--public-cert-key-algorithm (Zeichenfolge)

Die Kennung für den Verschlüsselungsalgorithmus, der zum Generieren des öffentlichen Schlüssels verwendet wird, der dem Zertifikat zugeordnet ist. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Standardwert ist RSA2048. Die maximale Länge beträgt 8 Zeichen. Die Mindestlänge beträgt 5 Zeichen. Der Wert muss dem regulären Ausdruck /^(RSA2048|RSA4096|ECDSA256|ECDSA384)$/ entsprechen.

--public-cert-ca (Zeichenfolge)

Der Name der Konfiguration der Zertifizierungsstelle. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--public-cert-dns (Zeichenfolge)

Der Name der DNS-Providerkonfiguration. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--public-cert-bundle-ca (boolescher Wert)

Dieses Feld gibt an, ob das ausgestellte Zertifikat mit Zwischenzertifikaten gebündelt ist. Setzen Sie diese Option auf false, wenn die Zertifikatsdatei nur das ausgestellte Zertifikat enthalten soll. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Standardwert ist true.

--secret-source-service (ServiceCredentialsSecretSourceService)

Die Eigenschaften, die zum Erstellen der Serviceberechtigungsnachweise für die angegebene Quellenserviceinstanz erforderlich sind. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--username-password-username (Zeichenfolge)

Der Benutzername, der einem username_password Geheimnis zugewiesen ist. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 64 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /[A-Za-z0-9+-=.]*/ entsprechen.

--username-password-password (Zeichenfolge)

Das Passwort, das einem username_password Geheimnis zugeordnet ist. Wenn Sie diesen Parameter weglassen, generiert Secrets Manager ein neues zufälliges Kennwort für Ihren geheimen Schlüssel. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 6 Zeichen. Der Wert muss dem regulären Ausdruck /.{6,256}/ entsprechen.

--username-password-policy (PasswordGenerationPolicy)

Richtlinie für automatisch generierte Kennwörter. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--custom-credentials-configuration (Zeichenfolge)

Der Name der Konfiguration für benutzerdefinierte Berechtigungsnachweise. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[a-zA-Z0-9]([-a-zA-Z0-9\\-_\\.]*)?$/ entsprechen.

--custom-credentials-parameters (generische Map)

Die Parameter, die an die Engine für benutzerdefinierte Berechtigungsnachweise übergeben werden. Erlaubte Typen sind String, Integer und Boolean. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Beispiel

Beispielanforderung

ibmcloud secrets-manager secret-create \
  --secret-name example-arbitrary-secret \
  --secret-type arbitrary \
  --arbitrary-payload example-secret-data

`ibmcloud secrets-manager secrets`

Listet die geheimen Schlüssel auf, die in Ihrer Secrets Manager-Instanz verfügbar sind. Anmerkung: Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne Seite der Objektgruppe ab.

ibmcloud secrets-manager secrets [--offset OFFSET] [--limit LIMIT] [--sort SORT] [--search SEARCH] [--groups GROUPS] [--secret-types SECRET-TYPES] [--match-all-labels MATCH-ALL-LABELS]

Befehlsoptionen

--offset (int64)

Die Anzahl der zu überspringenden geheimen Schlüssel.

Der Standardwert ist 0. Der Höchstwert ist 10000000. Der Mindestwert ist 0.

--limit (int64)

Anzahl der aufzulistenden geheimen Schlüssel

Der Standardwert ist 200. Der Höchstwert ist 1000. Der Mindestwert ist 1.

--sort (Zeichenfolge)

Sortiert eine Sammlung von geheimen Schlüsseln nach dem angegebenen Feld in aufsteigender Reihenfolge. Um in absteigender Reihenfolge zu sortieren, verwenden Sie das Zeichen -.

--search (Zeichenfolge)

Filtert geheime Schlüssel, die die angegebene Zeichenfolge in mindestens einem der folgenden Felder enthalten: "id", "name", "description", "labels", "secret_type".

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--groups ([]zeichenfolge)

Geheime Schlüssel nach Gruppen filtern. Geben Sie die IDs der Gruppen an, nach denen gefiltert werden soll.

Die Listenelemente müssen dem regulären Ausdruck /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/ entsprechen. Die maximale Länge beträgt 201. Die Mindestlänge beträgt 0.

--secret-types ([]zeichenfolge)

Geheime Schlüssel nach Typen filtern. Geben Sie die Typen geheimer Schlüssel an, nach denen gefiltert werden soll.

Erlaubte Listenelemente sind: arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, username_password, custom_credentials. Die maximale Länge beträgt 9. Die Mindestlänge beträgt 0.

--match-all-labels ([]zeichenfolge)

Geheime Schlüssel nach Bezeichnungen filtern. Geben Sie die Bezeichnungen an, nach denen gefiltert werden soll.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 30. Die Mindestlänge beträgt 0.

--all-pages (boolescher Wert)

Ruft mehrere Anforderungen auf, um alle Seiten der Sammlung für geheime Schlüssel anzuzeigen.

Beispiel

ibmcloud secrets-manager secrets \
    --offset 0 \
    --limit 10 \
    --sort created_at \
    --search example \
    --groups default,cac40995-c37a-4dcb-9506-472869077634 \
    --secret-types arbitrary,iam_credentials,imported_cert,kv,private_cert,public_cert,service_credentials,username_password,custom_credentials \
    --match-all-labels dev,us-south

Beispielausgabe

Beispiel für eine Antwort zur Erfassung von Metadaten für geheime Schlüssel

{
  "first" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets?limit=50"
  },
  "previous" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets?offset=50&limit=50"
  },
  "last" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets?offset=200&limit=50"
  },
  "limit" : 50,
  "next" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets?offset=150&limit=50"
  },
  "offset" : 100,
  "secrets" : [ {
    "alt_names" : [ "s1.example.com", "*.s2.example.com" ],
    "common_name" : "example.com",
    "created_at" : "2020-10-05T21:33:11Z",
    "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
    "crn" : "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:a931192f-b6a9-43d6-a59a-834f3003af7b",
    "custom_metadata" : {
      "metadata_custom_key" : "metadata_custom_value"
    },
    "description" : "Extended description for this secret.",
    "downloaded" : false,
    "expiration_date" : "2030-10-05T11:49:42Z",
    "id" : "a931192f-b6a9-43d6-a59a-834f3003af7b",
    "intermediate_included" : true,
    "issuer" : "DigiCert",
    "key_algorithm" : "RSA2048",
    "labels" : [ "dev", "us-south" ],
    "locks_total" : 0,
    "name" : "my-imported-certificate",
    "private_key_included" : true,
    "secret_group_id" : "bfc0a4a9-3d58-4fda-945b-76756af516aa",
    "serial_number" : "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd",
    "secret_type" : "imported_cert",
    "signing_algorithm" : "SHA256-RSA",
    "state" : 1,
    "state_description" : "active",
    "updated_at" : "2022-10-05T21:33:11Z",
    "validity" : {
      "not_before" : "2020-10-05T21:33:11Z",
      "not_after" : "2030-10-05T11:49:42Z"
    },
    "versions_total" : 1
  }, {
    "alt_names" : [ "s1.example.com", "*.s2.example.com" ],
    "common_name" : "example.com",
    "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
    "created_at" : "2020-10-05T21:33:11Z",
    "crn" : "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:cb7a2502-8ede-47d6-b5b6-1b7af6b6f563",
    "custom_metadata" : {
      "metadata_custom_key" : "metadata_custom_value"
    },
    "description" : "Extended description for this secret.",
    "downloaded" : false,
    "expiration_date" : "2030-10-05T11:49:42Z",
    "id" : "f075f0b3-71e4-4a14-b60f-0b38b855a3d1",
    "issuer" : "Lets Encrypt",
    "issuance_info" : {
      "auto_rotated" : false,
      "ordered_on" : "2022-10-06T06:15:55Z",
      "state" : 1,
      "state_description" : "active"
    },
    "bundle_certs" : true,
    "ca" : "lets-encrypt-config",
    "dns" : "cloud-internet-services-config",
    "key_algorithm" : "RSA2048",
    "labels" : [ "dev", "us-south" ],
    "updated_at" : "2022-10-05T21:33:11Z",
    "locks_total" : 0,
    "name" : "my-public-certificate",
    "rotation" : {
      "auto_rotate" : true,
      "rotate_keys" : true
    },
    "secret_group_id" : "bfc0a4a9-3d58-4fda-945b-76756af516aa",
    "serial_number" : "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd",
    "secret_type" : "public_cert",
    "signing_algorithm" : "SHA256-RSA",
    "state" : 1,
    "state_description" : "active",
    "validity" : {
      "not_before" : "2020-10-05T21:33:11Z",
      "not_after" : "2030-10-05T11:49:42Z"
    },
    "versions_total" : 1
  } ],
  "total_count" : 232
}

Standard-JMESPath

Standard-JMESPfad
Antwort	Ausgabe	Abfrage
Erfolg	Standard
	Tabelle	`secrets[*].{Name:name,ID:id,Secret_Type:secret_type,secret_group_id:secret_group_id,State:state_description,Locks:locks_total,Expiration:expiration_date}`
Fehler	Standard
	Tabelle	`secrets[*].{Name:name,ID:id,Secret_Type:secret_type,secret_group_id:secret_group_id,State:state_description,Locks:locks_total,Expiration:expiration_date}`
Alle Seiten	Standard
	Tabelle	`secrets[*].{Name:name,ID:id,Secret_Type:secret_type,secret_group_id:secret_group_id,State:state_description,Locks:locks_total,Expiration:expiration_date}`

Wenn eine benutzerdefinierte JMESPath-Abfrage bereitgestellt wird, ersetzt diese jede JMESPath in der obigen Tabelle.

`ibmcloud secrets-manager secret`

Rufen Sie einen geheimen Schlüssel und seine Details ab, indem Sie die ID des geheimen Schlüssels angeben.

Eine erfolgreiche Anforderung gibt die Daten des geheimen Schlüssels zusammen mit anderen Metadaten zurück. Wenn Sie nur die Details eines angegebenen Geheimnisses anzeigen möchten, ohne dessen Wert abzurufen, verwenden Sie den Vorgang "Get secret metadata".

ibmcloud secrets-manager secret --id ID

Befehlsoptionen

--id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

Beispiel

ibmcloud secrets-manager secret \
    --id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46

`ibmcloud secrets-manager secret-delete`

Löschen Sie einen geheimen Schlüssel, indem Sie die ID des geheimen Schlüssels angeben.

ibmcloud secrets-manager secret-delete --id ID [--force-delete=FORCE-DELETE]

Befehlsoptionen

--id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--force-delete (boolescher Wert)

Setzen Sie diese Option auf true, um das Löschen des Geheimnisses zu erzwingen. Nur für geheime Schlüssel vom Typ eines benutzerdefinierten Berechtigungsnachweises verfügbar.

Der Standardwert ist false.

Beispiel

ibmcloud secrets-manager secret-delete \
    --id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --force-delete=false

`ibmcloud secrets-manager secret-metadata`

Abrufen der Metadaten eines Geheimnisses durch Angabe der ID des Geheimnisses.

ibmcloud secrets-manager secret-metadata --id ID

Befehlsoptionen

--id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

Beispiel

ibmcloud secrets-manager secret-metadata \
    --id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46

`ibmcloud secrets-manager secret-metadata-update`

Aktualisiert die Metadaten eines geheimen Schlüssels, z. B. den Namen oder die Beschreibung.

ibmcloud secrets-manager secret-metadata-update --id ID [--name NAME] [--description DESCRIPTION] [--labels LABELS] [--custom-metadata CUSTOM-METADATA] [--expiration-date EXPIRATION-DATE] [--ttl TTL] [--rotation ROTATION] [--imported-cert-managed-csr IMPORTED-CERT-MANAGED-CSR] [--password-generation-policy PASSWORD-GENERATION-POLICY] [--custom-credentials-parameters CUSTOM-CREDENTIALS-PARAMETERS]

Befehlsoptionen

--id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--secret-metadata-patch (generische Map)

JSON-Merge-Patch-Inhalt für update_secret_metadata. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--name (Zeichenfolge)

Ein lesbarer Name, der Ihrem geheimen Schlüssel zugeordnet werden soll. Diese Option liefert einen Wert für ein Teilfeld der JSON-Option "secret-metadata-patch". Sie und diese Option schließen sich gegenseitig aus.

--description (Zeichenfolge)

Eine erweiterte Beschreibung Ihres geheimen Schlüssels. Diese Option liefert einen Wert für ein Teilfeld der JSON-Option "secret-metadata-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 1024 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--labels ([]zeichenfolge)

Bezeichnungen, die Sie zum Suchen nach geheimen Schlüsseln in Ihrer Instanz verwenden können. Diese Option liefert einen Wert für ein Teilfeld der JSON-Option "secret-metadata-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 30. Die Mindestlänge beträgt 0.

--custom-metadata (generische Map)

Die Metadaten des geheimen Schlüssels, die Benutzer anpassen können. Es sollte eine JSON-Zeichenfolge oder ein Pfad zu einer JSON-Datei sein. Diese Option liefert einen Wert für ein Teilfeld der JSON-Option "secret-metadata-patch". Sie und diese Option schließen sich gegenseitig aus.

--expiration-date (strfmt.DateTime)

Das Datum, an dem das geheime Material abläuft. Das Datumsformat entspricht dem Format 'RFC 3339'. Unterstützte Typen geheimer Schlüssel: arbitrary, username_password. Diese Option liefert einen Wert für ein Teilfeld der JSON-Option "secret-metadata-patch". Sie und diese Option schließen sich gegenseitig aus.

--ttl (Zeichenfolge)

Die Lebensdauer (Time-to-Live, TTL) oder die Dauer des Leasingverhältnisses, die generierten Berechtigungsnachweisen zugeordnet werden soll. Unterstützte Typen für geheime Schlüssel: iam_credentials, service_credentials, custom_credentials. Diese Option liefert einen Wert für ein Teilfeld der JSON-Option "secret-metadata-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 10 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^[0-9]+[s,m,h,d]{0,1}$/ entsprechen.

--rotation (RotationPolicy)

Dieses Feld gibt an, ob Secrets Manager Ihre geheimen Schlüssel automatisch wechseln soll. Unterstützte Typen für geheime Schlüssel: username_password, private_cert, public_cert, iam_credentials, custom_credentials. Es sollte eine JSON-Zeichenfolge oder ein Pfad zu einer JSON-Datei sein. Diese Option liefert einen Wert für ein Teilfeld der JSON-Option "secret-metadata-patch". Sie und diese Option schließen sich gegenseitig aus.

--imported-cert-managed-csr (ImportedCertificateManagedCsr)

Die zur Erstellung der CSR und des privaten Schlüssels angegebenen Daten. Es sollte eine JSON-Zeichenfolge oder ein Pfad zu einer JSON-Datei sein. Diese Option liefert einen Wert für ein Teilfeld der JSON-Option "secret-metadata-patch". Sie und diese Option schließen sich gegenseitig aus.

--password-generation-policy (PasswordGenerationPolicyPatch)

Richtlinienpatch für automatisch generierte Kennwörter. Die im Patch enthaltenen Richtlinieneigenschaften werden aktualisiert.\nEigenschaften, die nicht in dem Patch enthalten sind, bleiben unverändert. Es sollte eine JSON-Zeichenfolge oder ein Pfad zu einer JSON-Datei sein. Diese Option liefert einen Wert für ein Teilfeld der JSON-Option "secret-metadata-patch". Sie und diese Option schließen sich gegenseitig aus.

--custom-credentials-parameters (generische Map)

Die Parameter, die an die Engine für benutzerdefinierte Berechtigungsnachweise übergeben werden. Erlaubte Typen sind String, Integer und Boolean. Es sollte eine JSON-Zeichenfolge oder ein Pfad zu einer JSON-Datei sein. Diese Option liefert einen Wert für ein Teilfeld der JSON-Option "secret-metadata-patch". Sie und diese Option schließen sich gegenseitig aus.

Beispiel

ibmcloud secrets-manager secret-metadata-update \
    --id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --name updated-arbitrary-secret-name-example \
    --description 'updated Arbitrary Secret description' \
    --labels dev,us-south \
    --custom-metadata '{"anyKey": "anyValue"}' \
    --expiration-date 2033-04-12T23:20:50.520Z

`ibmcloud secrets-manager secret-action-create`

Erstellen Sie eine Aktion für einen geheimen Schlüssel. Dieser Vorgang unterstützt die folgenden Aktionen:.

ibmcloud secrets-manager secret-action-create --id ID [--secret-action-prototype SECRET-ACTION-PROTOTYPE | --secret-action-type SECRET-ACTION-TYPE]

Befehlsoptionen

--id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--secret-action-prototype (SecretActionPrototype)

Der Anforderungshauptteil zur Angabe der Eigenschaften für Ihre geheime Aktion. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--secret-action-type (Zeichenfolge)

Der Typ der Aktion für geheimen Schlüssel. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Zulässige Werte: public_cert_action_validate_dns_challenge, private_cert_action_revoke_certificate.

Beispiel

Beispielanforderung

ibmcloud secrets-manager secret-action-create --id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 --secret-action-type=public_cert_action_validate_dns_challenge

ibmcloud secrets-manager secret-action-create \
  --id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
  --secret-action-prototype='{"action_type": "public_cert_action_validate_dns_challenge"}'

`ibmcloud secrets-manager secret-by-name`

Rufen Sie ein Geheimnis und seine Details ab, indem Sie den Namen und den Typ des Geheimnisses angeben.

ibmcloud secrets-manager secret-by-name --secret-type SECRET-TYPE --name NAME --secret-group-name SECRET-GROUP-NAME

Befehlsoptionen

--secret-type (Zeichenfolge)

Der Typ des geheimen Schlüssels. Erforderlich.

Erlaubte Werte sind: arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, username_password, custom_credentials.

--name (Zeichenfolge)

Ein lesbarer Name, der Ihrem geheimen Schlüssel zugeordnet werden soll. Um Ihre Privatsphäre zu schützen, sollten Sie keine persönlichen Daten, wie z. B. Ihren Namen oder Ihren Wohnort, als Namen für Ihr Geheimnis verwenden. Erforderlich.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^\\w(([\\w-.]+)?\\w)?$/ entsprechen.

--secret-group-name (Zeichenfolge)

Der Name Ihrer Gruppe geheimer Schlüssel. Erforderlich.

Die maximale Länge beträgt 64 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

Beispiel

ibmcloud secrets-manager secret-by-name \
    --secret-type arbitrary \
    --name my-secret \
    --secret-group-name default

Geheime Versionen

Erstellen und verwalten Sie die Versionen Ihrer geheimen Schlüssel.

`ibmcloud secrets-manager secret-version-create`

Erstellt eine neue Version des geheimen Schlüssels.

ibmcloud secrets-manager secret-version-create --secret-id SECRET-ID [--secret-version-prototype SECRET-VERSION-PROTOTYPE | --arbitrary-payload ARBITRARY-PAYLOAD --secret-version-custom-metadata SECRET-VERSION-CUSTOM-METADATA --secret-version-version-custom-metadata SECRET-VERSION-VERSION-CUSTOM-METADATA --secret-version-restore-from-version SECRET-VERSION-RESTORE-FROM-VERSION --imported-cert-certificate IMPORTED-CERT-CERTIFICATE --imported-cert-intermediate IMPORTED-CERT-INTERMEDIATE --imported-cert-private-key IMPORTED-CERT-PRIVATE-KEY --kv-data KV-DATA --private-cert-csr PRIVATE-CERT-CSR --public-cert-rotation PUBLIC-CERT-ROTATION --username-password-password USERNAME-PASSWORD-PASSWORD]

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--secret-version-prototype (SecretVersionPrototype)

Gibt die Eigenschaften für Ihre neue Version des geheimen Schlüssels an. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--arbitrary-payload (Zeichenfolge)

Die geheimen Daten, die einem arbitrary secret zugeordnet sind. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-version-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 1000000 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--secret-version-custom-metadata (generische Map)

Die Metadaten des geheimen Schlüssels, die Benutzer anpassen können. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-version-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--secret-version-version-custom-metadata (generische Map)

Die Metadaten der Version des geheimen Schlüssels, die Benutzer anpassen können. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-version-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--secret-version-restore-from-version (Zeichenfolge)

Ein UUID-Bezeichner oder current oder previous geheime Versions-Aliase. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-version-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--imported-cert-certificate (Zeichenfolge)

Der PEM-codierte Inhalt Ihres Zertifikats. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-version-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 100000 Zeichen. Die Mindestlänge beträgt 50 Zeichen. Der Wert muss dem regulären Ausdruck /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/ entsprechen.

--imported-cert-intermediate (Zeichenfolge)

(Optional) Das PEM-codierte Zwischenzertifikat, das dem Stammzertifikat zugeordnet ist Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-version-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 100000 Zeichen. Die Mindestlänge beträgt 50 Zeichen. Der Wert muss dem regulären Ausdruck /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/ entsprechen.

--imported-cert-private-key (Zeichenfolge)

(Optional) Der PEM-codierte private Schlüssel, der dem Zertifikat zugeordnet werden soll. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-version-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 100000 Zeichen. Die Mindestlänge beträgt 50 Zeichen. Der Wert muss dem regulären Ausdruck /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/ entsprechen.

--kv-data (generische Map)

Die Nutzdaten eines geheimen Schlüssel für Schlüssel/Wert. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-version-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Mindestlänge ist 1 item.

--private-cert-csr (Zeichenfolge)

Die Zertifikatssignieranforderung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-version-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 4096 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/ entsprechen.

--public-cert-rotation (PublicCertificateRotationObject)

Definiert das Rotationsobjekt, das für die manuelle Rotation öffentlicher Zertifikate verwendet wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-version-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--username-password-password (Zeichenfolge)

Das Passwort, das einem username_password Geheimnis zugeordnet ist. Wenn Sie diesen Parameter weglassen, generiert Secrets Manager ein neues zufälliges Kennwort für Ihren geheimen Schlüssel. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-version-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 6 Zeichen. Der Wert muss dem regulären Ausdruck /.{6,256}/ entsprechen.

Beispiel

Beispielanforderung

ibmcloud secrets-manager secret-version-create --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 --arbitrary-payload='updated secret credentials' --secret-version-custom-metadata='{"anyKey": "anyValue"}'

ibmcloud secrets-manager secret-version-create \
  --secret-id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
  --secret-version-prototype='{"payload": "updated secret credentials", "custom_metadata": {"anyKey": "anyValue"}, "version_custom_metadata": {"anyKey": "anyValue"}}'

`ibmcloud secrets-manager secret-versions`

Listet die Versionen eines geheimen Schlüssels auf.

Eine erfolgreiche Anfrage gibt die Liste der Versionen eines Geheimnisses zusammen mit den Metadaten jeder Version zurück.

ibmcloud secrets-manager secret-versions --secret-id SECRET-ID

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

Beispiel

ibmcloud secrets-manager secret-versions \
    --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46

Beispielausgabe

Beispiel für eine Antwort zur Erfassung der Metadaten der Version des geheimen Schlüssels

{
  "versions" : [ {
    "created_at" : "2022-06-27T11:58:15Z",
    "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
    "expiration_date" : "2030-10-05T11:49:42Z",
    "id" : "bc656587-8fda-4d05-9ad8-b1de1ec7e712",
    "payload_available" : true,
    "secret_group_id" : "67d025e1-0248-418f-83ba-deb0ebfb9b4a",
    "secret_id" : "67d025e1-0248-418f-83ba-deb0ebfb9b4a",
    "secret_name" : "example-imported-certificate",
    "secret_type" : "imported_cert",
    "serial_number" : "38:eb:01:a3:22:e9:de:55:24:56:9b:14:cb:e2:f3:e3:e2:fb:f5:18",
    "validity" : {
      "not_after" : "2030-10-05T11:49:42Z",
      "not_before" : "2022-06-27T11:58:15Z"
    },
    "version_custom_metadata" : {
      "custom_version_key" : "custom_version_value"
    }
  } ],
  "total_count" : 1
}

Standard-JMESPath

Standard-JMESPfad
Antwort	Ausgabe	Abfrage
Erfolg	Standard
	Tabelle	`versions[*]`
Fehler	Standard
	Tabelle	`versions[*]`
Alle Seiten	Standard
	Tabelle	`versions[*]`

Wenn eine benutzerdefinierte JMESPath-Abfrage bereitgestellt wird, ersetzt diese jede JMESPath in der obigen Tabelle.

`ibmcloud secrets-manager secret-version`

Abrufen einer Version eines Geheimnisses durch Angabe der ID der Version. Sie können die Aliasnamen current oder previous verwenden, um auf die aktuelle oder vorherige Version des geheimen Schlüssels zu verweisen.

Eine erfolgreiche Anforderung gibt die Daten des geheimen Schlüssels zurück, die der angegebenen Version Ihres geheimen Schlüssels zugeordnet sind, zusammen mit anderen Metadaten.

ibmcloud secrets-manager secret-version --secret-id SECRET-ID --id ID

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--id (Zeichenfolge)

Die ID der Version des geheimen Schlüssels. Erforderlich.

Beispiel

ibmcloud secrets-manager secret-version \
    --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --id eb4cf24d-9cae-424b-945e-159788a5f535

`ibmcloud secrets-manager secret-version-data-delete`

Löschen Sie die Daten einer geheimen Version, indem Sie deren Versions-ID angeben.

Dieser Vorgang ist für die folgenden Geheimnistypen verfügbar:

iam_credentials nur aktuelle Version

custom_credentials: sowohl aktuelle als auch frühere Versionen.

ibmcloud secrets-manager secret-version-data-delete --secret-id SECRET-ID --id ID

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--id (Zeichenfolge)

Die ID der Version des geheimen Schlüssels. Erforderlich.

Beispiel

ibmcloud secrets-manager secret-version-data-delete \
    --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --id eb4cf24d-9cae-424b-945e-159788a5f535

`ibmcloud secrets-manager secret-version-metadata`

Abrufen der Metadaten einer geheimen Version durch Angabe der ID der Version. Sie können die Aliasnamen current oder previous verwenden, um auf die aktuelle oder vorherige Version des geheimen Schlüssels zu verweisen.

Eine erfolgreiche Anforderung gibt die Metadaten zurück, die der angegebenen Version Ihres geheimen Schlüssels zugeordnet sind.

ibmcloud secrets-manager secret-version-metadata --secret-id SECRET-ID --id ID

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--id (Zeichenfolge)

Die ID der Version des geheimen Schlüssels. Erforderlich.

Beispiel

ibmcloud secrets-manager secret-version-metadata \
    --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --id eb4cf24d-9cae-424b-945e-159788a5f535

`ibmcloud secrets-manager secret-version-metadata-update`

Aktualisieren Sie die angepassten Metadaten einer Version eines geheimen Schlüssels.

ibmcloud secrets-manager secret-version-metadata-update --secret-id SECRET-ID --id ID [--version-custom-metadata VERSION-CUSTOM-METADATA]

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--id (Zeichenfolge)

Die ID der Version des geheimen Schlüssels. Erforderlich.

--secret-version-metadata-patch (generische Map)

JSON-Merge-Patch-Inhalt für update_secret_version_metadata. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--version-custom-metadata (generische Map)

Die Metadaten der Version des geheimen Schlüssels, die Benutzer anpassen können. Es sollte eine JSON-Zeichenfolge oder ein Pfad zu einer JSON-Datei sein. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "secret-version-metadata-patch". Sie und diese Option schließen sich gegenseitig aus.

Beispiel

ibmcloud secrets-manager secret-version-metadata-update \
    --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --id eb4cf24d-9cae-424b-945e-159788a5f535 \
    --version-custom-metadata '{"anyKey": "anyValue"}'

`ibmcloud secrets-manager secret-version-action-create`

Erstellen Sie eine Aktion für eine Version des geheimen Schlüssels. Dieser Vorgang unterstützt die folgenden Aktionen:

private_cert_action_revoke_certificate: Widerrufen Sie eine Version eines privaten Zertifikats.

ibmcloud secrets-manager secret-version-action-create --secret-id SECRET-ID --id ID [--secret-version-action-prototype SECRET-VERSION-ACTION-PROTOTYPE | --secret-version-action-type SECRET-VERSION-ACTION-TYPE]

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--id (Zeichenfolge)

Die ID der Version des geheimen Schlüssels. Erforderlich.

--secret-version-action-prototype (SecretVersionActionPrototype)

Der Anforderungshauptteil zur Angabe der Eigenschaften der Aktion zum Erstellen einer Version des geheimen Schlüssels. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--secret-version-action-type (Zeichenfolge)

Der Typ der Aktion für die Version des geheimen Schlüssels Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'secret-version-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Zulässige Werte: private_cert_action_revoke_certificate.

Beispiel

Beispielanforderung

ibmcloud secrets-manager secret--version-action-create --secret-id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 --id=eb4cf24d-9cae-424b-945e-159788a5f535 --secret-version-action-type=private_cert_action_revoke_certificate

ibmcloud secrets-manager secret-version-action-create \
  --secret-id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
  --id=eb4cf24d-9cae-424b-945e-159788a5f535 \
  --secret-version-action-prototype='{"action_type": "private_cert_action_revoke_certificate"}'

Beispielausgabe

Der Anforderungshauptteil der Aktion zum Widerrufen privater Zertifikatsversionen.

{
  "action_type" : "private_cert_action_revoke_certificate",
  "revocation_time_seconds" : 1667982994
}

Geheime Aufgaben

Überwachen und aktualisieren Sie die Aufgaben, die zu Ihrem Geheimnis gehören.

`ibmcloud secrets-manager secret-tasks`

Listen Sie die Aufgaben zu geheimen Schlüsseln auf.

Unterstützte Geheimnistypen: custom_credentials.

ibmcloud secrets-manager secret-tasks --secret-id SECRET-ID

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

Beispiel

ibmcloud secrets-manager secret-tasks \
    --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46

Beispielausgabe

Beispiel für eine Antwort auf eine Liste aller Aufgaben.

{
  "tasks" : [ {
    "id" : "sm-task-b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
    "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
    "creation_date" : "2022-04-12T23:20:50.52Z",
    "last_update_date" : "2022-04-12T23:21:40.22Z",
    "updated_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
    "type" : "create_credentials",
    "status" : "queued",
    "trigger" : "secret_creation",
    "secret_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
    "secret_version_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5"
  } ]
}

`ibmcloud secrets-manager secret-task`

Rufen Sie die Aufgabe zu einem geheimen Schlüssel und die zugehörigen Details ab, indem Sie die ID der Aufgabe angeben.

Eine erfolgreiche Anforderung gibt die Aufgabe zurück, die Ihrem geheimen Schlüssel zugeordnet ist.

Unterstützte Geheimnistypen: custom_credentials.

ibmcloud secrets-manager secret-task --secret-id SECRET-ID --id ID

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--id (Zeichenfolge)

Die ID, die Ihre Aufgabe eindeutig kennzeichnet. Erforderlich.

Die Länge muss 44 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /^sm-task-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/übereinstimmen.

Beispiel

ibmcloud secrets-manager secret-task \
    --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --id sm-task-a436bebd-dbbd-5c0d-ab35-1232f1234f95

Beispielausgabe

Beispiel für eine Antwort mit einer Geheimaufgabe.

{
  "id" : "sm-task-b49ad24d-81d4-5ebc-b9b9-b0937d1a84d5",
  "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-abeae11c0f21",
  "creation_date" : "2022-04-12T23:20:50.52Z",
  "last_update_date" : "2022-04-12T23:20:50.52Z",
  "updated_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-abeae11c0f21",
  "type" : "create_credentials",
  "status" : "queued",
  "trigger" : "secret_creation",
  "secret_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
  "secret_version_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1a84d5"
}

`ibmcloud secrets-manager secret-task-update`

Ein Callback-Endpunkt zum Aktualisieren einer Aufgabe mit Ergebnissen.

Unterstützte Geheimnistypen: custom_credentials.

ibmcloud secrets-manager secret-task-update --secret-id SECRET-ID --id ID [--task-put TASK-PUT | --task-put-status TASK-PUT-STATUS --task-put-credentials TASK-PUT-CREDENTIALS --task-put-errors TASK-PUT-ERRORS]

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--id (Zeichenfolge)

Die ID, die Ihre Aufgabe eindeutig kennzeichnet. Erforderlich.

Die Länge muss 44 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /^sm-task-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/übereinstimmen.

--task-put (SecretTaskPrototype)

Der Anforderungskörper zur Angabe der Eigenschaften für die Aktualisierung der Aufgabe zu Ihrem geheimen Schlüssel. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--task-put-status (Zeichenfolge)

Beschreibt den Status der Aufgabe zu einem geheimen Schlüssel. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "task-put". Sie und diese Option schließen sich gegenseitig aus.

Zulässige Werte: credentials_created.

--task-put-credentials (CustomCredentialsNewCredentials)

Neu erstellte Berechtigungsnachweise, die vom Anbieter der Berechtigungsnachweise bereitgestellt werden. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "task-put". Sie und diese Option schließen sich gegenseitig aus.

--task-put-errors (SecretTaskError[])

Eine Sammlung von Fehlern. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "task-put". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 10. Die Mindestlänge ist 1 item.

Beispiele

ibmcloud secrets-manager secret-task-update \
    --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --id sm-task-a436bebd-dbbd-5c0d-ab35-1232f1234f95 \
    --task-put '{"status": "credentials_created", "credentials": {"id": "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5", "payload": {"anyKey": "anyValue"}}}'

Alternativ sind differenzierte Optionen für die Unterfelder von JSON-Zeichenfolgeoptionen verfügbar:

ibmcloud secrets-manager secret-task-update \
    --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --id sm-task-a436bebd-dbbd-5c0d-ab35-1232f1234f95 \
    --task-put-status credentials_created \
    --task-put-credentials customCredentialsNewCredentials

Beispielausgabe

Beispiel für eine Antwort mit einer Geheimaufgabe.

{
  "id" : "sm-task-b49ad24d-81d4-5ebc-b9b9-b0937d1a84d5",
  "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-abeae11c0f21",
  "creation_date" : "2022-04-12T23:20:50.52Z",
  "last_update_date" : "2022-04-12T23:20:50.52Z",
  "updated_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-abeae11c0f21",
  "type" : "create_credentials",
  "status" : "queued",
  "trigger" : "secret_creation",
  "secret_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
  "secret_version_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1a84d5"
}

`ibmcloud secrets-manager secret-task-delete`

Sie können eine Aufgabe löschen, indem Sie die ID des geheimen Schlüssels angeben.

Unterstützte Geheimnistypen: custom_credentials.

ibmcloud secrets-manager secret-task-delete --secret-id SECRET-ID --id ID

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--id (Zeichenfolge)

Die ID, die Ihre Aufgabe eindeutig kennzeichnet. Erforderlich.

Die Länge muss 44 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /^sm-task-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/übereinstimmen.

Beispiel

ibmcloud secrets-manager secret-task-delete \
    --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --id sm-task-a436bebd-dbbd-5c0d-ab35-1232f1234f95

Geheime Schlösser

Schützen Sie Ihre geheimen Daten, indem Sie einer Version des geheimen Schlüssels eine Sperre zuordnen und Änderungen oder Löschungen verhindern.

`ibmcloud secrets-manager secrets-locks`

Listet die geheimen Schlüssel und ihre Sperren in Ihrer Secrets Manager-Instanz auf. Anmerkung: Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne Seite der Objektgruppe ab.

ibmcloud secrets-manager secrets-locks [--offset OFFSET] [--limit LIMIT] [--search SEARCH] [--groups GROUPS]

Befehlsoptionen

--offset (int64)

Die Anzahl der zu überspringenden geheimen Schlüssel.

Der Standardwert ist 0. Der Höchstwert ist 10000000. Der Mindestwert ist 0.

--limit (int64)

Anzahl der aufzulistenden geheimen Schlüssel

Der Standardwert ist 200. Der Höchstwert ist 1000. Der Mindestwert ist 1.

--search (Zeichenfolge)

Die Sperren werden nach der angegebenen Zeichenfolge im Feld 'Name' gefiltert.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--groups ([]zeichenfolge)

Geheime Schlüssel nach Gruppen filtern. Geben Sie die IDs der Gruppen an, nach denen gefiltert werden soll.

--all-pages (boolescher Wert)

Ruft mehrere Anforderungen auf, um alle Seiten der Objektgruppe für Sperren geheimer Schlüssel anzuzeigen.

Beispiel

ibmcloud secrets-manager secrets-locks \
    --offset 0 \
    --limit 10 \
    --search example \
    --groups default,cac40995-c37a-4dcb-9506-472869077634

Beispielausgabe

Beispielantwort für das Auflisten aller geheimen Schlüssel und Sperren

{
  "secrets_locks" : [ {
    "secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
    "secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
    "secret_type" : "imported_cert",
    "secret_name" : "example-imported-certificate",
    "versions" : [ {
      "version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
      "version_alias" : "current",
      "locks" : [ "lock-example-1", "lock-example-2" ]
    } ]
  } ],
  "first" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets_locks?limit=50"
  },
  "previous" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets_locks?offset=50&limit=50"
  },
  "last" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets_locks?offset=200&limit=50"
  },
  "limit" : 50,
  "next" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets_locks?offset=150&limit=50"
  },
  "offset" : 100,
  "total_count" : 1
}

Standard-JMESPath

Standard-JMESPfad
Antwort	Ausgabe	Abfrage
Erfolg	Standard
	Tabelle	`secrets_locks[*]`
Fehler	Standard
	Tabelle	`secrets_locks[*]`
Alle Seiten	Standard
	Tabelle	`secrets_locks[*]`

Wenn eine benutzerdefinierte JMESPath-Abfrage bereitgestellt wird, ersetzt diese jede JMESPath in der obigen Tabelle.

`ibmcloud secrets-manager secret-locks`

Auflistung der Sperren, die mit einem bestimmten Geheimnis verbunden sind. Anmerkung: Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne Seite der Objektgruppe ab.

ibmcloud secrets-manager secret-locks --id ID [--offset OFFSET] [--limit LIMIT] [--sort SORT] [--search SEARCH]

Befehlsoptionen

--id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--offset (int64)

Die Anzahl der zu überspringenden Sperren.

Der Standardwert ist 0. Der Höchstwert ist 1000. Der Mindestwert ist 0.

--limit (int64)

Die Anzahl der geheimen Schlüssel mit Sperren, die aufgelistet werden sollen.

Der Standardwert ist 25. Der Höchstwert ist 100. Der Mindestwert ist 1.

--sort (Zeichenfolge)

Sortieren Sie eine Sammlung von Sperren nach dem angegebenen Feld in aufsteigender Reihenfolge. Um in absteigender Reihenfolge zu sortieren, verwenden Sie das Zeichen -.

Die maximale Länge beträgt 17 Zeichen. Die Mindestlänge beträgt 4 Zeichen. Der Wert muss dem regulären Ausdruck /^-?(created_at|updated_at|name)$/ entsprechen.

--search (Zeichenfolge)

Die Sperren werden nach der angegebenen Zeichenfolge im Feld 'Name' gefiltert.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--all-pages (boolescher Wert)

Rufen Sie mehrere Anforderungen auf, um alle Seiten der Sammlung für Sperren geheimer Schlüssel anzuzeigen.

Beispiel

ibmcloud secrets-manager secret-locks \
    --id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --offset 0 \
    --limit 10 \
    --sort name \
    --search example

Beispielausgabe

Beispiel für Antworthauptteil zum Auflisten geheimer Sperren

{
  "first" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/locks?limit=50"
  },
  "previous" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/locks?offset=50&limit=50"
  },
  "limit" : 50,
  "last" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/locks?offset=200&limit=50"
  },
  "locks" : [ {
    "attributes" : {
      "key" : "value"
    },
    "created_at" : "2022-06-27T11:58:15Z",
    "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
    "description" : "Lock for consumer 1.",
    "name" : "lock-example-1",
    "secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
    "secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
    "secret_version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
    "secret_version_alias" : "current",
    "updated_at" : "2022-10-05T21:33:11Z"
  }, {
    "created_at" : "2022-06-27T11:58:15Z",
    "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
    "description" : "Lock for consumer 2.",
    "name" : "lock-example-2",
    "secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
    "secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
    "secret_version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
    "secret_version_alias" : "current",
    "updated_at" : "2022-10-05T21:33:11Z"
  } ],
  "next" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/locks?offset=150&limit=50"
  },
  "offset" : 100,
  "total_count" : 2
}

`ibmcloud secrets-manager secret-locks-bulk-create`

Erstellen einer Sperre für die aktuelle Version eines Geheimnisses.

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 desselben Namens, falls sie bereits vorhanden ist. Außerdem können Sie diese Operation verwenden, um übereinstimmende Sperren für einen geheimen Schlüssel aufzuheben, indem Sie einen der folgenden optionalen Sperrmodi verwenden:

remove_previous: Entfernt alle anderen Sperren mit gleichem Namen, wenn sie in der vorherigen Version des Geheimnisses gefunden wurden.\n
remove_previous_and_delete: Führt dieselbe Funktion wie remove_previous aus, löscht aber auch die Daten der vorherigen Version des geheimen Schlüssels permanent, wenn keine Sperren vorhanden sind

ibmcloud secrets-manager secret-locks-bulk-create --id ID --locks LOCKS [--mode MODE]

Befehlsoptionen

--id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--locks (SecretLockPrototype[])

Die Sperrdaten, die einer Version des geheimen Schlüssels zugeordnet werden sollen. Erforderlich.

Die maximale Länge beträgt 1000. Die Mindestlänge beträgt 0.

--mode (Zeichenfolge)

Den Sperrenmodus festlegen. Zulässige Werte: remove_previous, und remove_previous_and_delete. Verwenden Sie remove_previous, um eine Sperre zu erstellen, die bestehende Sperren mit übereinstimmenden Namen aufhebt. Verwenden Sie remove_previous_and_delete, um auch die Daten der vorherigen Version zu löschen.

Zulässige Werte: remove_previous, remove_previous_and_delete.

Beispiel

ibmcloud secrets-manager secret-locks-bulk-create \
    --id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --locks '[{"name": "lock-example-1", "description": "lock for consumer 1", "attributes": {"anyKey": "anyValue"}}]' \
    --mode remove_previous

Beispielausgabe

Beispiel für Antworthauptteil zum Erstellen von Sperren für geheime Schlüssel

{
  "secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
  "secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
  "secret_type" : "arbitrary",
  "versions" : [ {
    "version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
    "version_alias" : "current",
    "locks" : [ "lock-3", "lock-4" ],
    "payload_available" : true
  }, {
    "version_id" : "5bf89b0c-df55-c8d5-7ad6-8816951c6784",
    "version_alias" : "previous",
    "locks" : [ "lock-example-1", "lock-example-2" ],
    "payload_available" : true
  } ]
}

`ibmcloud secrets-manager secret-locks-bulk-delete`

Löscht alle Sperren oder eine Untergruppe der Sperren, die einer Version eines geheimen Schlüssels zugeordnet sind.

Um nur eine Untergruppe der Sperren zu löschen, fügen Sie einen Abfrageparameter mit einem Komma hinzu, um die Liste der Sperrnamen zu trennen:

Beispiel: ?name=lock-example-1,lock-example-2.

Hinweis: Ein geheimer Schlüssel gilt als entsperrt und kann erst gelöscht werden, wenn Sie alle Sperren entfernt haben. Um festzustellen, 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.

ibmcloud secrets-manager secret-locks-bulk-delete --id ID [--name NAME]

Befehlsoptionen

--id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--name ([]zeichenfolge)

Geben Sie die Namen der zu löschenden Sperren geheimer Schlüssel an.

Die Listenelemente müssen dem regulären Ausdruck /^[a-zA-Z]{1}[a-zA-Z0-9-_.]{1,63}$/ entsprechen. Die maximale Länge beträgt 1000. Die Mindestlänge ist 1 item.

Beispiel

ibmcloud secrets-manager secret-locks-bulk-delete \
    --id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --name lock-example-1

Beispielausgabe

Beispiel für Antworthauptteil zum Erstellen von Sperren für geheime Schlüssel

{
  "secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
  "secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
  "secret_type" : "arbitrary",
  "versions" : [ {
    "version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
    "version_alias" : "current",
    "locks" : [ "lock-3", "lock-4" ],
    "payload_available" : true
  }, {
    "version_id" : "5bf89b0c-df55-c8d5-7ad6-8816951c6784",
    "version_alias" : "previous",
    "locks" : [ "lock-example-1", "lock-example-2" ],
    "payload_available" : true
  } ]
}

`ibmcloud secrets-manager secret-version-locks`

Listen Sie die Sperren auf, die einer angegebenen Version des geheimen Schlüssels zugeordnet sind. Anmerkung: Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne Seite der Objektgruppe ab.

ibmcloud secrets-manager secret-version-locks --secret-id SECRET-ID --id ID [--offset OFFSET] [--limit LIMIT] [--sort SORT] [--search SEARCH]

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--id (Zeichenfolge)

Die ID der Version des geheimen Schlüssels. Erforderlich.

--offset (int64)

Die Anzahl der zu überspringenden Sperren.

Der Standardwert ist 0. Der Höchstwert ist 1000. Der Mindestwert ist 0.

--limit (int64)

Die Anzahl der geheimen Schlüssel mit Sperren, die aufgelistet werden sollen.

Der Standardwert ist 25. Der Höchstwert ist 100. Der Mindestwert ist 1.

--sort (Zeichenfolge)

Sortieren Sie eine Sammlung von Sperren nach dem angegebenen Feld in aufsteigender Reihenfolge. Um in absteigender Reihenfolge zu sortieren, verwenden Sie das Zeichen -.

Die maximale Länge beträgt 17 Zeichen. Die Mindestlänge beträgt 4 Zeichen. Der Wert muss dem regulären Ausdruck /^-?(created_at|updated_at|name)$/ entsprechen.

--search (Zeichenfolge)

Die Sperren werden nach der angegebenen Zeichenfolge im Feld 'Name' gefiltert.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--all-pages (boolescher Wert)

Ruft mehrere Anforderungen auf, um alle Seiten der Sammlung für Sperren für Versionen geheimer Schlüssel anzuzeigen.

Beispiel

ibmcloud secrets-manager secret-version-locks \
    --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --id eb4cf24d-9cae-424b-945e-159788a5f535 \
    --offset 0 \
    --limit 10 \
    --sort name \
    --search example

Beispielausgabe

Beispielantwort zum Auflisten von Sperren für geheime Versionen

{
  "first" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/versions/7bf3814d-58f8-4df8-9cbd-f6860e4ca973/locks?limit=50"
  },
  "previous" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/versions/7bf3814d-58f8-4df8-9cbd-f6860e4ca973/locks?offset=50&limit=50"
  },
  "last" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/versions/7bf3814d-58f8-4df8-9cbd-f6860e4ca973/locks?offset=200&limit=50"
  },
  "limit" : 50,
  "locks" : [ {
    "attributes" : {
      "key" : "value"
    },
    "created_at" : "2022-06-27T11:58:15Z",
    "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
    "description" : "lock for consumer 1.",
    "name" : "lock-example-1",
    "secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
    "secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
    "secret_version_alias" : "current",
    "secret_version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
    "updated_at" : "2022-10-05T21:33:11Z"
  } ],
  "next" : {
    "href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/versions/7bf3814d-58f8-4df8-9cbd-f6860e4ca973/locks?offset=150&limit=50"
  },
  "offset" : 100,
  "total_count" : 1
}

`ibmcloud secrets-manager secret-version-locks-bulk-create`

Erzeugt eine Sperre für die angegebene Version eines Geheimnisses.

remove_previous: Entfernt alle anderen Sperren mit gleichem Namen, wenn sie in der vorherigen Version des Geheimnisses gefunden wurden.
remove_previous_and_delete: Führt dieselbe Funktion wie remove_previous aus, löscht aber auch die Daten der vorherigen Version des geheimen Schlüssels permanent, wenn keine Sperren vorhanden sind

ibmcloud secrets-manager secret-version-locks-bulk-create --secret-id SECRET-ID --id ID --locks LOCKS [--mode MODE]

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--id (Zeichenfolge)

Die ID der Version des geheimen Schlüssels. Erforderlich.

--locks (SecretLockPrototype[])

Die Sperrdaten, die einer Version des geheimen Schlüssels zugeordnet werden sollen. Erforderlich.

Die maximale Länge beträgt 1000. Die Mindestlänge beträgt 0.

--mode (Zeichenfolge)

Zulässige Werte: remove_previous, remove_previous_and_delete.

Beispiel

ibmcloud secrets-manager secret-version-locks-bulk-create \
    --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --id eb4cf24d-9cae-424b-945e-159788a5f535 \
    --locks '[{"name": "lock-example-1", "description": "lock for consumer 1", "attributes": {"anyKey": "anyValue"}}]' \
    --mode remove_previous

Beispielausgabe

Beispiel für Antworthauptteil zum Erstellen von Sperren für geheime Schlüssel

{
  "secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
  "secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
  "secret_type" : "arbitrary",
  "versions" : [ {
    "version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
    "version_alias" : "current",
    "locks" : [ "lock-3", "lock-4" ],
    "payload_available" : true
  }, {
    "version_id" : "5bf89b0c-df55-c8d5-7ad6-8816951c6784",
    "version_alias" : "previous",
    "locks" : [ "lock-example-1", "lock-example-2" ],
    "payload_available" : true
  } ]
}

`ibmcloud secrets-manager secret-version-locks-bulk-delete`

Löscht alle Sperren oder eine Untergruppe der Sperren, die der angegebenen Version eines geheimen Schlüssels zugeordnet sind.

Um nur eine Untergruppe der Sperren zu löschen, fügen Sie einen Abfrageparameter mit einem Komma hinzu, um die Liste der Sperrnamen zu trennen:

Beispiel: ?name=lock-example-1,lock-example-2.

Hinweis Ein geheimer Schlüssel gilt als entsperrt und kann erst gelöscht werden, wenn alle seine Sperren entfernt wurden. Um festzustellen, 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.

ibmcloud secrets-manager secret-version-locks-bulk-delete --secret-id SECRET-ID --id ID [--name NAME]

Befehlsoptionen

--secret-id (Zeichenfolge)

Die ID des geheimen Schlüssels. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/übereinstimmen.

--id (Zeichenfolge)

Die ID der Version des geheimen Schlüssels. Erforderlich.

--name ([]zeichenfolge)

Geben Sie die Namen der zu löschenden Sperren geheimer Schlüssel an.

Die Listenelemente müssen dem regulären Ausdruck /^[a-zA-Z]{1}[a-zA-Z0-9-_.]{1,63}$/ entsprechen. Die maximale Länge beträgt 1000. Die Mindestlänge ist 1 item.

Beispiel

ibmcloud secrets-manager secret-version-locks-bulk-delete \
    --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
    --id eb4cf24d-9cae-424b-945e-159788a5f535 \
    --name lock-example-1

Beispielausgabe

Beispiel für Antworthauptteil zum Erstellen von Sperren für geheime Schlüssel

{
  "secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
  "secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
  "secret_type" : "arbitrary",
  "versions" : [ {
    "version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
    "version_alias" : "current",
    "locks" : [ "lock-3", "lock-4" ],
    "payload_available" : true
  }, {
    "version_id" : "5bf89b0c-df55-c8d5-7ad6-8816951c6784",
    "version_alias" : "previous",
    "locks" : [ "lock-example-1", "lock-example-2" ],
    "payload_available" : true
  } ]
}

Konfigurationen

Erstellen und verwalten Sie Konfigurationen, sodass Sie mit bestimmten Typen von geheimen Schlüsseln arbeiten können.

`ibmcloud secrets-manager configuration-create`

Hinzufügen einer Konfiguration zum angegebenen Geheimnistyp.

Verwenden Sie diesen Vorgang, um die Konfigurationen zu definieren, die zum Erstellen von öffentlichen Zertifikaten (public_cert), privaten Zertifikaten (private_cert), IAM-Anmeldedatengeheimnissen (iam_credentials) und benutzerdefinierten Anmeldedatengeheimnissen (custom_credentials) erforderlich sind.

Sie können mehrere Konfigurationen für Ihre Instanz wie folgt hinzufügen:

Eine einzige Konfiguration für IAM-Anmeldeinformationen.
Bis zu 10 CA-Konfigurationen für öffentliche Zertifikate.
Bis zu 10 DNS-Konfigurationen für öffentliche Zertifikate.
Bis zu 10 Konfigurationen der Stammzertifizierungsstelle für private Zertifikate.
Bis zu 10 CA-Zwischenkonfigurationen für private Zertifikate.
Bis zu 10 Zertifikatsvorlagenkonfigurationen für private Zertifikate.

ibmcloud secrets-manager configuration-create [--configuration-prototype CONFIGURATION-PROTOTYPE | --config-type CONFIG-TYPE --name NAME --public-cert-cloud-internet-services-apikey PUBLIC-CERT-CLOUD-INTERNET-SERVICES-APIKEY --public-cert-cloud-internet-services-crn PUBLIC-CERT-CLOUD-INTERNET-SERVICES-CRN --public-cert-classic-infrastructure-username PUBLIC-CERT-CLASSIC-INFRASTRUCTURE-USERNAME --public-cert-classic-infrastructure-password PUBLIC-CERT-CLASSIC-INFRASTRUCTURE-PASSWORD --public-cert-lets-encrypt-environment PUBLIC-CERT-LETS-ENCRYPT-ENVIRONMENT --public-cert-lets-encrypt-private-key PUBLIC-CERT-LETS-ENCRYPT-PRIVATE-KEY --public-cert-lets-encrypt-preferred-chain PUBLIC-CERT-LETS-ENCRYPT-PREFERRED-CHAIN --private-cert-crypto-key PRIVATE-CERT-CRYPTO-KEY --private-cert-max-ttl PRIVATE-CERT-MAX-TTL --private-cert-crl-expiry PRIVATE-CERT-CRL-EXPIRY --private-cert-crl-disabled=PRIVATE-CERT-CRL-DISABLED --private-cert-crl-distribution-points-encoded=PRIVATE-CERT-CRL-DISTRIBUTION-POINTS-ENCODED --private-cert-issuing-certificate-urls-encoded=PRIVATE-CERT-ISSUING-CERTIFICATE-URLS-ENCODED --certificate-common-name CERTIFICATE-COMMON-NAME --certificate-alt-names CERTIFICATE-ALT-NAMES --private-cert-ip-sans PRIVATE-CERT-IP-SANS --private-cert-uri-sans PRIVATE-CERT-URI-SANS --private-cert-other-sans PRIVATE-CERT-OTHER-SANS --private-cert-ttl PRIVATE-CERT-TTL --private-cert-format PRIVATE-CERT-FORMAT --private-cert-private-key-format PRIVATE-CERT-PRIVATE-KEY-FORMAT --private-cert-private-key-type PRIVATE-CERT-PRIVATE-KEY-TYPE --private-cert-private-key-bits PRIVATE-CERT-PRIVATE-KEY-BITS --private-cert-max-path-length PRIVATE-CERT-MAX-PATH-LENGTH --private-cert-exclude-cn-from-sans=PRIVATE-CERT-EXCLUDE-CN-FROM-SANS --private-cert-permitted-dns-domains PRIVATE-CERT-PERMITTED-DNS-DOMAINS --private-cert-subject-organizational-unit PRIVATE-CERT-SUBJECT-ORGANIZATIONAL-UNIT --private-cert-subject-organization PRIVATE-CERT-SUBJECT-ORGANIZATION --private-cert-subject-country PRIVATE-CERT-SUBJECT-COUNTRY --private-cert-subject-locality PRIVATE-CERT-SUBJECT-LOCALITY --private-cert-subject-province PRIVATE-CERT-SUBJECT-PROVINCE --private-cert-subject-street-address PRIVATE-CERT-SUBJECT-STREET-ADDRESS --private-cert-subject-postal-code PRIVATE-CERT-SUBJECT-POSTAL-CODE --private-cert-serial-number PRIVATE-CERT-SERIAL-NUMBER --private-cert-signing-method PRIVATE-CERT-SIGNING-METHOD --private-cert-issuer PRIVATE-CERT-ISSUER --private-cert-ca-name PRIVATE-CERT-CA-NAME --private-cert-allowed-secret-groups PRIVATE-CERT-ALLOWED-SECRET-GROUPS --private-cert-allow-localhost=PRIVATE-CERT-ALLOW-LOCALHOST --private-cert-allowed-domains PRIVATE-CERT-ALLOWED-DOMAINS --private-cert-allowed-domains-template=PRIVATE-CERT-ALLOWED-DOMAINS-TEMPLATE --private-cert-allow-bare-domains=PRIVATE-CERT-ALLOW-BARE-DOMAINS --private-cert-allow-subdomains=PRIVATE-CERT-ALLOW-SUBDOMAINS --private-cert-allow-glob-domains=PRIVATE-CERT-ALLOW-GLOB-DOMAINS --private-cert-allow-wildcard=PRIVATE-CERT-ALLOW-WILDCARD --private-cert-allow-any-name=PRIVATE-CERT-ALLOW-ANY-NAME --private-cert-enforce-hostname=PRIVATE-CERT-ENFORCE-HOSTNAME --private-cert-allow-ip-sans=PRIVATE-CERT-ALLOW-IP-SANS --private-cert-allowed-uri-sans PRIVATE-CERT-ALLOWED-URI-SANS --private-cert-allowed-other-sans PRIVATE-CERT-ALLOWED-OTHER-SANS --private-cert-server-flag=PRIVATE-CERT-SERVER-FLAG --private-cert-client-flag=PRIVATE-CERT-CLIENT-FLAG --private-cert-code-signing-flag=PRIVATE-CERT-CODE-SIGNING-FLAG --private-cert-email-protection-flag=PRIVATE-CERT-EMAIL-PROTECTION-FLAG --private-cert-key-usage PRIVATE-CERT-KEY-USAGE --private-cert-ext-key-usage PRIVATE-CERT-EXT-KEY-USAGE --private-cert-ext-key-usage-oids PRIVATE-CERT-EXT-KEY-USAGE-OIDS --private-cert-use-csr-common-name=PRIVATE-CERT-USE-CSR-COMMON-NAME --private-cert-use-cse-sans=PRIVATE-CERT-USE-CSE-SANS --private-cert-require-cn=PRIVATE-CERT-REQUIRE-CN --private-cert-policy-identifiers PRIVATE-CERT-POLICY-IDENTIFIERS --private-cert-basic-constraints-valid-for-non-ca=PRIVATE-CERT-BASIC-CONSTRAINTS-VALID-FOR-NON-CA --private-cert-not-before-duration PRIVATE-CERT-NOT-BEFORE-DURATION --iam-credentials-apikey IAM-CREDENTIALS-APIKEY --iam-credentials-apikey-disabled=IAM-CREDENTIALS-APIKEY-DISABLED --custom-credentials-apikey-ref CUSTOM-CREDENTIALS-APIKEY-REF --custom-credentials-code-engine CUSTOM-CREDENTIALS-CODE-ENGINE --configuration-task-timeout CONFIGURATION-TASK-TIMEOUT]

Befehlsoptionen

--configuration-prototype (ConfigurationPrototype)

Eine JSON-Datei mit den erforderlichen Details zum Erstellen einer Konfiguration. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--config-type (Zeichenfolge)

Der Konfigurationstyp. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Erlaubte Werte sind: public_cert_configuration_dns_cloud_internet_services, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_ca_lets_encrypt, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template, iam_credentials_configuration, custom_credentials_configuration.

--name (Zeichenfolge)

Ein lesbarer eindeutiger Name, der Ihrer Konfiguration zugeordnet werden soll. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/ entsprechen.

--public-cert-cloud-internet-services-apikey (Zeichenfolge)

Ein IBM Cloud-API-Schlüssel, mit dem Domänen in Ihrer Cloud Internet Services-Instanz aufgelistet und DNS-Datensätze hinzufügt werden können. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--public-cert-cloud-internet-services-crn (Zeichenfolge)

Eine CRN, die eine IBM Cloud-Ressource eindeutig identifiziert. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 512 Zeichen. Die Mindestlänge beträgt 9 Zeichen. Der Wert muss dem regulären Ausdruck /^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/ entsprechen.

--public-cert-classic-infrastructure-username (Zeichenfolge)

Der Benutzername, der Ihrem Konto der klassischen Infrastruktur zugeordnet ist. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--public-cert-classic-infrastructure-password (Zeichenfolge)

Ihr API-Schlüssel für die klassische Infrastruktur. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--public-cert-lets-encrypt-environment (Zeichenfolge)

Die Konfiguration der 'Let's Encrypt'-CA-Umgebung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Zulässige Werte: production, staging.

--public-cert-lets-encrypt-private-key (Zeichenfolge)

Der PEM-codierte private Schlüssel Ihres 'Let's Encrypt'-Kontos. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 100000 Zeichen. Die Mindestlänge beträgt 50 Zeichen. Der Wert muss dem regulären Ausdruck /(^-----BEGIN PRIVATE KEY-----.*?)|(^-----BEGIN RSA PRIVATE KEY-----.*?)/ entsprechen.

--public-cert-lets-encrypt-preferred-chain (Zeichenfolge)

Die bevorzugte Kette mit einem Aussteller, der diesem allgemeinen Subjektnamen entspricht. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 30 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--private-cert-crypto-key (PrivateCertificateCryptoKey)

Die Daten, die mit einem Verschlüsselungsschlüssel in JSON-Format verbunden sind. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-max-ttl (Zeichenfolge)

Die maximale Lebensdauer (TTL, Time-to-Live) für Zertifikate, die von dieser Zertifizierungsstelle erstellt werden. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 10 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[0-9]+[s,m,h,d]{0,1}$/ entsprechen.

--private-cert-crl-expiry (Zeichenfolge)

Die Zeit bis zum Ablauf der Zertifikatswiderrufsliste (CRL). Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 10 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[0-9]+[s,m,h,d]{0,1}$/ entsprechen.

--private-cert-crl-disabled (boolescher Wert)

Dieses Feld inaktiviert oder aktiviert die Erstellung der Zertifikatswiderrufslisten (CRL). Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-crl-distribution-points-encoded (boolescher Wert)

Dieses Feld legt fest, ob die Verteilungspunkte der Zertifikatswiderrufsliste (CRL) in den von dieser Zertifizierungsstelle ausgegebenen Zertifikaten verschlüsselt werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-issuing-certificate-urls-encoded (boolescher Wert)

Dieses Feld bestimmt, ob die URL des ausstellenden Zertifikats in den von dieser Zertifizierungsstelle ausgestellten Zertifikaten codiert werden soll. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--certificate-common-name (Zeichenfolge)

Der allgemeine Name (Common Name, CN) steht für den Servernamen, der durch das SSL-Zertifikat geschützt wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 4 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--certificate-alt-names ([]zeichenfolge)

Im Feld 'Alternativer Name des Subjekts' können Sie zusätzliche Hostnamen angeben, die durch ein einziges SSL-Zertifikat geschützt werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /^(.*?)$/ entsprechen. Die maximale Länge beträgt 99. Die Mindestlänge beträgt 0.

--private-cert-ip-sans (Zeichenfolge)

Die IP-SANs (Subject Alternative Names), die für das CA-Zertifikat definiert werden sollen, in einer durch Kommas begrenzten Liste. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 2048 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--private-cert-uri-sans (Zeichenfolge)

Die URI-SANs (Subject Alternative Names), die für das CA-Zertifikat definiert werden sollen, in einer durch Kommas begrenzten Liste. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 2048 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--private-cert-other-sans ([]zeichenfolge)

Die benutzerdefinierte Objekt-ID (OID) oder UTF8-string-SANs (Subject Alternative Names), die für das CA-Zertifikat definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-ttl (Zeichenfolge)

Die angeforderte Lebensdauer (Time-to-Live, TTL) für Zertifikate, die durch diese Zertifizierungsstelle erstellt werden. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 10 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[0-9]+[s,m,h,d]{0,1}$/ entsprechen.

--private-cert-format (Zeichenfolge)

Das Format der zurückgegebenen Daten. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Zulässige Werte: pem, pem_bundle.

--private-cert-private-key-format (Zeichenfolge)

Das Format des generierten privaten Schlüssels. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Standardwert ist der. Erlaubte Werte sind: der, pkcs8.

--private-cert-private-key-type (Zeichenfolge)

Der Typ des zu generierenden privaten Schlüssels. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Zulässige Werte: rsa, ec.

--private-cert-private-key-bits (int64)

Die Anzahl der Bits, die zum Generieren des privaten Schlüssels verwendet wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Höchstwert ist 4096. Der Mindestwert ist 224.

--private-cert-max-path-length (int64)

Die maximale Pfadlänge, die im erzeugten Zertifikat kodiert werden soll. -1 bedeutet keine Begrenzung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Höchstwert ist 10. Der Mindestwert ist -1.

--private-cert-exclude-cn-from-sans (boolescher Wert)

Dieser Parameter steuert, ob der allgemeine Name aus SANs (Subject Alternative Names) ausgeschlossen wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-permitted-dns-domains ([]zeichenfolge)

Die zulässigen DNS-Domänen oder Unterdomänen für die Zertifikate, die von diesem CA-Zertifikat signiert und ausgestellt werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-subject-organizational-unit ([]zeichenfolge)

Die Organisationseinheitenwerte (OU), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-organization ([]zeichenfolge)

Die Organisationswerte (O), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-country ([]zeichenfolge)

Die Länderwerte (C), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-locality ([]zeichenfolge)

Die Lokalitätswerte (L), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-province ([]zeichenfolge)

Die Werte für die Provinz (ST), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-street-address ([]zeichenfolge)

Die Werte für die Straßenanschrift, die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-postal-code ([]zeichenfolge)

Die Postleitzahlwerte, die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-serial-number (Zeichenfolge)

Der angeforderte Wert für das Attribut serialNumber ( https://datatracker.ietf.org/doc/html/rfc4519#section-2.31 ), das im Distinguished Name (DN) des Zertifikats enthalten ist. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

The maximum length is 64 characters. The minimum length is 32 characters. The value must match regular expression /[^a-fA-F0-9]/.

--private-cert-signing-method (Zeichenfolge)

Die Signiermethode, die mit dieser Zertifizierungsstelle verwendet werden soll, um private Zertifikate zu generieren. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Zulässige Werte: internal, external.

--private-cert-issuer (Zeichenfolge)

Der definierte Name, der die Entität angibt, die das Zertifikat signiert und ausgestellt hat. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--private-cert-ca-name (Zeichenfolge)

Der Name der Zwischenzertifizierungsstelle. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/ entsprechen.

--private-cert-allowed-secret-groups (Zeichenfolge)

In diesem Feld wird die Erstellung privater Zertifikate auf die von Ihnen angegebenen Gruppen geheimer Schlüssel beschränkt. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 1024 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--private-cert-allow-localhost (boolescher Wert)

In diesem Feld wird angegeben, ob localhost als einer der angeforderten gemeinsamen Namen aufgenommen werden soll. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allowed-domains ([]zeichenfolge)

Die Domänen, die für die Zertifikatsvorlage definiert werden sollen. Diese Eigenschaft wird zusammen mit den Optionen allow_bare_domains und allow_subdomains verwendet. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-allowed-domains-template (boolescher Wert)

Dieses Feld gibt an, ob die Domänen, die im Feld allowed_domains angegeben werden, ACL-Vorlagen (Access Control List) enthalten dürfen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allow-bare-domains (boolescher Wert)

Dieses Feld gibt an, ob Clients private Zertifikate anfordern können, die dem Wert der tatsächlichen Domänen im endgültigen Zertifikat entsprechen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allow-subdomains (boolescher Wert)

Dieses Feld gibt an, ob Clients private Zertifikate mit allgemeinen Namen (Common Names, CN) anfordern dürfen, die Unterdomänen der CNs sind, die von den anderen Zertifikatsvorlagenoptionen zugelassen sind. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allow-glob-domains (boolescher Wert)

Dieses Feld gibt an, ob Glob-Muster in den Namen, die im Feld allowed_domains angegeben sind, erlaubt werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allow-wildcard (boolescher Wert)

Dieses Feld gibt an, ob die Ausstellung von Zertifikaten mit RFC 6125-Platzhalterzeichen im Feld 'CN' erfolgt. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allow-any-name (boolescher Wert)

Dieses Feld gibt an, ob Clients ein privates Zertifikat anfordern dürfen, das einem beliebigen allgemeinen Namen entspricht. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-enforce-hostname (boolescher Wert)

Dieses Feld gibt an, ob nur gültige Hostnamen für allgemeine Namen, alternative DNS-Subjektnamen und den Hostabschnitt von E-Mail-Adressen erzwungen werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allow-ip-sans (boolescher Wert)

Dieses Feld gibt an, ob Clients ein privates Zertifikat mit alternativen IP-Subjektnamen anfordern dürfen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allowed-uri-sans ([]zeichenfolge)

Die URI-SANs (Subject Alternative Names), die für private Zertifikate zulässig sind. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-allowed-other-sans ([]zeichenfolge)

Die benutzerdefinierte Objekt-ID (OID) oder UTF8-string-SANs (Subject Alternative Names), die für private Zertifikate zulässig sind. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-server-flag (boolescher Wert)

Dieses Feld gibt an, ob private Zertifikate für die Verwendung durch den Server markiert sind. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-client-flag (boolescher Wert)

Dieses Feld gibt an, ob private Zertifikate für die Verwendung durch den Client markiert sind. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-code-signing-flag (boolescher Wert)

Dieses Feld gibt an, ob private Zertifikate zur Verwendung der Codesignatur markiert sind. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-email-protection-flag (boolescher Wert)

Dieses Feld gibt an, ob private Zertifikate für die Verwendung des E-Mail-Schutzes markiert sind. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-key-usage ([]zeichenfolge)

Die zulässige Einschränkung für die Schlüsselnutzung, die für private Zertifikate zu definieren ist. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /^[a-zA-Z]+$/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-ext-key-usage ([]zeichenfolge)

Die zulässige Einschränkung für die erweiterte Schlüsselnutzung für private Zertifikate. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /^[a-zA-Z]+$/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-ext-key-usage-oids ([]zeichenfolge)

Eine Liste der erweiterten Schlüsselnutzungsobjektkennungen (OIDs). Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-use-csr-common-name (boolescher Wert)

Dieses Feld legt fest, ob der allgemeine Name (Common Name, CN) aus einer Zertifikatssignieranforderung verwendet werden soll. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-use-cse-sans (boolescher Wert)

Dieses Feld legt fest, ob die SANs (Subject Alternative Names) aus einer Zertifikatssignieranforderung verwendet werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-require-cn (boolescher Wert)

Dieses Feld gibt an, ob zum Erstellen eines privaten Zertifikats ein allgemeiner Name erforderlich ist. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-policy-identifiers ([]zeichenfolge)

Eine Liste der Richtlinienobjekt-IDs (OIDs). Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-basic-constraints-valid-for-non-ca (boolescher Wert)

Dieses Feld gibt an, ob die Erweiterung „Basiseinschränkungen“ eines ausgestellten privaten Zertifikats als gültig für Nicht-CA-Zertifikate markiert werden soll. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-not-before-duration (Zeichenfolge)

Die Dauer in Sekunden, um die die Eigenschaft not_before eines ausgestellten privaten Zertifikats rückdatiert wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 10 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[0-9]+[s,m,h,d]{0,1}$/ entsprechen.

--iam-credentials-apikey (Zeichenfolge)

Der API-Schlüssel, der zum Festlegen der IAM-Engine für Berechtigungsnachweise (iam_credentials) verwendet wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 60 Zeichen. Die Mindestlänge beträgt 5 Zeichen. Der Wert muss dem regulären Ausdruck /^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/ entsprechen.

--iam-credentials-apikey-disabled (boolescher Wert)

Dieser Parameter gibt an, ob die API-Schlüsselkonfiguration deaktiviert ist. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Standardwert ist false.

--custom-credentials-apikey-ref (Zeichenfolge)

Die geheime Schlüssel- ID für IAM-Berechtigungsnachweise, die zum Einrichten einer Konfiguration der Engine für benutzerdefinierten Berechtigungsnachweise verwendet wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/übereinstimmen.

--custom-credentials-code-engine (CustomCredentialsConfigurationCodeEngine)

Die zur Konfiguration von Code Engine erforderlichen Parameter. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--configuration-task-timeout (Zeichenfolge)

Gibt die maximal zulässige Zeit für die Ausführung einer Code Engine-Aufgabe an. Nach Ablauf dieser Zeit wird der Status der Aufgabe in 'fehlgeschlagen' geändert. Der Mindestwert beträgt 5 Minuten und der Höchstwert 24 Stunden. Die Standardzeit für Aufgaben beträgt 10 Minuten. Der Wert kann entweder eine ganze Zahl sein, die die Anzahl der Sekunden angibt, oder die String-Darstellung einer Dauer, wie 10m oder 2h. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'configuration-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 6 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^[0-9]+[s,m,h,d]{0,1}$/ entsprechen.

Beispiel

Beispielanforderung

ibmcloud secrets-manager configuration-create --config-type=private_cert_configuration_root_ca \
  --name=example-root-CA --certificate-common-name=example.com  --private-cert-max-ttl=7365

ibmcloud secrets-manager configuration-create --config-type=private_cert_configuration_root_ca   --name=example-root-CA-HSM \
--certificate-common-name=example.com  --private-cert-max-ttl=73654 \
--private-cert-crypto-key='{ "provider": { "type": "hyper_protect_crypto_services", "instance_crn": "crn:v1:bluemix:public:hs-crypto:us-south:a/791f3fb10486421e97aa8512f18b7e65:b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5::","pin_iam_credentials_secret_id": "14a7aff4-432d-11dc-a0f0-56a5b473394f", "private_keystore_id": "14a7aff4-432d-11dc-a0f0-56a5b473394f" }, "label": "cli-created", "allow_generate_key": true }'

ibmcloud secrets-manager configuration-create \
  --configuration-prototype='{"config_type": "private_cert_configuration_root_ca", "name": "example-root-CA", "max_ttl": "43830h", "crl_expiry": "72h", "crl_disable": false, "crl_distribution_points_encoded": true, "issuing_certificates_urls_encoded": true, "common_name": "example.com", "alt_names": ["alt-name-1","alt-name-2"], "ip_sans": "127.0.0.1", "uri_sans": "https://www.example.com/test", "other_sans": ["1.2.3.5.4.3.201.10.4.3;utf8:test@example.com"], "ttl": "2190h", "format": "pem", "private_key_format": "der", "key_type": "rsa", "key_bits": 4096, "max_path_length": -1, "exclude_cn_from_sans": false, "permitted_dns_domains": ["exampleString"], "ou": ["exampleString"], "organization": ["exampleString"], "country": ["exampleString"], "locality": ["exampleString"], "province": ["exampleString"], "street_address": ["exampleString"], "postal_code": ["exampleString"], "serial_number": "d9:be:fe:35:ba:09:42:b5:35:ba:09:42:b5"}'

`ibmcloud secrets-manager configurations`

Listen Sie die Konfigurationen auf, die in Ihrer Secrets Manager-Instanz verfügbar sind. Anmerkung: Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne Seite der Objektgruppe ab.

ibmcloud secrets-manager configurations [--offset OFFSET] [--limit LIMIT] [--sort SORT] [--search SEARCH] [--secret-types SECRET-TYPES]

Befehlsoptionen

--offset (int64)

Die Anzahl der zu überspringenden Konfigurationen.

Der Standardwert ist 0. Der Höchstwert ist 1000. Der Mindestwert ist 0.

--limit (int64)

Die Anzahl der aufzulistenden Konfigurationen.

Der Standardwert ist 200. Der Höchstwert ist 1000. Der Mindestwert ist 1.

--sort (Zeichenfolge)

Sortiert eine Sammlung von Konfigurationen nach dem angegebenen Feld in aufsteigender Reihenfolge. Um in absteigender Reihenfolge zu sortieren, verwenden Sie das Zeichen -.

Die maximale Länge beträgt 17 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^-?(config_type|secret_type|name)$/ entsprechen.

--search (Zeichenfolge)

Filterkonfigurationen, welche die angegebene Zeichenfolge in einem oder mehreren der folgenden Felder enthalten: "name", "config_type", "secret_type".

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--secret-types ([]zeichenfolge)

Konfigurationen nach Typen geheimer Schlüssel filtern. Geben Sie einen oder mehrere der folgenden Typen für geheime Schlüssel an: iam_credentials, public_cert, private_cert oder custom_credentials.

Erlaubte Listenelemente sind: iam_credentials, private_cert, public_cert, custom_credentials. Die maximale Länge beträgt 4. Die Mindestlänge beträgt 0.

--all-pages (boolescher Wert)

Rufen Sie mehrere Anforderungen auf, um alle Seiten der Sammlung für Konfigurationen anzuzeigen.

Beispiel

ibmcloud secrets-manager configurations \
    --offset 0 \
    --limit 10 \
    --sort config_type \
    --search example \
    --secret-types iam_credentials,private_cert,public_cert,custom_credentials

Beispielausgabe

Beispielantwort für die Konfiguration der Metadatensammlung

{
  "first" : {
    "href" : "https://something.com"
  },
  "next" : {
    "href" : "https://something.com"
  },
  "previous" : {
    "href" : "https://something.com"
  },
  "last" : {
    "href" : "https://something.com"
  },
  "limit" : 25,
  "offset" : 0,
  "configurations" : [ {
    "config_type" : "public_cert_configuration_ca_lets_encrypt",
    "created_at" : "2022-06-27T11:58:15Z",
    "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
    "lets_encrypt_environment" : "production",
    "name" : "lets-encrypt-config",
    "secret_type" : "public_cert",
    "updated_at" : "2022-10-05T21:33:11Z"
  }, {
    "config_type" : "public_cert_configuration_dns_cloud_internet_services",
    "created_at" : "2022-06-27T11:58:15Z",
    "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
    "name" : "cloud-internet-services-config",
    "secret_type" : "public_cert",
    "updated_at" : "2022-10-05T21:33:11Z"
  }, {
    "config_type" : "public_cert_configuration_dns_classic_infrastructure",
    "created_at" : "2022-06-27T11:58:15Z",
    "created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
    "name" : "classic-infrastructure-config",
    "secret_type" : "public_cert",
    "updated_at" : "2022-10-05T21:33:11Z"
  }, {
    "common_name" : "ibm.com",
    "config_type" : "private_cert_configuration_root_ca",
    "created_at" : "2022-11-08T11:22:19Z",
    "created_by" : "iam-ServiceId-1ba95813-1b0f-45c1-b46c-969a5fda08d1",
    "expiration_date" : "2030-03-31T01:13:07Z",
    "key_bits" : 2048,
    "key_type" : "rsa",
    "name" : "internal-root",
    "secret_type" : "private_cert",
    "status" : "configured",
    "updated_at" : "2022-11-08T11:22:19Z"
  }, {
    "common_name" : "ibm.com",
    "config_type" : "private_cert_configuration_intermediate_ca",
    "created_at" : "2022-11-08T11:22:19Z",
    "created_by" : "iam-ServiceId-1ba95813-1b0f-45c1-b46c-969a5fda08d1",
    "expiration_date" : "2030-03-31T01:13:07Z",
    "issuer" : "internal-root",
    "name" : "example-intermediate-CA",
    "key_bits" : 2048,
    "key_type" : "rsa",
    "secret_type" : "private_cert",
    "status" : "configured",
    "updated_at" : "2022-11-08T11:22:19Z"
  }, {
    "certificate_authority" : "inter-1",
    "config_type" : "private_cert_configuration_template",
    "created_at" : "2022-11-08T11:22:23Z",
    "created_by" : "iam-ServiceId-8e54a866-476b-46cd-ba05-dbeae5f1d984",
    "name" : "example-certificate-template",
    "secret_type" : "private_cert",
    "updated_at" : "2022-11-08T11:22:23Z"
  }, {
    "api_key_ref" : "a2f9c2e4-a3a8-c508-2bed-fcb7c26843ca",
    "code_engine" : {
      "job_name" : "code-engine-job-name",
      "project_id" : "12345678-5120-4a18-832a-4ba122496633",
      "region" : "us-south"
    },
    "code_engine_key_ref" : "sm-access-24bc230d-9855-4825-99b5-ac78be81959c",
    "config_type" : "custom_credentials_configuration",
    "created_at" : "2025-03-23T08:35:29.27Z",
    "created_by" : "IBMid-000002CM7E",
    "name" : "my_config",
    "schema" : {
      "credentials" : [ {
        "format" : "type:string",
        "name" : "token"
      } ],
      "parameters" : [ {
        "env_variable_name" : "SM_USER_NAME_VALUE",
        "format" : "type:string",
        "name" : "user_name"
      }, {
        "env_variable_name" : "SM_SCOPE_VALUE",
        "format" : "type:enum[admin|user]",
        "name" : "scope"
      }, {
        "env_variable_name" : "SM_EXPIRES_VALUE",
        "format" : "type:integer",
        "name" : "expires"
      } ]
    },
    "secret_type" : "custom_credentials",
    "task_timeout" : "10m",
    "updated_at" : "2025-03-23T08:35:29.27Z"
  } ],
  "total_count" : 7
}

Standard-JMESPath

Standard-JMESPfad
Antwort	Ausgabe	Abfrage
Erfolg	Standard
	Tabelle	`configurations[*].{Created_At:created_at,Name:name,Config_Type:config_type,Secret_Type:secret_type,Created_By:created_by,Updated_At:updated_at}`
Fehler	Standard
	Tabelle	`configurations[*].{Created_At:created_at,Name:name,Config_Type:config_type,Secret_Type:secret_type,Created_By:created_by,Updated_At:updated_at}`
Alle Seiten	Standard
	Tabelle	`configurations[*].{Created_At:created_at,Name:name,Config_Type:config_type,Secret_Type:secret_type,Created_By:created_by,Updated_At:updated_at}`

Wenn eine benutzerdefinierte JMESPath-Abfrage bereitgestellt wird, ersetzt diese jede JMESPath in der obigen Tabelle.

`ibmcloud secrets-manager configuration`

Rufen Sie eine Konfiguration durch Angabe ihres Namens ab.

Eine erfolgreiche Anforderung gibt die Details Ihrer Konfiguration zurück.

ibmcloud secrets-manager configuration --name NAME [--config-type CONFIG-TYPE]

Befehlsoptionen

--name (Zeichenfolge)

Der Name der Konfiguration. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--config-type (Zeichenfolge)

Der Konfigurationstyp dieser Konfiguration – verwenden Sie diesen Header, um Fehlerantworten des Typs 300 aufzulösen.

Beispiel

ibmcloud secrets-manager configuration \
    --name configuration-name \
    --config-type public_cert_configuration_dns_cloud_internet_services

`ibmcloud secrets-manager configuration-update`

Aktualisiert eine Konfiguration.

ibmcloud secrets-manager configuration-update --name NAME [--api-key API-KEY] [--iam-credentials-apikey-disabled=IAM-CREDENTIALS-APIKEY-DISABLED] [--private-cert-max-ttl PRIVATE-CERT-MAX-TTL] [--private-cert-crl-expiry PRIVATE-CERT-CRL-EXPIRY] [--private-cert-crl-disabled=PRIVATE-CERT-CRL-DISABLED] [--private-cert-crl-distribution-points-encoded=PRIVATE-CERT-CRL-DISTRIBUTION-POINTS-ENCODED] [--private-cert-issuing-certificate-urls-encoded=PRIVATE-CERT-ISSUING-CERTIFICATE-URLS-ENCODED] [--private-cert-allowed-secret-groups PRIVATE-CERT-ALLOWED-SECRET-GROUPS] [--private-cert-ttl PRIVATE-CERT-TTL] [--private-cert-allow-localhost=PRIVATE-CERT-ALLOW-LOCALHOST] [--private-cert-allowed-domains PRIVATE-CERT-ALLOWED-DOMAINS] [--private-cert-allowed-domains-template=PRIVATE-CERT-ALLOWED-DOMAINS-TEMPLATE] [--private-cert-allow-bare-domains=PRIVATE-CERT-ALLOW-BARE-DOMAINS] [--private-cert-allow-subdomains=PRIVATE-CERT-ALLOW-SUBDOMAINS] [--private-cert-allow-glob-domains=PRIVATE-CERT-ALLOW-GLOB-DOMAINS] [--private-cert-allow-any-name=PRIVATE-CERT-ALLOW-ANY-NAME] [--private-cert-enforce-hostname=PRIVATE-CERT-ENFORCE-HOSTNAME] [--private-cert-allow-ip-sans=PRIVATE-CERT-ALLOW-IP-SANS] [--private-cert-allowed-uri-sans PRIVATE-CERT-ALLOWED-URI-SANS] [--private-cert-allowed-other-sans PRIVATE-CERT-ALLOWED-OTHER-SANS] [--private-cert-server-flag=PRIVATE-CERT-SERVER-FLAG] [--private-cert-client-flag=PRIVATE-CERT-CLIENT-FLAG] [--private-cert-code-signing-flag=PRIVATE-CERT-CODE-SIGNING-FLAG] [--private-cert-email-protection-flag=PRIVATE-CERT-EMAIL-PROTECTION-FLAG] [--private-cert-private-key-type PRIVATE-CERT-PRIVATE-KEY-TYPE] [--private-cert-private-key-bits PRIVATE-CERT-PRIVATE-KEY-BITS] [--private-cert-key-usage PRIVATE-CERT-KEY-USAGE] [--private-cert-ext-key-usage PRIVATE-CERT-EXT-KEY-USAGE] [--private-cert-ext-key-usage-oids PRIVATE-CERT-EXT-KEY-USAGE-OIDS] [--private-cert-use-csr-common-name=PRIVATE-CERT-USE-CSR-COMMON-NAME] [--private-cert-use-cse-sans=PRIVATE-CERT-USE-CSE-SANS] [--private-cert-subject-organizational-unit PRIVATE-CERT-SUBJECT-ORGANIZATIONAL-UNIT] [--private-cert-subject-organization PRIVATE-CERT-SUBJECT-ORGANIZATION] [--private-cert-subject-country PRIVATE-CERT-SUBJECT-COUNTRY] [--private-cert-subject-locality PRIVATE-CERT-SUBJECT-LOCALITY] [--private-cert-subject-province PRIVATE-CERT-SUBJECT-PROVINCE] [--private-cert-subject-street-address PRIVATE-CERT-SUBJECT-STREET-ADDRESS] [--private-cert-subject-postal-code PRIVATE-CERT-SUBJECT-POSTAL-CODE] [--private-cert-requested-serial-number PRIVATE-CERT-REQUESTED-SERIAL-NUMBER] [--private-cert-require-cn=PRIVATE-CERT-REQUIRE-CN] [--private-cert-policy-identifiers PRIVATE-CERT-POLICY-IDENTIFIERS] [--private-cert-basic-constraints-valid-for-non-ca=PRIVATE-CERT-BASIC-CONSTRAINTS-VALID-FOR-NON-CA] [--private-cert-not-before-duration PRIVATE-CERT-NOT-BEFORE-DURATION] [--public-cert-lets-encrypt-environment PUBLIC-CERT-LETS-ENCRYPT-ENVIRONMENT] [--public-cert-lets-encrypt-private-key PUBLIC-CERT-LETS-ENCRYPT-PRIVATE-KEY] [--public-cert-lets-encrypt-preferred-chain PUBLIC-CERT-LETS-ENCRYPT-PREFERRED-CHAIN] [--public-cert-cloud-internet-services-apikey PUBLIC-CERT-CLOUD-INTERNET-SERVICES-APIKEY] [--cloud-internet-services-crn CLOUD-INTERNET-SERVICES-CRN] [--public-cert-classic-infrastructure-username PUBLIC-CERT-CLASSIC-INFRASTRUCTURE-USERNAME] [--public-cert-classic-infrastructure-password PUBLIC-CERT-CLASSIC-INFRASTRUCTURE-PASSWORD] [--configuration-task-timeout CONFIGURATION-TASK-TIMEOUT] [--x-sm-accept-configuration-type X-SM-ACCEPT-CONFIGURATION-TYPE]

Befehlsoptionen

--name (Zeichenfolge)

Der Name der Konfiguration. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--configuration-patch (generische Map)

JSON Merge-Patchinhalt für update_configuration. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--config-type (Zeichenfolge)

Der Konfigurationstyp dieser Konfiguration – verwenden Sie diesen Header, um Fehlerantworten des Typs 300 aufzulösen.

--api-key (Zeichenfolge)

Ein IBM Cloud-API-Schlüssel, der Service-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. Weitere Informationen finden Sie in der Dokumentation. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--iam-credentials-apikey-disabled (boolescher Wert)

Dieser Parameter gibt an, ob die API-Schlüsselkonfiguration deaktiviert ist. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-max-ttl (Zeichenfolge)

Die maximale Lebensdauer (TTL, Time-to-Live) für Zertifikate, die von dieser Zertifizierungsstelle erstellt werden. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 10 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[0-9]+[s,m,h,d]{0,1}$/ entsprechen.

--private-cert-crl-expiry (Zeichenfolge)

Die Zeit bis zum Ablauf der Zertifikatswiderrufsliste (CRL). Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 10 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[0-9]+[s,m,h,d]{0,1}$/ entsprechen.

--private-cert-crl-disabled (boolescher Wert)

Dieses Feld inaktiviert oder aktiviert die Erstellung der Zertifikatswiderrufslisten (CRL). Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-crl-distribution-points-encoded (boolescher Wert)

Dieses Feld legt fest, ob die Verteilungspunkte der Zertifikatswiderrufsliste (CRL) in den von dieser Zertifizierungsstelle ausgegebenen Zertifikaten verschlüsselt werden sollen. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-issuing-certificate-urls-encoded (boolescher Wert)

Dieses Feld bestimmt, ob die URL des ausstellenden Zertifikats in den von dieser Zertifizierungsstelle ausgestellten Zertifikaten codiert werden soll. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allowed-secret-groups (Zeichenfolge)

In diesem Feld wird die Erstellung privater Zertifikate auf die von Ihnen angegebenen Gruppen geheimer Schlüssel beschränkt. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 1024 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--private-cert-ttl (Zeichenfolge)

Die angeforderte Lebensdauer (Time-to-Live, TTL) für Zertifikate, die durch diese Zertifizierungsstelle erstellt werden. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 10 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[0-9]+[s,m,h,d]{0,1}$/ entsprechen.

--private-cert-allow-localhost (boolescher Wert)

Dieses Feld gibt an, ob 'localhost' als einer der angeforderten allgemeinen Namen eingeschlossen werden darf. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allowed-domains ([]zeichenfolge)

Die Domänen, die für die Zertifikatsvorlage definiert werden sollen. Diese Eigenschaft wird zusammen mit den Optionen 'allow_bare_domains' und 'allow_subdomains ' verwendet. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-allowed-domains-template (boolescher Wert)

Dieses Feld gibt an, ob die im Feld 'allowed_domains' angegebenen Domänen ACL-Vorlagen enthalten dürfen. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allow-bare-domains (boolescher Wert)

Dieses Feld gibt an, ob Clients private Zertifikate anfordern können, die dem Wert der tatsächlichen Domänen im endgültigen Zertifikat entsprechen. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allow-subdomains (boolescher Wert)

Dieses Feld gibt an, ob Clients private Zertifikate mit allgemeinen Namen (Common Names, CN) anfordern dürfen, die Unterdomänen der CNs sind, die von den anderen Zertifikatsvorlagenoptionen zugelassen sind. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allow-glob-domains (boolescher Wert)

Dieses Feld gibt an, ob glob-Muster in den Namen zulässig sind, die im Feld 'allowed_domains' angegeben sind. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allow-any-name (boolescher Wert)

Dieses Feld gibt an, ob Clients ein privates Zertifikat anfordern dürfen, das einem beliebigen allgemeinen Namen entspricht. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-enforce-hostname (boolescher Wert)

Dieses Feld gibt an, ob nur gültige Hostnamen für allgemeine Namen, alternative DNS-Subjektnamen und den Hostabschnitt von E-Mail-Adressen erzwungen werden sollen. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allow-ip-sans (boolescher Wert)

Dieses Feld gibt an, ob Clients ein privates Zertifikat mit alternativen IP-Subjektnamen anfordern dürfen. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-allowed-uri-sans ([]zeichenfolge)

Die URI-SANs (Subject Alternative Names), die für private Zertifikate zulässig sind. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-allowed-other-sans ([]zeichenfolge)

Die benutzerdefinierte Objekt-ID (OID) oder UTF8-string-SANs (Subject Alternative Names), die für private Zertifikate zulässig sind. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-server-flag (boolescher Wert)

Dieses Feld gibt an, ob private Zertifikate für die Verwendung durch den Server markiert sind. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-client-flag (boolescher Wert)

Dieses Feld gibt an, ob private Zertifikate für die Verwendung durch den Client markiert sind. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-code-signing-flag (boolescher Wert)

Dieses Feld gibt an, ob private Zertifikate zur Verwendung der Codesignatur markiert sind. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-email-protection-flag (boolescher Wert)

Dieses Feld gibt an, ob private Zertifikate für die Verwendung des E-Mail-Schutzes markiert sind. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-private-key-type (Zeichenfolge)

Der Typ des zu generierenden privaten Schlüssels. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Zulässige Werte: rsa, ec.

--private-cert-private-key-bits (int64)

Die Anzahl der Bits, die zum Generieren des privaten Schlüssels verwendet wird. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Der Höchstwert ist 4096. Der Mindestwert ist 224.

--private-cert-key-usage ([]zeichenfolge)

Die zulässige Einschränkung für die Schlüsselnutzung, die für private Zertifikate zu definieren ist. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /^[a-zA-Z]+$/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-ext-key-usage ([]zeichenfolge)

Die zulässige Einschränkung für die erweiterte Schlüsselnutzung für private Zertifikate. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /^[a-zA-Z]+$/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-ext-key-usage-oids ([]zeichenfolge)

Eine Liste der erweiterten Schlüsselnutzungsobjektkennungen (OIDs). Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-use-csr-common-name (boolescher Wert)

Dieses Feld legt fest, ob der allgemeine Name (Common Name, CN) aus einer Zertifikatssignieranforderung verwendet werden soll. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-use-cse-sans (boolescher Wert)

Dieses Feld legt fest, ob die SANs (Subject Alternative Names) aus einer Zertifikatssignieranforderung verwendet werden sollen. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-subject-organizational-unit ([]zeichenfolge)

Die Organisationseinheitenwerte (OU), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-organization ([]zeichenfolge)

Die Organisationswerte (O), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-country ([]zeichenfolge)

Die Länderwerte (C), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-locality ([]zeichenfolge)

Die Lokalitätswerte (L), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-province ([]zeichenfolge)

Die Werte für die Provinz (ST), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-street-address ([]zeichenfolge)

Die Werte für die Straßenanschrift, die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-postal-code ([]zeichenfolge)

Die Postleitzahlwerte, die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-requested-serial-number (Zeichenfolge)

Dieses Feld ist veraltet. Sie können den Wert ignorieren. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 64 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[^a-fA-F0-9]/ entsprechen.

--private-cert-require-cn (boolescher Wert)

Dieses Feld gibt an, ob zum Erstellen eines privaten Zertifikats ein allgemeiner Name erforderlich ist. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-policy-identifiers ([]zeichenfolge)

Eine Liste der Richtlinienobjekt-IDs (OIDs). Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-basic-constraints-valid-for-non-ca (boolescher Wert)

Dieses Feld gibt an, ob die Erweiterung „Basiseinschränkungen“ eines ausgestellten privaten Zertifikats als gültig für Nicht-CA-Zertifikate markiert werden soll. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--private-cert-not-before-duration (Zeichenfolge)

Der Zeitraum in Sekunden, um den die Eigenschaft 'not_before' eines ausgestellten privaten Zertifikats zurückdatiert werden soll. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 10 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[0-9]+[s,m,h,d]{0,1}$/ entsprechen.

--public-cert-lets-encrypt-environment (Zeichenfolge)

Die Konfiguration der 'Let's Encrypt'-CA-Umgebung. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Zulässige Werte: production, staging.

--public-cert-lets-encrypt-private-key (Zeichenfolge)

Der PEM-codierte private Schlüssel Ihres 'Let's Encrypt'-Kontos. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--public-cert-lets-encrypt-preferred-chain (Zeichenfolge)

Die bevorzugte Kette mit einem Aussteller, der diesem allgemeinen Subjektnamen entspricht. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 30 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--public-cert-cloud-internet-services-apikey (Zeichenfolge)

Ein IBM Cloud-API-Schlüssel, mit dem Domänen in Ihrer Cloud Internet Services-Instanz aufgelistet und DNS-Datensätze hinzufügt werden können. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--cloud-internet-services-crn (Zeichenfolge)

Eine CRN, die eine IBM Cloud-Ressource eindeutig identifiziert. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

--public-cert-classic-infrastructure-username (Zeichenfolge)

Der Benutzername, der Ihrem Konto der klassischen Infrastruktur zugeordnet ist. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--public-cert-classic-infrastructure-password (Zeichenfolge)

Ihr API-Schlüssel für die klassische Infrastruktur. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--configuration-task-timeout (Zeichenfolge)

Gibt die maximal zulässige Zeit für die Ausführung einer Code Engine-Aufgabe an. Nach Ablauf dieser Zeit wird der Status der Aufgabe in 'fehlgeschlagen' geändert. Der Mindestwert beträgt 5 Minuten und der Höchstwert 24 Stunden. Die Standardzeit für Aufgaben beträgt 10 Minuten. Der Wert kann entweder eine ganze Zahl sein, die die Anzahl der Sekunden angibt, oder die Zeichenfolgedarstellung einer Dauer, wie '10m' oder '2h'. Diese Option liefert einen Wert für ein Unterfeld der JSON-Option "configuration-patch". Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 6 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /^[0-9]+[s,m,h,d]{0,1}$/ entsprechen.

Beispiel

ibmcloud secrets-manager configuration-update \
    --name configuration-name \
    --config-type public_cert_configuration_dns_cloud_internet_services \
    --public-cert-cloud-internet-services-apikey 5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ \
    --cloud-internet-services-crn crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::

`ibmcloud secrets-manager configuration-delete`

Löschen Sie eine Konfiguration, indem Sie ihren Namen angeben.

ibmcloud secrets-manager configuration-delete --name NAME [--config-type CONFIG-TYPE]

Befehlsoptionen

--name (Zeichenfolge)

Der Name der Konfiguration. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--config-type (Zeichenfolge)

Der Konfigurationstyp dieser Konfiguration – verwenden Sie diesen Header, um Fehlerantworten des Typs 300 aufzulösen.

Beispiel

ibmcloud secrets-manager configuration-delete \
    --name configuration-name \
    --config-type public_cert_configuration_dns_cloud_internet_services

`ibmcloud secrets-manager configuration-action-create`

Erstellen Sie eine Konfigurationsaktion. Dieser Vorgang unterstützt die folgenden Aktionen:

private_cert_configuration_action_sign_intermediate: Signieren Sie eine Zwischenzertifizierungsstelle.
private_cert_configuration_action_sign_csr: Signieren Sie eine Zertifikatssignieranforderung.
private_cert_configuration_action_set_signed: Legen Sie eine signierte temporäre Zertifizierungsstelle fest.
private_cert_configuration_action_revoke_ca_certificate: Widerrufen Sie ein intern signiertes CA-Zwischenzertifikat.
private_cert_configuration_action_rotate_crl: Tauschen Sie die Zertifikatswiderrufsliste (CRL) einer Zwischenzertifizierungsstelle aus.
private_cert_configuration_action_rotate_intermediate: Drehen Sie ein intern signiertes Zwischenzertifizierungsstellen-Zertifikat.

ibmcloud secrets-manager configuration-action-create --name NAME [--config-action-prototype CONFIG-ACTION-PROTOTYPE | --config-action-action-type CONFIG-ACTION-ACTION-TYPE --certificate-common-name CERTIFICATE-COMMON-NAME --certificate-alt-names CERTIFICATE-ALT-NAMES --private-cert-ip-sans PRIVATE-CERT-IP-SANS --private-cert-uri-sans PRIVATE-CERT-URI-SANS --private-cert-other-sans PRIVATE-CERT-OTHER-SANS --private-cert-ttl PRIVATE-CERT-TTL --private-cert-format PRIVATE-CERT-FORMAT --private-cert-max-path-length PRIVATE-CERT-MAX-PATH-LENGTH --private-cert-exclude-cn-from-sans=PRIVATE-CERT-EXCLUDE-CN-FROM-SANS --private-cert-permitted-dns-domains PRIVATE-CERT-PERMITTED-DNS-DOMAINS --config-action-use-csr-values=CONFIG-ACTION-USE-CSR-VALUES --private-cert-subject-organizational-unit PRIVATE-CERT-SUBJECT-ORGANIZATIONAL-UNIT --private-cert-subject-organization PRIVATE-CERT-SUBJECT-ORGANIZATION --private-cert-subject-country PRIVATE-CERT-SUBJECT-COUNTRY --private-cert-subject-locality PRIVATE-CERT-SUBJECT-LOCALITY --private-cert-subject-province PRIVATE-CERT-SUBJECT-PROVINCE --private-cert-subject-street-address PRIVATE-CERT-SUBJECT-STREET-ADDRESS --private-cert-subject-postal-code PRIVATE-CERT-SUBJECT-POSTAL-CODE --private-cert-serial-number PRIVATE-CERT-SERIAL-NUMBER --private-cert-csr PRIVATE-CERT-CSR --config-action-intermediate-certificate-authority CONFIG-ACTION-INTERMEDIATE-CERTIFICATE-AUTHORITY --imported-cert-certificate IMPORTED-CERT-CERTIFICATE] [--config-type CONFIG-TYPE]

Befehlsoptionen

--name (Zeichenfolge)

Der Name der Konfiguration. Erforderlich.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--config-action-prototype (ConfigurationActionPrototype)

Der Anforderungshauptteil zur Angabe der Eigenschaften der Aktion zum Erstellen einer Konfiguration. Diese JSON-Option kann stattdessen bereitgestellt werden, indem einzelne Felder mit anderen Optionen festgelegt werden. Sie und diese Optionen schließen sich gegenseitig aus.

--config-type (Zeichenfolge)

Der Konfigurationstyp dieser Konfiguration – verwenden Sie diesen Header, um Fehlerantworten des Typs 300 aufzulösen.

--config-action-action-type (Zeichenfolge)

Der Typ der Konfigurationsaktion. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Zulässige Werte sind: private_cert_configuration_action_rotate_crl, private_cert_configuration_action_sign_intermediate, private_cert_configuration_action_sign_csr, private_cert_configuration_action_set_signed, private_cert_configuration_action_revoke_ca_certificate, private_cert_configuration_action_rotate_intermediate.

--certificate-common-name (Zeichenfolge)

Der allgemeine Name (Common Name, CN) steht für den Servernamen, der durch das SSL-Zertifikat geschützt wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 4 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--certificate-alt-names ([]zeichenfolge)

Im Feld 'Alternativer Name des Subjekts' können Sie zusätzliche Hostnamen angeben, die durch ein einziges SSL-Zertifikat geschützt werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /^(.*?)$/ entsprechen. Die maximale Länge beträgt 99. Die Mindestlänge beträgt 0.

--private-cert-ip-sans (Zeichenfolge)

Die IP-SANs (Subject Alternative Names), die für das CA-Zertifikat definiert werden sollen, in einer durch Kommas begrenzten Liste. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 2048 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--private-cert-uri-sans (Zeichenfolge)

Die URI-SANs (Subject Alternative Names), die für das CA-Zertifikat definiert werden sollen, in einer durch Kommas begrenzten Liste. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 2048 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--private-cert-other-sans ([]zeichenfolge)

Die benutzerdefinierte Objekt-ID (OID) oder UTF8-string-SANs (Subject Alternative Names), die für das CA-Zertifikat definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--private-cert-ttl (Zeichenfolge)

Die Lebensdauer (TTL, Time-to-Live), die einem privaten Zertifikat zugeordnet wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 10 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^[0-9]+[s,m,h,d]{0,1}$/ entsprechen.

--private-cert-format (Zeichenfolge)

Das Format der zurückgegebenen Daten. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Zulässige Werte: pem, pem_bundle.

--private-cert-max-path-length (int64)

Die maximale Pfadlänge, die im erzeugten Zertifikat kodiert werden soll. -1 bedeutet keine Begrenzung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Der Höchstwert ist 10. Der Mindestwert ist -1.

--private-cert-exclude-cn-from-sans (boolescher Wert)

Dieser Parameter steuert, ob der allgemeine Name aus SANs (Subject Alternative Names) ausgeschlossen wird. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-permitted-dns-domains ([]zeichenfolge)

Die zulässigen DNS-Domänen oder Unterdomänen für die Zertifikate, die von diesem CA-Zertifikat signiert und ausgestellt werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 100. Die Mindestlänge beträgt 0.

--config-action-use-csr-values (boolescher Wert)

Dieses Feld gibt an, ob Werte aus einer Zertifikatsignierungsanforderung (CSR) verwendet werden sollen, um eine private_cert_configuration_action_sign_csr Aktion abzuschließen. Wenn sie auf true gesetzt ist, gilt Folgendes:

Subjektinformationen, einschließlich Namen und alternative Namen, werden von der CSR beibehalten, anstatt die Werte zu verwenden, die in den anderen Parametern für diese Operation angegeben sind.
Jede in der CSR angeforderte Schlüsselverwendung (z. B. fälschungssicherer Herkunftsnachweis) wird der Basisgruppe der Schlüsselverwendungen hinzugefügt, die für CA-Zertifikate verwendet werden, die von der Zwischenzertifizierungsstelle signiert wurden.
In der Zertifikatssignieranforderung angeforderte Erweiterungen werden in das ausgestellte private Zertifikat kopiert. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

--private-cert-subject-organizational-unit ([]zeichenfolge)

Die Organisationseinheitenwerte (OU), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-organization ([]zeichenfolge)

Die Organisationswerte (O), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-country ([]zeichenfolge)

Die Länderwerte (C), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-locality ([]zeichenfolge)

Die Lokalitätswerte (L), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-province ([]zeichenfolge)

Die Werte für die Provinz (ST), die im Betrefffeld des resultierenden Zertifikats definiert werden sollen Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-street-address ([]zeichenfolge)

Die Werte für die Straßenanschrift, die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-subject-postal-code ([]zeichenfolge)

Die Postleitzahlwerte, die im Betrefffeld des resultierenden Zertifikats definiert werden sollen. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die Listenelemente müssen dem regulären Ausdruck /(.*?)/ entsprechen. Die maximale Länge beträgt 10. Die Mindestlänge beträgt 0.

--private-cert-serial-number (Zeichenfolge)

Der angeforderte Wert für das Attribut serialNumber ( https://datatracker.ietf.org/doc/html/rfc4519#section-2.31 ), das im Distinguished Name (DN) des Zertifikats enthalten ist. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

The maximum length is 64 characters. The minimum length is 32 characters. The value must match regular expression /[^a-fA-F0-9]/.

--private-cert-csr (Zeichenfolge)

Die Zertifikatssignieranforderung. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 4096 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/ entsprechen.

--config-action-intermediate-certificate-authority (Zeichenfolge)

Der Name der Konfiguration der Zwischenzertifizierungsstelle. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 128 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--imported-cert-certificate (Zeichenfolge)

Der PEM-codierte Inhalt Ihres Zertifikats. Diese Option stellt einen Wert für ein Unterfeld der JSON-Option 'config-action-prototype' bereit. Sie und diese Option schließen sich gegenseitig aus.

Die maximale Länge beträgt 100000 Zeichen. Die Mindestlänge beträgt 50 Zeichen. Der Wert muss dem regulären Ausdruck /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/ entsprechen.

Beispiele

ibmcloud secrets-manager configuration-action-create \
    --name configuration-name \
    --config-action-prototype '{"action_type": "private_cert_configuration_action_rotate_crl"}' \
    --config-type public_cert_configuration_dns_cloud_internet_services

Alternativ sind differenzierte Optionen für die Unterfelder von JSON-Zeichenfolgeoptionen verfügbar:

ibmcloud secrets-manager configuration-action-create \
    --name configuration-name \
    --config-type public_cert_configuration_dns_cloud_internet_services \
    --config-action-action-type private_cert_configuration_action_rotate_crl

Benachrichtigungen

Aktivieren Sie Lebenszyklusbenachrichtigungen für Ihre Instanz, indem Sie eine Verbindung zu Event Notifications herstellen.

`ibmcloud secrets-manager notifications-registration-create`

Erstellen Sie eine Registrierung zwischen einer Secrets Manager -Instanz und Event Notifications.

Eine erfolgreiche Anforderung fügt Secrets Manager als Quelle hinzu, auf die von Ihrer Event Notifications -Instanz aus verwiesen werden kann. Weitere Informationen zum Aktivieren von Benachrichtigungen für Secrets Managerfinden Sie im Dokumentation.

ibmcloud secrets-manager notifications-registration-create --event-notifications-instance-crn EVENT-NOTIFICATIONS-INSTANCE-CRN --event-notifications-source-name EVENT-NOTIFICATIONS-SOURCE-NAME [--event-notifications-source-description EVENT-NOTIFICATIONS-SOURCE-DESCRIPTION]

Befehlsoptionen

--event-notifications-instance-crn (Zeichenfolge)

Eine CRN, die eine IBM Cloud-Ressource eindeutig identifiziert. Erforderlich.

--event-notifications-source-name (Zeichenfolge)

Der Name, der als Quelle in Ihrer Instanz von Event Notifications angezeigt wird. Erforderlich.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 2 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

--event-notifications-source-description (Zeichenfolge)

Eine optionale Beschreibung für die Quelle in Ihrer Event Notifications-Instanz.

Die maximale Länge beträgt 1024 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /(.*?)/ entsprechen.

Beispiel

ibmcloud secrets-manager notifications-registration-create \
    --event-notifications-instance-crn crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8:: \
    --event-notifications-source-name 'My Secrets Manager' \
    --event-notifications-source-description 'Optional description of this source in an Event Notifications instance.'

Beispielausgabe

Beispielkonfigurationsdetails für die Registrierung von Benachrichtigungen für Event Notifications.

{
  "event_notifications_instance_crn" : "crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::"
}

`ibmcloud secrets-manager notifications-registration`

Rufen Sie die Details der Registrierung zwischen Ihrer Secrets Manager-Instanz und Event Notifications ab.

ibmcloud secrets-manager notifications-registration

Beispiel

ibmcloud secrets-manager notifications-registration

Beispielausgabe

Beispielkonfigurationsdetails für die Registrierung von Benachrichtigungen für Event Notifications.

{
  "event_notifications_instance_crn" : "crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::"
}

`ibmcloud secrets-manager notifications-registration-delete`

Löschen Sie die Registrierung zwischen Ihrer Secrets Manager Instanz und Event Notifications.

Eine erfolgreiche Anforderung entfernt Ihre Secrets Manager -Instanz als Quelle in Event Notifications.

ibmcloud secrets-manager notifications-registration-delete

Beispiel

ibmcloud secrets-manager notifications-registration-delete

`ibmcloud secrets-manager notifications-registration-test`

Sendet ein Testereignis von einer Secrets Manager -Instanz an eine konfigurierte Event Notifications -Instanz.

Eine erfolgreiche Anforderung sendet ein Testereignis an die Event Notifications -Instanz. Weitere Informationen zum Aktivieren von Benachrichtigungen für Secrets Managerfinden Sie im Dokumentation.

ibmcloud secrets-manager notifications-registration-test

Beispiel

ibmcloud secrets-manager notifications-registration-test

Schemabeispiele

Die folgenden Schemabeispiele stellen die Daten dar, die Sie für eine Befehlsoption angeben müssen. Diese Beispiele modellieren die Datenstruktur und umfassen Platzhalterwerte für den erwarteten Werttyp. Wenn Sie einen Befehl ausführen, ersetzen Sie diese Werte durch die Werte, die für Ihre Umgebung gelten.

ConfigurationActionPrototype

Das folgende Beispiel zeigt das Format des Objekts ConfigurationActionPrototype.


{
  "action_type" : "private_cert_configuration_action_rotate_crl"
}

ConfigurationPrototype

Das folgende Beispiel zeigt das Format des Objekts ConfigurationPrototype.


{
  "config_type" : "public_cert_configuration_dns_cloud_internet_services",
  "name" : "example-cloud-internet-services-config",
  "cloud_internet_services_apikey" : "5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ",
  "cloud_internet_services_crn" : "crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::"
}

CustomCredentialsConfigurationCodeEngine

Das folgende Beispiel zeigt das Format des Objekts CustomCredentialsConfigurationCodeEngine.


{
  "job_name" : "sm-custom-cred-job",
  "project_id" : "15314cc3-85b4-4338-903f-c28cdee6d005",
  "region" : "us-south"
}

CustomCredentialsNewCredentials

Das folgende Beispiel zeigt das Format des Objekts CustomCredentialsNewCredentials.


{
  "id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
  "payload" : {
    "anyKey" : "anyValue"
  }
}

ImportedCertificateManagedCsr

Das folgende Beispiel zeigt das Format des Objekts ImportedCertificateManagedCsr.


{
  "ou" : [ "exampleString", "anotherExampleString" ],
  "organization" : [ "exampleString", "anotherExampleString" ],
  "country" : [ "exampleString", "anotherExampleString" ],
  "locality" : [ "exampleString", "anotherExampleString" ],
  "province" : [ "exampleString", "anotherExampleString" ],
  "street_address" : [ "exampleString", "anotherExampleString" ],
  "postal_code" : [ "exampleString", "anotherExampleString" ],
  "require_cn" : true,
  "common_name" : "example.com",
  "alt_names" : "alt-name-1,alt-name-2",
  "ip_sans" : "1.1.1.1,2.2.2.2",
  "uri_sans" : "exampleString",
  "other_sans" : "2.5.4.5;UTF8:*.example.com",
  "exclude_cn_from_sans" : true,
  "user_ids" : "user-1,user-2",
  "server_flag" : true,
  "client_flag" : true,
  "code_signing_flag" : true,
  "email_protection_flag" : true,
  "key_type" : "rsa",
  "key_bits" : 4096,
  "key_usage" : "DigitalSignature,KeyAgreement,KeyEncipherment",
  "ext_key_usage" : "ServerAuth,ClientAuth,EmailProtection",
  "policy_identifiers" : "exampleString",
  "ext_key_usage_oids" : "exampleString",
  "rotate_keys" : true
}

PasswordGenerationPolicy

Das folgende Beispiel zeigt das Format des Objekts PasswordGenerationPolicy.


{
  "length" : 32,
  "include_digits" : true,
  "include_symbols" : true,
  "include_uppercase" : true
}

PasswordGenerationPolicyPatch

Das folgende Beispiel zeigt das Format des Objekts PasswordGenerationPolicyPatch.


{
  "length" : 12,
  "include_digits" : true,
  "include_symbols" : true,
  "include_uppercase" : true
}

PrivateCertificateCryptoKey

Das folgende Beispiel zeigt das Format des Objekts PrivateCertificateCryptoKey.


{
  "type" : "hyper_protect_crypto_services",
  "instance_crn" : "crn:v1:bluemix:public:hs-crypto:us-south:a/791f3fb10486421e97aa8512f18b7e65:b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5::",
  "pin_iam_credentials_secret_id" : "6ebb80d3-26d1-4e24-81d6-afb0d8e22f54",
  "private_keystore_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5"
}

PublicCertificateRotationObject

Das folgende Beispiel zeigt das Format des Objekts PublicCertificateRotationObject.


{
  "rotate_keys" : true
}

RotationPolicy

Das folgende Beispiel zeigt das Format des Objekts RotationPolicy.


{
  "auto_rotate" : true,
  "interval" : 1,
  "unit" : "day"
}

SecretActionPrototype

Das folgende Beispiel zeigt das Format des Objekts SecretActionPrototype.


{
  "action_type" : "private_cert_action_revoke_certificate"
}

SecretLockPrototype[]

Das folgende Beispiel zeigt das Format des Objekts SecretLockPrototype[] .


[ {
  "name" : "lock-example-1",
  "description" : "lock for consumer 1",
  "attributes" : {
    "anyKey" : "anyValue"
  }
} ]

SecretPrototype

Das folgende Beispiel zeigt das Format des Objekts SecretPrototype.


{
  "custom_metadata" : {
    "anyKey" : "anyValue"
  },
  "description" : "Description of my arbitrary secret.",
  "expiration_date" : "2030-10-05T11:49:42Z",
  "labels" : [ "dev", "us-south" ],
  "name" : "example-arbitrary-secret",
  "secret_group_id" : "default",
  "secret_type" : "arbitrary",
  "payload" : "secret-data",
  "version_custom_metadata" : {
    "anyKey" : "anyValue"
  }
}

SecretTaskError

Das folgende Beispiel zeigt das Format des Objekts SecretTaskError.


{
  "code" : "exampleString",
  "description" : "Failed to create credentials"
}

SecretTaskPrototype

Das folgende Beispiel zeigt das Format des Objekts SecretTaskPrototype.


{
  "status" : "credentials_created",
  "credentials" : {
    "id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
    "payload" : {
      "anyKey" : "anyValue"
    }
  }
}

SecretVersionActionPrototype

Das folgende Beispiel zeigt das Format des Objekts SecretVersionActionPrototype.


{
  "action_type" : "private_cert_action_revoke_certificate"
}

SecretVersionPrototype

Das folgende Beispiel zeigt das Format des Objekts SecretVersionPrototype.


{
  "payload" : "updated secret credentials",
  "custom_metadata" : {
    "anyKey" : "anyValue"
  },
  "version_custom_metadata" : {
    "anyKey" : "anyValue"
  }
}

ServiceCredentialsSecretSourceService

Das folgende Beispiel zeigt das Format des Objekts ServiceCredentialsSecretSourceService.


{
  "crn" : "exampleString"
}