Akamai を Google SecOps と統合する
このドキュメントでは、Akamai を Google Security Operations(Google SecOps)と統合する方法について説明します。
統合バージョン: 1.0
統合のパラメータ
Akamai との統合には、次のパラメータが必要です。
パラメータ | 説明 |
---|---|
Host |
必須。 Akamai インスタンスのホスト名。 |
Client Token |
必須。 Akamai クライアント トークン。 |
Client Secret |
必須。 Akamai クライアント シークレット。 |
Access Token |
必須。 Akamai アクセス トークン。 |
Verify SSL |
必須。 Akamai に接続する際に SSL 証明書を検証します。 デフォルトで選択されています。 |
操作
アクションの詳細については、Your Workdesk から保留中のアクションに対応すると手動アクションを実行するをご覧ください。
Ping
Ping アクションを使用して、Akamai への接続をテストします。
このアクションは Google SecOps エンティティに対して実行されず、入力パラメータもありません。
アクションの出力
[Ping] アクションでは、次の出力が提供されます。
アクションの出力タイプ | 対象 |
---|---|
ケースウォールのアタッチメント | 利用不可 |
ケースウォールのリンク | 利用不可 |
ケースウォール テーブル | 利用不可 |
拡充テーブル | 利用不可 |
JSON の結果 | 利用不可 |
スクリプトの結果 | 利用可能 |
出力メッセージ
Ping アクションでは、次の出力メッセージが表示されます。
出力メッセージ | メッセージの説明 |
---|---|
Successfully connected to the Akamai server with the provided
connection parameters! |
アクションが成功しました。 |
Failed to connect to the Akamai server! Error is
{0}".format(exception.stacktrace) |
操作を実行できませんでした。 |
スクリプトの結果
次の表に、Ping アクションを使用した場合のスクリプト結果出力の値を示します。
スクリプトの結果名 | 値 |
---|---|
is_success |
True または False |
ネットワーク リストを取得する
ネットワーク リストの取得アクションを使用して、Akamai のネットワーク リストに関する情報を取得します。
アクション入力
[Get Network Lists] アクションには、次のパラメータが必要です。
パラメータ | 説明 |
---|---|
Network List Name |
省略可。 検索するネットワーク リスト名のカンマ区切りのリスト。 |
Network List ID |
省略可。 検索するネットワーク リスト ID のカンマ区切りのリスト。 |
Include Items |
省略可。 ネットワーク リスト内のアイテムに関する情報を返します。 デフォルト値は |
Include Activation Status |
省略可。 各ネットワーク リストのアクティベーション ステータスを返します。 デフォルト値は 注: この情報は、 |
Activation Environment |
省略可。 アクティベーション ステータスが返される環境。 指定できる値は次のとおりです。
注: この情報は、 |
Max Network Lists To Return |
必須。 返すネットワーク リストの最大数。 デフォルト値と最大値は |
Max Network List Items To Return |
必須。 ネットワーク リストごとに返されるアイテムの最大数。 デフォルト値と最大値は |
アクションの出力
[ネットワーク リストを取得] アクションは、次の出力を提供します。
アクションの出力タイプ | 対象 |
---|---|
ケースウォールのアタッチメント | 利用不可 |
ケースウォールのリンク | 利用不可 |
ケースウォール テーブル | 利用不可 |
拡充テーブル | 利用不可 |
JSON の結果 | 利用可能 |
スクリプトの結果 | 利用可能 |
JSON の結果
次の例は、ネットワーク リストを取得アクションを使用した場合に受信する JSON 結果の出力について説明しています。
[
{
"networkListType": "networkListResponse",
"accessControlGroup": "KSD\nwith ION 3-13H1234",
"name": "General List",
"elementCount": 3011,
"readOnly": false,
"shared": false,
"syncPoint": 22,
"type": "IP",
"uniqueId": "25614_GENERALLIST",
"links": {
"activateInProduction": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/activate",
"method": "POST"
},
"activateInStaging": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/activate",
"method": "POST"
},
"appendItems": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST",
"method": "POST"
},
"retrieve": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST"
},
"statusInProduction": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
},
"statusInStaging": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
},
"update": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST",
"method": "PUT"
}
},
"Activation_STAGING": {
"activationId": 12345,
"activationComments": "Allow IPs of new employees who joined this week",
"activationStatus": "PENDING_ACTIVATION",
"syncPoint": 5,
"uniqueId": "25614_GENERALLIST",
"fast": false,
"dispatchCount": 1,
"links": {
"appendItems": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/append",
"method": "POST"
},
"retrieve": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST"
},
"statusInProduction": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
},
"statusInStaging": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
},
"syncPointHistory": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/sync-points/5/history"
},
"update": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST",
"method": "PUT"
},
"activationDetails": {
"href": "/network-list/v2/network-lists/activations/12345/"
}
}
},
"Activation_PRODUCTION": {
"activationId": 12345,
"activationComments": "Allow IPs of new employees who joined this week",
"activationStatus": "PENDING_ACTIVATION",
"syncPoint": 5,
"uniqueId": "25614_GENERALLIST",
"fast": false,
"dispatchCount": 1,
"links": {
"appendItems": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/append",
"method": "POST"
},
"retrieve": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST"
},
"statusInProduction": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
},
"statusInStaging": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
},
"syncPointHistory": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/sync-points/5/history"
},
"update": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST",
"method": "PUT"
},
"activationDetails": {
"href": "/network-list/v2/network-lists/activations/12345/"
}
}
}
}
]
出力メッセージ
ネットワーク リストを取得アクションでは、次の出力メッセージが表示されます。
出力メッセージ | メッセージの説明 |
---|---|
|
アクションが成功しました。 |
Error executing action "Get Network Lists". Reason: {0}''.format
(error.Stacktrace)
|
操作を実行できませんでした。 |
スクリプトの結果
次の表に、ネットワーク リストを取得アクションを使用した場合のスクリプト結果出力の値を示します。
スクリプトの結果名 | 値 |
---|---|
is_success |
True または False |
ネットワーク リストにアイテムを追加する
Add Items To Network List アクションを使用して、Akamai のネットワーク リストにアイテムを追加します。
アクション入力
[Add Items To Network List] アクションには、次のパラメータが必要です。
パラメータ | 説明 |
---|---|
Network List Name |
省略可。 更新するネットワーク リストの名前。
|
Network List ID |
省略可。 更新するネットワーク リストの ID。
|
Items |
必須。 ネットワーク リストに追加する項目のカンマ区切りのリスト。 |
アクションの出力
[Add Items To Network List] アクションは、次の出力を提供します。
アクションの出力タイプ | 対象 |
---|---|
ケースウォールのアタッチメント | 利用不可 |
ケースウォールのリンク | 利用不可 |
ケースウォール テーブル | 利用不可 |
拡充テーブル | 利用不可 |
JSON の結果 | 利用可能 |
スクリプトの結果 | 利用可能 |
JSON の結果
次の例は、[Add Items To Network Lists] アクションを使用した場合に受信する JSON 結果の出力について説明しています。
{
"networkListType": "networkListResponse",
"accessControlGroup": "KSD\nwith ION 3-13H1234",
"name": "General List",
"elementCount": 3011,
"readOnly": false,
"shared": false,
"syncPoint": 22,
"type": "IP",
"uniqueId": "25614_GENERALLIST",
"links": {
"activateInProduction": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/activate",
"method": "POST"
},
"activateInStaging": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/activate",
"method": "POST"
},
"appendItems": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST",
"method": "POST"
},
"retrieve": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST"
},
"statusInProduction": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
},
"statusInStaging": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
},
"update": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST",
"method": "PUT"
}
}
}
出力メッセージ
[Add Items To Network List] アクションでは、次の出力メッセージが表示されます。
出力メッセージ | メッセージの説明 |
---|---|
Successfully updated network list in Akamai. |
アクションが成功しました。 |
|
操作を実行できませんでした。 |
スクリプトの結果
次の表に、[Add Items To Network List] アクションを使用した場合のスクリプト結果出力の値を示します。
スクリプトの結果名 | 値 |
---|---|
is_success |
True または False |
ネットワーク リストからアイテムを削除する
Akamai のネットワーク リストからアイテムを削除するには、[Remove Items From Network List] アクションを使用します。
アクション入力
[Remove Items From Network List] アクションには、次のパラメータが必要です。
パラメータ | 説明 |
---|---|
Network List Name |
省略可。 更新するネットワーク リストの名前。
|
Network List ID |
省略可。 更新するネットワーク リストの ID。
|
Items |
必須。 ネットワーク リストから削除する項目のカンマ区切りのリスト。 |
アクションの出力
[Remove Items From Network List] アクションは、次の出力を提供します。
アクションの出力タイプ | 対象 |
---|---|
ケースウォールのアタッチメント | 利用不可 |
ケースウォールのリンク | 利用不可 |
ケースウォール テーブル | 利用不可 |
拡充テーブル | 利用不可 |
JSON の結果 | 利用可能 |
スクリプトの結果 | 利用可能 |
JSON の結果
次の例は、[ネットワーク リストからアイテムを削除] アクションを使用した場合に受信される JSON 結果の出力を示しています。
{
"networkListType": "networkListResponse",
"accessControlGroup": "KSD\nwith ION 3-13H1234",
"name": "General List",
"elementCount": 3011,
"readOnly": false,
"shared": false,
"syncPoint": 22,
"type": "IP",
"uniqueId": "25614_GENERALLIST",
"links": {
"activateInProduction": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/activate",
"method": "POST"
},
"activateInStaging": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/activate",
"method": "POST"
},
"appendItems": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST",
"method": "POST"
},
"retrieve": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST"
},
"statusInProduction": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
},
"statusInStaging": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
},
"update": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST",
"method": "PUT"
}
}
}
出力メッセージ
[Remove Items From Network List] アクションは、次の出力メッセージを提供します。
出力メッセージ | メッセージの説明 |
---|---|
|
アクションが成功しました。 |
|
操作を実行できませんでした。 |
スクリプトの結果
次の表に、[ネットワーク リストからアイテムを削除] アクションを使用した場合のスクリプト結果出力の値を示します。
スクリプトの結果名 | 値 |
---|---|
is_success |
True または False |
ネットワーク リストを有効にする
Akamai のネットワーク リストからアイテムを削除するには、[Activate Network List] アクションを使用します。
アクション入力
[Activate Network List] アクションには、次のパラメータが必要です。
パラメータ | 説明 |
---|---|
Network List Name |
省略可。 更新するネットワーク リストの名前。
|
Network List ID |
省略可。 更新するネットワーク リストの ID。
|
Environment |
省略可。 有効化のターゲット環境。 指定できる値は次のとおりです。
|
Comment |
省略可。 アクティベーションの目的を説明するコメント。 |
Notification Recipients |
省略可。 ネットワーク リストの有効化について通知するメールアドレスのカンマ区切りリスト。 |
アクションの出力
[ネットワーク リストを有効にする] アクションは、次の出力を提供します。
アクションの出力タイプ | 対象 |
---|---|
ケースウォールのアタッチメント | 利用不可 |
ケースウォールのリンク | 利用不可 |
ケースウォール テーブル | 利用不可 |
拡充テーブル | 利用不可 |
JSON の結果 | 利用可能 |
スクリプトの結果 | 利用可能 |
JSON の結果
次の例は、[ネットワーク リストを有効にする] アクションを使用した場合に受信する JSON 結果の出力について説明しています。
{
"activationId": 12345,
"activationComments": "Allow IPs of new employees who joined this week",
"activationStatus": "PENDING_ACTIVATION",
"syncPoint": 5,
"uniqueId": "25614_GENERALLIST",
"fast": false,
"dispatchCount": 1,
"links": {
"appendItems": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/append",
"method": "POST"
},
"retrieve": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST"
},
"statusInProduction": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
},
"statusInStaging": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
},
"syncPointHistory": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/sync-points/5/history"
},
"update": {
"href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST",
"method": "PUT"
},
"activationDetails": {
"href": "/network-list/v2/network-lists/activations/12345/"
}
}
}
出力メッセージ
[ネットワーク リストを有効にする] アクションでは、次の出力メッセージが表示されます。
出力メッセージ | メッセージの説明 |
---|---|
Successfully activated the network list in Akamai. |
アクションが成功しました。 |
|
操作を実行できませんでした。 |
スクリプトの結果
次の表に、[ネットワーク リストを有効にする] アクションを使用した場合のスクリプト結果の出力値を示します。
スクリプトの結果名 | 値 |
---|---|
is_success |
True または False |
クライアント リストを取得する
クライアント リストを取得アクションを使用して、Akamai のクライアント リストに関する情報を取得します。
アクション入力
[クライアント リストを取得] アクションには、次のパラメータが必要です。
パラメータ | 説明 |
---|---|
Client List Name |
省略可。 検索するクライアント リスト名のカンマ区切りリスト。 |
Client List ID |
省略可。 検索するクライアント リスト ID のカンマ区切りのリスト。 |
Include Items |
省略可。 クライアント リスト内のアイテムに関する情報を返します。 デフォルト値は 注: この情報は、 |
Type |
省略可。 検索するクライアント リストのタイプ。 指定できる値は次のとおりです。
ASN TLS Fingerprint File Hash 注: |
Max Client Lists To Return |
必須。 返すクライアント リストの最大数。 デフォルト値と最大値は |
Max Client List Items To Return |
必須。 クライアント リストごとに返されるアイテムの最大数。 デフォルト値と最大値は |
アクションの出力
[クライアント リストを取得] アクションでは、次の出力が提供されます。
アクションの出力タイプ | 対象 |
---|---|
ケースウォールのアタッチメント | 利用不可 |
ケースウォールのリンク | 利用不可 |
ケースウォール テーブル | 利用不可 |
拡充テーブル | 利用不可 |
JSON の結果 | 利用可能 |
スクリプトの結果 | 利用可能 |
JSON の結果
次の例は、[クライアント リストを取得] アクションを使用した場合に受信する JSON 結果の出力について説明しています。
[
{
"contractId": "K-0N7RAK71",
"createDate": "2023-04-05T18:20:42.090+00:00",
"createdBy": "jsmith",
"deprecated": false,
"groupId": 32145,
"groupName": "Acme IT Group",
"items": [
{
"createDate": "2023-04-05T18:20:42.892+00:00",
"createdBy": "jkowalski",
"description": "Canada - North America",
"expirationDate": "2023-12-31T23:59:19.700+00:00",
"productionStatus": "INACTIVE",
"stagingStatus": "INACTIVE",
"tags": [
"allowlist1"
],
"type": "GEO",
"updateDate": "2023-04-05T18:20:42.892+00:00",
"updatedBy": "mrossi",
"value": "CA"
}
],
"itemsCount": 3,
"listId": "1234_NORTHAMERICAGEOALLOWLIST",
"listType": "CL",
"name": "NorthAmericaGeoAllowlist",
"notes": "GEO code allowlist",
"productionActivationStatus": "INACTIVE",
"readOnly": false,
"shared": false,
"stagingActivationStatus": "INACTIVE",
"tags": [
"allowlist2"
],
"type": "GEO",
"updateDate": "2023-04-05T18:20:42.090+00:00",
"updatedBy": "jdupont",
"version": 1
}
]
出力メッセージ
クライアント リストを取得アクションでは、次の出力メッセージが表示されます。
出力メッセージ | メッセージの説明 |
---|---|
|
アクションが成功しました。 |
Error executing action "Get Client Lists". Reason: {0}''.format
(error.Stacktrace) |
操作を実行できませんでした。 |
スクリプトの結果
次の表に、クライアント リストを取得アクションを使用した場合のスクリプト結果出力の値を示します。
スクリプトの結果名 | 値 |
---|---|
is_success |
True または False |
クライアント リストにアイテムを追加する
Add Items To Client List アクションを使用して、Akamai のクライアント リストにアイテムを追加します。
アクション入力
[Add Items To Client List] アクションには、次のパラメータが必要です。
パラメータ | 説明 |
---|---|
Client List Name |
省略可。 更新するクライアント リストの名前。 注: |
Client List ID |
省略可。 更新するクライアント リストの ID。 注: |
Item Value |
必須。 クライアント リストに追加する項目のカンマ区切りのリスト。 |
Item Description |
省略可。 クライアント リストに追加されたアイテムの説明。 |
Item Expiration Date |
省略可。 追加されたアイテムの有効期限(ISO 8601 形式)。 |
Item Tags |
省略可。 追加されたアイテムに関連付けるタグのカンマ区切りのリスト。 |
アクションの出力
[Add Items To Client List] アクションでは、次の出力が提供されます。
アクションの出力タイプ | 対象 |
---|---|
ケースウォールのアタッチメント | 利用不可 |
ケースウォールのリンク | 利用不可 |
ケースウォール テーブル | 利用不可 |
拡充テーブル | 利用不可 |
JSON の結果 | 利用可能 |
スクリプトの結果 | 利用可能 |
JSON の結果
次の例は、[Add Items To Client List] アクションを使用した場合に受信する JSON 結果の出力を示しています。
[
{
"createDate": "2023-04-05T19:29:02.320+00:00",
"createdBy": "jkowalski",
"description": "Jamaica - North America",
"expirationDate": "2023-12-31T23:59:19.700+00:00",
"productionStatus": "INACTIVE",
"stagingStatus": "INACTIVE",
"tags": [
"allowlist2"
],
"type": "GEO",
"updateDate": "2023-04-05T19:29:02.320+00:00",
"updatedBy": "jdupont",
"value": "JM"
}
}
]
出力メッセージ
[Add Items To Client List] アクションでは、次の出力メッセージが表示されます。
出力メッセージ | メッセージの説明 |
---|---|
Successfully returned client lists from Akamai. |
アクションが成功しました。 |
|
操作を実行できませんでした。 |
スクリプトの結果
次の表に、[Add Items To Client List] アクションを使用した場合のスクリプト結果出力の値を示します。
スクリプトの結果名 | 値 |
---|---|
is_success |
True または False |
クライアント リストからアイテムを削除する
Remove Items From Client List アクションを使用して、Akamai のクライアント リストからアイテムを削除します。
アクション入力
[Remove Items From Client List] アクションには、次のパラメータが必要です。
パラメータ | 説明 |
---|---|
Client List Name |
省略可。 更新するクライアント リストの名前。 注: |
Client List ID |
省略可。 更新するクライアント リストの ID。 注: |
Item Value |
必須。 クライアント リストから削除する項目のカンマ区切りのリスト。 |
アクションの出力
[Remove Items From Client List] アクションは、次の出力を提供します。
アクションの出力タイプ | 対象 |
---|---|
ケースウォールのアタッチメント | 利用不可 |
ケースウォールのリンク | 利用不可 |
ケースウォール テーブル | 利用不可 |
拡充テーブル | 利用不可 |
JSON の結果 | 利用可能 |
スクリプトの結果 | 利用可能 |
JSON の結果
次の例は、Remove Items From Client List アクションを使用した場合に受信する JSON 結果の出力を示しています。
[
{
"createDate": "2023-04-05T19:29:02.320+00:00",
"createdBy": "jkowalski",
"description": "Jamaica - North America",
"expirationDate": "2023-12-31T23:59:19.700+00:00",
"productionStatus": "INACTIVE",
"stagingStatus": "INACTIVE",
"tags": [
"allowlist2"
],
"type": "GEO",
"updateDate": "2023-04-05T19:29:02.320+00:00",
"updatedBy": "jdupont",
"value": "JM"
}
]
出力メッセージ
[Remove Items From Client List] アクションは、次の出力メッセージを提供します。
出力メッセージ | メッセージの説明 |
---|---|
|
アクションが成功しました。 |
|
操作を実行できませんでした。 |
スクリプトの結果
次の表に、[Remove Items From Client List] アクションを使用した場合のスクリプト結果出力の値を示します。
スクリプトの結果名 | 値 |
---|---|
is_success |
True または False |
さらにサポートが必要な場合 コミュニティ メンバーや Google SecOps のプロフェッショナルから回答を得ることができます。