Commandes d'interface de ligne de commande Vault

Vous pouvez utiliser l'interface de ligne de commande (CLI) de HashiCorp Vault pour interagir avec IBM Cloud® Secrets Manager.

Secrets Manager utilise HashiCorp Vault avec une prise en charge supplémentaire de la méthode IBM Cloud IAM auth et un ensemble de moteurs de secret pour prendre en charge les opérations dans Secrets Manager pour différents types de secret.

Avant de commencer, configurez l'interface de ligne de commande Vault afin de pouvoir accéder à votre instance Secrets Manager à l'aide des commandes Vault. Pour en savoir plus sur l'utilisation de l'interface de commande de Vault, consultez la documentation de Vault.

Configurer un jeton de connexion

Utilisez cette commande pour configurer la durée de vie (TTL) et le cycle de vie (MaxTTL) d'un jeton de connexion Vault.

vault write auth/ibmcloud/manage/login [token_ttl=DURATION] [token_max_ttl=MAX_DURATION]

Prérequis

Vous devez utiliser le rôle de service Manager pour gérer la configuration des jetons de connexion.

Options de commande

token_ttl: Durée de vie initiale (TTL) du jeton de connexion à générer. La valeur par défaut est 1h.
token_max_ttl: Cycle de vie maximal du jeton de connexion. La valeur par défaut est 24h. Cette valeur ne peut pas dépasser la valeur MaxLeaseTTL Vault.

Exemples

Configurez un jeton de connexion Vault en entrant 30m pour la durée initiale de vie et 2h pour la durée de vie maximale.

vault write auth/ibmcloud/manage/login token_ttl=30m token_max_ttl=2h

Sortie

La commande génère la sortie suivante :

Success! Data written to: auth/ibmcloud/manage/login

Afficher la configuration d'un jeton

Utilisez cette commande pour afficher la configuration d'un jeton de connexion Vault.

vault read [-format=FORMAT] auth/ibmcloud/manage/login

Prérequis

Vous devez utiliser le rôle de service Manager pour gérer la configuration des jetons de connexion.

Options de commande

-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Affichez la configuration de connexion d'un jeton Vault au format JSON.

vault read -format=json auth/ibmcloud/manage/login

Sortie

La commande génère la sortie suivante :

{
    "request_id": "4dec6b8a-a277-0755-617c-97e40bcc7c3e",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "login": {
        "token_max_ttl": "2h0m0s",
        "token_ttl": "30m0s"
    }
    },
    "warnings": null
}

Groupes de secrets

Créer un groupe de secrets

Utilisez cette commande pour créer un groupe de secrets.

vault write [-format=FORMAT] auth/ibmcloud/manage/groups name=NAME [description="DESCRIPTION"]

Prérequis

Vous avez besoin du rôle de service Manager pour créer des groupes de secrets.

Options de commande

nom: Alias lisible que vous souhaitez affecter au groupe de secrets. Obligatoire.
description: Description étendue du groupe de secrets.
-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Créez un groupe de secrets avec un nom et une description.

vault write auth/ibmcloud/manage/groups name="my-secret-group" description="A group of secrets."

Sortie

La commande génère la sortie suivante :

Key            Value
---            -----
created_at     2020-10-05T17:43:49Z
description    A group of secrets.
id             9c6d20ad-779e-27c5-3842-2a20b19abfcf
name           my-secret-group
type           application/vnd.ibm.secrets-manager.secret.group+json
updated_at     n/a

Répertorier les groupes de secrets

Cette commande permet de répertorier les groupes de secrets disponibles dans votre instance Secrets Manager.

vault read [-format=FORMAT] auth/ibmcloud/manage/groups

Prérequis

Vous avez besoin du rôle de service Reader pour créer des groupes de secrets.

Options de commande

-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Extrayez une liste de groupes de secrets au format JSON.

vault read -format=json auth/ibmcloud/manage/groups

Sortie

La commande génère la sortie suivante :

{
    "request_id": "62051bde-9703-101c-a328-90a377a8bb77",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "groups": [
        {
        "created_at": "2020-10-05T17:43:49Z",
        "description": "A group of secrets.",
        "id": "9c6d20ad-779e-27c5-3842-2a20b19abfcf",
        "name": "my-secret-group",
        "type": "application/vnd.ibm.secrets-manager.secret.group+json",
        "updated_at": ""
        }
    ]
    },
    "warnings": null
}

Obtenir un groupe de secrets

Utilisez cette commande pour obtenir les détails d'un groupe de secrets.

vault read [-format=FORMAT] auth/ibmcloud/manage/groups/SECRET_GROUP_ID

Prérequis

Vous avez besoin du rôle de service Reader pour obtenir les détails d'un groupe de secrets.

Options de commande

-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Obtenez les détails d'un groupe de secrets spécifiques au format JSON.

vault read -format=json auth/ibmcloud/manage/groups/9c6d20ad-779e-27c5-3842-2a20b19abfcf

Sortie

La commande génère la sortie suivante :

{
    "request_id": "ab6b22d9-8e42-d23f-31d8-a4865b5a40e7",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "created_at": "2020-10-05T17:43:49Z",
    "description": "A group of secrets.",
    "id": "9c6d20ad-779e-27c5-3842-2a20b19abfcf",
    "name": "my-secret-group",
    "type": "application/vnd.ibm.secrets-manager.secret.group+json",
    "updated_at": ""
    },
    "warnings": null
}

Mettre à jour un groupe de secrets

Utilisez cette commande pour mettre à jour un groupe de secrets.

vault write [-format=FORMAT] auth/ibmcloud/manage/groups/SECRET_GROUP_ID name=NAME [description="DESCRIPTION"]

Prérequis

Vous avez besoin du rôle de service Manager pour mettre à jour des groupes de secrets.

Options de commande

nom: Alias lisible que vous souhaitez affecter au groupe de secrets. Obligatoire.
description: Description étendue du groupe de secrets.
-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Mettez à jour le nom et la description d'un groupe de secrets.

vault write auth/ibmcloud/manage/groups/9c6d20ad-779e-27c5-3842-2a20b19abfcf name="my-updated-secret-group" description="An updated group of secrets."

Sortie

La commande génère la sortie suivante :

Key            Value
---            -----
created_at     2020-10-05T17:43:49Z
description    An updated group of secrets.
id             9c6d20ad-779e-27c5-3842-2a20b19abfcf
name           my-updated-secret-group
type           application/vnd.ibm.secrets-manager.secret.group+json
updated_at     2020-10-05T17:56:56Z

Supprimer un groupe de secrets

Utilisez cette commande pour supprimer un groupe de secrets.

vault delete auth/ibmcloud/manage/groups/SECRET_GROUP_ID

Prérequis

Vous avez besoin du rôle de service Manager pour supprimer des groupes de secrets.

Exemples

Supprimez un groupe de secrets par l'ID qui lui a été attribué.

vault delete auth/ibmcloud/manage/groups/9c6d20ad-779e-27c5-3842-2a20b19abfcf

Sortie

La commande génère la sortie suivante :

Success! Data deleted (if it existed) at: auth/ibmcloud/manage/groups/9c6d20ad-779e-27c5-3842-2a20b19abfcf

Secrets statiques

Créer un secret

Utilisez les commandes suivantes pour ajouter un secret statique, tel que des informations d'identification utilisateur ou un secret arbitraire, à votre instance Secrets Manager. Les valeurs admises pour SECRET_TYPE sont: arbitrary,imported_cert, kv, private_cert, public_certet username_password.

Créez un secret dans le groupe de secrets default.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/secrets name=NAME [description="DESCRIPTION"] [username=USERNAME] [password=USERNAME] [payload=DATA] [expiration_date=EXPIRATION] [certificate=CERTIFICATE_DATA] [private_key=PRIVATE_KEY_DATA] [intermediate=INTERMEDIATE_CERTIFICATE_DATA] [ca=CA_CONFIGURATION_NAME] [dns=DNS_CONFIGURATION_NAME] [key_algorithm=KEY_ALGORITHM] [labels=LABEL,LABEL]

