ibmcloud secrets-manager docs

Ouvre la documentation du plug-in dans le navigateur web.

ibmcloud secrets-manager docs

ibmcloud secrets-manager docs

Exemple

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

Cet exemple ne fait que démontrer les options globales disponibles pour toutes les sous-commandes et n'est pas une commande valide en soi.

Exemples

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

Exemples

ibmcloud secrets-manager config get service-url

Exemples

ibmcloud secrets-manager config unset service-url

Exemples

ibmcloud secrets-manager config list

Options de commande

--name (chaîne)

Nom de votre groupe de secrets. Obligatoire.

La longueur maximale est de 64 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/.

--description (chaîne)

Description détaillée de votre groupe de secrets.

La longueur maximale est de 1024 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

Exemple

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

Exemple de sortie

Exemple de réponse à 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"
}

Exemple

ibmcloud secrets-manager secret-groups

Exemple de sortie

Exemple de réponse de collection 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
}

Par défaut JMESPath

Une requête JMESPath sera appliquée par défaut à la sortie de cette commande, si l'utilisateur n'en fournit pas une. La requête exacte dépendra du scénario et du format de sortie requis. Vous pouvez voir la condition pour chaque requête JMESPath par défaut dans le tableau suivant :

Si une requête JMESPath personnalisée est fournie, elle remplacera n'importe quel JMESPath dans le tableau ci-dessus.

Options de commande

--secret-group-id (chaîne)

ID du groupe de secrets. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 7 caractères. La valeur doit correspondre à l'expression régulière /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

Exemple

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

Exemple de sortie

Exemple de réponse à 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"
}

Options de commande

--id (chaîne)

ID du groupe de secrets. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--secret-group-patch (mappe générique)

Corps de la demande pour mettre à jour un groupe de secrets. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --secret-group-patch=@path/to/file.json.

--name (chaîne)

Nom de votre groupe de secrets. Cette option fournit une valeur pour un sous-champ de l'option JSON "secret-group-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 64 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/.

--description (chaîne)

Description détaillée de votre groupe de secrets. Cette option fournit une valeur pour un sous-champ de l'option JSON "secret-group-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 1024 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

Exemple

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

Exemple de sortie

Exemple de réponse à 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"
}

Options de commande

--id (chaîne)

ID du groupe de secrets. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

Exemple

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

Options de commande

--secret-prototype (SecretPrototype)

JSON contenant les détails requis pour la création d'un secret. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --secret-prototype=@path/to/file.json.

--secret-custom-metadata (mappe générique)

Les métadonnées de secret qu'un utilisateur peut personnaliser. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --secret-custom-metadata=@path/to/file.json.

--secret-description (chaîne)

Description détaillée de votre secret. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 1024 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

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

Date d'expiration de l'élément secret. Le format de la date suit le format RFC 3339. Types de secret pris en charge : arbitraire, username_password. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

--secret-labels (chaîne[])

Libellés que vous pouvez utiliser pour rechercher des secrets dans votre instance. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 30 éléments. La longueur minimale est de 0.

--secret-name (chaîne)

Nom lisible à affecter à votre secret. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 256 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/.

--secret-group-id (chaîne)

Un identifiant UUID ou un groupe secret default. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 36 caractères. La longueur minimale est de 7 caractères. La valeur doit correspondre à l'expression régulière /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

--secret-type (chaîne)

Le type de secret. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

Les valeurs autorisées sont les suivantes : arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, username_password, custom_credentials.

--arbitrary-payload (chaîne)

Les données secrètes attribuées à un secret arbitrary. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 1000000 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--secret-version-custom-metadata (mappe générique)

Les métadonnées de version de secret qu'un utilisateur peut personnaliser. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --secret-version-custom-metadata=@path/to/file.json.

--secret-ttl (chaîne)

Durée de vie ou durée de bail à affecter aux données d'identification générées. Types de secrets pris en charge : iam_credentials, service_credentials, custom_credentials. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 10 caractères. La valeur doit correspondre à l'expression régulière /^[0-9]+[s,m,h,d]{0,1}$/.

--iam-credentials-access-groups (chaîne[])

Groupes d'accès que vous pouvez utiliser pour un secret iam_credentials. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /^AccessGroupId-[a-z0-9-]+[a-z0-9]$/. La longueur maximale est de 10 éléments. La longueur minimale est de 1.

--iam-credentials-service-id (chaîne)

L'ID de service sous lequel la clé d'API est créée. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur doit être de 46 caractères. La valeur doit correspondre à l'expression régulière /^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 (chaîne)

L'ID du compte dans lequel les informations d'identification IAM sont créées. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur doit être de 32 caractères. La valeur doit correspondre à l'expression régulière /^[a-z0-9]*$/.

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

Ce paramètre indique si l'ID de service et la clé d'API doivent être réutilisés pour les opérations de lecture ultérieures. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

--secret-rotation (RotationPolicy)

Cette zone indique si Secrets Manager effectue une rotation automatique de vos secrets. Types de secret pris en charge : username_password, private_cert, public_cert, iam_credentials, custom_credentials. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --secret-rotation=@path/to/file.json.

--imported-cert-certificate (chaîne)

Contenu codé PEM de votre certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 100000 caractères. La longueur minimale est de 50 caractères. La valeur doit correspondre à l'expression régulière /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/.

--imported-cert-intermediate (chaîne)

(Facultatif) Certificat intermédiaire codé PEM associé au certificat racine. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 100000 caractères. La longueur minimale est de 50 caractères. La valeur doit correspondre à l'expression régulière /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/.

--imported-cert-private-key (chaîne)

(Facultatif) Clé privée codée PEM à associer au certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 100000 caractères. La longueur minimale est de 50 caractères. La valeur doit correspondre à l'expression régulière /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/.

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

Les données spécifiées pour créer la CSR et la clé privée. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --imported-cert-managed-csr=@path/to/file.json.

--kv-data (mappe générique)

Données de contenu d'un secret clé-valeur. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur minimale est de 1.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --kv-data=@path/to/file.json.

--private-cert-template-name (chaîne)

Nom du modèle de certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.

--certificate-common-name (chaîne)

Le nom usuel (CN) représente le nom du serveur qui est protégé par le certificat SSL. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur minimale est de 4 caractères.

--certificate-alt-names (chaîne[])

La zone de nom alternatif de sujet permet de spécifier des noms d'hôte supplémentaires à protéger par un certificat SSL unique. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /^(.*?)$/. La longueur maximale est de 99 éléments. La longueur minimale est de 0.

--private-cert-ip-sans (chaîne)

Noms alternatifs de sujet IP à définir pour le certificat de l'autorité de certification, dans une liste délimitée par des virgules. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 2048 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--private-cert-uri-sans (chaîne)

Noms alternatifs de sujet d'URI à définir pour le certificat de l'autorité de certification, dans une liste délimitée par des virgules. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 2048 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--private-cert-other-sans (chaîne[])

