Secrets Manager CLI

您可以使用 IBM Cloud® Secrets Manager 指令行介面 (CLI) 管理 Secrets Manager 範例中的機密。

現行版本: 2.0.16

必要條件

安裝 IBM Cloud CLI，然後執行下列指令安裝 Secrets Manager CLI 外掛程式：

ibmcloud plugin install secrets-manager

當 IBM Cloud CLI 和外掛程式的更新可用時，您會收到命令列通知。請務必保持最新的 CLI，以便您可以使用最新指令。您可以執行 ibmcloud plugin list 來檢視所有已安裝外掛程式的現行版本。

以 Secrets Manager 範例為目標

若要以 Secrets Manager 實例為目標，請使用下列其中一個選項。

執行 ibmcloud secrets-manager config set 指令。

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

以 Secrets Manager 服務端點匯出環境變數 URL。

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

在指令中設定服務端點。

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

將 {instance_ID} 和 {region} 取代為適用於 Secrets Manager 服務實例的值。要找到專屬於您的實例的端點 URL，您可以從 Secrets Manager UI 的端點頁面複製它。如需相關資訊，請參閱檢視端點 URL

整體

指令

`ibmcloud secrets-manager docs`

在網頁瀏覽器中開啟外掛程式說明文件。

ibmcloud secrets-manager docs

範例

ibmcloud secrets-manager docs

選項

--instance-id (字串): 服務供應商指定的 Secrets Manager Instance ID。
--region (字串): 在其中佈建 Secrets Manager 實例的地區。可用值：US-South、US-East、AU-SYD、JP-SA、JP-TOK、EU-DE、EU-GB、EU-ES、CA-TOR、CA-MON、BR-SAO。
--output (字串): 選擇輸出格式 - 可以是 'json'、'yaml' 或 'table'。預設為 'table'。
-j，--jmes-query (字串): 提供 JMESPath 查詢以自訂輸出。
--service-url (字串): 提供 API 的基本端點 URL。
-q, --quiet: 抑制詳細訊息。
-v, --version: 列印插件版本。

範例

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

本範例僅示範所有子指令可用的全局選項，本身並非有效的指令。

配置

全域參數也可以儲存在持久性配置中，這樣就不需要在每次呼叫插件時手動指定它們。每一個參數都可以使用 config 指令及其次指令來配置。

ibmcloud secrets-manager config

`ibmcloud secrets-manager config set`

設定特定選項的新配置值。 set 指令的每個次指令都對映至廣域選項。每個次指令都接受單一引數，即要為選項儲存的值的字串表示法。

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

範例

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

`ibmcloud secrets-manager config get`

列印出特定選項的目前設定值。 get 指令的每個次指令都對映至廣域選項。

ibmcloud secrets-manager config get <option>

範例

ibmcloud secrets-manager config get service-url

`ibmcloud secrets-manager config unset`

取消設定特定選項目前設定的值。 unset 指令的每個次指令都對映至廣域選項。

此服務可用的次指令為: service-url。

ibmcloud secrets-manager config unset <option>

範例

ibmcloud secrets-manager config unset service-url

`ibmcloud secrets-manager config list`

列出所有目前設定的配置值。

ibmcloud secrets-manager config list

範例

ibmcloud secrets-manager config list

密鑰群組

透過建立及管理群組來控制誰可以存取密鑰。

`ibmcloud secrets-manager secret-group-create`

建立秘密群組，用來組織秘密和控制誰可以存取這些秘密。

成功要求會傳回密鑰群組的 ID 值，以及其他內容。若要進一步瞭解密鑰群組，請參閱文件。

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

指令選項

--name (字串)

密鑰群組的名稱。必要。

最大長度為 64 字元。最小長度為 2 字元。值必須符合正規表示式 /^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/。

--description (字串)

密鑰群組的延伸說明。

最大長度為 1024 字元。最小長度為 0 字元。值必須符合正規表示式 /(.*?)/。

範例

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

輸出範例

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`

列出 Secrets Manager 實例中可用的密鑰群組。

ibmcloud secrets-manager secret-groups

範例

ibmcloud secrets-manager secret-groups

輸出範例

SecretGroup 集合回應範例

{
  "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
}

預設 JMESPath

如果使用者沒有提供 JMESPath 查詢，預設會套用此指令的輸出。確切的查詢取決於所要求的情況和輸出格式。您可以在下表中看到每個預設 JMESPath 查詢的條件：

預設 JMESPath
回應	輸出	查詢
成功	預設值
	表格	`secret_groups[*]`
錯誤	預設值
	表格	`secret_groups[*]`
所有頁面	預設值
	表格	`secret_groups[*]`

如果提供自訂的 JMESPath 查詢，則會取代上表中的任何 JMESPath。

`ibmcloud secrets-manager secret-group`

透過指定現有密鑰群組的 ID 來取得該群組的內容。

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

指令選項

--secret-group-id (字串)

密鑰群組的 ID。必要。

最大長度為 36 字元。最小長度為 7 字元。值必須符合正規表示式 /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/。

範例

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

輸出範例

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`

更新現有秘密群組的內容，例如名稱或說明。

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

指令選項

--id (字串)

密鑰群組的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--secret-group-patch (一般對映)

用於更新密鑰群組的要求內文。可以改為透過使用其他選項設定個別欄位來提供此 JSON 選項。它與這些選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --secret-group-patch=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--name (字串)

密鑰群組的名稱。此選項為 JSON 選項 'secret-group-patch' 的子字段提供一個值。它與該選項互斥。

最大長度為 64 字元。最小長度為 2 字元。值必須符合正規表示式 /^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/。

--description (字串)

密鑰群組的延伸說明。此選項為 JSON 選項 'secret-group-patch' 的子字段提供一個值。它與該選項互斥。

最大長度為 1024 字元。最小長度為 0 字元。值必須符合正規表示式 /(.*?)/。

範例

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