Créez un secret dans un groupe de secrets spécifié.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/secrets/groups/SECRET_GROUP_ID name=NAME [description="DESCRIPTION"] [username=USERNAME] [password=USERNAME] [payload=DATA] [expiration_date=EXPIRATION] [certificate=CERTIFICATE_DATA] [private_key=PRIVATE_KEY_DATA] [intermediate=INTERMEDIATE_CERTIFICATE_DATA] [ca=CA_CONFIGURATION_NAME] [dns=DNS_CONFIGURATION_NAME] [key_algorithm=KEY_ALGORITHM] [labels=LABEL,LABEL]

Prérequis

Vous avez besoin du rôle de service Writer pour créer des secrets.

Options de commande

nom: Alias lisible que vous souhaitez affecter au secret. Obligatoire.
description: Une description étendue à affecter au secret.
expiration_date: Date d'expiration à affecter au secret. Pris en charge pour les secrets de type arbitrary et username_password. Le format de date suit RFC 3339.
labels: Les libellés que vous pouvez utiliser pour regrouper et rechercher des secrets similaires dans votre instance.
payload: Les données que vous souhaitez stocker pour les secrets arbitrary ou kv . Seules les contenus basés sur du texte sont prises en charge pour les secrets arbitrary . Le moteur de secrets clé-valeur peut stocker des secrets au format JSON complexe. Avec votre secret clé-valeur, vous pouvez intégrer des outils compatibles avec les commandes CLI HashiCorp Vault KV (Version 2). En savoir plus sur Gestion des secrets clé-valeur avec l'interface de ligne de commande Vault.
nom d'utilisateur: Nom d'utilisateur que vous souhaitez affecter à un secret username_password.
Mot de passe: Mot de passe que vous souhaitez affecter à un secret username_password.
certificat: Données de certificat que vous souhaitez stocker pour un secret imported_cert. Le type de fichier pris en charge est .pem.
private_key: Les données de clé privée à stocker pour un secret imported_cert. Le type de fichier pris en charge est .pem.
intermediate: Données de certificat intermédiaire à stocker pour un secret imported_cert. Le type de fichier pris en charge est .pem.
ca: La configuration de l'autorité de certification à utiliser pour la commande d'un secret public_cert.
dns: La configuration du fournisseur DNS à utiliser pour la commande d'un secret public_cert.
key_algorithm: L'algorithme de clé à utiliser pour la signature et l'émission d'un secret public_cert. Les valeurs admises sont les suivantes: RSA2048, RSA4096, ECDSA256, ECDSA384
Modèle_Certificat: Modèle de certificat à utiliser pour la création d'un secret private_cert .
common_name: Nom commun à utiliser pour la création d'un secret private_cert . Selon le modèle de certificat choisi, certaines restrictions du nom usuel de votre certificat privé peuvent s'appliquer.
-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Créez les données d'identification d'un utilisateur avec une date d'expiration et deux étiquettes.

vault write -format=json ibmcloud/username_password/secrets name="my-test-user-credential" expiration_date="2020-12-31T23:59:59Z" username="user123" password="window-steel-dogs-coffee" labels=label-1,label-2

Créez un secret arbitraire avec une date d'expiration et deux étiquettes.

vault write -format=json ibmcloud/arbitrary/secrets name="my-test-arbitrary-secret" expiration_date="2020-12-31T23:59:59Z" payload="this is my secret data" labels=label-1,label-2

Créez un secret arbitraire ayant du contenu binaire.

base64 -w0 <filename> | vault write ibmcloud/arbitrary/secrets name="my-test-arbitrary-secret" payload=- labels="encode:base64"

Importez un certificat SSL/TLS avec une clé privée correspondante.

vault write -format=json ibmcloud/imported_cert/secrets name="my-test-imported-certificate" certificate=@cert.pem private_key=@key.pem

Commandez un certificat SSL/TLS public en spécifiant une autorité de certification et une configuration de fournisseur DNS.

vault write -format=json ibmcloud/public_cert/secrets name="my-test-public-certificate" ca="my-configured-certificate-authority" dns="my-configured-dns-provider" common_name="example.com" key_algorithm=RSA2048

Créez un certificat SSL/TLS privé en spécifiant le modèle de certificat à utiliser.

vault write -format=json ibmcloud/private_cert/secrets name="my-test-private-certificate" certificate_template="my-configured-certificate-template" common_name="example.com"

Créez un ensemble de données d'identification de service en spécifiant le CRN de l'instance de service source et le nom de rôle de service IAM.

vault write -format=json ibmcloud/service_credentials/secrets name="test-sc-1" source_crn="crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675cc::" role="crn:v1:bluemix:public:iam::::serviceRole:Manager"

Sortie

La commande de création d'un secret username_password renvoie la sortie suivante :

{
    "request_id": "c8edf459-cc26-d3f9-19e4-a24d899573f4",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
    "creation_date": "2020-10-05T21:52:29Z",
    "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e:secret:a6067f1c-98cf-9379-6188-a94a58222f5d",
    "expiration_date": "2020-12-31T23:59:59Z",
    "id": "a6067f1c-98cf-9379-6188-a94a58222f5d",
    "labels": [
        "label-1",
        "label-2"
    ],
    "last_update_date": "2020-10-05T21:52:29Z",
    "name": "my-test-user-credential",
    "secret_data": {
        "password": "window-steel-dogs-coffee",
        "username": "user123"
    },
    "secret_type": "USERNAME_PASSWORD",
    "state": 1,
    "state_description": "Active",
    "versions": [
        {
        "auto_rotated": false,
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
        "creation_date": "2020-10-05T21:52:29Z",
        "id": "f53b8061-359e-3236-5bcc-fb120e170c87"
        }
    ]
    },
    "warnings": null
}

La commande de création d'un secret arbitrary renvoie la sortie suivante :

{
    "request_id": "56f8532d-cd2b-372c-7b14-5a5875d1c6e6",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
    "creation_date": "2020-10-05T21:47:27Z",
    "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e:secret:2ca56a3b-a6e8-d2e2-5377-b6559babfac0",
    "expiration_date": "2020-12-31T23:59:59Z",
    "id": "2ca56a3b-a6e8-d2e2-5377-b6559babfac0",
    "labels": [
        "label-1",
        "label-2"
    ],
    "last_update_date": "2020-10-05T21:47:27Z",
    "name": "my-test-arbitrary-secret",
    "secret_data": {
        "payload": "this is my secret data"
    },
    "secret_type": "ARBITRARY",
    "state": 1,
    "state_description": "Active",
    "versions": [
        {
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
        "creation_date": "2020-10-05T21:47:27Z",
        "id": "88473a6c-4877-5079-f999-c9a39e3407ea"
        }
    ]
    },
    "warnings": null
}

La commande d'importation d'un secret imported_cert renvoie la sortie suivante :

{
    "request_id": "7b41ad30-8098-9f57-62cf-bd757d43238f",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "algorithm": "RSA",
    "common_name": "example.com",
    "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
    "creation_date": "2021-06-03T22:41:56Z",
    "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e:secret:2ca56a3b-a6e8-d2e2-5377-b6559babfac0",
    "expiration_date": "2021-06-04T15:25:44Z",
    "id": "2ca56a3b-a6e8-d2e2-5377-b6559babfac0",
    "intermediate_included": false,
    "issuer": "US Texas Austin Example Corp. Example Org example.com",
    "key_algorithm": "SHA256-RSA",
    "labels": [],
    "last_update_date": "2021-06-03T22:41:56Z",
    "name": "my-test-imported-certificate",
    "private_key_included": false,
    "secret_type": "imported_cert",
    "serial_number": "fc:22:29:7e:57:25:8a:05",
    "state": 1,
    "state_description": "Active",
    "validity": {
        "not_after": "2021-06-04T15:25:44Z",
        "not_before": "2021-06-03T15:25:44Z"
    },
    "versions": [
        {
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
        "creation_date": "2021-06-03T22:41:56.354781389Z",
        "expiration_date": "2021-06-04T15:25:44Z",
        "id": "2fae17bf-106a-1c31-55d9-e642ee3803ae",
        "serial_number": "fc:22:29:7e:57:25:8a:05",
        "validity": {
          "not_after": "2021-06-04T15:25:44Z",
          "not_before": "2021-06-03T15:25:44Z"
        }
        }
    ]
    },
    "warnings": null
}

La commande permettant de commander un secret public_cert renvoie la sortie suivante :

