ibmcloud secrets-manager docs

ウェブブラウザでプラグインのドキュメントを開きます。

ibmcloud secrets-manager docs

ibmcloud secrets-manager docs

例

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

注: この例は、すべてのサブコマンドで使用可能なグローバル・オプションのみを示しており、有効なコマンドではありません。

例

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

例

ibmcloud secrets-manager config get service-url

例

ibmcloud secrets-manager config unset service-url

例

ibmcloud secrets-manager config list

コマンド・オプション

--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

出力例

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クエリが提供された場合、それは上記の表のJMESPathのいずれかに置き換わります。

コマンド・オプション

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

コマンド・オプション

--id (文字列)

シークレット・グループの ID。 必須。

最大長は36文字です。 最小長は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 ストリング・オプションを指定するか、 @ で始まるファイル・パス・オプション (例: --secret-group-patch=@path/to/file.json) を指定して読み取る JSON ファイルを指定します。

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

コマンド・オプション

--id (文字列)

シークレット・グループの ID。 必須。

最大長は36文字です。 最小長は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

コマンド・オプション

--secret-prototype (SecretPrototype)

JSON にはシークレットを作成するために必要な詳細が含まれています。 代わりに、他のオプションを使用して個々のフィールドを設定することで、この JSON オプションを指定できます。 これらのオプションと同時に指定することはできません。

JSON ストリング・オプションを指定するか、 @ で始まるファイル・パス・オプション (例: --secret-prototype=@path/to/file.json) を指定して読み取る JSON ファイルを指定します。

--secret-custom-metadata (汎用マップ)

ユーザーがカスタマイズできるシークレット・メタデータ。 このオプションは、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。 サポートされるシークレット・タイプ: Arbitrary、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 秘密グループ。 このオプションは、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 (汎用マップ)

ユーザーがカスタマイズできるシークレット・バージョン・メタデータ。 このオプションは、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 シークレットに使用できるアクセスグループ。 このオプションは、JSON オプション「secret-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

リスト項目は、正規表現 /^AccessGroupId-[a-z0-9-]+[a-z0-9]$/ と一致している必要があります。 最大長さは 10。 最小長さは 1。

--iam-credentials-service-id (文字列)

API キーの作成に使用されたサービス ID。 このオプションは、JSON オプション「secret-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

最大長は46文字です。 最小長は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文字です。 最小長は32文字です。 値は正規表現/^[a-z0-9]*$/と一致する必要があります。

--iam-credentials-reuse-apikey (ブール)

このパラメーターは、将来の読み取り操作でサービス 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 ([]ストリング)

「サブジェクト代替名 (Subject Alternative Name)」フィールドを使用して、単一の 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 (ブール)

