> For the complete documentation index, see [llms.txt](https://docs.digibee.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digibee.com/documentation/developer-guide/pt-br/development-cycle/build-overview/accounts.md). # 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:
CampoDescrição
Nome da contaUm identificador único para a conta.
Tipo de contaO tipo da conta. Escolha entre as opções disponíveis.
DescriçãoInformações adicionais sobre a conta.
Disponibilidade do ProjetoDefine 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 ambienteCredenciais exigidas pelo tipo de conta selecionado. Veja abaixo como configurar cada tipo de conta.
{% hint style="warning" %} **Contas podem ser removidas permanentemente de pipelines** Uma conta é removida de um pipeline quando deixa de estar disponível no projeto do pipeline: quando o pipeline é movido para um projeto no qual a conta não é permitida, ou quando o projeto do pipeline é removido da lista de projetos permitidos na configuração de Disponibilidade do Projeto da conta. Uma vez removida, mover o pipeline de volta ou permitir o projeto novamente **não restaura a conta**, por motivos de segurança. Será necessário adicionar a conta manualmente ao pipeline novamente. {% endhint %} 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. {% hint style="info" %} Exemplo de conector que oferece suporte a esse tipo de conta: * [**REST V2**](/documentation/connectors-and-triggers/pt-br/connectors/web-protocols/rest-v2.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **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. {% hint style="info" %} Exemplos de conectores que oferecem suporte a esse tipo de conta: * [**DB V2**](/documentation/connectors-and-triggers/pt-br/connectors/structured-data/db-v2.md) * [**SOAP V3**](/documentation/connectors-and-triggers/pt-br/connectors/web-protocols/soap-v3.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **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. {% hint style="info" %} Exemplos de conectores que oferecem suporte a esse tipo de conta: * [**REST V2**](/documentation/connectors-and-triggers/pt-br/connectors/web-protocols/rest-v2.md) * [**WGet (Download HTTP)**](/documentation/connectors-and-triggers/pt-br/connectors/web-protocols/wget.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **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. {% hint style="info" %} Exemplos de conectores que oferecem suporte a esse tipo de conta: * [**Slack**](/documentation/connectors-and-triggers/pt-br/connectors/enterprise-applications/slack.md) * [**HubSpot: Sales and CMS**](/documentation/connectors-and-triggers/pt-br/connectors/industry-solutions/hubspot.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **Parâmetros de configuração** * **TOKEN:** Token OAuth
Private Key **Descrição**\ Armazena uma chave privada para autenticação. {% hint style="info" %} Exemplos de conectores que oferecem suporte a esse tipo de conta: * [**RSA Cryptography**](/documentation/connectors-and-triggers/pt-br/connectors/security/rsa-cryptography.md) * [**SFTP**](/documentation/connectors-and-triggers/pt-br/connectors/file-storage/sftp.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **Parâmetros de configuração** * **KEY:** Chave privada * **PASSPHRASE:** Senha da chave privada **Exemplo de chave privada** ```textproto -----BEGIN RSA PRIVATE KEY----- MIICWwIBAAKBgF2duc4+xxNKlMO9bUud4bzGnuATkQVX3bM/gzxISrgw7B1AzJwA OT5UChBoIKfmISaaVVY9+/fTpI1szihSqTyemdHnbC+FcDzoK3p53C5ZJ4pL7s+G Y7vGEa2Z/6JVder6dwJaaOtwf+DfZYiWQjvh8tfAVjVdONE/XZSxOOofAgMBAAEC -----END RSA PRIVATE KEY----- ```
Public Key **Descrição**\ Armazena uma chave pública para autenticação com pares de chave pública-privada. {% hint style="info" %} Exemplos de conectores que oferecem suporte a esse tipo de conta: * [**Digital Signature**](/documentation/connectors-and-triggers/pt-br/connectors/security/digital-signature.md) * [**RSA Cryptography**](/documentation/connectors-and-triggers/pt-br/connectors/security/rsa-cryptography.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **Parâmetros de configuração** * **KEY:** Chave pública **Exemplo de chave pública** ```textproto -----BEGIN PUBLIC KEY----- MIGeMA0GCSqGSIb3DQEBAQUAA4GMADCBiAKBgF2duc4+xxNKlMO9bUud4bzGnuAT kQVX3bM/gzxISrgw7B1AzJwAOT5UChBoIKfmISaaVVY9+/fTpI1szihSqTyemdHn -----END PUBLIC KEY----- ```
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. {% hint style="info" %} Exemplos de conectores que oferecem suporte a esse tipo de conta: * [**HubSpot: Sales and CMS**](/documentation/connectors-and-triggers/pt-br/connectors/industry-solutions/hubspot.md) * [**REST V2**](/documentation/connectors-and-triggers/pt-br/connectors/web-protocols/rest-v2.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **Parâmetros de configuração** * **PROVIDER:** Provedor OAuth * **SCOPES:** Escopos de acesso OAuth {% hint style="info" %} 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](/documentation/developer-guide/pt-br/development-cycle/build-overview/accounts/new-oauth2-architecture/registration-of-new-oauth-providers.md). {% endhint %} **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. {% hint style="info" %} Apenas o conector [**Oracle NetSuite**](/documentation/connectors-and-triggers/pt-br/connectors/industry-solutions/oracle-netsuite.md) oferece suporte a esse tipo de conta. {% endhint %} **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. {% hint style="info" %} Exemplos de conectores que oferecem suporte a esse tipo de conta: * [**CMS**](/documentation/connectors-and-triggers/pt-br/connectors/security/cms.md) * [**MongoDB**](/documentation/connectors-and-triggers/pt-br/connectors/structured-data/mongodb.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **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** ```shell openssl pkcs12 -in meu_certificado.p12 -out meu_app.pem ``` **Exemplo de certificate chain** ```textproto -----BEGIN CERTIFICATE----- MIIEUTCCAzmgAwIBAgIBATANBgkqhkiG9w0BAQUFADBSMQswCQYDVQQGEwJVUzEj -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIEUTCCAAGVDSHVEbjhdbhjsjeiejAQUFADBSMQswCQYDVQQGEwJVUzEj -----END CERTIFICATE----- -----BEGIN RSA PRIVATE KEY----- MIICWwIBAAKBgF2duc4+xxNKlMO9bUud4bzGnuATkQVX3bM/gzxISrgw7B1AzJwA -----END RSA PRIVATE KEY----- ```
Secret Key **Descrição**\ Usada por conectores de criptografia. {% hint style="info" %} Exemplo de conector que oferece suporte a esse tipo de conta: * [**Orderful**](/documentation/connectors-and-triggers/pt-br/connectors/industry-solutions/orderful.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **Parâmetros de configuração** * **KEY:** Chave secreta
Google Key **Descrição**\ Chave de serviço para acessar APIs do Google. {% hint style="info" %} Exemplos de conectores que oferecem suporte a esse tipo de conta: * [**REST V2**](/documentation/connectors-and-triggers/pt-br/connectors/web-protocols/rest-v2.md) * [**Google Cloud Functions**](/documentation/connectors-and-triggers/pt-br/connectors/google-gcp/cloud-functions.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **Parâmetros de configuração** * **KEY:** Chave do Google * **SCOPES:** Escopos de acesso separados por vírgulas. Veja [escopos do Google](https://developers.google.com/identity/protocols/oauth2/scopes). **Exemplo de Google Key** ```json { "type": "service_account", "project_id": "project_id", "private_key_id": "dfdsfrfr43r43r4refbcceceabf8055a12a", "private_key": "-----BEGIN PRIVATE KEY-----\n-----END PRIVATE KEY-----\n", "client_email": "user@DOMAIN.iam.gserviceaccount.com", "client_id": "123456576788888899", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "token_uri": "https://accounts.google.com/o/oauth2/token", "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/storage%40project.iam.gserviceaccount.com" } ```
Kerberos **Descrição**\ Armazena Keytab para autenticação em ambientes Kerberos. {% hint style="info" %} Exemplos de conectores que oferecem suporte a esse tipo de conta: * [**DB V2**](/documentation/connectors-and-triggers/pt-br/connectors/structured-data/db-v2.md) * [**Stream DB V3**](/documentation/connectors-and-triggers/pt-br/connectors/structured-data/stream-db-v3.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **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. {% hint style="info" %} Exemplos de conectores que oferecem suporte a esse tipo de conta: * [**AWS Security Token Service (STS)**](/documentation/connectors-and-triggers/pt-br/connectors/aws/sts.md) * [**DynamoDB**](/documentation/connectors-and-triggers/pt-br/connectors/structured-data/dynamodb.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **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. {% hint style="info" %} Apenas o conector [**DynamoDB**](/documentation/connectors-and-triggers/pt-br/connectors/structured-data/dynamodb.md) suporta esse recurso. {% endhint %} **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. {% hint style="warning" %} Na AWS, é necessário configurar os usuários que podem acessar a função. Se essa configuração não for feita corretamente, o usuário da conta **AWS V4** selecionada não conseguirá assumir a função, mesmo que as contas **AWS V4** e **AWS Role** estejam selecionadas no conector. {% endhint %}
OAuth Provider **Descrição**\ Autorização via OAuth, suportada apenas pelo conector [Salesforce](/documentation/connectors-and-triggers/pt-br/connectors/enterprise-applications/salesforce.md). {% hint style="info" %} Exemplos de conectores que oferecem suporte a esse tipo de conta: * [**Marketo**](/documentation/connectors-and-triggers/pt-br/connectors/industry-solutions/marketo.md) * [**Salesforce**](/documentation/connectors-and-triggers/pt-br/connectors/enterprise-applications/salesforce.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **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. {% hint style="warning" %} Esse tipo de conta é suportado apenas pelo Email V1, que está descontinuado. Para o Email V2 (versão ativa do conector), use os tipos de conta **Basic** ou **Azure Key**. {% endhint %} **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**](/documentation/connectors-and-triggers/pt-br/connectors/web-protocols/soap-v3.md). {% hint style="danger" %} O NTLM usa algoritmos de criptografia antigos (DES, RC4) com vulnerabilidades conhecidas. Substitua por **Kerberos** sempre que possível e implemente políticas de segurança mais rígidas. {% endhint %} **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** {% hint style="info" %} Exemplos de conectores que oferecem suporte a esse tipo de conta: * [**Azure Key Vault**](/documentation/connectors-and-triggers/pt-br/connectors/azure/key-vault.md) * [**Email V2**](/documentation/connectors-and-triggers/pt-br/connectors/web-protocols/email-v2.md) Se um conector oferecer suporte a esse tipo de conta, isso será indicado no parâmetro **Accounts** na documentação do conector. {% endhint %} **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](#descontinuando-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**. {% hint style="warning" %} Essa ação é irreversível. {% endhint %} ### **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. {% hint style="warning" %} Essa ação é irreversível. {% endhint %} ### **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. {% hint style="info" %} 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. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.digibee.com/documentation/developer-guide/pt-br/development-cycle/build-overview/accounts.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.