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查询，它将替换上表中任何JMESPath。

命令选项

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

密钥组标识。 必需。

最大长度为 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 (通用映射)

用于更新私钥组的请求主体。

通过提供以 @ 开头的文件路径选项 (例如 --secret-group-patch=@path/to/file.json)，提供 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 (字符串)

密钥组标识。 必需。

最大长度为 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 选项。 它与这些选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --secret-prototype=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

--secret-custom-metadata (通用映射)

用户可以定制的私钥元数据。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --secret-custom-metadata=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

--secret-description (字符串)

私钥的扩展描述。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 1024 个字符。 最小长度为 0 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

私钥材料到期的日期。 日期格式遵循 RFC 3339 格式。 受支持的私钥类型：任意或 username_password。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

--secret-labels ([]字符串)

可用于在实例中搜索私钥的标签。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 30 项。 最少长度为 0 项。

--secret-name (字符串)

要分配给私钥的人类可读名称。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 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-原型”的子字段提供值。 它与该选项互斥。

最大长度为 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-原型”的子字段提供值。 它与该选项互斥。

允许的值是：arbitrary、iam_credentials、imported_cert、kv、private_cert、public_cert、service_credentials、username_password。

--arbitrary-payload (字符串)

分配给 arbitrary 密钥的机密数据。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 1000000 个字符。 最小长度为 0 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

--secret-version-custom-metadata (通用映射)

用户可以定制的私钥版本元数据。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --secret-version-custom-metadata=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

--secret-ttl (字符串)

要分配给生成的凭证的生存时间 (TTL) 或租赁持续时间。 受支持的私钥类型：iam_credentials 和 service_credentials。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 10 个字符。 该值必须与正则表达式 /^[0-9]+[s,m,h,d]{0,1}$/ 匹配。

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

访问组，可用于创建 iam_credentials 密码。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /^AccessGroupId-[a-z0-9-]+[a-z0-9]$/ 匹配。 最多长度为 10 项。 最短长度为 1。

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

用于创建 API 密钥的服务标识。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 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 凭据的账户标识。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /^[a-z0-9]*$/ 匹配。

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

此参数指示是否复用服务标识和 API 密钥以用于将来的读操作。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

--secret-rotation (RotationPolicy)

此字段指示 Secrets Manager 是否自动轮换私钥。 受支持的私钥类型：username_password、private_cert、public_cert 或 iam_credentials。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --secret-rotation=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

--imported-cert-certificate (字符串)

证书的 PEM 编码内容。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 100000 个字符。 最小长度为 50 个字符。 该值必须与正则表达式 /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/ 匹配。

--imported-cert-intermediate (字符串)

（可选）与根证书关联的 PEM 编码的中间证书。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 100000 个字符。 最小长度为 50 个字符。 该值必须与正则表达式 /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/ 匹配。

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

（可选）与证书关联的 PEM 编码的专用密钥。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 100000 个字符。 最小长度为 50 个字符。 该值必须与正则表达式 /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/ 匹配。

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

创建CSR和私钥所需的数据。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --imported-cert-managed-csr=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

--kv-data (通用映射)

键值私钥的有效内容数据。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最短长度为 1。