輸出範例

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`

透過指定秘密群組的 ID 刪除秘密群組。

附註: 若要刪除密鑰群組，它必須是空的。如果您需要移除包含機密的機密群組，您必須先刪除與該群組相關的機密。

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

指令選項

--id (字串)

密鑰群組的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

範例

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

密碼

為您的應用程式和服務建立、訂購及管理不同類型的密碼。

`ibmcloud secrets-manager secret-create`

建立密鑰或匯入現有值，以用來存取受保護資源或向受保護資源進行鑑別。

使用此作業可產生或匯入現有的秘訣，例如 TLS 憑證，您可以在 Secrets Manager 服務範例中管理該憑證。成功要求會根據您指定的密鑰類型及資料，將密鑰儲存在專用實例中。回應會傳回密鑰的 ID 值，以及其他 meta 資料。

若要進一步瞭解您可以使用 Secrets Manager建立的密鑰類型，請參閱文件。

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]

指令選項

--secret-prototype (SecretPrototype)

包含建立密鑰所需詳細資料的 JSON。可以改為透過使用其他選項設定個別欄位來提供此 JSON 選項。它與這些選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --secret-prototype=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--secret-custom-metadata (一般對映)

使用者可以自訂的密鑰 meta 資料。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --secret-custom-metadata=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--secret-description (字串)

密鑰的延伸說明。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 1024 字元。最小長度為 0 字元。值必須符合正規表示式 /(.*?)/。

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

密鑰資料到期的日期。日期格式遵循 RFC 3339 格式。支援的密鑰類型：任意、username_password。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

--secret-labels ([]字串)

可用來在實例中搜尋密鑰的標籤。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 30 項。最小長度為 0 項。

--secret-name (字串)

指派給密鑰的人類可讀名稱。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 256 字元。最小長度為 2 字元。值必須符合正規表示式 /^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/。

--secret-group-id (字串)

UUID 識別碼，或 default secret group。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 36 字元。最小長度為 7 字元。值必須符合正規表示式 /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/。

--secret-type (字串)

密鑰類型。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

允許值為 arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, username_password, custom_credentials。

--arbitrary-payload (字串)

指派給 arbitrary 秘密的秘密資料。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 1000000 字元。最小長度為 0 字元。值必須符合正規表示式 /(.*?)/。

--secret-version-custom-metadata (一般對映)

使用者可以自訂的密鑰版本 meta 資料。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --secret-version-custom-metadata=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--secret-ttl (字串)

要指派給所產生認證的存活時間 (TTL) 或租賃持續時間。支援的密鑰類型：iam_credentials、service_credentials、custom_credentials。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 10 字元。值必須符合正規表示式 /^[0-9]+[s,m,h,d]{0,1}$/。

--iam-credentials-access-groups ([]字串)

您可以用於 iam_credentials secret 的存取群組。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /^AccessGroupId-[a-z0-9-]+[a-z0-9]$/。最大長度為 10 項。最小長度為 1 項。

--iam-credentials-service-id (字串)

用來建立 API 金鑰的服務 ID。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

長度必須為 46 字元。值必須符合正規表示式 /^ServiceId-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/。

--iam-credentials-account-id (字串)

在其中建立 IAM 認證的帳戶 ID。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

長度必須為 32 字元。值必須符合正規表示式 /^[a-z0-9]*$/。

--iam-credentials-reuse-apikey (bool)

此參數指出是否在未來讀取作業中重複使用服務 ID 及 API 金鑰。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

--secret-rotation (RotationPolicy)

此欄位指出 Secrets Manager 是否自動輪替您的密鑰。支援的密鑰類型：username_password、private_cert、public_cert、iam_credentials、custom_credentials。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --secret-rotation=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--imported-cert-certificate (字串)

憑證的 PEM 編碼內容。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 100000 字元。最小長度為 50 字元。值必須符合正規表示式 /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/。

--imported-cert-intermediate (字串)

（選用）與主要憑證相關聯的 PEM 編碼中繼憑證。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 100000 字元。最小長度為 50 字元。值必須符合正規表示式 /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/。

--imported-cert-private-key (字串)

（選用）要與憑證相關聯的 PEM 編碼私密金鑰。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 100000 字元。最小長度為 50 字元。值必須符合正規表示式 /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/。

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

指定用來建立 CSR 和私密金鑰的資料。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --imported-cert-managed-csr=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--kv-data (一般對映)

鍵值密鑰的有效負載資料。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最小長度為 1 項。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --kv-data=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--private-cert-template-name (字串)

憑證範本的名稱。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/。

--certificate-common-name (字串)

「通用名稱 (CN)」代表受 SSL 憑證保護的伺服器名稱。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最小長度為 4 字元。

--certificate-alt-names ([]字串)

透過「主體替代名稱」欄位，您可以指定要由單一 SSL 憑證保護的其他主機名稱。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /^(.*?)$/。最大長度為 99 項。最小長度為 0 項。

--private-cert-ip-sans (字串)

要為 CA 憑證定義的「IP 主體替代名稱」（以逗點區隔清單）。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 2048 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--private-cert-uri-sans (字串)

要為 CA 憑證定義的「URI 主體替代名稱」，以逗點區隔清單。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 2048 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--private-cert-other-sans ([]字串)

要為 CA 憑證定義的自訂物件 ID (OID) 或 UTF8-string 主體替代名稱。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-csr (字串)

憑證簽署要求。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 4096 字元。最小長度為 2 字元。值必須符合正規表示式 /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/。

--private-cert-format (字串)

所傳回資料的格式。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

允許值為：pem, pem_bundle。

--private-cert-private-key-format (字串)

所產生私密金鑰的格式。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

預設值為 der。允許值為：der, pkcs8。

--private-cert-exclude-cn-from-sans (bool)

此參數控制是否從「主體替代名稱 (SAN)」中排除一般名稱。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

--public-cert-key-algorithm (字串)

用來產生與憑證相關聯之公開金鑰的加密演算法 ID。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

預設值為 RSA2048。最大長度為 8 字元。最小長度為 5 字元。值必須符合正規表示式 /^(RSA2048|RSA4096|ECDSA256|ECDSA384)$/。

--public-cert-ca (字串)

憑證管理中心配置的名稱。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--public-cert-dns (字串)

DNS 提供者配置的名稱。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--public-cert-bundle-ca (bool)

此欄位指出已發出的憑證是否與中繼憑證組合在一起。設定為 false，使憑證檔案只包含已簽發的憑證。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

預設值為 true。

--secret-source-service (ServiceCredentialsSecretSourceService)

為指定來源服務實例建立服務認證所需的內容。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --secret-source-service=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--username-password-username (字串)

指定給 username_password secret 的使用者名稱。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 64 字元。最小長度為 2 字元。值必須符合正規表示式 /[A-Za-z0-9+-=.]*/。

--username-password-password (字串)

指定給 username_password secret 的密碼。如果您省略此參數，則 Secrets Manager 會為您的密鑰產生新的隨機密碼。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 256 字元。最小長度為 6 字元。值必須符合正規表示式 /.{6,256}/。

--username-password-policy (PasswordGenerationPolicy)

自動產生密碼的原則。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --username-password-policy=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--custom-credentials-configuration (字串)

自訂認證配置的名稱。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /^[a-zA-Z0-9]([-a-zA-Z0-9\\-_\\.]*)?$/。

--custom-credentials-parameters (一般對映)

傳給自訂認證引擎的參數。允許的類型有字串、整數和布林值。此選項為 JSON 選項 'secret-prototype' 的子欄位提供值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --custom-credentials-parameters=@path/to/file.json) 來指定要讀取的 JSON 檔案。

範例

要求範例

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

`ibmcloud secrets-manager secrets`

列出 Secrets Manager 實例中可用的密鑰。附註: 如果未設定 --all-pages 選項，則指令只會擷取集合的單一頁面。

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

指令選項

--offset (int64)

要跳過的密鑰數目。

預設值為 0。最大值為 10000000。最小值為 0。

--limit (int64)

要列出的密鑰數目。

預設值為 200。最大值為 1000。最小值為 1。

--sort (字串)

依指定欄位以遞增順序排序密鑰集合。若要以降序排序，請使用 - 字元。

--search (字串)

過濾在下列一個以上欄位中包含指定字串的密鑰："id"、"name"、"description"、"labels"、"secret_type"。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--groups ([]字串)

依群組過濾密鑰。提供要作為過濾依據的群組 ID。

清單項目必須符合正規表示式 /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/。最大長度為 201 項。最小長度為 0 項。

--secret-types ([]字串)

依類型過濾密鑰。提供要作為過濾依據的密鑰類型。

允許的清單項目有 arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, username_password, custom_credentials。最大長度為 9 項。最小長度為 0 項。

--match-all-labels ([]字串)

依標籤過濾密鑰。提供要作為過濾依據的標籤。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 30 項。最小長度為 0 項。

--all-pages (bool)

呼叫多個要求，以顯示密鑰集合的所有頁面。

範例

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

輸出範例

密鑰 meta 資料收集回應範例

{
  "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
}

預設 JMESPath

預設 JMESPath
回應	輸出	查詢
成功	預設值
	表格	`secrets[*].{Name:name,ID:id,Secret_Type:secret_type,secret_group_id:secret_group_id,State:state_description,Locks:locks_total,Expiration:expiration_date}`
錯誤	預設值
	表格	`secrets[*].{Name:name,ID:id,Secret_Type:secret_type,secret_group_id:secret_group_id,State:state_description,Locks:locks_total,Expiration:expiration_date}`
所有頁面	預設值
	表格	`secrets[*].{Name:name,ID:id,Secret_Type:secret_type,secret_group_id:secret_group_id,State:state_description,Locks:locks_total,Expiration:expiration_date}`

如果提供自訂的 JMESPath 查詢，則會取代上表中的任何 JMESPath。

`ibmcloud secrets-manager secret`

透過指定秘密的 ID 取得秘密及其詳細資訊。

成功要求會傳回與密鑰相關聯的密鑰資料，以及其他 meta 資料。若要僅檢視指定秘密的詳細資訊，而不擷取其值，請使用 Get secret metadata 作業。

ibmcloud secrets-manager secret --id ID

指令選項

--id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

範例

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

`ibmcloud secrets-manager secret-delete`

透過指定秘密的 ID 刪除秘密。

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

指令選項

--id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--force-delete (bool)

設定為 true 可強制刪除秘密。僅適用於自訂認證密鑰類型。

預設值為 false。

範例

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

`ibmcloud secrets-manager secret-metadata`

透過指定秘密的 ID 取得該秘密的元資料。

ibmcloud secrets-manager secret-metadata --id ID

指令選項

--id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

範例

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

`ibmcloud secrets-manager secret-metadata-update`

更新密鑰的 meta 資料，例如密鑰名稱或說明。

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]

指令選項

--id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--secret-metadata-patch (一般對映)

update_secret_metadata 的 JSON 合併-修補內容。可以改為透過使用其他選項設定個別欄位來提供此 JSON 選項。它與這些選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --secret-metadata-patch=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--name (字串)

指派給密鑰的人類可讀名稱。此選項為 JSON 選項 'secret-metadata-patch' 的子字段提供一個值。它與該選項互斥。

最大長度為 256 字元。最小長度為 2 字元。值必須符合正規表示式 /^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/。

--description (字串)

密鑰的延伸說明。此選項為 JSON 選項 'secret-metadata-patch' 的子字段提供一個值。它與該選項互斥。

最大長度為 1024 字元。最小長度為 0 字元。值必須符合正規表示式 /(.*?)/。

--labels ([]字串)

可用來在實例中搜尋密鑰的標籤。此選項為 JSON 選項 'secret-metadata-patch' 的子字段提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 30 項。最小長度為 0 項。

--custom-metadata (一般對映)

使用者可以自訂的密鑰 meta 資料。它應該是 JSON 字串或 JSON 檔案的路徑。此選項為 JSON 選項 'secret-metadata-patch' 的子字段提供一個值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --custom-metadata=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--expiration-date (strfmt.DateTime)

密鑰資料到期的日期。日期格式遵循 'RFC 3339' 格式。支援的密鑰類型：任意、username_password。此選項為 JSON 選項 'secret-metadata-patch' 的子字段提供一個值。它與該選項互斥。

--ttl (字串)

要指派給所產生認證的存活時間 (TTL) 或租賃持續時間。支援的密鑰類型：iam_credentials、service_credentials、custom_credentials。此選項為 JSON 選項 'secret-metadata-patch' 的子字段提供一個值。它與該選項互斥。

最大長度為 10 字元。最小長度為 1 字元。值必須符合正規表示式 /^[0-9]+[s,m,h,d]{0,1}$/。

--rotation (RotationPolicy)

此欄位指出 Secrets Manager 是否自動輪替您的密鑰。支援的密鑰類型：username_password、private_cert、public_cert、iam_credentials、custom_credentials。它應該是 JSON 字串或 JSON 檔案的路徑。此選項為 JSON 選項 'secret-metadata-patch' 的子字段提供一個值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --rotation=@path/to/file.json) 來指定要讀取的 JSON 檔案。

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

指定用來建立 CSR 和私密金鑰的資料。它應該是 JSON 字串或 JSON 檔案的路徑。此選項為 JSON 選項 'secret-metadata-patch' 的子字段提供一個值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --imported-cert-managed-csr=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--password-generation-policy (PasswordGenerationPolicyPatch)

自動產生密碼的原則修補程式。會更新修補程式中包含的原則內容。\n未包含在修補程式中的屬性保持不變。它應該是 JSON 字串或 JSON 檔案的路徑。此選項為 JSON 選項 'secret-metadata-patch' 的子字段提供一個值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --password-generation-policy=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--custom-credentials-parameters (一般對映)

傳給自訂認證引擎的參數。允許的類型有字串、整數和布林值。它應該是 JSON 字串或 JSON 檔案的路徑。此選項為 JSON 選項 'secret-metadata-patch' 的子字段提供一個值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --custom-credentials-parameters=@path/to/file.json) 來指定要讀取的 JSON 檔案。

範例

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`

