Integrar o Jira ao Google SecOps

Versão da integração: 50.0

Este documento explica como integrar o Jira ao Google Security Operations.

Casos de uso

A integração do Jira usa os recursos do Google SecOps para oferecer suporte aos seguintes casos de uso:

  • Emissão automática de tíquetes: crie automaticamente problemas do Jira com base em alertas do Google SecOps usando o Jira Connector para simplificar a transferência entre as equipes de segurança e TI.

  • Sincronização bidirecional: mantenha a consistência entre plataformas sincronizando automaticamente comentários e mudanças de status entre tíquetes do Jira e casos do Google SecOps usando jobs de sincronização dedicados.

  • Enriquecimento de incidentes: anexe evidências, registros e capturas de tela diretamente aos problemas do Jira usando a ação Fazer upload de anexo para fornecer contexto completo aos responsáveis pela correção.

  • Gerenciamento dinâmico de tarefas: atualize, atribua ou vincule problemas relacionados do Jira diretamente do playbook do Google SecOps para automatizar procedimentos operacionais padrão (POPs).

Antes de começar

Antes de configurar a integração do Jira na plataforma Google SecOps, verifique se você tem o seguinte:

  • Compatibilidade de produtos: acesso a uma instância do Jira Cloud ou a um ambiente do Jira Data Center (local).

  • URL raiz da API: o URL de base da sua instância do Jira (por exemplo, https://yourdomain.atlassian.net).

  • Credenciais de autenticação:

    • Jira Cloud: um nome de usuário válido e um token da API Atlassian.

    • Jira Data Center (no local): uma combinação válida de nome de usuário e senha padrão.

  • Acesso à rede: verifique se a plataforma Google SecOps (ou um agente remoto) pode acessar o endpoint de API Jira.

Configurar a autenticação do Jira Cloud

Para se conectar ao Jira Cloud, crie um token de API na sua conta da Atlassian:

  1. Faça login na sua conta da Atlassian.

  2. Clique em Criar um token de API.

  3. No campo Rótulo, insira um nome conciso para o token (como "Integração do Google SecOps") e clique em Criar.

  4. Clique em Copiar para a área de transferência e cole o token em um lugar seguro para salvar.

Parâmetros de integração

A integração com o Jira exige os seguintes parâmetros:

Parâmetro Descrição
Api Root

Obrigatório.

O URL de base da instância do Jira.

O valor padrão é https://JIRA_ADDRESS.
Username

Obrigatório.

O nome de usuário usado para se conectar ao Jira.

Os requisitos para esse campo variam de acordo com os produtos do Jira:

  • No Jira Cloud, insira o endereço de e-mail associado à sua conta.
  • Para o Jira Data Center, insira seu nome de usuário padrão.
Api Token

Obrigatório.

A credencial de autenticação usada para se conectar ao Jira.

Os requisitos de autenticação variam entre os produtos do Jira. Consulte Antes de começar para instruções específicas sobre como fazer a autenticação com o Jira Cloud ou o Jira Data Center.
Verify SSL

Opcional.

Se selecionada, a integração valida o certificado SSL ao se conectar ao servidor Jira.

Essa configuração está desativada por padrão.

Para instruções sobre como configurar uma integração no Google SecOps, consulte Configurar integrações.

Você pode fazer mudanças mais tarde, se necessário. Depois de configurar uma instância de integração, você pode usá-la em playbooks. Para mais informações sobre como configurar e oferecer suporte a várias instâncias, consulte Suporte a várias instâncias.

Ações

Para mais informações sobre ações, consulte Responder a ações pendentes da sua mesa de trabalho e Realizar uma ação manual.

Adicionar comentário

Use a ação Adicionar comentário para escrever e adicionar um comentário a um problema do Jira.

Essa é uma maneira eficaz de documentar descobertas, fornecer atualizações e colaborar com membros da equipe diretamente no Google SecOps.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Adicionar comentário exige os seguintes parâmetros:

Parâmetro Descrição
Issue Key

Obrigatório.

O identificador exclusivo do problema do Jira (por exemplo, PROJ-123).
Comment

Obrigatório.

O texto a ser adicionado à solicitação do Jira.

Saídas de ação

A ação Adicionar comentário fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Adicionar comentário:

Nome do resultado do script Valor
comment_id O ID exclusivo do comentário recém-criado no Jira.

Atribuir problema

Use a ação Atribuir problema para atribuir um problema do Jira a um usuário específico.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Atribuir problema exige os seguintes parâmetros:

Parâmetro Descrição
Issue Key

Obrigatório.

O identificador exclusivo do problema do Jira (por exemplo, PROJ-123).
Assignee

Obrigatório.

O nome ou endereço de e-mail do usuário a quem o problema será atribuído.
Jira Username

Opcional.

O nome de usuário do Jira da pessoa que iniciou a ação de atribuição.

Saídas de ação

A ação Atribuir problema fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Atribuir problema:

Nome do resultado do script Valor
success true ou false

Criar problema de alerta

Use a ação Criar problema de alerta para criar um novo tíquete no Jira para um alerta específico.

Essa ação é usada principalmente em playbooks para encaminhar incidentes de segurança a equipes de TI ou engenharia para investigação ou correção.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Criar problema de alerta exige os seguintes parâmetros:

Parâmetro Descrição
Project Key

Obrigatório.

A chave abreviada exclusiva do projeto do Jira em que o problema foi criado (como SEC).
Summary

Obrigatório.

Um breve título ou resumo do problema.
Issue Type

Obrigatório.

O nome do tipo de problema (como Task, Bug ou Incident).

Saídas de ação

A ação Criar problema de alerta fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo a seguir mostra a saída do resultado JSON recebida quando a ação cria um problema com sucesso:

{
   "summary": "Sample issue",
   "description": "Create Enrich entities action using Insights API (IOC search). Write connector for alerts.",
   "project": {
      "key": "PR",
      "name": "Project 1",
      "projectTypeKey": "software"
   },
   "issuetype": {
     "name": "Task",
     "subtask": false
   },
   "status": {
      "name": "DONE",
      "statusCategory": {
         "name": "Done",
         "key": "done"
      }
   },
   "priority": {
      "name": "Medium",
      "id": "3"
   },
   "creator": {
      "displayName": "user1",
      "emailAddress": "john_doe@example.com"
   },
   "assignee": {
      "displayName": "user2",
      "emailAddress": "john_doe@example.com"
   },
   "created": "2018-06-19T15:23:13.701+0300",
   "updated": "2018-09-18T10:02:06.347+0300"
}
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Criar problema de alerta:

Nome do resultado do script Valor
issue_key A chave abreviada exclusiva do problema do Jira recém-criado (por exemplo, SEC-456).

Criar problema

Use a ação Criar problema para criar um tíquete em um projeto do Jira.

Essa ação oferece várias opções de personalização, incluindo a capacidade de especificar componentes, rótulos e campos personalizados usando JSON, o que a torna adequada para fluxos de trabalho complexos de criação de tíquetes.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Criar problema exige os seguintes parâmetros:

Parâmetro Descrição
Project Key

Obrigatório.

A chave abreviada exclusiva do projeto do Jira em que o problema foi criado (como SEC).
Summary

Obrigatório.

Um breve título ou resumo do problema.
Description

Opcional.

Uma descrição detalhada do problema.
Issue Type

Obrigatório.

O nome do tipo de problema (como Task, Bug ou Incident).
Jira Username

Opcional.

O nome de usuário do Jira da pessoa que iniciou a ação.
Assignee

Opcional.

O identificador do usuário a quem o problema foi atribuído.
Components

Opcional.

Uma lista separada por vírgulas de componentes do Jira a serem associados ao problema.
Labels

Opcional.

Uma lista separada por vírgulas de marcadores a serem adicionados ao problema.
Custom Fields

Opcional.

Um objeto JSON que contém outros campos e valores a serem definidos durante a criação (por exemplo, {"customfield_10001": "Value"}).

Os valores fornecidos nesse parâmetro têm prioridade e substituem outros mapeamentos de campo se ocorrer um conflito.

Saídas de ação

A ação Criar problema fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo a seguir mostra a saída do resultado JSON recebida ao usar a ação Criar problema:

{
   "summary": "Sample issue",
   "description": "Create Enrich entities action using Insights API (IOC search). Write connector for alerts. In a couple of days we will have access to an instance.",
   "project": {
      "key": "PR",
      "name": "Project 1",
      "projectTypeKey": "software"
   },
   "issuetype": {
      "name": "Task",
      "description": "A task that needs to be done.",
      "subtask": false
   },
   "status": {
      "name": "DONE",
      "statusCategory": {
         "name": "Done",
         "key": "done",
         "colorName": "green"
      }
   },
   "priority": {
      "name": "Medium",
      "id": "3"
   },
   "resolution": {
      "name": "Done",
      "description": "Work has been completed on this issue."
   },
   "creator": {
      "displayName": "user1",
      "emailAddress": "john_doe@example.com",
      "active": true,
      "timeZone": "Asia/Jerusalem"
   },
   "assignee": {
      "displayName": "user2",
      "emailAddress": "john_doe@example.com",
      "active": true
   },
   "reporter": {
      "displayName": "user1",
      "emailAddress": "john_doe@example.com"
   },
   "labels": [
      "Label1"
   ],
   "attachment": [
      {
         "id": "1001",
         "filename": "file.rar",
         "mimeType": "binary/octet-stream",
         "size": 15420,
         "created": "2018-06-19T15:23:07.369+0300"
      }
   ],
   "created": "2018-06-19T15:23:13.701+0300",
   "updated": "2018-09-18T10:02:06.347+0300",
   "resolutiondate": "2018-09-18T10:02:06.340+0300",
   "watches": {
      "watchCount": 1,
      "isWatching": false
   }
}
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Criar problema:

Nome do resultado do script Valor
issue_key A chave abreviada exclusiva do problema do Jira recém-criado (por exemplo, SEC-789).

Excluir problema

Use a ação Excluir problema para remover permanentemente um problema do Jira.

Essa ação é usada normalmente para limpar tíquetes duplicados ou remover dados de teste gerados durante o desenvolvimento do playbook.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Excluir problema exige os seguintes parâmetros:

Parâmetro Descrição
Issue Key

Obrigatório.

A chave abreviada exclusiva da solicitação do Jira a ser excluída (por exemplo, SEC-123).

Saídas de ação

A ação Excluir problema fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Excluir problema:

Nome do resultado do script Valor
success true ou false

Baixar anexos

Use a ação Fazer o download de anexos para recuperar todos os arquivos anexados a um problema específico do Jira. Se um anexo for um arquivo .eml, a ação também fará o download de todos os arquivos contidos nesse e-mail.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Baixar anexos exige os seguintes parâmetros:

Parâmetro Descrição
Issue Key

Obrigatório.

A chave abreviada exclusiva do problema do Jira (por exemplo, SEC-123).
Download Path

Opcional.

O caminho local ou interno para a pasta em que a ação salva os anexos baixados.

O formato necessário depende do tipo de implantação:

  • Implantação de SaaS: o caminho é interno à plataforma hospedada, como /attachments/.
  • Implantação do agente remoto: o caminho precisa ser um caminho de diretório absoluto e válido na máquina local em que o agente remoto está instalado. Por exemplo, C:\temp\attachments para Windows ou /var/tmp/attachments/ para Linux.
Download Attachments to the Case Wall

Opcional.

Se selecionada, a ação baixa os anexos do problema do Jira diretamente para o Painel de Casos atual do Google SecOps.

Há uma limitação de tamanho para anexos adicionados ao Painel de Casos. Arquivos grandes podem não ser enviados.

Essa configuração está desativada por padrão.

Saídas de ação

A ação Baixar anexos fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Disponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo a seguir mostra a saída do resultado JSON recebida ao usar a ação Baixar anexos:

[
  {
    "download_path": "downloads/Security_Evidence.eml",
    "attachment_details": {
      "id": "10007",
      "filename": "Security_Evidence.eml",
      "author": {
        "displayName": "Security Analyst",
        "emailAddress": "analyst@example.com",
        "active": true,
        "timeZone": "Asia/Calcutta"
      },
      "created": "2024-05-25T20:27:09.066+0530",
      "size": 12049140,
      "mimeType": "message/rfc822"
    }
  },
  {
    "download_path": "downloads/Logs_Attachment.txt",
    "attachment_details": {
      "id": "10005",
      "filename": "Logs_Attachment.txt",
      "author": {
        "displayName": "System Admin",
        "emailAddress": "admin@example.com",
        "active": true,
        "timeZone": "Asia/Calcutta"
      },
      "created": "2024-05-16T11:48:24.141+0530",
      "size": 43,
      "mimeType": "text/plain"
    }
  }
]
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Baixar anexos:

Nome do resultado do script Valor
is_success true ou false

Receber problemas

Use a ação Receber problemas para extrair todos os detalhes de um ou mais problemas do Jira.

Essa ação é útil para enriquecer os casos do Google SecOps com metadados atuais do tíquete (como status, atribuição e prioridade).

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Receber problemas exige os seguintes parâmetros:

Parâmetro Descrição
Issue Keys

Obrigatório.

Uma lista separada por vírgulas de chaves de solicitação do Jira a serem buscadas (por exemplo, SEC-123, SEC-456).

Saídas de ação

A ação Receber problemas fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo a seguir mostra a saída do resultado JSON recebida ao usar a ação Get Issues:

{
  "issues_details_list": [
    {
      "key": "TES-65",
      "summary": "New summary",
      "description": "Detailed description of the security incident.",
      "project": {
        "key": "TES",
        "name": "test-project1",
        "projectTypeKey": "software"
      },
      "issuetype": {
        "name": "Bogue",
        "subtask": false
      },
      "status": {
        "name": "Fini",
        "statusCategory": {
          "name": "Terminé",
          "key": "done"
        }
      },
      "priority": {
        "name": "Medium",
        "id": "3"
      },
      "assignee": {
        "displayName": "Vasil Daskalov",
        "emailAddress": "vasil.daskalov@siemplify.co"
      },
      "creator": {
        "displayName": "admin@siemplifylab.local",
        "emailAddress": "admin@siemplifylab.local"
      },
      "created": "2021-08-31T12:15:22.089+0000",
      "updated": "2021-11-11T13:16:50.552+0000",
      "resolution": {
        "name": "Terminé",
        "description": "Ce ticket a été traité."
      },
      "labels": [],
      "components": []
    }
  ]
}
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Receber problemas:

Nome do resultado do script Valor
issues_details_list Uma lista com os metadados completos dos problemas do Jira solicitados.

Use a ação Vincular problemas para estabelecer uma relação entre vários problemas do Jira.

Essa ação é usada principalmente em playbooks para conectar incidentes de segurança relacionados ou rastrear dependências entre tíquetes de investigação.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação Vincular problemas exige os seguintes parâmetros:

Parâmetro Descrição
Inward Issue ID

Obrigatório.

Uma lista separada por vírgulas de IDs de problemas internos.

Por exemplo, se Relation Type estiver definido como Blocks, o problema vai mostrar a relação is blocked by na UI do Jira.
Outward Issue IDs

Obrigatório.

A chave abreviada da solicitação do Jira externa.

Por exemplo, se Relation Type estiver definido como Blocks, o problema vai mostrar a relação blocks na interface do Jira.
Relation Type

Obrigatório.

O tipo de link a ser criado entre os problemas.

Para conferir uma lista dos tipos de relação disponíveis, execute a ação List Relation Types.

O valor padrão é Blocks.

Saídas de ação

A ação Vincular problemas fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Vincular problemas pode retornar as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Successfully linked issue ISSUE_ID with the following issues in Jira: ISSUE_IDS.

A ação não conseguiu encontrar os seguintes problemas de destino no Jira: ISSUE_IDS.

 A ação foi concluída
Error executing action "Link Issues". Reason: ERROR_REASON

A ação falhou.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Vincular problemas:

Nome do resultado do script Valor
success true ou false

Listar problemas

Use a ação Listar problemas para pesquisar e recuperar uma lista de chaves de problema do Jira com base em critérios de filtragem específicos.

Essa ação é útil para identificar tíquetes que correspondem a um contexto de alerta para evitar duplicação ou fazer atualizações em massa em um playbook.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação List Issues oferece os seguintes parâmetros de filtragem opcionais. Se nenhum parâmetro for fornecido, a ação vai retornar todos os problemas acessíveis ao usuário da integração.

Parâmetro Descrição
Project Names

Opcional.

Uma lista separada por vírgulas de nomes de projetos para pesquisar.
Summary

Opcional.

Se fornecida, a ação filtra problemas pelo resumo ou título específico.
Description

Opcional.

Se fornecida, a ação filtra os problemas pelo texto contido na descrição.
Issue Types

Opcional.

Uma lista separada por vírgulas de tipos de problemas (por exemplo, Bug,Task).

O valor padrão é Bug.
Priorities

Opcional.

Uma lista separada por vírgulas de níveis de prioridade para filtrar (por exemplo, High,Medium).
Created From

Opcional.

Se fornecido, o filtro de ação será aplicado a problemas criados a partir dessa data (no formato YYYY/MM/DD).
Updated From

Opcional.

Se fornecido, o filtro de ações para problemas atualizados a partir dessa data (no formato YYYY/MM/DD).
Assignees

Opcional.

Uma lista separada por vírgulas de identificadores de atribuídos para filtrar.
Reporter

Opcional.

Uma lista separada por vírgulas de identificadores de repórter para filtrar.
Statuses

Opcional.

Uma lista separada por vírgulas de status de problemas para filtrar (por exemplo, Open,In Progress).

Saídas de ação

A ação Listar problemas fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo a seguir mostra a saída do resultado JSON recebida ao usar a ação List Issues:

[ 
  "PR-123", 
  "PR-124",
  "SEC-789"
]
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script ao usar a ação List Issues:

Nome do resultado do script Valor
issues Uma lista que contém as chaves abreviadas exclusivas dos problemas do Jira encontrados.

Listar tipos de relações

Use a ação Listar tipos de relação para recuperar uma lista de todos os tipos de relacionamento de link disponíveis configurados na sua instância do Jira.

Essa ação é útil para validar valores de entrada válidos para a ação Problemas de link.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

A ação List Relation Types exige os seguintes parâmetros:

Parâmetro Descrição
Filter Key

Opcional.

O campo usado para filtrar os tipos de relação.

Se a Lógica de filtro estiver definida como Equal ou Contains, selecione um campo diferente de Select One para evitar um erro de execução.

Os valores possíveis são:

  • Name
  • Inward
  • Outward

O valor padrão é Select One.
Filter Logic

Opcional.

O operador lógico aplicado ao filtro.

Os valores possíveis são:

  • Not Specified
  • Equal
  • Contains

O valor padrão é Not Specified.
Filter Value

Opcional.

O valor de string específico usado para filtrar com base no Filter Key e no Filter Logic selecionados.

Se nenhum valor for fornecido, o filtro não será aplicado, mesmo que uma chave e uma lógica sejam selecionadas.
Max Records To Return

Opcional.

O número máximo de registros a serem retornados nos resultados.

O valor padrão é 50.

Saídas de ação

A ação List Relation Types fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Disponível
Tabela de enriquecimento Indisponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Tabela do painel de casos

A ação List Relation Types (Listar tipos de relações) fornece a seguinte tabela:

Nome da tabela: Available Relation

Colunas da tabela:

  • Nome
  • Entrada
  • Outward (link em inglês)
Resultado JSON

O exemplo a seguir mostra a saída do resultado JSON recebida ao usar a ação List Relation Types:

[{
    "id": "10000",
    "name": "Blocks",
    "inward": "is blocked by",
    "outward": "blocks"
}]
Mensagens de saída

A ação List Relation Types pode retornar as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Successfully found relation types for the provided criteria in Jira.

The filter was not applied, because parameter "Filter Value" has an empty value.

 A ação foi concluída.
Error executing action "List Relation types". Reason: ERROR_REASON

A ação falhou.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script ao usar a ação List Relation Types:

Nome do resultado do script Valor
is_success true ou false

Ping

Use a ação Ping para testar a conectividade com o Jira.

Essa ação não é executada em entidades do Google SecOps.

Entradas de ação

Nenhuma.

Saídas de ação

A ação Ping fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Anexo do Painel de Casos Indisponível
Link do Painel de Casos Indisponível
Tabela do painel de casos Indisponível
Tabela de enriquecimento Indisponível
Resultado JSON Indisponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado do script

A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Ping:

Nome do resultado do script Valor
success true ou false

Atualizar problema

Descrição

Atualiza um problema. Para a nova API Jira, a ação tenta encontrar uma correspondência para o responsável e atribuir um problema com base no e-mail do usuário. Em seguida, ela tenta com o campo displayName.

Parâmetros

Parâmetro Tipo Valor padrão É obrigatório Descrição
Chave do problema String N/A Sim A chave do problema a ser atualizado.
Status String N/A Não Especifique o nome da transição relevante para mudar o problema para o novo status desejado.
Resumo String N/A Não O novo resumo do problema.
Descrição String N/A Não A nova descrição do problema.
Tipo de problema String N/A Não O novo tipo do problema.
Responsável String N/A Não O novo responsável pela questão.
Nome de usuário do Jira String N/A Não O nome de usuário do Jira do iniciador da ação.
Componentes String N/A Não

O campo "Componentes" do problema.

Esse parâmetro aceita vários valores como uma string separada por vírgulas.
Campos personalizados JSON NA Não

Especifique um objeto JSON que contenha todos os campos e valores usados durante a criação do problema.

Observação:esse parâmetro tem prioridade, e todos os campos são substituídos pelo valor fornecido para ele.

Exemplo: {"field":"value"}
Rótulos String N/A Não

O campo "Componentes" do problema.

Esse parâmetro aceita vários valores como uma string separada por vírgulas.

Executar em

Essa ação é executada em todas as entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor Exemplo
Sucesso Verdadeiro/falso Success:False
Resultado do JSON
{
   "comment":
     {
       "total": 0,
       "startAt": 0,
       "comments": [],
       "maxResults": 0
      },
   "creator":
     {
       "displayName": "user1",
       "name": "user1",
       "self": "",
       "avatarUrls":
          {
            "24x24": "",
            "16x16": "",
            "48x48": "",
            "32x32": ""
           },
        "emailAddress": "john_doe@example.com",
        "key": "user1user",
        "active": true,
        "timeZone": "Asia/Jerusalem",
        "accountId": "0"
       },
   "aggregatetimeestimate": null,
   "labels": ["Label1"],
   "aggregatetimespent": null,
   "watches":
      {
        "self": "",
        "watchCount": 1,
        "isWatching": false
       },
   "assignee":
      {
        "displayName": "user2",
        "name": "user2",
        "self": "",
        "avatarUrls":
           {
              "24x24": "",
              "16x16": "",
              "48x48": "",
              "32x32": ""
            },
        "emailAddress": "john_doe@example.com",
        "key": "user2",
        "active": true,
        "timeZone": "Asia/Jerusalem",
        "accountId": ""
       },
   "lastViewed": "2019-01-22T10:14:02.910+0200",
   "issuelinks": [],
   "Worklog":
      {
        "worklogs": [],
        "total": 0,
        "startAt": 0,
        "maxResults": 20
       },
   "aggregateprogress":
      {
        "progress": 0,
        "total": 0
       },
   "Priority":
      {
        "iconUrl": "",
        "self": "",
        "name": "Medium",
        "id": "3"
       },
   "votes":
       {
          "hasVoted": false,
          "self": "",
          "votes": 0
        },
   "workratio": -1,
   "fixVersions": [],
   "environment": null,
   "timespent": null,
   "attachment":
      [{
          "mimeType": "binary/octet-stream",
          "created": "2018-06-19T15:23:07.369+0300",
          "self": "",
          "author":
             {
               "displayName": "user1",
               "name": "user1",
               "self": "",
               "avatarUrls":
                  {
                     "24x24": "",
                     "16x16": "",
                     "48x48": "",
                     "32x32": ""
                   },
               "emailAddress": "john_doe@example.com",
               "key": "user1",
               "active": true,
               "timeZone": "Asia/Jerusalem",
               "accountId": "0"
              },
           "filename": "file.rar",
           "content": "",
           "id": "0",
           "size": 0
        }],
   "progress":
        {
          "progress": 0,
          "total": 0
         },
   "duedate": null,
   "status":
        {
          "statusCategory":
              {
                 "name": "Done",
                 "self": "",
                 "id": 3,
                 "key": "done",
                 "colorName": "green"
               },
          "description": "",
          "self": "",
          "iconUrl": "",
          "id": "0",
          "name": "DONE"
         },
   "updated": "2018-09-18T10:02:06.347+0300",
   "subtasks": [],
   "description": "Create Enrich entities action using Insights API (IOC search)\\n\\nWrite connector for laerts\\n\\nIn a couple of days we will have access to an instance",
   "reporter":
         {
           "displayName": "user1",
           "name": "user1",
           "self": "",
           "avatarUrls":
               {
                 "24x24": "",
                 "16x16": "",
                 "48x48": "",
                 "32x32": ""
               },
           "emailAddress": "john_doe@example.com",
           "key": "user1",
           "active": true,
           "timeZone": "Asia/Jerusalem",
           "accountId": "0"
          },
    "timeoriginalestimate": null,
    "aggregatetimeoriginalestimate": null,
    "created": "2018-06-19T15:23:13.701+0300",
    "versions": [],
    "resolutiondate": "2018-09-18T10:02:06.340+0300",
    "summary": "Sample issue",
    "project":
          {
             "name": "Project 1",
             "self": "",
             "projectTypeKey": "software",
             "avatarUrls":
                 {
                   "24x24": "",
                   "16x16": "",
                   "48x48": "",
                   "32x32": ""
                  },
             "key": "PR",
             "id": "0"
           },
    "timetracking": {},
    "components": [],
    "issuetype":
          {
             "name": "Task",
             "self": "",
             "iconUrl": "",
             "subtask": false,
             "avatarId": 10318,
             "id": "10002",
             "description": "A task that needs to be done."
           },
    "security": null,
    "resolution":
           {
             "id": "10000",
             "self": "",
             "description": "Work has been completed on this issue.",
              "name": "Done"
             },
    "timeestimate": null
}

Fazer upload de anexo

Descrição

Adicione um anexo a um problema.

Parâmetros

Parâmetro Tipo Valor padrão É obrigatório Descrição
Chave do problema String N/A Sim Caminhos de arquivos.
Caminhos de arquivos String N/A Sim

Os caminhos absolutos dos arquivos a serem enviados, separados por vírgulas.

O formato necessário depende do tipo de implantação:

  • Implantação de SaaS: o caminho é interno à plataforma hospedada, como /attachments/.
  • Implantação do agente remoto: o caminho precisa ser um caminho de diretório absoluto e válido na máquina local em que o agente remoto está instalado. Por exemplo, C:\temp\attachments para Windows ou /var/tmp/attachments/ para Linux.

Executar em

Essa ação é executada em todas as entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor Exemplo
is_success Verdadeiro/falso is_success:False
Resultado do JSON
N/A

Pesquisar usuários

Pesquise usuários no Jira.

Entidades

Essa ação não é executada em entidades.

Entradas de ação

Para configurar a ação, use os seguintes parâmetros:

Parâmetros
User Email Addresses Opcional

Lista de endereços de e-mail separados por vírgulas para retornar os usuários.
User Names Opcional

Lista separada por vírgulas de nomes de usuário para retornar os usuários.
Project Opcional

Nome do projeto em que os endereços de e-mail serão pesquisados. Se fornecido, apenas Project Assignable Users será retornado.

Saídas de ação

Tipo de saída da ação
Anexo do Painel de Casos N/A
Link do Painel de Casos N/A
Tabela do painel de casos N/A
Tabela de enriquecimento N/A
Resultado JSON Disponível
Resultado do script Disponível
Resultado do script
Nome do resultado do script Valor
is_success Verdadeiro/falso
Resultado JSON
[
 {
   "Entity": "example",
   "EntityResult": {
     "_resource": "user?accountId={0}",
     "_options": {
       "server": "https://siemplify.atlassian.net",
       "auth_url": "/rest/auth/1/session",
       "context_path": "/",
       "rest_path": "api",
       "rest_api_version": "2",
       "agile_rest_path": "agile",
       "agile_rest_api_version": "1.0",
       "verify": false,
       "resilient": true,
       "async": false,
       "async_workers": 5,
       "client_cert": null,
       "check_update": false,
       "delay_reload": 0,
       "headers": {
         "Cache-Control": "no-cache",
         "Content-Type": "application/json",
         "X-Atlassian-Token": "no-check"
       }
     },
     "_session": "<jira.resilientsession.ResilientSession object>",
     "_base_url": "{server}/rest/{rest_path}/{rest_api_version}/{path}",
     "raw": {
       "self": "https://siemplify.atlassian.net/rest/api/2/user?accountId=example-account-id",
       "accountId": "example-account-id",
       "accountType": "atlassian",
       "emailAddress": "example.user",
       "avatarUrls": {
         "48x48": "https://example.com"
       },
       "displayName": "Example",
       "active": true,
       "timeZone": "UTC",
       "locale": "en_US"
     },
     "self": "https://siemplify.atlassian.net/rest/api/2/user?accountId=example-account-id",
     "accountId": "example-account-id",
     "accountType": "atlassian",
     "emailAddress": "example.user",
     "avatarUrls": "<jira.resources.PropertyHolder object>",
     "displayName": "Example",
     "active": true,
     "timeZone": "UTC",
     "locale": "en_US"
   }
 }
]
Painel de casos

A ação fornece as seguintes mensagens de saída:

Mensagem de resposta Descrição da mensagem

Successfully found the following users in Jira for project PROJECT_NAME: USER_LIST

The following users were not found in Jira for project PROJECT_NAME: USER_LIST

None of the provided users were found in the project PROJECT_NAME

 A ação foi concluída.
Error executing action "Search Users". Reason: ERROR_REASON

Falha na ação.

Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais.

Conectores

Conector do Jira

Descrição

Extrair problemas do Jira para o Google SecOps.

Configurar o conector do Jira no Google SecOps

Para instruções detalhadas sobre como configurar um conector no Google SecOps, consulte Configurar o conector.

Parâmetros do conector

Use os seguintes parâmetros para configurar o conector:

Parâmetro Tipo Valor padrão É obrigatório Descrição
DeviceProductField String device_product Sim O nome do campo usado para determinar o produto do dispositivo.
EventClassId String nome Não O nome do campo usado para determinar o nome do evento (subtipo).
PythonProcessTimeout String 60 Sim O limite de tempo (em segundos) para o processo Python que executa o script atual.
Raiz da API String https://{jira_address} Sim A raiz da API da instância do Jira.
Nome de usuário String N/A Sim N/A
Token da API Senha N/A Sim

Token gerado no console do Jira.

Observação:esse parâmetro pode ser usado para conter a string "Password" (Senha) em caso de autenticação local, usando a combinação de nome de usuário e senha.
Dias para trás Número inteiro 5 Não Número máximo de dias para buscar alertas.
Máximo de tíquetes por ciclo Número inteiro 10 Não Número máximo de tíquetes a serem buscados e processados em um ciclo de conector.
Nomes de projetos String N/A Não Nomes de projetos separados por vírgula.
Status do problema String N/A Não Status dos problemas separados por vírgula.
Destinatários String N/A Não Nomes completos dos usuários separados por vírgula.
Tipos de problema String N/A Não Tipos de problema separados por vírgula.
Prioridades de problemas String N/A Não Prioridades de problemas separadas por vírgula.
Componentes do problema String N/A Não Problemas separados por vírgula.
Endereço do servidor proxy String N/A Não O endereço do servidor proxy a ser usado.
Nome de usuário do proxy String N/A Não O nome de usuário do proxy para autenticação.
Senha do proxy Senha N/A Não A senha do proxy para autenticação.
Nome do campo de ambiente String "" Não

Descreve o nome do campo em que o nome do ambiente é armazenado.

Se o campo de ambiente não for encontrado, o ambiente será o padrão.
Padrão de regex do ambiente String .* Não

Um padrão de regex a ser executado no valor encontrado no campo "Nome do campo de ambiente".

O padrão é ".*" para capturar tudo e retornar o valor sem alterações.

Usado para permitir que o usuário manipule o campo de ambiente usando a lógica de regex.

Se o padrão de regex for nulo ou vazio, ou se o valor do ambiente for nulo, o resultado final será o ambiente padrão.

Regras de conector

Suporte a proxy

O conector é compatível com proxy.

Lista dinâmica e lista de bloqueio

O conector é compatível com regras dinâmicas de lista de permissões e de bloqueio apenas para rótulos específicos no Jira.

Jobs

Trabalho de encerramento da sincronização

Descrição

Feche os tíquetes no Jira se os alertas correspondentes do Google SecOps forem fechados.

Parâmetros

Nome de exibição do parâmetro Tipo Valor padrão É obrigatório Descrição
Raiz da API String https://{jira_address} Sim URL raiz da API da instância do Jira.
Nome de usuário String N/A Sim Nome de usuário para se conectar à instância do Jira.
Token da API Senha N/A Sim

Token gerado no console do Jira.

Observação:esse parâmetro pode ser usado para conter a string "Password" (Senha) em caso de autenticação local, usando a combinação de nome de usuário e senha.
Nomes de projetos String nomes de projetos separados por vírgula Sim Nomes de projetos do Jira separados por uma vírgula que o job precisa monitorar.
Número máximo de dias para retroceder Número inteiro 1 Sim Número máximo de dias para sincronizar o status dos tíquetes retroativamente.

Trabalho de sincronização de comentários

Descrição

Sincronizar comentários entre o caso do Google SecOps e o tíquete correspondente do Jira. A sincronização é bidirecional, ou seja, do Google SecOps para o Jira e do Jira para o Google SecOps.

Quando o job cria um comentário, ele aplica o prefixo. Se um usuário do Google SecOps comentar no caso do Google SecOps, o job vai criar e sincronizar o comentário do usuário no tíquete correspondente do Jira usando o parâmetro Prefixo do comentário do Chronicle.

Esse recurso foi adicionado para duas finalidades:

  1. Visibilidade.
  2. Evite que os comentários adicionados pelo job sejam sincronizados novamente com o outro lado, causando um loop.

Parâmetros

Nome de exibição do parâmetro Tipo Valor padrão É obrigatório Descrição
Raiz da API String https://{jira_address} Sim URL raiz da API da instância do Jira.
Nome de usuário String N/A Sim Nome de usuário para se conectar à instância do Jira.
Token da API Senha N/A Sim

Token gerado no console do Jira.

Observação:esse parâmetro pode ser usado para conter a string "Password" (Senha) em caso de autenticação local, usando a combinação de nome de usuário e senha.
Nomes de projetos String nomes de projetos separados por vírgula Sim Nomes de projetos do Jira separados por vírgula que o job precisa monitorar.
Número máximo de dias para retroceder Número inteiro 1 Sim Número máximo de dias para sincronizar o status dos tíquetes retroativamente.
Prefixo de comentário do Google SecOps String Google SecOps: Sim Prefixo adicionado pelo job de sincronização aos comentários criados para tíquetes do Jira.
Prefixo do comentário do Jira String Trabalho de sincronização de comentários do Jira: Sim Prefixo adicionado pelo job de sincronização aos comentários de caso de alerta do Google SecOps.

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.