Tipos de autenticação de conexão HTTP v2

Introdução

Durante a configuração de uma conexão HTTP v2, após usar o menu Autenticação para selecionar o tipo de autenticação, campos adicionais ficam disponíveis para configurar, descritos nesta página para cada tipo:

• Chave de API: Especifique um par chave-valor de API para enviar em cabeçalhos ou parâmetros de consulta.

• Assinatura AWS: Especifique uma ID de chave de acesso AWS, chave de acesso secreta, região, serviço e token de sessão para enviar usando a Versão 4 de Assinatura do Amazon Web Services (AWS) em cabeçalhos ou parâmetros de consulta.

• Autenticação Básica: Especifique um nome de usuário e senha para enviar em cabeçalhos.

• Token de Portador: Especifique um token de portador para enviar em cabeçalhos.

• Autenticação Digest: Especifique um nome de usuário, senha, realm, nonce, algoritmo, QOP, contagem de nonce, nonce do cliente e opaque para enviar em cabeçalhos.

• Autenticação Hawk: Especifique uma ID de autenticação Hawk, chave de autenticação, informações específicas da aplicação, uma ID de aplicação e DLG para enviar em cabeçalhos.

• Sem Autenticação: Selecione para acessar o serviço anonimamente sem autorização.

• Autenticação NTLM: Especifique um nome de usuário, senha, domínio e estação de trabalho para enviar em cabeçalhos compatíveis com o protocolo NTLM da Microsoft.

• OAuth 2.0: Especifique o tipo de concessão e forneça o endpoint de token OAuth, ID do cliente, segredo do cliente e escopo para enviar em cabeçalhos ou no corpo da solicitação.

Chave de API

Quando Chave de API é selecionada no menu Autenticação, você fornece a chave de API e o valor e seleciona se o par chave-valor deve ser enviado em cabeçalhos ou parâmetros de consulta.

• Chave: Digite a chave de API.

• Valor: Digite o valor da chave de API.

• Adicionar a: Use o menu para selecionar Cabeçalhos ou Parâmetros de Consulta:

  • Cabeçalhos: O par chave-valor de API é enviado usando a chave de cabeçalho de solicitação definida.

  • Parâmetros de Consulta: O par chave-valor de API é enviado usando parâmetros de string de consulta. Por exemplo:

    GET /endpoint?api_key=abcdefgh123456789

Assinatura AWS

Quando Assinatura AWS é selecionada no menu Autenticação, você fornece uma ID de chave de acesso AWS, chave de acesso secreta, região, serviço e token de sessão para enviar usando a Versão 4 de Assinatura do Amazon Web Services (AWS) em cabeçalhos ou parâmetros de consulta.

• Chave de Acesso: Digite o ID da chave de acesso da AWS. Por exemplo, AKIAIOSFODNN7EXAMPLE.

• Chave Secreta: Digite a chave de acesso secreta da AWS. Por exemplo, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY.

• Adicionar Dados de Autorização Em: Selecione Cabeçalhos de Solicitação para enviar os dados de autorização usando o cabeçalho de solicitação HTTP Authorization.

• Região: Digite o código de região da AWS. Por exemplo, us-east-1 para US East (N. Virginia).

• Nome do Serviço: Digite o namespace do serviço AWS (também conhecido como prefixo do serviço AWS) que identifica o produto AWS. Por exemplo, s3 para Amazon S3.

• Token de Sessão: Digite o token de sessão da AWS se estiver assinando a solicitação usando credenciais de segurança temporárias. Por exemplo, AQoDYXdzEJr...<restante do token de sessão>.

Autenticação básica

Quando Autenticação Básica é selecionada no menu Autenticação, as credenciais especificadas são enviadas usando o cabeçalho de solicitação HTTP Authorization. As credenciais são codificadas automaticamente em Base64.

• Nome de Usuário: Digite o nome de usuário.

• Senha: Digite a senha.

Token de portador

Quando Token de Portador é selecionado no menu Autenticação, o token de portador especificado é enviado usando o cabeçalho de solicitação HTTP Authorization.

• Token de Portador: Digite o token de portador.

Autenticação Digest

Quando Autenticação Digest é selecionada no menu Autenticação, você fornece um nome de usuário, senha, realm, nonce, algoritmo, QOP, contagem de nonce, nonce do cliente e opaque para gerar um hash a ser enviado ao serviço através da diretiva WWW-Authenticate.

• Nome de Usuário: Digite o nome de usuário no realm especificado.

• Senha: Digite a senha associada ao nome de usuário.

• Realm: Digite o realm associado ao nome de usuário e senha. Por exemplo, registered_users@example.com.

• Nonce: Digite o nonce do servidor.

• Algoritmo: Digite o algoritmo usado para calcular o digest. Estes algoritmos são suportados:

  • MD5
  • MD5-sess
  • SHA-256
  • SHA-256-sess
  • SHA-512
  • SHA-512-sess

• QOP: Digite um token indicando uma única qualidade de proteção (QOP) aplicada à mensagem.

• Contagem de Nonce: Digite a contagem hexadecimal de solicitações enviadas com o valor de Nonce do Cliente nesta solicitação.

• Nonce do Cliente: Digite o nonce do cliente, um valor de string apenas ASCII.

• Opaque: Digite uma string de dados a ser retornada de solicitações subsequentes com URIs no mesmo espaço de proteção.

Autenticação Hawk

Quando Hawk Authentication é selecionada no menu Authentication, você fornece a ID de autenticação Hawk, a chave de autenticação, informações específicas da aplicação, um ID de aplicação e DLG para enviar nos cabeçalhos.

• Hawk Auth ID: Insira a ID de autenticação da API.

• Hawk Auth Key: Insira a chave de autenticação da API.

• EXT: Insira qualquer informação específica da aplicação a ser enviada com a solicitação.

• App: Insira a ID da aplicação.

• DLG: Se a Hawk Auth ID e a Hawk Auth Key forem obtidas através de delegação de acesso, insira a ID da aplicação delegante.

Sem autenticação

Quando No Auth é selecionada no menu Authentication, a conexão acessa o serviço anonimamente.

Autenticação NTLM

Quando NTLM Authentication é selecionada no menu Authentication, você fornece o nome de usuário, senha, domínio e estação de trabalho para enviar nos cabeçalhos compatíveis com o protocolo NTLM da Microsoft.

• Username: Insira o nome de usuário da conta.

• Password: Insira a senha da conta.

• Domain: Insira o domínio associado à conta.

• Workstation: Insira a estação de trabalho associada à conta.

Para mais informações, consulte a documentação da Microsoft sobre autenticação de usuário NTLM.

OAuth 2.0

A interface usada na configuração da conexão HTTP v2 depende da opção OAuth type selecionada:

• Client Credentials Grant: Para esta opção, a conexão é autenticada usando OAuth 2.0 de 2 pernas.

• Authorization Code Grant: Para esta opção, a conexão é autenticada usando um aplicativo OAuth 2.0 de 3 pernas. Esta opção requer o uso de agentes em nuvem ou versão de agente privado 10.83 / 11.21 ou posterior.

Client Credentials Grant

Quando Client Credentials Grant é selecionada como o OAuth type, os campos abaixo são apresentados.

• OAuth type: Selecione Client Credentials Grant para autenticar usando OAuth 2.0 de 2 pernas (descrito abaixo).

• Grant types: Use o menu para selecionar o fluxo de tipo de concessão a ser usado, Client Credentials ou Password Grant:

  • Client Credentials: (Padrão.) O tipo de concessão de credenciais do cliente.

  • Password Grant: O tipo de concessão de credenciais de senha do proprietário do recurso, que usa as credenciais de um usuário como token de acesso. Quando este tipo é selecionado, dois campos adicionais ficam disponíveis para configurar abaixo: Username e Password.

• Endpoint do token OAuth: Insira o endpoint na forma de uma URL completa que termine em /oauth/token para ser usado na geração do token.

• ID do cliente: Insira o ID do cliente associado à aplicação do serviço OAuth.

• Segredo do cliente: Insira o segredo do cliente associado à aplicação do serviço OAuth.

• Nome de usuário: Quando o tipo de concessão Password Grant está selecionado, insira o nome de usuário do proprietário do recurso.

• Senha: Quando o tipo de concessão Password Grant está selecionado, insira a senha associada ao nome de usuário.

• Escopo: Insira uma lista de permissões de escopo delimitada por espaços no formato esperado pelo serviço OAuth. Por exemplo, users, users.read, users:read, user-list-r, https://example.com/auth/scopes/user/users.readonly, openid profile, etc.

• Parâmetro de solicitação do tipo de concessão: Quando o tipo de concessão Client Credentials está selecionado, use o menu para escolher o valor grant_type a enviar em solicitações de token, seja Client Credentials ou Personalizado:

  • Client Credentials: (Padrão.) Envia client_credentials como o valor grant_type.

  • Personalizado: Envia o valor inserido no campo Valor do tipo de concessão personalizado como o valor grant_type. Use esta opção quando o serviço OAuth exigir um valor grant_type não padrão.

• Valor do tipo de concessão personalizado: Quando Personalizado está selecionado no menu Parâmetro de solicitação do tipo de concessão, insira o valor grant_type personalizado a enviar em solicitações de token. Por exemplo, account_credentials.

• Tipo de token: Opcionalmente, insira o tipo de token do Endpoint do token OAuth. Por exemplo, bearer ou refresh.

• Autenticação do cliente: Use o menu para selecionar Enviar como cabeçalho de autenticação básica ou Enviar credenciais do cliente no corpo:

  • Enviar como cabeçalho de autenticação básica: Os dados de autorização são enviados usando o cabeçalho de solicitação HTTP Authorization.

  • Enviar credenciais do cliente no corpo: Os dados de autorização são enviados no corpo da solicitação.

Authorization Code Grant

Quando Authorization Code Grant está selecionado como o Tipo OAuth, os campos abaixo são apresentados. Para notas importantes sobre o comportamento do token de acesso e token de atualização, consulte Notas importantes.

• Tipo OAuth: Selecione Authorization Code Grant para autenticar usando uma aplicação OAuth 2.0 de 3 etapas. Esta opção requer o uso da versão do agente 10.83 / 11.21 ou posterior.

• Aplicação OAuth: Use o menu para selecionar uma aplicação privada do conector HTTP v2 configurada na página Registros de aplicativos do Console de gerenciamento.

  Se uma aplicação privada não foi registrada para este conector, o menu estará vazio e o erro No app registrations found for HTTP v2 será exibido. Para mais informações sobre como configurar uma aplicação privada, consulte Conector OAuth 2.0 de 3 etapas.

  Nota

  Para conectar aos serviços web REST SuiteTalk do NetSuite, consulte os Pré-requisitos do OAuth 2.0 de 3 etapas (3LO) para conectar ao NetSuite para mais informações.

• Fazer login com OAuth: Clique para autenticar através do endpoint em uma aba separada do navegador e forneça consentimento para que o Jitterbit acesse a aplicação OAuth de 3 etapas.

Ao configurar uma aplicação OAuth com o endpoint, certifique-se de que a URL de retorno de chamada (também chamada de URI de retorno de chamada, URL de redirecionamento ou URI de redirecionamento, etc.) está definida como uma das seguintes URLs (dependendo da região da sua organização):