Integração com o Atlassian Jira Cloud - Amazon Quick
Antes de começarConfigurar o Atlassian Developer ConsoleConfigure a integração no Amazon QuickAções disponíveisGerenciar e solucionar problemas

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Integração com o Atlassian Jira Cloud

Use o conector de ação Atlassian Jira Cloud para criar, atualizar, pesquisar e gerenciar problemas, projetos, sprints e usuários do Jira diretamente no Amazon Quick por meio de linguagem natural.

A configuração dessa integração envolve duas etapas. Primeiro, você cria um aplicativo OAuth 2.0 (3LO) no Atlassian Developer Console e configura suas permissões. Em seguida, você cria a integração no Amazon Quick e a conecta ao seu aplicativo Atlassian. Para obter informações sobre os métodos de autenticação compatíveis com o Amazon Quick, consulteMétodos de autenticação.

Antes de começar

Certifique-se de ter o seguinte antes de configurar a integração.

Configurar o Atlassian Developer Console

Se você planeja usar a autenticação de usuário (3LO), crie um aplicativo OAuth 2.0 no Atlassian Developer Console antes de configurar o Amazon Quick. Conclua todas as etapas a seguir antes de migrar para o console do Amazon Quick.

Se você planeja usar somente a autenticação de serviço (chave de API), você pode pular esta seção e continuarConfigure a integração no Amazon Quick.

Para obter mais informações sobre aplicativos OAuth 2.0 (3LO), consulte Aplicativos OAuth 2.0 (3LO) na documentação do desenvolvedor da Atlassian.

Crie um OAuth aplicativo 2.0 (3LO)

O Amazon Quick usa um aplicativo Atlassian OAuth 2.0 (3LO) para se autenticar com seu produto Atlassian Cloud em nome de seus usuários. Crie esse aplicativo no Atlassian Developer Console antes de configurar o Amazon Quick.

  1. Abra o Atlassian Developer Console e faça login com sua conta Atlassian.

  2. Escolha Criar e, em seguida, escolha Integração OAuth 2.0.

  3. Em Nome, insira um nome descritivo para sua integração, por exemployour-app-name connector.

  4. Revise e aceite os termos para desenvolvedores da Atlassian.

  5. Escolha Criar.

Configurar permissões do

Depois de criar o aplicativo OAuth 2.0, adicione as permissões de API que o Amazon Quick precisa para interagir com seu produto Atlassian.

  1. No seu aplicativo no Atlassian Developer Console, escolha Permissões no painel de navegação à esquerda.

  2. Encontre a API para seu produto Atlassian (por exemplo, API Jira ou API Confluence) e escolha Adicionar. O botão muda para Configurar depois que a API é adicionada.

  3. Selecione Configurar. A página de escopos é aberta com as guias Escopos clássicos e Escopos granulares.

  4. Na guia Escopos clássicos, escolha Editar escopos. Selecione os escopos clássicos necessários e escolha Salvar.

  5. Escolha a guia Escopos granulares e, em seguida, escolha Editar escopos. Selecione os escopos granulares necessários e escolha Salvar.

Para os escopos específicos necessários para sua integração, consulte a seção de escopos a seguir.

Configurar permissões de API

Adicione os seguintes escopos ao seu aplicativo OAuth 2.0 para a integração de ações do Jira Cloud.

Escopos clássicos

Na guia Escopos clássicos, escolha Editar escopos e selecione os seguintes escopos.

Integração de ações do Jira — escopos clássicos
Escopo Description
read:jira-work Leia dados de projetos e problemas do Jira, pesquise problemas e objetos associados a problemas, como anexos e registros de trabalho.
manage:jira-project Crie e edite as configurações do projeto e crie novos objetos no nível do projeto (por exemplo, versões e componentes).
manage:jira-configuration Execute ações administrativas do Jira (por exemplo, criar projetos e campos personalizados, visualizar fluxos de trabalho, gerenciar tipos de links de problemas).
read:jira-user Visualize as informações do usuário no Jira às quais o usuário tem acesso, incluindo nomes de usuário, endereços de e-mail e avatares.
write:jira-work Crie e edite problemas no Jira, publique comentários como usuário, crie registros de trabalho e exclua problemas.
manage:jira-webhook Busque, registre, atualize e exclua webhooks do Jira declarados dinamicamente.