{
    "request_id": "64824dec-c53e-8e49-dbe7-6c44c0dcd7a0",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "alt_names": [],
        "common_name": "example.com",
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
        "creation_date": "2021-10-08T03:25:51Z",
        "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e:secret:2ca56a3b-a6e8-d2e2-5377-b6559babfac0",
        "downloaded": false,
        "id": "2c08d55d-1854-4dbd-9c25-bcd26828fe77",
        "issuance_info": {
            "auto_rotated": false,
            "bundle_certs": true,
            "ca": "my-configured-certificate-authority",
            "dns": "my-configured-dns-provider",
            "ordered_on": "2021-10-08T03:25:51Z",
            "state": 0,
            "state_description": "Pre-activation"
        },
        "key_algorithm": "RSA2048",
        "labels": [],
        "last_update_date": "2021-10-08T03:25:51Z",
        "name": "my-test-public-certificate",
        "rotation": {
            "auto_rotate": false,
            "rotate_keys": false
        },
        "secret_type": "public_cert",
        "state": 0,
        "state_description": "Pre-activation",
        "versions": [],
        "versions_total": 1
    },
    "warnings": null
}

La commande de création d'un secret private_cert renvoie la sortie suivante :

{
  "request_id": "7c72b7a6-0342-508a-1684-9625e11555db",
  "lease_id": "",
  "lease_duration": 0,
  "renewable": false,
  "data": {
    "algorithm": "SHA256-RSA",
    "alt_names": [
      "example.com"
    ],
    "certificate_authority": "my-configured-intermediate-ca",
    "certificate_template": "my-configured-template",
    "common_name": "example.com",
    "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
    "creation_date": "2022-05-03T18:18:43Z",
    "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e:secret:2ca56a3b-a6e8-d2e2-5377-b6559babfac0",
    "downloaded": true,
    "expiration_date": "2022-06-04T18:18:43Z",
    "id": "2c08d55d-1854-4dbd-9c25-bcd26828fe77",
    "issuer": "example.com",
    "key_algorithm": "RSA2048",
    "labels": [],
    "last_update_date": "2022-05-03T18:18:43Z",
    "name": "my-test-private-certificate",
    "rotation": {
      "auto_rotate": false
    },
    "secret_data": {
      "ca_chain": [
        "-----BEGIN CERTIFICATE-----\nMIIGZjCCBU6gAwIBAgIUHTgL...(truncated)"
      ],
      "certificate": "-----BEGIN CERTIFICATE-----\nMIIDJDCCAgygAwIBAgIUarx9...(truncated)",
      "issuing_ca": "-----BEGIN CERTIFICATE-----\nMIIGZjCCBU6gAwIBAgIUHTgLW...(truncated)",
      "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAtirEhptl3...(truncated)"
    },
    "secret_type": "private_cert",
    "serial_number": "6a:bc:7d:63:2a:7c:60:90:00:53:d9:ae:83:b2:1d:bc:97:ae:fb:f1",
    "state": 1,
    "state_description": "Active",
    "validity": {
      "not_after": "2022-06-04T18:18:43Z",
      "not_before": "2022-05-03T18:18:14Z"
    },
    "versions": [
      {
        "auto_rotated": false,
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
        "creation_date": "2022-05-03T18:18:14Z",
        "downloaded": true,
        "expiration_date": "2022-06-04T18:18:43Z",
        "id": "2c08d55d-1854-4dbd-9c25-bcd26828fe77",
        "payload_available": true,
        "serial_number": "6a:bc:7d:63:2a:7c:60:90:00:53:d9:ae:83:b2:1d:bc:97:ae:fb:f1",
        "state": 1,
        "state_description": "Active",
        "validity": {
          "not_after": "2022-06-04T18:18:43Z",
          "not_before": "2022-05-03T18:18:14Z"
        }
      }
    ],
    "versions_total": 1
  },
  "warnings": null
}

La commande de création d'un secret service-credentials renvoie la sortie suivante :

{
  "request_id": "13ee6f56-c91f-180c-8fc1-b4da6ac2817f",
  "lease_id": "",
  "lease_duration": 0,
  "renewable": false,
  "data": {
    "created_by": "IBMid-2700062DAH",
    "creation_date": "2023-11-23T08:27:15Z",
    "crn": "crn:v1:staging:public:secrets-manager:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:e2c32ad4-1414-41e0-8747-e107e6b9f8d6:secret:3c89e3ed-31fb-06f7-387b-c972213c89ee",
    "custom_metadata": {},
    "downloaded": true,
    "iam_apikey_description": "Auto-generated for key crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675bc:resource-key:ada7d881-1af3-484c-8e79-4e071d9e1a7d",
    "iam_apikey_id": "ApiKey-df88649d-5198-4ca5-884f-856a1b83031a",
    "iam_apikey_name": "test-sc-1",
    "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
    "iam_serviceid_crn": "crn:v1:staging:public:iam-identity::a/826aa2b9cab6c666477fc55ebc47bafc::serviceid:ServiceId-40052fad-55a4-4090-ab9e-64877964a3bc",
    "id": "3c89e3ed-31fb-06f7-387b-c972213c89be",
    "labels": [],
    "last_update_date": "2023-11-23T08:27:15Z",
    "locks_total": 0,
    "name": "test-sc-1",
    "parameters": {},
    "resource_key_crn": "crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675cc:resource-key:ada7d881-1af3-484c-8e79-4e071d9e1a7e",
    "resource_key_name": "test-sc-1",
    "role": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
    "secret_data": {
      "apikey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "guid": "f85409e9-1a06-47d5-8320-95ed4e1675bc",
      "iam_apikey_description": "Auto-generated for key crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675cc:resource-key:ada7d881-1af3-484c-8e79-4e071d9e1a7e",
      "iam_apikey_id": "ApiKey-df88649d-5198-4ca5-884f-856a1b83031a",
      "iam_apikey_name": "test-sc-1",
      "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
      "iam_serviceid_crn": "crn:v1:staging:public:iam-identity::a/826aa2b9cab6c666477fc55ebc47bafc::serviceid:ServiceId-40052fad-55a4-4090-ab9e-64877964a3cc",
      "instance_id": "f85409e9-1a06-47d5-8320-95ed4e1675cc",
      "plan": "33b50df2-9cd6-4005-a941-bf0a59f0d183",
      "region": "us-south"
    },
    "secret_type": "service_credentials",
    "source_crn": "crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675cc::",
    "state": 1,
    "state_description": "Active",
    "ttl": 0,
    "versions": [
      {
        "created_by": "IBMid-3242342DAH",
        "creation_date": "2023-11-23T08:27:15Z",
        "downloaded": true,
        "id": "34f934a3-def7-71e0-cc93-9c754879f2f8",
        "payload_available": true,
        "version_custom_metadata": {}
      }
    ],
    "versions_total": 1
  },
  "warnings": null
}

Répertorier les secrets

Utilisez les commandes suivantes pour répertorier les secrets statiques dans votre instance Secrets Manager. Les valeurs autorisées pour SECRET_TYPE sont : arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, custom_credentials, et username_password.

Répertorier les secrets par type.

vault read [-format=FORMAT] ibmcloud/SECRET_TYPE/secrets

Répertoriez les secrets par groupe de secrets.

vault read [-format=FORMAT] ibmcloud/SECRET_TYPE/secrets/groups/ID

Prérequis

Vous avez besoin du rôle de service Reader pour répertorier des secrets.

Options de commande

-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Extrayez une liste des secrets des données d'identification utilisateur disponibles dans le groupe de secrets default.

vault read -format=json ibmcloud/username_password/secrets

Extrayez une liste de secrets arbitraires qui sont affectés à un groupe de secrets spécifié.

vault read -format=json ibmcloud/arbitrary/secrets/groups/9ab2250f-a369-4e07-ade7-d417d63ad587

Sortie

La commande génère la sortie suivante :

{
    "request_id": "65689e3a-7cc6-990e-4f0e-8480edd244ed",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "secrets": [
        {
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
        "creation_date": "2020-10-06T05:31:05Z",
        "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e:secret:1cf95413-4c10-a5fa-e824-b5106375b129",
        "expiration_date": "2020-12-31T23:59:59Z",
        "id": "1cf95413-4c10-a5fa-e824-b5106375b129",
        "labels": [],
        "last_update_date": "2020-10-06T05:31:05Z",
        "name": "my-test-arbitrary-secret",
        "secret_group_id": "9ab2250f-a369-4e07-ade7-d417d63ad587",
        "secret_type": "ARBITRARY",
        "state": 1,
        "state_description": "Active"
        },
        {
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
        "creation_date": "2020-10-06T03:54:26Z",
        "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e:secret:285d83ce-4a26-c5c3-8e58-48d3140a2415",
        "id": "285d83ce-4a26-c5c3-8e58-48d3140a2415",
        "labels": [],
        "last_update_date": "2020-10-06T03:54:26Z",
        "name": "another-test-arbitrary-secret",
        "secret_group_id": "9ab2250f-a369-4e07-ade7-d417d63ad587",
        "secret_type": "ARBITRARY",
        "state": 1,
        "state_description": "Active"
        }
    ],
    "secrets_total": 2
    },
    "warnings": null
}

Si les secrets appartiennent à un groupe de secrets, la valeur data.secrets.secret_group_id est incluse dans la réponse pour identifier l'affectation au groupe de secrets.

Obtenir un secret

Utilisez les commandes suivantes pour extraire un secret et ses détails. Les valeurs autorisées pour SECRET_TYPE sont : arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, custom_credentials, et username_password. L'ID de secret ou le nom de secret peut être utilisé pour extraire le secret.

Obtenir un secret.

vault read [-format=FORMAT] ibmcloud/SECRET_TYPE/secrets/SECRET_ID_OR_SECRET_NAME

Récupérez un secret qui est affecté à un groupe secret spécifié.

vault read [-format=FORMAT] ibmcloud/SECRET_TYPE/secrets/groups/SECRET_GROUP_ID/SECRET_ID_OR_SECRET_NAME

Prérequis

Vous avez besoin du rôle de service SecretsReader ou Writer pour extraire des secrets.

Options de commande

-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Extrayez un secret arbitraire, y compris son contenu.

Extraction par ID secret

vault read -format=json ibmcloud/arbitrary/secrets/71539dff-9e84-804a-debb-ab3eb3d8afce

Extraction par nom de secret

vault read -format=json ibmcloud/arbitrary/secrets/my-test-arbitrary-secret

Sortie

La commande génère la sortie suivante :

{
    "request_id": "025df8ac-b926-6153-3f5b-cd2364b5f85e",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
    "creation_date": "2020-10-20T16:55:41Z",
    "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e:secret:71539dff-9e84-804a-debb-ab3eb3d8afce",
    "id": "71539dff-9e84-804a-debb-ab3eb3d8afce",
    "labels": [],
    "last_update_date": "2020-10-20T16:55:41Z",
    "name": "my-test-arbitrary-secret",
    "secret_data": {
        "payload": "This is the data for my secret."
    },
    "secret_type": "ARBITRARY",
    "state": 1,
    "state_description": "Active",
    "versions": [
        {
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
        "creation_date": "2020-10-20T16:55:41Z",
        "id": "cc2c795e-0072-8074-9824-b6efd5050232"
        }
    ]
    },
    "warnings": null
}

Mettre à jour un secret

Utilisez cette commande pour mettre à jour les métadonnées d'un secret, telles que son nom ou sa description. Les valeurs autorisées pour SECRET_TYPE sont : arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, custom_credentials, et username_password.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/secrets/SECRET_ID/metadata name=NAME [description="DESCRIPTION"][expiration_date=EXPIRATION] [labels=LABEL,LABEL]

Prérequis

Vous avez besoin du rôle de service Writer pour mettre à jour des secrets.

Options de commande

nom: Alias lisible que vous souhaitez affecter au secret.
description: Une description étendue à affecter au secret.
expiration_date: Date d'expiration à affecter au secret. Le format de date suit RFC 3339.
labels: Les libellés que vous pouvez utiliser pour regrouper et rechercher des secrets similaires dans votre instance.
-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Mettez à jour le nom d'un secret arbitraire.

vault write -format=json ibmcloud/arbitrary/secrets/fe874c2b-e8fd-bbb6-9f19-e91bbe744735/metadata name="updated-name-arbitrary-secret"

Mettez à jour le nom d'un secret de données d'identification de service.

vault write -format=json ibmcloud/service_credentials/secrets/3c89e3ed-31fb-06f7-387b-c972213c89be/metadata name="updated-name-sc-secret"

Sortie

La commande arbitraire renvoie le résultat suivant :

{
    "request_id": "f361132f-a0e3-eab0-52b8-4d992074b411",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
    "creation_date": "2020-10-22T14:26:44Z",
    "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e:secret:fe874c2b-e8fd-bbb6-9f19-e91bbe744735",
    "id": "fe874c2b-e8fd-bbb6-9f19-e91bbe744735",
    "labels": [],
    "last_update_date": "2020-10-22T14:54:25Z",
    "name": "updated-name-arbitrary-secret",
    "secret_type": "ARBITRARY",
    "state": 1,
    "state_description": "Active"
    },
    "warnings": null
}

La commande service credentials renvoie le résultat suivant :

