監査エンティティ (テクニカルプレビュー)

サイトおよびスペースの管理者は、auditsリソースを使用してエンティティに加えられた変更を表示できます。このリソースを使用すると、セキュリティやGDPRコンプライアンスなどの規制活動の表示など、企業の準備状況を監視できます。

概要

auditsリソースを使用して、GDPRコンプライアンスとセキュリティ規制に関連するアクティビティを表示します。このリソースは、ALM Octaneユーザーインターフェイスの [履歴] タブで利用できるよりも多くの監査情報を取得します。

監査リソースはエンティティベースではないため、複数のエンティティ間で監査できます。

サイトおよびスペースの管理者は、次のことを前提として、サイト、スペース、およびワークスペースのレベルでエンティティを監査できます。

  • 管理者には、コンテキストに適したロールと権限があります。

  • 関連するエンティティの監査がサポートされています。監査できるエンティティを決定するには、エンティティメタデータリファレンスの非監査可能フィーチャーを参照してください。

このリソースは、データアクセスが制限されている場合でも、すべてのサイトおよびスペース管理者が利用できます。

ALM Octaneは、次の操作の監査をサポートしています。作成、更新、および削除。

注: 技術的なプレビューとして、このリソースは変更される可能性があります。

トップに戻る

URI

コンテキストに応じて、監査のURIは次のとおりです。 

環境

URI

サイト

http[s]://<server>:<port>/api/audits/*

または 

http[s]://<server>:<port>/api/audits/*

このコンテキストで監査できるエンティティの例には、スペース、サイトユーザー、構成パラメーター、およびサーバーが含まれます。

スペース

http[s]://<server>:<port>/api/shared_spaces/<space_id>/audits/*

このコンテキストで監査できるエンティティの例には、ワークスペース、ユーザー、APIアクセスが含まれます。
共有エリア

 

http[s]://<server>:<port>/api/shared_spaces/<space_id>/shared_area/audits/*

このコンテキストで監査できるエンティティの例には、リリースが含まれます。

ワークスペース

http[s]://<server>:<port>/api/shared_spaces/<space_id>/workspaces/<workspace_id>/audits/*

このコンテキストで監査できるエンティティの例には、チーム、作業項目、およびテストが含まれます。

トップに戻る

監査リクエストへのクエリの追加

監査によって返される情報の量をフィルタリングするクエリを追加します。次の句を使用できます。

  • 返されたデータがどのようにページングされるか。ページデータ (limit、offset、total_count)を参照してください。

  • fields句を使用して、必要なフィールドのみを取得します。フィールドの選択を参照してください

  • クエリ句を使用して返されるインスタンスをフィルタリングします。クエリを参照してください。

注意: クエリが指定されていない場合、すべてのエンティティのすべての操作が返されます。したがって、パフォーマンスのために、常にクエリ句をリクエストに追加することをお勧めします。

セミコロンを使用して、クエリ内の句を区切ります。これは、AND関係演算子を表します。

次の項目についてクエリを実行できます。 

クエリ項目 説明

entity_type

チーム、フィーチャー、パイプラインなどのエンティティタイプごとに監査できます。

監査できるエンティティを確認するには、エンティティメタデータリファレンスの下の非監査可能フィーチャーを参照してください。

entity_id

 エンティティのIDで監査できます。

field_name

エンティティの特定のフィールドに加えられた変更を監査できます。

使用可能なフィールドを確認するには、フィールドメタデータリファレンスの非監査可能フィーチャーを参照してください。

action

次のアクションを監査できます。 

  • create

  • update

  • delete

user_id

特定のユーザーによる変更をリクエストできます。

ユーザーIDは整数であるため、ユーザーIDは引用符なしで入力してください。

注: ALM Octaneのすべてのユーザーは2つのIDを持っています。サイトレベルで監査を行っている場合は、サイトのユーザーIDを指定します。スペースまたはワークスペースレベルで監査する場合は、必ずスペースのユーザーIDを指定してください。

例: このクエリは、IDが2004であるストーリーの重大度フィールドに対してユーザー8987が行ったすべての更新を監査していることを示しています。 
?query="entity_type=^story^;entity_id=2004;field_name=^severity^;action=^update^;user_id=8987"

トップに戻る

例

auditsリソースを操作するためのいくつかの例を次に示します。

特定の時間枠内に行われた削除の監査

この例は、2019年の初め以降に削除されたすべてのエンティティを表示する方法を示しています。

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/audits?query="action EQ ^delete^;timestamp GE ^2019-01-01T20:59:59Z^"

さまざまな段階でのワークスペースレベルのエンティティの監査

この例では、ワークスペース管理者がID 1125のエピックを監査します。応答には、その作成、エピックに加えられた更新、およびその削除が表示されます。

注: entity_idを指定するだけでは不十分です。同じエンティティIDを持つ、ユーザーストーリーやフィーチャーなど、他のエンティティタイプが存在する場合があります。したがって、エンティティのタイプも必ず指定してください。

リクエスト:  

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/audits?query="entity_type EQ ^epic^;entity_id EQ 1125"

応答:  

この折りたたまれたJSON表現は、エンティティが3つのアクションを実行したことを示しています。最新の操作は常に一番上にあり、0というラベルが付いています。

注: ルールが監査に表示される変更を行った場合、応答には次のように表示されます。 

"rule_changer_id": <rule ID>

これは、ルールを実行したuser_idに追加されます。

