For the complete documentation index, see llms.txt. This page is also available as Markdown.

Contas

Saiba mais sobre contas e como elas são usadas para gerenciar credenciais com segurança na Digibee Integration Platform.

Visão geral

As contas fornecem uma forma segura de armazenar informações confidenciais, como senhas, chaves privadas e tokens de autenticação, sem expor essas credenciais diretamente em suas integrações. Ao criptografar e gerenciar credenciais de forma centralizada, as contas ajudam a garantir a segurança dos processos de autenticação.

Além disso, as contas podem ser restritas a projetos específicos, garantindo que as informações confidenciais estejam acessíveis apenas onde são necessárias. Elas podem ser usadas em conectores dentro de pipelines e cápsulas para autenticar e autorizar o acesso a endpoints externos.

Gerenciando contas

A página de Contas pode ser acessada pela página Build, na aba Contas, ou pelo logo da Digibee no canto superior esquerdo, em Configurações.

Nela, a lista de contas exibe Nome da conta, Tipo de conta, Descrição, Data de expiração e Pipelines em execução para cada conta, com filtros por Tipo de conta, status Descontinuada e Status de expiração (Expirado ou Expirando em breve).

Criando uma conta

Na página de Contas, clique em Criar novo e preencha os campos:

Campo
Descrição

Nome da conta

Um identificador único para a conta.

Tipo de conta

O tipo da conta. Escolha entre as opções disponíveis.

Descrição

Informações adicionais sobre a conta.

Disponibilidade do Projeto

Define se a conta fica disponível para todos os projetos ou apenas para os selecionados. Na página de listagem de contas, você só vê contas disponíveis para todos os projetos ou para os projetos aos quais tem acesso.

Data de expiração

Define uma data de expiração para a conta como lembrete: ela só deixa de funcionar nos pipelines se essa data coincidir com a expiração real no serviço externo, e nesse caso será necessário atualizar as credenciais e fazer o redeploy.

Insira a data no formato DD/MM/AAAA (por exemplo, 30/05/2030). Contas próximas da expiração mostram Expirando em breve, e contas expiradas mostram Expirado. Opcional; aplica-se apenas a OAuth Bearer, Private Key, Public Key, OAuth 2, Certificate Chain, Google Key, AWS V4.

Configuração do ambiente

Credenciais exigidas pelo tipo de conta selecionado. Veja abaixo como configurar cada tipo de conta.

Em seguida, clique em Salvar para criar a conta.

Configurando cada tipo de conta

API Key

Descrição

Usada quando um endpoint requer uma chave de API.

Exemplo de conector que oferece suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • URL-PARAM-NAME: Parâmetro de consulta onde a chave de API é aplicada

  • API-KEY: Valor da chave de API

Expiração para tokens de autenticação

Os seguintes provedores definem um período de expiração para seus tokens de autenticação. Por isso, é necessário atualizar as configurações de suas contas ao final de cada período.

Expiração por provedor:

  • Microsoft: A cada 3 meses

  • Google: A cada 6 meses

  • Mercado Livre: A cada 6 meses

Basic

Descrição Autenticação com nome de usuário e senha.

Exemplos de conectores que oferecem suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • USERNAME: Nome de usuário

  • PASSWORD: Senha do usuário

Custom Auth Header

Descrição Usado quando um endpoint requer um cabeçalho de autenticação personalizado.

Exemplos de conectores que oferecem suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • HEADER-NAME: Nome do cabeçalho

  • HEADER-VALUE: Valor do cabeçalho

OAuth Bearer

Descrição Armazena um token OAuth e o atribui ao cabeçalho Authorization nas requisições.

Exemplos de conectores que oferecem suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • TOKEN: Token OAuth

Private Key

Descrição Armazena uma chave privada para autenticação.

Exemplos de conectores que oferecem suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • KEY: Chave privada

  • PASSPHRASE: Senha da chave privada

Exemplo de chave privada

Public Key

Descrição Armazena uma chave pública para autenticação com pares de chave pública-privada.

Exemplos de conectores que oferecem suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • KEY: Chave pública

Exemplo de chave pública

OAuth 2