Identificateur d'objet personnalisé (OID) ou noms alternatifs de sujet au format chaîne UTF8 à définir pour le certificat de l'autorité de certification. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

--private-cert-csr (chaîne)

Demande de signature de certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 4096 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/.

--private-cert-format (chaîne)

Format des données renvoyées. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

Les valeurs admises sont: pem, pem_bundle.

--private-cert-private-key-format (chaîne)

Format de la clé privée générée. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La valeur par défaut est der. Les valeurs autorisées sont : der, pkcs8.

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

Ce paramètre contrôle si le nom usuel est exclu des noms alternatifs de sujet (SAN). Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

--public-cert-key-algorithm (chaîne)

L'identificateur de l'algorithme de cryptographie utilisé pour générer la clé publique associée au certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La valeur par défaut est RSA2048. La longueur maximale est de 8 caractères. La longueur minimale est de 5 caractères. La valeur doit correspondre à l'expression régulière /^(RSA2048|RSA4096|ECDSA256|ECDSA384)$/.

--public-cert-ca (chaîne)

Le nom de la configuration de l'autorité de certification. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--public-cert-dns (chaîne)

Le nom de la configuration du fournisseur DNS. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

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

Cette zone indique si le certificat que vous avez émis est regroupé avec des certificats intermédiaires. Définir à false pour que le fichier de certificat ne contienne que le certificat délivré. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La valeur par défaut est true.

--secret-source-service (ServiceCredentialsSecretSourceService)

Propriétés requises pour créer les données d'identification du service pour l'instance de service source spécifiée. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --secret-source-service=@path/to/file.json.

--username-password-username (chaîne)

Le nom d'utilisateur attribué à un secret username_password. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 64 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /[A-Za-z0-9+-=.]*/.

--username-password-password (chaîne)

Le mot de passe attribué à un secret username_password. Si vous omettez ce paramètre, Secrets Manager génère un nouveau mot de passe aléatoire pour votre secret. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 256 caractères. La longueur minimale est de 6 caractères. La valeur doit correspondre à l'expression régulière /.{6,256}/.

--username-password-policy (PasswordGenerationPolicy)

Règle pour les mots de passe générés automatiquement. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --username-password-policy=@path/to/file.json.

--custom-credentials-configuration (chaîne)

Nom de la configuration des données d'identification personnalisées. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[a-zA-Z0-9]([-a-zA-Z0-9\\-_\\.]*)?$/.

--custom-credentials-parameters (mappe générique)

Les paramètres qui sont transmis au moteur de données d'identification personnalisées. Les types autorisés sont les suivants : chaîne, entier et booléen. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-prototype'. Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --custom-credentials-parameters=@path/to/file.json.

Exemple

Exemple de demande

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

Options de commande

--offset (int64)

Nombre de secrets à ignorer.

La valeur par défaut est 0. La valeur maximale est de 10000000. Valeur minimale : 0.

--limit (int64)

Nombre de secrets à répertorier.

La valeur par défaut est 200. La valeur maximale est de 1000. Valeur minimale : 1.

--sort (chaîne)

Triez une collection de secrets en fonction de la zone spécifiée, par ordre croissant. Pour trier par ordre décroissant, utilisez le caractère -.

La longueur maximale est de 17 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^-?(id|created_at|updated_at|retrieved_at|expiration_date|secret_type|name)$/.

--search (chaîne)

Filtrez les secrets qui contiennent la chaîne spécifiée dans une ou plusieurs des zones suivantes : "id", "name", "description", "labels", "secret_type".

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--groups (chaîne[])

Filtrer les secrets par groupe. Indiquez les ID des groupes à utiliser pour le filtrage.

Les éléments de liste doivent correspondre à l'expression régulière /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/. La longueur maximale est de 201 éléments. La longueur minimale est de 0.

--secret-types (chaîne[])

Filtrer les secrets par types. Indiquez les types de secret à utiliser pour le filtrage.

Les éléments de la liste autorisés sont les suivants : arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, username_password, custom_credentials. La longueur maximale est de 9 éléments. La longueur minimale est de 0.

--match-all-labels (chaîne[])

Filtrer les secrets par libellés. Indiquez les libellés à utiliser pour le filtrage.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 30 éléments. La longueur minimale est de 0.

--all-pages (bool)

Appelez plusieurs demandes pour afficher toutes les pages de la collection de secrets.

Exemple

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

Exemple de sortie

Exemple de réponse de collecte de métadonnées de secret

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

Par défaut JMESPath

Une requête JMESPath sera appliquée par défaut à la sortie de cette commande, si l'utilisateur n'en fournit pas une. La requête exacte dépendra du scénario et du format de sortie requis. Vous pouvez voir la condition pour chaque requête JMESPath par défaut dans le tableau suivant :

Si une requête JMESPath personnalisée est fournie, elle remplacera n'importe quel JMESPath dans le tableau ci-dessus.

Options de commande

--id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

Exemple

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

Options de commande

--id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--force-delete (bool)

La valeur true permet de forcer la suppression du secret. Disponible uniquement pour le type de secret des données d'identification personnalisées.

La valeur par défaut est false.

Exemple

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

Options de commande

--id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

Exemple

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

Options de commande

--id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--secret-metadata-patch (mappe générique)

Contenu JSON Merge-Patch pour update_secret_metadata. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --secret-metadata-patch=@path/to/file.json.

--name (chaîne)

Nom lisible à affecter à votre secret. Cette option fournit une valeur pour un sous-champ de l'option JSON "secret-metadata-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 256 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/.

--description (chaîne)

Description détaillée de votre secret. Cette option fournit une valeur pour un sous-champ de l'option JSON "secret-metadata-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 1024 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--labels (chaîne[])

Libellés que vous pouvez utiliser pour rechercher des secrets dans votre instance. Cette option fournit une valeur pour un sous-champ de l'option JSON "secret-metadata-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 30 éléments. La longueur minimale est de 0.

--custom-metadata (mappe générique)

Les métadonnées de secret qu'un utilisateur peut personnaliser. Il doit s'agir d'une chaîne JSON ou d'un chemin d'accès à un fichier JSON. Cette option fournit une valeur pour un sous-champ de l'option JSON "secret-metadata-patch". Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --custom-metadata=@path/to/file.json.

--expiration-date (strfmt.DateTime)

Date d'expiration de l'élément secret. Le format de date respecte le format 'RFC 3339'. Types de secret pris en charge : arbitraire, username_password. Cette option fournit une valeur pour un sous-champ de l'option JSON "secret-metadata-patch". Elle est mutuellement exclusive avec cette option.

--ttl (chaîne)

Durée de vie ou durée de bail à affecter aux données d'identification générées. Types de secrets pris en charge : iam_credentials, service_credentials, custom_credentials. Cette option fournit une valeur pour un sous-champ de l'option JSON "secret-metadata-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 10 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^[0-9]+[s,m,h,d]{0,1}$/.

--rotation (RotationPolicy)

