Página de Registros de Aplicativos no Management Console Jitterbit

Introdução

A página Registros de Aplicativos permite que administradores da organização Harmony registrem aplicativos OAuth 2.0 (3LO) de externo para uso com determinados conectores do Integration Studio. Após o registro do aplicativo 3LO de externo na página Registros de Aplicativos, você poderá autenticar uma conexão usando OAuth 2.0 de três pernas.

Para obter 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, selecione Management Console > Personalizações > Registros de Aplicativos no menu do portal Harmony:

Você pode visualizar, criar, editar, ou excluir 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 exclusivo.

Visualizar

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

Com as inscrições, o corpo da página contém uma barra de ferramentas e uma tabela listando as inscrições disponíveis:

• Pesquisar: Insira o 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: Mostrar opções avançadas para o registro.

  • Editar: Editar o registro.

  • Excluir: Excluir o registro.

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

Criar

Para criar um novo registro de aplicativo de 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 é exclusivo para o conector.

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

   • Conector: Clique para abrir o menu e selecione um dos conectores suportados. Atualmente, estes 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 caracteres separados por espaços OAuth 2.0 scopes.

   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 de atualização do token: A URL para solicitar um novo token de acesso.

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

   

4. Após o salvamento bem-sucedido, o registro aparecerá como uma nova entrada na tabela:

   

Editar

Para editar um registro, siga estes passos:

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

   

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

   Nota

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

3. Leia a mensagem de notificação que aparece no canto superior direito da janela. Para fechar a notificação, clique no botão Ícone Fechar.

Excluir

Para excluir um registro, siga estes passos:

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

2. A caixa de diálogo Excluir Registro de Aplicativo será aberta:

   

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

Opções avançadas

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

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

A gaveta contém as seguintes abas:

• Política de Tokens

• 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:

• Habilitar 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 expirar ou estiver próximo 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 é ativada, a notificação por email é enviada aos administradores da organização Harmony (membros de uma papel com a permissão Admin e o usuário que implantou o projeto pela última vez).

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

  

  Dica

  A configuração recomendada para este valor deve corresponder à usada 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 Expirar após como 1 ano.

• Habilitar expiração por inatividade do token de atualização: Quando ativado, os tokens de atualização que estiverem inativos pelo tempo especificado serã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 será marcado como expirado.

  Importante

  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 incorretamente considerados expirados na plataforma Harmony. Por outro lado, se o provedor OAuth tiver essa configuração definida, mas ela não estiver habilitada e especificada aqui no portal Harmony, o endpoint poderá usar um token de atualização obsoleto, potencialmente causando problemas com base nas regras de token de atualização do provedor OAuth.

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

    

  Dica

  A configuração recomendada para este valor deve corresponder à usada 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 Expirar após como 90 dias.

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

  

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

Solicitação de autenticação

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

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

• Parâmetros: Para adicionar parâmetros para a 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 e selecione Solicitar URL ou Cabeçalho da solicitação.

  3. Clique 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 em Cancelar para descartá-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 para a 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 e selecione URL da solicitação, Cabeçalho da solicitação ou Corpo da solicitação.

  3. Clique 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 em Cancelar para descartá-las.

Solicitação de atualização

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

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

• Parâmetros: Para adicionar parâmetros para a 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 e selecione URL da solicitação, Cabeçalho da solicitação ou Corpo da solicitação.

  3. Clique 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 em Cancelar para descartá-las.