Escopos granulares

Escolha a guia Escopos granulares e, em seguida, escolha Editar escopos. Use a barra de pesquisa para encontrar os escopos abaixo. Por exemplo, pesquise sprint:jira-software para encontrar escopos relacionados ao sprint.

Integração de ações do Jira — escopos granulares
Escopo Description
read:board-scope:jira-software Leia as configurações da placa.
read:sprint:jira-software Leia as informações do sprint.
write:sprint:jira-software Crie e modifique sprints.
delete:sprint:jira-software Exclua os sprints.
write:board-scope:jira-software Gerencie as configurações da placa.
read:project:jira Leia os detalhes do projeto.

Configurar autorização

Defina a URL de retorno de chamada para que a Atlassian possa redirecionar os usuários de volta para o Amazon Quick depois que eles autorizarem o aplicativo.

  1. No seu aplicativo no Atlassian Developer Console, escolha Autorização no painel de navegação à esquerda.

  2. Ao lado de OAuth 2.0 (3LO), escolha Adicionar.

  3. Em Callback URLs, insirahttps://region.quicksight.aws.amazon.com/sn/oauthcallback. regionSubstitua pela AWS região em que sua instância Amazon Quick está implantada, por exemplous-east-1.

  4. Escolha Salvar alterações.

Registre suas credenciais

Antes de sair do Atlassian Developer Console, confirme se você tem os seguintes valores. Você precisa deles para a configuração do Amazon Quick.

  1. No seu aplicativo no Atlassian Developer Console, escolha Configurações no painel de navegação à esquerda.

  2. Em Detalhes da autenticação, copie os valores do ID do cliente e do segredo.

Credenciais obrigatórias do Atlassian Developer Console
Valor Onde encontrá-lo
ID de cliente Página de configurações, em Detalhes de autenticação
Secret Página de configurações, em Detalhes de autenticação

Configure a integração no Amazon Quick

Depois de preparar suas credenciais de autenticação, crie a integração no Amazon Quick.

  1. No console do Amazon Quick, escolha Integrações.

  2. Escolha a guia Ações.

  3. Em Configurar uma nova integração de aplicativos para Ações, encontre o Atlassian Jira Cloud e escolha o botão Adicionar (mais “+”).

  4. No assistente de criação de integração, preencha os seguintes campos:

    • Nome — Nome descritivo da sua integração com o Jira.

    • Descrição (opcional) — Notas sobre como essa conexão será usada.

    • Tipo de conexão — Escolha Rede pública.

  5. Em Configurações de autenticação, escolha seu método de autenticação e preencha os campos obrigatórios:

    1. Para autenticação do usuário, configure os seguintes campos:

      • URL base — O URL da sua instância do Jira para chamadas de API. Esse não é o mesmo URL em que os usuários fazem login. É semelhante ao seguinte:https://api.atlassian.com/ex/jira/yourInstanceId. Para encontrar o ID da sua instância, navegue atéhttps://your-domain.atlassian.net/_edge/tenant_info.

      • ID do cliente — ID do cliente na página de configurações do seu aplicativo Atlassian OAuth .

      • Segredo do cliente — Segredo da página de configurações do seu aplicativo Atlassian OAuth .

      • URL do token — https://auth.atlassian.com/oauth/token

      • URL de autorização — https://auth.atlassian.com/authorize

      • URL de redirecionamento — Esse campo é pré-preenchido com sua URL de retorno de chamada do Amazon Quick.

    2. Para autenticação de serviço, configure os seguintes campos:

      • Chave de API — token de API do Jira.

      • URL base — O URL da sua instância do Jira para chamadas de API.

      • E-mail — E-mail da conta de usuário associada.

  6. Escolha Criar e continuar.

  7. (Opcional) Na página Compartilhar integração, escolha os usuários com os quais compartilhar a integração.