このパラメーターは、共通名がサブジェクト代替名 (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 (ブール)

このフィールドは、発行された証明書が中間証明書にバンドルされているかどうかを示します。 証明書ファイルに発行済み証明書のみを含める場合は、 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 シークレットに割り当てられるユーザー名。 このオプションは、JSON オプション「secret-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

最大長は64文字です。 最小長は2文字です。 値は正規表現/[A-Za-z0-9+-=.]*/と一致する必要があります。

--username-password-password (文字列)

username_password シークレットに割り当てられるパスワード。 このパラメーターを省略すると、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 secret-create \
  --secret-prototype='{"name": "example-arbitrary-secret", "secret_type": "arbitrary", "payload":"example-secret-data"}'

コマンド・オプション

--offset (int64)

スキップするシークレットの数。

デフォルト値は 0です。 最大値は 10000000 である。 最小値は 0 です。

--limit (int64)

リストするシークレットの数。

デフォルト値は 200です。 最大値は 1000 である。 最小値は 1 です。

--sort (文字列)

指定されたフィールドでシークレットのコレクションを昇順でソートします。 降順に並べ替えるには、 -。

最大長は17文字です。 最小長は2文字です。 値は正規表現/^-?(id|created_at|updated_at|expiration_date|secret_type|name)$/と一致する必要があります。

--search (文字列)

「ID」、「name」、「description」、「labels」、「secret_type」の 1 つ以上のフィールドに、指定されたストリングを含むシークレットをフィルターに掛けます。

最大長は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 (ブール)

複数の要求を呼び出して、秘密情報のコレクションのすべてのページを表示します。

例

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

出力例

秘密メタデータ収集の応答の例

{
  "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クエリがこのコマンドの出力にデフォルトで適用されます。 正確なクエリは、シナリオと要求された出力フォーマットによって異なります。 デフォルトのJMESPathクエリごとの条件は、以下の表でご確認いただけます

カスタムのJMESPathクエリが提供された場合、それは上記の表のJMESPathのいずれかに置き換わります。

コマンド・オプション

--id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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

コマンド・オプション

--id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/と一致する必要があります。

--force-delete (ブール)

true 、強制的にシークレットを削除する。 カスタム資格情報の秘密タイプでのみ利用可能です。

デフォルト値は falseです。

例

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

コマンド・オプション

--id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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

コマンド・オプション

--id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/と一致する必要があります。

--secret-metadata-patch (汎用マップ)

JSON マージ - update_secret_metadata のパッチ・コンテンツ。

JSON ストリング・オプションを指定するか、 @ で始まるファイル・パス・オプション (例: --secret-metadata-patch=@path/to/file.json) を指定して読み取る JSON ファイルを指定します。

--name (文字列)

シークレットに割り当てる、人間が理解できる名前。

最大長は256文字です。 最小長は2文字です。 値は正規表現/^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/と一致する必要があります。

--description (文字列)

シークレットの追加説明。

最大長は1024文字です。 最小長は0文字です。 値は正規表現/(.*?)/と一致する必要があります。

--labels ([]ストリング)

インスタンス内のシークレットを検索するために使用できるラベル。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 30。 最小の長さは 0。

--custom-metadata (汎用マップ)

ユーザーがカスタマイズできるシークレット・メタデータ。

--expiration-date (strfmt.DateTime)

秘密資料の有効期限が切れる日付。 日付の書式は RFC 3339。 サポートされるシークレット・タイプ: Arbitrary、username_password。

--ttl (文字列)

生成される資格情報に割り当てられる存続時間 (TTL) またはリース期間。 サポートされる秘密の型: iam_credentials、service_credentials、custom_credentials。

最大長は10文字です。 最小文字数は 1。 値は正規表現/^[0-9]+[s,m,h,d]{0,1}$/と一致する必要があります。

--rotation (RotationPolicy)

このフィールドは、Secrets Manager がシークレットを自動的にローテートするかどうかを示します。 サポートされる秘密の型: username_password、private_cert、public_cert、iam_credentials、custom_credentials。

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

CSRとプライベート・キーを作成するために指定されたデータ。

--password-generation-policy (PasswordGenerationPolicyPatch)

自動生成されたパスワードのポリシー・パッチ。 パッチに含まれているポリシー・プロパティーが更新されます。 パッチに含まれていないプロパティーは変更されません。

--custom-credentials-parameters (汎用マップ)

カスタム資格情報エンジンに渡されるパラメータ。 使用できる型は「文字列」、「整数」、「ブーリアン」である。

例

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

コマンド・オプション

--id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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"}'

コマンド・オプション

--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

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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 (汎用マップ)

ユーザーがカスタマイズできるシークレット・メタデータ。 このオプションは、JSON オプション「secret-version-prototype」のサブフィールドの値を指定します。 このオプションと同時に指定することはできません。

JSON ストリング・オプションを指定するか、 @ で始まるファイル・パス・オプション (例: --secret-version-custom-metadata=@path/to/file.json) を指定して読み取る JSON ファイルを指定します。

--secret-version-version-custom-metadata (汎用マップ)

ユーザーがカスタマイズできるシークレット・バージョン・メタデータ。 このオプションは、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 シークレットに割り当てられるパスワード。 このパラメーターを省略すると、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"}}'

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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

出力例

秘密バージョン・メタデータ収集の応答の例

{
  "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クエリがこのコマンドの出力にデフォルトで適用されます。 正確なクエリは、シナリオと要求された出力フォーマットによって異なります。 デフォルトのJMESPathクエリごとの条件は、以下の表でご確認いただけます

カスタムのJMESPathクエリが提供された場合、それは上記の表のJMESPathのいずれかに置き換わります。

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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 (汎用マップ)

JSON マージ - update_secret_version_metadata のパッチ・コンテンツ。

JSON ストリング・オプションを指定するか、 @ で始まるファイル・パス・オプション (例: --secret-version-metadata-patch=@path/to/file.json) を指定して読み取る JSON ファイルを指定します。

--version-custom-metadata (汎用マップ)

ユーザーがカスタマイズできるシークレット・バージョン・メタデータ。

例

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

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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
}

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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"
  } ]
}

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/と一致する必要があります。