建立密鑰動作。這項作業支援下列動作:。

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

指令選項

--id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--secret-action-prototype (SecretActionPrototype)

用於指定密鑰動作內容的要求內文。可以改為透過使用其他選項設定個別欄位來提供此 JSON 選項。它與這些選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --secret-action-prototype=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--secret-action-type (字串)

密鑰動作的類型。此選項為 JSON 選項 'secret-action-prototype' 的子欄位提供值。它與該選項互斥。

允許值為：public_cert_action_validate_dns_challenge, private_cert_action_revoke_certificate。

範例

要求範例

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`

指定密鑰的名稱及類型，以取得密鑰及其詳細資料。

成功要求會傳回與密鑰相關聯的密鑰資料，以及其他 meta 資料。若要僅檢視指定秘密的詳細資訊，而不擷取其值，請使用 Get secret metadata 作業。

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

指令選項

--secret-type (字串)

密鑰類型。必要。

允許值為 arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, username_password, custom_credentials。

--name (字串)

指派給密鑰的人類可讀名稱。為了保護您的隱私，請勿使用個人資料 (例如您的姓名或所在地) 作為您的秘密名稱。必要。

最大長度為 256 字元。最小長度為 2 字元。值必須符合正規表示式 /^\\w(([\\w-.]+)?\\w)?$/。

--secret-group-name (字串)

密鑰群組的名稱。必要。

最大長度為 64 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

範例

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

秘密版本

建立及管理密鑰的版本。

`ibmcloud secrets-manager secret-version-create`

建立新的密鑰版本。

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]

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--secret-version-prototype (SecretVersionPrototype)

指定新密鑰版本的內容。可以改為透過使用其他選項設定個別欄位來提供此 JSON 選項。它與這些選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --secret-version-prototype=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--arbitrary-payload (字串)

指派給 arbitrary 秘密的秘密資料。此選項提供 JSON 選項 'secret-version-prototype' 的子欄位值。它與該選項互斥。

最大長度為 1000000 字元。最小長度為 0 字元。值必須符合正規表示式 /(.*?)/。

--secret-version-custom-metadata (一般對映)

使用者可以自訂的密鑰 meta 資料。此選項提供 JSON 選項 'secret-version-prototype' 的子欄位值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --secret-version-custom-metadata=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--secret-version-version-custom-metadata (一般對映)

使用者可以自訂的密鑰版本 meta 資料。此選項提供 JSON 選項 'secret-version-prototype' 的子欄位值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --secret-version-version-custom-metadata=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--secret-version-restore-from-version (字串)

UUID 識別碼，或 current 或 previous 秘密版本別名。此選項提供 JSON 選項 'secret-version-prototype' 的子欄位值。它與該選項互斥。

最大長度為 36 字元。最小長度為 7 字元。值必須符合正規表示式 /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/。

--imported-cert-certificate (字串)

憑證的 PEM 編碼內容。此選項提供 JSON 選項 'secret-version-prototype' 的子欄位值。它與該選項互斥。

最大長度為 100000 字元。最小長度為 50 字元。值必須符合正規表示式 /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/。

--imported-cert-intermediate (字串)

（選用）與主要憑證相關聯的 PEM 編碼中繼憑證。此選項提供 JSON 選項 'secret-version-prototype' 的子欄位值。它與該選項互斥。

最大長度為 100000 字元。最小長度為 50 字元。值必須符合正規表示式 /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/。

--imported-cert-private-key (字串)

（選用）要與憑證相關聯的 PEM 編碼私密金鑰。此選項提供 JSON 選項 'secret-version-prototype' 的子欄位值。它與該選項互斥。

最大長度為 100000 字元。最小長度為 50 字元。值必須符合正規表示式 /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/。

--kv-data (一般對映)

鍵值密鑰的有效負載資料。此選項提供 JSON 選項 'secret-version-prototype' 的子欄位值。它與該選項互斥。

最小長度為 1 項。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --kv-data=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--private-cert-csr (字串)

憑證簽署要求。此選項提供 JSON 選項 'secret-version-prototype' 的子欄位值。它與該選項互斥。

最大長度為 4096 字元。最小長度為 2 字元。值必須符合正規表示式 /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/。

--public-cert-rotation (PublicCertificateRotationObject)

定義用來手動輪換公用憑證的輪替物件。此選項提供 JSON 選項 'secret-version-prototype' 的子欄位值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --public-cert-rotation=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--username-password-password (字串)

指定給 username_password secret 的密碼。如果您省略此參數，則 Secrets Manager 會為您的密鑰產生新的隨機密碼。此選項提供 JSON 選項 'secret-version-prototype' 的子欄位值。它與該選項互斥。

最大長度為 256 字元。最小長度為 6 字元。值必須符合正規表示式 /.{6,256}/。

範例

要求範例

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`

列出密鑰版本。

成功要求會傳回密鑰的版本清單，以及每一個版本的 meta 資料。

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

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

範例

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

輸出範例

密鑰版本 meta 資料收集回應範例

{
  "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
}

預設 JMESPath

預設 JMESPath
回應	輸出	查詢
成功	預設值
	表格	`versions[*]`
錯誤	預設值
	表格	`versions[*]`
所有頁面	預設值
	表格	`versions[*]`

如果提供自訂的 JMESPath 查詢，則會取代上表中的任何 JMESPath。

`ibmcloud secrets-manager secret-version`

透過指定版本的 ID 來取得密鑰的版本。您可以使用 current 或 previous 別名來參照現行或先前的密鑰版本。

成功要求會傳回與密鑰指定版本相關聯的密鑰資料，以及其他 meta 資料。

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

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--id (字串)

密鑰版本的 ID。必要。

最大長度為 36 字元。最小長度為 7 字元。值必須符合正規表示式 /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/。

範例

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`

透過指定版本 ID 刪除秘密版本的資料。

此操作適用於下列秘密類型：

iam_credentials：僅限目前版本

custom_credentials：目前和以前的版本。

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

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--id (字串)

密鑰版本的 ID。必要。

最大長度為 36 字元。最小長度為 7 字元。值必須符合正規表示式 /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/。

範例

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`