通过提供以 @ 开头的文件路径选项 (例如 --kv-data=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

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

证书模板的名称。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 128 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/ 匹配。

--certificate-common-name (字符串)

公共名称 (CN) 表示受 SSL 证书保护的服务器名称。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最小长度为 4 个字符。

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

使用“主题备用名称”字段，可以指定要由单个 SSL 证书保护的其他主机名。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /^(.*?)$/ 匹配。 最多长度为 99 项。 最少长度为 0 项。

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

要为 CA 证书定义的 IP 主题备用名称（以逗号分隔的列表）。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 2048 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

要为 CA 证书定义的 URI 主题备用名称（以逗号分隔的列表）。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 2048 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

要为 CA 证书定义的定制对象标识 (OID) 或 UTF8-string 主题备用名称。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

--private-cert-csr (字符串)

证书签名请求。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 4096 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/ 匹配。

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

返回的数据的格式。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

允许的值是：pem、pem_bundle。

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

生成的专用密钥的格式。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

默认值为 der。 允许的值是：der、pkcs8。

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

此参数控制是否从主题备用名称 (SAN) 中排除公共名称。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

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

用于生成与证书关联的公用密钥的密码算法的标识。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

默认值为 RSA2048。 最大长度为 8 个字符。 最小长度为 5 个字符。 该值必须与正则表达式 /^(RSA2048|RSA4096|ECDSA256|ECDSA384)$/ 匹配。

--public-cert-ca (字符串)

认证中心配置的名称。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 128 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

--public-cert-dns (字符串)

DNS 提供程序配置的名称。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 128 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

此字段指示是否将已发放的证书与中间证书捆绑在一起。 请将证书文件设置为仅包含已颁发的证书，发送至 false。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

默认值为 true。

--secret-source-service (ServiceCredentialsSecretSourceService)

为指定的源服务实例创建服务凭证所需的属性。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --secret-source-service=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

--username-password-username (字符串)

分配给 username_password 密钥的用户名。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 64 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /[A-Za-z0-9+-=.]*/ 匹配。

--username-password-password (字符串)

分配给 username_password 秘密的密码。 如果省略此参数，那么 Secrets Manager 会为私钥生成新的随机密码。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

最大长度为 256 个字符。 最小长度为 6 个字符。 该值必须与正则表达式 /.{6,256}/ 匹配。

--username-password-policy (PasswordGenerationPolicy)

自动生成密码的策略。 此选项为 JSON 选项“secret-原型”的子字段提供值。 它与该选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --username-password-policy=@path/to/file.json)，提供 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”。

最大长度为 128 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

--groups ([]字符串)

按组过滤私钥。 提供要作为过滤依据的组的标识。

