Secure Application API

このページでは、選択したパラメータ、ダッシュボード、およびセキュリティレポートをクエリするために使用できる Secure Application API メソッドについて説明します。

API レート制限

Secure Application API は、1 分あたり最大 300 の要求をサポートします。

アクセストークンの生成

OAuth API を使用してトークンを生成することによって、コントローラへの各 API アクセスコールのアクセストークンを生成できます。

エンドポイントの使用例：

BASH 
curl -X GET  'https://<controller address>/controller/argento/public-api/v1/applications' \
--header 'Authorization: Bearer <your-token-from-ouath-above>'

アプリケーションリストの取得

オプションの SCIM フィルタリングおよびソート機能を使用して、アプリケーションのページネーションされたリストを取得します。セキュリティステータス、エージェント数、およびメタデータを含むアプリケーションの詳細を返します。

CODE 
GET controller/argento/public-api/v1/applications

パラメータ

Name タイプ 説明
date（クエリパラメータ） 文字列

一時的フィルタリングの RFC3339 フォーマットの日付と時刻。日付が指定されていない場合、API はデフォルトで過去 8 日間のデータを返します。指定すると、過去 8 日間のみのフィルタリングが可能になります。8 日より前の日付または将来の日付は拒否されます。UTC とローカルのタイムゾーンオフセットをサポートしています。

例：UTC: 2021-01-30T08:30:00Z、Pacific: 2021-01-30T08:30:00-08:00、Eastern: 2021-01-30T08:30:00-05:00
max（クエリパラメータ） 整数

1 ページあたりの返される最大アイテム数。有効な整数である必要があります。

デフォルトでは60000。 10
offset（クエリパラメータ） 整数

ページネーションでスキップするアイテム数。有効な整数である必要があります。

デフォルトでは60000。 0
sort（クエリパラメータ） 文字列

結果をソートするフィールド名。利用可能なフィールド：applicationName、applicationAppdId、applicationCreatedAt、applicationSecurityEnabled、applicationSecurityEnabledComputed、countApmActive、countSupportedAgent、countSecured、countSecurityEnabled、countReady。フィールド名の大文字と小文字は区別されません。

例： "applicationName"
order（クエリパラメータ） 文字列

結果のソート順序。昇順の場合は ASC、降順の場合は DESC である必要があります。

デフォルトでは60000。 "DESC"
filter（クエリパラメータ） 文字列

RFC 7644 で定義されている、結果フィルタリングの SCIM フィルタ式。サポートされる演算子：eq（等しい）、co（含む）。フィルタリング可能なフィールド：applicationName、applicationSecurityEnabled、applicationSecurityEnabledComputed。フィールド名の大文字と小文字は区別されません。

例："applicationName eq MyApp"、"applicationSecurityEnabled eq true"、"applicationName co web"
applicationId（クエリパラメータ） 整数

出力を 1 つのアプリケーションのみに制限するグローバル アプリケーション フィルタ。応答から appdApplicationId 値を使用します。応答からフィールド appdApplicationId の値を使用します。

レスポンス

Code 200

アプリケーションリストが正常に取得された場合：

JSON 
{
  "items": [
    {
      "appdApplicationId": 0,
      "applicationCreatedAt": "string",
      "applicationId": "string",
      "applicationName": "string",
      "applicationSecurityEnabled": true,
      "applicationSecurityEnabledComputed": true,
      "countApmActive": 0,
      "countReady": 0,
      "countSecured": 0,
      "countSecurityEnabled": 0,
      "countSupportedAgent": 0
    }
  ],
  "total": 0
}
Code 400

不正なリクエスト：無効なクエリパラメータ、不正な形式の SCIM フィルタ式、または検証エラー：

JSON 
{
  "error": "string"
}
Code 500

内部サーバエラー:

JSON 
{
  "error": "string"
}

アプリケーション階層の取得

オプションの SCIM フィルタリングおよびソート機能を使用して、特定のアプリケーションの階層のページネーションされたリストを取得します。セキュリティステータス、エージェント数、およびメタデータを含む階層の詳細を返します。

CODE 
GET controller/argento/public-api/v1/applications/{applicationId}/tiers

パラメータ

Name タイプ 説明
applicationId（経路パラメータ） 文字列

階層を取得するアプリケーション識別子（汎用一意識別子フォーマット）。有効な汎用一意識別子である必要があります。
date（クエリパラメータ） 文字列

一時的フィルタリングの RFC3339 フォーマットの日付と時刻。UTC とローカルの両方のタイムゾーンオフセットをサポートしています。

例：UTC：'2021-01-30T08:30:00Z'、太平洋標準時：'2021-01-30T08:30:00-08:00'、インド時間：'2021-01-30T08:30:00+05:30'、東部時間：'2021-01-30T08:30:00-05:00'。将来の日付は 'date is in the future' エラーで拒否されます。
max（クエリパラメータ） 整数

1 ページあたりの返される最大アイテム数。有効な整数である必要があります。

デフォルトでは60000。 10
offset（クエリパラメータ） 整数

ページネーションでスキップするアイテム数。有効な整数である必要があります。

デフォルトでは60000。 0
sort（クエリパラメータ） 文字列

結果をソートするフィールド名。利用可能なフィールド：tiername、appdtierid、appdapplicationid、createdat、tiersecurityenabled、tiersecurityenabledcomputed、countapmactive、countsupportedagent、countsecured、countsecurityenabled、countready。フィールド名の大文字と小文字は区別されません。

例： "tiername"
order（クエリパラメータ） 文字列

結果のソート順序。昇順の場合は ASC、降順の場合は DESC である必要があります。

デフォルトでは60000。 "DESC"
filter（クエリパラメータ） 文字列

結果フィルタリングの SCIM フィルタ式。サポートされる演算子：eq（等しい）、co（含む）。フィルタリング可能なフィールド：tiername、tiersecurityenabled、tiersecurityenabledcomputed。フィールド名の大文字と小文字は区別されません。

例："tiername eq \"、"tiername eq "WebTier"
applicationId（クエリパラメータ） 整数

出力を 1 つのアプリケーションのみに制限するグローバル アプリケーション フィルタ。応答の appdApplicationId 値を使用します。

例： 12345
tierId（クエリパラメータ） 整数

出力を 1 つの階層のみに制限するグローバル階層フィルタ。応答の appdTierId 値を使用します。

レスポンス

Code 200

階層リストが正常に取得されました。