透過指定版本的 ID 來取得秘密版本的元資料。您可以使用 current 或 previous 別名來參照現行或先前的密鑰版本。

成功要求會傳回與密鑰指定版本相關聯的 meta 資料。

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

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--id (字串)

密鑰版本的 ID。必要。

最大長度為 36 字元。最小長度為 7 字元。值必須符合正規表示式 /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/。

範例

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`

更新密鑰版本的自訂 meta 資料。

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

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--id (字串)

密鑰版本的 ID。必要。

最大長度為 36 字元。最小長度為 7 字元。值必須符合正規表示式 /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/。

--secret-version-metadata-patch (一般對映)

update_secret_version_metadata 的 JSON 合併-修補內容。可以改為透過使用其他選項設定個別欄位來提供此 JSON 選項。它與這些選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --secret-version-metadata-patch=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--version-custom-metadata (一般對映)

使用者可以自訂的密鑰版本 meta 資料。它應該是 JSON 字串或 JSON 檔案的路徑。此選項為 JSON 選項 'secret-version-metadata-patch' 的子字段提供一個值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --version-custom-metadata=@path/to/file.json) 來指定要讀取的 JSON 檔案。

範例

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`

建立密鑰版本動作。這項作業支援下列動作:

private_cert_action_revoke_certificate: 撤銷專用憑證的版本。

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]

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--id (字串)

密鑰版本的 ID。必要。

最大長度為 36 字元。最小長度為 7 字元。值必須符合正規表示式 /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/。

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

用於指定動作內容以建立密鑰版本的要求內文。可以改為透過使用其他選項設定個別欄位來提供此 JSON 選項。它與這些選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --secret-version-action-prototype=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--secret-version-action-type (字串)

密鑰版本動作的類型。此選項提供 JSON 選項 'secret-version-action-prototype' 的子欄位值。它與該選項互斥。

允許值為：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-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"}'

輸出範例

用於撤銷專用憑證版本之動作的要求內文。

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

秘密任務

監控和更新屬於您秘密的任務。

`ibmcloud secrets-manager secret-tasks`

列出密鑰作業。

支援的秘密類型：custom_credentials。

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

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

範例

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

輸出範例

列出所有任務回應的範例。

{
  "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`

透過指定作業的 ID 取得密鑰作業及其詳細資料。

成功的要求會傳回與您的密鑰相關聯的作業。

支援的秘密類型：custom_credentials。

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

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--id (字串)

唯一識別您作業的 ID。必要。

長度必須為 44 字元。值必須符合正規表示式 /^sm-task-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/。

範例

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

輸出範例

有 Secret's Task 的回應範例。

{
  "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`

用於更新作業結果的回呼端點。

支援的秘密類型：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]

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--id (字串)

唯一識別您作業的 ID。必要。

長度必須為 44 字元。值必須符合正規表示式 /^sm-task-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/。

--task-put (SecretTaskPrototype)

指定密鑰作業更新內容的要求主體。可以改為透過使用其他選項設定個別欄位來提供此 JSON 選項。它與這些選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --task-put=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--task-put-status (字串)

說明密鑰作業的狀態。此選項為 JSON 選項 'task-put' 的子欄位提供一個值。它與該選項互斥。

允許值為：credentials_created.

--task-put-credentials (CustomCredentialsNewCredentials)

由認證提供者提供的新建立認證。此選項為 JSON 選項 'task-put' 的子欄位提供一個值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --task-put-credentials=@path/to/file.json) 來指定要讀取的 JSON 檔案。

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

錯誤的集合。此選項為 JSON 選項 'task-put' 的子欄位提供一個值。它與該選項互斥。

最大長度為 10 項。最小長度為 1 項。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --task-put-errors=@path/to/file.json) 來指定要讀取的 JSON 檔案。

範例

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"}}}'

或者，JSON 字串選項的子欄位也可以使用精細選項:

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

輸出範例

有 Secret's Task 的回應範例。

