ServiceDesk Plus V3

Versão da integração: 4.0

Configurar o ServiceDesk Plus V3 para trabalhar com o Google Security Operations

Como gerar um token de API

  1. Acesse o console do usuário administrador.

    Console do ServiceDesk Plus V3

  2. Clique nele e em Gerar chave de API.

    Gerar chave de API no console do ServiceDesk Plus V3

  3. Uma caixa de diálogo mostra o status da geração da chave.

    • Se você já gerou a chave, guarde-a em um lugar seguro. Caso contrário, será necessário gerar outra.
    • Caso contrário, clique em Gerar chave, e a chave de API será mostrada imediatamente.

    Regenerar a chave de API no console do ServiceDesk Plus V3

Configurar a integração do ServiceDesk Plus V3 no Google SecOps

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

Parâmetros de integração

Use os seguintes parâmetros para configurar a integração:

Nome de exibição do parâmetro Tipo Valor padrão É obrigatório Descrição
Raiz da API String http://{IP OR FQDN}:8080/api/v3/ Sim Raiz da API do ServiceDesk Plus.
Token da API String N/A Sim Token de API do ServiceDesk Plus. (também chamada de "chave do técnico")
Verificar SSL Caixa de seleção Desmarcado Sim Se ativada, verifica se o certificado SSL da conexão com o servidor do ServiceDesk Plus é válido.

Ações

Ping

Descrição

Teste a conectividade com o ServiceDesk Plus V3 usando os parâmetros fornecidos na página de configuração da integração na guia "Marketplace" do Google Security Operations.

Parâmetros

N/A

Casos de uso

A ação é usada para testar a conectividade na página de configuração da integração na guia "Marketplace" do Google Security Operations e pode ser executada como uma ação manual, não usada em playbooks.

Executar em

Essa ação não é executada em 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
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se a conexão for bem-sucedida: "Conexão bem-sucedida com o ServiceDesk Plus V3 usando os parâmetros fornecidos"

A ação precisa falhar e interromper a execução de um playbook:

Se um erro crítico, como credenciais incorretas ou perda de conectividade, for informado:

"Não foi possível se conectar ao ServiceDesk Plus V3. O erro é {0}".format(exception.stacktrace)

Geral

Adicionar nota

Descrição

Adicione uma observação a uma solicitação.

Parâmetros

Nome de exibição do parâmetro Tipo Valor padrão É obrigatório Descrição
ID da solicitação String N/A Sim O ID das solicitações.
Observação String N/A Sim O conteúdo da observação.
Mostrar ao requerente Caixa de seleção Desmarcado Não Especifique se a observação deve ser mostrada ao solicitante ou não.
Notificar o técnico Caixa de seleção Desmarcado Não Especifique se a observação deve ser mostrada ao solicitante ou não.
Marcar como primeira resposta Caixa de seleção Desmarcado Não Especifique se esta observação deve ser marcada como a primeira resposta.
Adicionar às solicitações vinculadas Caixa de seleção Desmarcado Não Especifique se esta observação deve ser adicionada às solicitações vinculadas.

Executar em

Essa ação não é executada em 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
{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "request_note": {
        "created_time": {
            "display_value": "Nov 10, 2020 01:14 AM",
            "value": "1690499678XXX"
        },
        "request": {
            "subject": "New Subject Dropdown",
            "id": "00"
        },
        "show_to_requester": false,
        "description": "New Note",
        "id": "23",
        "created_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        }
    }
}
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se a operação for bem-sucedida: "A observação foi adicionada à solicitação do ServiceDesk Plus. ID da solicitação: {ID} , ID da observação: {note.id}."

Se o parâmetro "ID da solicitação" não for encontrado:

"Não foi possível adicionar uma observação à solicitação com o ID {ID} no ServiceDesk Plus. Motivo: não foi encontrada a solicitação com o ID {ID}."

A ação precisa falhar e interromper a execução de um playbook:

Se não der certo: "Erro ao executar a ação "Adicionar observação". Motivo: {0}''.format(error.Stacktrace)

Geral

Fechar solicitação

Descrição

Fechar uma solicitação.

Parâmetros