JSON 
{
  "items": [
    {
      "appdApplicationId": 0,
      "appdTierId": 0,
      "applicationId": "string",
      "applicationName": "string",
      "countApmActive": 0,
      "countReady": 0,
      "countSecured": 0,
      "countSecurityEnabled": 0,
      "countSupportedAgent": 0,
      "id": "string",
      "tierCreatedAt": "string",
      "tierEnableSecurity": true,
      "tierEnableSecurityStatus": true,
      "tierName": "string"
    }
  ],
  "total": 0
}
Code 400

不正なリクエスト：無効なクエリパラメータ、不正な形式の SCIM フィルタ式、または検証エラー：

JSON 
{
  "error": "string"
}
Code 500

内部サーバエラー:

JSON 
{
  "error": "string"
}

攻撃リストの取得

テナントにアクセス可能なすべての攻撃の概要の、ページネーションされたフィルタリング可能なリストを返します。結果をフィルタリングするための SCIM ベースのフィルタリング、複数のフィールドによる回数変更可能ソート、時間ベースのクエリ、標準規格のページネーションをサポートします。結果には、攻撃の分類、タイムライン情報、関連するアプリケーション/階層のコンテキスト、ビジネストランザクションの詳細、セキュリティ アセスメント データなどの包括的な攻撃のメタデータが含まれます。この端末を使用して、環境内で検出されたすべてのセキュリティ攻撃を参照および検索します。

JSON 
GET controller/argento/public-api/v1/attacks

パラメータ

Name タイプ 説明
startedAt（クエリパラメータ） 文字列

タイムゾーンサポートを使用して、RFC3339 フォーマットで攻撃の時間ベースのフィルタリングを開始する時間の境界。日付が指定されていない場合、API はデフォルトで過去 8 日間のデータを返します。指定すると、過去 8 日間のみのフィルタリングが可能になります。8 日より前の日付または将来の日付は拒否されます。endedAt パラメータと使用する必要があります。

例： "2021-01-30T08:30:00Z"
endedAt（クエリパラメータ） 文字列

タイムゾーンサポートを使用して、RFC3339 フォーマットで攻撃の時間ベースのフィルタリングを終了する時間の境界。日付が指定されていない場合、API はデフォルトで過去 8 日間のデータを返します。指定すると、過去 8 日間のみのフィルタリングが可能になります。8 日より前の日付または将来の日付は拒否されます。startedAt パラメータと使用する必要があります。

例： "2021-01-30T23:59:59Z"
sort（クエリパラメータ） 文字列

結果をソートするフィールド名。利用可能なフィールド：attackName、attackStatus、attackOutcome、firstSeenAt、lastSeenAt、attackTypes、applicationName、tierName、btName。フィールド名の大文字と小文字は区別されません。

例： "attackName"
order（クエリパラメータ） 文字列

指定したソートフィールドのソート順序方向。利用可能な値：ASC、DESC。

デフォルト値： DESC

例： "DESC"
filter（クエリパラメータ） 文字列

RFC 7644 で定義されている、結果フィルタリングの SCIM フィルタ式。サポートされる演算子：eq（等しい）、co（含む）。フィルタリング可能なフィールド：attackName、attackStatus、attackOutcome、attackTypes（配列）、applicationName、tierName、businessTransactionName、businessTransactionId（汎用一意識別子）。フィールド名の大文字と小文字は区別されません。

例： "attackStatus eq OPEN"
max（クエリパラメータ） 整数

ページネーションの 1 ページあたりの最大結果数。返される結果セットのサイズを制御します。有効な整数である必要があります。

デフォルト値： 10

例： 25
offset（クエリパラメータ） 整数

ページネーションでスキップする結果の数。結果の後続ページを取得するために使用されます。有効な整数である必要があります。

デフォルト値： 0

例： 0
applicationId（クエリパラメータ） 整数

出力を特定のアプリケーションに制限するグローバル アプリケーション フィルタ。以前の API 応答の appdApplicationId 値を使用して、アプリケーション コンテキストで攻撃をフィルタ処理します。

例： 12345
tierId（クエリパラメータ） 整数

出力を特定の階層に制限するグローバル階層フィルタ。以前の API 応答の appdTierId 値を使用して、階層コンテキストで攻撃をフィルタ処理します。

例： 67890

レスポンス

Code 200

詳細な攻撃の概要情報が正常に取得されました。

JSON 
{
  "appdApplicationId": 0,
  "appdBtId": 0,
  "appdTierId": 0,
  "applicationId": "string",
  "applicationName": "string",
  "attackName": "string",
  "attackNote": "string",
  "attackOutcome": "string",
  "attackSource": "string",
  "attackStatus": "string",
  "attackSummaryId": "string",
  "attackTypes": "string",
  "btName": "string",
  "btUuid": "string",
  "firstSeenAt": "string",
  "keyInfo": "string",
  "lastSeenAt": "string",
  "tierId": "string",
  "tierName": "string"
}
Code 400

不正なリクエスト：無効または不正な汎用一意識別子フォーマット：

JSON 
{
  "error": "string"
}
Code 500

内部サーバーエラー：

JSON 
{
  "error": "string"
}

攻撃の詳細情報の取得

汎用一意識別子によって識別された特定の攻撃に関する詳細情報が返されます。包括的な攻撃の概要と、攻撃の分類、タイムライン、関連するアプリケーション/階層のコンテキスト、ビジネストランザクションの詳細、セキュリティ アセスメント データなどのすべての関連コンテキスト情報を提供します。この端末を使用して、特定のセキュリティ攻撃インシデントに関する完全な情報を取得します。

JSON 
GET controller/argento/public-api/v1/attacks/{attackSummaryId}

パラメータ

Name タイプ 説明
attackSummaryId（経路パラメータ、必須） 文字列

特定の攻撃の詳細を取得するための攻撃の概要汎用一意識別子です。

例： "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
startedAt（クエリパラメータ） 文字列

タイムゾーンサポートを使用して、RFC3339 フォーマットで攻撃の時間ベースのフィルタリングを開始する時間の境界。日付が指定されていない場合、API はデフォルトで過去 8 日間のデータを返します。指定すると、過去 8 日間のみのフィルタリングが可能になります。8 日より前の日付または将来の日付は拒否されます。endedAt パラメータと使用する必要があります。

例： "2021-01-30T08:30:00Z"
endedAt（クエリパラメータ） 文字列

タイムゾーンサポートを使用して、RFC3339 フォーマットで攻撃の時間ベースのフィルタリングを終了する時間の境界。日付が指定されていない場合、API はデフォルトで過去 8 日間のデータを返します。指定すると、過去 8 日間のみのフィルタリングが可能になります。8 日より前の日付または将来の日付は拒否されます。startedAt パラメータと使用する必要があります。

例： "2021-01-30T23:59:59Z"
sort（クエリパラメータ） 文字列