Descrição Usado para serviços que suportam autorização OAuth 2.0 (como Google ou Microsoft). Fornece acesso delegado a recursos sem expor credenciais do usuário.

Exemplos de conectores que oferecem suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • PROVIDER: Provedor OAuth

  • SCOPES: Escopos de acesso OAuth

Se um provedor OAuth2 personalizado usar um certificado configurado, uma senha será necessária. Essa senha deve ser a mesma utilizada no upload do certificado. Para detalhes de configuração, consulte a documentação de provedores OAuth2.

Provedores suportados

  • Microsoft: O escopo "offline_access" é obrigatório para uso na Digibee Integration Platform. Importante lembrar que esse provedor aceita apenas contas pessoais.

  • Google

  • Mercado Livre

OAuth 1

Descrição

OAuth 1 é um método de autenticação que permite a comunicação segura entre aplicações sem compartilhar as credenciais do usuário. Nesse caso, os tokens são gerados diretamente na plataforma à qual você deseja se conectar, como o NetSuite. Não é necessário fazer login por meio de um provedor externo, como o Google.

Apenas o conector Oracle NetSuite oferece suporte a esse tipo de conta.

Parâmetros de configuração

  • OAUTH_TOKEN: Token de acesso gerado na plataforma (por exemplo, no NetSuite) que identifica o usuário de integração.

  • REALM: Identificador da conta ou domínio dentro da plataforma onde a integração está sendo realizada. No NetSuite, esse valor geralmente corresponde ao ID da conta.

  • OAUTH_TOKEN_SECRET: Chave secreta associada ao token de acesso. Também é gerada na plataforma e usada junto com o token para autenticar as requisições de forma segura.

Certificate Chain

Descrição

Especifica uma cadeia de certificados para endpoints que exigem autenticação SSL bidirecional ou certificados de cliente. Os certificados devem estar no formato PEM e na ordem correta.

Exemplos de conectores que oferecem suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • CHAIN: Cadeia completa de certificados

  • PASSWORD: Senha da chave privada (se necessário)

  • EXPIRATION DATE: Data de expiração do certificado

Exemplo de conversão com OpenSSL

Exemplo de certificate chain

Secret Key

Descrição Usada por conectores de criptografia.

Exemplo de conector que oferece suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • KEY: Chave secreta

Google Key

Descrição Chave de serviço para acessar APIs do Google.

Exemplos de conectores que oferecem suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • KEY: Chave do Google

  • SCOPES: Escopos de acesso separados por vírgulas. Veja escopos do Google.

Exemplo de Google Key

Kerberos

Descrição Armazena Keytab para autenticação em ambientes Kerberos.

Exemplos de conectores que oferecem suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • KEYTAB: Arquivo Keytab codificado em Base64

  • PRINCIPAL: Usuário associado ao Keytab (por exemplo, usuario@DOMINIO)

AWS V4

Descrição Usado para autenticar requisições a serviços da AWS com Signature Version 4.

Exemplos de conectores que oferecem suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • SERVICE-NAME: Serviço AWS (por exemplo, S3, SQS)

  • ACCESS-KEY: Chave de acesso da AWS

  • SECRET-KEY: Chave secreta da AWS

  • SESSION-TOKEN: Token de sessão temporário (se aplicável)

  • REGION: Região de execução

AWS Role

Descrição Concede a um usuário AWS acesso temporário a uma função específica criada na AWS. Para usar esse recurso, uma conta AWS V4 deve estar configurada.

Uma vez configurados corretamente ambos os tipos de conta, eles podem ser usados juntos em conectores que suportam o recurso assume role.

Apenas o conector DynamoDB suporta esse recurso.

Parâmetros de configuração

  • ROLE-ARN: Amazon Resource Name da função

  • ROLE-SESSION-NAME: Identificador da sessão assume role

  • EXTERNAL-ID: Identificador opcional para operações entre contas

Exemplo de uso

Suponha que você esteja usando o conector DynamoDB e queira que um usuário específico acesse um banco de dados para recuperar alguns dados. Você não quer que esse usuário tenha sempre acesso a esse banco ou possa realizar outras operações nele. Nesse caso, você pode configurar uma função na AWS e permitir que o usuário assuma temporariamente essa função para recuperar os dados necessários.