アクション2は、エンティティの作成です。actionは「作成」です。作成中に値を受け取った各フィールドは、change_set属性にリストされます。

    {
      "type": "audit",
      "workspace_id": 1002,
      "entity_physical_id": 1125,
      "change_set": [
        {
          "field_type": "SINGLE_REF",
          "field_name": "author",
          "value": "1001",
          "value_id": 1001,
          "ref_entity_type": "workspace_user",
          "field_label": "Author",
          "value_text": "marta@thecompany.com"
        },
        {
          "field_type": "STANDARD",
          "field_name": "logical_name",
          "value": "qdk3no4m41kvzs9w5lkdrjv94",
          "field_label": "Logical name"
        },
        {
          "field_type": "STANDARD",
          "field_name": "name",
          "value": "Epic 1",
          "field_label": "Name"
        },
        {
          "field_type": "SINGLE_REF",
          "field_name": "parent",
          "value": "1001",
          "value_id": 1001,
          "ref_entity_type": "work_item",
          "field_label": "Parent",
          "value_text": "Backlog"
        },
        {
          "field_type": "STANDARD",
          "field_name": "path",
          "value": "0000000000Z3",
          "field_label": "Path"
        },
        {
          "field_type": "SINGLE_REF",
          "field_name": "phase",
          "value": "phase.epic.new",
          "value_id": 1019,
          "ref_entity_type": "phase",
          "field_label": "Phase",
          "value_text": "New"
        },
        {
          "field_type": "STANDARD",
          "field_name": "subtype",
          "value": "epic",
          "field_label": "Type"
        }
      ],
      "entity_type": "epic",
      "user_id": 1001,
      "user_name": "marta@thecompany.com",
      "action": "create",
      "session_id": "$1$XHYKNW1C$IhyU1Zzj7N0rlfLwoeWGQ0",
      "entity_id": "1125",
      "timestamp": "2018-12-13T11:18:42Z"
    }

アクション1は、エンティティの更新です。actionは「更新」です。更新された各フィールドは、change_set属性にリストされています。更新中に初めて値を受け取るフィールドは、現在の値とともに一覧表示されます。値が更新されたフィールドについては、古い値と現在の値の両方が一覧表示されます。

    {
      "type": "audit",
      "workspace_id": 1002,
      "entity_physical_id": 1125,
      "change_set": [
        {
          "field_type": "MEMO",
          "field_name": "description",
          "value": "<html><body>\n<p>Adding a description to my epic.</p>\n</body></html>",
          "field_label": "Description"
        },
        {
          "field_type": "SINGLE_REF",
          "field_name": "epic_type",
          "value": "list_node.epic_type.Business",
          "value_id": 1035,
          "ref_entity_type": "list_node",
          "field_label": "Epic type",
          "value_text": "Business"
        },
        {
          "field_type": "SINGLE_REF",
          "field_name": "item_origin",
          "value": "list_node.item_origin.alm",
          "value_id": 1051,
          "ref_entity_type": "list_node",
          "field_label": "Item origin",
          "value_text": "ALM"
        },
        {
          "field_type": "SINGLE_REF",
          "field_name": "owner",
          "value": "1001",
          "value_id": 1001,
          "ref_entity_type": "workspace_user",
          "field_label": "Owner",
          "value_text": "marta@thecompany.com"
        },
        {
          "field_type": "SINGLE_REF",
          "field_name": "phase",
          "value": "phase.epic.inprogress",
          "value_id": 1020,
          "old_value_id": 1019,
          "ref_entity_type": "phase",
          "old_value": "phase.epic.new",
          "field_label": "Phase",
          "value_text": "In Progress",
          "old_value_text": "New"
        },
        {
          "field_type": "STANDARD",
          "field_name": "story_points",
          "value": "10",
          "field_label": "Story points"
        }
      ],
      "entity_type": "epic",
      "user_id": 1001,
      "user_name": "marta@thecompany.com",
      "action": "update",
      "session_id": "$1$4YoRwEtz$/72LHp9E93e2.WoC8uQjh0",
      "entity_id": "1125",
      "timestamp": "2018-12-13T11:38:05Z"
    },

アクション0は、エンティティの削除です。actionは「削除」です。 

    {
      "type": "audit",
      "workspace_id": 1002,
      "entity_physical_id": 1125,
      "change_set": []
      "entity_type": "epic",
      "user_id": 1001,
      "user_name": "marta@thecompany.com",
      "action": "delete",
      "session_id": "$1$4YoRwEtz$/72LHp9E93e2.WoC8uQjh0",
      "entity_id": "1125",
      "timestamp": "2018-12-13T11:38:05Z"
    },

すべてのワークスペースに共通の「shared_area」スペースレベルエンティティであるリリースの監査

この例では、ワークスペース管理者がID 1001のリリースを監査します。

shared_areaコンテキストは、共有アセットを含むスペース内の特別な領域です。

GET .../api/shared_spaces/<space_id>/shared_area/audits?query="entity_type EQ ^release^;entity_id EQ 1001"

共有されたスペースレベルのエンティティであるワークスペースの監査

この例では、スペース管理者がすべてのワークスペースでのすべての操作を監査します。

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/audits?query="entity_type EQ ^workspace^"

特定のユーザーのアクティビティの監査

この例は、ユーザー2002、Marta Santoraによって実行されたすべてのアクションの履歴を取得する方法を示しています。

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/audits?query="user_id EQ 2002"

複数の属性の監査

この例は、IDが2004であるストーリーの重大度フィールドに対してユーザー8987が行ったすべての更新を監査する方法を示しています。 

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/audits?query="entity_type EQ ^story^;entity_id EQ 2004;field_name EQ ^severity^;action EQ ^update^;user_id EQ 8987"

トップに戻る

参照情報: