Gérer les identifiants sécurisés

Les identifiants sécurisés vous aident à stocker, protéger et gérer de manière centralisée des informations sensibles telles que les mots de passe, les clés API ou les certificats chiffrés. Votre moniteur Synthétique peut accéder en toute sécurité à ces informations pendant l'exécution script. Ce tutoriel fournit des exemples d'utilisation de l'API NerdGraph pour gérer par programmation des identifiants sécurisés.

Créer un identifiant sécurisé

Vous pouvez créer une authentification sécurisée en utilisant la mutation syntheticsCreateSecureCredential. Cette mutation vous permet de stocker en toute sécurité des informations sensibles auxquelles votre moniteur Synthétique peut accéder pendant l'exécution script.

Paramètres d'entrée

Demande d'échantillon

mutation {
  syntheticsCreateSecureCredential(
    accountId: ACCOUNT_ID
    description: "Your optional description"
    key: "SECURE_CREDENTIAL_NAME"
    value: "SECURE_CREDENTIAL_VALUE"
  ) {
    errors {
      description
      type
    }
  }
}

Exemple de réponse

Une réponse positive renvoie null en cas d'erreur :

{
  "data": {
    "syntheticsCreateSecureCredential": {
      "errors": null
    }
  }
}

En cas de problème lors de la création de l'identifiant sécurisé, le éventail errors contiendra des objets avec des champs description et type expliquant ce qui s'est mal passé.

Mettre à jour un identifiant sécurisé

Vous pouvez mettre à jour une authentification sécurisée existante en utilisant la mutation syntheticsUpdateSecureCredential. Cela vous permet de modifier la valeur et la description tout en conservant le même nom de clé.

Paramètres d'entrée

Demande d'échantillon

mutation {
  syntheticsUpdateSecureCredential(
    accountId: ACCOUNT_ID
    description: "Updated description for the secure credential."
    key: "SECURE_CREDENTIAL_NAME"
    value: "SECURE_CREDENTIAL_VALUE"
  ) {
    createdAt
    lastUpdate
    errors {
      description
      type
    }
  }
}

Exemple de réponse

Une réponse positive renvoie les métadonnées mises à jour et null pour les erreurs :

{
  "data": {
    "syntheticsUpdateSecureCredential": {
      "createdAt": "2024-01-15T10:30:00Z",
      "lastUpdate": "2024-01-20T14:45:00Z",
      "errors": null
    }
  }
}

En cas de problème lors de la mise à jour des informations d'identification sécurisées, le éventail errors contiendra des objets avec des champs description et type expliquant ce qui s'est mal passé.

Supprimer un identifiant sécurisé

Vous pouvez supprimer une information d'identification sécurisée en utilisant la mutation syntheticsDeleteSecureCredential. Une fois supprimée, toute fonction de monitoring faisant référence à ces informations d'identification échouera jusqu'à leur mise à jour.

Paramètres d'entrée

Demande d'échantillon

mutation {
  syntheticsDeleteSecureCredential(
    accountId: ACCOUNT_ID
    key: "SECURE_CREDENTIAL_NAME"
  ) {
    errors {
      description
      type
    }
  }
}

Exemple de réponse

Une réponse positive renvoie null en cas d'erreur :

{
  "data": {
    "syntheticsDeleteSecureCredential": {
      "errors": null
    }
  }
}

En cas de problème lors de la suppression des informations d'identification sécurisées, le éventail errors contiendra des objets avec des champs description et type expliquant ce qui s'est mal passé.