結果をソートするフィールド名。利用可能なフィールド：attackName、attackStatus、attackOutcome、firstSeenAt、lastSeenAt、attackTypes、applicationName、tierName、btName。フィールド名の大文字と小文字は区別されません。

例： "attackName"
order（クエリパラメータ） 文字列

指定したソートフィールドのソート順序方向。利用可能な値：ASC、DESC。

デフォルト値： DESC

例： "DESC"
filter（クエリパラメータ） 文字列

RFC 7644 で定義されている、結果フィルタリングの SCIM フィルタ式。サポートされる演算子：eq（等しい）、co（含む）。フィルタリング可能なフィールド：attackName、attackStatus、attackOutcome、attackTypes（配列）、applicationName、tierName、businessTransactionName、businessTransactionId（汎用一意識別子）。フィールド名の大文字と小文字は区別されません。

例： "attackStatus eq OPEN"
max（クエリパラメータ） 整数

ページネーションの 1 ページあたりの最大結果数。返される結果セットのサイズを制御します。有効な整数である必要があります。

デフォルト値： 10

例： 25
offset（クエリパラメータ） 整数

ページネーションでスキップする結果の数。結果の後続ページを取得するために使用されます。有効な整数である必要があります。

デフォルト値： 0

例： 0
applicationId（クエリパラメータ） 整数

出力を特定のアプリケーションに制限するグローバル アプリケーション フィルタ。以前の API 応答の appdApplicationId 値を使用して、アプリケーション コンテキストで攻撃をフィルタ処理します。

例： 12345
tierId（クエリパラメータ） 整数

出力を特定の階層に制限するグローバル階層フィルタ。以前の API 応答の appdTierId 値を使用して、階層コンテキストで攻撃をフィルタ処理します。

例： 67890

レスポンス

Code 200

詳細な攻撃の概要情報が正常に取得されました。

JSON 
{
  "appdApplicationId": 0,
  "appdBtId": 0,
  "appdTierId": 0,
  "applicationId": "string",
  "applicationName": "string",
  "attackName": "string",
  "attackNote": "string",
  "attackOutcome": "string",
  "attackSource": "string",
  "attackStatus": "string",
  "attackSummaryId": "string",
  "attackTypes": "string",
  "btName": "string",
  "btUuid": "string",
  "firstSeenAt": "string",
  "keyInfo": "string",
  "lastSeenAt": "string",
  "tierId": "string",
  "tierName": "string"
}
Code 400

不正なリクエスト：無効または不正な汎用一意識別子フォーマット：

JSON 
{
  "error": "string"
}
Code 500

内部サーバーエラー：

JSON 
{
  "error": "string"
}

ビジネス トランザクション リストの取得

テナントにアクセス可能なすべてのビジネストランザクションの、ページネーションされたフィルタリング可能なリストを取得します。結果をフィルタリングするための SCIM ベースのフィルタリング、複数のフィールドによる回数変更可能ソート、時間ベースのクエリ、標準規格のページネーションをサポートします。結果には、トランザクション名、評価指標、関連するアプリケーション/階層、セキュリティステータス、脆弱性の数など、包括的なビジネストランザクション メタデータが含まれます。この端末を使用して、環境内のすべてのビジネストランザクションを参照および検索します。

JSON 
GET controller/argento/public-api/v1/businessTransactions

パラメータ

Name タイプ 説明
startedAt（クエリパラメータ） 文字列

タイムゾーンサポートを使用して、RFC3339 フォーマットでビジネストランザクションの時間ベースのフィルタリングを開始する時間の境界。このタイムスタンプ以降にアクティブであったトランザクションをフィルタ処理します。将来の日付は 'date is in the future' というエラーメッセージで拒否されます。

例： "2021-01-30T08:30:00Z"
endedAt（クエリパラメータ） 文字列

タイムゾーンサポートを使用して、RFC3339 フォーマットでビジネストランザクションの時間ベースのフィルタリングを終了する時間の境界。このタイムスタンプ以前にアクティブであったトランザクションをフィルタ処理します。将来の日付は「将来の日付です」というエラーメッセージで拒否されます。

例： "2021-01-30T23:59:59Z"
sort（クエリパラメータ） 文字列

結果をソートするフィールド名。サポートされているフィールドには、ビジネストランザクション メタデータ、評価指標、アプリケーション/階層情報、セキュリティステータスのフィールドが含まれます。ソートする正確なフィールド名を指定します。

例： "businessTransactionName"
order（クエリパラメータ） 文字列

指定したソートフィールドのソート順序方向。すべて大文字でなければなりません。利用可能な値：ASC、DESC。

デフォルト値： DESC

例： "DESC"
filter（クエリパラメータ） 文字列

結果フィルタリングの SCIM フィルタ式。サポートされる演算子：eq（等しい）、co（含む）。フィルタリング可能なフィールドには、ビジネストランザクション メタデータ、アプリケーション/階層情報、セキュリティステータスのフィールドが含まれます。フィールド名の大文字と小文字は区別されません。

例： "businessTransactionName eq "login""
max（クエリパラメータ） 整数

ページネーションの 1 ページあたりの最大結果数。返される結果セットのサイズを制御します。有効な整数である必要があります。

デフォルト値： 10

例： 25
offset（クエリパラメータ） 整数

ページネーションでスキップする結果の数。結果の後続ページを取得するために使用されます。有効な整数である必要があります。

デフォルト値： 0

例： 0
applicationId（クエリパラメータ） 整数

出力を特定のアプリケーションに制限するグローバル アプリケーション フィルタ。以前の API 応答の appdApplicationId 値を使用して、アプリケーション コンテキストでビジネストランザクションをフィルタ処理します。

例： 12345
tierId（クエリパラメータ） 整数

出力を特定の階層に制限するグローバル階層フィルタ。以前の API 応答の appdTierId 値を使用して、階層コンテキストでビジネストランザクションをフィルタ処理します。

例： 67890

レスポンス

Code 200

合計数と項目の配列を含むビジネストランザクションのページネーションされたリストが正常に取得されました。

JSON 
{
  "items": [
    {
      "appdApplicationId": 0,
      "appdBusinessTransactionId": 0,
      "applicationId": "string",
      "applicationName": "string",
      "attackOutcomeCountAttempted": 0,
      "attackOutcomeCountBlocked": 0,
      "attackOutcomeCountExploited": 0,
      "brmTitle": "string",
      "businessRiskScore": 0,
      "businessTransactionId": "string",
      "businessTransactionName": "string",
      "entryTierAppdId": 0,
      "entryTierId": "string",
      "entryTierName": "string",
      "riskScore": 0,
      "severityCountCritical": 0,
      "severityCountHigh": 0,
      "severityCountLow": 0,
      "severityCountMedium": 0,
      "tierCount": 0,
      "totalAttackCount": 0,
      "totalVulnCount": 0
    }
  ],
  "total": 0
}
Code 400

