ServiceDesk Plus V3

整合版本：4.0

設定 ServiceDesk Plus V3，以便與 Google Security Operations 搭配使用

如何產生 API 權杖

1. 前往管理使用者控制台。

   

2. 點選該使用者，然後按一下「產生 API 金鑰」。

   

3. 對話方塊會顯示金鑰產生狀態。

   • 如果您已產生金鑰，請務必妥善保管，否則就必須重新產生。
   • 如果沒有，請按一下「產生金鑰」，系統會立即顯示 API 金鑰。

   

在 Google SecOps 中設定 ServiceDesk Plus V3 整合

如需在 Google SecOps 中設定整合功能的詳細操作說明，請參閱「設定整合功能」。

整合參數

請使用下列參數設定整合：

參數顯示名稱	類型	預設值	為必填項目	說明
API 根目錄	字串	http://{IP OR FQDN}:8080/api/v3/	是	ServiceDesk Plus 的 API 根層級。
API 權杖	字串	不適用	是	ServiceDesk Plus 的 API 權杖。(又稱「技術人員金鑰」)
驗證 SSL	核取方塊	已取消勾選	是	啟用後，系統會驗證連線至 ServiceDesk Plus 伺服器的 SSL 憑證是否有效。

動作

乒乓

說明

使用 Google Security Operations Marketplace 分頁整合設定頁面中提供的參數，測試與 ServiceDesk Plus V3 的連線。

參數

不適用

用途

這項動作用於在 Google Security Operations Marketplace 分頁的整合設定頁面上測試連線，可做為手動動作執行，不適用於應對手冊。

執行時間

這項操作不會對實體執行。

動作執行結果

指令碼執行結果

指令碼結果名稱	值選項	範例
is_success	True/False	is_success:False

案件總覽

結果類型	值 / 說明	類型
輸出訊息*	動作不應失敗，也不應停止執行應對手冊： 如果成功： 「已使用提供的連線參數，成功連線至 ServiceDesk Plus V3！」 動作應會失敗並停止執行應對手冊： 如果系統回報重大錯誤，例如憑證錯誤或連線中斷： 「Failed to connect to the ServiceDesk Plus V3! Error is {0}".format(exception.stacktrace)	一般

新增附註

說明

在要求中新增附註。

參數

參數顯示名稱	類型	預設值	為必填項目	說明
要求 ID	字串	不適用	是	要求的 ID。
注意事項	字串	不適用	是	附註內容。
向要求者顯示	核取方塊	已取消勾選	否	指定是否要向要求者顯示附註。
通知技術人員	核取方塊	已取消勾選	否	指定是否要向要求者顯示附註。
標示為「首次回覆」	核取方塊	已取消勾選	否	指定是否要將這則附註標示為第一則回覆。
新增至已連結的要求	核取方塊	已取消勾選	否	指定是否要將這則附註新增至連結的要求。

執行時間

這項操作不會對實體執行。

動作執行結果

指令碼執行結果

指令碼結果名稱	值選項	範例
is_success	True/False	is_success:False

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
        }
    }
}

案件總覽

結果類型	值 / 說明	類型
輸出訊息*	動作不應失敗，也不應停止執行應對手冊： 如果成功： 「已成功將附註新增至 ServiceDesk Plus 要求。要求 ID：{ID}，記事 ID：{note.id}。」 如果找不到「要求 ID」參數： 「Action wasn't able to add note to request with ID {ID} in ServiceDesk Plus. 原因：找不到 ID 為 {ID} 的要求。 動作應會失敗並停止執行應對手冊： 如果未成功： 「執行動作『新增附註動作』時發生錯誤。原因：{0}''.format(error.Stacktrace)	一般

關閉要求

說明

關閉要求。

參數

參數顯示名稱	類型	預設值	為必填項目	說明
要求 ID	字串	不適用	是	要求的 ID。
註解	字串	不適用	是	結尾註解。
已確認解決方案	核取方塊	已取消勾選	否	要求解決方案是否已獲得確認。

執行時間

這項操作不會對實體執行。

動作執行結果

指令碼執行結果

指令碼結果名稱	值選項	範例
is_success	True/False	is_success:False

JSON 結果

{
    "response_status": {
        "status_code": 2000,
        "messages": [
            {
                "status_code": 2000,
                "type": "success",
                "message": "Request(s) closed successfully."
            }
        ],
        "status": "success"
    }
}

案件總覽

結果類型	值 / 說明	類型
輸出訊息*	動作不應失敗，也不應停止執行應對手冊： 如果成功： Print "Successfully closed ServiceDesk Plus request with ID {ID} ." 如果找不到要求 ID： Print "Action wasn't able to close request with ID {ID} in ServiceDesk Plus. 原因：找不到 ID 為 {ID} 的要求。 動作應會失敗並停止執行應對手冊： 如果未成功： Print "Error executing action "Close Request action". 原因：{0}''.format(error.Stacktrace)	一般

