Configurando cada tipo de conta

Saiba mais sobre a configuração de cada um dos tipos de contas utilizadas na Digibee Integration Platform.

Existem diferentes tipos de contas, como AWS V4, Basic, Public Key, Secret Key, OAuth 2 e API Key, e destaca-se que podem ser configuradas e armazenadas com o conector Store Account sem interromper a execução. Abaixo você aprenderá como configurar cada uma dessas contas.

Contas aceitam valores de até 10.000 caracteres.

Tipos de contas

Tipo de contaDescriçãoCampos/Parâmetros

API Key

Armazenamento de API Key para endpoints que precisam de uma API Key.

  • URL-PARAM-NAME: nome do query parameter em que a API Key configurada será utilizada

  • API-KEY: valor da API Key a ser utilizada

Basic

Autenticação de usuário/senha.

  • USERNAME: nome do usuário

  • PASSWORD: senha do usuário

Custom Auth Header

Header de autenticação personalizado para terminais específicos.

  • HEADER-NAME: nome do header

  • HEADER-VALUE: valor do header

OAuth Bearer

Armazenamento para tokens do tipo OAuth, o token será atribuído ao parâmetro "Authorization" no cabeçalho da solicitação.

  • TOKEN: token OAuth

Private Key

Armazenamento para chaves privadas.

  • KEY: Chave privada

  • PASSPHRASE: Senha da chave privada

Public Key

Armazenamento para chaves públicas.

  • KEY: Chave pública

OAuth2

Autorização via padrão OAuth que é comumente usado para permitir que usuários da Internet façam login em outros sites usando suas contas do Google, Microsoft, etc., sem revelar suas senhas. OAuth fornece a eles um "acesso seguro delegado" aos recursos do servidor em nome do proprietário do recurso.

  • PROVIDER: provedor OAuth

  • SCOPES: escopos de acesso OAuth

Certificate Chain

Cadeia de certificados para endpoints que precisam de autenticação 2-way SSL ou certificados de cliente. (A cadeia de certificados deve ser fornecida na ordem correta e no formato pem.)

  • CHAIN: cadeia de certificados completa

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

Secret Key

Usado para conectores de criptografia.

  • KEY: chave secreta

Google Key

Chave de serviço para APIs do Google.

Kerberos

Armazenamento Keytab para autenticações em ambientes que utilizam Kerberos.

  • KEYTAB: base64 do arquivo Keytab

  • PRINCIPAL: usuário dessa Keytab (ex.: user@DOMAIN)

AWS V4

Para acesso ao serviço AWS.

  • SERVICE-NAME: nome do serviço a ser acessado (por exemplo, S3, SQS)

  • ACCESS-KEY: chave criada na AWS para acessar o serviço

  • SECRET-KEY: chave tipo "secret key" gerada na AWS para acessar o serviço

  • SESSION-TOKEN: o session token da AWS (quando estiver usando credenciais temporárias)

  • REGION: a região onde o serviço é executado

OAuth Provider

Autorização via padrão OAuth que é geralmente usada para logar em aplicações web. Somente pode ser usada pelo conector Salesforce.

  • CLIENT-ID: o identificador associado com uma aplicação

  • CLIENT-SECRET: o secret associado com uma aplicação

SMTP Auth And Properties

Para Mail Connector, fornece dados de acesso ao servidor SMTP para enviar e-mails.

  • HOST: nome do host do servidor SMTP

  • PORT: porta de acesso ao servidor SMTP

  • USERNAME: email do usuário

  • PASSWORD: senha do email

  • STARTTLS_ENABLE: valores “true” ou “false” - se “true”, o acesso será via SSL.

  • AUTH: tipo de autenticação do servidor de email

NTLM

NTLM (NT Lan Manager) é um conjunto de protocolos de segurança Microsoft para autenticação, integridade e confidencialidade que pode ser acessado por meio do conector SOAP V3.

  • USERNAME: nome do usuário

  • PASSWORD: senha utilizada para o acesso

  • DOMAIN (opcional): nome do domínio

  • HOSTNAME (opcional): nome do host

AWS Role

Usada para especificar uma função AWS a ser assumida por um usuário configurado em uma conta AWS V4.