{
  {
  "request_id": "62f4f088-0588-51ec-3389-da83b4c34a6a",
  "lease_id": "",
  "lease_duration": 0,
  "renewable": false,
  "data": {
    "created_by": "IBMid-2723462DAH",
    "creation_date": "2023-11-23T08:27:15Z",
    "crn": "crn:v1:staging:public:secrets-manager:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:e2c32ad4-1414-41e0-8747-e107e6b9f8e6:secret:3c89e3ed-31fb-06f7-387b-c972213c89be",
    "custom_metadata": {},
    "downloaded": false,
    "iam_apikey_description": "Auto-generated for key crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675cc:resource-key:ada7d881-1af3-484c-8e79-4e071d9e1a7e",
    "iam_apikey_id": "ApiKey-df88649d-5198-4ca5-884f-856a1b83031a",
    "iam_apikey_name": "test-sc-1",
    "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
    "iam_serviceid_crn": "crn:v1:staging:public:iam-identity::a/826aa2b9cab6c666477fc55ebc47bafc::serviceid:ServiceId-40052fad-55a4-4090-ab9e-64877964a3ac",
    "id": "3c89e3ed-31fb-06f7-387b-c972213c89be",
    "labels": [],
    "last_update_date": "2023-11-23T08:48:20Z",
    "locks_total": 0,
    "name": "updated-name-sc-secret",
    "parameters": {},
    "resource_key_crn": "crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675cc:resource-key:ada7d881-1af3-484c-8e79-4e071d9e1a7e",
    "resource_key_name": "test-sc-1",
    "role": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
    "secret_type": "service_credentials",
    "source_crn": "crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675cc::",
    "state": 1,
    "state_description": "Active",
    "ttl": 0,
    "versions_total": 2
  },
  "warnings": null
}

Mise à jour d'une version de secret

Cette commande permet de mettre à jour une version spécifique d'un secret.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/secrets/SECRET_ID/versionins/VERSION_ID/metadata
{                                   
        "version_custom_metadata": {              
             "metadata_custom_key": "metadata_custom_value"
        }
}

Exemples

vault write -format=json ibmcloud/service_credentials/secrets/1a3f9fbc-58d4-ac68-7984-f422d8b8112a/versions/38a361c8-51a2-6fc4-1ed8-d59747db5847/metadata
{                                   
        "version_custom_metadata": {              
             "metadata_custom_key": "metadata_custom_value"
        }
}

{ :pre}

Sortie

{
  "request_id": "8a395155-01eb-be57-e73d-53a9bbe09139",
  "lease_id": "",
  "lease_duration": 0,
  "renewable": false,
  "data": {
    "auto_rotated": false,
    "created_by": "IBMid-2723462DAH",
    "creation_date": "2023-11-23T10:19:45Z",
    "crn": "crn:v1:staging:public:secrets-manager:us-south:a/826aa2b9cab6c666477fc55ebc47bafd:e2c32ad4-1414-41e0-8747-e107e6b9f8d7:secret:1a3f9fbc-58d4-ac68-7984-f422d8b8112a",
    "expiration_date": "2023-12-03T10:19:45Z",
    "id": "1a3f9fbc-58d4-ac68-7984-f422d8b8112a",
    "payload_available": true,
    "resource_key_crn": "crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafd:f85409e9-1a06-47d5-8320-95ed4e1675bd:resource-key:496acdc2-792c-4425-8172-32fcd5cddaca",
    "resource_key_name": "test-sc-1",
    "version_custom_metadata": {
      "metadata_custom_key": "metadata_custom_value"
    },
    "version_id": "38a361c8-51a2-6fc4-1ed8-d59747db5847"
  },
  "warnings": null
}

Appliquer une rotation à un secret

Utilisez cette commande pour appliquer une rotation à un secret. Les valeurs autorisées pour SECRET_TYPE sont : arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, custom_credentials, et username_password.

vault write [-format=FORMAT] [-force] ibmcloud/SECRET_TYPE/secrets/SECRET_ID/rotate [payload="SECRET_DATA"] [password=PASSWORD] [certificate=CERTIFICATE_DATA] [private_key=PRIVATE_KEY_DATA] [intermediate=INTERMEDIATE_CERTIFICATE_DATA]

Prérequis

Vous avez besoin du rôle de service Writer pour la rotation des secrets.

Options de commande

payload: Nouvelles données à stocker pour un secret arbitrary. Seuls les contenus basés sur du texte sont pris en charge. Si vous devez stocker un fichier binaire, veillez à l'encodr avec base64avant de le sauvegarder dans Secrets Manager. Pour plus d'informations, voir Exemples.
Mot de passe: Le nouveau mot de passe à affecter à un secret username_password.
certificat: Nouvelles données du certificat à stocker pour un secret imported_cert. Le type de fichier pris en charge est .pem.
private_key: Les nouvelles données de clé privée à stocker pour un secret imported_cert. Le type de fichier pris en charge est .pem.
intermediate: Les nouvelles données de certificat intermédiaire à stocker pour un secret imported_cert. Le type de fichier pris en charge est .pem.
-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.
force: Remplace le mot de passe stocké pour un secret username_password par un mot de passe de 32 caractères généré au hasard qui contient des lettres majuscules, des lettres minuscules, des chiffres et des symboles.

Exemples

Appliquez manuellement une rotation aux données du secret qui sont stockées pour un secret arbitraire.

vault write -format=json ibmcloud/arbitrary/secrets/fe874c2b-e8fd-bbb6-9f19-e91bbe744735/rotate payload="Updated secret data."

Effectuez manuellement la rotation du mot de passe stocké pour un secret username_password.

vault write -format=json ibmcloud/username_password/secrets/cb32abc1-2a4b-e0fd-f403-233e5249e130/rotate password="my-updated-password"

Remplacez le mot de passe stocké pour un secret username_password par un mot de passe de 32 caractères généré aléatoirement.

vault write -format=json -force ibmcloud/username_password/secrets/cb32abc1-2a4b-e0fd-f403-233e5249e130/rotate

Rotation d'un ensemble de références de service.

vault write -format=json -force ibmcloud/service_credentials/secrets/3c89e3ed-31fb-06f7-387b-c972213c89be/rotate

Sortie

La commande de rotation manuelle d'un secret username_password avec un mot de passe fourni par l'utilisateur renvoie la sortie suivante :

{
    "request_id": "9cb258e5-fbc9-7a37-f8c9-c5ab1dd7b823",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
    "creation_date": "2020-10-22T15:09:19Z",
    "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e:secret:cb32abc1-2a4b-e0fd-f403-233e5249e130",
    "id": "cb32abc1-2a4b-e0fd-f403-233e5249e130",
    "labels": [],
    "last_update_date": "2020-10-22T15:10:34Z",
    "name": "new-username-password",
    "secret_data": {
        "password": "my-updated-password",
        "username": "my-username"
    },
    "secret_type": "USERNAME_PASSWORD",
    "state": 1,
    "state_description": "Active"
    },
    "warnings": null
}

La commande de rotation manuelle d'un secret username_password avec un mot de passe généré par le service renvoie la sortie suivante :

{
    "request_id": "67992946-3fd7-8cbe-9464-f5bc0cc8254e",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
    "creation_date": "2020-10-22T15:09:19Z",
    "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e:secret:cb32abc1-2a4b-e0fd-f403-233e5249e130",
    "id": "cb32abc1-2a4b-e0fd-f403-233e5249e130",
    "labels": [],
    "last_update_date": "2020-10-22T16:25:55Z",
    "name": "new-username-password",
    "secret_data": {
        "password": "TYRodi/HX7s095UpQ38)L1z(t4\u003ccG6!2",
        "username": "my-username"
    },
    "secret_type": "USERNAME_PASSWORD",
    "state": 1,
    "state_description": "Active"
    },
    "warnings": null
}

La commande permettant de faire pivoter manuellement un ensemble de données d'identification de service renvoie la sortie suivante:

{
  "request_id": "6adeab90-93a3-79eb-24eb-ae6f1c6856dc",
  "lease_id": "",
  "lease_duration": 0,
  "renewable": false,
  "data": {
    "created_by": "IBMid-2734562DAH",
    "creation_date": "2023-11-23T08:27:15Z",
    "crn": "crn:v1:staging:public:secrets-manager:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:e2c32ad4-1414-41e0-8747-e107e6b9f8d6:secret:3c89e3ed-31fb-06f7-387b-c972213c89ee",
    "custom_metadata": {},
    "downloaded": false,
    "iam_apikey_description": "Auto-generated for key crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675cc:resource-key:ada7d881-1af3-484c-8e79-4e071d9e1a7e",
    "iam_apikey_id": "ApiKey-df88649d-5198-4ca5-884f-856a1b83031a",
    "iam_apikey_name": "test-sc-1",
    "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
    "iam_serviceid_crn": "crn:v1:staging:public:iam-identity::a/826aa2b9cab6c666477fc55ebc47bacc::serviceid:ServiceId-40052fad-55a4-4090-ab9e-64877964a3ac",
    "id": "3c89e3ed-31fb-06f7-387b-c972213c89be",
    "labels": [],
    "last_update_date": "2023-11-23T08:48:20Z",
    "locks_total": 0,
    "name": "test-sc-1",
    "parameters": {},
    "resource_key_crn": "crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675cc:resource-key:ada7d881-1af3-484c-8e79-4e071d9e1a7e",
    "resource_key_name": "test-sc-1",
    "role": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
    "secret_data": {
      "apikey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "guid": "f85409e9-1a06-47d5-8320-95ed4e1675bc",
      "iam_apikey_description": "Auto-generated for key crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675cc:resource-key:48d0d690-7095-4e91-b267-bb8f4e7cc1e7",
      "iam_apikey_id": "ApiKey-7a2311a5-d071-4d4f-b511-f1182e5e9849",
      "iam_apikey_name": "test-sc-1",
      "iam_serviceid_crn": "crn:v1:staging:public:iam-identity::a/826aa2b9cab6c666477fc55ebc47bacc::serviceid:ServiceId-40052fad-55a4-4090-ab9e-64877964a3ac",
      "instance_id": "f85409e9-1a06-47d5-8320-95ed4e1675cc",
      "plan": "33b50df2-9cd6-4005-a941-bf0a59f0d133",
      "region": "us-south"
    },
    "secret_type": "service_credentials",
    "source_crn": "crn:v1:staging:public:event-notifications:us-south:a/826aa2b9cab6c666477fc55ebc47bafc:f85409e9-1a06-47d5-8320-95ed4e1675cc::",
    "state": 1,
    "state_description": "Active",
    "ttl": 0,
    "versions": [
      {
        "created_by": "IBMid-2723462DAH",
        "creation_date": "2023-11-23T08:27:15Z",
        "downloaded": true,
        "id": "34f934a3-def7-71e0-cc93-9c754879f2f8",
        "payload_available": true,
        "version_custom_metadata": {}
      },
      {
        "created_by": "IBMid-2723462DAH",
        "creation_date": "2023-11-23T08:48:20Z",
        "downloaded": false,
        "id": "1449cd40-dd18-5f68-7719-7a08a9f8e57d",
        "payload_available": true,
        "version_custom_metadata": {}
      }
    ],
    "versions_total": 2
  },
  "warnings": null
}

Suppression d'un secret

Utilisez cette commande pour supprimer un secret. Les valeurs autorisées pour SECRET_TYPE sont : arbitrary, iam_credentials, imported_cert, kv, private_cert, public_cert, service_credentials, custom_credentials, et username_password.

