Gerencie credenciais seguras

Credenciais seguras ajudam você a armazenar, proteger e gerenciar centralmente informações confidenciais, como senhas, chaves de API ou certificados criptografados. Os monitores da Sintético podem acessar essas informações com segurança durante a execução script. Este tutorial fornece exemplos de como usar a API do NerdGraph para gerenciar credenciais seguras de forma programática.

Crie uma credencial segura

Você pode criar uma credencial segura usando a mutação syntheticsCreateSecureCredential. Essa mutação permite armazenar com segurança informações confidenciais que seus monitores Sintético podem acessar durante a execução script.

Parâmetro de entrada

Solicitação de amostra

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

Resposta de amostra

Uma resposta bem-sucedida retorna null para erros:

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

Se houver algum problema na criação da credencial segura, a matriz errors conterá objetos com campos description e type explicando o que deu errado.

Atualizar uma credencial segura

Você pode atualizar uma credencial segura existente usando a mutação syntheticsUpdateSecureCredential. Isso permite modificar o valor e a descrição, mantendo o mesmo nome de chave.

Parâmetro de entrada

Solicitação de amostra

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

Resposta de amostra

Uma resposta bem-sucedida retorna os metadados atualizados e null para erros:

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

Se houver algum problema ao atualizar a credencial segura, a matriz errors conterá objetos com campos description e type explicando o que deu errado.

Excluir uma credencial segura

Você pode excluir uma credencial segura usando a mutação syntheticsDeleteSecureCredential. Uma vez excluídas, todas as sessões de monitoramento que fizerem referência a essas credenciais falharão até que sejam atualizadas.

Parâmetro de entrada

Solicitação de amostra

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

Resposta de amostra

Uma resposta bem-sucedida retorna null para erros:

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

Se houver algum problema ao excluir a credencial segura, a matriz errors conterá objetos com campos description e type explicando o que deu errado.