Integrar o ServiceNow ao Google SecOps
Versão da integração: 59.0
Este documento explica como integrar o ServiceNow ao Google Security Operations (Google SecOps).
Casos de uso
A integração do ServiceNow usa os recursos do Google SecOps para oferecer suporte aos seguintes casos de uso:
Emissão automática de tíquetes de incidentes: crie automaticamente incidentes do ServiceNow com base em alertas de segurança originados no SIEM ou em outras ferramentas de segurança.
Enriquecimento e resposta a incidentes: simplifique os fluxos de trabalho de resposta a incidentes reduzindo a emissão manual de tíquetes e enriquecendo os incidentes com informações relevantes do alerta de origem.
Correção de phishing: automatize etapas repetitivas de investigação de phishing, como coleta de cabeçalhos de e-mail, investigação de anexos e pesquisa de e-mails semelhantes, o que acelera os tempos de resposta.
Orquestração de correção de vulnerabilidades: orquestre fluxos de trabalho de correção de vulnerabilidades criando automaticamente solicitações de mudança do ServiceNow para ações de aplicação de patch ou mitigação com base nos resultados da verificação de vulnerabilidades.
Automação do ciclo de vida do usuário: automatize tarefas de provisionamento e remoção de provisionamento de usuários em vários sistemas (controle de acesso, plataformas de e-mail, aplicativos) com base em gatilhos de fluxos de trabalho do ServiceNow.
Contexto de inteligência de ameaças: enriqueça os alertas de segurança com dados de inteligência de ameaças provenientes diretamente da plataforma ServiceNow, oferecendo mais contexto para que os analistas priorizem as ações de resposta.
Antes de começar
Antes de configurar a integração na plataforma do Google SecOps, verifique se você concluiu os seguintes pré-requisitos:
Conta de usuário do ServiceNow: uma conta de usuário com permissões para criar e atualizar registros.
Funções do ServiceNow: as funções de sistema necessárias (
sn_incident_write,itil) e uma configuração de acesso do usuário personalizada (secops_user) para permitir o acesso a tabelas específicas.Conectividade de rede: uma configuração de rede que permite o tráfego de endereços IP do Google SecOps para sua instância do ServiceNow.
Credenciais do OAuth (opcional): o ID e a chave secreta do cliente se você planeja usar a autenticação OAuth 2.0.
Configurar o acesso do usuário no ServiceNow
Para permitir que a integração sincronize comentários e execute ações, é necessário realizar as seguintes tarefas administrativas na plataforma ServiceNow.
Para instruções específicas sobre como navegar na interface do ServiceNow, consulte a documentação oficial do produto ServiceNow.
Crie um papel personalizado: crie um novo papel (por exemplo,
secops_user) para processar permissões de integração específicas.Crie uma regra de ACL: a integração exige acesso à tabela
sys_journal_field, que é restrita a administradores por padrão. Crie uma ACL de operaçãoreadpara a tabelasys_journal_fielde atribua à sua função personalizada (secops_user).Atribua papéis ao usuário: atribua os seguintes papéis à conta de usuário do ServiceNow destinada à integração:
O papel personalizado que você criou.
sn_incident_write: obrigatório para as ações Fechar incidente e Atualizar incidente.itil: obrigatório para as ações Receber detalhes do registro da CMDB e Listar registros da CMDB.
Configurar a autenticação do OAuth 2.0 (opcional)
Recomendamos usar a autenticação OAuth 2.0. Esse processo exige ações no ServiceNow (para receber credenciais) e no Google SecOps (para gerar um token).
Criar um endpoint OAuth (ServiceNow)
Na sua instância do ServiceNow, verifique se o plug-in OAuth 2.0 está ativo e crie um endpoint de API OAuth para clientes externos.
Para instruções sobre como criar um endpoint, consulte Criar um endpoint para os clientes acessarem a instância.
Depois de criar, registre o ID do cliente e a chave secreta do cliente.
Gerar um token de atualização (Google SecOps)
Para gerar o token de atualização, configure temporariamente a integração para executar uma ação auxiliar.
No Google SecOps, navegue até Resposta > Configuração de integrações.
-
Configure uma instância temporária de integração do ServiceNow usando o Nome de usuário, a Senha, o ID do cliente e a Chave secreta do cliente.
Simule ou abra um caso.
Execute a ação Get Oauth Token do ServiceNow manualmente no caso.
Copie o valor
refresh_tokendo resultado JSON da ação para usar no campo Token de atualização ao configurar a integração.
Parâmetros de integração
A integração do ServiceNow exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Api Root |
Obrigatório. A raiz da API da instância do ServiceNow. O valor padrão é |
Username |
Obrigatório. O nome de usuário da conta do ServiceNow. |
Password |
Obrigatório. A senha da conta do ServiceNow. |
Incident Table |
Opcional. O nome da tabela da API ou o caminho a ser usado para ações relacionadas a incidentes e recuperação de registros. Por padrão, a integração usa o caminho |
Verify SSL |
Opcional. Se selecionada, a integração valida o certificado SSL ao se conectar ao servidor do ServiceNow. Ativado por padrão. |
Client ID |
Opcional. O ID do cliente para a integração do ServiceNow, necessário para a autenticação do OAuth 2.0 usando credenciais do cliente. É possível autenticar usando o token de atualização ou as credenciais do cliente. Se o token de atualização e as credenciais do cliente forem configurados, a integração usará o token de atualização para autenticação. |
Client Secret |
Opcional. A chave secreta do cliente para a integração do ServiceNow, necessária para a autenticação do OAuth 2.0 usando credenciais do cliente. É possível autenticar usando o token de atualização ou as credenciais do cliente. Se o token de atualização e as credenciais do cliente forem configurados, a integração usará o token de atualização para autenticação. |
Refresh Token |
Opcional. O token de atualização da integração do ServiceNow, necessário para a autenticação do OAuth 2.0 usando um token de atualização. O token de atualização configurado expira a cada 90 dias. É possível autenticar usando o token de atualização ou as credenciais do cliente. Se o token de atualização e as credenciais do cliente forem configurados, a integração usará o token de atualização para autenticação. |
Use Oauth Authentication |
Opcional. Se selecionada, a integração usa o OAuth 2.0 para autenticar. A autenticação OAuth 2.0 exige a definição das credenciais do cliente
( Essa configuração está desativada por padrão. |
Para instruções sobre como configurar uma integração no Google SecOps, consulte Configurar integrações.
É possível 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 anexo
Use a ação Adicionar anexo para adicionar anexos a um registro de tabela no ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Adicionar anexo exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Table Name |
Obrigatório. O nome da tabela que contém o registro em que o anexo é adicionado. |
Record Sys ID |
Obrigatório. O ID do sistema ( |
File Path |
Obrigatório. Uma lista separada por vírgulas de caminhos absolutos para os arquivos a serem anexados. |
Mode |
Opcional. O comportamento da ação quando um arquivo com o mesmo nome já existe no registro. Os valores possíveis são:
O valor padrão é |
Saídas de ação
A ação Adicionar anexo 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 Adicionar anexo:
{
"result": {
"size_bytes": "742",
"file_name": "placeholder_document.txt",
"sys_mod_count": "0",
"average_image_color": "",
"image_width": "",
"sys_updated_on": "2025-01-01 10:00:00",
"sys_tags": "",
"table_name": "incident",
"sys_id": "TEST_SYS_ID_ATTACH_123456789",
"image_height": "",
"sys_updated_by": "admin",
"download_link": "https://placeholder.service-now.com/api/now/attachment/TEST_SYS_ID_ATTACH_123456789/file",
"content_type": "multipart/form-data",
"sys_created_on": "2025-01-01 10:00:00",
"size_compressed": "438",
"compressed": "true",
"state": "pending",
"table_sys_id": "TEST_SYS_ID_RECORD_ABCDEFG",
"chunk_size_bytes": "700000",
"hash": "test_hash_0000000000000000000000000000000000000000000000000000000000000000",
"sys_created_by": "admin"
}
}
Mensagens de saída
A ação Adicionar anexo pode retornar as seguintes mensagens de saída:
| Mensagem de resposta | Descrição da mensagem |
|---|---|
|
A ação foi concluída. |
Error executing action "Add Attachment". 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 Adicionar anexo:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Adicionar comentário
Use a ação Adicionar comentário para incluir um comentário em um incidente do ServiceNow.
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 |
|---|---|
Incident Number |
Obrigatório. O número do incidente a que o comentário será adicionado, no formato
|
Comment |
Obrigatório. O comentário a ser adicionado ao incidente. |
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 os valores da saída do resultado do script ao usar a ação Adicionar comentário:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Adicionar comentário e aguardar resposta
Use a ação Adicionar comentário e aguardar resposta para adicionar um comentário a um incidente do ServiceNow e pausar a execução do playbook até que um novo comentário ou resposta seja adicionado a esse incidente. A saída da ação é o conteúdo do novo comentário.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Adicionar comentário e aguardar resposta exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Incident Number |
Obrigatório. O número do incidente a que o comentário será adicionado, no formato
|
Comment |
Obrigatório. O comentário a ser adicionado ao incidente. |
Saídas de ação
A ação Adicionar comentário e aguardar resposta 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 e aguardar resposta:
| Nome do resultado do script | Valor |
|---|---|
new_comment |
Adicionar comentário ao registro
Use a ação Adicionar comentário ao registro para adicionar um comentário ou uma nota de trabalho a um registro de tabela específico no ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Adicionar comentário ao registro exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Table Name |
Obrigatório. O nome da tabela em que o comentário ou a observação será adicionado. |
Type |
Obrigatório. O tipo de comentário ou observação a ser adicionado. Os valores possíveis são:
O valor padrão é |
Record Sys ID |
Obrigatório. O ID do sistema ( |
Text |
Obrigatório. O conteúdo do comentário ou da observação de trabalho. |
Wait For Reply |
Opcional. Se selecionada, a ação será executada de forma assíncrona e pausará a execução até que um novo comentário ou observação de trabalho seja adicionado ao registro. A ação rastreia comentários se você adicionar um, e observações de trabalho se você adicionar uma. Essa configuração está desativada por padrão. |
Saídas de ação
A ação Adicionar comentário ao registro 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 Adicionar comentário ao registro:
{
"sys_id": "4355183607523010ff23f6fd7c1ed0a8",
"sys_created_on": "2021-09-03 10:29:48",
"name": "incident",
"element_id": "552c48888c033300964f4932b03eb092",
"sys_tags": "",
"value": "Test comment content.",
"sys_created_by": "admin",
"element": "comments"
}
Mensagens de saída
A ação Adicionar comentário ao registro pode retornar as seguintes mensagens de saída:
| Mensagem de resposta | Descrição da mensagem |
|---|---|
Successfully added
COMMENT_OR_NOTE "
CONTENT" to TABLE_NAME
with Sys_ID SYS_ID in ServiceNow.
|
A ação foi concluída. |
Error executing action "Add Comment To Record". 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 Adicionar comentário ao registro:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Adicionar incidente principal
Use a ação Adicionar incidente principal para adicionar um incidente principal a incidentes no ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Adicionar incidente principal exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Parent Incident Number |
Obrigatório. O número do incidente principal, no formato
A ação adiciona todos os incidentes em |
Child Incident Numbers |
Obrigatório. Uma lista separada por vírgulas de números de incidentes a serem definidos como incidentes secundários para
o incidente principal especificado, no formato
|
Saídas de ação
A ação Adicionar incidente principal 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 Adicionar incidente principal:
{
"result": [
{
"parent": "",
"made_sla": "true",
"caused_by": "",
"watch_list": "",
"upon_reject": "cancel",
"sys_updated_on": "2020-10-20 07:19:11",
"child_incidents": "0",
"hold_reason": "",
"approval_history": "",
"skills": "",
"number": "INC0010009",
"resolved_by": "",
"sys_updated_by": "admin",
"opened_by": {
"link": "https://example.service-now.com/api/now/table/sys_user/ID",
"value": "ID"
},
"user_input": "",
"sys_created_on": "2020-10-20 07:19:11",
"sys_domain": {
"link": "https://example.service-now.com/api/now/table/sys_user_group/global",
"value": "global"
},
"state": "1",
"sys_created_by": "admin",
"knowledge": "false",
"order": "",
"calendar_stc": "",
"closed_at": "",
"cmdb_ci": "",
"delivery_plan": "",
"contract": "",
"impact": "3",
"active": "true",
"work_notes_list": "",
"business_service": "",
"priority": "5",
"sys_domain_path": "/",
"rfc": "",
"time_worked": "",
"expected_start": "",
"opened_at": "2020-10-20 07:18:56",
"business_duration": "",
"group_list": "",
"work_end": "",
"caller_id": {
"link": "https://example.service-now.com/api/now/table/sys_user/ID",
"value": "ID"
},
"reopened_time": "",
"resolved_at": "",
"approval_set": "",
"subcategory": "",
"work_notes": "",
"short_description": "Assessment : Assessor",
"close_code": "",
"correlation_display": "",
"delivery_task": "",
"work_start": "",
"assignment_group": "",
"additional_assignee_list": "",
"business_stc": "",
"description": "",
"calendar_duration": "",
"close_notes": "",
"notify": "1",
"service_offering": "",
"sys_class_name": "incident",
"closed_by": "",
"follow_up": "",
"parent_incident": {
"link": "https://example.service-now.com/api/now/table/incident/ID",
"value": "ID"
},
"sys_id": "2a100a1c2fc42010c518532a2799b621",
"contact_type": "",
"reopened_by": "",
"incident_state": "1",
"urgency": "3",
"problem_id": "",
"company": "",
"reassignment_count": "0",
"activity_due": "",
"assigned_to": "",
"severity": "3",
"comments": "",
"approval": "not requested",
"sla_due": "",
"comments_and_work_notes": "",
"due_date": "",
"sys_mod_count": "0",
"reopen_count": "0",
"sys_tags": "",
"escalation": "0",
"upon_approval": "proceed",
"correlation_id": "",
"location": "",
"category": "inquiry"
}
]
}
Mensagens de saída
A ação Adicionar incidente principal pode retornar as seguintes mensagens de saída:
| Mensagem de resposta | Descrição da mensagem |
|---|---|
Successfully set
PARENT_INCIDENT_NUMBER as the
"Parent Incident" for the following incidents in ServiceNow:
CHILD_INCIDENT_NUMBERS. |
A ação foi concluída. |
Error executing action "Add Parent Incident".
Reason: ERROR_REASON |
A ação falhou. Verifique a conexão com o servidor, os parâmetros de entrada ou as credenciais. |
Fechar incidente
Use a ação Fechar incidente para fechar um incidente do ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Encerrar incidente exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Incident Number |
Obrigatório. O número do incidente a ser fechado, no formato
|
Close Reason |
Obrigatório. O motivo para encerrar o incidente. |
Resolution Code |
Obrigatório. O código de resolução do incidente. Os valores possíveis são:
O valor padrão é |
Close Notes |
Obrigatório. As notas de encerramento do incidente. |
Saídas de ação
A ação Fechar incidente 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 Encerrar incidente:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Criar incidente de alerta
Use a ação Criar incidente de alerta para criar um incidente no ServiceNow com base nos detalhes do alerta que inicia a execução do playbook.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Criar incidente de alerta exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Impact |
Obrigatório. O nível de impacto do incidente. Os valores possíveis são:
O valor padrão é |
Urgency |
Obrigatório. O nível de urgência do incidente. Os valores possíveis são os seguintes:
O valor padrão é |
Category |
Opcional. A categoria do incidente. |
Assignment Group ID |
Opcional. O nome completo do grupo a que o incidente será atribuído. |
Assigned User ID |
Opcional. O nome completo do usuário a quem o incidente será atribuído. |
Description |
Opcional. A descrição do incidente. |
Saídas de ação
A ação Criar incidente 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 ao usar a ação Criar incidente de alerta:
{
"sys_tags": " ",
"user_input": " ",
"calendar_stc": " ",
"subcategory": " ",
"watch_list": " ",
"follow_up": " ",
"made_sla": "true",
"sys_created_by": "admin",
"sla_due": " ",
"number": "INC0010005",
"group_list": " ",
"reassignment_count": "0",
"assigned_to": " ",
"sys_mod_count": "0",
"notify": "1",
"resolved_by": " ",
"upon_reject": "cancel",
"additional_assignee_list": " ",
"category": "inquiry",
"closed_at": " ",
"parent_incident": " ",
"cmdb_ci": " ",
"contact_type": " ",
"impact": "1",
"rfc": " ",
"expected_start": " ",
"knowledge": "false",
"sys_updated_by":
"admin", "caused_by": " ",
"comments": " ",
"closed_by": " ",
"priority": "1",
"state": "1",
"sys_id": "ID",
"opened_at": "2020-07-10 05:13:25",
"child_incidents": "0",
"work_notes": " ",
"delivery_task": " ",
"short_description": "4187b92c-7aaa-40ec-a032-833dd5a854e6",
"comments_and_work_notes": " ",
"time_worked": " ",
"upon_approval": "proceed",
"company": " ",
"business_stc": " ",
"correlation_display": " ",
"sys_class_name": "incident",
"delivery_plan": " ",
"escalation": "0",
"description": " ",
"parent": " ",
"close_notes": " ",
"business_duration": " ",
"problem_id": " ",
"sys_updated_on": "2020-07-10 05:13:25",
"approval_history": " ",
"approval_set": " ",
"business_service": " ",
"reopened_by": " ",
"calendar_duration": " ",
"caller_id": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"active": "true",
"approval": "not requested",
"service_offering": " ",
"sys_domain_path": "/",
"hold_reason": " ",
"activity_due": "2020-07-10 07:13:25",
"severity": "3",
"incident_state": "1",
"resolved_at": " ",
"location": " ",
"due_date": " ",
"work_start": " ",
"work_end": " ",
"work_notes_list": " ",
"sys_created_on": "2020-07-10 05:13:25",
"correlation_id": " ",
"contract": " ",
"reopened_time": " ",
"opened_by": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"close_code": " ",
"assignment_group": " ",
"sys_domain": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user_group/global",
"value": "global"
},
"order": " ",
"urgency": "1",
"reopen_count": "0"
}
Resultado do script
A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Criar incidente de alerta:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Criar incidente
Use a ação Criar incidente para criar um incidente no ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Criar incidente exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Short Description |
Obrigatório. A breve descrição do incidente. |
Impact |
Obrigatório. O nível de impacto do incidente. Os valores possíveis são:
O valor padrão é |
Urgency |
Obrigatório. O nível de urgência do incidente. Os valores possíveis são os seguintes:
O valor padrão é |
Category |
Opcional. A categoria do incidente. |
Assignment Group ID |
Opcional. O nome completo do grupo a que o incidente será atribuído. |
Assigned User ID |
Opcional. O nome completo do usuário a quem o incidente será atribuído. |
Description |
Opcional. A descrição do incidente. |
Custom Fields |
Opcional. Uma lista separada por vírgulas de nomes de campos e os valores correspondentes a serem incluídos no novo registro de incidente do ServiceNow, no formato É possível usar esse parâmetro para definir valores de campos não listados explicitamente como entradas de ação (como "location" ou "priority"). |
Saídas de ação
A ação Criar incidente 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 incidente:
{
"sys_tags": " ",
"user_input": " ",
"calendar_stc": " ",
"subcategory": " ",
"watch_list": " ",
"follow_up": " ",
"made_sla": "true",
"sys_created_by": "admin",
"sla_due": " ",
"number": "INC0010005",
"group_list": " ",
"reassignment_count": "0",
"assigned_to": " ",
"sys_mod_count": "0",
"notify": "1",
"resolved_by": " ",
"upon_reject": "cancel",
"additional_assignee_list": " ",
"category": "inquiry",
"closed_at": " ",
"parent_incident": " ",
"cmdb_ci": " ",
"contact_type": " ",
"impact": "1",
"rfc": " ",
"expected_start": " ",
"knowledge": "false",
"sys_updated_by":
"admin", "caused_by": " ",
"comments": " ",
"closed_by": " ",
"priority": "1",
"state": "1",
"sys_id": "ID",
"opened_at": "2020-07-10 05:13:25",
"child_incidents": "0",
"work_notes": " ",
"delivery_task": " ",
"short_description": "4187b92c-7aaa-40ec-a032-833dd5a854e6",
"comments_and_work_notes": " ",
"time_worked": " ",
"upon_approval": "proceed",
"company": " ",
"business_stc": " ",
"correlation_display": " ",
"sys_class_name": "incident",
"delivery_plan": " ",
"escalation": "0",
"description": " ",
"parent": " ",
"close_notes": " ",
"business_duration": " ",
"problem_id": " ",
"sys_updated_on": "2020-07-10 05:13:25",
"approval_history": " ",
"approval_set": " ",
"business_service": " ",
"reopened_by": " ",
"calendar_duration": " ",
"caller_id": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"active": "true",
"approval": "not requested",
"service_offering": " ",
"sys_domain_path": "/",
"hold_reason": " ",
"activity_due": "2020-07-10 07:13:25",
"severity": "3",
"incident_state": "1",
"resolved_at": " ",
"location": " ",
"due_date": " ",
"work_start": " ",
"work_end": " ",
"work_notes_list": " ",
"sys_created_on": "2020-07-10 05:13:25",
"correlation_id": " ",
"contract": " ",
"reopened_time": " ",
"opened_by": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"close_code": " ",
"assignment_group": " ",
"sys_domain": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user_group/global",
"value": "global"
},
"order": " ",
"urgency": "1",
"reopen_count": "0"
}
Resultado do script
A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Criar incidente:
| Nome do resultado do script | Valor |
|---|---|
incident_number |
INCIDENT_NUMBER |
Criar registro
Use a ação Criar registro para criar registros em diferentes tabelas do ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Criar registro exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Table Name |
Opcional. O nome da tabela do ServiceNow em que o novo registro é criado (por exemplo, |
Object Json Data |
Opcional. O objeto JSON que contém os pares campo-valor necessários para definir o novo registro (como campos de incidente ou atributos de item da CMDB). |
Saídas de ação
A ação Criar registro 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 registro:
{
"sys_tags": " ",
"user_input": " ",
"calendar_stc": " ",
"subcategory": " ",
"watch_list": " ",
"follow_up": " ",
"made_sla": "true",
"sys_created_by": "admin",
"sla_due": " ",
"number": "INC0010021",
"group_list": " ",
"reassignment_count": "0",
"assigned_to": " ",
"sys_mod_count": "0",
"notify": "1",
"resolved_by": " ",
"upon_reject": "cancel",
"additional_assignee_list": " ",
"category": "inquiry",
"closed_at": " ",
"parent_incident": " ",
"cmdb_ci": " ",
"contact_type": " ",
"impact": "3",
"rfc": " ",
"expected_start": " ",
"knowledge": "false",
"sys_updated_by": "admin",
"caused_by": " ",
"comments": " ",
"closed_by": " ",
"priority": "5",
"state": "1",
"sys_id": "ID",
"opened_at": "2020-07-10 08:24:34",
"child_incidents": "0",
"work_notes": " ",
"delivery_task": " ",
"short_description": " ",
"comments_and_work_notes": " ",
"time_worked": " ",
"upon_approval": "proceed",
"company": " ",
"business_stc": " ",
"correlation_display": " ",
"sys_class_name": "incident",
"delivery_plan": " ",
"escalation": "0",
"description": " ",
"parent": " ",
"close_notes": " ",
"business_duration": " ",
"problem_id": " ",
"sys_updated_on": "2020-07-10 08:24:34",
"approval_history": " ",
"approval_set": " ",
"business_service": " ",
"reopened_by": " ",
"calendar_duration": " ",
"caller_id": " ",
"active": "true",
"approval": "not requested",
"service_offering": " ",
"sys_domain_path": "/",
"hold_reason": " ",
"activity_due": " ",
"severity": "3",
"incident_state": "1",
"resolved_at": " ",
"location": " ",
"due_date": " ",
"work_start": " ",
"work_end": " ",
"work_notes_list": " ",
"sys_created_on": "2020-07-10 08:24:34",
"correlation_id": " ",
"contract": " ",
"reopened_time": " ",
"opened_by": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"close_code": " ",
"assignment_group": " ",
"sys_domain": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user_group/global",
"value": "global"
},
"order": " ",
"urgency": "3",
"reopen_count": "0"
}
Resultado do script
A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Criar registro:
| Nome do resultado do script | Valor |
|---|---|
object_sys_id |
OBJECT_SYS_ID |
Baixar anexos
Use a ação Baixar anexos para baixar arquivos e documentos anexados a um registro específico do ServiceNow em uma pasta local no seu ambiente do Google SecOps.
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 |
|---|---|
Table Name |
Obrigatório. O nome da tabela do ServiceNow que contém o registro para baixar
anexos (como |
Record Sys ID |
Obrigatório. O ID do sistema ( |
Download Folder Path |
Obrigatório. O caminho absoluto para a pasta no ambiente do Google SecOps em que os anexos baixados são salvos. |
Overewrite |
Opcional. Se selecionada, a ação vai substituir arquivos com o mesmo nome. 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 | 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 Baixar anexos:
{
"result": [
{"absolute_file_path" : ["PATH"]
"size_bytes": "187",
"file_name": "example.txt",
"sys_mod_count": "1",
"average_image_color": "",
"image_width": "",
"sys_updated_on": "2020-10-19 09:58:39",
"sys_tags": "",
"table_name": "problem",
"sys_id": "SYS_ID",
"image_height": "",
"sys_updated_by": "system",
"download_link": "https://example.service-now.com/api/now/attachment/ID/file",
"content_type": "text/plain",
"sys_created_on": "2020-10-19 09:58:38",
"size_compressed": "172",
"compressed": "true",
"state": "available",
"table_sys_id": "57771d002f002010c518532a2799b6cc",
"chunk_size_bytes": "700000",
"hash": "a4fbb8ab71268903845b59724835274ddc66e095de553c5e0c1da8fecd04ee45",
"sys_created_by": "admin"
}
]
}
Mensagens de saída
A ação Ping pode retornar as seguintes mensagens de saída:
| Mensagem de resposta | Descrição da mensagem |
|---|---|
|
A ação foi concluída. |
Error executing action "Download Attachments". 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 Fazer o download dos anexos:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Receber detalhes do incidente secundário
Use a ação Receber detalhes do incidente secundário para recuperar informações sobre incidentes secundários com base no incidente principal no ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Receber detalhes do incidente secundário exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Parent Incident Number |
Obrigatório. O número do incidente principal de que serão extraídos os detalhes do incidente secundário, no formato |
Max Child Incident To Return |
Opcional. O número máximo de incidentes filhos que a ação retorna do incidente principal. O valor padrão é |
Saídas de ação
A ação Receber detalhes do incidente secundá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 | 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 Receber detalhes do incidente secundário fornece a seguinte tabela:
Nome da tabela: Detalhes do incidente secundário
Colunas da tabela:
- ID do sistema (mapeado como
sys_id) - Número (mapeado como
number) - Descrição breve (mapeada como
short_description) - Data de criação (mapeada como
sys_created_on)
Resultado JSON
O exemplo a seguir mostra a saída do resultado JSON recebida ao usar a ação Receber detalhes do incidente secundário:
{
"result": [
{
"parent": "",
"made_sla": "true",
"caused_by": "",
"watch_list": "",
"upon_reject": "cancel",
"sys_updated_on": "2020-10-20 07:19:11",
"child_incidents": "0",
"hold_reason": "",
"approval_history": "",
"skills": "",
"number": "INC0010009",
"resolved_by": "",
"sys_updated_by": "admin",
"opened_by": {
"link": "https://example.service-now.com/api/now/table/sys_user/ID",
"value": "ID"
},
"user_input": "",
"sys_created_on": "2020-10-20 07:19:11",
"sys_domain": {
"link": "https://example.service-now.com/api/now/table/sys_user_group/global",
"value": "global"
},
"state": "1",
"sys_created_by": "admin",
"knowledge": "false",
"order": "",
"calendar_stc": "",
"closed_at": "",
"cmdb_ci": "",
"delivery_plan": "",
"contract": "",
"impact": "3",
"active": "true",
"work_notes_list": "",
"business_service": "",
"priority": "5",
"sys_domain_path": "/",
"rfc": "",
"time_worked": "",
"expected_start": "",
"opened_at": "2020-10-20 07:18:56",
"business_duration": "",
"group_list": "",
"work_end": "",
"caller_id": {
"link": "https://example.service-now.com/api/now/table/sys_user/ID",
"value": "ID"
},
"reopened_time": "",
"resolved_at": "",
"approval_set": "",
"subcategory": "",
"work_notes": "",
"short_description": "Assessment : ATF Assessor",
"close_code": "",
"correlation_display": "",
"delivery_task": "",
"work_start": "",
"assignment_group": "",
"additional_assignee_list": "",
"business_stc": "",
"description": "",
"calendar_duration": "",
"close_notes": "",
"notify": "1",
"service_offering": "",
"sys_class_name": "incident",
"closed_by": "",
"follow_up": "",
"parent_incident": {
"link": "https://example.service-now.com/api/now/table/incident/ID",
"value": "ID"
},
"sys_id": "2a100a1c2fc42010c518532a2799b621",
"contact_type": "",
"reopened_by": "",
"incident_state": "1",
"urgency": "3",
"problem_id": "",
"company": "",
"reassignment_count": "0",
"activity_due": "",
"assigned_to": "",
"severity": "3",
"comments": "",
"approval": "not requested",
"sla_due": "",
"comments_and_work_notes": "",
"due_date": "",
"sys_mod_count": "0",
"reopen_count": "0",
"sys_tags": "",
"escalation": "0",
"upon_approval": "proceed",
"correlation_id": "",
"location": "",
"category": "inquiry"
}
]
}
Mensagens de saída
A ação Receber detalhes do incidente secundário pode retornar as seguintes mensagens de saída:
| Mensagem de resposta | Descrição da mensagem |
|---|---|
|
A ação foi concluída. |
Error executing action "Get Child Incident Details". 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 Receber detalhes do incidente secundário:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Acessar detalhes do registro da CMDB
Use a ação Receber detalhes do registro do CMDB para receber registros detalhados do CMDB da mesma classe no ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Receber detalhes do registro do CMDB exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Class Name |
Obrigatório. O nome da classe da CMDB de que os registros serão recuperados, como
Para mais informações sobre nomes de classes, consulte Ver e editar a definição e os metadados de uma classe. |
Sys ID |
Obrigatório. Uma lista separada por vírgulas dos IDs do sistema (`sys_id`) dos registros da CMDB para os quais os detalhes serão recuperados. |
Max Records To Return |
Opcional. O número máximo de relações de registros a serem retornadas para cada tipo de relação (como O valor padrão é |
Saídas de ação
A ação Receber detalhes do registro da CMDB 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 Receber detalhes do registro do CMDB:
{
"result": {
"outbound_relations": [
{
"sys_id": "56f3a7ad7f701200bee45f19befa910f",
"type": {
"display_value": "Members::Member of",
"link": "https://example.service-now.com/api/now/table/cmdb_rel_type/ID",
"value": "ID"
},
"target": {
"display_value": "Example",
"link": "https://example.service-now.com/api/now/cmdb/instance/cmdb_ci/ID",
"value": "ID"
}
}
],
"attributes": {
"attested_date": "",
"skip_sync": "false",
"operational_status": "1",
"caption": "",
"cluster_type": "",
"sys_updated_on": "2016-01-06 19:04:07",
"attestation_score": "",
"discovery_source": "",
"first_discovered": "",
"sys_updated_by": "example.user",
"cluster_status": "",
"due_in": "",
"sys_created_on": "2016-01-06 16:47:15",
"sys_domain": {
"display_value": "global",
"link": "https://example.service-now.com/api/now/table/sys_user_group/global",
"value": "global"
},
"install_date": "",
"invoice_number": "",
"gl_account": "",
"sys_created_by": "example.user",
"warranty_expiration": "",
"cluster_version": "",
"asset_tag": "",
"fqdn": "",
"change_control": "",
"owned_by": "",
"checked_out": "",
"sys_domain_path": "/",
"delivery_date": "",
"maintenance_schedule": "",
"install_status": "1",
"cost_center": "",
"attested_by": "",
"supported_by": "",
"dns_domain": "",
"name": "SAP-LB-Win-Cluster",
"assigned": "",
"purchase_date": "",
"subcategory": "Cluster",
"short_description": "",
"assignment_group": "",
"managed_by": "",
"managed_by_group": "",
"last_discovered": "",
"can_print": "false",
"sys_class_name": "cmdb_ci_win_cluster",
"manufacturer": "",
"sys_id": "SYS_ID",
"cluster_id": "",
"po_number": "",
"checked_in": "",
"sys_class_path": "/!!/!5/!$",
"vendor": "",
"mac_address": "",
"company": "",
"model_number": "",
"justification": "",
"department": "",
"assigned_to": "",
"start_date": "",
"cost": "",
"comments": "",
"sys_mod_count": "1",
"serial_number": "",
"monitor": "false",
"model_id": "",
"ip_address": "",
"duplicate_of": "",
"sys_tags": "",
"cost_cc": "USD",
"support_group": "",
"order_date": "",
"schedule": "",
"environment": "",
"due": "",
"attested": "false",
"unverified": "false",
"correlation_id": "",
"attributes": "",
"location": "",
"asset": "",
"category": "Resource",
"fault_count": "0",
"lease_id": ""
},
"inbound_relations": [
{
"sys_id": "3b3d95297f701200bee45f19befa910c",
"type": {
"display_value": "Depends on::Used by",
"link": "https://example.service-now.com/api/now/table/cmdb_rel_type/ID",
"value": "ID"
},
"target": {
"display_value": "IP-Router-3",
"link": "https://example.service-now.com/api/now/cmdb/instance/cmdb_ci/ID",
"value": "ID"
}
}
]
}
}
Mensagens de saída
A ação Receber detalhes do registro da CMDB pode retornar as seguintes mensagens de saída:
| Mensagem de resposta | Descrição da mensagem |
|---|---|
|
A ação foi concluída. |
Error executing action "Get CMDB Record Details". 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 Receber detalhes do registro da CMDB:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Acessar incidente
Use a ação Receber incidente para recuperar informações sobre um incidente do ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Receber incidente exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Incident Number |
Obrigatório. O identificador exclusivo do incidente do ServiceNow a ser recuperado, no formato |
Saídas de ação
A ação Get Incident 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 Incident:
{
"sys_tags": " ",
"user_input": " ",
"calendar_stc": "2012",
"subcategory": " ",
"watch_list": " ",
"follow_up": " ",
"made_sla": "true",
"sys_created_by": "admin",
"sla_due": " ",
"number": "INC0010041",
"group_list": " ",
"reassignment_count": "0",
"assigned_to": " ",
"sys_mod_count": "10",
"notify": "1",
"resolved_by": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"upon_reject": "cancel",
"additional_assignee_list": " ",
"category": "inquiry",
"closed_at": "2020-07-10 12:53:06",
"parent_incident": " ",
"cmdb_ci": " ",
"contact_type": " ",
"impact": "1",
"rfc": " ",
"expected_start": " ",
"knowledge": "false",
"sys_updated_by": "admin",
"caused_by": " ",
"comments": " ",
"closed_by": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"priority": "1",
"state": "7",
"sys_id": "SYS_ID",
"opened_at": "2020-07-10 12:18:04",
"child_incidents": "0",
"work_notes": " ",
"delivery_task": " ",
"short_description": "sdf",
"comments_and_work_notes": " ",
"time_worked": " ",
"upon_approval": "proceed",
"company": " ",
"business_stc": "0",
"correlation_display": " ",
"sys_class_name": "incident",
"delivery_plan": " ",
"escalation": "0",
"description": " ",
"parent": " ",
"close_notes": "Closed by Caller",
"business_duration": "1970-01-01 00:00:00",
"problem_id": " ",
"sys_updated_on": "2020-07-10 13:13:57",
"approval_history": " ",
"approval_set": " ",
"business_service": " ",
"reopened_by": " ",
"calendar_duration": "1970-01-01 00:35:02",
"caller_id": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"active": "false",
"approval": "not requested",
"service_offering": " ",
"sys_domain_path": "/",
"hold_reason": " ",
"activity_due": "2020-07-10 14:33:28",
"severity": "3",
"incident_state": "7",
"resolved_at": "2020-07-10 12:53:06",
"location": " ",
"due_date": " ",
"work_start": " ",
"work_end": " ",
"work_notes_list": " ",
"sys_created_on": "2020-07-10 12:18:04",
"correlation_id": " ",
"contract": " ",
"reopened_time": " ",
"opened_by": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"close_code": "Closed/Resolved by Caller",
"assignment_group": " ",
"sys_domain": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user_group/global",
"value": "global"
},
"order": " ",
"urgency": "1",
"reopen_count": "0"
}
Resultado do script
A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Receber incidente:
| Nome do resultado do script | Valor |
|---|---|
incident_number |
INCIDENT_NUMBER |
Receber token do OAuth
Use a ação Get Oauth Token para receber um token de atualização do OAuth para o ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
Nenhuma.
Saídas de ação
A ação Receber token do OAuth 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 Oauth Token:
{
"access_token": "Na4Kb1oWpFcYNUnyAjsYldiTMxYF1Cz79Q",
"refresh_token": "0ryCENbbvfggZbNG9rFFd8_C8X0UgAQSMQkPJNStGwEEt0qNt-F1lw",
"scope": "useraccount",
"token_type": "Bearer",
"expires_in": 1799
}
Mensagens de saída
A ação Get Oauth Token pode retornar as seguintes mensagens de saída:
| Mensagem de resposta | Descrição da mensagem |
|---|---|
Successfully generated Oauth tokens for ServiceNow. Now navigate
to the configuration tab and put "refresh_token" value in the "Refresh
Token" parameter. Note: "Username" and "Password" parameters can be
emptied. |
A ação foi concluída. |
Error executing action "Get Oauth Token". 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 Get Oauth Token:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Acessar detalhes do registro
Use a ação Receber detalhes do registro para recuperar informações sobre registros de tabela específicos no ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Receber detalhes do registro exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Table Name |
Obrigatório. O nome da tabela do ServiceNow que contém o registro para recuperar
informações (como |
Record Sys ID |
Obrigatório. O ID do sistema ( |
Fields |
Opcional. Uma lista separada por vírgulas de campos (colunas) específicos a serem retornados do
registro recuperado (como Se nenhum valor for fornecido, a ação vai retornar os campos padrão do registro. |
Saídas de ação
A ação Extrair detalhes do registro 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 Receber detalhes do registro:
{
"result": [
{
"parent": "",
"made_sla": "true",
"caused_by": "",
"watch_list": "",
"upon_reject": "cancel",
"sys_updated_on": "2020-10-20 07:19:11",
"child_incidents": "0",
"hold_reason": "",
"approval_history": "",
"skills": "",
"number": "INC0010009",
"resolved_by": "",
"sys_updated_by": "admin",
"opened_by": {
"link": "https://example.service-now.com/api/now/table/sys_user/ID",
"value": "ID"
},
"user_input": "",
"sys_created_on": "2020-10-20 07:19:11",
"sys_domain": {
"link": "https://example.service-now.com/api/now/table/sys_user_group/global",
"value": "global"
},
"state": "1",
"sys_created_by": "admin",
"knowledge": "false",
"order": "",
"calendar_stc": "",
"closed_at": "",
"cmdb_ci": "",
"delivery_plan": "",
"contract": "",
"impact": "3",
"active": "true",
"work_notes_list": "",
"business_service": "",
"priority": "5",
"sys_domain_path": "/",
"rfc": "",
"time_worked": "",
"expected_start": "",
"opened_at": "2020-10-20 07:18:56",
"business_duration": "",
"group_list": "",
"work_end": "",
"caller_id": {
"link": "https://example.service-now.com/api/now/table/sys_user/ID",
"value": "ID"
},
"reopened_time": "",
"resolved_at": "",
"approval_set": "",
"subcategory": "",
"work_notes": "",
"short_description": "Assessment : ATF Assessor",
"close_code": "",
"correlation_display": "",
"delivery_task": "",
"work_start": "",
"assignment_group": "",
"additional_assignee_list": "",
"business_stc": "",
"description": "",
"calendar_duration": "",
"close_notes": "",
"notify": "1",
"service_offering": "",
"sys_class_name": "incident",
"closed_by": "",
"follow_up": "",
"parent_incident": {
"link": "https://example.service-now.com/api/now/table/incident/ID",
"value": "ID"
},
"sys_id": "SYS_ID",
"contact_type": "",
"reopened_by": "",
"incident_state": "1",
"urgency": "3",
"problem_id": "",
"company": "",
"reassignment_count": "0",
"activity_due": "",
"assigned_to": "",
"severity": "3",
"comments": "",
"approval": "not requested",
"sla_due": "",
"comments_and_work_notes": "",
"due_date": "",
"sys_mod_count": "0",
"reopen_count": "0",
"sys_tags": "",
"escalation": "0",
"upon_approval": "proceed",
"correlation_id": "",
"location": "",
"category": "inquiry"
}
]
}
Mensagens de saída
A ação Receber detalhes do registro pode retornar as seguintes mensagens de saída:
| Mensagem de resposta | Descrição da mensagem |
|---|---|
|
A ação foi concluída. |
Error executing action "Get Record Details". 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 Receber detalhes do registro:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Acessar detalhes do usuário
Use a ação Receber detalhes do usuário para recuperar informações sobre o usuário usando o parâmetro sys_id no ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Receber detalhes do usuário exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
User Sys IDs |
Opcional. Uma lista separada por vírgulas dos IDs do sistema correspondentes aos usuários para
quem recuperar detalhes (como |
Emails |
Opcional. Uma lista separada por vírgulas de endereços de e-mail correspondentes aos usuários de quem recuperar detalhes (como |
Saídas de ação
A ação Receber detalhes do usuá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 | 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 Receber detalhes do usuário fornece a seguinte tabela:
Nome da tabela: Detalhes do usuário
Colunas da tabela:
- ID do sistema (mapeado como
sys_id) - Nome (mapeado como
name) - Nome de usuário (mapeado como
user_name) - E-mail (mapeado como
email)
Resultado JSON
O exemplo a seguir mostra a saída do resultado JSON recebida ao usar a ação Get User Details:
{
"result": [
{
"calendar_integration": "1",
"country": "",
"last_position_update": "",
"user_password": "example",
"last_login_time": "",
"source": "",
"sys_updated_on": "2020-08-29 02:42:42",
"building": "",
"web_service_access_only": "false",
"notification": "2",
"enable_multifactor_authn": "false",
"sys_updated_by": "user@example",
"sys_created_on": "2012-02-18 03:04:52",
"agent_status": "",
"sys_domain": {
"link": "https://example.service-now.com/api/now/table/sys_user_group/global",
"value": "global"
},
"state": "",
"vip": "false",
"sys_created_by": "admin",
"longitude": "",
"zip": "",
"home_phone": "",
"time_format": "",
"last_login": "",
"default_perspective": "",
"geolocation_tracked": "false",
"active": "true",
"sys_domain_path": "/",
"cost_center": {
"link": "https://example.service-now.com/api/now/table/cmn_cost_center/ID",
"value": "ID"
},
"phone": "",
"name": "Example User",
"employee_number": "",
"password_needs_reset": "false",
"gender": "Male",
"city": "",
"failed_attempts": "",
"user_name": "example.user",
"latitude": "",
"roles": "",
"title": "",
"sys_class_name": "sys_user",
"sys_id": "SYS_ID",
"internal_integration_user": "false",
"ldap_server": "",
"mobile_phone": "",
"street": "",
"company": {
"link": "https://example.service-now.com/api/now/table/core_company/ID",
"value": "ID"
},
"department": {
"link": "https://dev98773.service-now.com/api/now/table/cmn_department/ID",
"value": "ID"
},
"first_name": "Example",
"email": "example@example.com",
"introduction": "",
"preferred_language": "",
"manager": "",
"business_criticality": "3",
"locked_out": "false",
"sys_mod_count": "4",
"last_name": "User",
"photo": "",
"avatar": "063e38383730310042106710ce41f13b",
"middle_name": "",
"sys_tags": "",
"time_zone": "",
"schedule": "",
"on_schedule": "",
"date_format": "",
"location": {
"link": "https://example.service-now.com/api/now/table/cmn_location/ID",
"value": "ID"
}
}
]
}
Mensagens de saída
A ação Receber detalhes do usuário pode retornar as seguintes mensagens de saída:
| Mensagem de resposta | Descrição da mensagem |
|---|---|
|
A ação foi concluída. |
Error executing action "Get User Details". 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 Receber detalhes do usuário:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Listar registros da CMDB
Use a ação Listar registros do CMDB para listar registros do CMDB da mesma classe no ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Gerar o filtro de consulta
O parâmetro Query Filter aceita strings de consulta codificadas padrão do ServiceNow (sysparm_query). É possível gerar essas strings diretamente na interface do ServiceNow (por exemplo, criando um filtro em uma visualização em lista e selecionando Copiar consulta) ou construindo-as manualmente.
Para instruções sobre como gerar e usar essas strings, consulte Strings de consulta codificadas na documentação do ServiceNow.
Entradas de ação
A ação List CMDB Records exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Class Name |
Obrigatório. O nome da classe da CMDB de que os registros serão recuperados, como
Para mais informações sobre nomes de classes do ServiceNow, consulte Visualizar e editar definição de classe e metadados. |
Query Filter |
Opcional. A string de consulta codificada usada para filtrar os registros retornados (como
É possível gerar strings de consulta válidas usando a opção Copiar consulta nas visualizações de lista do ServiceNow. Para mais informações, consulte Strings de consulta codificadas. |
Max Records To Return |
Opcional. O número máximo de registros a serem recuperados com base nos filtros aplicados. O valor padrão é |
Saídas de ação
A ação List CMDB Records 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 CMDB Records fornece a seguinte tabela:
Nome da tabela: Registros de CLASS_NAME
Colunas da tabela:
- Nome (mapeado como
name) - ID do sistema (mapeado como
sys_id)
Resultado JSON
O exemplo a seguir mostra a saída do resultado JSON recebida ao usar a ação List CMDB Records:
{
"result": [
{
"sys_id": "SYS_ID",
"name": "Example server"
}
]
}
Mensagens de saída
A ação Listar registros da CMDB pode retornar as seguintes mensagens de saída:
| Mensagem de resposta | Descrição da mensagem |
|---|---|
|
A ação foi concluída. |
Error executing action "List CMDB Records". 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 CMDB Records:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Listar comentários de registros
Use a ação List Record Comments para listar comentários relacionados a um registro de tabela específico no ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação List Record Comments exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Table Name |
Obrigatório. O nome da tabela do ServiceNow que contém o registro para listar comentários (como |
Record Sys ID |
Obrigatório. O ID do sistema ( |
Type |
Obrigatório. O tipo de comentários ou notas a serem recuperados. Os valores possíveis são:
O valor padrão é |
Max Results To Return |
Opcional. O número máximo de comentários ou observações de trabalho a serem retornados. O valor padrão é |
Saídas de ação
A ação List Record Comments 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 Record Comments:
{
"sys_id": "SYS_ID",
"sys_created_on": "2021-09-03 10:29:48",
"name": "incident",
"element_id": "552c48888c033300964f4932b03eb092",
"sys_tags": "",
"value": "test",
"sys_created_by": "admin",
"element": "comments"
}
Mensagens de saída
A ação List Record Comments pode retornar as seguintes mensagens de saída:
| Mensagem de resposta | Descrição da mensagem |
|---|---|
|
A ação foi concluída. |
Error executing action "List Record Comments". 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 Record Comments:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Listar registros relacionados ao usuário
Use a ação List Records Related To User para listar registros de uma tabela relacionados a um usuário no ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação List Records Related To User exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Table Name |
Obrigatório. O nome da tabela do ServiceNow para pesquisar registros relacionados (como
|
Usernames |
Obrigatório. Uma lista separada por vírgulas de nomes de usuário para recuperar os registros relacionados. |
Max Days Backwards |
Obrigatório. O número de dias a partir da data atual para pesquisar registros relacionados. O valor padrão é |
Max Records To Return |
Opcional. O número máximo de registros a serem retornados para cada usuário. O valor padrão é |
Saídas de ação
A ação List Records Related To User 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 Records Related To User:
{
"result": [
{
"parent": "",
"made_sla": "true",
"caused_by": "",
"watch_list": "",
"upon_reject": "cancel",
"sys_updated_on": "2020-10-19 14:18:40",
"child_incidents": "0",
"hold_reason": "",
"approval_history": "",
"skills": "",
"number": "INC0010008",
"resolved_by": "",
"sys_updated_by": "admin",
"opened_by": {
"link": "https://example.service-now.com/api/now/table/sys_user/ID",
"value": "ID"
},
"user_input": "",
"sys_created_on": "2020-10-19 14:18:40",
"sys_domain": {
"link": "https://example.service-now.com/api/now/table/sys_user_group/global",
"value": "global"
},
"state": "1",
"sys_created_by": "admin",
"knowledge": "false",
"order": "",
"calendar_stc": "",
"closed_at": "",
"cmdb_ci": "",
"delivery_plan": "",
"contract": "",
"impact": "3",
"active": "true",
"work_notes_list": "",
"business_service": "",
"priority": "5",
"sys_domain_path": "/",
"rfc": "",
"time_worked": "",
"expected_start": "",
"opened_at": "2020-10-19 14:18:20",
"business_duration": "",
"group_list": "",
"work_end": "",
"caller_id": {
"link": "https://example.service-now.com/api/now/table/sys_user/ID",
"value": "ID"
},
"reopened_time": "",
"resolved_at": "",
"approval_set": "",
"subcategory": "",
"work_notes": "",
"short_description": "TEST",
"close_code": "",
"correlation_display": "",
"delivery_task": "",
"work_start": "",
"assignment_group": "",
"additional_assignee_list": "",
"business_stc": "",
"description": "",
"calendar_duration": "",
"close_notes": "",
"notify": "1",
"service_offering": "",
"sys_class_name": "incident",
"closed_by": "",
"follow_up": "",
"parent_incident": "",
"sys_id": "SYS_ID",
"contact_type": "",
"reopened_by": "",
"incident_state": "1",
"urgency": "3",
"problem_id": "",
"company": {
"link": "https://example.service-now.com/api/now/table/core_company/ID",
"value": "ID"
},
"reassignment_count": "0",
"activity_due": "",
"assigned_to": "",
"severity": "3",
"comments": "",
"approval": "not requested",
"sla_due": "",
"comments_and_work_notes": "",
"due_date": "",
"sys_mod_count": "0",
"reopen_count": "0",
"sys_tags": "",
"escalation": "0",
"upon_approval": "proceed",
"correlation_id": "",
"location": "",
"category": "inquiry"
}
]
}
Mensagens de saída
A ação List Records Related To User pode retornar as seguintes mensagens de saída:
| Mensagem de resposta | Descrição da mensagem |
|---|---|
|
A ação foi concluída. |
Error executing action "List Records Related To User". 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 Records Related To User:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Ping
Use a ação Ping para testar a conectividade com o ServiceNow.
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 |
|---|---|
is_success |
true ou false |
Atualizar incidente
Use a ação Atualizar incidente para atualizar as informações do incidente.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Atualizar incidente exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Incident Number |
Obrigatório. O identificador exclusivo do incidente do ServiceNow a ser atualizado, no formato |
Short Description |
Opcional. Uma breve descrição do incidente. |
Impact |
Opcional. Um nível de impacto para o incidente. Os valores possíveis são:
O valor padrão é |
Urgency |
Opcional. Um nível de urgência para o incidente. Os valores possíveis são os seguintes:
O valor padrão é |
Category |
Opcional. Uma categoria para o incidente. |
Assignment Group ID |
Opcional. O nome completo de um grupo para atribuir o incidente. |
Assigned User ID |
Opcional. O nome completo de um usuário para atribuir o incidente. |
Description |
Opcional. A descrição do incidente. |
Incident State |
Opcional. Um nome ou ID de status para o incidente (como |
Custom Fields |
Opcional. Uma lista separada por vírgulas de nomes de campos e os valores correspondentes a serem
atualizados, no formato É possível usar esse parâmetro para modificar campos não definidos explicitamente como
entradas de ação (como |
Saídas de ação
A ação Atualizar incidente 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 JSON
O exemplo a seguir mostra a saída do resultado JSON recebida ao usar a ação Atualizar incidente:
{
"sys_tags": " ",
"user_input": " ",
"calendar_stc": "2012",
"subcategory": " ",
"watch_list": " ",
"follow_up": " ",
"made_sla": "true",
"sys_created_by": "admin",
"sla_due": " ",
"number": "INC0010041",
"group_list": " ",
"reassignment_count": "0",
"assigned_to": " ",
"sys_mod_count": "10",
"notify": "1",
"resolved_by": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"upon_reject": "cancel",
"additional_assignee_list": " ",
"category": "inquiry",
"closed_at": "2020-07-10 12:53:06",
"parent_incident": " ",
"cmdb_ci": " ",
"contact_type": " ",
"impact": "1",
"rfc": " ",
"expected_start": " ",
"knowledge": "false",
"sys_updated_by": "admin",
"caused_by": " ",
"comments": " ",
"closed_by": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"priority": "1",
"state": "7",
"sys_id": "SYS_ID",
"opened_at": "2020-07-10 12:18:04",
"child_incidents": "0",
"work_notes": " ",
"delivery_task": " ",
"short_description": "sdf",
"comments_and_work_notes": " ",
"time_worked": " ",
"upon_approval": "proceed",
"company": " ",
"business_stc": "0",
"correlation_display": " ",
"sys_class_name": "incident",
"delivery_plan": " ",
"escalation": "0",
"description": " ",
"parent": " ",
"close_notes": "Closed by Caller",
"business_duration": "1970-01-01 00:00:00",
"problem_id": " ",
"sys_updated_on": "2020-07-10 13:13:57",
"approval_history": " ",
"approval_set": " ",
"business_service": " ",
"reopened_by": " ",
"calendar_duration": "1970-01-01 00:35:02",
"caller_id": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"active": "false",
"approval": "not requested",
"service_offering": " ",
"sys_domain_path": "/",
"hold_reason": " ",
"activity_due": "2020-07-10 14:33:28",
"severity": "3",
"incident_state": "7",
"resolved_at": "2020-07-10 12:53:06",
"location": " ",
"due_date": " ",
"work_start": " ",
"work_end": " ",
"work_notes_list": " ",
"sys_created_on": "2020-07-10 12:18:04",
"correlation_id": " ",
"contract": " ",
"reopened_time": " ",
"opened_by": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"close_code": "Closed/Resolved by Caller",
"assignment_group": " ",
"sys_domain": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user_group/global",
"value": "global"
},
"order": " ",
"urgency": "1",
"reopen_count": "0"
}
Resultado do script
A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Atualizar incidente:
| Nome do resultado do script | Valor |
|---|---|
incident_number |
INCIDENT_NUMBER |
Atualizar registro
Use a ação Atualizar registro para modificar registros atuais pertencentes a várias tabelas no ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Atualizar registro exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Table Name |
Opcional. O nome da tabela do ServiceNow que contém o registro a ser atualizado (como
|
Object Json Data |
Obrigatório. Um objeto JSON que contém os pares campo-valor a serem aplicados ao registro (como |
Record Sys ID |
Obrigatório. O ID do sistema ( |
Saídas de ação
A ação Atualizar registro oferece 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 Atualizar registro:
{
"sys_tags": " ",
"user_input": " ",
"calendar_stc": " ",
"subcategory": " ",
"watch_list": " ",
"follow_up": " ",
"made_sla": "true",
"sys_created_by": "admin",
"sla_due": " ",
"number": "INC0010021",
"group_list": " ",
"reassignment_count": "0",
"assigned_to": " ",
"sys_mod_count": "0",
"notify": "1",
"resolved_by": " ",
"upon_reject": "cancel",
"additional_assignee_list": " ",
"category": "inquiry",
"closed_at": " ",
"parent_incident": " ",
"cmdb_ci": " ",
"contact_type": " ",
"impact": "3",
"rfc": " ",
"expected_start": " ",
"knowledge": "false",
"sys_updated_by": "admin",
"caused_by": " ",
"comments": " ",
"closed_by": " ",
"priority": "5",
"state": "1",
"sys_id": "SYS_ID",
"opened_at": "2020-07-10 08:24:34",
"child_incidents": "0",
"work_notes": " ",
"delivery_task": " ",
"short_description": " ",
"comments_and_work_notes": " ",
"time_worked": " ",
"upon_approval": "proceed",
"company": " ",
"business_stc": " ",
"correlation_display": " ",
"sys_class_name": "incident",
"delivery_plan": " ",
"escalation": "0",
"description": " ",
"parent": " ",
"close_notes": " ",
"business_duration": " ",
"problem_id": " ",
"sys_updated_on": "2020-07-10 08:24:34",
"approval_history": " ",
"approval_set": " ",
"business_service": " ",
"reopened_by": " ",
"calendar_duration": " ",
"caller_id": " ",
"active": "true",
"approval": "not requested",
"service_offering": " ",
"sys_domain_path": "/",
"hold_reason": " ",
"activity_due": " ",
"severity": "3",
"incident_state": "1",
"resolved_at": " ",
"location": " ",
"due_date": " ",
"work_start": " ",
"work_end": " ",
"work_notes_list": " ",
"sys_created_on": "2020-07-10 08:24:34",
"correlation_id": " ",
"contract": " ",
"reopened_time": " ",
"opened_by": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user/ID",
"value": "ID"
},
"close_code": " ",
"assignment_group": " ",
"sys_domain": {
"link": "https://example.service-now.com/api/now/v1/table/sys_user_group/global",
"value": "global"
},
"order": " ",
"urgency": "3",
"reopen_count": "0"
}
Resultado do script
A tabela a seguir lista o valor da saída do resultado do script ao usar a ação Atualizar registro:
| Nome do resultado do script | Valor |
|---|---|
record_sys_id |
RECORD_SYS_ID
|
Aguardar comentários
Use a ação Aguardar comentários para pausar a execução do playbook até que um comentário ou uma observação de trabalho seja adicionado a um registro de tabela específico no ServiceNow.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Aguardar comentários exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Table Name |
Obrigatório. O nome da tabela do ServiceNow que contém o registro de onde
esperar comentários (como |
Record Sys ID |
Obrigatório. O ID do sistema ( |
Type |
Obrigatório. O tipo de comentários ou observações que a ação deve aguardar. Os valores possíveis são:
O valor padrão é |
Wait Mode |
Obrigatório. A condição que determina quando a ação para de esperar e continua. Os valores possíveis são:
O valor padrão é |
Text |
Opcional. A string de texto específica que a ação aguarda em um novo comentário ou observação de trabalho. Esse parâmetro só é usado quando |
Saídas de ação
A ação Aguardar comentários 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 de resultado JSON recebida ao usar a ação Aguardar comentários:
{
"sys_id": "SYS_ID",
"sys_created_on": "2021-09-03 10:29:48",
"name": "incident",
"element_id": "552c48888c033300964f4932b03eb092",
"sys_tags": "",
"value": "test",
"sys_created_by": "admin",
"element": "comments"
}
Mensagens de saída
A ação Aguardar comentários pode retornar as seguintes mensagens de saída:
| Mensagem de resposta | Descrição da mensagem |
|---|---|
|
A ação foi concluída. |
Error executing action "Wait For Comments". 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 Aguardar comentários:
| Nome do resultado do script | Valor |
|---|---|
is_success |
true ou false |
Aguardar atualização do campo
Use a ação Aguardar atualização de campo para pausar a execução do playbook até que um campo específico em um registro de dados do ServiceNow seja atualizado para um dos valores esperados.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Aguardar atualização do campo exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Table Name |
Obrigatório. O nome da tabela do ServiceNow que contém o registro a ser monitorado
(como |
Record Sys ID |
Obrigatório. O ID do sistema ( |
Field - Column Name |
Obrigatório. O nome da coluna (campo) que a ação monitora para detectar mudanças. |
Field - Values |
Obrigatório. Uma lista separada por vírgulas de valores que, se encontrados no campo monitorado,
fazem com que a ação pare de esperar e continue (como
|
Saídas de ação
A ação Aguardar atualização do campo 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 Aguardar atualização do campo:
| Nome do resultado do script | Valor |
|---|---|
updated_field |
UPDATED_FIELD |
Aguardar atualização de status
Use a ação Aguardar atualização de status para pausar a execução do playbook até que um status (estado) específico do incidente do ServiceNow seja atualizado para um dos valores esperados.
Essa ação não é executada em entidades do Google SecOps.
Entradas de ação
A ação Aguardar atualização de status exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Incident Number |
Obrigatório. O identificador exclusivo do incidente do ServiceNow a ser monitorado, no formato |
Statuses |
Obrigatório. Uma lista separada por vírgulas de status (estados) de incidentes que, se alcançados, fazem com que a ação pare de esperar e continue (como |
Saídas de ação
A ação Aguardar atualização de status 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 Aguardar atualização de status:
| Nome do resultado do script | Valor |
|---|---|
new_status |
STATUS |
Conectores
Para mais informações sobre como configurar conectores no Google SecOps, consulte Ingerir seus dados (conectores).
Conector do ServiceNow
Use o conector do ServiceNow para recuperar incidentes do ServiceNow.
Como trabalhar com a lista de consultas dinâmicas
No conector do ServiceNow, a lista dinâmica modifica o sysparm_query
que o conector usa para consultar o ServiceNow. Isso permite filtrar registros com base em qualquer campo compatível para o tipo de registro.
Para definir um filtro, configure cada item da lista dinâmica para conter um par campo-valor
no seguinte formato:
FIELD_NAME=VALUE.
Por exemplo, category=security.
Quando Use whitelist as a blacklist está ativado, o conector inverte a lógica da consulta, fazendo com que a lista dinâmica funcione como uma lista de bloqueio em vez de um filtro.
Entradas do conector
O conector do ServiceNow exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Product Field Name |
Obrigatório. O nome do campo em que o nome do produto é armazenado. O nome do produto afeta principalmente o mapeamento. Para simplificar e melhorar o processo de mapeamento do conector, o valor padrão é resolvido como um valor substituto referenciado no código. Qualquer entrada inválida para esse parâmetro é resolvida como um valor de substituição por padrão. O valor padrão é |
Event Field Name |
Obrigatório. O nome do campo que determina o nome do evento (subtipo). O valor padrão é |
Rule Generator |
Opcional. O nome do campo cujo valor define a consulta ou o conjunto de regras específico a ser aplicado durante a recuperação de registros. |
Api Root |
Obrigatório. A raiz da API da instância do ServiceNow. O valor padrão é
|
Username |
Obrigatório. O nome de usuário da conta do ServiceNow. |
Password |
Obrigatório. A senha da conta do ServiceNow. |
Verify SSL |
Opcional. Se selecionada, a integração valida o certificado SSL ao se conectar ao servidor do ServiceNow. Ativado por padrão. |
Days Backwards |
Opcional. O número de dias desde o momento atual para recuperar registros. Esse parâmetro é usado na execução inicial do conector ou como um valor de substituição se um carimbo de data/hora anterior do conector tiver expirado. O valor padrão é |
Max Incidents Per Cycle |
Opcional. O número máximo de incidentes a serem recuperados durante cada iteração do conector. O valor padrão é |
Environments Whitelist |
Opcional. Uma lista separada por vírgulas de ambientes (domínios) para o conector ingerir no Google SecOps, como |
Use whitelist as a blacklist |
Opcional. Se selecionado, o conector usa a lista dinâmica como uma lista de bloqueio. Essa configuração está desativada por padrão. |
PythonProcessTimeout |
Obrigatório. O limite de tempo limite, em segundos, para o processo do Python que executa o script atual. O valor padrão é |
Incident Table |
Opcional. O nome da tabela da API ou o caminho a ser usado para ações relacionadas a incidentes e recuperação de registros. Por padrão, a integração usa o caminho |
Client ID |
Opcional. O ID do cliente para a integração do ServiceNow, necessário para a autenticação do OAuth 2.0 usando credenciais do cliente. É possível autenticar usando o token de atualização ou as credenciais do cliente. Se o token de atualização e as credenciais do cliente forem configurados, a integração usará o token de atualização para autenticação. |
Client Secret |
Opcional. A chave secreta do cliente para a integração do ServiceNow, necessária para a autenticação do OAuth 2.0 usando credenciais do cliente. É possível autenticar usando o token de atualização ou as credenciais do cliente. Se o token de atualização e as credenciais do cliente forem configurados, a integração usará o token de atualização para autenticação. |
Refresh Token |
Opcional. O token de atualização da integração do ServiceNow, necessário para a autenticação do OAuth 2.0 usando um token de atualização. O token de atualização configurado expira a cada 90 dias. É possível autenticar usando o token de atualização ou as credenciais do cliente. Se o token de atualização e as credenciais do cliente forem configurados, a integração usará o token de atualização para autenticação. |
Assignment Group |
Opcional. O nome do grupo de atribuição cujos registros o conector precisa ingerir. |
Use Oauth Authentication |
Opcional. Se selecionada, a integração usa o OAuth 2.0 para autenticar. A autenticação OAuth 2.0 exige a definição das credenciais do cliente
( Essa configuração está desativada por padrão. |
Server Time Zone |
Opcional. O fuso horário configurado no servidor do ServiceNow, como O valor padrão é |
Table Name |
Opcional. O nome da tabela de onde os registros serão extraídos, como |
Event Name |
Opcional. O nome do evento do Google SecOps criado quando um registro é ingerido, como |
Proxy Server Address |
Opcional. O endereço do servidor proxy a ser usado. |
Proxy Username |
Opcional. O nome de usuário do proxy para autenticação. |
Proxy Password |
Opcional. A senha do proxy para autenticação. |
Get User Information |
Opcional. Se selecionado, o conector também recupera as informações sobre os usuários relacionados ao incidente. Essa configuração está desativada por padrão. |
Jobs
Para mais informações sobre jobs, consulte Configurar um novo job e Programação avançada.
ServiceNow: sincronizar incidentes fechados
Use o job ServiceNow - Sync Closed Incidents para sincronizar incidentes fechados do ServiceNow com os alertas e casos correspondentes do Google SecOps.
Esse job processa incidentes do ServiceNow ingeridos como alertas e casos que contêm a tag ServiceNow e um valor de contexto TICKET_ID com o número do incidente.
Parâmetros do job
O job ServiceNow - Sync Closed Incidents exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Api Root |
Obrigatório. A raiz da API da instância do ServiceNow. O valor padrão é
|
Username |
Obrigatório. O nome de usuário da instância do ServiceNow. |
Password |
Obrigatório. A senha da instância do ServiceNow. |
Verify SSL |
Opcional. Se selecionada, a integração valida o certificado SSL ao se conectar ao servidor do ServiceNow. Ativado por padrão. |
Client ID |
Opcional. O ID do cliente para a integração do ServiceNow, necessário para a autenticação do OAuth 2.0 usando credenciais do cliente. É possível autenticar usando o token de atualização ou as credenciais do cliente. Se o token de atualização e as credenciais do cliente forem configurados, a integração usará o token de atualização para autenticação. |
Client Secret |
Opcional. A chave secreta do cliente para a integração do ServiceNow, necessária para a autenticação do OAuth 2.0 usando credenciais do cliente. É possível autenticar usando o token de atualização ou as credenciais do cliente. Se o token de atualização e as credenciais do cliente forem configurados, a integração usará o token de atualização para autenticação. |
Refresh Token |
Opcional. O token de atualização da integração do ServiceNow, necessário para a autenticação do OAuth 2.0 usando um token de atualização. O token de atualização configurado expira a cada 90 dias. É possível autenticar usando o token de atualização ou as credenciais do cliente. Se o token de atualização e as credenciais do cliente forem configurados, a integração usará o token de atualização para autenticação. |
Use Oauth Authentication |
Opcional. Se selecionada, a integração usa o OAuth 2.0 para autenticar. A autenticação OAuth 2.0 exige a definição das credenciais do cliente
( Essa configuração está desativada por padrão. |
Max Hours Backwards |
Opcional. O número de horas desde o momento atual para pesquisar e sincronizar incidentes encerrados. O valor padrão é |
Table Name |
Obrigatório. O nome da tabela de banco de dados para pesquisar incidentes fechados (como
|
ServiceNow: sincronizar incidentes
Use o job ServiceNow - Sync Incidents para sincronizar campos de incidentes e anexos do ServiceNow com casos e alertas relacionados no Google SecOps.
Requisitos do trabalho
Para que o job funcione corretamente, verifique se os seguintes itens estão configurados no caso ou alerta do Google SecOps (dependendo do parâmetro Sync Level):
Tag: o caso precisa ter a tag
ServiceNow Incident Sync.Valor de contexto: o caso ou alerta precisa ter uma chave de contexto
TICKET_IDque contenha uma lista separada por vírgulas de números de incidentes do ServiceNow (por exemplo,INC0000050,INC0000051). Observação: é possível definir o valor de contextoTICKET_IDusando a ação Definir valor de contexto do escopo da integração de utilitários do Siemplify.
Parâmetros do job
O job ServiceNow - Sincronizar incidentes exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Api Root |
Obrigatório. A raiz da API da instância do ServiceNow. O valor padrão é
|
Username |
Obrigatório. O nome de usuário da instância do ServiceNow. |
Password |
Obrigatório. A senha da instância do ServiceNow. |
Sync Level |
Obrigatório. O nível em que o job sincroniza dados. Os valores possíveis são:
O valor padrão é |
Max Hours Backwards |
Obrigatório. O número máximo de horas desde o horário atual para pesquisar casos a serem sincronizados. O valor padrão é |
Verify SSL |
Opcional. Se selecionada, a integração valida o certificado SSL ao se conectar ao servidor do ServiceNow. Ativado por padrão. |
Sincronizar comentários de registros da tabela
Use o job Sincronizar comentários de registros da tabela para sincronizar comentários entre registros da tabela do ServiceNow e casos do Google SecOps.
Parâmetros do job
O job Sync Table Record Comments exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
Api Root |
Obrigatório. A raiz da API da instância do ServiceNow. O valor padrão é
|
Username |
Obrigatório. O nome de usuário da instância do ServiceNow. |
Password |
Obrigatório. A senha da instância do ServiceNow. |
Verify SSL |
Opcional. Se selecionada, a integração valida o certificado SSL ao se conectar ao servidor do ServiceNow. Ativado por padrão. |
Client ID |
Opcional. O ID do cliente para a integração do ServiceNow, necessário para a autenticação do OAuth 2.0 usando credenciais do cliente. É possível autenticar usando o token de atualização ou as credenciais do cliente. Se o token de atualização e as credenciais do cliente forem configurados, a integração usará o token de atualização para autenticação. |
Client Secret |
Opcional. A chave secreta do cliente para a integração do ServiceNow, necessária para a autenticação do OAuth 2.0 usando credenciais do cliente. É possível autenticar usando o token de atualização ou as credenciais do cliente. Se o token de atualização e as credenciais do cliente forem configurados, a integração usará o token de atualização para autenticação. |
Refresh Token |
Opcional. O token de atualização da integração do ServiceNow, necessário para a autenticação do OAuth 2.0 usando um token de atualização. O token de atualização configurado expira a cada 90 dias. É possível autenticar usando o token de atualização ou as credenciais do cliente. Se o token de atualização e as credenciais do cliente forem configurados, a integração usará o token de atualização para autenticação. |
Use Oauth Authentication |
Opcional. Se selecionada, a integração usa o OAuth 2.0 para autenticar. A autenticação OAuth 2.0 exige a definição das credenciais do cliente
( Essa configuração está desativada por padrão. |
Table Name |
Obrigatório. O nome da tabela do ServiceNow em que pesquisar registros para sincronizar
comentários (como |
Sincronizar comentários de registros de tabela por tag
Use o job Sync Table Record Comments By Tag para sincronizar comentários entre registros de tabela do ServiceNow e casos do Google SecOps.
Requisitos do trabalho
Para que o job funcione corretamente, o caso do Google SecOps precisa ter estas duas tags:
ServiceNow TABLE_NAME(em que<var class="readonly">TABLE_NAME</var>é o nome da tabela do ServiceNow, comoincident).ServiceNow TicketId: TICKET_ID(em que<var class="readonly">TICKET_ID</var>é o ID ou número do sistema do registro correspondente).
Parâmetros do job
O job Sync Table Record Comments By Tag exige os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
API Root |
Obrigatório. A raiz da API da instância do ServiceNow. O valor padrão é
|
Username |
Obrigatório. O nome de usuário da instância do ServiceNow. |
Password |
Obrigatório. A senha da instância do ServiceNow. |
Table Name |
Obrigatório. O nome da tabela de banco de dados a ser pesquisada, como |
Verify SSL |
Opcional. Se selecionada, a integração valida o certificado SSL ao se conectar ao servidor do ServiceNow. Ativado por padrão. |
Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.