Supprimez un secret dans le groupe de secrets default.

vault delete ibmcloud/SECRET_TYPE/secrets/SECRET_ID

Supprimez un secret d'un groupe de secrets existant.

vault delete ibmcloud/SECRET_TYPE/secrets/groups/SECRET_GROUP_ID/SECRET_ID

Prérequis

Vous avez besoin du rôle de service Manager pour supprimer des secrets.

Options de commande

-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Supprimez un secret arbitraire par l'ID qui lui a été attribué.

vault delete ibmcloud/arbitrary/secrets/d26702aa-77ae-400e-4f25-9790a9cabf9c

Sortie

La commande génère la sortie suivante :

Success! Data deleted (if it existed) at: ibmcloud/arbitrary/secrets/d26702aa-77ae-400e-4f25-9790a9cabf9c

Secrets dynamiques

Les secrets dynamiques sont des données d'identification à usage unique qui ne sont générées que lorsqu'elles sont lues ou consultées.

Pour créer un secret dynamique à l'aide de l'interface de ligne de commande Vault, utilisez la commande role pour définir la portée du secret avec le niveau souhaité des droits d'accès dans votre compte IBM Cloud. Ensuite, utilisez la commande creds pour générer des données d'identification pour le rôle.

Créer un rôle

Utilisez les commandes suivantes pour enregistrer un rôle pour un moteur de secrets qui prend en charge les secrets dynamiques. Une fois que vous avez créé un rôle, vous pouvez générer des données d'identification. La configuration que vous définissez pour le rôle, par exemple son nom, sa durée de validité et ses droits d'accès, est héritée par les données d'identification générées.

Créez un rôle dans le groupe de secrets default.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/roles/ROLE_NAME access_groups=ACCESS_GROUP_ID,ACCESS_GROUP_ID ttl=LEASE_DURATION [description="DESCRIPTION"] [labels=LABEL,LABEL]

Créez un rôle dans un groupe de secrets spécifié.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/roles/groups/SECRET_GROUP_ID/ROLE_NAME access_groups=ACCESS_GROUP_ID,ACCESS_GROUP_ID ttl=LEASE_DURATION [description="DESCRIPTION"] [labels=LABEL,LABEL]

Prérequis

Vous avez besoin du rôle de service Writer pour créer des secrets.

Options de commande

SECRET_TYPE: Type de secret que vous souhaitez créer. Actuellement, iam_credentials est pris en charge.
SECRET_GROUP_ID: ID du groupe de secrets que vous souhaitez affecter au rôle et à ses données d'identification.
ROLE_NAME: Alias lisible que vous souhaitez affecter au rôle et à ses données d'identification.
access_groups: ID du groupe d'accès qui détermine la portée d'accès à affecter au rôle et à ses données d'identification.
ttl: Le temps de vie (TTL) qui détermine la durée d'existence des informations d'identification générées par un rôle. Utilisez une chaîne de durée telle que 300s ou 1h30m. Les unités de temps valides sont s, m et h.
description: Une description étendue à affecter au rôle et à ses données d'identification.
labels: Les libellés que vous pouvez utiliser pour regrouper et rechercher des secrets similaires dans votre instance.
-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Configurez un justificatif IAM avec une durée de bail d'une heure et attribuez-le au groupe de secrets default.

vault write -format=json ibmcloud/iam_credentials/roles/test-iam-credentials access_groups=AccessGroupId-985dc0a3-857b-48bd-b6d6-33819da7ba42 ttl=1h description="My test IAM credential." labels=test,us-south

Configurez des données d'identification IAM avec une durée de validité d'une heure et affectez-les à un groupe de secrets spécifié.

vault write -format=json ibmcloud/iam_credentials/roles/groups/9ab2250f-a369-4e07-ade7-d417d63ad587/test-iam-credential-in-group access_groups=AccessGroupId-985dc0a3-857b-48bd-b6d6-33819da7ba42 ttl=1h description="My test IAM credential that is assigned to a secret group." labels=test,us-south

Sortie

La commande génère la sortie suivante :

{
    "request_id": "d4150a28-1184-8864-dcd3-15b0d18da7c1",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "access_groups": [
        "AccessGroupId-985dc0a3-857b-48bd-b6d6-33819da7ba42"
    ],
    "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
    "creation_date": "2020-10-09T17:13:47Z",
    "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e::",
    "description": "My test IAM credential that is assigned to a secret group.",
    "id": "091ca93f-5c99-4078-9d7e-4801143030fd",
    "labels": [
        "test",
        "us-south"
    ],
    "last_update_date": "2020-10-09T17:13:47Z",
    "name": "test-iam-credential-in-group",
    "secret_group_id": "9ab2250f-a369-4e07-ade7-d417d63ad587",
    "secret_type": "IAM_CREDENTIALS",
    "state": 1,
    "state_description": "Active",
    "ttl": 3600
    },
    "warnings": null
}

Si le rôle est créé dans un groupe de secret, la valeur data.secret_group_id est incluse dans la réponse pour identifier l'affectation au groupe de secrets.

Générer des données d'identification IAM

Utilisez les commandes suivantes pour générer une clé d'API pour un rôle. Cette commande crée un ID de service, l'ajoute au groupe d'accès configuré pour le rôle, puis génère une clé d'API pour l'ID de service.

Générez une clé d'API pour un rôle dans le groupe de secrets default.

vault read [-format=FORMAT] ibmcloud/iam_credentials/creds/ROLE_ID

Générez une clé d'API pour un rôle dans un groupe de secrets spécifié.

vault read [-format=FORMAT] ibmcloud/iam_credentials/creds/groups/SECRET_GROUP_ID/ROLE_ID

Les clés d'API générées sont renouvelables et ont une durée de vie (TTL) définie par le rôle ou la valeur par défaut du système.

Prérequis

Vous avez besoin du rôle de service Writer pour créer des secrets.

Options de commande

SECRET_GROUP_ID: ID du groupe de secrets que vous souhaitez affecter à ce secret.
ROLE_ID: ID ou nom affecté au rôle pour ce secret.
-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Générez des données d'identification IAM pour un secret affecté au groupe default.

vault read -format=json ibmcloud/iam_credentials/creds/test-iam-credentials

Générez des données d'identification IAM pour un secret affecté à un groupe de secrets spécifié.

vault read -format=json ibmcloud/iam_credentials/creds/groups/9ab2250f-a369-4e07-ade7-d417d63ad587/test-iam-credential-in-group

Sortie

La commande génère la sortie suivante :

{
    "request_id": "48d14d52-ce92-6efc-aeaa-b49cc11eabd6",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "access_groups": [
        "AccessGroupId-985dc0a3-857b-48bd-b6d6-33819da7ba42"
    ],
    "api_key": "Cg7l3kJveurEry_P7_fLPIBR....(truncated)",
    "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
    "creation_date": "2020-10-09T17:13:47Z",
    "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e::",
    "description": "My test IAM credential that is assigned to a secret group.",
    "id": "091ca93f-5c99-4078-9d7e-4801143030fd",
    "labels": [
        "test",
        "us-south"
    ],
    "last_update_date": "2020-10-09T17:53:23Z",
    "name": "test-iam-credential-in-group",
    "secret_group_id": "9ab2250f-a369-4e07-ade7-d417d63ad587",
    "secret_type": "IAM_CREDENTIALS",
    "service_id": "ServiceId-ae06783c-0ab4-4b02-a78a-8dff7d0634c6",
    "state": 1,
    "state_description": "Active",
    "ttl": 3600
    },
    "warnings": null
}

Si le rôle appartient à un groupe de secrets, la valeur data.secret_group_id est incluse dans la réponse pour identifier l'affectation du groupe de secrets.

Répertorier les rôles

Utilisez les commandes suivantes pour répertorier les rôles ou les secrets dans votre instance Secrets Manager.

Répertoriez les rôles par type.

vault read [-format=FORMAT] ibmcloud/SECRET_TYPE/roles

Répertoriez les rôles par ID de groupe de secrets.

vault read [-format=FORMAT] ibmcloud/SECRET_TYPE/roles/groups/SECRET_GROUP_ID

Prérequis

Vous avez besoin du rôle de service Reader pour répertorier des secrets.

Options de commande

