ServiceDesk Plus V3

統合バージョン: 4.0

Google Security Operations と連携するように ServiceDesk Plus V3 を構成する

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 証明書が有効であることを確認します。

アクション

Ping

説明

[Google Security Operations Marketplace] タブの統合構成ページで提供されるパラメータを使用して、ServiceDesk Plus V3 への接続性をテストします。

パラメータ

なし

ユースケース

このアクションは、Google Security Operations Marketplace タブの統合構成ページで接続性をテストするために使用されます。手動アクションとして実行でき、ハンドブックでは使用されません。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果

スクリプトの結果名	値のオプション	例
is_success	True/False	is_success:False

ケースウォール

結果のタイプ	値 / 説明	種類
出力メッセージ *	アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。 成功した場合: 「指定された接続パラメータを使用して ServiceDesk Plus V3 に正常に接続しました。」 アクションが失敗し、ハンドブックの実行が停止します。 認証情報の誤りや接続の切断などの重大なエラーが報告された場合: 「ServiceDesk Plus V3 に接続できませんでした。エラーは {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.」を出力します。Reason: Request with ID {ID} wasn't found」と出力します。 アクションが失敗し、ハンドブックの実行が停止します。 不成功の場合: 「アクション「メモの追加」の実行中にエラーが発生しました。理由: {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"
    }
}

ケースウォール

結果のタイプ	値 / 説明	種類
出力メッセージ *	アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。 成功した場合: 「Successfully closed ServiceDesk Plus request with ID {ID} .」を出力します。 リクエスト ID が見つからない場合: 「Action has't closed request with ID {ID} in ServiceDesk Plus.」を出力します。Reason: Request with ID {ID} wasn't found」と出力します。 アクションが失敗し、ハンドブックの実行が停止します。 不成功の場合: 「アクション「リクエスト アクションを閉じる」の実行中にエラーが発生しました」と出力します。理由: {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"
        }
    }
}

ケースウォール

結果のタイプ	値 / 説明	種類
出力メッセージ *	アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。 成功した場合: 「ServiceDesk Plus リクエストにメモが正常に追加されました。リクエスト ID: {ID}、メモ ID: {note.id}。」 「リクエスト ID」パラメータが見つからない場合: 「Action wasn't able to add note to request with ID {ID} in ServiceDesk Plus.」を出力します。Reason: Request with ID {ID} wasn't found」と出力します。 アクションが失敗し、ハンドブックの実行が停止します。 不成功の場合: 「アクション「メモの追加」の実行中にエラーが発生しました。理由: {0}」.format(error.Stacktrace)	一般

アラート リクエストを作成する

説明

Google SecOps アラートに関連するリクエストを作成します。

パラメータ

パラメータの表示名	種類	デフォルト値	必須	説明
件名	文字列	なし	○	リクエストの件名。
リクエスト元	文字列	API キーのユーザー	○	リクエストの送信者。指定しない場合、API キーのユーザーに設定されます。
アセット	文字列	なし	いいえ	リクエストに関連付けるアセットの名前。
ステータス	文字列	なし	いいえ	リクエストのステータス。
技術者	文字列	なし	いいえ	リクエストに割り当てられた技術者の名前。
優先度	文字列	なし	いいえ	リクエストの優先度。
緊急度	文字列	なし	いいえ	リクエストの緊急度。
カテゴリ	文字列	なし	いいえ	リクエストのカテゴリ。
リクエスト　テンプレート	文字列	なし	いいえ	リクエストのテンプレート。
リクエストの種類	文字列	なし	いいえ	リクエストのタイプ。 例: インシデント、サービス リクエスト
期限時刻（ミリ秒）	文字列	なし	いいえ	リクエストの期日（ミリ秒単位）。
モード	文字列	なし	いいえ	このリクエストが作成されたモード。 例: E-メール
レベル	文字列	なし	いいえ	リクエストのレベル。
サイト	文字列	なし	いいえ	このリクエストが属するサイトを示します。
グループ	文字列	なし	いいえ	このリクエストが属するグループ。
影響	文字列	なし	いいえ	リクエストの影響。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果