新增附註並等待回覆

說明

在要求中新增附註。

注意： 請在 IDE 的逾時部分，更新您希望動作執行的實際時間。

參數

參數顯示名稱	類型	預設值	為必填項目	說明
要求 ID	字串	不適用	是	要求的 ID。
注意事項	字串	不適用	是	附註內容。
向要求者顯示	核取方塊	已取消勾選	否	指定是否要向要求者顯示附註。
通知技術人員	核取方塊	已取消勾選	否	指定是否要向要求者顯示附註。
標示為「首次回覆」	核取方塊	已取消勾選	否	指定是否要將這則附註標示為第一則回覆。
新增至已連結的要求	核取方塊	已取消勾選	否	指定是否要將這則附註新增至連結的要求。

執行時間

這項操作不會對實體執行。

動作執行結果

指令碼執行結果

指令碼結果名稱	值選項	範例
is_success	True/False	is_success:False

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"
        }
    }
}

案件總覽

結果類型	值 / 說明	類型
輸出訊息*	動作不應失敗，也不應停止執行應對手冊： 如果成功：「Successfully added note to ServiceDesk Plus request. 要求 ID：{ID}，記事 ID：{note.id}。」 如果找不到「要求 ID」參數： 「Action wasn't able to add note to request with ID {ID} in ServiceDesk Plus. 原因：找不到 ID 為 {ID} 的要求。 動作應會失敗並停止執行應對手冊： 如果未成功： 「執行動作『新增附註動作』時發生錯誤。原因：{0}''.format(error.Stacktrace)	一般

建立快訊要求

說明

建立與 Google SecOps 快訊相關的要求。

參數

參數顯示名稱	類型	預設值	為必填項目	說明
主旨	字串	不適用	是	要求的主旨。
要求者	字串	API 金鑰使用者	是	要求者。如未指定，則設為 API 金鑰的使用者。
資產	字串	不適用	否	要與要求建立關聯的資產名稱。
狀態	字串	不適用	否	要求的狀態。
技術人員	字串	不適用	否	指派給要求的技術人員姓名。
優先順序	字串	不適用	否	要求的優先順序。
急迫性	字串	不適用	否	要求的緊急程度。
類別	字串	不適用	否	要求的類別。
要求範本	字串	不適用	否	要求的範本。
要求類型	字串	不適用	否	要求的類型。 例如事件、服務要求
到期時間 (毫秒)	字串	不適用	否	要求截止日期 (以毫秒為單位)。
模式	字串	不適用	否	建立這項要求的模式。 示例：電子郵件
等級	字串	不適用	否	要求的層級。
網站	字串	不適用	否	表示這項要求所屬的網站。
群組	字串	不適用	否	這項要求所屬的群組。
影響	字串	不適用	否	要求的影響。

執行時間

這項操作不會對實體執行。

動作執行結果

指令碼執行結果

指令碼結果名稱	值選項	範例
is_success	True/False	is_success:False

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"
    }
}

案件總覽

結果類型	值 / 說明	類型
輸出訊息*	動作不應失敗，也不應停止執行應對手冊： 如果成功： 「Successfully created ServiceDesk Plus request」(已成功建立 ServiceDesk Plus 要求) 動作應會失敗並停止執行應對手冊： 如果未成功： 「Error executing action "Create Alert Request action". 原因：{0}''.format(error.Stacktrace)	一般

建立要求

說明

建立新要求。

參數

參數	類型	預設值	為必填項目	說明
主旨	字串	不適用	是	要求的主旨。
要求者	字串	API 金鑰使用者	是	要求者。如未指定，則設為 API 金鑰的使用者。
說明	字串	不適用	否	要求的說明。
資產	字串	不適用	否	要與要求建立關聯的資產名稱。
狀態	字串	不適用	否	要求的狀態。
技術人員	字串	不適用	否	指派給要求的技術人員姓名。
優先順序	字串	不適用	否	要求的優先順序。
急迫性	字串	不適用	否	要求的緊急程度。
類別	字串	不適用	否	要求的類別。
要求範本	字串	不適用	否	要求的範本。
要求類型	字串	不適用	否	要求的類型。 例如事件、服務要求
到期時間 (毫秒)	字串	不適用	否	要求截止日期 (以毫秒為單位)。
模式	字串	不適用	否	建立這項要求的模式。 示例：電子郵件
等級	字串	不適用	否	要求的層級。
網站	字串	不適用	否	表示這項要求所屬的網站。
群組	字串	不適用	否	這項要求所屬的群組。
影響	字串	不適用	否	要求的影響。