SECRET_TYPE: Type de secret que vous souhaitez répertorier. Actuellement, iam_credentials est pris en charge.
SECRET_GROUP_ID: ID du groupe de secrets.
-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Extrayez une liste de données d'identification IAM.

vault read -format=json ibmcloud/iam_credentials/roles

Extrayez une liste des données d'identification IAM qui appartiennent à un groupe de secrets spécifié.

vault read -format=json ibmcloud/iam_credentials/roles/groups/9ab2250f-a369-4e07-ade7-d417d63ad587

Sortie

La commande génère la sortie suivante :

{
    "request_id": "d567207f-b5e6-fc35-086e-fbc465bf3678",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "roles": [
        {
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
        "creation_date": "2020-10-09T17:13:47Z",
        "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e::",
        "description": "My test IAM credential that is assigned to a secret group.",
        "id": "091ca93f-5c99-4078-9d7e-4801143030fd",
        "labels": [
          "test",
          "us-south"
        ],
        "last_update_date": "2020-10-09T17:13:47Z",
        "name": "test-iam-credential-in-group",
        "secret_group_id": "9ab2250f-a369-4e07-ade7-d417d63ad587",
        "secret_type": "IAM_CREDENTIALS",
        "state": 1,
        "state_description": "Active",
        "ttl": 3600
        },
        {
        "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
        "creation_date": "2020-10-09T17:05:21Z",
        "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e:secret:a810998d-2912-4865-b4da-8dcc7465d784",
        "description": "My test IAM credential.",
        "id": "a810998d-2912-4865-b4da-8dcc7465d784",
        "labels": [
          "test",
          "us-south"
        ],
        "last_update_date": "2020-10-09T17:05:21Z",
        "name": "test-iam-credentials",
        "secret_type": "IAM_CREDENTIALS",
        "state": 1,
        "state_description": "Active",
        "ttl": 3600
        }
    ],
    "roles_total": 2
    },
    "warnings": null
}

Si le rôle appartient à un groupe de secrets, la valeur roles.data.secret_group_id est incluse dans la réponse pour identifier l'affectation du groupe de secrets.

Lire les métadonnées d'un rôle

Utilisez les commandes suivantes pour afficher les détails d'un rôle ou d'un secret enregistré, par exemple son nom et son historique.

Consulter les détails d'un rôle.

vault read [-format=FORMAT] ibmcloud/SECRET_TYPE/roles/ROLE_ID/metadata

Affichez les détails d'un rôle qui est affecté à un groupe secret.

vault read [-format=FORMAT] ibmcloud/SECRET_TYPE/roles/groups/GROUP_ID/ROLE/metadata

Prérequis

Vous avez besoin du rôle de service Reader pour afficher les métadonnées d'un secret.

Options de commande

SECRET_TYPE: Type de secret que vous souhaitez afficher. Actuellement, iam_credentials est pris en charge.
SECRET_GROUP_ID: ID du groupe de secrets affecté au rôle et à ses données d'identification
ROLE_ID: ID affecté au rôle pour ce secret.
-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Affichez les détails d'un rôle qui est affecté à un groupe secret.

vault read -format=json ibmcloud/iam_credentials/roles/groups/9ab2250f-a369-4e07-ade7-d417d63ad587/091ca93f-5c99-4078-9d7e-4801143030fd/metadata

Sortie

La commande génère la sortie suivante :

{
    "request_id": "cb4672e2-51d9-3a83-f8a2-717afe16e24a",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "access_groups": [
        "AccessGroupId-985dc0a3-857b-48bd-b6d6-33819da7ba42"
    ],
    "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
    "creation_date": "2020-10-09T17:13:47Z",
    "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e::",
    "description": "My test IAM credential that is assigned to a secret group.",
    "id": "091ca93f-5c99-4078-9d7e-4801143030fd",
    "labels": [
        "test",
        "us-south"
    ],
    "last_update_date": "2020-10-09T17:13:47Z",
    "name": "test-iam-credential-in-group",
    "secret_group_id": "9ab2250f-a369-4e07-ade7-d417d63ad587",
    "secret_type": "IAM_CREDENTIALS",
    "state": 1,
    "state_description": "Active",
    "ttl": 3600
    },
    "warnings": null
}

Mettre à jour les métadonnées d'un rôle

Utilisez les commandes suivantes pour afficher les détails d'un rôle ou d'un secret enregistré, par exemple son nom et son historique.

Mettez à jour les détails d'un rôle dans le groupe de secrets default.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/roles/ROLE_ID/metadata [name="ROLE_NAME"] [access_groups=ACCESS_GROUP_ID,ACCESS_GROUP_ID] [ttl=LEASE_DURATION] [description="DESCRIPTION"] [labels=LABEL,LABEL]

Mettez à jour les détails d'un rôle qui est affecté à un groupe secret.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/roles/groups/SECRET_GROUP_ID/ROLE_ID/metadata [name="ROLE_NAME"] [access_groups=ACCESS_GROUP_ID,ACCESS_GROUP_ID] [ttl=LEASE_DURATION] [description="DESCRIPTION"] [labels=LABEL,LABEL]

Prérequis

Vous avez besoin du rôle de service Writer pour mettre à jour les métadonnées d'un secret.

Options de commande

SECRET_TYPE: Type de secret que vous souhaitez mettre à jour. Actuellement, iam_credentials est pris en charge.
SECRET_GROUP_ID: ID du groupe de secrets affecté au rôle et à ses données d'identification.
ROLE_ID: ID affecté à ce secret.
access_groups: ID du groupe d'accès qui détermine la portée d'accès à affecter au rôle et à ses données d'identification.
ttl: Durée de vie (TTL) qui détermine la durée d'existence des données d'identification générées d'un rôle. Utilisez une chaîne de durée telle que 300s ou 1h30m. Les unités de temps valides sont s, m et h.
nom: Le nouveau nom que vous souhaitez affecter à ce secret.
description: Une description étendue à affecter au rôle et à ses données d'identification.
labels: Les libellés que vous pouvez utiliser pour regrouper et rechercher des secrets similaires dans votre instance.
-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Mettez à jour les détails d'un rôle affecté au groupe default.

vault write -format=json ibmcloud/iam_credentials/roles/091ca93f-5c99-4078-9d7e-4801143030fd/metadata name="new-credential-name"

Sortie

La commande génère la sortie suivante :

{
    "request_id": "cb4672e2-51d9-3a83-f8a2-717afe16e24a",
    "lease_id": "",
    "lease_duration": 0,
    "renewable": false,
    "data": {
        "access_groups": [
        "AccessGroupId-985dc0a3-857b-48bd-b6d6-33819da7ba42"
    ],
    "created_by": "iam-ServiceId-b7ebcf90-c7a9-495b-8ce8-bbf33cb95ca0",
    "creation_date": "2020-10-09T17:13:47Z",
    "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/791f5fb10986423e97aa8512f18b7e65:e415e570-f073-423a-abdc-55de9b58f54e::",
    "description": "My test IAM credential.",
    "id": "091ca93f-5c99-4078-9d7e-4801143030fd",
    "labels": [
        "test",
        "us-south"
    ],
    "last_update_date": "2020-10-09T17:13:47Z",
    "name": "new-credential-name",
    "secret_type": "IAM_CREDENTIALS",
    "state": 1,
    "state_description": "Active",
    "ttl": 3600
    },
    "warnings": null
}

Supprimer un rôle

Utilisez les commandes suivantes pour supprimer un rôle.

Supprimez un rôle dans le groupe de secrets default.

vault delete ibmcloud/SECRET_TYPE/roles/ROLE_ID

Supprimez un rôle qui appartient à un groupe secret.

vault delete ibmcloud/SECRET_TYPE/roles/groups/SECRET_GROUP_ID/ROLE_ID

Prérequis

Vous avez besoin du rôle de service Writer pour mettre à jour les métadonnées d'un secret.

Options de commande

SECRET_TYPE: Type de secret que vous souhaitez supprimer. Actuellement, iam_credentials est pris en charge.
SECRET_GROUP_ID: ID du groupe de secrets affecté au rôle et à ses données d'identification.
ROLE_ID: ID affecté à ce secret.

Exemples

Supprimez un rôle affecté au groupe default.

vault delete ibmcloud/iam_credentials/roles/091ca93f-5c99-4078-9d7e-4801143030fd

Sortie

La commande génère la sortie suivante :