--id (文字列)

タスクを一意に識別するID。 必須。

最大長は44文字です。 最小長は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

出力例

シークレットタスクの回答例。

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

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/と一致する必要があります。

--id (文字列)

タスクを一意に識別するID。 必須。

最大長は44文字です。 最小長は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

出力例

シークレットタスクの回答例。

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

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/と一致する必要があります。

--id (文字列)

タスクを一意に識別するID。 必須。

最大長は44文字です。 最小長は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

コマンド・オプション

--offset (int64)

スキップするシークレットの数。

デフォルト値は 0です。 最大値は 10000000 である。 最小値は 0 です。

--limit (int64)

リストするシークレットの数。

デフォルト値は 200です。 最大値は 1000 である。 最小値は 1 です。

--search (文字列)

「name」フィールドに指定されたストリングを含むロックをフィルターに掛けます。

最大長は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 (ブール)

複数の要求を呼び出して、シークレット・ロックのコレクションのすべてのページを表示します。

例

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クエリがこのコマンドの出力にデフォルトで適用されます。 正確なクエリは、シナリオと要求された出力フォーマットによって異なります。 デフォルトのJMESPathクエリごとの条件は、以下の表でご確認いただけます

カスタムのJMESPathクエリが提供された場合、それは上記の表のJMESPathのいずれかに置き換わります。

コマンド・オプション

--id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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 (文字列)

「name」フィールドに指定されたストリングを含むロックをフィルターに掛けます。

最大長は128文字です。 最小長は2文字です。 値は正規表現/(.*?)/と一致する必要があります。

--all-pages (ブール)

複数の要求を呼び出して、シークレット・ロックのコレクションのすべてのページを表示します。

例

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
}

コマンド・オプション

--id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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
  } ]
}

コマンド・オプション

--id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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
  } ]
}

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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 (文字列)

「name」フィールドに指定されたストリングを含むロックをフィルターに掛けます。

最大長は128文字です。 最小長は2文字です。 値は正規表現/(.*?)/と一致する必要があります。

--all-pages (ブール)

複数の要求を呼び出して、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
}

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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。 remove_previous を使ってロックを作成し、名前が一致する既存のロックをクリアする。 remove_previous_and_delete 、旧バージョンのデータも削除する。

使用できる値は、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
  } ]
}

コマンド・オプション

--secret-id (文字列)

シークレットの ID。 必須。

最大長は36文字です。 最小長は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
  } ]
}

コマンド・オプション

--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 (文字列)

Cloud Internet Services インスタンス内のドメインをリストし、DNS レコードを追加できる IBM Cloud API キー。 このオプションは、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 (ブール)

このフィールドは、証明書失効リスト (CRL) の作成を無効または有効にします。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-crl-distribution-points-encoded (ブール)

このフィールドは、この認証局によって発行される証明書内の証明書失効リスト (CRL) 配布ポイントをエンコードするかどうかを決定します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-issuing-certificate-urls-encoded (ブール)

このフィールドは、発行元証明書の URL を、この認証局によって発行される証明書にエンコードするかどうかを決定します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--certificate-common-name (文字列)

共通名 (CN) は、SSL 証明書によって保護されるサーバー名を表します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

最大長は128文字です。 最小長は4文字です。 値は正規表現/(.*?)/と一致する必要があります。

--certificate-alt-names ([]ストリング)

「サブジェクト代替名 (Subject Alternative Name)」フィールドを使用して、単一の 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 (ブール)