Importante

O Jira Cloud pode retornar respostas de sucesso HTTP 200 mesmo quando os tokens da API são revogados ou configurados incorretamente. Para obter mais informações, consulte JRACLOUD-82932. Se sua integração parecer estar se conectando com sucesso, mas as ações falharem inesperadamente, verifique se seu token de API é válido e não foi revogado.

Ações disponíveis

Depois de configurar a integração, as ações a seguir estarão disponíveis.

Ações disponíveis do Jira Cloud
Ação Description
Adicionar anexo Adicione um anexo a uma edição.
Adicionar comentário Adicione um novo comentário.
Alterar status do problema Alterar o status da tarefa de um problema.
Criar problema Crie um novo problema ou subtarefa.
Criar projeto Crie um novo projeto.
Crie um Sprint Crie um sprint em um projeto.
Excluir comentário Remover comentário.
Excluir problema Exclua um problema em um projeto.
Excluir projeto Remova o projeto.
Excluir Sprint Exclua um sprint em um projeto.
Editar problema Modifique o problema.
Encontre usuários Procure um usuário do Jira.
Obtenha todas as etiquetas Veja todos os rótulos.
Obtenha todos os usuários Listar todos os usuários do Jira.
Obtenha o conteúdo do anexo Visualize o conteúdo de um anexo.
Obter comentários Exibir comentários sobre o problema.
Obter problema Veja os detalhes de um problema em um projeto.
Obtenha tipos de problemas para o projeto Veja os tipos de problemas do projeto.
Obtenha prioridades Veja as prioridades do problema.
Obtenha o projeto Veja os detalhes do projeto.
Obtenha o Sprint Veja os detalhes de um sprint em um projeto.
Mover problemas para a lista de pendências Mova os problemas para a lista de pendências.
Mover problemas para Sprint e Rank Atribua um problema a um sprint.
Problemas de pesquisa Pesquise problemas.
Projetos de pesquisa Encontre projetos visíveis.
Status de pesquisa Status de problemas de pesquisa.
Atualizar comentário Editar comentário.
Atualizar projeto Modifique o projeto.
Atualize o Sprint Atualize os detalhes do sprint.
nota

As ações que você pode usar dependem das permissões configuradas na sua instância do Jira Cloud e do seu método de autenticação.

Gerenciar e solucionar problemas

Para editar, compartilhar ou excluir sua integração, consulteGerenciando integrações existentes.

Problemas de autenticação

  • Configuração incorreta do aplicativo — Verifique se o OAuth aplicativo no Atlassian Developer Console inclui os escopos necessários e se o URI de redirecionamento corresponde à sua configuração do Amazon Quick.

  • Token de API expirado ou revogado — Se estiver usando a autenticação de serviço, verifique se o token de API não expirou ou foi revogado. Devido a um comportamento conhecido do Jira Cloud (JRACLOUD-82932), a integração pode parecer estar se conectando com sucesso mesmo com tokens inválidos.

  • URL base incorreta — A URL base para chamadas de API não é a mesma que a URL de login do Jira Cloud. Verifique se você está usando o formato de URL da API:https://api.atlassian.com/ex/jira/yourInstanceId. Para encontrar o ID da sua instância, navegue atéhttps://your-domain.atlassian.net/_edge/tenant_info.

Mensagens de erro comuns

  • Access denied. You do not have permission to perform this action— O usuário autenticado não tem as permissões necessárias no Jira Cloud. Entre em contato com seu administrador do Jira Cloud para verificar e conceder as permissões apropriadas.

  • OAuth 2.0 authorization failed— Verifique se o ID do cliente, o segredo do cliente e OAuth os escopos estão configurados corretamente no Atlassian Developer Console e no Amazon Quick.