執行時間

這項操作不會對實體執行。

動作執行結果

指令碼執行結果

指令碼結果名稱	值選項	範例
is_success	True/False	is_success:False

案件總覽

結果類型	值 / 說明	類型
輸出訊息*	動作不應失敗，也不應停止執行應對手冊： 如果成功：「Successfully created ServiceDesk Plus request」(已成功建立 ServiceDesk Plus 要求) 動作應會失敗並停止執行應對手冊： 如果未成功：「Error executing action "Create Request action". 原因：{0}''.format(error.Stacktrace)	一般

取得要求

說明

在 ServiceDesk Plus 中擷取要求相關資訊。

參數

參數	類型	預設值	為必填項目	說明
要求 ID	字串	不適用	是	要求的 ID。

執行時間

這項操作不會對實體執行。

動作執行結果

指令碼執行結果

指令碼結果名稱	值選項	範例
is_success	True/False	is_success:False

案件總覽

結果類型	值 / 說明	類型
輸出訊息*	動作不應失敗，也不應停止執行應對手冊： 如果成功：「Successfully fetched ServiceDesk Plus request with ID {ID} .」(已成功擷取 ID 為 {ID} 的 ServiceDesk Plus 要求。) 如果找不到「要求 ID」參數：「Action wasn't able fetch request with ID {ID} in ServiceDesk Plus. 原因：找不到 ID 為 {ID} 的要求。 動作應會失敗並停止執行應對手冊： 如果未成功：「Error executing action "Get Request action". 原因：{0}''.format(error.Stacktrace)	一般

等待欄位更新

說明

等待要求中的欄位更新為所需值。

注意： 請在 IDE 的逾時部分，更新您希望動作執行的實際時間。

參數

參數	類型	預設值	為必填項目	說明
要求 ID	字串	不適用	是	要求的 ID。
欄位名稱	字串	不適用	是	要更新的欄位名稱。
值	字串	不適用	是	指定欄位的所需值。

執行時間

這項操作不會對實體執行。

動作執行結果

指令碼執行結果

指令碼結果名稱	值選項	範例
is_success	True/False	is_success:False

案件總覽

結果類型	值 / 說明	類型
輸出訊息*	動作不應失敗，也不應停止執行應對手冊： 如果成功為欄位建立等待 (非同步動作) 工作：「Created analysis tasks for the field: {0}」(已為欄位建立分析工作：{0})。format([fields_list])。 如果無法為所有提供的欄位建立分析工作：「No ServiceDesk Plus analysis tasks were created」(未建立任何 ServiceDesk Plus 分析工作)。 如果仍等待更新欄位：「Action waiting for the next update」(等待下次更新的動作) 動作應失敗並停止執行應對手冊： 如果系統回報重大錯誤，例如憑證錯誤或連線中斷：「Failed to connect to the ServiceDesk service! Error is {0}".format(exception.stacktrace)	一般

更新要求

說明

透過 ID 更新 ServiceDesk Plus 要求。

參數

參數	類型	預設值	為必填項目	說明
要求 ID	字串	不適用	是	要更新的要求 ID。
主旨	字串	不適用	否	要求的主旨。
要求者	字串	不適用	否	要求者。 如未指定，則設為 API 金鑰的使用者。
說明	字串	不適用	否	要求的說明。
資產	字串	不適用	否	要與要求建立關聯的資產名稱。 這個參數也可以取得以半形逗號分隔的資產名稱字串清單。
狀態	字串	不適用	否	要求的狀態。
技術人員	字串	不適用	否	指派給要求的技術人員姓名。
優先順序	字串	不適用	否	要求的優先順序。
急迫性	字串	不適用	否	要求的緊急程度。
類別	字串	不適用	否	要求的類別。
要求範本	字串	不適用	否	要求的範本。
要求類型	字串	不適用	否	要求的類型。 例如事件、服務要求
到期時間 (毫秒)	字串	不適用	否	要求截止日期 (以毫秒為單位)。
模式	字串	不適用	否	建立這項要求的模式。 示例：電子郵件
等級	字串	不適用	否	要求的層級。
網站	字串	不適用	否	表示這項要求所屬的網站。
群組	字串	不適用	否	這項要求所屬的群組。
影響	字串	不適用	否	要求的影響。

執行時間

這項操作不會對實體執行。

動作執行結果

指令碼執行結果

指令碼結果名稱	值選項	範例
is_success	True/False	is_success:False

案件總覽

