エンティティリストAPI

概要

Entity List API は、この GET /api/entity_list エンドポイントを通じてエンティティデータを取得・管理できる RESTful エンドポイントです。 このAPIは、エンティティ情報への包括的なアクセスを提供し、ページネーション、フィルタリング、およびソート機能を標準でサポートしています。

主な機能

Entity List API には、以下の機能があります：

• 効率的なデータ処理のために、エンティティをページ分割形式で取得する
• リスクスコアの閾値、直近のリスク、およびユーザー名でエンティティをフィルタリングする
• 結果をリスクスコアまたは異常スコアで並べ替える

照会パラメーター

このAPIでは、データの取得やフィルタリングを制御するために、いくつかのクエリパラメータを受け付けます：

ルールのフィルタリング

フィルタパラメータを使用する場合、以下のルールが適用されます：

• risk_score_min と risk_score_max は相互に排他的であり、同じリクエスト内で併用することはできません。
• 複数のフィルタパラメータを組み合わせて、検索結果をさらに絞り込むことができます。

並べ替えオプション

このAPIでは、2つのソート方法をサポートしています：

ページ編集

大規模な結果セットを閲覧するには、以下のパラメータを使用してください：

• limit – 1回のリクエストで返されるレコード数
• オフセット – 結果セットの開始位置

応答構造

このAPIは、以下の情報を返します：

• エンティティーの詳細
• リスク関連指標
• 一致したエンティティの総数
• ページネーション情報（ 制限数とオフセット ）

異常スコアで並べ替えた場合、レスポンスには追加の集計リスク指標が含まれます。

応答の例

以下の例は、典型的なAPIの応答を示しています：

{
  "risk_threshold": 50.0,
  "entities": [
    {
      "entity_id": 12345,
      "username": "john.doe",
      "risk_score": 78.5,
      "latest_risk": 82.0,
      "total_sum_risk": 156.3
    },
    {
      "entity_id": 12346,
      "username": "jane.smith",
      "risk_score": 65.2,
      "latest_risk": 68.7,
      "total_sum_risk": 121.8
    }
  ],
  "total_count": 250,
  "limit": 50,
  "offset": 0
}

入力項目には以下のものが含まれます：

• risk_threshold は、 クエリに適用される実効リスク閾値を示します。
• entities には、一致したエンティティのリストが含まれています。
• sortBy=anomalyScoretotal_sum_risk は、以下の場合にのみ含まれます。
• total_count は、 指定されたフィルタに一致するエンティティの総数を表します。
• limit と offset は、 現在の結果セットのページネーション情報を指定します。

エラー処理

このAPIは、標準の HTTP ステータスコードを返します：

• 200 OK– リクエストが正常に処理されました
• 400 Bad Request– 無効なリクエストパラメータ
• 500 Internal Server Error– 予期せぬサーバーエラー