列表项必须与正则表达式 /^([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。最大长度为 8 项。 最少长度为 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 \
    --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查询，它将替换上表中任何JMESPath。

命令选项

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

私钥标识。 必需。

最大长度为 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-delete \
    --id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46

命令选项

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

私钥标识。 必需。

最大长度为 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 (通用映射)

update_secret_metadata 的 JSON Merge-Patch 内容。

通过提供以 @ 开头的文件路径选项 (例如 --secret-metadata-patch=@path/to/file.json)，提供 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 格式。 受支持的私钥类型：任意或 username_password。

--ttl (字符串)

要分配给生成的凭证的生存时间 (TTL) 或租赁持续时间。 受支持的私钥类型：iam_credentials 和 service_credentials。

最大长度为 10 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /^[0-9]+[s,m,h,d]{0,1}$/ 匹配。

--rotation (RotationPolicy)

此字段指示 Secrets Manager 是否自动轮换私钥。 受支持的私钥类型：username_password、private_cert、public_cert 或 iam_credentials。

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

创建CSR和私钥所需的数据。

--password-generation-policy (PasswordGenerationPolicyPatch)

自动生成密码的策略补丁。 将更新补丁中包含的策略属性。 未包括在补丁中的属性保持不变。

示例

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

私钥标识。 必需。

最大长度为 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 选项。 它与这些选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --secret-action-prototype=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

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

私钥操作的类型。 此选项为 JSON 选项“secret-action-原型”的子字段提供值。 它与该选项互斥。

允许的值是：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。

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

私钥标识。 必需。

最大长度为 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 选项。 它与这些选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --secret-version-prototype=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

--arbitrary-payload (字符串)

分配给 arbitrary 密钥的机密数据。 此选项为 JSON 选项“secret-version-原型”的子字段提供值。 它与该选项互斥。

最大长度为 1000000 个字符。 最小长度为 0 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

--secret-version-custom-metadata (通用映射)

用户可以定制的私钥元数据。 此选项为 JSON 选项“secret-version-原型”的子字段提供值。 它与该选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --secret-version-custom-metadata=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

--secret-version-version-custom-metadata (通用映射)

用户可以定制的私钥版本元数据。 此选项为 JSON 选项“secret-version-原型”的子字段提供值。 它与该选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --secret-version-version-custom-metadata=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

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

UUID标识符，或 current 或 previous 秘密版本别名。 此选项为 JSON 选项“secret-version-原型”的子字段提供值。 它与该选项互斥。

最大长度为 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-原型”的子字段提供值。 它与该选项互斥。

最大长度为 100000 个字符。 最小长度为 50 个字符。 该值必须与正则表达式 /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/ 匹配。

--imported-cert-intermediate (字符串)

（可选）与根证书关联的 PEM 编码的中间证书。 此选项为 JSON 选项“secret-version-原型”的子字段提供值。 它与该选项互斥。

最大长度为 100000 个字符。 最小长度为 50 个字符。 该值必须与正则表达式 /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/ 匹配。

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

（可选）与证书关联的 PEM 编码的专用密钥。 此选项为 JSON 选项“secret-version-原型”的子字段提供值。 它与该选项互斥。

最大长度为 100000 个字符。 最小长度为 50 个字符。 该值必须与正则表达式 /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/ 匹配。

--kv-data (通用映射)

键值私钥的有效内容数据。 此选项为 JSON 选项“secret-version-原型”的子字段提供值。 它与该选项互斥。

最短长度为 1。

通过提供以 @ 开头的文件路径选项 (例如 --kv-data=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

--private-cert-csr (字符串)

证书签名请求。 此选项为 JSON 选项“secret-version-原型”的子字段提供值。 它与该选项互斥。

最大长度为 4096 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/ 匹配。

--public-cert-rotation (PublicCertificateRotationObject)

定义用于手动轮换公用证书的轮换对象。 此选项为 JSON 选项“secret-version-原型”的子字段提供值。 它与该选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --public-cert-rotation=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

--username-password-password (字符串)

分配给 username_password 秘密的密码。 如果省略此参数，那么 Secrets Manager 会为私钥生成新的随机密码。 此选项为 JSON 选项“secret-version-原型”的子字段提供值。 它与该选项互斥。

最大长度为 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 (字符串)

私钥标识。 必需。

最大长度为 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查询，它将替换上表中任何JMESPath。

命令选项

--secret-id (字符串)

私钥标识。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/ 匹配。

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

私钥标识。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/ 匹配。

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

私钥标识。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/ 匹配。

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

私钥标识。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/ 匹配。

--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 Merge-Patch 内容。

通过提供以 @ 开头的文件路径选项 (例如 --secret-version-metadata-patch=@path/to/file.json)，提供 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 (字符串)

私钥标识。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/ 匹配。

--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 选项。 它与这些选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --secret-version-action-prototype=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

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

私钥版本操作的类型。 此选项为 JSON 选项“secret-version-action-原型”的子字段提供值。 它与该选项互斥。

允许的值为：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
}

命令选项

--offset (int64)

要跳过的私钥的数量。

默认值为 0。 最大值为 10000000。 最小值为 0。

--limit (int64)

要列出的私钥数。

默认值为 200。 最大值为 1000。 最小值为 1。

--search (字符串)

在字段 "name" 中包含指定字符串的过滤器锁定。

最大长度为 128 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

--groups ([]字符串)

按组过滤私钥。 提供要作为过滤依据的组的标识。

列表项必须与正则表达式 /^([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)

调用多个请求以显示私钥锁定的所有集合页面。

示例

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查询，它将替换上表中任何JMESPath。

命令选项

--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 (bool)

调用多个请求以显示私钥锁定的的所有集合页面。

示例

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

私钥标识。 必需。

最大长度为 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 项。

通过提供以 @ 开头的文件路径选项 (例如 --locks=@path/to/file.json)，提供 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 (字符串)

私钥标识。 必需。

最大长度为 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 (字符串)

私钥标识。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/ 匹配。

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

命令选项

--secret-id (字符串)

私钥标识。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/ 匹配。

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

通过提供以 @ 开头的文件路径选项 (例如 --locks=@path/to/file.json)，提供 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 (字符串)

私钥标识。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/ 匹配。

--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 选项。 它与这些选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --configuration-prototype=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

--config-type (字符串)

配置类型。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

允许的值是：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。

--name (字符串)

要分配给配置的人类可读唯一名称。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 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-原型”的子字段提供值。 它与该选项互斥。

最大长度为 128 个字符。 最小长度为 0 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

唯一标识 IBM Cloud 资源的 CRN。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 512 个字符。 最小长度为 9 个字符。 该值必须与正则表达式 /^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/ 匹配。

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

与经典基础架构帐户关联的用户名。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 128 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

经典基础架构 API 密钥。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 128 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

Let's Encrypt CA 环境的配置。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

允许的值是：production、staging。

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

Let 's Encrypt 帐户的 PEM 编码的专用密钥。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 100000 个字符。 最小长度为 50 个字符。 该值必须与正则表达式 /(^-----BEGIN PRIVATE KEY-----.*?)|(^-----BEGIN RSA PRIVATE KEY-----.*?)/ 匹配。

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

具有与此主题公共名称匹配的颁发者的首选链。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 30 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

与 JSON 格式加密密钥相关联的数据。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --private-cert-crypto-key=@path/to/file.json)，提供 JSON 字符串选项或指定要从中读取的 JSON 文件。

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

此 CA 创建的证书的最长生存时间 (TTL)。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 10 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /^[0-9]+[s,m,h,d]{0,1}$/ 匹配。

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

证书撤销列表 (CRL) 到期之前的时间。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 10 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /^[0-9]+[s,m,h,d]{0,1}$/ 匹配。

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

此字段禁用或启用证书撤销列表 (CRL) 构建。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段将确定是否对此认证中心颁发的证书中的证书撤销列表 (CRL) 分发点进行编码。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段确定是否在此认证中心颁发的证书中对颁发证书的 URL 进行编码。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

--certificate-common-name (字符串)

公共名称 (CN) 表示受 SSL 证书保护的服务器名称。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 128 个字符。 最小长度为 4 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

使用“主题备用名称”字段，可以指定要由单个 SSL 证书保护的其他主机名。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /^(.*?)$/ 匹配。 最多长度为 99 项。 最少长度为 0 项。

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

要为 CA 证书定义的 IP 主题备用名称（以逗号分隔的列表）。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 2048 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

要为 CA 证书定义的 URI 主题备用名称（以逗号分隔的列表）。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 2048 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

要为 CA 证书定义的定制对象标识 (OID) 或 UTF8-string 主题备用名称。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

此 CA 创建的证书的请求生存时间 (TTL)。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 10 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /^[0-9]+[s,m,h,d]{0,1}$/ 匹配。

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

返回的数据的格式。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

允许的值是：pem、pem_bundle。

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

生成的专用密钥的格式。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

默认值为 der。 允许的值是：der、pkcs8。

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

要生成的专用密钥的类型。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

允许的值是：rsa、ec。

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

用于生成专用密钥的位数。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大值为 4096。 最小值为 224。

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

生成的证书中编码的最大路径长度。-1 表示无限制。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

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

此参数控制是否从主题备用名称 (SAN) 中排除公共名称。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此 CA 证书要签署和发放的证书所允许的 DNS 域或子域。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的组织单元 (OU) 值。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的组织 (O) 值。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的国家或地区 (C) 值。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的位置 (L) 值。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的省/自治区/直辖市 (ST) 值。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的街道地址值。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的邮政编码值。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

证书的专有名称（DN）中 serialNumber （ https://datatracker.ietf.org/doc/html/rfc4519#section-2.31 ）属性的请求值。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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-原型”的子字段提供值。 它与该选项互斥。

允许的值是：internal、external。

--private-cert-issuer (字符串)

用于标识签署和发放证书的实体的专有名称。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 128 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

中间认证中心的名称。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 128 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/ 匹配。

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

此字段将专用证书的创建范围限定为仅您指定的私钥组。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 1024 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

该字段用于指示是否允许将 localhost 作为请求的常用名称之一。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

要为证书模板定义的域。 此属性与 allow_bare_domains 和 allow_subdomains 选项一起使用。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

此字段用于指示是否允许在 allowed_domains 字段中提供的域包含访问控制列表（ACL）模板。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段指示是否允许客户机请求与最终证书上实际域的值匹配的专用证书。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段指示是否允许客户机请求具有公共名称 (CN) 的专用证书，这些公共名称是其他证书模板选项所允许的 CN 的子域。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段用于指示是否允许在 allowed_domains 字段中指定的名称中使用通配符。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段指示是否在 CN 字段中使用 RFC 6125 通配符发放证书。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段指示是否允许客户机请求与任何公共名称匹配的专用证书。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段指示是否仅对公共名称、DNS 主题备用名称和电子邮件地址的主机部分实施有效主机名。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段指示是否允许客户机请求具有 IP 主题备用名称的专用证书。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

允许用于专用证书的 URI 主题备用名称。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

用于允许专用证书的定制对象标识 (OID) 或 UTF8-string 主题备用名称 (SAN)。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

此字段指示是否将专用证书标记为供服务器使用。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段指示是否将专用证书标记为供客户机使用。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段指示是否标记专用证书以用于代码签名。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段指示是否标记专用证书以用于电子邮件保护。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

要为专用证书定义的允许密钥使用约束。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /^[a-zA-Z]+$/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

专用证书上允许的扩展密钥使用约束。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /^[a-zA-Z]+$/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

扩展密钥使用对象标识 (OID) 的列表。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

此字段确定是否使用证书签名请求 (CSR) 中的公共名称 (CN)。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段确定是否使用证书签名请求 (CSR) 中的主题备用名称 (SAN)。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

此字段指示是否需要公共名称来创建专用证书。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

策略对象标识 (OID) 的列表。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

此字段指示是否将已颁发专用证书的“基本约束”扩展标记为对非 CA 证书有效。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

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

已签发私人证书的 not_before 属性回溯日期的持续时间（以秒为单位）。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 10 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /^[0-9]+[s,m,h,d]{0,1}$/ 匹配。

--iam-credentials-apikey (字符串)

用于设置 iam_credentials 引擎的 API 密钥。 此选项为 JSON 选项“configuration-原型”的子字段提供值。 它与该选项互斥。

最大长度为 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-原型”的子字段提供值。 它与该选项互斥。

默认值为 false。

示例

示例请求

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

过滤在一个或多个字段中包含指定字符串的配置：“name”、“config_type”、“secret_type”。

最大长度为 128 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

--secret-types ([]字符串)

按机密类型过滤配置。 提供以下一种或多种保密类型：iam_credentials、public_cert 或 private_cert。

允许的列表项有 iam_credentials、private_cert、public_cert。最大长度为 3 项。 最少长度为 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

示例输出

用于配置元数据收集的示例响应

{
  "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"
  } ],
  "total_count" : 6
}

