Gestionar credenciales seguras

Las credenciales seguras lo ayudan a almacenar, proteger y gestionar de forma centralizada información confidencial, como contraseñas, claves de API o certificados codificados. Sus monitores Sintético pueden acceder de forma segura a esta información durante la ejecución script. Este tutorial proporciona ejemplos de cómo emplear la API NerdGraph para gestionar mediante programación credenciales seguras.

Crear una credencial segura

Puede crear una credencial segura empleando la mutación syntheticsCreateSecureCredential. Esta mutación le permite almacenar de forma segura información confidencial a la que sus monitores Sintético pueden acceder durante la ejecución script.

parámetro de entrada

Solicitud de muestra

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

Ejemplo de respuesta

Una respuesta exitosa devuelve null para los errores:

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

Si hay algún problema al crear la credencial segura, la matriz errors contendrá objetos con campos description y type que explican qué salió mal.

Actualizar una credencial segura

Puede actualizar una credencial segura existente empleando la mutación syntheticsUpdateSecureCredential. Esto le permite modificar el valor y la descripción manteniendo el mismo nombre de clave.

parámetro de entrada

Solicitud de muestra

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

Ejemplo de respuesta

Una respuesta exitosa devuelve los metadatos actualizados y null para errores:

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

Si hay algún problema al actualizar la credencial segura, la matriz errors contendrá objetos con campos description y type que explican qué salió mal.

Eliminar una credencial segura

Puede eliminar una credencial segura empleando la mutación syntheticsDeleteSecureCredential. Una vez eliminado, cualquier monitor que haga referencia a esta credencial fallará hasta que se actualice.

parámetro de entrada

Solicitud de muestra

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

Ejemplo de respuesta

Una respuesta exitosa devuelve null para los errores:

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

Si hay algún problema al eliminar la credencial segura, la matriz errors contendrá objetos con campos description y type que explican qué salió mal.