Para isso, selecione a conta AWS V4 que deseja usar no conector DynamoDB e ative o parâmetro Use Assume Role na aba Authentication. Com essa opção ativa, é possível selecionar a conta AWS Role que concede ao usuário permissão para realizar a operação desejada.

OAuth Provider

Descrição Autorização via OAuth, suportada apenas pelo conector Salesforce.

Exemplos de conectores que oferecem suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • CLIENT-ID: Identificador da aplicação

  • CLIENT-SECRET: Segredo da aplicação

SMTP Auth and Properties

Descrição

Configura as credenciais SMTP para o envio de emails com o conector Email V1.

Parâmetros de configuração

  • HOST: Host do servidor SMTP

  • PORT: Porta do servidor SMTP

  • USERNAME: Endereço de email

  • PASSWORD: Senha do email

  • STARTTLS_ENABLE: “true” ou “false” para acesso SSL

  • AUTH: Tipo de autenticação

NTLM

Descrição Conjunto de protocolos de segurança da Microsoft para autenticação, integridade e confidencialidade. Suportado via conector SOAP V3.

Parâmetros de configuração

  • USERNAME: Nome de usuário

  • PASSWORD: Senha do usuário

  • DOMAIN (opcional): Nome do domínio

  • HOSTNAME (opcional): Nome do host

Azure Key

Descrição Usada para conectar ao Azure Key Vault. As chaves podem ser encontradas no Default Directory em App Registrations:

  • CLIENT-ID e TENANT-ID em Overview

  • CLIENT-SECRET em Certificates & secrets

Exemplos de conectores que oferecem suporte a esse tipo de conta:

Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro Accounts na documentação do conector.

Parâmetros de configuração

  • CLIENT-SECRET: Segredo do cliente

  • CLIENT-ID: ID da aplicação (cliente)

  • TENANT-ID: ID do diretório (tenant)

Editando uma conta

Para editar uma conta, acesse a lista de contas e clique na linha da conta que deseja editar.

Você pode:

  • Atualizar a descrição.

  • Marcar a conta como descontinuada. Saiba mais sobre descontinuar uma conta.

  • Definir novas regras de Disponibilidade do Projeto.

  • Atualizar credenciais de todos os ambientes. Credenciais sensíveis não ficam visíveis, mas é possível adicionar novas.

  • Ver todos os pipelines que usam a conta. Se você editar a conta, os pipelines já implantados precisarão ser reimplantados para que as mudanças sejam aplicadas.

Após editar a conta, clique em Salvar. Uma janela de confirmação aparece, e você deve clicar em Editar para confirmar as alterações.

Todas as mudanças são aplicadas imediatamente aos pipelines que usam a conta e ainda não foram implantados. Para pipelines já implantados, recomendamos reimplantá-los após editar a conta, para evitar problemas e manter os pipelines atualizados.

Descontinuando uma conta

Descontinuar uma conta a torna indisponível para novos pipelines ou novas versões de pipelines. As implantações existentes continuam funcionando, a menos que sejam reimplantadas.

Para descontinuar uma conta:

  1. Na lista de contas, clique na linha da conta que deseja descontinuar.

  2. Ative a opção Descontinuada.

  3. Clique em Salvar.

Excluindo uma conta

Excluir uma conta a remove permanentemente da plataforma. Não é possível excluir contas que estejam em uso em pipelines, implantados ou não. Para prosseguir, remova ou substitua a conta em todos os pipelines antes de excluí-la.

Para excluir uma conta:

  1. Na lista de contas, clique nos três pontos ao lado da conta que deseja excluir.

  2. Selecione Remover

  3. Confirme a ação na janela pop-up.

Usando contas

As contas oferecem acesso seguro a serviços externos dentro de pipelines e cápsulas, por meio de conectores que suportam o campo Account. Quando um conector exige uma conta, esse campo aparece no formulário de configuração, permitindo selecionar a conta apropriada para a integração.

Ao selecionar uma conta no formulário de configuração de um conector, só são exibidas as contas permitidas no projeto do pipeline, mantendo credenciais sensíveis restritas a projetos autorizados.

Atualizado

Isto foi útil?