Pular para o conteúdo principal

O que são Credentials?

Credentials (credenciais) são pares chave-valor criptografados que permitem armazenar informações sensíveis como API keys, tokens e secrets de forma segura. Em vez de colocar valores sensíveis diretamente no código do seu workflow, você os referencia pelo nome, e o Tela os injeta de forma segura em tempo de execução.

Por que usar Credentials?

Gerenciando Credentials

Acessando as Configurações de Credentials

Abra Configurações do Workspace → Credentials para gerenciar as credenciais do seu Workspace.

Criando uma Credential

  1. Clique em Adicionar Credential
  2. Digite uma Chave (identificador que você usará no código, ex: SLACK_BOT_TOKEN)
  3. Digite o Valor (o secret em si)
  4. Clique em Salvar
O valor da credential é criptografado antes de ser armazenado. Depois de salvo, ele não pode mais ser visualizado: você só pode atualizá-lo ou excluí-lo.

Nomenclatura de Chaves

Escolha nomes descritivos e consistentes para suas chaves de credential:
Use letras maiúsculas e sublinhados, como em variáveis de ambiente, para manter a consistência. Isso facilita identificar credentials no seu código.

Atualizando uma Credential (Rotação)

Para rotacionar uma credential:
  1. Encontre a credential na lista
  2. Clique em Editar
  3. Digite o novo valor
  4. Clique em Salvar
O novo valor entra em vigor imediatamente para novas execuções de workflow.

Excluindo uma Credential

Excluir uma credential faz qualquer workflow que a referencia falhar com o erro missing_credential. Confira se nenhum workflow ativo depende dela antes de excluir.

Usando Credentials em Execução de Código

Em etapas de Execução de Código, use a função credential() para obter valores secretos em tempo de execução.

JavaScript/TypeScript

Usando Credentials em Agents

Quando um workflow executa uma etapa de Agent Existente, todas as credentials do Workspace ficam disponíveis para o Agente. O Agente nunca vê os valores: ele se refere a uma credential pelo nome, e o Tela injeta o valor no momento da chamada. Para que o Agente use uma credential específica, cite o nome dela no Objetivo ou na configuração do Agente. Por exemplo, você pode dizer ao Agente: “Use a credential SLACK_BOT_TOKEN para enviar uma mensagem no canal #general.”
Credentials são herdadas do escopo do workflow. O Agente recebe as mesmas credentials disponíveis para o workflow que o executou.

Como Credentials Funcionam em Runtime

Quando uma etapa de workflow roda:
  1. O sistema resolve todas as credentials disponíveis para o Workspace
  2. As credentials são descriptografadas e injetadas no ambiente de execução da etapa
  3. A função credential() lê desse contexto seguro
  4. Os valores ficam apenas em memória, nunca em logs, saídas ou estado
O sistema tenta mascarar os valores de credentials nos logs. Porém, se o seu código imprimir um valor explicitamente, ele ainda pode ficar visível.

Escopos de Credentials

Credentials podem ser definidas em dois níveis:
  • Nível de workspace: Disponíveis para todos os workflows no workspace (padrão)
  • Nível de workflow: Específicas para um único workflow, sobrescrevendo credentials do workspace com a mesma chave

Credentials de Workspace

Credentials de workspace são o escopo padrão. Elas ficam disponíveis para todos os workflows e servem como fallback quando não existe uma credential com escopo de workflow.

Credentials com Escopo de Workflow

Você pode criar credentials que são específicas para um único workflow. Isso é útil quando:
  • Um workflow precisa de uma API key diferente do padrão do workspace
  • Você quer isolar credentials por motivos de segurança
  • Diferentes workflows se conectam a ambientes diferentes (staging vs produção)
Para gerenciar credentials com escopo de workflow:
  1. Abra o workflow que deseja configurar
  2. Clique no botão Credentials no cabeçalho do workflow
  3. Adicione credentials específicas para este workflow
Modal de credentials do workflow
Credentials com escopo de workflow que tenham a mesma chave que credentials do workspace irão sobrescrever o valor do workspace apenas para aquele workflow específico.

