Página de Registros de Aplicativos no Console de Gerenciamento do Jitterbit

Introdução

A página Registros de Aplicativos permite que administradores de organizações Harmony registrem aplicativos de terceiros com OAuth 2.0 de 3 pernas (3LO) para uso com certos conectores do Integration Studio. Uma vez que o aplicativo de terceiros 3LO esteja registrado na página Registros de Aplicativos, você pode autenticar uma conexão usando OAuth 2.0 de 3 pernas.

Para mais informações sobre como autenticar uma conexão com 3LO, consulte autenticação 3LO.

Na página Registros de Aplicativos, os administradores da organização podem registrar aplicativos privados com conectores habilitados para 3LO, definir os detalhes do provedor OAuth e definir o comportamento dos tokens de atualização. Para abri-la, use o menu do portal Harmony para selecionar Console de Gerenciamento > Personalizações > Registros de Aplicativos.

Você pode visualizar, criar, editar ou deletar registros, e visualizar e editar opções avançadas para um registro. Um conector pode ser registrado várias vezes. Cada um é considerado um aplicativo de conector único.

Visualizar

Sem registros, o corpo da página contém uma barra de ferramentas e uma tabela vazia:

Com registros, o corpo da página contém uma barra de ferramentas e uma tabela listando os registros disponíveis:

• Pesquisar: Digite texto para encontrar entradas correspondentes.

• Criar Novo: Criar um novo registro.

• Ações: Passe o mouse sobre uma linha para revelar os ícones de ações:

  • Opções avançadas: Mostre opções avançadas para o registro.

  • Editar: Edite o registro.

  • Excluir: Exclua o registro.

Clique em qualquer cabeçalho de coluna (exceto Ações) para classificar a tabela em ordem crescente por essa coluna. Clique novamente para inverter a ordem da classificação.

Criar

Para criar um novo registro de aplicativo conector, siga estas etapas:

1. Clique em Criar Novo. Uma nova linha aparece na tabela:

   

2. Defina valores para os seguintes campos:

   Na seção Criar novo registro de aplicativo:

   • Nome: Um nome para o registro que seja exclusivo para o conector.

   • Descrição: Uma descrição para o registro.

   • Conector: Clique para abrir o menu e, em seguida, selecione um dos conectores suportados. Atualmente, esses conectores suportam 3LO:

     • BMC Helix ITSM
     • HTTP v2
     • Jira
     • Slack

   • ID do Cliente: O identificador do cliente atribuído pelo provedor OAuth.

   • Segredo do Cliente: O segredo do cliente atribuído pelo provedor OAuth.

   • Escopo: Um ou mais [escopos OAuth 2.0] separados por espaço.

   Na seção Configuração:

   • URL de Autenticação: A URL para enviar uma solicitação de autorização.

   • URL do token de acesso: A URL para enviar uma solicitação de token de acesso.

   • URL do token de atualização: A URL para solicitar um novo token de acesso.

3. Clique em Salvar para salvar os valores ou em Cancelar para cancelar:

   

4. Quando salvo com sucesso, o registro aparece como uma nova entrada na tabela:

   

Editar

Para editar um registro, siga estas etapas:

1. Passe o mouse sobre um registro na tabela para revelar os ícones de ações, em seguida, clique em Editar. O painel Editar registro do aplicativo aparece:

   

2. No painel Editar registro do aplicativo, edite os campos e clique em Salvar para salvar as alterações ou Cancelar para cancelar.

   Nota

   O Conector de um registro não pode ser alterado a partir de seu valor inicial.

3. Leia a mensagem de notificação que aparece na parte superior direita da janela. Para fechar a notificação, clique no ícone Fechar.

Excluir

Para excluir um registro, siga estas etapas:

1. Passe o mouse sobre um registro na tabela para revelar os ícones de ações, em seguida, clique em Excluir.

2. Um diálogo Excluir Registro do Aplicativo é aberto:

   Texto do diálogo

   Excluir Registro do Aplicativo
   Você tem certeza de que deseja excluir o registro do aplicativo appRegistrationName? Esta ação não pode ser desfeita.

   Por favor, digite "DELETE" para confirmar.

3. Digite o texto DELETE e clique em Excluir, ou clique em Cancelar para cancelar a ação.

Opções avançadas

O painel Opções avançadas contém as configurações padrão fornecidas pelo provedor OAuth para o token de cada registro, e para as solicitações de autenticação, token e atualização.

Para abri-lo, passe o mouse sobre um registro na tabela e clique em Opções avançadas. O painel aparece na parte inferior da página:

O painel contém estas abas:

• Política de token

• Solicitação de autenticação

• Solicitação de token