Cette zone indique si Secrets Manager effectue une rotation automatique de vos secrets. Types de secret pris en charge : username_password, private_cert, public_cert, iam_credentials, custom_credentials. Il doit s'agir d'une chaîne JSON ou d'un chemin d'accès à un fichier JSON. Cette option fournit une valeur pour un sous-champ de l'option JSON "secret-metadata-patch". Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --rotation=@path/to/file.json.

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

Les données spécifiées pour créer la CSR et la clé privée. Il doit s'agir d'une chaîne JSON ou d'un chemin d'accès à un fichier JSON. Cette option fournit une valeur pour un sous-champ de l'option JSON "secret-metadata-patch". Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --imported-cert-managed-csr=@path/to/file.json.

--password-generation-policy (PasswordGenerationPolicyPatch)

Correctif de règle pour les mots de passe générés automatiquement. Les propriétés de règle incluses dans le correctif sont mises à jour.\nLes propriétés qui ne sont pas incluses dans le correctif restent inchangées. Il doit s'agir d'une chaîne JSON ou d'un chemin d'accès à un fichier JSON. Cette option fournit une valeur pour un sous-champ de l'option JSON "secret-metadata-patch". Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --password-generation-policy=@path/to/file.json.

--custom-credentials-parameters (mappe générique)

Les paramètres qui sont transmis au moteur de données d'identification personnalisées. Les types autorisés sont les suivants : chaîne, entier et booléen. Il doit s'agir d'une chaîne JSON ou d'un chemin d'accès à un fichier JSON. Cette option fournit une valeur pour un sous-champ de l'option JSON "secret-metadata-patch". Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --custom-credentials-parameters=@path/to/file.json.

Exemple

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

Options de commande

--id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--secret-action-prototype (SecretActionPrototype)

Corps de la demande pour spécifier les propriétés de votre action de secret. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --secret-action-prototype=@path/to/file.json.

--secret-action-type (chaîne)

Type de l'action de secret. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les valeurs admises sont: public_cert_action_validate_dns_challenge, private_cert_action_revoke_certificate.

Exemple

Exemple de demande

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

Options de commande

--secret-type (chaîne)

Le type de secret. Obligatoire.

Les valeurs autorisées sont les suivantes : arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, username_password, custom_credentials.

--name (chaîne)

Nom lisible à affecter à votre secret. Pour protéger votre vie privée, n'utilisez pas de données personnelles, telles que votre nom ou votre lieu de résidence, pour désigner votre secret. Obligatoire.

La longueur maximale est de 256 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^\\w(([\\w-.]+)?\\w)?$/.

--secret-group-name (chaîne)

Nom de votre groupe de secrets. Obligatoire.

La longueur maximale est de 64 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

Exemple

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

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--secret-version-prototype (SecretVersionPrototype)

Spécifiez les propriétés de votre nouvelle version de secret. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --secret-version-prototype=@path/to/file.json.

--arbitrary-payload (chaîne)

Les données secrètes attribuées à un secret arbitrary. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-version-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 1000000 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--secret-version-custom-metadata (mappe générique)

Les métadonnées de secret qu'un utilisateur peut personnaliser. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-version-prototype'. Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --secret-version-custom-metadata=@path/to/file.json.

--secret-version-version-custom-metadata (mappe générique)

Les métadonnées de version de secret qu'un utilisateur peut personnaliser. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-version-prototype'. Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --secret-version-version-custom-metadata=@path/to/file.json.

--secret-version-restore-from-version (chaîne)

Un identifiant UUID, ou les alias de version secrète current ou previous. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-version-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 36 caractères. La longueur minimale est de 7 caractères. La valeur doit correspondre à l'expression régulière /^([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 (chaîne)

Contenu codé PEM de votre certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-version-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 100000 caractères. La longueur minimale est de 50 caractères. La valeur doit correspondre à l'expression régulière /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/.

--imported-cert-intermediate (chaîne)

(Facultatif) Certificat intermédiaire codé PEM associé au certificat racine. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-version-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 100000 caractères. La longueur minimale est de 50 caractères. La valeur doit correspondre à l'expression régulière /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/.

--imported-cert-private-key (chaîne)

(Facultatif) Clé privée codée PEM à associer au certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-version-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 100000 caractères. La longueur minimale est de 50 caractères. La valeur doit correspondre à l'expression régulière /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/.

--kv-data (mappe générique)

Données de contenu d'un secret clé-valeur. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-version-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur minimale est de 1.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --kv-data=@path/to/file.json.

--private-cert-csr (chaîne)

Demande de signature de certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-version-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 4096 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/.

--public-cert-rotation (PublicCertificateRotationObject)

Définit l'objet de rotation utilisé pour effectuer une rotation manuelle des certificats publics. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-version-prototype'. Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --public-cert-rotation=@path/to/file.json.

--username-password-password (chaîne)

Le mot de passe attribué à un secret username_password. Si vous omettez ce paramètre, Secrets Manager génère un nouveau mot de passe aléatoire pour votre secret. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-version-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 256 caractères. La longueur minimale est de 6 caractères. La valeur doit correspondre à l'expression régulière /.{6,256}/.

Exemple

Exemple de demande

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

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

Exemple

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

Exemple de sortie

Exemple de réponse de collecte de métadonnées de version de secret

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

Par défaut JMESPath

Une requête JMESPath sera appliquée par défaut à la sortie de cette commande, si l'utilisateur n'en fournit pas une. La requête exacte dépendra du scénario et du format de sortie requis. Vous pouvez voir la condition pour chaque requête JMESPath par défaut dans le tableau suivant :

Si une requête JMESPath personnalisée est fournie, elle remplacera n'importe quel JMESPath dans le tableau ci-dessus.

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--id (chaîne)

Identificateur de la version du secret. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 7 caractères. La valeur doit correspondre à l'expression régulière /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/.

Exemple

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

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--id (chaîne)

Identificateur de la version du secret. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 7 caractères. La valeur doit correspondre à l'expression régulière /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/.

Exemple

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

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--id (chaîne)

Identificateur de la version du secret. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 7 caractères. La valeur doit correspondre à l'expression régulière /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/.

Exemple

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

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--id (chaîne)

Identificateur de la version du secret. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 7 caractères. La valeur doit correspondre à l'expression régulière /^([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 (mappe générique)

Contenu JSON Merge-Patch pour update_secret_version_metadata. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --secret-version-metadata-patch=@path/to/file.json.

--version-custom-metadata (mappe générique)

Les métadonnées de version de secret qu'un utilisateur peut personnaliser. Il doit s'agir d'une chaîne JSON ou d'un chemin d'accès à un fichier JSON. Cette option fournit une valeur pour un sous-champ de l'option JSON "secret-version-metadata-patch". Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --version-custom-metadata=@path/to/file.json.

Exemple

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

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--id (chaîne)

Identificateur de la version du secret. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 7 caractères. La valeur doit correspondre à l'expression régulière /^([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)

Corps de demande permettant de spécifier les propriétés de l'action de création d'une version de secret. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --secret-version-action-prototype=@path/to/file.json.