スクリプトの結果名	値のオプション	例
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"
    }
}

ケースウォール

結果のタイプ	値 / 説明	種類
出力メッセージ *	アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。 成功した場合: 「ServiceDesk Plus リクエストが正常に作成されました」 アクションが失敗し、ハンドブックの実行が停止します。 不成功の場合: 「アクション「Create Alert Request action」の実行中にエラーが発生しました。理由: {0}」.format(error.Stacktrace)	一般

リクエストを作成

説明

新しいリクエストを作成。

パラメータ

パラメータ	種類	デフォルト値	必須	説明
件名	文字列	なし	○	リクエストの件名。
リクエスト元	文字列	API キーのユーザー	○	リクエストの送信者。指定しない場合、API キーのユーザーに設定されます。
説明	文字列	なし	いいえ	リクエストの説明。
アセット	文字列	なし	いいえ	リクエストに関連付けるアセットの名前。
ステータス	文字列	なし	いいえ	リクエストのステータス。
技術者	文字列	なし	いいえ	リクエストに割り当てられた技術者の名前。
優先度	文字列	なし	いいえ	リクエストの優先度。
緊急度	文字列	なし	いいえ	リクエストの緊急度。
カテゴリ	文字列	なし	いいえ	リクエストのカテゴリ。
リクエスト　テンプレート	文字列	なし	いいえ	リクエストのテンプレート。
リクエストの種類	文字列	なし	いいえ	リクエストのタイプ。 例: インシデント、サービス リクエスト
期限時刻（ミリ秒）	文字列	なし	いいえ	リクエストの期日（ミリ秒単位）。
モード	文字列	なし	いいえ	このリクエストが作成されたモード。 例: E-メール
レベル	文字列	なし	いいえ	リクエストのレベル。
サイト	文字列	なし	いいえ	このリクエストが属するサイトを示します。
グループ	文字列	なし	いいえ	このリクエストが属するグループ。
影響	文字列	なし	いいえ	リクエストの影響。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果

スクリプトの結果名	値のオプション	例
is_success	True/False	is_success:False

ケースウォール

結果のタイプ	値 / 説明	種類
出力メッセージ *	アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。 成功した場合: 「ServiceDesk Plus リクエストが正常に作成されました」 アクションが失敗し、ハンドブックの実行が停止します。 不成功の場合: 「アクション「リクエスト アクションの作成」の実行中にエラーが発生しました。理由: {0}」.format(error.Stacktrace)	一般

リクエストの取得

説明

ServiceDesk Plus のリクエストに関する情報を取得します。

パラメータ

パラメータ	種類	デフォルト値	必須	説明
リクエスト ID	文字列	なし	○	リクエストの ID。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果

スクリプトの結果名	値のオプション	例
is_success	True/False	is_success:False

ケースウォール

結果のタイプ	値 / 説明	種類
出力メッセージ *	アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。 成功した場合: 「ID {ID} の ServiceDesk Plus リクエストが正常に取得されました。」 「リクエスト ID」パラメータが見つからない場合: 「Action wasn't able fetch request with ID {ID} in ServiceDesk Plus. Reason: Request with ID {ID} wasn't found」と出力します。 アクションが失敗し、ハンドブックの実行が停止します。 不成功の場合: 「アクション「Get Request action」の実行中にエラーが発生しました。」理由: {0}」.format(error.Stacktrace)	一般

フィールドの更新を待機

説明

リクエストのフィールドが目的の値に更新されるのを待ちます。

注: このアクションの IDE タイムアウト セクションで、アクションを実行する実際の時間を更新します。

パラメータ

パラメータ	種類	デフォルト値	必須	説明
リクエスト ID	文字列	なし	○	リクエストの ID。
フィールド名	文字列	なし	○	更新するフィールドの名前。
値	文字列	なし	○	指定されたフィールドの目的の値。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果

スクリプトの結果名	値のオプション	例
is_success	True/False	is_success:False