Allowlist de Credentials

Para controle adicional de segurança, você pode definir uma allowlist (lista de permissão) de credentials para cada workflow. Quando uma allowlist está configurada, apenas as credentials especificadas ficam acessíveis durante a execução do workflow.

Por que Usar uma Allowlist?

Configurando a Allowlist

  1. Abra o workflow que deseja configurar
  2. Clique no botão Credentials no cabeçalho do workflow
  3. Vá para a aba Usage Permissions
  4. Ative as credentials a que este workflow deve ter acesso
Configuração de allowlist de credentials
Se nenhuma allowlist estiver definida, o workflow tem acesso a todas as credentials do workspace (comportamento retrocompatível).
Ao usar uma allowlist, inclua todas as credentials de que o seu workflow precisa. Uma credential ausente faz o workflow falhar em tempo de execução.

Considerações de Segurança

Criptografia

Todos os valores de credentials são criptografados usando AES-256-GCM antes do armazenamento. Valores são descriptografados apenas no momento da execução e mantidos em memória pelo menor tempo necessário.

Controle de Acesso

  • Apenas administradores do Workspace podem criar, atualizar ou excluir credentials
  • Usuários com permissão de editar/executar workflows podem referenciar credentials pela chave, mas não podem ver os valores
  • Valores de credentials nunca são retornados pela API após a criação

Tratamento de Erros

Credential Ausente

Se seu código referencia uma credential que não existe:
Solução: Crie a credential nas Configurações do Workspace antes de executar o workflow.

Boa Prática: Validar no Início

Verifique as credentials necessárias no início do seu código:

Boas Práticas

Faça

  • Use nomes de chaves descritivos e consistentes
  • Rotacione credentials periodicamente
  • Use credentials separadas para diferentes serviços
  • Teste workflows após rotação de credentials
  • Documente para que cada credential é usada

Não Faça

  • Colocar secrets direto no código do workflow
  • Imprimir valores de credentials em logs
  • Compartilhar valores de credentials fora do sistema
  • Usar a mesma credential para vários fins
  • Excluir credentials sem verificar dependências

Perguntas Frequentes

Não. Por razões de segurança, valores de credentials não podem ser recuperados após a criação. Você só pode atualizá-los (sobrescrever) ou excluí-los.
Cada etapa resolve as credentials no momento da execução. Se uma credential for rotacionada no meio de uma execução, as etapas seguintes usam o novo valor. Etapas já em execução continuam com o valor que obtiveram.
Credentials estão disponíveis em etapas de Execução de Código e Agent Existente por meio da função credential(). Elas não podem ser usadas em campos de configuração do workflow nem em template strings.
Não há limite rígido, mas recomendamos manter as credentials organizadas e remover as não utilizadas para manter a clareza.
Não. Credentials têm escopo em um único workspace. Cada workspace tem seu próprio conjunto isolado de credentials.
Credentials com escopo de workflow têm prioridade. Se um workflow tem uma credential com escopo de workflow com chave API_KEY e o workspace também tem API_KEY, o workflow usará seu próprio valor com escopo de workflow. Outros workflows sem uma API_KEY com escopo de workflow continuarão usando o valor do workspace.
O workflow falhará com erro missing_credential quando tentar acessar a credential que não está na allowlist. Certifique-se de testar seus workflows após configurar uma allowlist.
Sim. A allowlist controla quais chaves de credential são acessíveis, e credentials com escopo de workflow fornecem os valores. Se uma chave está na allowlist, o sistema primeiro verificará se há um valor com escopo de workflow, depois fará fallback para credentials do workspace.
Valores de credentials podem ter até 64KB. Para secrets maiores, considere armazená-los em um secret manager dedicado e usar uma credential para guardar o token de acesso.

Resumo

Credentials fornecem uma forma segura e centralizada de gerenciar valores sensíveis em seus workflows, eliminando a necessidade de secrets hardcoded e simplificando a rotação de chaves. Com credentials com escopo de workflow e allowlists, você tem controle granular sobre quais secrets cada workflow pode acessar.