Success! Data deleted (if it existed) at: ibmcloud/iam_credentials/roles/091ca93f-5c99-4078-9d7e-4801143030fd

Verrous

Verrouiller un secret

Utilisez les commandes suivantes pour créer un ou plusieurs verrous sur la version actuelle d'un secret.

Créez un verrou sur un secret dans le groupe de secrets par défaut.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/locks/SECRET_ID/lock @FILE

Créez un verrou sur un secret dans un groupe de secrets personnalisé.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/locks/groups/SECRET_GROUP_ID/SECRET_ID/lock @FILE

Verrouiller un secret exclusivement.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/locks/groups/SECRET_GROUP_ID/SECRET_ID/lock_exclusive @FILE

Verrouillez un secret exclusivement et supprimez les données de la version précédente.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/locks/groups/SECRET_GROUP_ID/SECRET_ID/lock_exclusive_delete @FILE

Prérequis

Vous avez besoin du rôle de service Auteur ou supérieur pour créer des verrous de secret.

Options de commande

SECRET_TYPE: Le type de secret que vous souhaitez verrouiller.
SECRET_GROUP_ID: ID du groupe de secrets.
FICHIER: Fichier JSON qui contient les détails du verrou.
nom: Alias lisible que vous souhaitez affecter au groupe de secrets. Obligatoire.
description: Description étendue du groupe de secrets.
-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Créez un verrou sur un secret dans le groupe de secrets par défaut.

vault write -format=json ibmcloud/arbitrary/locks/fe874c2b-e8fd-bbb6-9f19-e91bbe744735/lock @locks.json

Créez un verrou sur un secret dans un groupe de secrets personnalisé.

vault write -format=json ibmcloud/arbitrary/locks/groups/bb6-9f19-e91bbe744735/fe874c2b-e8fd-bbb6-9f19/lock @locks.json

Vous pouvez formater le fichier JSON qui contient les détails de verrou de secret en fonction de l'exemple suivant.

{
  "locks": [
    {
      "name": "lockX",
      "description": "blabla",
      "attributes": {"key": "value"}
    },
    {
      "name": "lockY",
      "description": "blabla",
      "attributes": {"key": "value"}
    }
  ]
}

Sortie

La commande de création d'un verrou sur un secret dans le groupe par défaut renvoie la sortie suivante:

{
  "request_id": "df85bbe9-4a0a04-06b123",
  "lease_id": "",
  "lease_duration": 0,
  "renewable": false,
  "data": {
    "secret_group_id": "default",
    "secret_id": "65e44d42-cf24f4-490fa9",
    "versions": [
      {
        "alias": "current",
        "id": "6df7edfe-e5f-0b66c-aaba832",
        "locks": [
          "lock4",
          "lock5"
        ],
        "payload_available": true
      }
    ]
  },
  "warnings": null
}

Répertorier les verrous de secret

Utilisez les commandes suivantes pour répertorier les verrous associés à la version en cours d'un secret.

Répertorier les verrous sur un secret qui se trouve dans le groupe de secrets par défaut.

vault read [-format=FORMAT] ibmcloud/SECRET_TYPE/locks/SECRET_ID

vault read [-format=FORMAT] ibmcloud/SECRET_TYPE/locks/groups/SECRET_GROUP_ID/SECRET_ID

Prérequis

Vous avez besoin du rôle de service Reader ou supérieur pour répertorier les verrous de secret.

Options de commande

-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Répertorier les verrous associés à un secret arbitraire dans le groupe de secrets par défaut.

vault read -format=json ibmcloud/arbitrary/locks/184408d6-8264-5ff3-c308-6922ed04ad88

Répertorier les verrous associés à la valeur confidentielle des données d'identification d'un utilisateur dans un groupe de valeurs confidentielles personnalisé.

vault read -format=json ibmcloud/username_password/locks/groups/d2e98a96-18ed-f13c-8dee-db955fb94122/c86946e6-b392-2613-159d-aff5a3f095b3

Sortie

La commande génère la sortie suivante :

{
  "request_id": "7a09ca14-6a7d-9ea2-2515-f7c22890f148",
  "lease_id": "",
  "lease_duration": 0,
  "renewable": false,
  "data": {
    "locks": [
      {
        "attributes": {
          "key": "value"
        },
        "created_by": "iam-ServiceId-222b47ab-b08e-42c3acb8",
        "creation_date": "2022-06-30T21:04:15.143896Z",
        "description": "Test lock for secret in the custom secret group.",
        "last_update_date": "2022-06-30T21:31:19.343086Z",
        "name": "lock-for-app-1",
        "secret_group_id": "d2e98a96-18ed-fb22",
        "secret_id": "c86946e6-b392-2613-15095b3",
        "secret_version_alias": "current",
        "secret_version_id": "ad6aa6d9-b43c-4bc3-52e64"
      }
    ],
    "locks_total": 1
  },
  "warnings": null
}

Déverrouiller un secret

Utilisez les commandes suivantes pour supprimer un ou plusieurs verrous sur la version en cours d'un secret.

Supprimez les verrous d'un secret dans le groupe de secrets par défaut.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/locks/SECRET_ID/unlock locks=LOCK_NAME locks=LOCK_NAME

Supprimez les verrous d'un secret dans un groupe de secrets personnalisé.

vault write [-format=FORMAT] ibmcloud/SECRET_TYPE/locks/groups/SECRET_GROUP_ID/SECRET_ID/unlock locks=LOCK_NAME locks=LOCK_NAME

Prérequis

Vous avez besoin du rôle de service Auteur ou supérieur pour créer des verrous de secret.

Options de commande

-format: Imprime la sortie au format que vous indiquez. Les formats valides sont table, json et yaml. La valeur par défaut est table. Vous pouvez également définir le format de sortie à l'aide de la variable d'environnement VAULT_FORMAT.

Exemples

Supprimez les verrous d'un secret dans le groupe de secrets par défaut.

vault write -format=json ibmcloud/username_password/locks/65e44d42-cfb6-a24f4490fa9/unlock locks=test-lock-1 locks=test-lock-2

Supprimez les verrous d'un secret dans un groupe de secrets personnalisé.

vault write -format=json ibmcloud/arbitrary/locks/groups/7a09ca14-6a7d-9ea2-2515-f7c22890f148/9ea2-2515-f7c22890f148/unlock locks=test-lock-1 locks=test-lock-2

Sortie

La commande génère la sortie suivante :

{
  "request_id": "0ec52cf2-59867-184a9c977",
  "lease_id": "",
  "lease_duration": 0,
  "renewable": false,
  "data": {
    "secret_group_id": "default",
    "secret_id": "65e44d42-cfb6-abe2-637d-2824f4490fa9",
    "versions": [
      {
        "alias": "current",
        "id": "6df7edfe-ea85-3d34-565f-0b66caaba832",
        "locks": [],
        "payload_available": true
      }
    ]
  },
  "warnings": null
}

Commandes d'interface de ligne de commande Vault

Se connecter

Configurer un jeton de connexion

Prérequis

Options de commande

Exemples

Sortie

Afficher la configuration d'un jeton

Prérequis

Options de commande

Exemples

Sortie

Groupes de secrets

Créer un groupe de secrets

Prérequis

Options de commande

Exemples

Sortie

Répertorier les groupes de secrets

Prérequis

Options de commande

Exemples

Sortie

Obtenir un groupe de secrets

Prérequis

Options de commande

Exemples

Sortie

Mettre à jour un groupe de secrets

Prérequis

Options de commande

Exemples

Sortie

Supprimer un groupe de secrets

Prérequis

Exemples

Sortie

Secrets statiques

Créer un secret

Prérequis

Options de commande

Exemples

Sortie

Répertorier les secrets

Prérequis

Options de commande

Exemples

Sortie

Obtenir un secret

Prérequis

Options de commande

Exemples

Sortie

Mettre à jour un secret

Prérequis

Options de commande

Exemples

Sortie

Mise à jour d'une version de secret

Exemples

Sortie

Appliquer une rotation à un secret

Prérequis

Options de commande

Exemples

Sortie

Suppression d'un secret

Prérequis

Options de commande

Exemples

Sortie

Secrets dynamiques

Créer un rôle

Prérequis

Options de commande

Exemples

Sortie

Générer des données d'identification IAM

Prérequis

Options de commande