このパラメーターは、共通名がサブジェクト代替名 (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 ([]ストリング)

結果の証明書のサブジェクト・フィールドに定義する Country (C) 値です。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 10。 最小の長さは 0。

--private-cert-subject-locality ([]ストリング)

結果の証明書のサブジェクト・フィールドに定義する Locality (L) 値です。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 10。 最小の長さは 0。

--private-cert-subject-province ([]ストリング)

結果の証明書のサブジェクト・フィールドに定義する 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 (文字列)

証明書の識別名（DN）に含まれる serialNumber ( https://datatracker.ietf.org/doc/html/rfc4519#section-2.31 ) 属性の要求値。 このオプションは、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 (ブール)

このフィールドは、要求されたコモン・ネームの1つとして localhost を含めることを許可するかどうかを示す。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-allowed-domains ([]ストリング)

証明書テンプレートに定義するドメイン。 このプロパティは、 allow_bare_domains および allow_subdomains オプションとともに使用される。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 100。 最小の長さは 0。

--private-cert-allowed-domains-template (ブール)

このフィールドは、 allowed_domains フィールドで指定されたドメインに、アクセス制御リスト(ACL)テンプレート を含めることを許可するかどうかを示す。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-allow-bare-domains (ブール)

このフィールドは、最終証明書の実際のドメインの値と一致するプライベート証明書をクライアントが要求できるようにするかどうかを示します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-allow-subdomains (ブール)

このフィールドは、他の証明書テンプレート・オプションで許可されている CN のサブドメインである共通名 (CN) を持つプライベート証明書をクライアントが要求できるようにするかどうかを示します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-allow-glob-domains (ブール)

このフィールドは、 allowed_domains フィールドで指定された名前にグロブ・パターンを許可するかどうかを示す。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-allow-wildcard (ブール)

このフィールドは、CN フィールドで RFC 6125 ワイルドカードを使用して証明書を発行するかどうかを示します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-allow-any-name (ブール)

このフィールドは、任意の共通名に一致するプライベート証明書をクライアントが要求することを許可するかどうかを示します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-enforce-hostname (ブール)

このフィールドは、共通名、DNS サブジェクト代替名、および E メール・アドレスのホスト・セクションに有効なホスト名のみを強制するかどうかを示します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-allow-ip-sans (ブール)

このフィールドは、クライアントが 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 (ブール)

このフィールドは、サーバーが使用するためにプライベート証明書にフラグが立てられるかどうかを示します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-client-flag (ブール)

このフィールドは、クライアントが使用するためにプライベート証明書にフラグが立てられるかどうかを示します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-code-signing-flag (ブール)

このフィールドは、コード署名用にプライベート証明書にフラグが立てられるかどうかを示します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-email-protection-flag (ブール)

このフィールドは、E メール保護のためにプライベート証明書にフラグを立てるかどうかを示します。 このオプションは、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 (ブール)

このフィールドは、証明書署名要求 (CSR) から共通名 (CN) を使用するかどうかを決定します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-use-cse-sans (ブール)

このフィールドは、証明書署名要求 (CSR) からサブジェクト代替名 (SAN) を使用するかどうかを決定します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-require-cn (ブール)

このフィールドは、プライベート証明書を作成するために共通名を必要とするかどうかを示します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

--private-cert-policy-identifiers ([]ストリング)

ポリシー・オブジェクト ID (OID) のリスト。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 100。 最小の長さは 0。

--private-cert-basic-constraints-valid-for-non-ca (ブール)

このフィールドは、発行されたプライベート証明書の基本制約拡張機能に、非 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 (ブール)

このパラメータは、API キー設定が無効であるかどうかを示します。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

デフォルト値は falseです。

--custom-credentials-apikey-ref (文字列)

カスタム資格情報エンジン構成を設定するために使用される IAM 資格情報秘密 ID。 このオプションは、JSON オプション「configuration-prototype」のサブフィールドの値を提供します。 このオプションと同時に指定することはできません。

最大長は36文字です。 最小長は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"}'

コマンド・オプション

--offset (int64)

スキップする構成の数。

デフォルト値は 0です。 最大値は 1000 である。 最小値は 0 です。

--limit (int64)

リストする構成の数。

デフォルト値は 200です。 最大値は 1000 である。 最小値は 1 です。

--sort (文字列)

指定されたフィールドで構成のコレクションを昇順でソートします。 降順に並べ替えるには、 -。

最大長は17文字です。 最小長は2文字です。 値は正規表現/^-?(config_type|secret_type|name)$/と一致する必要があります。

--search (文字列)

指定されたストリングを 1 つ以上のフィールド (「name」、「config_type」、「secret_type」) に含む構成をフィルターに掛けます。

最大長は128文字です。 最小長は2文字です。 値は正規表現/(.*?)/と一致する必要があります。

--secret-types ([]ストリング)

構成をシークレット・タイプでフィルタリングします。 iam_credentials、public_cert、private_cert、custom_credentials のいずれか1つ以上のシークレットタイプを指定する。

許可されるリスト項目は以下の通りです： iam_credentials private_cert, public_cert, custom_credentials。最大長は 4 アイテムです。 最小の長さは 0。

--all-pages (ブール)

複数の要求を呼び出して、構成のコレクションのすべてのページを表示します。

例

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

出力例

メタデータ収集を構成するための応答例

{
  "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クエリがこのコマンドの出力にデフォルトで適用されます。 正確なクエリは、シナリオと要求された出力フォーマットによって異なります。 デフォルトのJMESPathクエリごとの条件は、以下の表でご確認いただけます

カスタムのJMESPathクエリが提供された場合、それは上記の表のJMESPathのいずれかに置き換わります。

コマンド・オプション

--name (文字列)

構成の名前。 必須。

最大長は128文字です。 最小長は2文字です。 値は正規表現/(.*?)/と一致する必要があります。

--config-type (文字列)

この構成の構成タイプ - 300 個のエラー応答を解決するには、このヘッダーを使用します。

許容値は以下の通りです： 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.

例

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

コマンド・オプション

--name (文字列)

構成の名前。 必須。

最大長は128文字です。 最小長は2文字です。 値は正規表現/(.*?)/と一致する必要があります。

--configuration-patch (汎用マップ)

JSON マージ - update_configuration のパッチ・コンテンツ。

JSON ストリング・オプションを指定するか、 @ で始まるファイル・パス・オプション (例: --configuration-patch=@path/to/file.json) を指定して読み取る JSON ファイルを指定します。

--config-type (文字列)

この構成の構成タイプ - 300 個のエラー応答を解決するには、このヘッダーを使用します。

許容値は以下の通りです： 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.

--api-key (文字列)

サービス ID を作成および管理できる IBM Cloud API キー。 API キーには、アクセス・グループ・サービスに対するエディターのプラットフォーム役割および IAM Identity Service に対するオペレーターのプラットフォーム役割が割り当てられている必要があります。 詳細については、資料を参照してください。

最大長は60文字です。 最小長は5文字です。 値は正規表現/^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/と一致する必要があります。

--iam-credentials-apikey-disabled (ブール)

このパラメータは、API キー設定が無効であるかどうかを示します。

--private-cert-max-ttl (文字列)

この CA により作成される証明書の最大存続時間 (TTL)。

最大長は10文字です。 最小長は2文字です。 値は正規表現/^[0-9]+[s,m,h,d]{0,1}$/と一致する必要があります。

--private-cert-crl-expiry (文字列)

証明書失効リスト (CRL) の有効期限が切れるまでの時間。

最大長は10文字です。 最小長は2文字です。 値は正規表現/^[0-9]+[s,m,h,d]{0,1}$/と一致する必要があります。

--private-cert-crl-disabled (ブール)

このフィールドは、証明書失効リスト (CRL) の作成を無効または有効にします。

--private-cert-crl-distribution-points-encoded (ブール)

このフィールドは、この認証局によって発行される証明書内の証明書失効リスト (CRL) 配布ポイントをエンコードするかどうかを決定します。

--private-cert-issuing-certificate-urls-encoded (ブール)

このフィールドは、発行元証明書の URL を、この認証局によって発行される証明書にエンコードするかどうかを決定します。

--private-cert-allowed-secret-groups (文字列)

このフィールドは、プライベート証明書の作成の有効範囲を、指定したシークレット・グループのみに限定します。

最大長は1024文字です。 最小長は2文字です。 値は正規表現/(.*?)/と一致する必要があります。

--private-cert-ttl (文字列)

この CA によって作成された証明書に対して要求された存続時間 (TTL)。

最大長は10文字です。 最小長は2文字です。 値は正規表現/^[0-9]+[s,m,h,d]{0,1}$/と一致する必要があります。

--private-cert-allow-localhost (ブール)

このフィールドは、要求されたコモン・ネームの1つとして localhost を含めることを許可するかどうかを示す。

--private-cert-allowed-domains ([]ストリング)

証明書テンプレートに定義するドメイン。 このプロパティは、 allow_bare_domains および allow_subdomains オプションとともに使用される。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 100。 最小の長さは 0。

--private-cert-allowed-domains-template (ブール)

このフィールドは、 allowed_domains フィールドで指定されたドメインに、アクセス制御リスト(ACL)テンプレート を含めることを許可するかどうかを示す。

--private-cert-allow-bare-domains (ブール)

このフィールドは、最終証明書の実際のドメインの値と一致するプライベート証明書をクライアントが要求できるようにするかどうかを示します。

--private-cert-allow-subdomains (ブール)

このフィールドは、他の証明書テンプレート・オプションで許可されている CN のサブドメインである共通名 (CN) を持つプライベート証明書をクライアントが要求できるようにするかどうかを示します。

--private-cert-allow-glob-domains (ブール)

このフィールドは、 allowed_domains フィールドで指定された名前にグロブ・パターンを許可するかどうかを示す。

--private-cert-allow-any-name (ブール)

このフィールドは、任意の共通名に一致するプライベート証明書をクライアントが要求することを許可するかどうかを示します。

--private-cert-enforce-hostname (ブール)

このフィールドは、共通名、DNS サブジェクト代替名、および E メール・アドレスのホスト・セクションに有効なホスト名のみを強制するかどうかを示します。

--private-cert-allow-ip-sans (ブール)

このフィールドは、クライアントが IP サブジェクト代替名を使用してプライベート証明書を要求できるようにするかどうかを示します。

--private-cert-allowed-uri-sans ([]ストリング)

プライベート証明書を許可する URI サブジェクト代替名。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 100。 最小の長さは 0。

--private-cert-allowed-other-sans ([]ストリング)

プライベート証明書を許可するカスタム・オブジェクト ID (OID) または UTF8-string のサブジェクト代替名 (SAN)。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 100。 最小の長さは 0。

--private-cert-server-flag (ブール)

このフィールドは、サーバーが使用するためにプライベート証明書にフラグが立てられるかどうかを示します。

--private-cert-client-flag (ブール)

このフィールドは、クライアントが使用するためにプライベート証明書にフラグが立てられるかどうかを示します。

--private-cert-code-signing-flag (ブール)

このフィールドは、コード署名用にプライベート証明書にフラグが立てられるかどうかを示します。

--private-cert-email-protection-flag (ブール)

このフィールドは、E メール保護のためにプライベート証明書にフラグを立てるかどうかを示します。

--private-cert-private-key-type (文字列)

生成する秘密鍵のタイプです。

使用できる値は、rsa、ecです。

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

秘密鍵を生成するために使用するビット数。

最大値は 4096 である。 最小値は 224です。

--private-cert-key-usage ([]ストリング)

プライベート証明書に対して定義するために許可される鍵用途制約。

リスト項目は、正規表現 /^[a-zA-Z]+$/ と一致している必要があります。 最大長さは 100。 最小の長さは 0。

--private-cert-ext-key-usage ([]ストリング)

プライベート証明書に対して許可される拡張鍵の使用制約。

リスト項目は、正規表現 /^[a-zA-Z]+$/ と一致している必要があります。 最大長さは 100。 最小の長さは 0。

--private-cert-ext-key-usage-oids ([]ストリング)

拡張鍵用途のオブジェクト ID (OID) のリストです。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 100。 最小の長さは 0。

--private-cert-use-csr-common-name (ブール)

このフィールドは、証明書署名要求 (CSR) から共通名 (CN) を使用するかどうかを決定します。

--private-cert-use-cse-sans (ブール)

このフィールドは、証明書署名要求 (CSR) からサブジェクト代替名 (SAN) を使用するかどうかを決定します。

--private-cert-subject-organizational-unit ([]ストリング)

結果の証明書のサブジェクト・フィールドに定義する組織単位 (OU) 値。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 10。 最小の長さは 0。

--private-cert-subject-organization ([]ストリング)

結果の証明書のサブジェクト・フィールドに定義する組織 (O) 値。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 10。 最小の長さは 0。

--private-cert-subject-country ([]ストリング)

結果の証明書のサブジェクト・フィールドに定義する Country (C) 値です。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 10。 最小の長さは 0。

--private-cert-subject-locality ([]ストリング)

結果の証明書のサブジェクト・フィールドに定義する Locality (L) 値です。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 10。 最小の長さは 0。

--private-cert-subject-province ([]ストリング)

結果の証明書のサブジェクト・フィールドに定義する Province (ST) 値。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 10。 最小の長さは 0。

--private-cert-subject-street-address ([]ストリング)

結果の証明書のサブジェクト・フィールドに定義する番地の値。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 10。 最小の長さは 0。

--private-cert-subject-postal-code ([]ストリング)

結果の証明書のサブジェクト・フィールドに定義する郵便番号の値。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 10。 最小の長さは 0。

--private-cert-requested-serial-number (文字列)

このフィールドは非推奨です。 その値は無視できます。

最大長は64文字です。 最小長は32文字です。 値は正規表現/[^a-fA-F0-9]/と一致する必要があります。

--private-cert-require-cn (ブール)

このフィールドは、プライベート証明書を作成するために共通名を必要とするかどうかを示します。

--private-cert-policy-identifiers ([]ストリング)

ポリシー・オブジェクト ID (OID) のリスト。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 100。 最小の長さは 0。

--private-cert-basic-constraints-valid-for-non-ca (ブール)

このフィールドは、発行されたプライベート証明書の基本制約拡張機能に、非 CA 証明書に対して有効としてマークを付けるかどうかを示します。

--private-cert-not-before-duration (文字列)

発行されたプライベート証明書の not_before プロパティをバックデートする時間（秒）。

最大長は10文字です。 最小長は2文字です。 値は正規表現/^[0-9]+[s,m,h,d]{0,1}$/と一致する必要があります。

--public-cert-lets-encrypt-environment (文字列)

Let 's Encrypt CA 環境の構成です。

使用できる値は、production、stagingです。

--public-cert-lets-encrypt-private-key (文字列)

Let 's Encrypt アカウントの PEM エンコードされた秘密鍵です。

最大長は100000文字です。 最小長は50文字です。 値は正規表現/(^-----BEGIN PRIVATE KEY-----.*?)|(^-----BEGIN RSA PRIVATE KEY-----.*?)/と一致する必要があります。

--public-cert-lets-encrypt-preferred-chain (文字列)

このサブジェクト共通名と一致する発行者を持つ優先チェーンです。

最大長は30文字です。 最小長は2文字です。 値は正規表現/(.*?)/と一致する必要があります。

--public-cert-cloud-internet-services-apikey (文字列)

Cloud Internet Services インスタンス内のドメインをリストし、DNS レコードを追加できる IBM Cloud API キー。

最大長は128文字です。 最小長は0文字です。 値は正規表現/(.*?)/と一致する必要があります。

--cloud-internet-services-crn (文字列)

IBM Cloud リソースを一意的に識別する CRN です。

最大長は512文字です。 最小長は9文字です。 値は正規表現/^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/と一致する必要があります。

--public-cert-classic-infrastructure-username (文字列)

クラシック・インフラストラクチャー・アカウントに関連付けられているユーザー名。

最大長は128文字です。 最小長は2文字です。 値は正規表現/(.*?)/と一致する必要があります。

--public-cert-classic-infrastructure-password (文字列)

クラシック・インフラストラクチャー API キー。

最大長は128文字です。 最小長は2文字です。 値は正規表現/(.*?)/と一致する必要があります。

--configuration-task-timeout (文字列)

Code Engine タスクが完了するまでの最大許容時間を指定する。 この時間が経過すると、タスクの状態は失敗に変わる。 最小値は5分、最大値は24時間。 デフォルトのタスクタイムアウトは10分。 値は、秒数を指定する整数か、 10m や 2h のような継続時間を表す文字列のいずれかになります。

最大長は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::

コマンド・オプション

--name (文字列)

構成の名前。 必須。

最大長は128文字です。 最小長は2文字です。 値は正規表現/(.*?)/と一致する必要があります。

--config-type (文字列)

この構成の構成タイプ - 300 個のエラー応答を解決するには、このヘッダーを使用します。

許容値は以下の通りです： 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.

例

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

コマンド・オプション

--name (文字列)

構成の名前。 必須。

最大長は128文字です。 最小長は2文字です。 値は正規表現/(.*?)/と一致する必要があります。

--config-action-prototype (ConfigurationActionPrototype)

構成を作成するアクションのプロパティーを指定するための要求本文。 代わりに、他のオプションを使用して個々のフィールドを設定することで、この JSON オプションを指定できます。 これらのオプションと同時に指定することはできません。

JSON ストリング・オプションを指定するか、 @ で始まるファイル・パス・オプション (例: --config-action-prototype=@path/to/file.json) を指定して読み取る JSON ファイルを指定します。

--config-type (文字列)

この構成の構成タイプ - 300 個のエラー応答を解決するには、このヘッダーを使用します。

許容値は以下の通りです： 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.

--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 ([]ストリング)

「サブジェクト代替名 (Subject Alternative Name)」フィールドを使用して、単一の 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 (文字列)

プライベート証明書に割り当てる time-to-live (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 (ブール)

このパラメーターは、共通名がサブジェクト代替名 (SAN) から除外されるかどうかを制御します。 このオプションは、JSON オプション「config-action-prototype」のサブフィールドの値を指定します。 このオプションと同時に指定することはできません。

--private-cert-permitted-dns-domains ([]ストリング)

この CA 証明書によって署名および発行される証明書に対して許可される DNS ドメインまたはサブドメイン。 このオプションは、JSON オプション「config-action-prototype」のサブフィールドの値を指定します。 このオプションと同時に指定することはできません。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 100。 最小の長さは 0。

--config-action-use-csr-values (ブール)

このフィールドは、証明書署名要求（CSR）の値を使用して private_cert_configuration_action_sign_csr アクションを完了するかどうかを示す。 true に設定されている場合は、以下のようになります。

1. サブジェクト情報 (名前や代替名など) は、この操作の他のパラメーターで指定された値を使用するのではなく、CSR から保持されます。

2. CSR で要求された鍵用途 (否認防止など) はすべて、中間機関によって署名された CA 証明書に使用される鍵用途の基本セットに追加されます。

3. 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 ([]ストリング)

結果の証明書のサブジェクト・フィールドに定義する Country (C) 値です。 このオプションは、JSON オプション「config-action-prototype」のサブフィールドの値を指定します。 このオプションと同時に指定することはできません。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 10。 最小の長さは 0。

--private-cert-subject-locality ([]ストリング)

結果の証明書のサブジェクト・フィールドに定義する Locality (L) 値です。 このオプションは、JSON オプション「config-action-prototype」のサブフィールドの値を指定します。 このオプションと同時に指定することはできません。

リスト項目は、正規表現 /(.*?)/ と一致している必要があります。 最大長さは 10。 最小の長さは 0。

--private-cert-subject-province ([]ストリング)

結果の証明書のサブジェクト・フィールドに定義する 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 (文字列)

証明書の識別名（DN）に含まれる serialNumber ( https://datatracker.ietf.org/doc/html/rfc4519#section-2.31 ) 属性の要求値。 このオプションは、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-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

出力例

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

例

ibmcloud secrets-manager notifications-registration-test