結果類型	值 / 說明	類型
輸出訊息*	動作不應失敗，也不應停止執行應對手冊： 如果成功：「Successfully updated ServiceDesk Plus request with ID {ID} .」(已成功更新 ID 為 {ID} 的 ServiceDesk Plus 要求。) 如果找不到「要求 ID」參數：「Action wasn't able update request with ID {ID} in ServiceDesk Plus. 原因：找不到 ID 為 {ID} 的要求。 動作應會失敗並停止執行應對手冊： 如果未成功：「Error executing action "Update Request action". 原因：{0}''.format(error.Stacktrace)	一般

等待狀態更新

說明

等待要求狀態更新為所需狀態。

注意： 請在 IDE 的逾時部分，更新您希望動作執行的實際時間。

參數

參數	類型	預設值	為必填項目	說明
要求 ID	字串	不適用	是	要求的 ID。
值	字串	不適用	是	指定欄位的所需值。

執行時間

這項操作不會對實體執行。

動作執行結果

指令碼執行結果

指令碼結果名稱	值選項	範例
is_success	True/False	is_success:False

案件總覽

結果類型	值 / 說明	類型
輸出訊息*	動作不應失敗，也不應停止執行應對手冊： 如果成功為欄位建立等待 (非同步動作) 工作：「Created analysis tasks for the field: {0}」(已為欄位建立分析工作：{0})。format([fields_list])。 如果無法為所有提供的欄位建立分析工作：「No ServiceDesk Plus analysis tasks were created.」(未建立任何 ServiceDesk Plus 分析工作)。 如果仍等待更新欄位：「Action waiting for the next update」(等待下次更新的動作) 動作應失敗並停止執行應對手冊： 如果系統回報重大錯誤，例如憑證錯誤或連線中斷：「Failed to connect to the ServiceDesk service! Error is {0}".format(exception.stacktrace)	一般

建立要求 - 下拉式清單

說明

建立新要求。

參數

參數	類型	預設值	為必填項目	說明
主旨	字串	不適用	是	要求的主旨。
要求者	字串	不適用	否	要求者。如未指定，則設為 API 金鑰的使用者。
資產	字串	不適用	否	要與要求建立關聯的資產名稱。 參數也可以取得以半形逗號分隔的資產名稱字串清單。
說明	字串	不適用	否	要求的說明。
狀態	DDL	不適用	否	要求的狀態。
技術人員	字串	不適用	否	指派給要求的技術人員姓名。
優先順序	DDL	不適用	否	要求的優先順序。
急迫性	DDL	不適用	否	要求的緊急程度。
類別	DDL	不適用	否	要求的類別。
要求範本	字串	不適用	否	要求的範本。
要求類型	DDL	不適用	否	要求的類型。 例如事件、服務要求
到期時間 (毫秒)	字串	不適用	否	要求截止日期 (以毫秒為單位)。
模式	DDL	不適用	否	建立這項要求的模式。 示例：電子郵件
等級	DDL	不適用	否	要求的層級。
網站	字串	不適用	否	表示這項要求所屬的網站。
群組	字串	不適用	否	這項要求所屬的群組。
影響	DDL	不適用	否	要求的影響。

執行時間

這項操作不會對實體執行。

動作執行結果

指令碼執行結果

指令碼結果名稱	值選項	範例
is_success	True/False	is_success:False

案件總覽

結果類型	值 / 說明	類型
輸出訊息*	動作不應失敗，也不應停止執行應對手冊： 如果成功：「Successfully created ServiceDesk Plus request」(已成功建立 ServiceDesk Plus 要求) 動作應會失敗並停止執行應對手冊： 如果未成功：「Error executing action "Create Request action". 原因：{0}''.format(error.Stacktrace)	一般

工作

依標記同步處理已結案的要求

說明

同步處理在 Google SecOps 案件劇本和 Google SecOps 案件中建立的 ServiceDesk Plus V3 要求。

注意： 在 ServiceDesk Plus V3 中，「已取消」、「已結案」和「已解決」狀態視為已結案。此外，案件必須有兩個標記，工作才能正常運作。第一個標記應為「ServiceDesk Plus」，第二個標記應以「ServiceDesk Plus Requests:{request id}」前置字元開頭。

參數

參數	類型	預設值	為必填項目	說明
API 根目錄	字串	http://{IP OR FQDN}:8080/api/v3/	是	ServiceDeskPlus 執行個體的 API 根目錄。
API 金鑰	密碼	不適用	是	ServiceDeskPlus 執行個體的 API 金鑰。
可倒轉的小時數上限	整數	24	否	指定要回溯同步處理狀態的小時數。
驗證 SSL	核取方塊	已勾選	是	如果已啟用，請確認連線至 ServiceDeskPlus 伺服器的 SSL 憑證是否有效。

還有其他問題嗎？向社群成員和 Google SecOps 專業人員尋求答案。