Nome de exibição do parâmetro Tipo Valor padrão É obrigatório Descrição
ID da solicitação String N/A Sim O ID da solicitação.
Comentário String N/A Sim Comentário de encerramento.
Resolução confirmada Caixa de seleção Desmarcado Não Se a resolução da solicitação foi confirmada ou não.

Executar em

Essa ação não é executada em 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
{
    "response_status": {
        "status_code": 2000,
        "messages": [
            {
                "status_code": 2000,
                "type": "success",
                "message": "Request(s) closed successfully."
            }
        ],
        "status": "success"
    }
}
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se a operação for concluída:

Imprima "Solicitação do ServiceDesk Plus com ID {ID} encerrada com sucesso."

Se o ID da solicitação não for encontrado:

Imprima "Não foi possível fechar a solicitação com ID {ID} no ServiceDesk Plus. Motivo: não foi encontrada a solicitação com o ID {ID}."

A ação precisa falhar e interromper a execução de um playbook:

Se não for concluída:

Imprima "Erro ao executar a ação "Fechar solicitação". Motivo: {0}''.format(error.Stacktrace)

Geral

Adicionar observação e aguardar resposta

Descrição

Adicione uma observação a uma solicitação.

Parâmetros

Nome de exibição do parâmetro Tipo Valor padrão É obrigatório Descrição
ID da solicitação String N/A Sim O ID das solicitações.
Observação String N/A Sim O conteúdo da observação.
Mostrar ao requerente Caixa de seleção Desmarcado Não Especifique se a observação deve ser mostrada ao solicitante ou não.
Notificar o técnico Caixa de seleção Desmarcado Não Especifique se a observação deve ser mostrada ao solicitante ou não.
Marcar como primeira resposta Caixa de seleção Desmarcado Não Especifique se esta observação deve ser marcada como primeira resposta.
Adicionar às solicitações vinculadas Caixa de seleção Desmarcado Não Especifique se esta observação deve ser adicionada às solicitações vinculadas.

Executar em

Essa ação não é executada em 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
{
    "response_status": {
        "status": "Success",
        "statuscode": "2000"
    },
    "request_note": {
        "id": "1",
        "description": "Need more info on this topic. Please contact me.",
        "created_by": {
            "id": "4",
            "name": "administrator"
        },
        "show_to_requester": true,
        "request": {
            "id": "2"
        },
        "created_time": {
            "value": 1455520864880,
            "display_value": "Feb 15, 2016 12:51 PM"
        }
    }
}
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se a ação for bem-sucedida: "A observação foi adicionada à solicitação do ServiceDesk Plus. ID da solicitação: {ID} , ID da observação: {note.id}."

Se o parâmetro "ID da solicitação" não for encontrado:

"Não foi possível adicionar uma observação à solicitação com o ID {ID} no ServiceDesk Plus. Motivo: não foi encontrada a solicitação com o ID {ID}."

A ação precisa falhar e interromper a execução de um playbook:

Se não der certo: "Erro ao executar a ação "Adicionar observação". Motivo: {0}''.format(error.Stacktrace)

Geral

Criar solicitação de alerta

Descrição

Crie uma solicitação relacionada a um alerta do Google SecOps.

Parâmetros

Nome de exibição do parâmetro Tipo Valor padrão É obrigatório Descrição
Assunto String N/A Sim O assunto da solicitação.
Solicitante String Usuário da chave de API. Sim O solicitante da solicitação. Se não for especificado, será definido como o usuário da chave de API.
Recursos String N/A Não Nomes dos recursos a serem associados à solicitação.
Status String N/A Não O status da solicitação.
Técnico String N/A Não O nome do técnico atribuído à solicitação.
Prioridade String N/A Não A prioridade da solicitação.
Urgência String N/A Não A urgência da solicitação.
Categoria String N/A Não A categoria da solicitação.
Modelo de solicitação String N/A Não O modelo da solicitação.
Tipo de solicitação String N/A Não

O tipo da solicitação.

Exemplo: incidente, solicitação de serviço

Vencimento (ms) String N/A Não A data de vencimento da solicitação em milissegundos.
Modo String N/A Não

O modo em que esta solicitação é criada.

Exemplo: e-mail