ケースウォール

結果のタイプ	値 / 説明	種類
出力メッセージ *	アクションが失敗したり、Playbook の実行が停止したりすることはありません。 フィールドの待機（非同期アクション）タスクが正常に作成された場合: 「フィールドの分析タスクを作成しました: {0}」.format([fields_list])。 指定されたすべてのフィールドの分析タスクを作成できない場合: 「ServiceDesk Plus 分析タスクは作成されませんでした。」 フィールドの更新をまだ待っている場合: 「Action waiting for the next update」（次の更新を待機中のアクション） アクションが失敗し、Playbook の実行が停止します。 認証情報の誤りや接続の切断などの重大なエラーが報告された場合:「ServiceDesk サービスへの接続に失敗しました。エラー: {0}」.format(exception.stacktrace)	一般

リクエストの更新

説明

ID を使用して ServiceDesk Plus リクエストを更新します。

パラメータ

パラメータ	種類	デフォルト値	必須	説明
リクエスト ID	文字列	なし	True	更新するリクエストの ID。
件名	文字列	なし	いいえ	リクエストの件名。
リクエスト元	文字列	なし	いいえ	リクエストの送信者。 指定しない場合、API キーのユーザーに設定されます。
説明	文字列	なし	いいえ	リクエストの説明。
アセット	文字列	なし	いいえ	リクエストに関連付けるアセットの名前。 パラメータには、アセットの名前を含むカンマ区切りの文字列のリストを指定することもできます。
ステータス	文字列	なし	いいえ	リクエストのステータス。
技術者	文字列	なし	いいえ	リクエストに割り当てられた技術者の名前。
優先度	文字列	なし	いいえ	リクエストの優先度。
緊急度	文字列	なし	いいえ	リクエストの緊急度。
カテゴリ	文字列	なし	いいえ	リクエストのカテゴリ。
リクエスト　テンプレート	文字列	なし	いいえ	リクエストのテンプレート。
リクエストの種類	文字列	なし	いいえ	リクエストのタイプ。 例: インシデント、サービス リクエスト
期限時刻（ミリ秒）	文字列	なし	いいえ	リクエストの期日（ミリ秒単位）。
モード	文字列	なし	いいえ	このリクエストが作成されたモード。 例: E-メール
レベル	文字列	なし	いいえ	リクエストのレベル。
サイト	文字列	なし	いいえ	このリクエストが属するサイトを示します。
グループ	文字列	なし	いいえ	このリクエストが属するグループ。
影響	文字列	なし	いいえ	リクエストの影響。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果

スクリプトの結果名	値のオプション	例
is_success	True/False	is_success:False

ケースウォール

結果のタイプ	値 / 説明	種類
出力メッセージ *	アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。 成功した場合: 「ID {ID} の ServiceDesk Plus リクエストが正常に更新されました。」 「リクエスト ID」パラメータが見つからない場合: 「Action wasn't able update request with ID {ID} in ServiceDesk Plus. Reason: Request with ID {ID} wasn't found」と出力します。 アクションが失敗し、ハンドブックの実行が停止します。 不成功の場合: 「アクション「Update Request action」の実行中にエラーが発生しました。理由: {0}」.format(error.Stacktrace)	一般

ステータスの更新を待機する

説明

リクエストのステータスが目的のステータスに更新されるまで待機します。

注: このアクションの IDE タイムアウト セクションで、アクションを実行する実際の時間を更新します。

パラメータ

パラメータ	種類	デフォルト値	必須	説明
リクエスト ID	文字列	なし	○	リクエストの ID。
値	文字列	なし	○	指定されたフィールドの目的の値。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果

スクリプトの結果名	値のオプション	例
is_success	True/False	is_success:False

ケースウォール