默认JMESPath

如果用户没有提供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。

示例

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

命令选项

--name (字符串)

配置的名称。 必需。

最大长度为 128 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

--configuration-patch (通用映射)

update_configuration 的 JSON Merge-Patch 内容。

通过提供以 @ 开头的文件路径选项 (例如 --configuration-patch=@path/to/file.json)，提供 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。

--api-key (字符串)

可以创建和管理服务标识的 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 (bool)

该参数表示是否禁用 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 (bool)

此字段禁用或启用证书撤销列表 (CRL) 构建。

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

此字段将确定是否对此认证中心颁发的证书中的证书撤销列表 (CRL) 分发点进行编码。

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

此字段确定是否在此认证中心颁发的证书中对颁发证书的 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 (bool)

该字段用于指示是否允许将 localhost 作为请求的常用名称之一。

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

要为证书模板定义的域。 此属性与 allow_bare_domains 和 allow_subdomains 选项一起使用。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

此字段用于指示是否允许在 allowed_domains 字段中提供的域包含访问控制列表（ACL）模板。

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

此字段指示是否允许客户机请求与最终证书上实际域的值匹配的专用证书。

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

此字段指示是否允许客户机请求具有公共名称 (CN) 的专用证书，这些公共名称是其他证书模板选项所允许的 CN 的子域。

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