• Solicitação de atualização

Política de token

A aba Política de token contém configurações para o token:

As seguintes configurações estão disponíveis:

• Ativar expiração do token de atualização: Quando ativado e usado em combinação com as configurações Receber Notificação de Expiração e Dias para Notificação de Expiração de uma conexão, você receberá notificações por email e um banner de notificação em todo o portal Harmony lembrando-o de obter um novo token de atualização quando o atual estiver expirado ou se aproximando da expiração. Quando um token de atualização expira, todas as operações dependentes falharão em tempo de execução.

  Quando esta configuração está ativada, a notificação por email é enviada para os administradores da organização Harmony (membros de um papel com a permissão Admin e o usuário que implantou o projeto por último).

  Para definir o período de expiração, insira um número inteiro maior que zero, em seguida, clique no menu e selecione um de Segundos, Horas ou Dias:

  

  Tip

  A configuração recomendada para este valor deve corresponder à utilizada no próprio provedor OAuth. Por exemplo, se a expiração do token de atualização de um provedor OAuth for de 1 ano, defina o valor de Expirar após para 1 ano.

• Ativar expiração por inatividade do token de atualização: Quando ativado, tokens de atualização que estiverem inativos por um período de tempo especificado são marcados como expirados na plataforma Harmony. Use o campo Expirar após para especificar o intervalo após o qual um token de atualização inativo é marcado como expirado.

  Important

  Use esta configuração em alinhamento com a configuração de inatividade do provedor OAuth. Habilitar esta configuração quando o provedor OAuth não tiver uma configuração de inatividade definida fará com que tokens de atualização válidos sejam considerados incorretamente como expirados na plataforma Harmony. Por outro lado, se o provedor OAuth tiver esta configuração definida, mas não estiver habilitada e especificada aqui no portal Harmony, o endpoint pode usar um token de atualização desatualizado, potencialmente causando problemas com base nas regras de token de atualização do provedor OAuth.

  • Expirar após: Para definir o período de expiração, insira um número inteiro maior que zero, em seguida, clique no menu e selecione um de Segundos, Horas ou Dias:

    

  Tip

  A configuração recomendada para este valor deve corresponder à utilizada no próprio provedor OAuth. Por exemplo, se a expiração de inatividade do token de atualização de um provedor OAuth for de 90 dias, defina o valor de Expirar após para 90 dias.

• Habilitar rotação de token de atualização: Clique para habilitar a rotação de token:

  

Clique em Salvar para salvar as alterações ou Cancelar para abandoná-las.

Solicitação de autenticação

A aba Solicitação de autenticação contém configurações para a solicitação de autenticação do token:

• URL de autenticação: A URL para enviar uma solicitação de autorização.

• Parâmetros: Para adicionar parâmetros à solicitação, siga estas etapas:

  1. Insira valores para Chave e Valor.

  2. Para escolher o método de envio de parâmetros, clique no menu Enviar em, em seguida, selecione um de URL da solicitação ou Cabeçalho da solicitação.

  3. Clique em Adicionar. O parâmetro aparece como uma nova linha na tabela.

  4. Repita os três passos anteriores para todos os parâmetros.

Clique em Salvar para salvar as alterações ou Cancelar para abandoná-las.

Solicitação de token

A aba Solicitação de token contém configurações para a solicitação de token:

• URL do token de acesso: A URL para enviar uma solicitação de token de acesso.

• Parâmetros: Para adicionar parâmetros à solicitação, siga estes passos:

  1. Insira valores para Chave e Valor.

  2. Para escolher o método de envio dos parâmetros, clique no menu Enviar em, e selecione uma das opções URL da Solicitação, Cabeçalho da Solicitação ou Corpo da Solicitação.

  3. Clique em Adicionar. O parâmetro aparece como uma nova linha na tabela.

  4. Repita os três passos anteriores para todos os parâmetros.

Clique em Salvar para salvar as alterações ou Cancelar para abandoná-las.

Solicitação de atualização

A aba Solicitação de atualização contém configurações para a solicitação de atualização de token:

• URL do token de atualização: A URL para solicitar um novo token de acesso.

• Parâmetros: Para adicionar parâmetros à solicitação, siga estes passos:

  1. Insira valores para Chave e Valor.

  2. Para escolher o método de envio dos parâmetros, clique no menu Enviar em, e selecione uma das opções URL da Solicitação, Cabeçalho da Solicitação ou Corpo da Solicitação.

  3. Clique em Adicionar. O parâmetro aparece como uma nova linha na tabela.

  4. Repita os três passos anteriores para todos os parâmetros.

Clique em Salvar para salvar as alterações ou Cancelar para abandoná-las.