結果のタイプ	値 / 説明	種類
出力メッセージ *	アクションが失敗したり、Playbook の実行が停止したりすることはありません。 フィールドの待機（非同期アクション）タスクが正常に作成された場合: 「フィールドの分析タスクを作成しました: {0}」.format([fields_list])。 指定されたすべてのフィールドの分析タスクを作成できなかった場合: 「ServiceDesk Plus 分析タスクは作成されませんでした。」 フィールドの更新をまだ待っている場合: 「Action waiting for the next update」（次の更新を待機中のアクション） アクションが失敗し、Playbook の実行が停止します。 認証情報の誤りや接続の切断などの重大なエラーが報告された場合:「ServiceDesk サービスへの接続に失敗しました。エラー: {0}」.format(exception.stacktrace)	一般

リクエストの作成 - プルダウン リスト

説明

新しいリクエストを作成。

パラメータ

パラメータ	種類	デフォルト値	必須	説明
件名	文字列	なし	○	リクエストの件名。
リクエスト元	文字列	なし	いいえ	リクエストの送信者。指定しない場合、API キーのユーザーに設定されます。
アセット	文字列	なし	いいえ	リクエストに関連付けるアセットの名前。 パラメータには、アセット名のカンマ区切りの文字列のリストを指定することもできます。
説明	文字列	なし	いいえ	リクエストの説明。
ステータス	DDL	なし	いいえ	リクエストのステータス。
技術者	文字列	なし	いいえ	リクエストに割り当てられた技術者の名前。
優先度	DDL	なし	いいえ	リクエストの優先度。
緊急度	DDL	なし	いいえ	リクエストの緊急度。
カテゴリ	DDL	なし	いいえ	リクエストのカテゴリ。
リクエスト　テンプレート	文字列	なし	いいえ	リクエストのテンプレート。
リクエストの種類	DDL	なし	いいえ	リクエストのタイプ。 例: インシデント、サービス リクエスト
期限時刻（ミリ秒）	文字列	なし	いいえ	リクエストの期日（ミリ秒単位）。
モード	DDL	なし	いいえ	このリクエストが作成されたモード。 例: E-メール
レベル	DDL	なし	いいえ	リクエストのレベル。
サイト	文字列	なし	いいえ	このリクエストが属するサイトを示します。
グループ	文字列	なし	いいえ	このリクエストが属するグループ。
影響	DDL	なし	いいえ	リクエストの影響。

実行

このアクションはエンティティに対しては実行されません。

アクションの結果

スクリプトの結果

スクリプトの結果名	値のオプション	例
is_success	True/False	is_success:False

ケースウォール

結果のタイプ	値 / 説明	種類
出力メッセージ *	アクションが失敗したり、ハンドブックの実行を停止したりすることはありません。 成功した場合: 「ServiceDesk Plus リクエストが正常に作成されました」 アクションが失敗し、ハンドブックの実行が停止します。 不成功の場合: 「アクション「リクエスト アクションの作成」の実行中にエラーが発生しました。理由: {0}」.format(error.Stacktrace)	一般

ジョブ

タグでクローズされたリクエストを同期する

説明

Google SecOps Case ハンドブックと Google SecOps ケース内で作成された ServiceDesk Plus V3 リクエストを同期します。

注: ServiceDesk Plus V3 では、「キャンセル」、「クローズ」、「解決済み」のステータスはクローズとして扱われます。また、ジョブが機能するには、ケースに 2 つのタグが必要です。最初のタグは「ServiceDesk Plus」で、2 番目のタグは「ServiceDesk Plus Requests:{request id}」という接頭辞で始まる必要があります。

パラメータ

パラメータ	種類	デフォルト値	必須	説明
API ルート	文字列	http://{IP OR FQDN}:8080/api/v3/	○	ServiceDeskPlus インスタンスの API ルート。
API キー	パスワード	なし	○	ServiceDeskPlus インスタンスの API キー。
最大遡及時間	整数	24	いいえ	ステータスを同期するために遡る時間数を指定します。
SSL を確認	チェックボックス	オン	○	有効になっている場合は、ServiceDeskPlus サーバーへの接続用の SSL 証明書が有効であることを確認します。

さらにサポートが必要な場合 コミュニティ メンバーや Google SecOps のプロフェッショナルから回答を得ることができます。