A conta AWS Role só pode ser usada atualmente no conector DynamoDB.

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

  • ROLE-SESSION-NAME: O nome que identifica a sessão de assumir a função.

  • EXTERNAL-ID: Um identificador opcional necessário para operações entre contas para assumir a função.

Azure Key

Usado para conectar-se aos serviços do Azure Key Vault na Microsoft Azure.

Todas as chaves podem ser encontradas no Default Directory, na seção de App Registrations. O CLIENT-ID e o TENANT-ID estão disponíveis no Overview do aplicativo, enquanto o CLIENT-SECRET está na seção Certificates & secrets.

  • CLIENT-SECRET: O client secret.

  • CLIENT-ID: O Application (client) ID.

  • TENANT-ID: O Directory (tenant) ID associado ao Azure Default Directory.

Informações e exemplos

Temos algumas informações importantes sobre algumas Contas e alguns exemplos, veja abaixo:

Informações

AWS Role

A conta AWS Role garante a um usuário AWS acesso temporário a uma função específica criada na AWS. Para usar essa funcionalidade, uma conta AWS V4 deve ser configurada.

Assim que as duas contas estiverem configuradas corretamente, elas podem ser usadas juntas em conectores que suportam a funcionalidade de assumir funções.

Atualmente, somente o conector DynamoDB suporta esta funcionalidade.

Exemplo:

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

Para fazer isto, selecione a conta AWS V4 que você quer usar no conector DynamoDB e ative o parâmetro Use Assume Role na aba Authentication. Quando a opção está ativada, você pode selecionar a conta AWS Role que garante ao usuário permissões para performar a operação desejada.

Na AWS, é necessário configurar os usuários AWS que podem acessar a função. Se esta configuração não for feita corretamente, o usuário da conta AWS V4 não poderá assumir a função, mesmo que ambas as contas AWS V4 e AWS Role estejam selecionadas no conector.

OAuth 2

Importante: Suportamos os seguintes provedores:

  • Microsoft: é obrigatório o escopo "offline_access" para utilização na Digibee Integration Platform. Também é importante lembrar que esse provedor aceita apenas contas pessoais;

  • Google;

  • Mercado Livre.

API Key

Importante: Os provedores a seguir definem um período de expiração para seus tokens de autenticação. Por este motivo, é necessário atualizar as configurações das suas Contas ao final de cada período.

  • Microsoft: a cada 3 meses

  • Google: a cada 6 meses

  • Mercado Livre: a cada 6 meses

Certificate Chain

Para converter sua chave, você pode fazê-lo através do OpenSSL através da linha de comando, por exemplo: openssl pkcs12 -in mycert_xpto.p12 -out myapp.pem

Exemplos

Private Key

-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgF2duc4+xxNKlMO9bUud4bzGnuATkQVX3bM/gzxISrgw7B1AzJwA
OT5UChBoIKfmISaaVVY9+/fTpI1szihSqTyemdHnbC+FcDzoK3p53C5ZJ4pL7s+G
Y7vGEa2Z/6JVder6dwJaaOtwf+DfZYiWQjvh8tfAVjVdONE/XZSxOOofAgMBAAEC
-----END RSA PRIVATE KEY-----

Public Key

-----BEGIN PUBLIC KEY-----
MIGeMA0GCSqGSIb3DQEBAQUAA4GMADCBiAKBgF2duc4+xxNKlMO9bUud4bzGnuAT
kQVX3bM/gzxISrgw7B1AzJwAOT5UChBoIKfmISaaVVY9+/fTpI1szihSqTyemdHn
-----END PUBLIC KEY-----

Certificate Chain

-----BEGIN CERTIFICATE-----
MIIEUTCCAzmgAwIBAgIBATANBgkqhkiG9w0BAQUFADBSMQswCQYDVQQGEwJVUzEj
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
MIIEUTCCAAGVDSHVEbjhdbhjsjeiejAQUFADBSMQswCQYDVQQGEwJVUzEj
-----END CERTIFICATE-----
-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgF2duc4+xxNKlMO9bUud4bzGnuATkQVX3bM/gzxISrgw7B1AzJwA
-----END RSA PRIVATE KEY-----

Google Key

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

Atualizado