Nível String N/A Não O nível da solicitação.
Site String N/A Não Denota o site a que esta solicitação pertence.
Grupo String N/A Não Grupo a que esta solicitação pertence.
Impacto String N/A Não O impacto da solicitação.

Executar em

Essa ação não é executada em 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
{
    "request": {
        "ola_due_by_time": null,
        "subject": "Test request number 2",
        "resolution": {
            "submitted_on": {
                "display_value": "Oct 28, 2020 09:31 PM",
                "value": "1603945909120"
            },
            "submitted_by": {
                "email_id": null,
                "name": "administrator",
                "is_vipuser": false,
                "id": "4",
                "department": null
            },
            "resolution_attachments": [],
            "content": "Mail Fetching Server problem has been fixed"
        },
        "linked_to_request": null,
        "mode": null,
        "lifecycle": null,
        "reason_for_cancel": null,
        "assets": [
            {
                "name": "servicedesk.workgroup",
                "id": "24"
            }
        ],
        "is_trashed": false,
        "id": "6",
        "assigned_time": null,
        "group": null,
        "requester": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "cancel_requested_by": null,
        "email_to": [],
        "created_time": {
            "display_value": "Oct 28, 2020 09:31 PM",
            "value": "1603945909120"
        },
        "item": null,
        "level": null,
        "has_resolution_attachments": false,
        "approval_status": null,
        "impact": null,
        "service_category": null,
        "sla": null,
        "priority": null,
        "created_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "scheduled_end_time": null,
        "tags": [],
        "first_response_due_by_time": null,
        "last_updated_time": null,
        "has_notes": false,
        "impact_details": "Routine tasks are pending due to mail server problem",
        "subcategory": null,
        "email_cc": [],
        "status": {
            "color": "#0066ff",
            "name": "Open",
            "id": "2"
        },
        "scheduled_start_time": null,
        "template": {
            "is_service_template": false,
            "name": "Default Request",
            "id": "1"
        },
        "email_ids_to_notify": [],
        "request_type": {
            "name": "Incident",
            "id": "1"
        },
        "cancel_requested_time": null,
        "description": "I am unable to fetch mails from the mail server",
        "has_dependency": false,
        "has_conversation": false,
        "callback_url": null,
        "chat_type": 0,
        "is_service_request": false,
        "urgency": null,
        "is_shared": false,
        "cancel_requested": false,
        "has_request_initiated_change": false,
        "request_template_task_ids": [],
        "department": null,
        "is_reopened": false,
        "has_draft": false,
        "has_attachments": false,
        "has_linked_requests": false,
        "is_overdue": false,
        "technician": null,
        "has_request_caused_by_change": false,
        "has_problem": false,
        "due_by_time": null,
        "has_project": false,
        "is_first_response_overdue": false,
        "cancel_requested_is_pending": false,
        "category": null
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se a operação for bem-sucedida: "A solicitação do ServiceDesk Plus foi criada"

A ação precisa falhar e interromper a execução de um playbook:

Se não der certo: "Erro ao executar a ação "Criar solicitação de alerta". Motivo: {0}''.format(error.Stacktrace)

Geral

Criar solicitação

Descrição

Crie uma nova solicitação.

Parâmetros

Parâmetro Tipo Valor padrão É obrigatório Descrição
Assunto String N/A Sim O assunto da solicitação.
Solicitante String Usuário da chave de API. Sim O solicitante da solicitação. Se não for especificado, será definido como o usuário da chave de API.
Descrição String N/A Não A descrição da solicitação.
Recursos String N/A Não Nomes dos recursos a serem associados à solicitação.
Status String N/A Não O status da solicitação.
Técnico String N/A Não O nome do técnico atribuído à solicitação.
Prioridade String N/A Não A prioridade da solicitação.
Urgência String N/A Não A urgência da solicitação.
Categoria String N/A Não A categoria da solicitação.
Modelo de solicitação String N/A Não O modelo da solicitação.
Tipo de solicitação String N/A Não

O tipo da solicitação.

Exemplo: incidente, solicitação de serviço

Vencimento (ms) String N/A Não A data de vencimento da solicitação em milissegundos.
Modo String N/A Não

O modo em que esta solicitação é criada.

Exemplo: e-mail

Nível String N/A Não O nível da solicitação.
Site String N/A Não Denota o site a que esta solicitação pertence.
Grupo String N/A Não Grupo a que esta solicitação pertence.
Impacto String N/A Não O impacto da solicitação.

Executar em

Essa ação não é executada em 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
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se a ação for bem-sucedida: "A solicitação do ServiceDesk Plus foi criada"

A ação precisa falhar e interromper a execução de um playbook:

Se não der certo: "Erro ao executar a ação "Criar solicitação". Motivo: {0}''.format(error.Stacktrace)

Geral

Get Request

Descrição

Recupera informações sobre uma solicitação no ServiceDesk Plus.

Parâmetros

Parâmetro Tipo Valor padrão É obrigatório Descrição
ID da solicitação String N/A Sim O ID da solicitação.

Executar em

Essa ação não é executada em 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
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se a solicitação for bem-sucedida: "A solicitação do ServiceDesk Plus com ID {ID} foi buscada."

Se o parâmetro "ID da solicitação" não for encontrado: "Não foi possível buscar a solicitação com o ID {ID} no ServiceDesk Plus. Motivo: não foi encontrada a solicitação com o ID {ID}."

A ação precisa falhar e interromper a execução de um playbook:

Se não der certo: "Erro ao executar a ação "Get Request action". Motivo: {0}''.format(error.Stacktrace)

Geral

Aguardar atualização do campo

Descrição

Aguarde a atualização de um campo de uma solicitação para um valor desejado.

Parâmetros

Parâmetro Tipo Valor padrão É obrigatório Descrição
ID da solicitação String N/A Sim O ID da solicitação.
Nome do campo String N/A Sim O nome do campo a ser atualizado.
Valores String N/A Sim Valores desejados para o campo especificado.

Executar em

Essa ação não é executada em 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
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução do playbook:

Se uma tarefa de espera (ação assíncrona) for criada com sucesso para o campo: "Tarefas de análise criadas para o campo: {0}".format([fields_list]).

Se não for possível criar uma tarefa de análise para todos os campos fornecidos: "Nenhuma tarefa de análise do ServiceDesk Plus foi criada".

Se ainda estiver aguardando a atualização do campo: "Ação aguardando a próxima atualização"

A ação deve falhar e interromper a execução do playbook:

Se um erro crítico, como credenciais incorretas ou perda de conectividade, for informado: "Não foi possível se conectar ao serviço ServiceDesk! O erro é {0}".format(exception.stacktrace)

Geral

Atualizar solicitação

Descrição

Atualize uma solicitação do ServiceDesk Plus usando o ID dela.

Parâmetros

Parâmetro Tipo Valor padrão É obrigatório Descrição
ID da solicitação String N/A Verdadeiro O ID da solicitação a ser atualizada.
Assunto String N/A Não O assunto da solicitação.
Solicitante String N/A Não

O solicitante da solicitação.

Se não for especificado, será definido como o usuário da chave de API.

Descrição String N/A Não A descrição da solicitação.
Recursos String N/A Não

Nomes dos recursos a serem associados à solicitação.

O parâmetro também pode receber uma lista de strings separadas por vírgulas com nomes de recursos.

Status String N/A Não O status da solicitação.
Técnico String N/A Não O nome do técnico atribuído à solicitação.
Prioridade String N/A Não A prioridade da solicitação.
Urgência String N/A Não A urgência da solicitação.
Categoria String N/A Não A categoria da solicitação.
Modelo de solicitação String N/A Não O modelo da solicitação.
Tipo de solicitação String N/A Não

O tipo da solicitação.

Exemplo: incidente, solicitação de serviço

Vencimento (ms) String N/A Não A data de vencimento da solicitação em milissegundos.
Modo String N/A Não

O modo em que esta solicitação é criada.

Exemplo: e-mail

Nível String N/A Não O nível da solicitação.
Site String N/A Não Denota o site a que esta solicitação pertence.
Grupo String N/A Não Grupo a que esta solicitação pertence.
Impacto String N/A Não O impacto da solicitação.

Executar em

Essa ação não é executada em 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
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se a operação for concluída: "A solicitação do ServiceDesk Plus com o ID {ID} foi atualizada."

Se o parâmetro "ID da solicitação" não for encontrado: "Não foi possível atualizar a solicitação com o ID {ID} no ServiceDesk Plus. Motivo: não foi encontrada a solicitação com o ID {ID}."

A ação precisa falhar e interromper a execução de um playbook:

Se não der certo: "Erro ao executar a ação "Atualizar solicitação". Motivo: {0}''.format(error.Stacktrace)

Geral

Aguardar atualização de status

Descrição

Aguarde a atualização do status de uma solicitação para o status desejado.

Parâmetros

Parâmetro Tipo Valor padrão É obrigatório Descrição
ID da solicitação String N/A Sim O ID da solicitação.
Valores String N/A Sim Valores desejados para o campo especificado.

Executar em

Essa ação não é executada em 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
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução do playbook:

Se uma tarefa de espera (ação assíncrona) for criada com sucesso para o campo: "Tarefas de análise criadas para o campo: {0}".format([fields_list]).

Se não for possível criar uma tarefa de análise para todos os campos fornecidos: "Nenhuma tarefa de análise do ServiceDesk Plus foi criada".

Se ainda estiver aguardando a atualização do campo: "Ação aguardando a próxima atualização"

A ação deve falhar e interromper a execução do playbook:

Se um erro crítico, como credenciais incorretas ou perda de conectividade, for informado: "Não foi possível se conectar ao serviço ServiceDesk! O erro é {0}".format(exception.stacktrace)

Geral

Criar solicitação: listas suspensas

Descrição

Crie uma nova solicitação.

Parâmetros

Parâmetro Tipo Valor padrão É obrigatório Descrição
Assunto String N/A Sim O assunto da solicitação.
Solicitante String N/A Não O solicitante da solicitação. Se não for especificado, será definido como o usuário da chave de API.
Recursos String N/A Não

Nomes dos recursos a serem associados à solicitação.

O parâmetro também pode receber uma lista de strings separadas por vírgulas com nomes de recursos.

Descrição String N/A Não A descrição da solicitação.
Status DDL N/A Não O status da solicitação.
Técnico String N/A Não O nome do técnico atribuído à solicitação.
Prioridade DDL N/A Não A prioridade da solicitação.
Urgência DDL N/A Não A urgência da solicitação.
Categoria DDL N/A Não A categoria da solicitação.
Modelo de solicitação String N/A Não O modelo da solicitação.
Tipo de solicitação DDL N/A Não

O tipo da solicitação.

Exemplo: incidente, solicitação de serviço

Vencimento (ms) String N/A Não A data de vencimento da solicitação em milissegundos.
Modo DDL N/A Não

O modo em que esta solicitação é criada.

Exemplo: e-mail

Nível DDL N/A Não O nível da solicitação.
Site String N/A Não Denota o site a que esta solicitação pertence.
Grupo String N/A Não Grupo a que esta solicitação pertence.
Impacto DDL N/A Não O impacto da solicitação.

Executar em

Essa ação não é executada em 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
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se a ação for bem-sucedida: "A solicitação do ServiceDesk Plus foi criada"

A ação precisa falhar e interromper a execução de um playbook:

Se não der certo: "Erro ao executar a ação "Criar solicitação". Motivo: {0}''.format(error.Stacktrace)

Geral

Jobs

Sincronizar solicitações encerradas por tag

Descrição

Sincroniza solicitações do ServiceDesk Plus V3 criadas no playbook de casos do Google SecOps e nos casos do Google SecOps.

Parâmetros

Parâmetro Tipo Valor padrão É obrigatório Descrição
Raiz da API String http://{IP OR FQDN}:8080/api/v3/ Sim Raiz da API da instância do ServiceDeskPlus.
Chave da API Senha N/A Sim Chave de API da instância do ServiceDeskPlus.
Máximo de horas para trás Número inteiro 24 Não Especifique o número de horas para trás em que os status serão sincronizados.
Verificar SSL Caixa de seleção Selecionado Sim Se ativado, verifique se o certificado SSL da conexão com o servidor ServiceDeskPlus é válido.

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