不正なリクエスト：無効なクエリパラメータ、無効な時間フォーマット、サポートされていない SCIM フィルタ式、または無効なソートフィールド：

JSON 
{
  "error": "string"
}
Code 500

内部サーバーエラー：

JSON 
{
  "error": "string"
}

ビジネストランザクションの詳細の取得

汎用一意識別子によって識別された特定のビジネストランザクションに関する詳細情報が返されます。トランザクションメタデータ、評価指標、関連するアプリケーション/階層、セキュリティステータス、脆弱性情報、実行パターンなど、包括的なビジネストランザクションの詳細を提供します。この端末を使用して、環境内の特定のビジネストランザクションに関する完全な情報を取得します。

JSON 
GET controller/argento/public-api/v1/businessTransactions/{businessTransactionId}

パラメータ

Name タイプ 説明
businessTransactionId（経路パラメータ、必須） 文字列

特定のトランザクションの詳細を取得するための汎用一意識別子フォーマットのビジネストランザクション識別子。有効な汎用一意識別子である必要があります。

例： "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

レスポンス

Code 200

詳細なビジネストランザクション情報が正常に取得されました。

JSON 
{
  "appdApplicationId": 0,
  "appdBusinessTransactionId": 0,
  "applicationId": "string",
  "applicationName": "string",
  "brmTitle": "string",
  "businessRiskScore": 0,
  "businessTransactionName": "string",
  "entryTierAppdId": 0,
  "entryTierId": "string",
  "entryTierName": "string",
  "riskScore": 0,
  "riskScoreCard": "string"
}
Code 400

不正なリクエスト：無効または不正な汎用一意識別子フォーマット：

JSON 
{
  "error": "string"
}
Code 500

内部サーバーエラー：

JSON 
{
  "error": "string"
}

ライブラリリストの取得

テナントにアクセス可能なすべてのライブラリの、ページネーションされたフィルタリング可能なリストを取得します。結果をフィルタリングするための SCIM ベースのフィルタリング、複数のフィールドによる回数変更可能ソート、時間ベースのクエリ、標準規格のページネーションをサポートします。結果には、パッケージ情報、バージョンの詳細、関連するアプリケーション/階層、脆弱性の数、セキュリティステータスなど、包括的なライブラリメタデータが含まれます。この端末を使用して、環境内で検出されたすべてのサードパーティライブラリを参照および検索します。

JSON 
GET controller/argento/public-api/v1/libraries

パラメータ

Name タイプ 説明
startedAt（クエリパラメータ） 文字列

タイムゾーンサポートを使用して、RFC3339 フォーマットでライブラリの時間ベースのフィルタリングを開始する時間の境界。日付が指定されていない場合、API はデフォルトで過去 8 日間のデータを返します。指定すると、過去 8 日間のみのフィルタリングが可能になります。8 日より前の日付または将来の日付は拒否されます。

例： "2021-01-30T08:30:00Z"
endedAt（クエリパラメータ） 文字列

タイムゾーンサポートを使用して、RFC3339 フォーマットでライブラリの時間ベースのフィルタリングを終了する時間の境界。日付が指定されていない場合、API はデフォルトで過去 8 日間のデータを返します。指定すると、過去 8 日間のみのフィルタリングが可能になります。8 日より前の日付または将来の日付は拒否されます。

例： "2021-01-30T23:59:59Z"
sort（クエリパラメータ） 文字列

結果をソートするフィールド名。利用可能なフィールド：libraryId、packageId、packageLanguage、packageName、packageVersion、packageCanonicalName、appdTierId、tierName、tierId、appdApplicationId、applicationName、applicationId、riskScore、severity、severityCountCritical、severityCountHigh、severityCountMedium、severityCountLow、totalVulnCount、status、affectedNodeCount、filePath。フィールド名の大文字と小文字は区別されません。

例： "packageName"
order（クエリパラメータ） 文字列

指定したソートフィールドのソート順序方向。すべて大文字でなければなりません。利用可能な値：ASC、DESC。

デフォルト値： DESC

例： "DESC"
filter（クエリパラメータ） 文字列

RFC 7644 で定義されている、結果フィルタリングの SCIM フィルタ式。サポートされる演算子：eq（等しい）、co（含む）。フィルタリング可能なフィールドには、ライブラリメタデータ、アプリケーション/階層情報、セキュリティステータスのフィールドが含まれます。フィールド名の大文字と小文字は区別されません。

例： "applicationName eq webapp"
max（クエリパラメータ） 整数

ページネーションの 1 ページあたりの最大結果数。返される結果セットのサイズを制御します。有効な整数である必要があります。

デフォルト値： 10

例： 25
offset（クエリパラメータ） 整数

ページネーションでスキップする結果の数。結果の後続ページを取得するために使用されます。有効な整数である必要があります。

デフォルト値： 0

例： 0
applicationId（クエリパラメータ） 整数

出力を特定のアプリケーションに制限するグローバル アプリケーション フィルタ。以前の API 応答の appdApplicationId 値を使用して、アプリケーション コンテキストでライブラリをフィルタ処理します。

例： 12345
tierId（クエリパラメータ） 整数

出力を特定の階層に制限するグローバル階層フィルタ。以前の API 応答の appdTierId 値を使用して、階層コンテキストでライブラリをフィルタ処理します。

例： 67890

レスポンス

Code 200

合計数と項目の配列を含むライブラリのページネーションされたリストが正常に取得されました。

JSON 
{
  "items": [
    {
      "active_internet_breach": true,
      "affectedNodeCount": 0,
      "appdApplicationId": 0,
      "appdTierId": 0,
      "applicationId": "string",
      "applicationName": "string",
      "easily_exploitable": true,
      "filePath": "string",
      "kennaRiskScore": 0,
      "libraryId": "string",
      "malware_exploitable": true,
      "packageCanonicalName": "string",
      "packageId": "string",
      "packageLanguage": "string",
      "packageName": "string",
      "packageVersion": "string",
      "popular_target": true,
      "predicted_exploitable": true,
      "recommendedVersion": "string",
      "remote_code_execution": true,
      "riskScore": 0,
      "severity": "string",
      "severityCountCritical": 0,
      "severityCountHigh": 0,
      "severityCountLow": 0,
      "severityCountMedium": 0,
      "status": "string",
      "tierId": "string",
      "tierName": "string",
      "totalVulnCount": 0
    }
  ],
  "total": 0
}
Code 400