--secret-version-action-type (chaîne)

Type d'action de la version de secret. Cette option fournit une valeur pour une sous-zone de l'option JSON'secret-version-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les valeurs admises sont: private_cert_action_revoke_certificate.

Exemple

Exemple de demande

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

Exemple de sortie

Corps de demande de l'action de révocation des versions de certificat privé.

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

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

Exemple

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

Exemple de sortie

Exemple de réponse à une liste de toutes les tâches.

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

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--id (chaîne)

L'ID qui identifie de manière unique votre tâche. Obligatoire.

La longueur doit être de 44 caractères. La valeur doit correspondre à l'expression régulière /^sm-task-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Exemple

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

Exemple de sortie

Exemple de réponse avec une tâche secrète.

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

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--id (chaîne)

L'ID qui identifie de manière unique votre tâche. Obligatoire.

La longueur doit être de 44 caractères. La valeur doit correspondre à l'expression régulière /^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)

Le corps de demande pour spécifier les propriétés de la mise à jour de votre tâche de secret. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --task-put=@path/to/file.json.

--task-put-status (chaîne)

Décrit l'état de la tâche d'un secret. Cette option fournit une valeur pour un sous-champ de l'option JSON "task-put". Elle est mutuellement exclusive avec cette option.

Les valeurs admises sont: credentials_created.

--task-put-credentials (CustomCredentialsNewCredentials)

Données d'identification nouvellement créées fournies par le fournisseur de données d'identification. Cette option fournit une valeur pour un sous-champ de l'option JSON "task-put". Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --task-put-credentials=@path/to/file.json.

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

Une collection d'erreurs. Cette option fournit une valeur pour un sous-champ de l'option JSON "task-put". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 10 éléments. La longueur minimale est de 1.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --task-put-errors=@path/to/file.json.

Exemples

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

Des options granulaires sont également disponibles pour les sous-zones des options de chaîne 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

Exemple de sortie

Exemple de réponse avec une tâche secrète.

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

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--id (chaîne)

L'ID qui identifie de manière unique votre tâche. Obligatoire.

La longueur doit être de 44 caractères. La valeur doit correspondre à l'expression régulière /^sm-task-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Exemple

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

Options de commande

--offset (int64)

Nombre de secrets à ignorer.

La valeur par défaut est 0. La valeur maximale est de 10000000. Valeur minimale : 0.

--limit (int64)

Nombre de secrets à répertorier.

La valeur par défaut est 200. La valeur maximale est de 1000. Valeur minimale : 1.

--search (chaîne)

Filtrer les verrous contenant la chaîne spécifiée dans la zone "name".

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--groups (chaîne[])

Filtrer les secrets par groupe. Indiquez les ID des groupes à utiliser pour le filtrage.

Les éléments de liste doivent correspondre à l'expression régulière /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/. La longueur maximale est de 201 éléments. La longueur minimale est de 0.

--all-pages (bool)

Appelez plusieurs demandes pour afficher toutes les pages de la collection de verrouillages de secrets.

Exemple

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

Exemple de sortie

Exemple de réponse pour la liste de tous les secrets et verrous

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

Par défaut JMESPath

Une requête JMESPath sera appliquée par défaut à la sortie de cette commande, si l'utilisateur n'en fournit pas une. La requête exacte dépendra du scénario et du format de sortie requis. Vous pouvez voir la condition pour chaque requête JMESPath par défaut dans le tableau suivant :

Si une requête JMESPath personnalisée est fournie, elle remplacera n'importe quel JMESPath dans le tableau ci-dessus.

Options de commande

--id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--offset (int64)

Nombre de verrous à ignorer.

La valeur par défaut est 0. La valeur maximale est de 1000. Valeur minimale : 0.

--limit (int64)

Nombre de secrets avec verrous à répertorier.

La valeur par défaut est 25. La valeur maximale est de 100. Valeur minimale : 1.

--sort (chaîne)

Triez une collection de verrous en fonction de la zone spécifiée, par ordre croissant. Pour trier par ordre décroissant, utilisez le caractère -.

La longueur maximale est de 17 caractères. La longueur minimale est de 4 caractères. La valeur doit correspondre à l'expression régulière /^-?(created_at|updated_at|name)$/.

--search (chaîne)

Filtrer les verrous contenant la chaîne spécifiée dans la zone "name".

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--all-pages (bool)

Appelez plusieurs demandes pour afficher toutes les pages de la collection de verrous de secret.

Exemple

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

Exemple de sortie

Exemple de corps de réponse pour la liste des verrous de secret

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

Options de commande

--id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--locks (SecretLockPrototype[])

Données de verrouillage à associer à une version du secret. Obligatoire.

La longueur maximale est de 1000 éléments. La longueur minimale est de 0.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --locks=@path/to/file.json.

--mode (chaîne)

Définir le mode de verrouillage. Valeurs autorisées : remove_previous, et remove_previous_and_delete. Utilisez remove_previous pour créer un verrou qui efface les verrous existants dont les noms correspondent. Utilisez remove_previous_and_delete pour supprimer également les données de la version précédente.

Les valeurs admises sont: remove_previous, remove_previous_and_delete.

Exemple

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

Exemple de sortie

Exemple de corps de réponse pour créer des verrous de secret

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

Options de commande

--id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--name (chaîne[])

Indiquez les noms des verrous de secret à supprimer.

Les éléments de liste doivent correspondre à l'expression régulière /^[a-zA-Z]{1}[a-zA-Z0-9-_.]{1,63}$/. La longueur maximale est de 1000 éléments. La longueur minimale est de 1.

Exemple

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

Exemple de sortie

Exemple de corps de réponse pour créer des verrous de secret

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

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--id (chaîne)

Identificateur de la version du secret. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 7 caractères. La valeur doit correspondre à l'expression régulière /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/.

--offset (int64)

Nombre de verrous à ignorer.

La valeur par défaut est 0. La valeur maximale est de 1000. Valeur minimale : 0.

--limit (int64)

Nombre de secrets avec verrous à répertorier.

La valeur par défaut est 25. La valeur maximale est de 100. Valeur minimale : 1.

--sort (chaîne)

Triez une collection de verrous en fonction de la zone spécifiée, par ordre croissant. Pour trier par ordre décroissant, utilisez le caractère -.

La longueur maximale est de 17 caractères. La longueur minimale est de 4 caractères. La valeur doit correspondre à l'expression régulière /^-?(created_at|updated_at|name)$/.

--search (chaîne)

Filtrer les verrous contenant la chaîne spécifiée dans la zone "name".

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--all-pages (bool)

Appelez plusieurs demandes pour afficher toutes les pages de la collection de verrous de version de secret.

Exemple

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

Exemple de sortie

Exemple de réponse pour la liste des verrous de version de secret

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

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--id (chaîne)

Identificateur de la version du secret. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 7 caractères. La valeur doit correspondre à l'expression régulière /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/.

--locks (SecretLockPrototype[])

Données de verrouillage à associer à une version du secret. Obligatoire.