此字段用于指示是否允许在 allowed_domains 字段中指定的名称中使用通配符。

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

此字段指示是否允许客户机请求与任何公共名称匹配的专用证书。

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

此字段指示是否仅对公共名称、DNS 主题备用名称和电子邮件地址的主机部分实施有效主机名。

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

此字段指示是否允许客户机请求具有 IP 主题备用名称的专用证书。

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

允许用于专用证书的 URI 主题备用名称。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

用于允许专用证书的定制对象标识 (OID) 或 UTF8-string 主题备用名称 (SAN)。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

此字段指示是否将专用证书标记为供服务器使用。

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

此字段指示是否将专用证书标记为供客户机使用。

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

此字段指示是否标记专用证书以用于代码签名。

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

此字段指示是否标记专用证书以用于电子邮件保护。

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

扩展密钥使用对象标识 (OID) 的列表。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

此字段确定是否使用证书签名请求 (CSR) 中的公共名称 (CN)。

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

此字段确定是否使用证书签名请求 (CSR) 中的主题备用名称 (SAN)。

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

要在生成的证书的主题字段中定义的组织单元 (OU) 值。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的组织 (O) 值。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的国家或地区 (C) 值。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的位置 (L) 值。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

--private-cert-subject-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 (bool)

此字段指示是否需要公共名称来创建专用证书。

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