不正なリクエスト：無効なクエリパラメータ、無効な時間フォーマット、サポートされていない SCIM フィルタ式、または無効なソートフィールド：

JSON 
{
  "error": "string"
}
Code 500

内部サーバーエラー：

JSON 
{
  "error": "string"
}

ライブラリの詳細の取得

汎用一意識別子によって識別された特定のライブラリに関する詳細情報が返されます。パッケージ情報、バージョンの詳細、ライセンス情報、セキュリティステータス、脆弱性の数、関連するアプリケーション/階層など、包括的なライブラリの詳細を提供します。この端末を使用して、環境内の特定のサードパーティライブラリに関する完全な情報を取得します。

JSON 
GET controller/argento/public-api/v1/libraries/{libraryId}

パラメータ

Name タイプ 説明
libraryId（経路パラメータ、必須） 文字列

特定のライブラリの詳細を取得するための汎用一意識別子フォーマットのライブラリ識別子。有効な汎用一意識別子である必要があります。

例： "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
applicationId（クエリパラメータ） 整数

出力を特定のアプリケーションに制限するグローバル アプリケーション フィルタ。以前の API 応答の appdApplicationId 値を使用して、アプリケーション コンテキストでライブラリの詳細をフィルタ処理します。

例： 12345
tierId（クエリパラメータ） 整数

出力を特定の階層に制限するグローバル階層フィルタ。以前の API 応答の appdTierId 値を使用して、階層コンテキストでライブラリの詳細をフィルタ処理します。

例： 67890

レスポンス

Code 200

詳細なライブラリ情報が正常に取得されました。

JSON 
{
  "affectedNodeCount": 0,
  "appdApplicationId": 0,
  "appdTierId": 0,
  "applicationId": "string",
  "applicationName": "string",
  "filePath": "string",
  "highestCvssScoreCveId": "string",
  "highestCvssScoreCveName": "string",
  "highestCvssScoreCveTitle": "string",
  "highestKennaRiskScoreCveId": "string",
  "highestKennaRiskScoreCveName": "string",
  "highestKennaRiskScoreCveTitle": "string",
  "kennaRiskScore": 0,
  "libraryId": "string",
  "packageCanonicalName": "string",
  "packageId": "string",
  "packageLanguage": "string",
  "packageName": "string",
  "packageVersion": "string",
  "recommendedVersion": "string",
  "riskScore": 0,
  "severity": "string",
  "status": "string",
  "tierId": "string",
  "tierName": "string"
}
Code 400

不正なリクエスト：無効または不正な汎用一意識別子フォーマット：

JSON 
{
  "error": "string"
}
Code 500

内部サーバーエラー：

JSON 
{
  "error": "string"
}

ポリシー設定を取得する

テナントにアクセス可能なすべての動作ポリシー設定の、ページネーションされたフィルタリング可能なリストを返します。結果をフィルタリングするための SCIM ベースのフィルタリング、複数のフィールドによる回数変更可能ソート、標準規格のページネーションをサポートします。結果には、関連するアプリケーション/階層情報、ポリシータイプの詳細、設定ステータスなど、包括的なポリシーメタデータが含まれます。

CODE 
GET controller/argento/public-api/v1/policyConfigs

パラメータ

Name タイプ 説明
filter（クエリパラメータ） 文字列

RFC 7644 で定義されている、結果フィルタリングの SCIM フィルタ式。サポートされる演算子：eq（等しい）、co（含む）。フィルタリング可能なフィールド：policyTypeDescription、applicationName、tierName。フィールド名の大文字と小文字は区別されません。例：applicationName eq MyApp、tierName co web、policyTypeDescription eq Runtime Security。
sort（クエリパラメータ） 文字列

結果をソートするフィールド名。サポート対象フィールド：action、status、policyTypeDescription、applicationName、tierName。フィールド名の大文字と小文字は区別されません。

例： applicationName
order（クエリパラメータ） 文字列

ソート順序方向。

利用可能な値：ASC、DESC

デフォルト値： DESC

例： "DESC"
max（クエリパラメータ） 整数

1 ページあたりの最大結果数。有効な整数である必要があります。

デフォルトでは60000。 10

例： 50
offset（クエリパラメータ） 整数

ページネーションでスキップする結果の数。有効な整数である必要があります。

デフォルトでは60000。 0

例： 0

レスポンス

Code 200

ポリシー設定のページネーションされたリストが正常に取得されました。

JSON 
{
  "items": [
    {
      "action": "string",
      "applicationId": "string",
      "applicationName": "string",
      "configDetails": "string",
      "configTypeId": 0,
      "configTypeName": "string",
      "id": "string",
      "policyTypeDescription": "string",
      "policyTypeId": 0,
      "policyTypeLongDescription": "string",
      "policyTypeName": "string",
      "status": "string",
      "tierId": "string",
      "tierName": "string",
      "version": "string"
    }
  ],
  "total": 0
}
Code 400

不正なリクエスト：無効なクエリパラメータ、サポートされていない SCIM フィルタ式、または無効なソートフィールド：

JSON 
{
  "error": "string"
}
Code 500

内部サーバエラー:

JSON 
{
  "error": "string"
}

ポリシー設定の詳細を取得する

関連するすべてのメタデータ、ポリシータイプ情報、アプリケーション/階層コンテキスト、および完全な設定ルールを含む、特定の動作ポリシー設定の完全な詳細を取得します。この端末は、詳細な検査と設定管理に適した、単一のポリシー設定の最も包括的なビューを提供します。

CODE 
GET controller/argento/public-api/v1/policyConfigs/{policyConfigId}

パラメータ

Name タイプ 説明
policyConfigId（経路パラメータ） 文字列

必須。動作ポリシー設定汎用一意識別子。

例： "e43fa8f3-9a1d-452b-97f5-63d97bda624f"

レスポンス

Code 200

包括的なポリシー設定の詳細が正常に取得されました。

JSON 
{
  "action": "string",
  "applicationId": "string",
  "applicationName": "string",
  "configDetails": "string",
  "configTypeId": 0,
  "configTypeName": "string",
  "id": "string",
  "policyTypeDescription": "string",
  "policyTypeId": 0,
  "policyTypeLongDescription": "string",
  "policyTypeName": "string",
  "status": "string",
  "tierId": "string",
  "tierName": "string",
  "version": "string"
}
Code 400

不正なリクエスト：無効な汎用一意識別子フォーマットまたは不正な形式のポリシー識別子パラメータ：

JSON 
{
"error": "string"
}
Code 500

内部サーバエラー:

JSON 
{
"error": "string"
}

新しいポリシー設定の作成