La longueur maximale est de 1000 éléments. La longueur minimale est de 0.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --locks=@path/to/file.json.

--mode (chaîne)

Définir le mode de verrouillage. Valeurs autorisées : remove_previous, et remove_previous_and_delete. Utilisez remove_previous pour créer un verrou qui efface les verrous existants dont les noms correspondent. Utilisez remove_previous_and_delete pour supprimer également les données de la version précédente.

Les valeurs admises sont: remove_previous, remove_previous_and_delete.

Exemple

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

Exemple de sortie

Exemple de corps de réponse pour créer des verrous de secret

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

Options de commande

--secret-id (chaîne)

Identificateur du secret. Obligatoire.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

--id (chaîne)

Identificateur de la version du secret. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 7 caractères. La valeur doit correspondre à l'expression régulière /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/.

--name (chaîne[])

Indiquez les noms des verrous de secret à supprimer.

Les éléments de liste doivent correspondre à l'expression régulière /^[a-zA-Z]{1}[a-zA-Z0-9-_.]{1,63}$/. La longueur maximale est de 1000 éléments. La longueur minimale est de 1.

Exemple

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

Exemple de sortie

Exemple de corps de réponse pour créer des verrous de secret

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

Options de commande

--configuration-prototype (ConfigurationPrototype)

JSON contenant les détails requis pour la création d'une configuration. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --configuration-prototype=@path/to/file.json.

--config-type (chaîne)

Type de configuration. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les valeurs autorisées sont les suivantes : 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 (chaîne)

Nom unique lisible à affecter à votre configuration. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/.

--public-cert-cloud-internet-services-apikey (chaîne)

Une clé d'API IBM Cloud qui peut répertorier les domaines dans votre instance Cloud Internet Services et ajouter des enregistrements DNS. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--public-cert-cloud-internet-services-crn (chaîne)

Nom CRN qui identifie de manière unique une ressource IBM Cloud. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 512 caractères. La longueur minimale est de 9 caractères. La valeur doit correspondre à l'expression régulière /^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

--public-cert-classic-infrastructure-username (chaîne)

Nom d'utilisateur associé à votre compte d'infrastructure classique. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--public-cert-classic-infrastructure-password (chaîne)

Clé d'API de votre infrastructure classique. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--public-cert-lets-encrypt-environment (chaîne)

Configuration de l'environnement d'autorité de certification Let's Encrypt. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les valeurs admises sont: production, staging.

--public-cert-lets-encrypt-private-key (chaîne)

Clé privée codée PEM de votre compte Let's Encrypt. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 100000 caractères. La longueur minimale est de 50 caractères. La valeur doit correspondre à l'expression régulière /(^-----BEGIN PRIVATE KEY-----.*?)|(^-----BEGIN RSA PRIVATE KEY-----.*?)/.

--public-cert-lets-encrypt-preferred-chain (chaîne)

Chaîne préférée dont l'émetteur correspond à ce nom usuel de sujet. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 30 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

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

Les données associées à une clé cryptographique au format JSON. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --private-cert-crypto-key=@path/to/file.json.

--private-cert-max-ttl (chaîne)

Durée de vie maximale des certificats créés par cette autorité de certification. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 10 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[0-9]+[s,m,h,d]{0,1}$/.

--private-cert-crl-expiry (chaîne)

Délai d'expiration de la liste de révocation de certificat (CRL). Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 10 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[0-9]+[s,m,h,d]{0,1}$/.

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

Cette zone désactive ou active la génération de la liste de révocation de certificat (CRL). Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

Cette zone détermine si les points de distribution de liste de révocation de certificat (CRL) doivent être codés dans les certificats émis par cette autorité de certification. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

Cette zone détermine si l'URL du certificat émetteur doit être codée dans les certificats émis par cette autorité de certification. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

--certificate-common-name (chaîne)

Le nom usuel (CN) représente le nom du serveur qui est protégé par le certificat SSL. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 4 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--certificate-alt-names (chaîne[])

La zone de nom alternatif de sujet permet de spécifier des noms d'hôte supplémentaires à protéger par un certificat SSL unique. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /^(.*?)$/. La longueur maximale est de 99 éléments. La longueur minimale est de 0.

--private-cert-ip-sans (chaîne)

Noms alternatifs de sujet IP à définir pour le certificat de l'autorité de certification, dans une liste délimitée par des virgules. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 2048 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--private-cert-uri-sans (chaîne)

Noms alternatifs de sujet d'URI à définir pour le certificat de l'autorité de certification, dans une liste délimitée par des virgules. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 2048 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--private-cert-other-sans (chaîne[])

Identificateur d'objet personnalisé (OID) ou noms alternatifs de sujet au format chaîne UTF8 à définir pour le certificat de l'autorité de certification. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

--private-cert-ttl (chaîne)

Durée de vie demandée pour les certificats créés par cette autorité de certification. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 10 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[0-9]+[s,m,h,d]{0,1}$/.

--private-cert-format (chaîne)

Format des données renvoyées. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les valeurs admises sont: pem, pem_bundle.

--private-cert-private-key-format (chaîne)

Format de la clé privée générée. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La valeur par défaut est der. Les valeurs autorisées sont : der, pkcs8.

--private-cert-private-key-type (chaîne)

Type de clé privée à générer. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les valeurs admises sont: rsa, ec.

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

Nombre de bits à utiliser pour générer la clé privée. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La valeur maximale est de 4096. La valeur minimale est 224.

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

Longueur maximale du chemin à encoder dans le certificat généré. -1 signifie aucune limite. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La valeur maximale est de 10. La valeur minimale est -1.

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

Ce paramètre contrôle si le nom usuel est exclu des noms alternatifs de sujet (SAN). Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

--private-cert-permitted-dns-domains (chaîne[])

Domaines ou sous-domaines DNS autorisés pour les certificats qui doivent être signés et émis par ce certificat de l'autorité de certification. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

--private-cert-subject-organizational-unit (chaîne[])

Valeurs d'unité organisationnelle (OU) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-organization (chaîne[])

Valeurs d'organisation (O) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-country (chaîne[])

Valeurs de pays (C) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-locality (chaîne[])

Valeurs de localité (L) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-province (chaîne[])

Valeurs de province (ST) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-street-address (chaîne[])

Valeurs d'adresse à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-postal-code (chaîne[])

Valeurs de code postal à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-serial-number (chaîne)

Valeur demandée pour l'attribut serialNumber ( https://datatracker.ietf.org/doc/html/rfc4519#section-2.31 ) qui figure dans le nom distinctif (DN) du certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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 (chaîne)

Méthode de signature à utiliser avec cette autorité de certification pour générer des certificats privés. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les valeurs admises sont: internal, external.

--private-cert-issuer (chaîne)

Nom distinctif qui identifie l'entité qui a signé et émis le certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--private-cert-ca-name (chaîne)

Nom de l'autorité de certification intermédiaire. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.

--private-cert-allowed-secret-groups (chaîne)