策略对象标识 (OID) 的列表。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

此字段指示是否将已颁发专用证书的“基本约束”扩展标记为对非 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 (字符串)

IBM Cloud API 密钥，可列出 Cloud Internet Services 实例中的域并添加 DNS 记录。

最大长度为 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 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

示例

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。

示例

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 选项。 它与这些选项互斥。

通过提供以 @ 开头的文件路径选项 (例如 --config-action-prototype=@path/to/file.json)，提供 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。

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

配置操作的类型。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

允许的值是：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-原型”的子字段提供值。 它与该选项互斥。

最大长度为 128 个字符。 最小长度为 4 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

使用“主题备用名称”字段，可以指定要由单个 SSL 证书保护的其他主机名。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /^(.*?)$/ 匹配。 最多长度为 99 项。 最少长度为 0 项。

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

要为 CA 证书定义的 IP 主题备用名称（以逗号分隔的列表）。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

最大长度为 2048 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

要为 CA 证书定义的 URI 主题备用名称（以逗号分隔的列表）。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

最大长度为 2048 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

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

要为 CA 证书定义的定制对象标识 (OID) 或 UTF8-string 主题备用名称。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

要分配给专用证书的生存时间 (TTL)。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

最大长度为 10 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /^[0-9]+[s,m,h,d]{0,1}$/ 匹配。

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

返回的数据的格式。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

允许的值是：pem、pem_bundle。

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

生成的证书中编码的最大路径长度。-1 表示无限制。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

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

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

此参数控制是否从主题备用名称 (SAN) 中排除公共名称。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

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

此 CA 证书要签署和发放的证书所允许的 DNS 域或子域。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 100 项。 最少长度为 0 项。

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

该字段指示是否使用证书签名请求（CSR）中的值来完成 private_cert_configuration_action_sign_csr 操作。 如果设置为 true，那么:

1. 主题信息 (包括名称和备用名称) 将从 CSR 中保留，而不是使用此操作的其他参数中提供的值。

2. CSR 中请求的任何密钥用法 (例如，不可抵赖性) 都将添加到用于中间机构签署的 CA 证书的基本密钥用法集。

3. CSR 中请求的扩展将复制到发放的专用证书中。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

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

要在生成的证书的主题字段中定义的组织单元 (OU) 值。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的组织 (O) 值。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的国家或地区 (C) 值。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的位置 (L) 值。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的省/自治区/直辖市 (ST) 值。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的街道地址值。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

要在生成的证书的主题字段中定义的邮政编码值。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

列表项必须与正则表达式 /(.*?)/ 匹配。 最多长度为 10 项。 最少长度为 0 项。

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

证书的专有名称（DN）中 serialNumber （ https://datatracker.ietf.org/doc/html/rfc4519#section-2.31 ）属性的请求值。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

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-原型”的子字段提供值。 它与该选项互斥。

最大长度为 4096 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/ 匹配。

--config-action-intermediate-certificate-authority (字符串)

中间认证中心配置的名称。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

最大长度为 128 个字符。 最小长度为 2 个字符。 该值必须与正则表达式 /(.*?)/ 匹配。

--imported-cert-certificate (字符串)

证书的 PEM 编码内容。 此选项为 JSON 选项“config-action-原型”的子字段提供值。 它与该选项互斥。

最大长度为 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