特定のテナント用の新しい動作ポリシー設定を作成します。この端末では、グローバル、アプリケーション、または階層レベルで適用できるセキュリティポリシーを定義できます。ポリシー設定には、実行するアクション（検出、ブロック、NONE、パッチ）、ステータス（ON/OFF）、および JSON フォーマットの詳細な設定ルールが含まれます。

CODE 
POST controller/argento/public-api/v1/policyConfigs

パラメータ

Name タイプ 説明
policy（本文パラメータ） object

必須。ポリシー設定ペイロード。

policy オブジェクト（コンテンツタイプ：アプリケーション/JSON）には、「オプション」と記載がない限り、次のフィールドが含まれている必要があります。

  • action（文字列）：ポリシーによって実行されるアクション。有効な値：DETECT、BLOCK、NONE、PATCH。

  • applicationId（文字列）：オプション。ポリシーが作成されるアプリケーションの汎用一意識別子。

    例： "d48fc5dc-1ad0-41f9-adfe-8b87f4a93e4e"

  • configDetails（文字列）：ポリシーの詳細な設定を表す JSON BLOB。これには、ポリシー規則とパラメータが含まれます。

    例： "{"permission":{"filter":[{"action":"DETECT","targetMatch":{"matchType":"EQUALS","value":"bbbb.exe"},"name":"detect bbbb.exe"}]}}"

  • policyTypeId（整数）：使用されるポリシータイプの識別子。ポリシータイプの識別子：

    • コマンドの実行：1
    • ファイルシステムアクセス：2
    • ネットワークまたはソケットアクセス：3
    • データベースクエリ：4
    • ランタイム時にロードされるライブラリ：5
    • 未処理の例外：6
    • HTTP トランザクションのヘッダー：7
    • 発信 HTTP レスポンスの Cookie：8
    • ランタイム時のクラスの逆シリアル化：9
    • Web トランザクション：10

  • status（文字列）：ポリシーのステータス。有効な値：ON、OFF。

  • tierId（文字列）：オプション。ポリシーが作成される階層の汎用一意識別子。

    例： "e43fa8f3-9a1d-452b-97f5-63d97bda624f"

例：

JSON 
{
  "action": "DETECT",
  "applicationId": "string",
  "configDetails": "string",
  "policyTypeId": 0,
  "status": "ON",
  "tierId": "string"
}

レスポンス

コード 201

生成された汎用一意識別子とメタデータを使用してポリシー設定が正常に作成されました。

JSON 
{
  "action": "string",
  "application_id": "string",
  "config_details": "string",
  "config_type_id": 0,
  "config_type_value": "string",
  "created_at": "string",
  "id": "string",
  "modified_by": "string",
  "notify": true,
  "operative_policy_type_id": 0,
  "overridable": true,
  "status": "string",
  "tenant_id": "string",
  "tier_id": "string",
  "updated_at": "string",
  "version": 0
}
Code 400

不正なリクエスト：configDetails の無効な入力データ、検証エラー、または不正な形式の JSON：

JSON 
{
  "error": "string"
}
Code 500

内部サーバエラー:

JSON 
{
  "error": "string"
}

ポリシー設定の削除

汎用一意識別子によって既存の動作ポリシー設定を完全に削除します。この操作は元に戻せません。この設定に関連付けられているアクティブなポリシーの適用がただちに停止します。アクティブなセキュリティ監視や保護に影響を与える可能性があるため、注意して使用してください。

CODE 
DELETE controller/argento/public-api/v1/policyConfigs/{policyConfigId}

パラメータ

Name タイプ 説明
policyConfigId（経路パラメータ） 文字列

必須。削除する動作ポリシー設定汎用一意識別子。

例： "e43fa8f3-9a1d-452b-97f5-63d97bda624f"

レスポンス

コード 204

コンテンツなし：ポリシー設定が正常に削除されました。

Code 400
不正なリクエスト：無効な汎用一意識別子フォーマットまたは不正な形式のポリシー識別子パラメータ：
JSON 
{
  "error": "string"
}
Code 500

内部サーバエラー:

JSON 
{
  "error": "string"
}

脆弱性リストの取得

テナントにアクセス可能なすべての脆弱性の、ページネーションされたフィルタリング可能なリストを取得します。結果をフィルタリングするための SCIM ベースのフィルタリング、複数のフィールドによる回数変更可能ソート、時間ベースのクエリ、標準規格のページネーションをサポートします。結果には、共通脆弱性識別子情報、シビラティ（重大度）アセスメント、影響を受けるアプリケーション/階層、パッケージの詳細、リスクスコアリングデータなど、包括的な脆弱性メタデータが含まれます。この端末を使用して、環境内で検出されたすべてのセキュリティ脆弱性を参照および検索します。

JSON 
GET controller/argento/public-api/v1/vulnerabilities

パラメータ

Name タイプ 説明
sort（クエリパラメータ） 文字列

結果をソートするフィールド名。利用可能なフィールド：severity、status、riskScore、kennaScore、firstSeenAt、lastSeenAt、cveName、cveTitle、applicationName、tierName、packageCanonicalName、packageLanguage、affectedNodeCount、hasAttacks、hasEvent、cvePublishDate。フィールド名の大文字と小文字は区別されません。

例： "severity"
order（クエリパラメータ） 文字列

指定したソートフィールドのソート順序方向。すべて大文字でなければなりません。利用可能な値：ASC、DESC。

デフォルト値： DESC

例： "DESC"
filter（クエリパラメータ） 文字列

RFC 7644 で定義されている、結果フィルタリングの SCIM フィルタ式。サポートされる演算子：eq（等しい）、co（含む）、gt（より大きい）、lt（より小さい）、ge（以上）、le（以下）。フィルタリング可能なフィールド：severity、hasEvent、cveTitle、cveName、applicationName、tierName、packageLanguage、status、packageCanonicalName、kennascore、riskScore、environment、servicename。フィールド名の大文字と小文字は区別されません。

例： "severity eq CRITICAL"
max（クエリパラメータ） 整数

ページネーションの 1 ページあたりの最大結果数。返される結果セットのサイズを制御します。有効な整数である必要があります。

デフォルト値： 10

例： 25
offset（クエリパラメータ） 整数

ページネーションでスキップする結果の数。結果の後続ページを取得するために使用されます。有効な整数である必要があります。

デフォルト値： 0

例： 0
applicationId（クエリパラメータ） 整数

出力を特定のアプリケーションに制限するグローバル アプリケーション フィルタ。以前の API 応答の appdApplicationId 値を使用して、アプリケーション コンテキストで脆弱性をフィルタ処理します。

例： 12345
tierId（クエリパラメータ） 整数