Cette zone permet de limiter la création de certificats privés aux seuls groupes de secrets que vous spécifiez. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 1024 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

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

Ce champ indique s'il faut autoriser l'inclusion de localhost parmi les noms communs demandés. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

--private-cert-allowed-domains (chaîne[])

Domaines à définir pour le modèle de certificat. Cette propriété est utilisée avec les options allow_bare_domains et allow_subdomains. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

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

Ce champ indique s'il faut autoriser les domaines fournis dans le champ allowed_domains à contenir des modèles de liste de contrôle d'accès (ACL). Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les clients doivent être autorisés à demander des certificats privés qui correspondent à la valeur des domaines réels sur le certificat final. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les clients doivent être autorisés à demander des certificats privés portant des noms usuels (CN) qui sont des sous-domaines des noms usuels autorisés par les autres options de modèle de certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

Ce champ indique s'il faut autoriser les motifs globaux dans les noms spécifiés dans le champ allowed_domains. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si l'émission de certificats comportant des caractères génériques RFC 6125 dans la zone CN doit être autorisée. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les clients doivent être autorisés à demander un certificat privé correspondant à un nom usuel. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les noms d'hôte valides doivent être appliqués uniquement pour les noms usuels, les noms alternatifs de sujet DNS et la section hôte des adresses e-mail. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les clients doivent être autorisés à demander un certificat privé portant des noms alternatifs de sujet IP. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

--private-cert-allowed-uri-sans (chaîne[])

Noms alternatifs de sujet d'URI à autoriser pour les certificats privés. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

--private-cert-allowed-other-sans (chaîne[])

Identificateur d'objet personnalisé (OID) ou noms alternatifs de sujet au format chaîne UTF8 à autoriser pour les certificats privés. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

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

Cette zone indique si les certificats privés sont marqués pour être utilisés par le serveur. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les certificats privés sont marqués pour être utilisés par le client. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les certificats privés sont marqués pour être utilisés par la signature de code. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les certificats privés sont marqués pour la protection d'e-mail. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

--private-cert-key-usage (chaîne[])

Contrainte d'utilisation de clé autorisée à définir pour les certificats privés. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /^[a-zA-Z]+$/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

--private-cert-ext-key-usage (chaîne[])

Contrainte d'utilisation de clé étendue autorisée pour les certificats privés. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /^[a-zA-Z]+$/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

--private-cert-ext-key-usage-oids (chaîne[])

Liste des identificateurs d'objet (OID) d'utilisation de clé étendue. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

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

cette zone détermine si le nom usuel (CN) doit être utilisé à partir d'une demande de signature de certificat (CSR). Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

cette zone détermine si les noms alternatifs de sujet doivent être utilisés à partir d'une demande de signature de certificat (CSR). Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si un nom usuel doit être exigé pour créer un certificat privé. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

--private-cert-policy-identifiers (chaîne[])

Liste des identificateurs d'objet de règle (OID). Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

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

Cette zone indique si l'extension de Contraintes de base d'un certificat privé émis doit être marquée comme valide pour les certificats autres que les certificat d'autorité de certification. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

--private-cert-not-before-duration (chaîne)

Durée en secondes de l'antidatation de la propriété not_before d'un certificat privé délivré. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 10 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[0-9]+[s,m,h,d]{0,1}$/.

--iam-credentials-apikey (chaîne)

Clé d'API utilisée pour définir le moteur iam_credentials. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 60 caractères. La longueur minimale est de 5 caractères. La valeur doit correspondre à l'expression régulière /^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/.

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

Ce paramètre indique si la configuration de clé d'API est désactivée. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La valeur par défaut est false.

--custom-credentials-apikey-ref (chaîne)

L'ID secret des données d'identification IAM utilisé pour configurer un moteur de données d'identification personnalisées. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /^[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)

Les paramètres nécessaires à la configuration de Code Engine. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --custom-credentials-code-engine=@path/to/file.json.

--configuration-task-timeout (chaîne)

Indique le temps maximal autorisé pour qu'une tâche Code Engine soit terminée. Une fois ce temps écoulé, l'état de la tâche passe à Échec. La valeur minimale est de 5 minutes et la valeur maximale est de 24 heures. Le délai d'expiration par défaut d'une tâche est de 10 minutes. La valeur peut être soit un nombre entier qui spécifie le nombre de secondes, soit la représentation sous forme de chaîne d'une durée, telle que 10m ou 2h. Cette option fournit une valeur pour une sous-zone de l'option JSON'configuration-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 6 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^[0-9]+[s,m,h,d]{0,1}$/.

Exemple

Exemple de demande

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

Options de commande

--offset (int64)

Nombre de configurations à ignorer.

La valeur par défaut est 0. La valeur maximale est de 1000. Valeur minimale : 0.

--limit (int64)

Nombre de configurations à répertorier.

La valeur par défaut est 200. La valeur maximale est de 1000. Valeur minimale : 1.

--sort (chaîne)

Triez une collection de configurations en fonction de la zone spécifiée, par ordre croissant. Pour trier par ordre décroissant, utilisez le caractère -.

La longueur maximale est de 17 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^-?(config_type|secret_type|name)$/.

--search (chaîne)

Triez les configurations qui contiennent la chaîne spécifiée dans une ou plusieurs des zones : "name", "config_type", "secret_type".

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--secret-types (chaîne[])

Filtrer les configurations par type de secret. Fournissez un ou plusieurs des types de secret suivants : iam_credentials, public_cert, private_cert ou custom_credentials.

Les éléments de liste autorisés sont les suivants : iam_credentials, private_cert, public_cert, custom_credentials. La longueur maximale est de 4 éléments. La longueur minimale est de 0.

--all-pages (bool)

Appelez plusieurs demandes afin d'afficher toutes les pages de la collection de configurations.

Exemple

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

Exemple de sortie

Exemple de réponse pour la configuration de la collecte de métadonnées

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

Par défaut JMESPath

Une requête JMESPath sera appliquée par défaut à la sortie de cette commande, si l'utilisateur n'en fournit pas une. La requête exacte dépendra du scénario et du format de sortie requis. Vous pouvez voir la condition pour chaque requête JMESPath par défaut dans le tableau suivant :

Si une requête JMESPath personnalisée est fournie, elle remplacera n'importe quel JMESPath dans le tableau ci-dessus.

Options de commande

--name (chaîne)

Nom de la configuration. Obligatoire.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--config-type (chaîne)

Type de configuration de cette configuration : utilisez cet en-tête pour résoudre 300 réponses d'erreur.

Les valeurs autorisées sont les suivantes : 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.

Exemple

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

Options de commande

--name (chaîne)

Nom de la configuration. Obligatoire.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--configuration-patch (mappe générique)

Contenu JSON Merge-Patch pour update_configuration. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --configuration-patch=@path/to/file.json.

--config-type (chaîne)

Type de configuration de cette configuration : utilisez cet en-tête pour résoudre 300 réponses d'erreur.

Les valeurs autorisées sont les suivantes : 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 (chaîne)