{
  "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`

透過指定密鑰的 ID 刪除作業。

支援的秘密類型：custom_credentials。

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

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--id (字串)

唯一識別您作業的 ID。必要。

長度必須為 44 字元。值必須符合正規表示式 /^sm-task-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/。

範例

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

秘密鎖

透過將鎖定連接至密鑰版本並防止任何修改或刪除，來保護密鑰資料的安全。

`ibmcloud secrets-manager secrets-locks`

列出 Secrets Manager 實例中的密鑰及其鎖定。附註: 如果未設定 --all-pages 選項，則指令只會擷取集合的單一頁面。

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

指令選項

--offset (int64)

要跳過的密鑰數目。

預設值為 0。最大值為 10000000。最小值為 0。

--limit (int64)

要列出的密鑰數目。

預設值為 200。最大值為 1000。最小值為 1。

--search (字串)

過濾欄位「名稱」中包含指定字串的鎖定。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--groups ([]字串)

依群組過濾密鑰。提供要作為過濾依據的群組 ID。

清單項目必須符合正規表示式 /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/。最大長度為 201 項。最小長度為 0 項。

--all-pages (bool)

呼叫多個要求，以顯示 secrets-locks 集合的所有頁面。

範例

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

輸出範例

列出所有「密鑰」及鎖定的範例回應

{
  "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
}

預設 JMESPath

預設 JMESPath
回應	輸出	查詢
成功	預設值
	表格	`secrets_locks[*]`
錯誤	預設值
	表格	`secrets_locks[*]`
所有頁面	預設值
	表格	`secrets_locks[*]`

如果提供自訂的 JMESPath 查詢，則會取代上表中的任何 JMESPath。

`ibmcloud secrets-manager secret-locks`

列出與指定機密相關的鎖。附註: 如果未設定 --all-pages 選項，則指令只會擷取集合的單一頁面。

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

指令選項

--id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--offset (int64)

要跳過的鎖定數。

預設值為 0。最大值為 1000。最小值為 0。

--limit (int64)

要列出含鎖定的密鑰數目。

預設值為 25。最大值為 100。最小值為 1。

--sort (字串)

依指定欄位以遞增順序排序鎖定集合。若要以降序排序，請使用 - 字元。

最大長度為 17 字元。最小長度為 4 字元。值必須符合正規表示式 /^-?(created_at|updated_at|name)$/。

--search (字串)

過濾欄位「名稱」中包含指定字串的鎖定。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--all-pages (bool)

呼叫多個要求，以顯示 secret-locks 集合的所有頁面。

範例

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

輸出範例

列出密鑰鎖定的回應主體範例

{
  "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`

在秘密的目前版本上建立鎖定。

鎖定可用來防止在應用程式使用密鑰時刪除或修改密鑰。成功的要求會將新鎖定連接至您的密鑰，或取代同名的鎖定 (如果已存在的話)。此外，您可以使用此作業，透過使用下列其中一個選用鎖定模式來清除密鑰上的任何相符鎖定:

remove_previous:如果在秘密的前一個版本中發現其他具有匹配名稱的鎖，則移除它們。\n
remove_previous_and_delete: 選取與 remove_previous 相同的功能，但也會永久地刪除前一個密鑰版本的資料 (如果它沒有任何鎖定的話)。

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

指令選項

--id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--locks (SecretLockPrototype[])

要附加至密鑰版本的鎖定資料。必要。

最大長度為 1000 項。最小長度為 0 項。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --locks=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--mode (字串)

設定鎖定模式。允許值：remove_previous，和 remove_previous_and_delete。使用 remove_previous 建立一個鎖會清除名稱相符的現有鎖。使用 remove_previous_and_delete 也可以刪除先前版本的資料。

允許值為：remove_previous, remove_previous_and_delete。

範例

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

輸出範例

建立秘密鎖定的回應主體範例

{
  "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`

刪除與某個密鑰版本相關聯的所有鎖定或鎖定子集。

若只要刪除鎖定的子集，請以逗點來新增查詢參數，以區隔鎖定名稱清單:

範例: ?name=lock-example-1,lock-example-2。

附註: 只有在您移除密鑰的所有鎖定之後，才會將密鑰視為已解除鎖定且能夠刪除。若要判定密鑰是否包含鎖定，請檢查作為密鑰 meta 資料一部分傳回的 locks_total 欄位。

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

指令選項

--id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--name ([]字串)

指定要刪除的密鑰鎖定名稱。

清單項目必須符合正規表示式 /^[a-zA-Z]{1}[a-zA-Z0-9-_.]{1,63}$/。最大長度為 1000 項。最小長度為 1 項。

範例

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

輸出範例

建立秘密鎖定的回應主體範例

{
  "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`

列出與指定密鑰版本相關聯的鎖定。附註: 如果未設定 --all-pages 選項，則指令只會擷取集合的單一頁面。

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

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--id (字串)

密鑰版本的 ID。必要。

最大長度為 36 字元。最小長度為 7 字元。值必須符合正規表示式 /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/。

--offset (int64)

要跳過的鎖定數。

預設值為 0。最大值為 1000。最小值為 0。

--limit (int64)

要列出含鎖定的密鑰數目。

預設值為 25。最大值為 100。最小值為 1。

--sort (字串)

依指定欄位以遞增順序排序鎖定集合。若要以降序排序，請使用 - 字元。

最大長度為 17 字元。最小長度為 4 字元。值必須符合正規表示式 /^-?(created_at|updated_at|name)$/。

--search (字串)

過濾欄位「名稱」中包含指定字串的鎖定。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--all-pages (bool)

呼叫多個要求，以顯示 secret-version-locks 集合的所有頁面。

範例

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

輸出範例

列出密鑰版本鎖定的範例回應

{
  "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`

在秘密的指定版本上建立鎖定。

remove_previous:如果在秘密的前一個版本中發現其他具有匹配名稱的鎖，則移除它們。
remove_previous_and_delete: 選取與 remove_previous 相同的功能，但也會永久地刪除前一個密鑰版本的資料 (如果它沒有任何鎖定的話)。

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

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--id (字串)

密鑰版本的 ID。必要。

最大長度為 36 字元。最小長度為 7 字元。值必須符合正規表示式 /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/。

--locks (SecretLockPrototype[])

要附加至密鑰版本的鎖定資料。必要。

最大長度為 1000 項。最小長度為 0 項。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --locks=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--mode (字串)

允許值為：remove_previous, remove_previous_and_delete。

範例

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

輸出範例

建立秘密鎖定的回應主體範例

{
  "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`

刪除與密鑰指定版本相關聯的所有鎖定或鎖定子集。

若只要刪除鎖定的子集，請以逗點來新增查詢參數，以區隔鎖定名稱清單:

範例: ?name=lock-example-1,lock-example-2。

附註: 密鑰會被視為已解除鎖定，且只有在移除其所有鎖定之後才能刪除。若要判定密鑰是否包含鎖定，請檢查作為密鑰 meta 資料一部分傳回的 locks_total 欄位。

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

指令選項

--secret-id (字串)

密鑰的 ID。必要。

長度必須為 36 字元。值必須符合正規表示式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/。

--id (字串)

密鑰版本的 ID。必要。

最大長度為 36 字元。最小長度為 7 字元。值必須符合正規表示式 /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/。

--name ([]字串)

指定要刪除的密鑰鎖定名稱。

清單項目必須符合正規表示式 /^[a-zA-Z]{1}[a-zA-Z0-9-_.]{1,63}$/。最大長度為 1000 項。最小長度為 1 項。

範例

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

輸出範例

建立秘密鎖定的回應主體範例

{
  "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 configuration-create`

新增設定到指定的秘訣類型。

使用此操作定義建立公用憑證 (public_cert)、私人憑證 (private_cert)、IAM 憑證機密 (iam_credentials) 和自訂憑證機密 (custom_credentials) 所需的設定。

您可以為實例新增多項配置，如下所示:

IAM 認證的單一設定。
公用憑證最多 10 個 CA 配置。
公用憑證最多 10 個 DNS 配置。
專用憑證最多 10 個主要 CA 配置。
專用憑證最多 10 個中繼 CA 配置。
最多 10 個專用憑證的「憑證範本」配置。

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]

指令選項

--configuration-prototype (ConfigurationPrototype)

包含建立配置所需詳細資料的 JSON。可以改為透過使用其他選項設定個別欄位來提供此 JSON 選項。它與這些選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --configuration-prototype=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--config-type (字串)

配置類型。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

允許值為 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 (字串)

指派給您的配置的人類可讀唯一名稱。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/。

--public-cert-cloud-internet-services-apikey (字串)

IBM Cloud API 金鑰，可列出 Cloud Internet Services 實例中的網域並新增 DNS 記錄。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 128 字元。最小長度為 0 字元。值必須符合正規表示式 /(.*?)/。

--public-cert-cloud-internet-services-crn (字串)

唯一識別 IBM Cloud 資源的 CRN。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 512 字元。最小長度為 9 字元。值必須符合正規表示式 /^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/。

--public-cert-classic-infrastructure-username (字串)

與標準基礎架構帳戶相關聯的使用者名稱。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--public-cert-classic-infrastructure-password (字串)

標準基礎架構 API 金鑰。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--public-cert-lets-encrypt-environment (字串)

Let 's Encrypt CA 環境的配置。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

允許值為：production, staging。

--public-cert-lets-encrypt-private-key (字串)

您的 Let 's Encrypt 帳戶的 PEM 編碼私密金鑰。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 100000 字元。最小長度為 50 字元。值必須符合正規表示式 /(^-----BEGIN PRIVATE KEY-----.*?)|(^-----BEGIN RSA PRIVATE KEY-----.*?)/。

--public-cert-lets-encrypt-preferred-chain (字串)

具有符合此「主旨通用名稱」之發證者的偏好鏈。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 30 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

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

使用 JSON 格式的加密金鑰相關資料。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --private-cert-crypto-key=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--private-cert-max-ttl (字串)

此 CA 所建立憑證的存活時間 (TTL) 上限。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 10 字元。最小長度為 2 字元。值必須符合正規表示式 /^[0-9]+[s,m,h,d]{0,1}$/。

--private-cert-crl-expiry (字串)

憑證撤銷清單 (CRL) 到期之前的時間。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 10 字元。最小長度為 2 字元。值必須符合正規表示式 /^[0-9]+[s,m,h,d]{0,1}$/。

--private-cert-crl-disabled (bool)

這個欄位會停用或啟用憑證撤銷清單 (CRL) 建置。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-crl-distribution-points-encoded (bool)

這個欄位決定是否要將憑證撤銷清冊 (CRL) 配送點編碼在這個憑證管理中心所發出的憑證中。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-issuing-certificate-urls-encoded (bool)

此欄位決定是否將發出憑證的 URL 編碼在此憑證管理中心發出的憑證中。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--certificate-common-name (字串)

「通用名稱 (CN)」代表受 SSL 憑證保護的伺服器名稱。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 128 字元。最小長度為 4 字元。值必須符合正規表示式 /(.*?)/。

--certificate-alt-names ([]字串)

透過「主體替代名稱」欄位，您可以指定要由單一 SSL 憑證保護的其他主機名稱。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /^(.*?)$/。最大長度為 99 項。最小長度為 0 項。

--private-cert-ip-sans (字串)

要為 CA 憑證定義的「IP 主體替代名稱」（以逗點區隔清單）。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 2048 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--private-cert-uri-sans (字串)

要為 CA 憑證定義的「URI 主體替代名稱」，以逗點區隔清單。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 2048 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--private-cert-other-sans ([]字串)

要為 CA 憑證定義的自訂物件 ID (OID) 或 UTF8-string 主體替代名稱。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-ttl (字串)

針對此 CA 建立的憑證所要求的存活時間 (TTL)。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 10 字元。最小長度為 2 字元。值必須符合正規表示式 /^[0-9]+[s,m,h,d]{0,1}$/。

--private-cert-format (字串)

所傳回資料的格式。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

允許值為：pem, pem_bundle。

--private-cert-private-key-format (字串)

所產生私密金鑰的格式。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

預設值為 der。允許值為：der, pkcs8。

--private-cert-private-key-type (字串)

要產生的私密金鑰類型。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

允許值為：rsa, ec。

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

用來產生私密金鑰的位元數。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大值為 4096。最小值為 224。

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

在產生的憑證中編碼的最大路徑長度。-1 表示沒有限制。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大值為 10。最小值為 -1。

--private-cert-exclude-cn-from-sans (bool)

此參數控制是否從「主體替代名稱 (SAN)」中排除一般名稱。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-permitted-dns-domains ([]字串)

要由此 CA 憑證簽署及發出之憑證的容許 DNS 網域或子網域。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-subject-organizational-unit ([]字串)

要在所產生憑證的主旨欄位中定義的組織單位 (OU) 值。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-organization ([]字串)

要在所產生憑證的主旨欄位中定義的組織 (O) 值。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-country ([]字串)

要在所產生憑證的主旨欄位中定義的「國家/地區 (C)」值。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-locality ([]字串)

要在所產生憑證的主旨欄位中定義的「區域 (L)」值。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-province ([]字串)

要在所產生憑證的主旨欄位中定義的「省 (ST)」值。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-street-address ([]字串)

要在所產生憑證的主旨欄位中定義的街道地址值。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-postal-code ([]字串)

要在所產生憑證的主旨欄位中定義的郵遞區號值。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-serial-number (字串)

serialNumber ( https://datatracker.ietf.org/doc/html/rfc4519#section-2.31 ) 屬性的請求值，該屬性在憑證的識別名 (DN) 中。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

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 (字串)

與此憑證管理中心搭配使用以產生專用憑證的簽署方法。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

允許值為：internal, external。

--private-cert-issuer (字串)

識別簽署並發出憑證之實體的識別名稱。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--private-cert-ca-name (字串)

中繼憑證管理中心的名稱。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/。

--private-cert-allowed-secret-groups (字串)

此欄位只會將建立專用憑證的範圍設定為您指定的密鑰群組。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 1024 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--private-cert-allow-localhost (bool)

此欄位表示是否允許 localhost 包含為要求的常用名之一。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-allowed-domains ([]字串)

要為憑證範本定義的網域。此屬性與 allow_bare_domains 及 allow_subdomains 選項一起使用。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-allowed-domains-template (bool)

此欄位表示是否允許 allowed_domains 欄位中提供的網域包含存取控制清單 (ACL) 模版。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-allow-bare-domains (bool)

此欄位指出是否容許用戶端要求與最終憑證上實際網域值相符的專用憑證。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-allow-subdomains (bool)

此欄位指出是否容許用戶端要求具有通用名稱 (CN) 的專用憑證，這些通用名稱 (CN) 是其他憑證範本選項所容許的 CN 子網域。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-allow-glob-domains (bool)

此欄位表示是否允許在 allowed_domains 欄位指定的名稱中使用 glob 模式。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-allow-wildcard (bool)

此欄位指出是否發出在 CN 欄位中具有 RFC 6125 萬用字元的憑證。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-allow-any-name (bool)

此欄位指出是否容許用戶端要求符合任何通用名稱的專用憑證。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-enforce-hostname (bool)

此欄位指出是否只對通用名稱、DNS 主體替代名稱及電子郵件位址的主機區段施行有效的主機名稱。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-allow-ip-sans (bool)

此欄位指出是否容許用戶端要求具有「IP 主體替代名稱」的專用憑證。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-allowed-uri-sans ([]字串)

容許專用憑證的 URI 主體替代名稱。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-allowed-other-sans ([]字串)

自訂物件 ID (OID) 或 UTF8-string 主體替代名稱 (SAN)，以容許專用憑證。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-server-flag (bool)

此欄位指出是否標示專用憑證以供伺服器使用。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-client-flag (bool)

此欄位指出是否標示專用憑證以供用戶端使用。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-code-signing-flag (bool)

此欄位指出是否標示專用憑證以供程式碼簽署使用。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-email-protection-flag (bool)

此欄位指出是否標示專用憑證以供電子郵件保護使用。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-key-usage ([]字串)

針對專用憑證定義的容許金鑰用法限制。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /^[a-zA-Z]+$/。最大長度為 100 項。最小長度為 0 項。

--private-cert-ext-key-usage ([]字串)

專用憑證上容許的延伸金鑰用法限制。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /^[a-zA-Z]+$/。最大長度為 100 項。最小長度為 0 項。

--private-cert-ext-key-usage-oids ([]字串)

延伸金鑰用法「物件 ID (OID)」的清單。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-use-csr-common-name (bool)

此欄位決定是否使用來自憑證簽署要求 (CSR) 的通用名稱 (CN)。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-use-cse-sans (bool)

此欄位決定是否使用憑證簽署要求 (CSR) 中的「主體替代名稱 (SAN)」。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-require-cn (bool)

此欄位指出是否需要通用名稱來建立專用憑證。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-policy-identifiers ([]字串)

原則物件 ID (OID) 的清單。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-basic-constraints-valid-for-non-ca (bool)

此欄位指出是否將已發出專用憑證的「基本限制」延伸標示為對非 CA 憑證有效。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

--private-cert-not-before-duration (字串)

追溯已簽發私人憑證的 not_before 屬性的時間，以秒為單位。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 10 字元。最小長度為 2 字元。值必須符合正規表示式 /^[0-9]+[s,m,h,d]{0,1}$/。

--iam-credentials-apikey (字串)

用來設定 iam_credentials 引擎的 API 金鑰。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 60 字元。最小長度為 5 字元。值必須符合正規表示式 /^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/。

--iam-credentials-apikey-disabled (bool)

此參數指出是否停用 API 金鑰配置。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

預設值為 false。

--custom-credentials-apikey-ref (字串)

用於設定自訂認證引擎配置的 IAM 認證密鑰 ID。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

長度必須為 36 字元。值必須符合正規表示式 /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/。

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

配置 Code Engine 所需的參數。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --custom-credentials-code-engine=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--configuration-task-timeout (字串)

指定完成 Code Engine 作業的最大容許時間。這段時間過後，作業狀態會變更為失敗。最小值為 5 分鐘，最大值為 24 小時。預設作業逾時為 10 分鐘。值可以是指定秒數的整數，也可以是持續時間的字串表示，例如 10m 或 2h。此選項提供 JSON 選項 'configuration-prototype' 的子欄位值。它與該選項互斥。

最大長度為 6 字元。最小長度為 1 字元。值必須符合正規表示式 /^[0-9]+[s,m,h,d]{0,1}$/。

範例

要求範例

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`

列出 Secrets Manager 實例中可用的配置。附註: 如果未設定 --all-pages 選項，則指令只會擷取集合的單一頁面。

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

指令選項

--offset (int64)

要跳過的配置數目。

預設值為 0。最大值為 1000。最小值為 0。

--limit (int64)

要列出的配置數目。

預設值為 200。最大值為 1000。最小值為 1。

--sort (字串)

依指定欄位以遞增順序排序配置集合。若要以降序排序，請使用 - 字元。

最大長度為 17 字元。最小長度為 2 字元。值必須符合正規表示式 /^-?(config_type|secret_type|name)$/。

--search (字串)

過濾在下列一或多個欄位中包含指定字串的配置： "name"、"config_type"、"secret_type"。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--secret-types ([]字串)

依密鑰類型過濾配置。提供下列一個或多個密鑰類型：iam_credentials、public_cert、private_cert 或 custom_credentials。

允許的清單項目有 iam_credentials, private_cert, public_cert, custom_credentials。最大長度為 4 項。最小長度為 0 項。

--all-pages (bool)

呼叫多個要求，以顯示配置集合的所有頁面。

範例

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

輸出範例

配置 meta 資料收集的回應範例

{
  "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
}

預設 JMESPath

預設 JMESPath
回應	輸出	查詢
成功	預設值
	表格	`configurations[*].{Created_At:created_at,Name:name,Config_Type:config_type,Secret_Type:secret_type,Created_By:created_by,Updated_At:updated_at}`
錯誤	預設值
	表格	`configurations[*].{Created_At:created_at,Name:name,Config_Type:config_type,Secret_Type:secret_type,Created_By:created_by,Updated_At:updated_at}`
所有頁面	預設值
	表格	`configurations[*].{Created_At:created_at,Name:name,Config_Type:config_type,Secret_Type:secret_type,Created_By:created_by,Updated_At:updated_at}`

如果提供自訂的 JMESPath 查詢，則會取代上表中的任何 JMESPath。

`ibmcloud secrets-manager configuration`

透過指定配置名稱來取得配置。

成功要求會傳回配置的詳細資料。

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

指令選項

--name (字串)

配置的名稱。必要。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--config-type (字串)

此配置的配置類型 - 使用此標頭來解決 300 個錯誤回應。

範例

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

`ibmcloud secrets-manager configuration-update`

更新配置。

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]

指令選項

--name (字串)

配置的名稱。必要。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--configuration-patch (一般對映)

update_configuration 的 JSON 合併-修補內容。可以改為透過使用其他選項設定個別欄位來提供此 JSON 選項。它與這些選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --configuration-patch=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--config-type (字串)

此配置的配置類型 - 使用此標頭來解決 300 個錯誤回應。

--api-key (字串)

可建立及管理服務 ID 的 IBM Cloud API 金鑰。必須為 API 金鑰指派「存取群組服務」上的「編輯者」平台角色，以及 IAM Identity Service 上的「操作員」平台角色。如需相關資訊，請參閱文件。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 60 字元。最小長度為 5 字元。值必須符合正規表示式 /^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/。

--iam-credentials-apikey-disabled (bool)

此參數指出是否停用 API 金鑰配置。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-max-ttl (字串)

此 CA 所建立憑證的存活時間 (TTL) 上限。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 10 字元。最小長度為 2 字元。值必須符合正規表示式 /^[0-9]+[s,m,h,d]{0,1}$/。

--private-cert-crl-expiry (字串)

憑證撤銷清單 (CRL) 到期之前的時間。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 10 字元。最小長度為 2 字元。值必須符合正規表示式 /^[0-9]+[s,m,h,d]{0,1}$/。

--private-cert-crl-disabled (bool)

這個欄位會停用或啟用憑證撤銷清單 (CRL) 建置。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-crl-distribution-points-encoded (bool)

這個欄位決定是否要將憑證撤銷清冊 (CRL) 配送點編碼在這個憑證管理中心所發出的憑證中。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-issuing-certificate-urls-encoded (bool)

此欄位決定是否將發出憑證的 URL 編碼在此憑證管理中心發出的憑證中。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-allowed-secret-groups (字串)

此欄位只會將建立專用憑證的範圍設定為您指定的密鑰群組。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 1024 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--private-cert-ttl (字串)

針對此 CA 建立的憑證所要求的存活時間 (TTL)。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 10 字元。最小長度為 2 字元。值必須符合正規表示式 /^[0-9]+[s,m,h,d]{0,1}$/。

--private-cert-allow-localhost (bool)

此欄位指出是否容許將 'localhost' 併入為其中一個所要求的通用名稱。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-allowed-domains ([]字串)

要為憑證範本定義的網域。此內容與 'allow_bare_domains' 及 'allow_subdomains' 選項一起使用。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-allowed-domains-template (bool)

此欄位指出是否容許 'allowed_domains' 欄位中提供的網域包含存取控制清單 (ACL) 範本。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-allow-bare-domains (bool)

此欄位指出是否容許用戶端要求與最終憑證上實際網域值相符的專用憑證。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-allow-subdomains (bool)

此欄位指出是否容許用戶端要求具有通用名稱 (CN) 的專用憑證，這些通用名稱 (CN) 是其他憑證範本選項所容許的 CN 子網域。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-allow-glob-domains (bool)

此欄位指出是否容許在 'allowed_domains' 欄位中指定的名稱中使用 glob 型樣。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-allow-any-name (bool)

此欄位指出是否容許用戶端要求符合任何通用名稱的專用憑證。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-enforce-hostname (bool)

此欄位指出是否只對通用名稱、DNS 主體替代名稱及電子郵件位址的主機區段施行有效的主機名稱。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-allow-ip-sans (bool)

此欄位指出是否容許用戶端要求具有「IP 主體替代名稱」的專用憑證。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-allowed-uri-sans ([]字串)

容許專用憑證的 URI 主體替代名稱。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-allowed-other-sans ([]字串)

自訂物件 ID (OID) 或 UTF8-string 主體替代名稱 (SAN)，以容許專用憑證。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-server-flag (bool)

此欄位指出是否標示專用憑證以供伺服器使用。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-client-flag (bool)

此欄位指出是否標示專用憑證以供用戶端使用。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-code-signing-flag (bool)

此欄位指出是否標示專用憑證以供程式碼簽署使用。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-email-protection-flag (bool)

此欄位指出是否標示專用憑證以供電子郵件保護使用。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-private-key-type (字串)

要產生的私密金鑰類型。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

允許值為：rsa, ec。

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

用來產生私密金鑰的位元數。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大值為 4096。最小值為 224。

--private-cert-key-usage ([]字串)

針對專用憑證定義的容許金鑰用法限制。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /^[a-zA-Z]+$/。最大長度為 100 項。最小長度為 0 項。

--private-cert-ext-key-usage ([]字串)

專用憑證上容許的延伸金鑰用法限制。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /^[a-zA-Z]+$/。最大長度為 100 項。最小長度為 0 項。

--private-cert-ext-key-usage-oids ([]字串)

延伸金鑰用法「物件 ID (OID)」的清單。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-use-csr-common-name (bool)

此欄位決定是否使用來自憑證簽署要求 (CSR) 的通用名稱 (CN)。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-use-cse-sans (bool)

此欄位決定是否使用憑證簽署要求 (CSR) 中的「主體替代名稱 (SAN)」。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-subject-organizational-unit ([]字串)

要在所產生憑證的主旨欄位中定義的組織單位 (OU) 值。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-organization ([]字串)

要在所產生憑證的主旨欄位中定義的組織 (O) 值。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-country ([]字串)

要在所產生憑證的主旨欄位中定義的「國家/地區 (C)」值。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-locality ([]字串)

要在所產生憑證的主旨欄位中定義的「區域 (L)」值。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-province ([]字串)

要在所產生憑證的主旨欄位中定義的「省 (ST)」值。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-street-address ([]字串)

要在所產生憑證的主旨欄位中定義的街道地址值。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-postal-code ([]字串)

要在所產生憑證的主旨欄位中定義的郵遞區號值。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-requested-serial-number (字串)

此欄位已淘汰。您可以忽略其值。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 64 字元。最小長度為 32 字元。值必須符合正規表示式 /[^a-fA-F0-9]/。

--private-cert-require-cn (bool)

此欄位指出是否需要通用名稱來建立專用憑證。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-policy-identifiers ([]字串)

原則物件 ID (OID) 的清單。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-basic-constraints-valid-for-non-ca (bool)

此欄位指出是否將已發出專用憑證的「基本限制」延伸標示為對非 CA 憑證有效。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

--private-cert-not-before-duration (字串)

所發出專用憑證的 'not_before' 內容回溯的持續時間（以秒為單位）。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 10 字元。最小長度為 2 字元。值必須符合正規表示式 /^[0-9]+[s,m,h,d]{0,1}$/。

--public-cert-lets-encrypt-environment (字串)

Let 's Encrypt CA 環境的配置。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

允許值為：production, staging。

--public-cert-lets-encrypt-private-key (字串)

您的 Let 's Encrypt 帳戶的 PEM 編碼私密金鑰。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 100000 字元。最小長度為 50 字元。值必須符合正規表示式 /(^-----BEGIN PRIVATE KEY-----.*?)|(^-----BEGIN RSA PRIVATE KEY-----.*?)/。

--public-cert-lets-encrypt-preferred-chain (字串)

具有符合此「主旨通用名稱」之發證者的偏好鏈。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 30 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--public-cert-cloud-internet-services-apikey (字串)

IBM Cloud API 金鑰，可列出 Cloud Internet Services 實例中的網域並新增 DNS 記錄。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 128 字元。最小長度為 0 字元。值必須符合正規表示式 /(.*?)/。

--cloud-internet-services-crn (字串)

唯一識別 IBM Cloud 資源的 CRN。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 512 字元。最小長度為 9 字元。值必須符合正規表示式 /^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/。

--public-cert-classic-infrastructure-username (字串)

與標準基礎架構帳戶相關聯的使用者名稱。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--public-cert-classic-infrastructure-password (字串)

標準基礎架構 API 金鑰。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--configuration-task-timeout (字串)

指定完成 Code Engine 作業的最大容許時間。這段時間過後，作業狀態會變更為失敗。最小值為 5 分鐘，最大值為 24 小時。預設作業逾時為 10 分鐘。值可以是指定秒數的整數，也可以是時間長度的字串表示，例如 '10m' 或 '2h'。此選項為 JSON 選項「configuration-patch」的子欄位提供一個值。它與該選項互斥。

最大長度為 6 字元。最小長度為 1 字元。值必須符合正規表示式 /^[0-9]+[s,m,h,d]{0,1}$/。

範例

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`

指定配置名稱來刪除配置。

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

指令選項

--name (字串)

配置的名稱。必要。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--config-type (字串)

此配置的配置類型 - 使用此標頭來解決 300 個錯誤回應。

範例

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

`ibmcloud secrets-manager configuration-action-create`

建立配置動作。這項作業支援下列動作:

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_crl: 輪替中繼憑證管理中心的憑證撤銷清冊 (CRL)。
private_cert_configuration_action_rotate_intermediate：輪換內部簽署的中間憑證授權單位證書。

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]

指令選項

--name (字串)

配置的名稱。必要。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--config-action-prototype (ConfigurationActionPrototype)

用於指定動作內容以建立配置的要求內文。可以改為透過使用其他選項設定個別欄位來提供此 JSON 選項。它與這些選項互斥。

提供 JSON 字串選項，或提供以 @ 開頭的檔案路徑選項 (例如 --config-action-prototype=@path/to/file.json) 來指定要讀取的 JSON 檔案。

--config-type (字串)

此配置的配置類型 - 使用此標頭來解決 300 個錯誤回應。

--config-action-action-type (字串)

配置動作的類型。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

允許值為 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 (字串)

「通用名稱 (CN)」代表受 SSL 憑證保護的伺服器名稱。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 128 字元。最小長度為 4 字元。值必須符合正規表示式 /(.*?)/。

--certificate-alt-names ([]字串)

透過「主體替代名稱」欄位，您可以指定要由單一 SSL 憑證保護的其他主機名稱。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /^(.*?)$/。最大長度為 99 項。最小長度為 0 項。

--private-cert-ip-sans (字串)

要為 CA 憑證定義的「IP 主體替代名稱」（以逗點區隔清單）。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 2048 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--private-cert-uri-sans (字串)

要為 CA 憑證定義的「URI 主體替代名稱」，以逗點區隔清單。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 2048 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--private-cert-other-sans ([]字串)

要為 CA 憑證定義的自訂物件 ID (OID) 或 UTF8-string 主體替代名稱。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--private-cert-ttl (字串)

要指派給專用憑證的存活時間 (TTL)。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 10 字元。最小長度為 2 字元。值必須符合正規表示式 /^[0-9]+[s,m,h,d]{0,1}$/。

--private-cert-format (字串)

所傳回資料的格式。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

允許值為：pem, pem_bundle。

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

在產生的憑證中編碼的最大路徑長度。-1 表示沒有限制。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

最大值為 10。最小值為 -1。

--private-cert-exclude-cn-from-sans (bool)

此參數控制是否從「主體替代名稱 (SAN)」中排除一般名稱。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

--private-cert-permitted-dns-domains ([]字串)

要由此 CA 憑證簽署及發出之憑證的容許 DNS 網域或子網域。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 100 項。最小長度為 0 項。

--config-action-use-csr-values (bool)

此欄位表示是否使用憑證簽章請求 (CSR) 的值來完成 private_cert_configuration_action_sign_csr 動作。如果設為 true，則:

主體資訊 (包括名稱和替代名稱) 會從 CSR 保留，而不是使用此作業的其他參數中提供的值。
CSR 中所要求的任何金鑰用法 (例如不可否認性) 都會新增至中間憑證管理中心所簽署的 CA 憑證所用的基本金鑰用法集。
CSR 中所要求的延伸會複製到已發出的專用憑證。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

--private-cert-subject-organizational-unit ([]字串)

要在所產生憑證的主旨欄位中定義的組織單位 (OU) 值。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-organization ([]字串)

要在所產生憑證的主旨欄位中定義的組織 (O) 值。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-country ([]字串)

要在所產生憑證的主旨欄位中定義的「國家/地區 (C)」值。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-locality ([]字串)

要在所產生憑證的主旨欄位中定義的「區域 (L)」值。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-province ([]字串)

要在所產生憑證的主旨欄位中定義的「省 (ST)」值。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-street-address ([]字串)

要在所產生憑證的主旨欄位中定義的街道地址值。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-subject-postal-code ([]字串)

要在所產生憑證的主旨欄位中定義的郵遞區號值。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

清單項目必須符合正規表示式 /(.*?)/。最大長度為 10 項。最小長度為 0 項。

--private-cert-serial-number (字串)

serialNumber ( https://datatracker.ietf.org/doc/html/rfc4519#section-2.31 ) 屬性的請求值，該屬性在憑證的識別名 (DN) 中。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

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 (字串)

憑證簽署要求。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 4096 字元。最小長度為 2 字元。值必須符合正規表示式 /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/。

--config-action-intermediate-certificate-authority (字串)

中繼憑證管理中心配置的名稱。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 128 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--imported-cert-certificate (字串)

憑證的 PEM 編碼內容。此選項為 JSON 選項 'config-action-prototype' 的子欄位提供值。它與該選項互斥。

最大長度為 100000 字元。最小長度為 50 字元。值必須符合正規表示式 /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/。

範例

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

或者，JSON 字串選項的子欄位也可以使用精細選項:

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

通知

透過連線至 Event Notifications，為您的實例啟用生命週期通知。

`ibmcloud secrets-manager notifications-registration-create`

在 Secrets Manager 實例與 Event Notifications 之間建立登錄。

成功要求會將 Secrets Manager 新增為您可以從 Event Notifications 實例參照的來源。如需更多有關 Secrets Manager 啟用通知的資訊，請查看說明文件。

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]

指令選項

--event-notifications-instance-crn (字串)

唯一識別 IBM Cloud 資源的 CRN。必要。

最大長度為 512 字元。最小長度為 9 字元。值必須符合正規表示式 /^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/。

--event-notifications-source-name (字串)

在 Event Notifications 實例中顯示為來源的名稱。必要。

最大長度為 256 字元。最小長度為 2 字元。值必須符合正規表示式 /(.*?)/。

--event-notifications-source-description (字串)

Event Notifications 實例中來源的選用說明。

最大長度為 1024 字元。最小長度為 0 字元。值必須符合正規表示式 /(.*?)/。

範例

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.'

輸出範例

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`

取得 Secrets Manager 實例與 Event Notifications 之間登錄的詳細資料。

ibmcloud secrets-manager notifications-registration

範例

ibmcloud secrets-manager notifications-registration

輸出範例

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`

刪除 Secrets Manager 實例與 Event Notifications之間的登錄。

成功要求會在 Event Notifications中移除作為來源的 Secrets Manager 實例。

ibmcloud secrets-manager notifications-registration-delete

範例

ibmcloud secrets-manager notifications-registration-delete

`ibmcloud secrets-manager notifications-registration-test`

將測試事件從 Secrets Manager 實例傳送至已配置的 Event Notifications 實例。

成功要求會將測試事件傳送至 Event Notifications 實例。如需更多有關 Secrets Manager 啟用通知的資訊，請查看說明文件。

ibmcloud secrets-manager notifications-registration-test

範例

ibmcloud secrets-manager notifications-registration-test

綱目範例

下列綱目範例代表您需要為指令選項指定的資料。這些範例會建立資料結構模型，並包含期望值類型的位置保留元值。當您執行指令時，請視情況將這些值取代為適用於您環境的值。

ConfigurationActionPrototype

以下範例顯示 ConfigurationActionPrototype 物件的格式。


{
  "action_type" : "private_cert_configuration_action_rotate_crl"
}

ConfigurationPrototype

以下範例顯示 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

以下範例顯示 CustomCredentialsConfigurationCodeEngine 物件的格式。


{
  "job_name" : "sm-custom-cred-job",
  "project_id" : "15314cc3-85b4-4338-903f-c28cdee6d005",
  "region" : "us-south"
}

CustomCredentialsNewCredentials

以下範例顯示 CustomCredentialsNewCredentials 物件的格式。


{
  "id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
  "payload" : {
    "anyKey" : "anyValue"
  }
}

ImportedCertificateManagedCsr

以下範例顯示 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

以下範例顯示 PasswordGenerationPolicy 物件的格式。


{
  "length" : 32,
  "include_digits" : true,
  "include_symbols" : true,
  "include_uppercase" : true
}

PasswordGenerationPolicyPatch

以下範例顯示 PasswordGenerationPolicyPatch 物件的格式。


{
  "length" : 12,
  "include_digits" : true,
  "include_symbols" : true,
  "include_uppercase" : true
}

PrivateCertificateCryptoKey

以下範例顯示 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

以下範例顯示 PublicCertificateRotationObject 物件的格式。


{
  "rotate_keys" : true
}

RotationPolicy

以下範例顯示 RotationPolicy 物件的格式。


{
  "auto_rotate" : true,
  "interval" : 1,
  "unit" : "day"
}

SecretActionPrototype

以下範例顯示 SecretActionPrototype 物件的格式。


{
  "action_type" : "private_cert_action_revoke_certificate"
}

SecretLockPrototype[]

以下範例顯示 SecretLockPrototype[] 物件的格式。


[ {
  "name" : "lock-example-1",
  "description" : "lock for consumer 1",
  "attributes" : {
    "anyKey" : "anyValue"
  }
} ]

SecretPrototype

以下範例顯示 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

以下範例顯示 SecretTaskError 物件的格式。


{
  "code" : "exampleString",
  "description" : "Failed to create credentials"
}

SecretTaskPrototype

以下範例顯示 SecretTaskPrototype 物件的格式。


{
  "status" : "credentials_created",
  "credentials" : {
    "id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
    "payload" : {
      "anyKey" : "anyValue"
    }
  }
}

SecretVersionActionPrototype

以下範例顯示 SecretVersionActionPrototype 物件的格式。


{
  "action_type" : "private_cert_action_revoke_certificate"
}

SecretVersionPrototype

以下範例顯示 SecretVersionPrototype 物件的格式。


{
  "payload" : "updated secret credentials",
  "custom_metadata" : {
    "anyKey" : "anyValue"
  },
  "version_custom_metadata" : {
    "anyKey" : "anyValue"
  }
}

ServiceCredentialsSecretSourceService

以下範例顯示 ServiceCredentialsSecretSourceService 物件的格式。


{
  "crn" : "exampleString"
}