出力を特定の階層に制限するグローバル階層フィルタ。以前の API 応答の appdTierId 値を使用して、階層コンテキストで脆弱性をフィルタ処理します。

例： 67890

レスポンス

Code 200

合計数と項目の配列を含む脆弱性のページネーションされたリストが正常に取得されました。

JSON 
{
  "items": [
    {
      "active_internet_breach": true,
      "affectedNodeCount": 0,
      "appdApplicationId": 0,
      "appdTierId": 0,
      "applicationId": "string",
      "applicationName": "string",
      "attackSummaryId": "string",
      "cveId": "string",
      "cveName": "string",
      "cvePublishDate": "string",
      "cveTitle": "string",
      "cweName": "string",
      "easily_exploitable": true,
      "firstSeenAt": "string",
      "hasAttacks": true,
      "hasEvent": true,
      "hasObservations": true,
      "incidentId": "string",
      "kennaScore": 0,
      "lastSeenAt": "string",
      "libraryId": "string",
      "malware_exploitable": true,
      "packageCanonicalName": "string",
      "packageId": "string",
      "packageLanguage": "string",
      "popular_target": true,
      "predicted_exploitable": true,
      "remediation": "string",
      "remote_code_execution": true,
      "riskScore": 0,
      "severity": "string",
      "status": "Unknown",
      "tierId": "string",
      "tierName": "string"
    }
  ],
  "total": 0
}
Code 400

不正なリクエスト：無効なクエリパラメータ、無効な時間フォーマット、サポートされていない SCIM フィルタ式、または無効なソートフィールド：

JSON 
{
  "error": "string"
}
Code 500

内部サーバーエラー：

JSON 
{
  "error": "string"
}

脆弱性の詳細の取得

共通脆弱性識別子（汎用一意識別子）によって識別された特定の脆弱性に関する詳細情報が返されます。共通脆弱性識別子分類、シビラティ（重大度）アセスメント、影響を受けるアプリケーション/階層、パッケージ情報、リスクスコアリング、修復ガイダンスなど、包括的な脆弱性の詳細を提供します。この端末を使用して、特定のセキュリティ脆弱性インシデントに関する完全な情報を取得します。

JSON 
GET controller/argento/public-api/v1/vulnerabilities/{cveId}

パラメータ

Name タイプ 説明
cveId（経路パラメータ、必須） 文字列

特定の脆弱性の詳細を取得するための汎用一意識別子フォーマットの共通脆弱性識別子。有効な汎用一意識別子である必要があります。

例： "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

レスポンス

Code 200

詳細な脆弱性情報が正常に取得されました。

JSON 
{
  "createdAt": "string",
  "cveId": "string",
  "cveTitle": "string",
  "cvss3BaseScore": 0,
  "cvss3VectorString": "string",
  "cweName": "string",
  "description": "string",
  "kenna": {
    "active_internet_breach": true,
    "easily_exploitable": true,
    "malware_exploitable": true,
    "popular_target": true,
    "predicted_exploitable": true,
    "remote_code_execution": true,
    "risk_score_meter": 0
  },
  "name": "string",
  "nvdUrl": "string",
  "publishDate": "string",
  "remediation": "string",
  "severity": "string",
  "updatedAt": "string"
}
Code 400

不正なリクエスト：無効または不正な汎用一意識別子フォーマット：

JSON 
{
  "error": "string"
}
コード 404

リソースが見つかりません：指定された共通脆弱性識別子の脆弱性が見つかりません。

JSON 
{
  "error": "string"
}
Code 500

内部サーバーエラー：

JSON 
{
  "error": "string"
}

階層ノードの取得

オプションの SCIM フィルタリングおよびソート機能を使用して、特定の階層のノードのページネーションされたリストを取得します。セキュリティステータス、エージェント数、およびメタデータを含むノードの詳細を返します。

JSON 
GET controller/argento/public-api/v1/tiers/{tierId}/nodes

パラメータ

Name タイプ 説明
tierId（経路パラメータ、必須） 文字列

ノードを取得する階層識別子（汎用一意識別子フォーマット）。有効な汎用一意識別子である必要があります。
date（クエリパラメータ） 文字列

一時的フィルタリングの RFC3339 フォーマットの日付と時刻。UTC とローカルの両方のタイムゾーンオフセットをサポートしています。将来の日付は「将来の日付です」というエラーで拒否されます。

例： "2021-01-30T08:30:00-08:00"
max（クエリパラメータ） 整数

1 ページあたりの返される最大アイテム数。有効な整数である必要があります。

デフォルト値： 10
offset（クエリパラメータ） 整数

ページネーションでスキップするアイテム数。有効な整数である必要があります。

デフォルト値： 0
sort（クエリパラメータ） 文字列

結果をソートするフィールド名。利用可能なフィールド：nodejvmid、nodesecurityenabled、nodesecurityenabledcomputed、countapmactive、countsupportedagent、countsecured、countsecurityenabled、countready、appdnodeagenttype、appdnodeagentversion、lastactivity、lastdependencyreported。フィールド名の大文字と小文字は区別されません。

例： "nodejvmid"
order（クエリパラメータ） 文字列

結果のソート順序。昇順の場合は「ASC」、降順の場合は「DESC」である必要があります。

デフォルト値： "DESC"
filter（クエリパラメータ） 文字列

結果フィルタリングの SCIM フィルタ式。サポートされる演算子：eq（等しい）、co（含む）。フィルタリング可能なフィールド：nodejvmid、nodesecurityenabled、nodesecurityenabledcomputed、countapmactive、countsupportedagent、countsecured、countsecurityenabled、countready、appdnodeagenttype。フィールド名の大文字と小文字は区別されません。

例： "nodejvmid eq "java-node-1""

レスポンス

Code 200

ノードリストが正常に取得されました。

JSON 
{
  "items": [
    {
      "appdApplicationId": 0,
      "appdNodeId": 0,
      "appdTierId": 0,
      "applicationId": "string",
      "countApmActive": 0,
      "countReady": 0,
      "countSecured": 0,
      "countSecurityEnabled": 0,
      "countSupportedAgent": 0,
      "id": "string",
      "nodeAppdNodeAgentType": "string",
      "nodeAppdNodeAgentVersion": "string",
      "nodeCreatedAt": "string",
      "nodeJvmId": "string",
      "nodeLastCheckinAt": "string",
      "nodeLastDependencyReportAt": "string",
      "nodeSecurityEnabled": true,
      "nodeSecurityEnabledComputed": true,
      "tierId": "string"
    }
  ],
  "total": 0
}
Code 400

不正なリクエスト：無効なクエリパラメータ、不正な形式の SCIM フィルタ式、または検証エラー：