Une clé d'API IBM Cloud qui peut créer et gérer des ID de service. Elle doit disposer du rôle de plateforme Editeur pour le service de groupes d'accès et du rôle de plateforme Opérateur pour le service d'identité IAM. Pour plus d'informations, voir la documentation. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 60 caractères. La longueur minimale est de 5 caractères. La valeur doit correspondre à l'expression régulière /^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/.

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

Ce paramètre indique si la configuration de clé d'API est désactivée. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

--private-cert-max-ttl (chaîne)

Durée de vie maximale des certificats créés par cette autorité de certification. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 10 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[0-9]+[s,m,h,d]{0,1}$/.

--private-cert-crl-expiry (chaîne)

Délai d'expiration de la liste de révocation de certificat (CRL). Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 10 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[0-9]+[s,m,h,d]{0,1}$/.

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

Cette zone désactive ou active la génération de la liste de révocation de certificat (CRL). Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

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

Cette zone détermine si les points de distribution de liste de révocation de certificat (CRL) doivent être codés dans les certificats émis par cette autorité de certification. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

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

Cette zone détermine si l'URL du certificat émetteur doit être codée dans les certificats émis par cette autorité de certification. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

--private-cert-allowed-secret-groups (chaîne)

Cette zone permet de limiter la création de certificats privés aux seuls groupes de secrets que vous spécifiez. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 1024 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--private-cert-ttl (chaîne)

Durée de vie demandée pour les certificats créés par cette autorité de certification. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 10 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[0-9]+[s,m,h,d]{0,1}$/.

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

Cette zone indique si 'localhost' doit être inclus comme un des noms usuels demandés. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

--private-cert-allowed-domains (chaîne[])

Domaines à définir pour le modèle de certificat. Cette propriété est utilisée avec les options 'allow_bare_domains' et 'allow_subdomains'. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

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

Cette zone indique si les domaines fournis dans la zone 'allowed_domains' doivent être autorisés à contenir des modèles de liste de contrôle d'accès (ACL). Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les clients doivent être autorisés à demander des certificats privés qui correspondent à la valeur des domaines réels sur le certificat final. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les clients doivent être autorisés à demander des certificats privés portant des noms usuels (CN) qui sont des sous-domaines des noms usuels autorisés par les autres options de modèle de certificat. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les modèles glob doivent être autorisés dans les noms spécifiés dans la zone 'allowed_domains'. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les clients doivent être autorisés à demander un certificat privé correspondant à un nom usuel. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les noms d'hôte valides doivent être appliqués uniquement pour les noms usuels, les noms alternatifs de sujet DNS et la section hôte des adresses e-mail. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les clients doivent être autorisés à demander un certificat privé portant des noms alternatifs de sujet IP. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

--private-cert-allowed-uri-sans (chaîne[])

Noms alternatifs de sujet d'URI à autoriser pour les certificats privés. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

--private-cert-allowed-other-sans (chaîne[])

Identificateur d'objet personnalisé (OID) ou noms alternatifs de sujet au format chaîne UTF8 à autoriser pour les certificats privés. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

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

Cette zone indique si les certificats privés sont marqués pour être utilisés par le serveur. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les certificats privés sont marqués pour être utilisés par le client. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les certificats privés sont marqués pour être utilisés par la signature de code. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

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

Cette zone indique si les certificats privés sont marqués pour la protection d'e-mail. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

--private-cert-private-key-type (chaîne)

Type de clé privée à générer. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les valeurs admises sont: rsa, ec.

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

Nombre de bits à utiliser pour générer la clé privée. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La valeur maximale est de 4096. La valeur minimale est 224.

--private-cert-key-usage (chaîne[])

Contrainte d'utilisation de clé autorisée à définir pour les certificats privés. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /^[a-zA-Z]+$/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

--private-cert-ext-key-usage (chaîne[])

Contrainte d'utilisation de clé étendue autorisée pour les certificats privés. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /^[a-zA-Z]+$/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

--private-cert-ext-key-usage-oids (chaîne[])

Liste des identificateurs d'objet (OID) d'utilisation de clé étendue. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

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

cette zone détermine si le nom usuel (CN) doit être utilisé à partir d'une demande de signature de certificat (CSR). Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

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

cette zone détermine si les noms alternatifs de sujet doivent être utilisés à partir d'une demande de signature de certificat (CSR). Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

--private-cert-subject-organizational-unit (chaîne[])

Valeurs d'unité organisationnelle (OU) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-organization (chaîne[])

Valeurs d'organisation (O) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-country (chaîne[])

Valeurs de pays (C) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-locality (chaîne[])

Valeurs de localité (L) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-province (chaîne[])

Valeurs de province (ST) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-street-address (chaîne[])

Valeurs d'adresse à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-postal-code (chaîne[])

Valeurs de code postal à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-requested-serial-number (chaîne)

Cette zone est obsolète. Vous pouvez ignorer sa valeur. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 64 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[^a-fA-F0-9]/.

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

Cette zone indique si un nom usuel doit être exigé pour créer un certificat privé. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

--private-cert-policy-identifiers (chaîne[])

Liste des identificateurs d'objet de règle (OID). Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

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

Cette zone indique si l'extension de Contraintes de base d'un certificat privé émis doit être marquée comme valide pour les certificats autres que les certificat d'autorité de certification. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

--private-cert-not-before-duration (chaîne)

Durée, en secondes, de l'antidatation de la propriété 'not_before' d'un certificat privé émis. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 10 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[0-9]+[s,m,h,d]{0,1}$/.

--public-cert-lets-encrypt-environment (chaîne)

Configuration de l'environnement d'autorité de certification Let's Encrypt. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

Les valeurs admises sont: production, staging.

--public-cert-lets-encrypt-private-key (chaîne)

Clé privée codée PEM de votre compte Let's Encrypt. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 100000 caractères. La longueur minimale est de 50 caractères. La valeur doit correspondre à l'expression régulière /(^-----BEGIN PRIVATE KEY-----.*?)|(^-----BEGIN RSA PRIVATE KEY-----.*?)/.

--public-cert-lets-encrypt-preferred-chain (chaîne)

Chaîne préférée dont l'émetteur correspond à ce nom usuel de sujet. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 30 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--public-cert-cloud-internet-services-apikey (chaîne)

Une clé d'API IBM Cloud qui peut répertorier les domaines dans votre instance Cloud Internet Services et ajouter des enregistrements DNS. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--cloud-internet-services-crn (chaîne)

Nom CRN qui identifie de manière unique une ressource IBM Cloud. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 512 caractères. La longueur minimale est de 9 caractères. La valeur doit correspondre à l'expression régulière /^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

--public-cert-classic-infrastructure-username (chaîne)

Nom d'utilisateur associé à votre compte d'infrastructure classique. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--public-cert-classic-infrastructure-password (chaîne)

Clé d'API de votre infrastructure classique. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--configuration-task-timeout (chaîne)