JSON 
{
  "error": "string"
}
Code 500

内部サーバーエラー：

JSON 
{
  "error": "string"
}

ビジネスリスクのスコアの取得

指定されたクエリパラメータに基づいたアプリケーションとビジネストランザクションによってビジネスリスクスコアを取得します。

JSON 
GET controller/argento/public-api/v1/stats/businessRisk

パラメータ

Name タイプ 説明
btId（クエリパラメータ） 文字列

汎用一意識別子フォーマットのビジネストランザクション識別子

例： "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
applicationId（クエリパラメータ） 整数

応答の appdApplicationId 値を使用して出力を 1 つのアプリケーションのみに制限するグローバル アプリケーション フィルタ。

例： 12345
tierId（クエリパラメータ） 整数

出力を 1 つの階層のみに制限するグローバル階層フィルタ。応答の appdTierId 値を使用します。

例： 0

レスポンス

Code 200

ビジネスリスクスコアが正常に取得された場合：

JSON 
{
  "brmTitle": "string",
  "businessRiskScore": 0
}
Code 400

不正なリクエスト：

JSON 
{
  "error": "string"
}
Code 500

内部サーバーエラー：

JSON 
{
  "error": "string"
}

アプリケーションのSecurityステータスの更新

提供されたリソース識別子に基づいて、特定のアプリケーションの securityEnabled ステータスを更新します。

CODE 
PATCH controller/argento/public-api/v1/applications/{resourceId}

パラメータ

Name タイプ 説明
resourceId string アプリケーションのリソース ID（UUID 形式）。必須です。
body object securityEnabled ステータスを含む JSON 本文。必須です。

例：

JSON 
{
  "securityEnabled": true
}

レスポンス

コード 204

更新に成功しましたが、コンテンツはありません。

Code 400

無効な要求（パラメータの欠落または無効なパラメータなど）：

JSON 
{
  "error": "string"
}
コード 404

リソースが見つかりません

JSON 
{
  "error": "string"
}
Code 500

内部サーバエラー:

JSON 
{
  "error": "string"
}

階層の Security ステータスの更新

特定のアプリケーション、階層、またはノードリソースのセキュリティ有効化ステータスを更新します。この端末は、使用されるルート経路に基づいて、さまざまなリソースタイプの securityEnabled フラグの更新をサポートします。

JSON 
PATCH controller/argento/public-api/v1/tiers/{resourceId}

パラメータ

Name タイプ 説明
resourceId（経路パラメータ、必須） 文字列

更新するアプリケーション、階層、またはノードのリソース識別子（汎用一意識別子フォーマット）。有効な汎用一意識別子である必要があります。
リクエスト本文（必須） object

セキュリティ有効化ステータスを含む JSON 本文。securityEnabled フィールドには boolean（true/false）または null を使用できます。

例：

JSON 
{
  "securityEnabled": true
}

レスポンス

コード 204

リソースセキュリティ設定は正常に更新されました。

Code 400

不正なリクエスト：無効なリソース識別子フォーマット、リクエスト本文の欠落、または検証エラー：

JSON 
{
  "error": "string"
}
Code 500

内部サーバーエラー：

JSON 
{
  "error": "string"
}

ノードの Security ステータスの更新

特定のアプリケーション、階層、またはノードリソースのセキュリティ有効化ステータスを更新します。この端末は、使用されるルート経路に基づいて、さまざまなリソースタイプの securityEnabled フラグの更新をサポートします。

JSON 
PATCH controller/argento/public-api/v1/nodes/{resourceId}

パラメータ

Name タイプ 説明
resourceId（経路パラメータ、必須） 文字列

更新するアプリケーション、階層、またはノードのリソース識別子（汎用一意識別子フォーマット）。有効な汎用一意識別子である必要があります。
リクエスト本文（必須） object

セキュリティ有効化ステータスを含む JSON 本文。securityEnabled フィールドには boolean（true/false）または null を使用できます。

例：

JSON 
{
  "securityEnabled": true
}

レスポンス

コード 204

リソースセキュリティ設定は正常に更新されました。

Code 400

不正なリクエスト：無効なリソース識別子フォーマット、リクエスト本文の欠落、または検証エラー：

JSON 
{
  "error": "string"
}
Code 500

内部サーバーエラー：

JSON 
{
  "error": "string"
}

ポリシー構成の更新

既存の動作ポリシー設定で部分的な更新を実行します。この端末は、アクション（DETECT、BLOCK、NONE、PATCH）、ステータス（ON、OFF）、および詳細な構成ルールの更新をサポートしています。RESTful PATCH セマンティクスに従って、リクエスト本文で提供されるフィールドのみが更新されます。ポリシー設定が存在し、テナントによりアクセス可能である必要があります。

CODE 
PATCH controller/argento/public-api/v1/policyConfigs/{policyConfigId}

パラメータ

Name タイプ 説明
policyConfigId（経路パラメータ） 文字列

必須。動作ポリシー設定汎用一意識別子。

例： "e43fa8f3-9a1d-452b-97f5-63d97bda624f"
updateData（本文パラメータ） object

更新するフィールド。指定したフィールドだけが変更されます。

updateData オブジェクト（コンテンツタイプ：アプリケーション/JSON）の説明：

  • action（文字列）：ポリシーによって実行されるアクション。有効な値：DETECT、BLOCK、NONE、PATCH。

  • configDetails（文字列）：ポリシーの詳細な設定を表す JSON BLOB。これには、ポリシー規則とパラメータが含まれます。

    例： "{"permission":{"filter":[{"action":"DETECT","targetMatch":{"matchType":"EQUALS","value":"bbbb.exe"},"name":"detect bbbb.exe"}]}}"

  • status（文字列）：ポリシーのステータス。有効な値：ON、OFF。

例：

JSON 
{
  "action": "DETECT",
  "configDetails": "string",
  "status": "ON"
}

レスポンス

Code 200

変更されたフィールドを含むポリシー設定が正常に更新されました。

JSON 
{
  "action": "string",
  "application_id": "string",
  "config_details": "string",
  "config_type_id": 0,
  "config_type_value": "string",
  "created_at": "string",
  "id": "string",
  "modified_by": "string",
  "notify": true,
  "operative_policy_type_id": 0,
  "overridable": true,
  "status": "string",
  "tenant_id": "string",
  "tier_id": "string",
  "updated_at": "string",
  "version": 0
}
Code 400

不正なリクエスト：無効な汎用一意識別子フォーマット、検証エラー、不正なフォーマットの updateData JSON、または更新用のデータが指定されていません。

JSON 
{
"error": "string"
}
Code 500

内部サーバエラー:

JSON 
{
"error": "string"
}