Indique le temps maximal autorisé pour qu'une tâche Code Engine soit terminée. Une fois ce temps écoulé, l'état de la tâche passe à Échec. La valeur minimale est de 5 minutes et la valeur maximale est de 24 heures. Le délai d'expiration par défaut d'une tâche est de 10 minutes. La valeur peut être soit un entier indiquant le nombre de secondes, soit la représentation sous forme de chaîne d'une durée, telle que '10m' ou '2h'. Cette option fournit une valeur pour un sous-champ de l'option JSON "configuration-patch". Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 6 caractères. La longueur minimale est de 1 caractères. La valeur doit correspondre à l'expression régulière /^[0-9]+[s,m,h,d]{0,1}$/.

Exemple

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

Options de commande

--name (chaîne)

Nom de la configuration. Obligatoire.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--config-type (chaîne)

Type de configuration de cette configuration : utilisez cet en-tête pour résoudre 300 réponses d'erreur.

Les valeurs autorisées sont les suivantes : 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.

Exemple

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

Options de commande

--name (chaîne)

Nom de la configuration. Obligatoire.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--config-action-prototype (ConfigurationActionPrototype)

Corps de demande permettant de spécifier les propriétés de l'action de création d'une configuration. Cette option JSON peut à la place être fournie en définissant des zones individuelles avec d'autres options. Elle est mutuellement exclusive avec ces options.

Indiquez une option de chaîne JSON ou spécifiez un fichier JSON à lire en fournissant une option de chemin de fichier commençant par un @, par exemple --config-action-prototype=@path/to/file.json.

--config-type (chaîne)

Type de configuration de cette configuration : utilisez cet en-tête pour résoudre 300 réponses d'erreur.

Les valeurs autorisées sont les suivantes : 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 (chaîne)

Type d'action de configuration. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les valeurs admises sont: 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 (chaîne)

Le nom usuel (CN) représente le nom du serveur qui est protégé par le certificat SSL. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 4 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--certificate-alt-names (chaîne[])

La zone de nom alternatif de sujet permet de spécifier des noms d'hôte supplémentaires à protéger par un certificat SSL unique. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /^(.*?)$/. La longueur maximale est de 99 éléments. La longueur minimale est de 0.

--private-cert-ip-sans (chaîne)

Noms alternatifs de sujet IP à définir pour le certificat de l'autorité de certification, dans une liste délimitée par des virgules. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 2048 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--private-cert-uri-sans (chaîne)

Noms alternatifs de sujet d'URI à définir pour le certificat de l'autorité de certification, dans une liste délimitée par des virgules. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 2048 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--private-cert-other-sans (chaîne[])

Identificateur d'objet personnalisé (OID) ou noms alternatifs de sujet au format chaîne UTF8 à définir pour le certificat de l'autorité de certification. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

--private-cert-ttl (chaîne)

Durée de vie (TTL) à affecter à un certificat privé. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 10 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^[0-9]+[s,m,h,d]{0,1}$/.

--private-cert-format (chaîne)

Format des données renvoyées. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les valeurs admises sont: pem, pem_bundle.

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

Longueur maximale du chemin à encoder dans le certificat généré. -1 signifie aucune limite. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

La valeur maximale est de 10. La valeur minimale est -1.

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

Ce paramètre contrôle si le nom usuel est exclu des noms alternatifs de sujet (SAN). Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

--private-cert-permitted-dns-domains (chaîne[])

Domaines ou sous-domaines DNS autorisés pour les certificats qui doivent être signés et émis par ce certificat de l'autorité de certification. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 100 éléments. La longueur minimale est de 0.

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

Ce champ indique s'il faut utiliser les valeurs d'une demande de signature de certificat (CSR) pour effectuer une action private_cert_configuration_action_sign_csr. S'il est défini sur true, alors:

1. Les informations de sujet, y compris les noms et les noms de remplacement, sont conservées dans la demande de signature de certificat plutôt qu'en utilisant les valeurs fournies dans les autres paramètres de cette opération.

2. Toute utilisation de clé, par exemple, la non-répudiation, qui est demandée dans la demande de signature de certificat, est ajoutée à l'ensemble de base des utilisations de clé utilisées pour les certificats de l'autorité de certification signés par l'autorité intermédiaire.

3. Les extensions demandées dans la demande de signature de certificat sont copiées dans le certificat privé émis. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

--private-cert-subject-organizational-unit (chaîne[])

Valeurs d'unité organisationnelle (OU) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-organization (chaîne[])

Valeurs d'organisation (O) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-country (chaîne[])

Valeurs de pays (C) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-locality (chaîne[])

Valeurs de localité (L) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-province (chaîne[])

Valeurs de province (ST) à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-street-address (chaîne[])

Valeurs d'adresse à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-subject-postal-code (chaîne[])

Valeurs de code postal à définir dans la zone d'objet du certificat résultant. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

Les éléments de liste doivent correspondre à l'expression régulière /(.*?)/. La longueur maximale est de 10 éléments. La longueur minimale est de 0.

--private-cert-serial-number (chaîne)

Valeur demandée pour l'attribut serialNumber ( https://datatracker.ietf.org/doc/html/rfc4519#section-2.31 ) qui figure dans le nom distinctif (DN) du certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

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 (chaîne)

Demande de signature de certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 4096 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/.

--config-action-intermediate-certificate-authority (chaîne)

Le nom de la configuration de l'autorité de certification intermédiaire. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 128 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--imported-cert-certificate (chaîne)

Contenu codé PEM de votre certificat. Cette option fournit une valeur pour une sous-zone de l'option JSON'config-action-prototype'. Elle est mutuellement exclusive avec cette option.

La longueur maximale est de 100000 caractères. La longueur minimale est de 50 caractères. La valeur doit correspondre à l'expression régulière /(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/.

Exemples

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

Des options granulaires sont également disponibles pour les sous-zones des options de chaîne 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

Options de commande

--event-notifications-instance-crn (chaîne)

Nom CRN qui identifie de manière unique une ressource IBM Cloud. Obligatoire.

La longueur maximale est de 512 caractères. La longueur minimale est de 9 caractères. La valeur doit correspondre à l'expression régulière /^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

--event-notifications-source-name (chaîne)

Nom affiché en tant que source dans votre instance Event Notifications. Obligatoire.

La longueur maximale est de 256 caractères. La longueur minimale est de 2 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

--event-notifications-source-description (chaîne)

Description facultative de la source qui se trouve dans votre instance Event Notifications.

La longueur maximale est de 1024 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /(.*?)/.

Exemple

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

Exemple de sortie

Exemple de détails de configuration d'enregistrement de notifications pour Event Notifications.

{
  "event_notifications_instance_crn" : "crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::"
}

Exemple

ibmcloud secrets-manager notifications-registration

Exemple de sortie

Exemple de détails de configuration d'enregistrement de notifications pour Event Notifications.

{
  "event_notifications_instance_crn" : "crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::"
}

Exemple

ibmcloud secrets-manager notifications-registration-delete

Exemple

ibmcloud secrets-manager notifications-registration-test